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 1670439508
2336 \begin_layout Section
2338 \change_inserted 564990737 1670439533
2339 \begin_inset CommandInset label
2341 name "sec:Collections"
2348 \begin_layout Subsection
2349 AMS \SpecialChar LaTeX
2353 \begin_layout Standard
2360 Richard Kimberly Heck
2363 \begin_layout Standard
2364 \begin_inset VSpace bigskip
2370 \begin_layout Standard
2372 The AMS \SpecialChar LaTeX
2373 layouts are set up to conform to suggested styles for mathematical
2374 papers to be submitted to American Mathematical Society publications.
2375 The layouts are not tailored to a specific journal, but easily can be.
2376 You should refer to the AMS documentation for specific instructions for
2377 each journal (usually it will entail only changing a single line in the
2380 That documentation is available on the Web at
2381 \begin_inset Flex URL
2384 \begin_layout Plain Layout
2392 \begin_inset Flex URL
2395 \begin_layout Plain Layout
2397 ftp://ftp.ams.org/pub/tex/amslatex/
2403 These layouts are appropriate, and useful, for any mathematical writing.
2407 \begin_layout Standard
2408 There are two basic AMS \SpecialChar LaTeX
2412 \begin_layout Itemize
2413 amsart: The standard AMS article format.
2416 \begin_layout Itemize
2417 amsbook: the standard AMS book (really, monograph) format.
2421 \begin_layout Standard
2422 The layouts themselves contain only the minimum necessary to use the AMS
2424 They do not, in particular, contain any of the `theorem' environments used
2425 for setting theorems, lemmas, and the like.
2426 These are contained, instead, in the
2427 \begin_inset Flex Code
2430 \begin_layout Plain Layout
2436 module, which is loaded by default when you select one of the AMS classes.
2437 (It can also be used with other classes and can be removed, if you would
2438 rather use something else.) Less commonly used environments are in the
2439 \begin_inset Flex Code
2442 \begin_layout Plain Layout
2443 Theorems (AMS-Extended)
2448 module, which must be loaded manually.
2451 \begin_layout Standard
2452 By default, theorems and the like are numbered consecutively throughout
2453 the document, but this may be modified by loading the module
2454 \begin_inset Flex Code
2457 \begin_layout Plain Layout
2458 Theorems (Order by Section)
2463 or, if you are using
2464 \begin_inset Flex Code
2467 \begin_layout Plain Layout
2474 \begin_inset Flex Code
2477 \begin_layout Plain Layout
2478 Theorems (Order by Chapter)
2484 These will number the results as
2485 \begin_inset Formula $n.m$
2488 , where the first number refers to the section (or chapter) and the second
2489 refers to the total number of results so far in that section (or chapter).
2490 Many environments are also available unnumbered.
2491 These are indicated by an asterisk at the end.
2492 If you happen to want
2496 unnumbered results, the module
2497 \begin_inset Flex Code
2500 \begin_layout Plain Layout
2506 provides that option.
2509 \begin_layout Standard
2510 Note that these modules do not
2514 to be used with the AMS classes.
2515 It is perfectly possible to use the
2516 \begin_inset Flex Code
2519 \begin_layout Plain Layout
2525 module, and the others mentioned, with other classes, such as
2526 \begin_inset Flex Code
2529 \begin_layout Plain Layout
2536 \begin_inset Flex Code
2539 \begin_layout Plain Layout
2546 \begin_inset Flex Code
2549 \begin_layout Plain Layout
2558 \begin_layout Subsubsection
2559 What these layouts provide
2562 \begin_layout Standard
2563 There is a long list of included environments provided by these layouts.
2564 In AMS-\SpecialChar LaTeX
2565 , there is, in fact, an opportunity to define an unlimited variety
2566 of `theorem' environments.
2567 However, the AMS recommends the environments that are available in \SpecialChar LyX
2572 \begin_layout Standard
2573 The following environments—as well as the standard environments, such as
2575 \begin_inset Flex Noun
2578 \begin_layout Plain Layout
2585 \begin_inset Flex Noun
2588 \begin_layout Plain Layout
2595 \begin_inset Flex Noun
2598 \begin_layout Plain Layout
2605 \begin_inset Flex Noun
2608 \begin_layout Plain Layout
2615 \begin_inset Flex Noun
2618 \begin_layout Plain Layout
2625 \begin_inset Flex Code
2628 \begin_layout Plain Layout
2635 \begin_inset Flex Code
2638 \begin_layout Plain Layout
2647 \begin_layout Description
2648 Address This should be the author's permanent address.
2651 \begin_layout Description
2653 \begin_inset space ~
2656 Address This should be the author's temporary address at the time of submission,
2657 if different from the Address.
2660 \begin_layout Description
2661 Email Author's e-mail address
2664 \begin_layout Description
2665 URL Author's Web address, if desired.
2668 \begin_layout Description
2669 Keywords Key words or phrases used to identify specific topics discussed
2673 \begin_layout Description
2674 Subjectclass These refer to the AMS Subject Classifications, published and
2677 Mathematical Reviews
2680 These are also available online at the AMS cites listed above.
2683 \begin_layout Description
2687 \begin_layout Description
2691 \begin_layout Description
2695 \begin_layout Standard
2696 The following environments are provided by both the
2697 \begin_inset Flex Code
2700 \begin_layout Plain Layout
2707 \begin_inset Flex Code
2710 \begin_layout Plain Layout
2716 modules, in the latter case in both starred (unnumbered) and unstarred
2717 (numbered) versions.
2718 These same environments are provided only in the starred versions by the
2720 \begin_inset Flex Code
2723 \begin_layout Plain Layout
2732 \begin_layout Theorem
2733 This is typically used for the statements of major results.
2737 \begin_layout Corollary*
2738 This is used for statements which follow fairly directly from previous statement
2740 Again, these can be major results.
2745 These are smaller results needed to prove other statements.
2748 \begin_layout Proposition
2749 These are less major results which (hopefully) add to the general theory
2753 \begin_layout Conjecture
2754 These are statements provided without justification, which the author does
2755 not know how to prove, but which seem to be true (to the author, at least).
2758 \begin_layout Definition*
2759 Guess what this is for.
2760 The font is different for this environment than for the previous ones.
2764 \begin_layout Example*
2765 Used for examples illustrating proven results.
2768 \begin_layout Problem
2769 It's not really known what this is for.
2770 You should figure it out.
2773 \begin_layout Exercise*
2774 Write a description for this one.
2777 \begin_layout Remark
2778 This environment is also a type of theorem, usually a lesser sort of observation.
2781 \begin_layout Claim*
2782 Often used in the course of giving a proof of a larger result.
2786 Generally, these are used to break up long arguments, using specific instances
2792 The numbering scheme for cases is on its own, not together with other numbered
2798 At the end of this environment, a QED symbol (usually a square, but it can
2799 vary with different styles) is placed.
2800 If you want to have other environments within this one—for example, Case
2801 environments—and have the QED symbol appear only after them, then the other
2802 environments need to be nested within the proof environment.
2805 Nesting Environments
2811 for information on nesting.
2814 \begin_layout Standard
2815 And these environments are provided by
2816 \begin_inset Flex Code
2819 \begin_layout Plain Layout
2820 Theorems (AMS-Extended)
2828 \begin_layout Criterion*
2829 A required condition.
2832 \begin_layout Algorithm*
2833 A general procedure to be used.
2836 \begin_layout Axiom*
2837 This is a property or statement taken as true within the system being discussed.
2840 \begin_layout Condition*
2841 Sometimes used to state a condition assumed within the present context of
2846 Similar to a Remark.
2849 \begin_layout Notation*
2850 Used for the explanation of, yes, notation.
2853 \begin_layout Summary
2854 Do we really need to tell you?
2857 \begin_layout Acknowledgement*
2861 \begin_layout Conclusion*
2862 Sometimes used at the end of a long train of argument.
2866 Used in a way similar to Proposition, though perhaps lower on the scale.
2869 \begin_layout Standard
2870 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
2873 They need to be available on your system in order to use these environments.
2876 \begin_layout Subsection
2878 \change_inserted 564990737 1671383236
2881 \begin_inset CommandInset label
2883 name "subsec:Extra-font-sizes"
2890 \begin_layout Standard
2892 \change_inserted 564990737 1671383236
2895 The “Extra font sizes” collection provides the document classes
2898 \begin_inset space \thinspace{}
2901 (with extra font sizes)
2906 \begin_inset space \thinspace{}
2909 (with extra font sizes)
2914 \begin_inset space \thinspace{}
2917 (with extra font sizes)
2922 \begin_inset space \thinspace{}
2925 (with extra font sizes)
2943 document classes respectively but offer the additional
2949 \begin_inset space ~
2954 options 8, 9, 14, 17 and 20 in the
2959 ocument\SpecialChar menuseparator
2964 ettings\SpecialChar menuseparator
2970 \begin_layout Subsection
2972 \change_inserted 564990737 1671383236
2978 \begin_layout Standard
2980 \change_inserted 564990737 1671383236
2983 The document classes
2986 \begin_inset space \thinspace{}
2994 \begin_inset space \thinspace{}
3009 document classes to facilitate the use of Hebrew in \SpecialChar LyX
3013 \begin_layout Subsection
3015 \change_inserted 564990737 1671383236
3018 \begin_inset CommandInset label
3020 name "subsec:Japanese"
3027 \begin_layout Standard
3029 \change_inserted 564990737 1671383236
3032 The document classes
3035 \begin_inset space \thinspace{}
3043 \begin_inset space \thinspace{}
3046 (Japanese Standard Class Vertical Writing)
3051 \begin_inset space \thinspace{}
3054 (Japanese Standard Class)
3059 \begin_inset space \thinspace{}
3067 \begin_inset space \thinspace{}
3070 (Japanese Standard Class Vertical Writing)
3075 \begin_inset space \thinspace{}
3078 (Japanese Standard Class)
3083 \begin_inset space \thinspace{}
3086 (Japanese Vertical Writing)
3091 \begin_inset space \thinspace{}
3094 (Japanese Standard Class)
3096 provide document classes for the Japanese language.
3099 \begin_layout Subsection
3103 \begin_layout Standard
3109 \begin_layout Subsubsection
3113 \begin_layout Standard
3114 The \SpecialChar LyX
3117 article (koma-script)
3121 report (koma-script)
3139 correspond to the \SpecialChar LaTeX
3157 \begin_inset space ~
3160 of the Koma-Script family.
3161 They are replacements for the standard document classes
3177 , resp., and fit better to European typography conventions in a number of
3181 \begin_layout Itemize
3182 Standard character size is 11pt in
3184 article (koma-script)
3188 report (koma-script)
3196 letter (koma-script)
3201 \begin_layout Itemize
3202 Headings, labels of the description environment, and a number of elements
3205 letter (koma-script)
3207 document class are set in a bold sans serif font.
3211 \begin_layout Plain Layout
3212 There is a big difference between the bold sans serif old cm fonts and new
3213 ec fonts, especially in the appearance of headings.
3214 In comparison, the ec bold sans serif fonts look a bit thin.
3215 Here the \SpecialChar LaTeX
3224 helps to produce the
3225 \begin_inset Quotes eld
3229 \begin_inset Quotes erd
3232 appearance when using the ec fonts.
3237 The numbering of chapter headings is made in the same way as the numbering
3238 of section headings, that is without the extra line
3239 \begin_inset Quotes eld
3242 Chapter\SpecialChar ldots
3244 \begin_inset Quotes erd
3248 In addition, the appearance of the headings can be modified by using a
3249 number of options (in \SpecialChar LyX
3250 to be entered in the field
3253 \begin_inset space ~
3260 Layout\SpecialChar menuseparator
3267 \begin_layout Itemize
3268 The main means in the Koma-Script document classes to design the type area
3277 (in \SpecialChar LyX
3278 to be entered in the extra class options field in the dialog
3280 Document\SpecialChar menuseparator
3284 They make a clearer modification of page margins possible as do the options
3287 Document\SpecialChar menuseparator
3294 \begin_layout Itemize
3295 The \SpecialChar LaTeX
3296 document classes of the Koma-Script family define a number of additional
3298 Those part of it which makes sense in \SpecialChar LyX
3299 is implemented in corresponding
3303 \begin_layout Standard
3304 Detailed descriptions of the \SpecialChar LaTeX
3305 document classes of the Koma-Script family
3306 can be found in the Koma-Script documentation
3317 \begin_layout Subsubsection
3318 article (koma-script), report (koma-script), and book (koma-script)
3321 \begin_layout Standard
3322 The document classes
3324 article (koma-script)
3328 report (koma-script)
3338 are implemented in the layout files
3351 They contain all the paragraph types of the corresponding standard document
3364 , resp., partly modified, with the exception of the \SpecialChar LyX
3369 -type, which is replaced by the new
3373 -type having the same functionality.
3378 -Type there is a number of new paragraph types added.
3385 letter (koma-script)
3390 \begin_layout Itemize
3399 : are equivalents to
3407 , resp., additionally inserting an entry in the table of contents.
3416 are not contained in
3418 article (koma-script)
3423 \begin_layout Itemize
3440 , resp., additionally clearing running heads.
3447 article (koma-script)
3453 \begin_layout Plain Layout
3466 report (koma-script)
3468 , but since this is identical to
3472 , is has not been implemented in \SpecialChar LyX
3481 \begin_layout Itemize
3486 : generates a heading directly above the following paragraph in the standard
3487 character size without affecting the structure of the document.
3490 \begin_layout Itemize
3499 are special captions which respect the different space settings needed
3500 for captions placed above or below an element (if you follow strict typographic
3501 rules, you might want to place table captions always above the table).
3502 You can also use the class option
3519 You need at least Koma-Script version 2.8q to use this.
3522 \begin_layout Itemize
3527 : can be used to set a bonmot, e.
3528 \begin_inset space \thinspace{}
3532 \begin_inset space \space{}
3535 at the beginning of a chapter.
3536 If you use the optional argument (
3538 Insert\SpecialChar menuseparator
3540 \begin_inset space ~
3545 ), you can insert the dictum's author there.
3546 Dictum and author are separated by a line.
3547 You need at least Koma-Script version 2.8q to use this.
3554 article (koma-script)
3559 \begin_layout Standard
3560 The following types, together with the standard types
3572 , form the title area of the document.
3573 They must be entered ahead of the first
3574 \begin_inset Quotes eld
3578 \begin_inset Quotes erd
3585 \begin_layout Plain Layout
3586 The corresponding \SpecialChar LaTeX
3587 commands must appear before the
3598 When such a type is used more than once, the latter usage overwrites the
3599 former one, that means, for every type only the latest usage is valid.
3600 The order of the different types however has, like
3612 , no effect on the appearance of the produced document.
3615 \begin_layout Itemize
3620 : produces a centered paragraph above the ordinary title (
3632 ) for the subject of the document.
3635 \begin_layout Itemize
3640 : produces a centered paragraph below the ordinary title (
3652 ) for the publishers' name.
3655 \begin_layout Itemize
3662 report (koma-script)
3668 produces a centered paragraph on its own page behind the title page, or
3671 article (koma-script)
3673 produces a centered paragraph below the ordinary title (
3692 \begin_layout Itemize
3697 : produces a left aligned paragraph above the ordinary title (
3713 ) for a document`s head.
3716 \begin_layout Itemize
3721 : produces in a double-sided print in
3723 report (koma-script)
3729 a left-aligned paragraph at the top of the title page`s back or has no
3730 effect in a single-sided print or in
3732 article (koma-script)
3737 \begin_layout Itemize
3742 : produces in a double-sided print in
3744 report (koma-script)
3750 a left-aligned paragraph at the bottom of the title page`s back or has
3751 no effect in a single-sided print or in
3753 article (koma-script)
3758 \begin_layout Itemize
3763 : produces a special
3764 \begin_inset Quotes eld
3768 \begin_inset Quotes erd
3771 page ahead of the actual document containing a paragraph without special
3775 \begin_layout Standard
3776 The layout files for the document classes
3778 article (koma-script)
3782 report (koma-script)
3793 This is thought of as a place to define your own types.
3798 in your personal layout directory and edit the file!
3801 \begin_layout Subsubsection
3802 letter (koma-script)
3805 \begin_layout Description
3806 Note: This section discusses the obsolete
3808 KOMA-Script-Letter (v.
3809 \begin_inset space ~
3814 , which is not even included anymore in recent KOMA releases.
3815 Please refer to the next section for the current KOMA-Script-Letter class
3817 \begin_inset space ~
3823 \begin_layout Standard
3827 letter (koma-script)
3829 is implemented in the layout file
3834 It contains all the paragraph types of the corresponding standard document
3839 , partly modified, with the exception of the \SpecialChar LyX
3853 type, which is replaced by the new
3858 In addition, it contains, in contrast to the standard document class, the
3877 Furthermore, there are a number of new letter specific types.
3880 \begin_layout Standard
3881 The appearance of the letter produced by this document class can be controlled
3882 by a number of \SpecialChar LaTeX
3883 commands, which you can put in the \SpecialChar LaTeX
3888 \begin_layout Plain Layout
3889 For example, the standard appearance of the letter`s heading, consisting
3890 of name and address, is quite self-willed.
3892 \begin_inset Quotes eld
3896 \begin_inset Quotes erd
3899 heading is produced by the following \SpecialChar LaTeX
3900 commands in the preamble:
3903 \begin_layout LyX-Code
3913 \begin_layout LyX-Code
3929 \begin_layout LyX-Code
3939 \begin_layout LyX-Code
3959 A detailed German description of such \SpecialChar LaTeX
3960 commands can be found in the Koma-Script
3966 With it, the letter's author can produce his personal letter layout.
3969 \begin_layout Standard
3978 define the beginning of the letter and must be used in every letter.
3979 To emphasize them in the \SpecialChar LyX
3980 document class, they are marked with the letter
3990 \begin_inset space ~
3994 It is possible to write any number of letters in one file.
3999 type produces a new letter using the same addressee and a
4003 type produces a new addressee.
4020 are ordinary paragraph types and can also be used several times in one
4021 and the same letter.
4024 \begin_layout Itemize
4029 : produces a paragraph for the addressee and implicitly defines the beginning
4033 \begin_layout Itemize
4038 : produces a paragraph for the form of address and implicitly produces a
4042 \begin_layout Itemize
4047 : produces a paragraph for a close.
4050 \begin_layout Itemize
4055 : produces a paragraph for a postscript.
4058 \begin_layout Itemize
4063 : produces a paragraph for a distribution list.
4066 \begin_layout Itemize
4071 : produces a paragraph for enclosures.
4074 \begin_layout Standard
4115 are input types provided with a label to enter information, which will
4116 be processed by the document class.
4120 \begin_layout Plain Layout
4121 It could be seen as a matter of inconsequence, that the types
4129 described above are not such input types as well.
4130 Because of the special meaning of those types, however, I have implemented
4131 them as ordinary paragraph types with a one letter mark in the left margin.
4132 Moreover, it would affect my feeling of symmetry, if the
4140 type had such a serious different appearance.
4145 The types must be used ahead of the corresponding
4152 \begin_layout Standard
4153 An implementation of these types in a WYSIWYG fashion does not seem to make
4154 sense, because the real appearance of the produced letter does not only
4155 depend on the usage of the particular type, but also on other factors.
4156 For example, a signature entered in the
4160 type will in the standard behavior appear in the produced letter only,
4161 when in the same letter also a
4166 The entered value of the
4170 type will in the standard behavior not appear in the produced letter at
4172 The possibility to design the letter`s heading freely is already indicated
4173 in a footnote above.
4176 \begin_layout Standard
4177 The input types can also be used as empty paragraphs.
4179 \begin_inset space \thinspace{}
4183 \begin_inset space \space{}
4195 type is not used at all, in the standard behavior the value of the
4199 type is used as signature, whereas if an empty
4203 type is used, no signature value is defined.
4206 \begin_layout Standard
4207 By using the input types it is possible to write a letter template, containing
4208 filled input types with your personal dates (name, address, etc.) and empty
4209 input types for other dates you want to enter.
4212 \begin_layout Itemize
4217 : sender's name, in the standard behavior appears as a centered paragraph
4218 in small caps in the letter`s heading.
4221 \begin_layout Itemize
4226 : sender's signature, in the standard behavior appears below the
4235 type is used, the value of the
4239 type appears instead.
4242 \begin_layout Itemize
4247 : sender's address, in the standard behavior appears in a centered paragraph
4248 in the letter`s heading below the sender's name.
4251 \begin_layout Itemize
4256 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
4267 \begin_layout Itemize
4272 : place of the letter`s making.
4275 \begin_layout Itemize
4280 : date of the letter`s making.
4289 , in the standard behavior, produce the place and the date in a right-aligned
4290 line below the addressee's field.
4295 type is used, neither place nor date appear, independent of the value of
4305 type is used, the date of the letter `s production is used.
4308 \begin_layout Itemize
4313 : sender`s back address, in the standard behavior appears above the addressee's
4314 field in a small sans serif font.
4317 \begin_layout Itemize
4322 : special mail information, in the standard behavior appears underlined
4323 above the addressee's field below the back address.
4326 \begin_layout Itemize
4331 : additional information, in the standard behavior appears on right side
4332 below the addressee`s field.
4335 \begin_layout Itemize
4340 : the letter's title, in the standard behavior appears in a big, bold, sans
4341 serif font above the subject.
4344 \begin_layout Itemize
4349 : the letter's subject, in the standard behavior appears in a bold font
4357 \begin_layout Standard
4378 produce a business letter like line above the
4382 line containing the fields
4383 \begin_inset Quotes eld
4387 \begin_inset Quotes erd
4391 \begin_inset Quotes eld
4395 \begin_inset Quotes erd
4399 \begin_inset Quotes eld
4403 \begin_inset Quotes erd
4407 \begin_inset Quotes eld
4411 \begin_inset Quotes erd
4415 \begin_inset Quotes eld
4419 \begin_inset Quotes erd
4423 \begin_inset Quotes eld
4427 \begin_inset Quotes erd
4431 For the date field, the value of the
4437 \begin_inset Quotes eld
4440 business letter types
4441 \begin_inset Quotes erd
4444 is used, the value of the
4448 type however does not appear, but only the \SpecialChar LaTeX
4456 The ordinary output of place and date in a right-aligned line below the
4457 addressee`s field is suppressed.
4458 The types are implemented as input types provided with a label and must
4459 be used ahead of the corresponding
4466 \begin_layout Itemize
4474 \begin_layout Itemize
4482 \begin_layout Itemize
4490 \begin_layout Itemize
4498 \begin_layout Itemize
4506 \begin_layout Subsubsection
4507 The new letter class: letter (koma-script v.2)
4510 \begin_layout Standard
4516 \begin_layout Standard
4517 \begin_inset VSpace medskip
4523 \begin_layout Standard
4525 Koma-Script version 2.8 has introduced a new letter class
4529 which supersedes the now unsupported
4534 It has — on the \SpecialChar LaTeX
4535 side — a completely new interface and is not compatible
4537 Therefore, \SpecialChar LyX
4538 supports both, though it is recommended you use the new class.
4541 \begin_layout Standard
4542 This class covers the same functionality as
4544 letter (koma-script),
4551 (receiver's address, same as
4568 will start a new letter (i.
4569 \begin_inset space \thinspace{}
4573 \begin_inset space \space{}
4576 you can write several letters per document).
4577 New elements are sender's
4593 and the possibility to use a
4599 Insert\SpecialChar menuseparator
4605 \begin_layout Standard
4606 The biggest improvement is, though, that the letter's layout is configurable
4607 to meet almost any needs.
4608 This can be done via the preamble or with a special style file (Letter
4609 Class Option, extension
4613 ), that will be read in as a class option.
4617 \begin_layout Plain Layout
4618 The KOMA package comes with some default
4623 There is, for instance, a
4627 file that follows german typesetting rules, or a
4631 that provides the default layout of the old
4636 The latter can be loaded with the class option
4642 Layout\SpecialChar menuseparator
4643 Document\SpecialChar menuseparator
4652 \change_deleted 564990737 1671617922
4660 \change_deleted 564990737 1671617938
4661 that is included in \SpecialChar LyX
4663 \change_inserted 564990737 1671617997
4670 ile\SpecialChar menuseparator
4672 \begin_inset space ~
4680 \begin_inset space ~
4683 Template\SpecialChar menuseparator
4686 \SpecialChar menuseparator
4687 KOMA-Script Letter (V.2)
4692 A detailed description is to be found in the Koma-Script documentation
4700 \begin_layout Subsubsection
4704 \begin_layout Standard
4705 Visualizing the Koma-Script document classes in \SpecialChar LyX
4706 , the \SpecialChar LyX
4707 internals cause some
4711 \begin_layout Itemize
4712 The chapter number of a
4716 type appears on a line of its own above the chapter heading instead of
4717 appearing in the same line ahead of it.
4718 The cause for that is the \SpecialChar LyX
4719 internal behavior for the labeltype
4726 \begin_layout Itemize
4727 The headings of the types
4736 \begin_inset Quotes eld
4740 \begin_inset Quotes erd
4744 table of contents, but not in the \SpecialChar LyX
4747 Document\SpecialChar menuseparator
4749 \begin_inset space ~
4753 \begin_inset space ~
4761 \begin_layout Itemize
4766 document class appear in a skip separation mode, not indented.
4767 This is the standard behavior, no special \SpecialChar LaTeX
4768 commands are needed for that.
4771 Document\SpecialChar menuseparator
4774 dialog the corresponding radio button indicates
4783 value always has the effect that extra \SpecialChar LaTeX
4784 commands are inserted in the document
4785 to produce the gap, which is not what is wanted in this case.
4788 \begin_layout Subsection
4790 \change_inserted 564990737 1670924924
4792 \begin_inset space \thinspace{}
4796 \begin_inset space \space{}
4800 \change_deleted 564990737 1670924933
4801 Article (mwart), book (mwbk) and report (mwrep)
4802 \begin_inset Argument status
4805 \begin_layout Plain Layout
4820 \begin_layout Standard
4826 \begin_layout Standard
4827 The \SpecialChar LyX
4844 correspond to the \SpecialChar LaTeX
4858 They are replacements for the standard document classes
4870 , resp., and fit better to Polish typography conventions in a number of points.
4874 \begin_layout Standard
4878 \begin_layout Itemize
4879 Unnumbered titles (with star, e.
4880 \begin_inset space \thinspace{}
4884 \begin_inset space \space{}
4891 ) are added into table of contents,
4894 \begin_layout Itemize
4895 Additional page styles:
4899 \begin_layout Description
4900 uheadings header with separated lines,
4903 \begin_layout Description
4904 myheadings custom header, contents headers via commands:
4919 \begin_layout Description
4920 myuheadings custom header with separated lines,
4923 \begin_layout Description
4924 outer page number is placed on outer side of page
4928 \begin_layout Itemize
4933 \begin_layout Description
4934 rmheadings serif titles — default,
4937 \begin_layout Description
4938 sfheadings sansserif titles,
4941 \begin_layout Description
4942 authortitle on title page first placed is author next title — default,
4945 \begin_layout Description
4946 titleauthor on title page first placed is title next author,
4949 \begin_layout Description
4950 withmarginpar reserve place on page for margins.
4954 \begin_layout Section
4956 \change_inserted 564990737 1670439534
4960 \begin_layout Standard
4962 \change_inserted 564990737 1670794710
4963 See also the document classes in the Collections (section
4964 \begin_inset space ~
4968 \begin_inset CommandInset ref
4970 reference "sec:Collections"
4977 \begin_layout Subsection
4979 \change_inserted 564990737 1670794716
4985 \begin_layout Standard
4987 \change_inserted 564990737 1670794716
4994 ; updated by the \SpecialChar LyX
4998 \begin_layout Subsubsection
5000 \change_inserted 564990737 1670794716
5006 \begin_layout Standard
5008 \change_inserted 564990737 1670794716
5011 This section describes how \SpecialChar LyX
5012 can be used to write articles for submission
5013 to the scientific journal
5015 Astronomy and Astrophysics
5018 \begin_inset CommandInset href
5021 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
5026 ) using Version 9.1 of the document class
5030 ; information about it is available at
5031 \begin_inset Flex URL
5034 \begin_layout Plain Layout
5036 \change_inserted 564990737 1670794716
5038 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
5048 \begin_layout Standard
5050 \change_inserted 564990737 1670794716
5053 A manual comes together with the package and should be consulted before
5054 installing this document class as described in the
5056 Installing New Document Classe
5066 \begin_layout Standard
5068 \change_inserted 564990737 1670794716
5071 \begin_inset Note Greyedout
5074 \begin_layout Plain Layout
5076 \change_inserted 564990737 1670794716
5079 Please note that the publisher of the journal was changed from Springer
5080 to EDP Sciences starting January 1, 2001.
5081 That change also involved some slight changes to the style files, namely
5082 the removal of the thesaurus command.
5083 If you have an older version installed, please upgrade.
5084 For information about compatibility with the old (version 4) layout, please
5085 refer to the comments in
5088 Dir/layouts/aapaper.layout
5098 \begin_layout Subsubsection
5100 \change_inserted 564990737 1670794716
5106 \begin_layout Standard
5108 \change_inserted 564990737 1671617129
5111 It is recommended you start from the template in the menu
5116 ile\SpecialChar menuseparator
5118 \begin_inset space ~
5126 \begin_inset space ~
5131 \SpecialChar menuseparator
5132 Articles\SpecialChar menuseparator
5133 Astronomy & Astrophysics
5137 If you are not using the template, note the following settings:
5140 \begin_layout Itemize
5142 \change_inserted 564990737 1670794716
5154 ocument\SpecialChar menuseparator
5159 ettings\SpecialChar menuseparator
5161 \begin_inset space ~
5166 dialog (OK, that one was obvious).
5169 \begin_layout Itemize
5171 \change_inserted 564990737 1670794716
5177 \begin_inset space ~
5189 \begin_inset space ~
5194 dialog: leave it set to
5199 The whole layout is done by the macros, you shouldn't change anything.
5202 \begin_layout Subsubsection
5204 \change_inserted 564990737 1670794716
5210 \begin_layout Standard
5212 \change_inserted 564990737 1670794716
5215 First thing to enter is the header information.
5216 It consists of five entries, of which one is optional.
5220 \begin_layout Itemize
5222 \change_inserted 564990737 1670794716
5231 \begin_layout Itemize
5233 \change_inserted 564990737 1670794716
5242 \begin_layout Itemize
5244 \change_inserted 564990737 1670794716
5253 \begin_layout Itemize
5255 \change_inserted 564990737 1670794716
5264 \begin_layout Itemize
5266 \change_inserted 564990737 1670794716
5275 Received: <date>; Accepted <date>
5278 \begin_layout Standard
5280 \change_inserted 564990737 1670794716
5283 Although the order of the single header entries doesn't matter it is advised
5284 to keep the above sequence, just to get the best optics and meets the layout
5285 of the real document.
5288 \begin_layout Standard
5290 \change_inserted 564990737 1670794716
5293 If you want to place footnotes in the header block, e.
5294 \begin_inset space \thinspace{}
5298 \begin_inset space \space{}
5301 to state your present address, just use the standard footnote via the menu
5307 nsert\SpecialChar menuseparator
5316 will automagically use the term
5325 \begin_layout Standard
5327 \change_inserted 564990737 1670794716
5330 In addition to these topics, the macros use three additional \SpecialChar LaTeX
5332 have no counterpart in \SpecialChar LyX
5336 \begin_layout Itemize
5338 \change_inserted 564990737 1670794716
5346 to separate different names for more than one author and institute, respectivel
5350 \begin_layout Itemize
5352 \change_inserted 564990737 1670794716
5360 to mark corresponding author/institute pairs.
5361 The institutes are numbered sequentially as they appear in the
5365 field, so you have to put a marker to each author.
5368 \begin_layout Itemize
5370 \change_inserted 564990737 1670794716
5378 to supply an email address for fast contact.
5381 \begin_layout Standard
5383 \change_inserted 564990737 1671642374
5386 In all cases, the appropriate command has to be entered as \SpecialChar TeX
5387 code in \SpecialChar LyX
5389 See the examples in the template and in
5392 File\SpecialChar menuseparator
5393 Open Example\SpecialChar menuseparator
5394 Articles\SpecialChar menuseparator
5395 Astronomy & Astrophysics
5403 \begin_layout Subsubsection
5405 \change_inserted 564990737 1670794716
5411 \begin_layout Standard
5413 \change_inserted 564990737 1670794716
5416 The abstract should immediately follow the header block and must contain
5426 \begin_layout Enumerate
5428 \change_inserted 564990737 1670794716
5434 (optional) {} leave it empty if necessary
5437 \begin_layout Enumerate
5439 \change_inserted 564990737 1670794716
5448 \begin_layout Enumerate
5450 \change_inserted 564990737 1670794716
5459 \begin_layout Enumerate
5461 \change_inserted 564990737 1670794716
5470 \begin_layout Enumerate
5472 \change_inserted 564990737 1670794716
5478 (optional) {} leave it empty if necessary
5481 \begin_layout Standard
5483 \change_inserted 564990737 1670794716
5487 This structure not shown in
5494 \begin_layout Subsubsection
5496 \change_inserted 564990737 1670794716
5499 Supported environments
5502 \begin_layout Standard
5504 \change_inserted 564990737 1670794716
5507 The A&A paper layout supports the following environments for structuring
5511 \begin_layout Itemize
5513 \change_inserted 564990737 1670794716
5520 \begin_layout Itemize
5522 \change_inserted 564990737 1670794716
5529 \begin_layout Itemize
5531 \change_inserted 564990737 1670794716
5538 \begin_layout Itemize
5540 \change_inserted 564990737 1670794716
5547 \begin_layout Itemize
5549 \change_inserted 564990737 1670794716
5556 \begin_layout Itemize
5558 \change_inserted 564990737 1670794716
5565 \begin_layout Itemize
5567 \change_inserted 564990737 1670794716
5574 \begin_layout Itemize
5576 \change_inserted 564990737 1670794716
5583 \begin_layout Itemize
5585 \change_inserted 564990737 1670794716
5592 \begin_layout Itemize
5594 \change_inserted 564990737 1670794716
5601 \begin_layout Itemize
5603 \change_inserted 564990737 1670794716
5610 \begin_layout Itemize
5612 \change_inserted 564990737 1670794716
5620 \begin_layout Subsubsection
5622 \change_inserted 564990737 1670794716
5625 Commands not supported by \SpecialChar LyX
5629 \begin_layout Standard
5631 \change_inserted 564990737 1670794716
5634 Some commands are not yet supported by the
5638 layout for \SpecialChar LyX
5640 Some have already been mentioned.
5641 For the sake of completeness, they are listed all together here:
5644 \begin_layout Itemize
5646 \change_inserted 564990737 1670794716
5655 \begin_layout Itemize
5657 \change_inserted 564990737 1670794716
5666 \begin_layout Itemize
5668 \change_inserted 564990737 1670794716
5677 \begin_layout Itemize
5679 \change_inserted 564990737 1670794716
5688 \begin_layout Itemize
5690 \change_inserted 564990737 1670794716
5699 \begin_layout Standard
5701 \change_inserted 564990737 1670794716
5704 If you want to use any of these commands, you have to enter them yourself.
5707 Do not forget to use
5713 nsert\SpecialChar menuseparator
5716 \begin_inset space ~
5725 \begin_layout Subsubsection
5727 \change_inserted 564990737 1670794716
5730 Figure and Table Floats
5733 \begin_layout Standard
5735 \change_inserted 564990737 1670794716
5739 provides support for the necessary float environments
5741 figure, figure*, table
5747 , therefore we won't tell much about it here.
5751 \begin_inset space ~
5757 Just remember that tables should be left-aligned.
5758 For that, select the table and change the alignment in
5763 dit\SpecialChar menuseparator
5769 \begin_inset space ~
5775 \begin_layout Standard
5777 \change_inserted 564990737 1670794716
5780 There is only one special thing: the figures with a caption beside the figure.
5781 To create such a figure, you have to do the following:
5784 \begin_layout Enumerate
5786 \change_inserted 564990737 1670794716
5789 Create a wide figure float:
5794 nsert\SpecialChar menuseparator
5799 t\SpecialChar menuseparator
5802 , then, from within the float, use the menu
5807 dit\SpecialChar menuseparator
5813 \begin_inset space ~
5824 \begin_inset space ~
5836 \begin_layout Enumerate
5838 \change_inserted 564990737 1670794716
5841 Enter your caption text.
5844 \begin_layout Enumerate
5846 \change_inserted 564990737 1670794716
5853 to move the cursor above the caption.
5856 \begin_layout Enumerate
5858 \change_inserted 564990737 1670794716
5864 \begin_layout Enumerate
5866 \change_inserted 564990737 1670794716
5869 Position the cursor after the figure and insert a horizontal fill by using
5875 nsert\SpecialChar menuseparator
5880 rmatting\SpecialChar menuseparator
5886 \begin_inset space ~
5895 dialog and select the
5909 \begin_layout Enumerate
5911 \change_inserted 564990737 1670794716
5914 Switch to \SpecialChar LaTeX
5918 \begin_inset space ~
5926 \begin_layout Enumerate
5928 \change_inserted 564990737 1670794716
5939 Do not close the brace!
5942 \begin_layout Enumerate
5944 \change_inserted 564990737 1670794716
5947 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
5952 \begin_inset space ~
5964 \begin_layout Standard
5966 \change_inserted 564990737 1671642458
5969 Also, refer to the figures in the file in
5972 File\SpecialChar menuseparator
5973 Open Example\SpecialChar menuseparator
5974 Articles\SpecialChar menuseparator
5975 Astronomy & Astrophysics
5981 \begin_layout Subsubsection
5983 \change_inserted 564990737 1670794716
5989 \begin_layout Standard
5991 \change_inserted 564990737 1670794716
5994 For submission, the paper has to be formatted in a special double-spacing
5996 For this purpose, you have to add the option
6007 \begin_inset space ~
6017 ocument\SpecialChar menuseparator
6022 ettings\SpecialChar menuseparator
6024 \begin_inset space ~
6033 \begin_layout Subsubsection
6035 \change_inserted 564990737 1670794716
6041 \begin_layout Standard
6043 \change_inserted 564990737 1671642520
6049 File\SpecialChar menuseparator
6050 Open Example\SpecialChar menuseparator
6051 Articles\SpecialChar menuseparator
6052 Astronomy & Astrophysics
6055 was written with \SpecialChar LyX
6057 It is the example paper from the original macro package,
6062 \begin_inset CommandInset href
6065 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
6070 , but translated to \SpecialChar LyX
6071 using the older unstructured abstract type.
6072 Use it for inspiration, and compare the \SpecialChar LaTeX
6077 with the \SpecialChar LyX
6081 \begin_layout Subsection
6086 \begin_layout Standard
6092 \begin_layout Subsubsection
6096 \begin_layout Standard
6098 is a set of macros produced by the American Astronomical Society to
6099 facilitate electronic manuscript submission to the three journals they
6100 publish: the Astrophysical Journal (including the Letters and Supplement),
6101 the Astronomical Journal, and the Publications of the Astronomical Society
6104 has proven to be an excellent tool for generating these documents, especially
6105 given its equation, citation, and figure handling capabilities.
6107 requires version 5.0 (or higher) of these macros; preferably 6.0, which
6108 is the version described here, or higher.
6109 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
6110 2.09 and are fundamentally
6111 incompatible with \SpecialChar LyX
6113 The AAS\SpecialChar TeX
6114 package may be downloaded from the AAS\SpecialChar TeX
6118 \begin_layout Standard
6119 \begin_inset VSpace medskip
6125 \begin_layout Standard
6127 \begin_inset Flex URL
6130 \begin_layout Plain Layout
6132 https://aas.org/aastex/aastex-downloads
6140 \begin_layout Standard
6141 \begin_inset VSpace medskip
6147 \begin_layout Standard
6148 A complete user guide is contained in that package and you should familiarize
6149 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
6152 will not reduce the need to figure out all the AAS\SpecialChar TeX
6153 commands, it will only
6154 reduce the drudgery of typing everything in.
6155 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
6157 completely to the requirements of the journal to which you are submitting
6161 \begin_layout Subsubsection
6162 Starting a New Paper
6165 \begin_layout Standard
6166 I strongly suggest that you start with the AAS\SpecialChar TeX
6170 File\SpecialChar menuseparator
6176 \change_inserted 564990737 1671617265
6177 \SpecialChar menuseparator
6178 Articles\SpecialChar menuseparator
6179 American Astronomical Society
6180 \change_deleted 564990737 1671617310
6183 , enter the new file name, then choose the
6190 This will show the most common fields found in a manuscript.
6191 Simply overwrite the existing text (including the brackets,
6195 ) with the correct information.
6196 Many of the AAS\SpecialChar TeX
6197 commands and environments can be implemented directly in
6200 For commands such as these, the \SpecialChar LaTeX
6201 code must be entered directly and marked
6203 Such commands are referred to as \SpecialChar TeX
6204 code, or Evil Red Text.
6205 I tried to minimize the amount of \SpecialChar TeX
6206 code needed in an AAS\SpecialChar TeX
6210 \begin_layout Subsubsection
6211 Finishing Your Paper
6214 \begin_layout Standard
6215 When the paper is finished to your satisfaction and previews/prints correctly,
6217 \begin_inset Quotes eld
6221 \begin_inset Quotes erd
6224 actions which need to be done before you submit it to the journals.
6228 \begin_layout Enumerate
6229 Export your paper as a \SpecialChar LaTeX
6232 File\SpecialChar menuseparator
6233 Export\SpecialChar menuseparator
6241 \begin_layout Enumerate
6246 file with your favorite text editor
6250 \begin_layout Enumerate
6251 remove the comment lines before the
6260 \begin_layout Enumerate
6265 usepackage...{fontenc}
6267 line if it appears (usually just after
6282 \begin_layout Enumerate
6283 remove everything between (and including) the
6295 commands, except for any commands you specifically put into the \SpecialChar LaTeX
6297 (which should appear immediately after the
6298 \begin_inset Quotes eld
6301 User specified \SpecialChar LaTeX
6303 \begin_inset Quotes erd
6314 \begin_layout Enumerate
6315 Run the resulting file through \SpecialChar LaTeX
6316 to make sure it still processes correctly.
6319 \begin_layout Enumerate
6320 Reread the journal requirements to make sure your filenames and formats
6324 \begin_layout Enumerate
6328 \begin_layout Subsubsection
6329 Comments On Specific Commands
6332 \begin_layout Standard
6333 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
6340 ) gives a good description of each.
6341 Thus it's probably easiest for me to go down the list as found in the guide
6342 and offer comments where necessary.
6343 So let's begin \SpecialChar ldots
6347 \begin_layout Paragraph
6348 Things that work as expected
6351 \begin_layout Standard
6352 Because they work as you might expect, I simply list them and the section
6453 begin{thebibliography}
6461 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6462 graphicx figure commands (2.14.1),
6486 (2.15.4, amongst other places),
6513 \begin_layout Standard
6514 The following style options also work correctly:
6535 Simply put them in the
6541 Layout\SpecialChar menuseparator
6547 \begin_layout Paragraph
6548 Things that work, but require more comment
6551 \begin_layout Standard
6552 The following items work, but require a little more discussion:
6555 \begin_layout Itemize
6556 These items are reserved for use by the journal editors, but you can put
6557 them into the \SpecialChar LaTeX
6558 preamble if you feel compelled to do so:
6591 \begin_layout Itemize
6592 These items may be placed in the \SpecialChar LaTeX
6593 preamble, and are included as blanks in
6615 \begin_layout Itemize
6622 (2.3) – can only be used
6623 \begin_inset Quotes eld
6627 \begin_inset Quotes erd
6630 , not in the middle of a paragraph.
6631 Use \SpecialChar TeX
6632 code if you need to embed it.
6635 \begin_layout Itemize
6642 (2.3) – will have extra {} after it.
6643 This should not cause an error.
6646 \begin_layout Itemize
6653 (2.6) – can only be used
6654 \begin_inset Quotes eld
6658 \begin_inset Quotes erd
6661 , not in the middle of a paragraph.
6662 Use \SpecialChar TeX
6663 code if you need to embed it.
6666 \begin_layout Itemize
6673 (2.8) – can't insert a cross-reference tag, you must type the tag name by
6677 \begin_layout Itemize
6691 \begin_layout Itemize
6698 (2.9) – will have extra {} after it.
6699 This should not cause an error.
6702 \begin_layout Itemize
6709 (2.11) – will have extra {} after it.
6710 This should not cause an error.
6713 \begin_layout Itemize
6720 (2.14.2) – you can insert an optional filename argument by placing the cursor
6721 at the beginning of the text and selecting
6723 Insert\SpecialChar menuseparator
6728 \begin_inset Quotes eld
6732 \begin_inset Quotes erd
6735 inserts an optional argument of the type needed by
6742 Hopefully it will be renamed someday.
6745 \begin_layout Itemize
6758 for the catalog ID optional parameter
6761 \begin_layout Itemize
6774 for the catalog ID optional parameter
6777 \begin_layout Paragraph
6778 Things not implemented, use \SpecialChar TeX
6782 \begin_layout Standard
6793 setcounter{equation}
6795 (2.12), Journal name abbreviations (2.13.4),
6831 (2.15.4, insert it as the first element in the lefthand cell after where
6833 Don't use any of \SpecialChar LyX
6834 's rules in the table),
6846 (2.15.5), much of Misc (2.17, except
6897 \begin_layout Paragraph
6898 Things that cannot be implemented
6901 \begin_layout Standard
6903 at least in any meaningful sort of way, so I suggest ignoring them.
6904 They are the references environment (2.13.3), and the deluxetable environment
6906 If you really, really need to use deluxetable, I suggest editing it in
6907 a separate file with a text editor, then using
6909 Insert\SpecialChar menuseparator
6911 \begin_inset space ~
6916 to include it in your \SpecialChar LyX
6919 \change_deleted 564990737 1671642564
6925 \change_inserted 564990737 1671642618
6929 File\SpecialChar menuseparator
6930 Open Example\SpecialChar menuseparator
6931 Articles\SpecialChar menuseparator
6932 American Astronomical Society
6938 \change_inserted 564990737 1671642621
6944 \begin_layout Subsubsection
6945 FAQs, Tips, Tricks, and Other Ruminations
6948 \begin_layout Paragraph
6949 Getting \SpecialChar LyX
6950 and AAS\SpecialChar TeX
6954 \begin_layout Standard
6955 It can be a bit tricky to get \SpecialChar LyX
6956 to recognize a new layout and document class.
6957 When all else fails, do this:
6960 \begin_layout Enumerate
6961 Make certain that \SpecialChar LaTeX
6962 can find AAS\SpecialChar TeX
6964 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
6966 directory completely unrelated to \SpecialChar LaTeX
6967 or AAS\SpecialChar TeX
6968 and run \SpecialChar LaTeX
6976 \begin_layout Enumerate
6981 appears in \SpecialChar LyX
6989 \begin_layout Enumerate
6992 Tools\SpecialChar menuseparator
6996 , then restart \SpecialChar LyX
7000 \begin_layout Enumerate
7001 Open a regular new file, not from a template.
7002 Does AAS\SpecialChar TeX
7003 appear in the class list in
7005 Document\SpecialChar menuseparator
7011 \begin_layout Standard
7012 If you get a warning from an existing AAS\SpecialChar TeX
7013 document about not being able
7014 to find the AAS\SpecialChar TeX
7015 layout or a message about
7016 \begin_inset Quotes eld
7019 You should not mix title layouts with normal ones
7020 \begin_inset Quotes erd
7023 , things haven't been installed correctly.
7026 \begin_layout Paragraph
7028 error processing a table
7031 \begin_layout Standard
7033 , by default, attempts to center the table caption/title.
7034 This seems to produce a bad interaction in AAS\SpecialChar TeX
7035 so you should click somewhere
7036 in the caption/title, then select
7038 Edit\SpecialChar menuseparator
7040 \begin_inset space ~
7054 This took care of it for me.
7057 \begin_layout Paragraph
7061 \begin_layout Standard
7062 A couple of things: 1) I have noticed some funny spacing in the reference
7063 entries in the text.
7064 When you enter the bibliography item data, make sure their is
7068 space between the last author and the parenthesis setting off the year;
7072 \begin_inset space \thinspace{}
7076 \begin_inset space \space{}
7090 2) Entering the references at all is not obvious.
7091 The easiest thing is to start typing your first reference at the end of
7092 the document, then mark it as type
7097 That will put a small gray box in front of what you just typed.
7098 Click on the box to fill in the rest of the information.
7099 For new references, go to the end of an existing reference and press return.
7100 That will create a new line with its own box, etc.
7103 \begin_layout Paragraph
7107 \begin_layout Standard
7108 Even though AAS\SpecialChar TeX
7109 provides its own figure commands (
7115 , for example), I much prefer \SpecialChar LaTeX
7116 's standard figure commands (with the default
7125 \begin_inset space ~
7128 commands as \SpecialChar TeX
7129 code into a Figure Float box if you desire, but I never have
7130 much luck getting the layout right.
7131 With the standard graphics, \SpecialChar LyX
7136 usepackage{graphicx}
7138 command into the \SpecialChar LaTeX
7139 preamble and handle the figures in the standard \SpecialChar LaTeX2e
7141 interspersing the figures in the text.
7142 I believe ApJ accepts figures exactly this way now; AJ might still use
7144 \begin_inset Quotes eld
7147 stack everything at the end
7148 \begin_inset Quotes erd
7154 \begin_layout Paragraph
7155 Things I could have done, but didn't
7158 \begin_layout Standard
7160 \begin_inset Quotes eld
7164 \begin_inset Quotes erd
7167 things I could have implemented, but chose not to.
7168 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
7170 even though it is double-spaced in the paper manuscript.
7171 Also, I chose not to make separate layouts for the preprint and preprint2
7173 Since I assume you will spend most of your time in the plain manuscript
7174 mode anyway, I decided not to chew up more disk space with this.
7178 \begin_layout Subsubsection
7182 \begin_layout Standard
7183 Your mileage may vary.
7184 I've now had papers published by both ApJ and AJ that have had 98% of the
7185 effort done in \SpecialChar LyX
7186 ; the last 2% was the \SpecialChar LaTeX
7187 post-processing and a few cleanups.
7188 I have had no trouble with the submission process, and I'm sure the journals
7189 were never aware that there might be a difference.
7190 So, go forth and publish!
7193 \begin_layout Subsection
7195 \change_inserted 564990737 1671442131
7201 \begin_layout Standard
7203 \change_inserted 564990737 1671642768
7209 \begin_inset space \thinspace{}
7218 document class together with the style
7222 to facilitate the description of chess games.
7226 File\SpecialChar menuseparator
7229 \SpecialChar menuseparator
7230 Articles\SpecialChar menuseparator
7249 \begin_layout Subsection
7251 \change_inserted 564990737 1671042028
7257 \begin_layout Standard
7259 \change_inserted 564990737 1671617396
7265 \begin_inset space \thinspace{}
7275 This provides the following additional environments:
7278 \begin_inset space ~
7286 \begin_inset space ~
7294 \begin_inset space ~
7312 A template is available in the menu
7317 ile\SpecialChar menuseparator
7319 \begin_inset space ~
7327 \begin_inset space ~
7332 \SpecialChar menuseparator
7333 Articles\SpecialChar menuseparator
7338 It has been customized with further environments and contains all the informati
7340 However, the documentation is also available from
7341 \begin_inset CommandInset href
7344 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
7352 \begin_layout Subsection
7354 \change_inserted 564990737 1671042046
7360 \begin_layout Standard
7362 \change_inserted 564990737 1671042046
7368 \begin_inset space \thinspace{}
7373 provides an alternative to the
7378 It provides similar functionality, but you might prefer this layout with
7379 sans serif sections, headings, and more.
7382 \begin_layout Subsection
7387 \begin_layout Standard
7393 \begin_layout Standard
7394 \begin_inset VSpace bigskip
7400 \begin_layout Standard
7405 \begin_inset space ~
7410 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
7412 \begin_inset Formula $\beta$
7415 release of May, 1999) class.
7418 \begin_layout Standard
7424 textclass, which works with Rev\SpecialChar TeX
7426 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
7428 That means that it doesn't interact very well with \SpecialChar LyX
7429 , which requires \SpecialChar LaTeX2e
7431 it has been kludged to work.
7432 Since Rev\SpecialChar TeX
7433 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
7440 \begin_inset space ~
7445 textclass should also be pretty easy to use.
7448 \begin_layout Standard
7449 These documents are supposed to be used in
7453 to the Rev\SpecialChar TeX
7454 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
7456 and assume you'll know what to put in the preamble if necessary.
7459 \begin_layout Subsubsection
7463 \begin_layout Standard
7464 All you need to do is install Rev\SpecialChar TeX
7465 4, as described in the package's README
7467 The package can be found at The Rev\SpecialChar TeX
7469 \begin_inset Flex URL
7472 \begin_layout Plain Layout
7474 http://publish.aps.org/revtex4/
7480 Install it somewhere that \SpecialChar LaTeX
7482 Test it by trying to \SpecialChar LaTeX
7483 a short Rev\SpecialChar TeX
7484 4 document in some random directory (i.
7485 \begin_inset space \thinspace{}
7489 \begin_inset space \space{}
7492 not the directory where you installed the class file.) Then, if you reconfigure
7494 , it will find the class file and let you use the Rev\SpecialChar TeX
7498 \begin_layout Standard
7499 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
7508 \begin_inset space ~
7513 template, found in the templates directory.
7516 \begin_layout Subsubsection
7520 \begin_layout Standard
7521 Optional arguments to
7528 \begin_inset Quotes eld
7532 \begin_inset Quotes erd
7536 \begin_inset Quotes eld
7540 \begin_inset Quotes erd
7546 \begin_inset space ~
7554 \begin_inset space ~
7560 Remember that in Rev\SpecialChar TeX
7561 , at least one optional argument is required!
7564 \begin_layout Standard
7565 Other preamble matter, like
7572 \begin_inset space ~
7579 \begin_inset space ~
7584 dialog, also as usual.
7587 \begin_layout Subsubsection
7591 \begin_layout Standard
7592 The layouts basically correspond to the commands in Rev\SpecialChar TeX
7594 For example, the Email layout corresponds to
7601 Note that (at least as of Rev\SpecialChar TeX
7610 layouts are exactly equivalent, so you shouldn't need to use both.
7614 \begin_layout Plain Layout
7615 In case you're curious, both were included so that
7619 would be able to translate both
7639 \begin_layout Subsubsection
7643 \begin_layout Standard
7644 There are a couple of important unique aspects of Rev\SpecialChar TeX
7646 bugs that will be even more confusing in \SpecialChar LyX
7650 \begin_layout Standard
7651 In Rev\SpecialChar TeX
7669 The \SpecialChar LyX
7670 equivalent is that there is a separate Thanks layout.
7675 write footnotes in the
7679 layout, or weird things may happen.
7680 See the Rev\SpecialChar TeX
7681 4 documentation for more details.
7684 \begin_layout Standard
7688 \begin_inset space ~
7696 \begin_inset space ~
7705 layouts must be placed
7713 layout and the corresponding
7730 , the \SpecialChar LaTeX
7734 \begin_layout Subsection
7736 \change_inserted 564990737 1671042072
7742 \begin_layout Standard
7744 \change_inserted 564990737 1671042072
7751 classes were replaced in 2013 with a completely new
7756 This package provides a \SpecialChar LaTeX
7757 class and templates for books to be published
7758 at Springer Gabler Research, Springer Vieweg Research, Springer Spektrum
7759 Research, Springer VS Research, or Springer VS Forschung.
7760 The documentation is available in German from
7761 \begin_inset CommandInset href
7764 target "http://mirrors.ctan.org/macros/latex/contrib/springer/sr-vorl/sr-vorl.pdf"
7772 \begin_layout Section
7774 \change_inserted 564990737 1670439560
7778 \begin_layout Standard
7780 \change_inserted 564990737 1670439581
7781 See also the document classes in the Collections (section
7782 \begin_inset space ~
7786 \begin_inset CommandInset ref
7788 reference "sec:Collections"
7795 \begin_layout Subsection
7799 \begin_layout Standard
7805 \begin_layout Subsubsection
7809 \begin_layout Standard
7810 Memoir is a very powerful and constantly evolving class.
7811 It has been designed with regard to fictional and non-fictional literature.
7812 Its aim is to let the user have maximum control over the typesetting of
7814 Memoir is based on the standard book class, but it can also emulate the
7815 article class (see below).
7818 \begin_layout Standard
7819 Peter Wilson, the developer of Memoir, is known as the author of lots of
7820 useful packages in the \SpecialChar LaTeX
7822 Most of them have been merged with Memoir.
7823 Therefore, it is much easier to layout the table of contents, appendices,
7824 chapter designs and such.
7826 , though, does not support all of these goodies natively.
7827 Some of them might be added to forthcoming releases
7831 \begin_layout Plain Layout
7832 You are invited to send suggestions to
7833 \begin_inset Flex URL
7836 \begin_layout Plain Layout
7838 lyx-devel@lists.lyx.org
7848 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
7850 Of course you can still use all features with the help of some native \SpecialChar LaTeX
7852 commands (\SpecialChar TeX
7857 \begin_layout Plain Layout
7862 \begin_layout Plain Layout
7872 \begin_inset space ~
7876 \begin_inset CommandInset ref
7878 reference "sec:Inserting-TeX-Code"
7888 In this section, we can only list those features that are natively supported
7891 For detailed descriptions (and for the rest of features) we recommend you
7892 have a look at the detailed manual of the Memoir class
7896 \begin_layout Plain Layout
7901 \begin_layout Plain Layout
7911 \begin_inset Flex URL
7914 \begin_layout Plain Layout
7916 CTAN:/macros/latex/memoir/memman.pdf
7926 , which is not only a user guide for the class, but also both a comprehensive
7927 description on good typesetting and a superb example for good typesetting
7931 \begin_layout Subsubsection
7932 Basic features and restrictions
7935 \begin_layout Standard
7936 Memoir supports basically all features of the standard book classes.
7937 There are, however, some differences, as follows:
7940 \begin_layout Description
7942 \begin_inset space ~
7945 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
7948 \begin_layout Description
7950 \begin_inset space ~
7953 style: The fancy page style is not supported, due to a command clash between
7954 Memoir and the fancyhdr package (they both define a command with the same
7955 name, which confuses \SpecialChar LaTeX
7957 Instead, Memoir comes with a number of its own page styles (see
7959 Document\SpecialChar menuseparator
7960 Settings\SpecialChar menuseparator
7962 \begin_inset space ~
7968 If you want to use these for the chapter pages, you have to use the command
7975 in the main text or in preamble (e.
7976 \begin_inset space \thinspace{}
7980 \begin_inset space \space{}
7987 chapterstyle{companion}
7992 \begin_layout Description
7993 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
7994 optional argument in the standard classes.
7995 With this, you can specify an alternative version of the title for the
7996 table of contents and the headers (for instance, if the title is too long).
7998 , you can do this via
8000 Insert\SpecialChar menuseparator
8002 \begin_inset space ~
8007 at the beginning of a chapter/section.
8008 Memoir features a second optional argument and thus separates the table
8009 of contents from the header.
8010 You can define three variants of a title with this: one for the main text,
8011 one for the table of contents, and one for the headers.
8013 makes these available in form of specific
8024 \begin_layout Description
8025 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
8026 of contents, the list of figures and the list of table start a new page
8028 Memoir does not follow this route.
8029 You have to insert a page break yourself, if you want to have one.
8032 \begin_layout Description
8033 Titlepage: For some unknown reason, Memoir uses pagination on the title
8034 page (in the standard classes, title pages are
8035 \begin_inset Quotes eld
8039 \begin_inset Quotes erd
8043 If you want an empty title page, type
8047 aliaspagestyle{title}{empty}
8052 \begin_layout Description
8053 Article: With the class option
8059 Document\SpecialChar menuseparator
8060 Settings\SpecialChar menuseparator
8061 Class Settings\SpecialChar menuseparator
8063 \begin_inset space ~
8068 ), you can emulate article style.
8069 That is, counters (footnotes, figures, tables etc.) will not be reset on
8070 new chapters, chapters don't start a new page (but are—in contrary to
8071 \begin_inset Quotes eld
8075 \begin_inset Quotes erd
8078 article classes—still allowed), parts, though, use their own page, as in
8082 \begin_layout Description
8083 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
8084 font commands, which have been used in the old \SpecialChar LaTeX
8086 \begin_inset space \thinspace{}
8090 \begin_inset space \space{}
8106 It produces an error and stops \SpecialChar LaTeX
8107 whenever such a command appears.
8112 reallows the commands and spits out warnings instead (which does at least
8113 not stop \SpecialChar LaTeX
8115 Since a lot of packages and particularly Bib\SpecialChar TeX
8116 style files are still using
8117 those commands, we have decided to use this option by default.
8120 \begin_layout Subsubsection
8124 \begin_layout Standard
8125 We will only describe the features supported by \SpecialChar LyX
8126 (which is not much currently).
8127 Please consult the Memoir manual
8131 \begin_layout Plain Layout
8136 \begin_layout Plain Layout
8146 \begin_inset Flex URL
8149 \begin_layout Plain Layout
8151 CTAN:/macros/latex/memoir/memman.pdf
8164 \begin_layout Description
8165 Abstract: You may wonder why an abstract is an extra feature.
8166 Well, it is in book class.
8167 Usually books don't have abstracts.
8168 Memoir, however, has.
8169 You can use it wherever and how often you like.
8172 \begin_layout Description
8173 Chapterprecis: You may know this older typesetting style: The contents of
8174 a chapter are summarized below the title and also in the table of contents
8176 \begin_inset space \thinspace{}
8180 \begin_inset space \space{}
8185 Our hero arrives in Troia; he loses some friends; he finds others
8188 Chapterprecis does exactly this.
8189 It is therefore only sensible below a chapter.
8192 \begin_layout Description
8193 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
8194 The epigraph environment provides an elegant way of typesetting such a
8196 The motto itself (text) and its (optional) author (source) are divided
8198 The author (source) can be inserted via
8200 Insert\SpecialChar menuseparator
8207 \begin_layout Description
8208 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
8209 complex figurative poems).
8211 can only support a few of them.
8212 One is poemtitle, which is a centered title for poems, which will also
8213 be added to the table of contents (verse is the standard environment for
8215 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
8217 because they have to be nested inside regular verse environments, which
8218 is not possible with \SpecialChar LyX
8222 \begin_layout Description
8223 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
8226 \begin_layout Subsection
8228 \change_inserted 564990737 1671442175
8234 \begin_layout Standard
8236 \change_inserted 564990737 1671442175
8246 \begin_inset space \thinspace{}
8251 document class but adds two environments:
8254 \begin_layout Description
8256 \change_inserted 564990737 1671442175
8259 Recipe a numbered section environment at the
8263 level which generates a bold centered heading above a double horizontal
8267 \begin_layout Description
8269 \change_inserted 564990737 1671442175
8282 are what are being described and the environment ends with a horizontal
8286 \begin_layout Standard
8288 \change_inserted 564990737 1671642866
8292 File\SpecialChar menuseparator
8293 Open Example\SpecialChar menuseparator
8294 Books\SpecialChar menuseparator
8298 illustrates its use.
8301 \begin_layout Standard
8303 \change_inserted 564990737 1671442175
8306 It is designed for typesetting one or two recipes per page, with dimensions
8308 \begin_inset Quotes qrd
8312 \begin_inset Quotes qrd
8316 The hyperlinked table of contents (ToC) and page numbers make browsing
8317 recipes convenient, and the pages can be joined together or printed 2 per
8318 page to normal letterpaper easily.
8319 The size was chosen to work in half-page 3-ring binder cover sheets, because
8320 un-laminated paper just doesn't last in the kitchen.
8323 \begin_layout Standard
8325 \change_inserted 564990737 1671442175
8328 The half-letter pages can be printed two per page using your printer driver,
8329 or bound together using
8331 pdfjam --nup 2x1 --papersize '{11in,8.5in}'
8341 is the compiled version of your recipes.
8344 \begin_layout Section
8346 \change_inserted 564990737 1671442207
8350 \begin_layout Subsection
8352 \change_inserted 564990737 1671442208
8358 \begin_layout Standard
8360 \change_inserted 564990737 1671642942
8366 \begin_inset space \space{}
8370 \begin_inset space \thinspace{}
8379 document class, an unofficial implementation of the ‘Europass CV’ recommended
8380 by the European Commission in 2013.
8384 File\SpecialChar menuseparator
8385 Open Example\SpecialChar menuseparator
8386 Curricula Vitae\SpecialChar menuseparator
8390 offers guidance on its use.
8391 Its documentation is available from
8392 \begin_inset CommandInset href
8395 target "http://mirrors.ctan.org/macros/latex/contrib/europasscv/europasscv.pdf"
8403 \begin_layout Subsection
8405 \change_inserted 564990737 1671442208
8411 \begin_layout Standard
8413 \change_inserted 564990737 1671642984
8419 \begin_inset space \space{}
8423 \begin_inset space \thinspace{}
8432 document class, an unofficial implementation of the “Europass CV” recommended
8433 by the European Commission in 2002.
8437 File\SpecialChar menuseparator
8438 Open Example\SpecialChar menuseparator
8439 Curricula Vitae\SpecialChar menuseparator
8443 offers guidance on its use.
8444 Its documentation is available from
8445 \begin_inset CommandInset href
8448 target "http://mirrors.ctan.org/macros/latex/contrib/europecv/europecv.pdf"
8456 \begin_layout Subsection
8458 \change_inserted 564990737 1671442208
8464 \begin_layout Standard
8466 \change_inserted 564990737 1671643003
8472 \begin_inset space \space{}
8476 \begin_inset space \thinspace{}
8486 This allows the creation of customizable CVs.
8490 File\SpecialChar menuseparator
8491 Open Example\SpecialChar menuseparator
8492 Curricula Vitae\SpecialChar menuseparator
8496 offers guidance on its use.
8497 Its documentation is available from
8498 \begin_inset CommandInset href
8501 target "http://mirrors.ctan.org/macros/latex/contrib/moderncv/manual/moderncv_userguide.pdf"
8509 \begin_layout Subsection
8511 \change_inserted 564990737 1671442208
8517 \begin_layout Standard
8519 \change_inserted 564990737 1671643024
8525 \begin_inset space \space{}
8529 \begin_inset space \thinspace{}
8538 document class, originally developed for use with \SpecialChar LyX
8543 File\SpecialChar menuseparator
8544 Open Example\SpecialChar menuseparator
8545 Curricula Vitae\SpecialChar menuseparator
8549 offers guidance on its use.
8550 Its documentation is available from
8551 \begin_inset CommandInset href
8554 target "http://mirrors.ctan.org/macros/latex/contrib/simplecv/simplecv.pdf"
8562 \begin_layout Section
8564 \change_inserted 564990737 1671041968
8568 \begin_layout Subsection
8570 \change_inserted 564990737 1671041970
8576 \begin_layout Standard
8578 \change_inserted 564990737 1671617528
8589 document class for writing letters according to the
8591 Deutsches Institut für Normung
8594 The file in the menu
8599 ile\SpecialChar menuseparator
8601 \begin_inset space ~
8609 \begin_inset space ~
8612 Template\SpecialChar menuseparator
8613 Letters\SpecialChar menuseparator
8616 offers guidance on its use.
8617 The documentation is available from
8618 \begin_inset CommandInset href
8621 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
8629 \begin_layout Subsection
8631 \change_inserted 564990737 1671458835
8637 \begin_layout Standard
8639 \change_inserted 564990737 1671617591
8650 document class for English letters and to create mailing labels.
8651 The file in the menu
8656 ile\SpecialChar menuseparator
8658 \begin_inset space ~
8666 \begin_inset space ~
8669 Template\SpecialChar menuseparator
8670 Letters\SpecialChar menuseparator
8671 Letter (Standard Class)
8673 offers guidance on its use.
8676 \begin_layout Section
8678 \change_inserted 564990737 1670439660
8682 \begin_layout Subsection
8684 \change_inserted 564990737 1671458922
8690 \begin_layout Standard
8692 \change_inserted 564990737 1671617655
8698 \begin_inset space \thinspace{}
8707 document class for creating presentations.
8708 The file in the menu
8713 ile\SpecialChar menuseparator
8715 \begin_inset space ~
8723 \begin_inset space ~
8726 Template\SpecialChar menuseparator
8727 Presentations\SpecialChar menuseparator
8730 offers guidance on its use.
8731 The documentation is available from
8732 \begin_inset CommandInset href
8735 target "http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf"
8743 \begin_layout Subsection
8746 Foil\SpecialChar TeX
8750 \begin_inset CommandInset label
8759 \begin_layout Standard
8765 \begin_layout Subsubsection
8769 \begin_layout Standard
8770 This section describes how to use \SpecialChar LyX
8771 to make slides for overhead projectors.
8772 There are two document classes that can do this: the default slides class
8775 Foil\SpecialChar TeX
8779 This section documents the latter.
8782 \begin_layout Standard
8783 I'm going to say this again, nice and clear, so that there's no misunderstanding
8787 \begin_layout Standard
8788 \begin_inset VSpace bigskip
8794 \begin_layout Standard
8798 This section documents the class
8799 \begin_inset Quotes eld
8807 \begin_inset Quotes erd
8815 \begin_layout Standard
8816 \begin_inset VSpace bigskip
8822 \begin_layout Standard
8823 If you're looking for the documentation for
8824 \begin_inset Quotes eld
8832 \begin_inset Quotes erd
8836 \begin_inset space ~
8840 \begin_inset CommandInset ref
8842 reference "sec:slitex"
8847 If your machine doesn't have the
8855 installed, you'll probably have to use the default
8859 class, which isn't quite as good as
8864 \begin_layout Standard
8869 class is designed for use with version
8870 \begin_inset space ~
8878 class file which is now an integral part of \SpecialChar LaTeX2e
8882 \begin_layout Subsubsection
8886 \begin_layout Standard
8887 Obviously, to use this document class, you need to select
8898 \begin_inset space ~
8904 There are some settings in the
8907 \begin_inset space ~
8912 dialog that you should know about that are specific to this class:
8915 \begin_layout Itemize
8916 Don't change the options
8927 \begin_inset space ~
8933 They're ignored by the
8940 \begin_layout Itemize
8941 The default font size is 20
8942 \begin_inset space \thinspace{}
8945 pt with the other options being 17
8946 \begin_inset space \thinspace{}
8950 \begin_inset space \thinspace{}
8954 \begin_inset space \thinspace{}
8960 \begin_layout Itemize
8969 but all math equations are still typeset in the usual roman font.
8972 \begin_layout Itemize
8975 Foil\SpecialChar TeX
8978 supports A4 and Letter paper sizes as well as a special size for working
8980 \begin_inset space \thinspace{}
8984 It doesn't support A5, B5, legal or executive paper sizes.
8987 \begin_layout Itemize
8988 Don't bother changing the
8992 settings because they are ignored anyway.
8993 All floats appear where they are defined in the text.
8996 \begin_layout Itemize
9001 setting behaves a bit differently for this class.
9004 Foil\SpecialChar TeX
9007 provides extensive footer and header capabilities including a user-defined
9010 \begin_inset space ~
9014 \begin_inset CommandInset ref
9016 reference "sec:foilfoot"
9021 The title page is treated differently to all other pages in the document
9030 has the logo centered at the bottom of the page (if one is defined).
9031 The possible page style choices and what they do are as follows:
9035 \begin_layout Labeling
9036 \labelwidthstring MMMMMMM
9043 The final output contains no page numbers, or other headers or footers
9044 (except footnotes of course).
9048 \begin_layout Labeling
9049 \labelwidthstring MMMMMMM
9056 The final output contains page numbers centered at the bottom of the page.
9057 No other headings or footers (other than footnotes).
9060 \begin_layout Labeling
9061 \labelwidthstring MMMMMMM
9066 Page numbers in lower right corner.
9067 Additional headers and footers are also shown.
9068 This is also the default.
9071 \begin_layout Labeling
9072 \labelwidthstring MMMMMMM
9077 Gives you access to the
9081 package although its use with
9083 Foil\SpecialChar TeX
9086 is discouraged by the writer of the
9088 Foil\SpecialChar TeX
9091 package because of some potential page layout clashes.
9095 \begin_layout Paragraph
9099 \begin_layout Standard
9100 The following options may be used in the extra class options in the
9102 Document\SpecialChar menuseparator
9108 \begin_layout Labeling
9109 \labelwidthstring MMMMMMx
9114 This sets up the page layout for 7.33
9115 \begin_inset space \thinspace{}
9119 \begin_inset space \thinspace{}
9122 in paper, which is about the same aspect ratio as a 35
9123 \begin_inset space \thinspace{}
9126 mm slide, making it a bit easier to work with this medium.
9129 \begin_layout Labeling
9130 \labelwidthstring MMMMMMx
9135 Places a rule across the page below the header on every page except the
9139 \begin_layout Labeling
9140 \labelwidthstring MMMMMMx
9145 Places a rule across the page above the footer on every page except the
9149 \begin_layout Labeling
9150 \labelwidthstring MMMMMMx
9155 This is automatically set each time you create a new
9162 Foil\SpecialChar TeX
9165 to use the dvips driver to rotate those pages that are set as landscape
9169 \begin_layout Labeling
9170 \labelwidthstring MMMMMMx
9175 Simply changes the page dimensions to those of a landscape page but doesn't
9177 Thus if you use this option you need to use an external program to rotate
9178 each page or feed your paper through your printer as landscape.
9179 Note that this option effectively reverses the roles of the
9187 environments (don't worry these are described in the next section).
9190 \begin_layout Labeling
9191 \labelwidthstring MMMMMMx
9196 Equation numbers on the left.
9199 \begin_layout Labeling
9200 \labelwidthstring MMMMMMx
9205 Flush-left equations.
9208 \begin_layout Subsubsection
9209 Supported Environments
9212 \begin_layout Standard
9213 Most of the environments commonly supported in other classes are also supported
9219 There are several additional environments provided by
9221 Foil\SpecialChar TeX
9224 as well as a couple added by \SpecialChar LyX
9226 The following environments are shared with other classes:
9229 \begin_layout Standard
9230 \begin_inset Flex Multiple Columns
9233 \begin_layout Itemize
9239 \begin_layout Itemize
9245 \begin_layout Itemize
9251 \begin_layout Itemize
9257 \begin_layout Itemize
9263 \begin_layout Itemize
9270 \begin_layout Itemize
9276 \begin_layout Itemize
9282 \begin_layout Itemize
9288 \begin_layout Itemize
9294 \begin_layout Itemize
9300 \begin_layout Itemize
9306 \begin_layout Itemize
9312 \begin_layout Itemize
9318 \begin_layout Itemize
9329 \begin_layout Standard
9330 That is, all the major environments apart from the sectioning environments.
9331 Since foils are essentially self-contained sections, with a title and body,
9334 Foil\SpecialChar TeX
9337 provides specific commands for starting new foils and these are:
9340 \begin_layout Itemize
9346 \begin_layout Itemize
9352 \begin_layout Standard
9354 also provides slightly modified versions of these two environments called:
9357 \begin_layout Itemize
9363 \begin_layout Itemize
9369 \begin_layout Standard
9370 and the differences will be explained in the next section.
9373 \begin_layout Standard
9374 Since foils are often used in presenting ideas or new theorems and such
9377 Foil\SpecialChar TeX
9380 also provides a comprehensive box of goodies for presenting them:
9383 \begin_layout Standard
9384 \begin_inset Flex Multiple Columns
9387 \begin_layout Itemize
9393 \begin_layout Itemize
9399 \begin_layout Itemize
9405 \begin_layout Itemize
9411 \begin_layout Itemize
9417 \begin_layout Itemize
9423 \begin_layout Itemize
9429 \begin_layout Itemize
9435 \begin_layout Itemize
9441 \begin_layout Itemize
9447 \begin_layout Itemize
9458 \begin_layout Standard
9459 The starred versions are unnumbered while the unstarred versions are numbered.
9460 There are also two list environments added by \SpecialChar LyX
9464 \begin_layout Itemize
9470 \begin_layout Itemize
9476 \begin_layout Standard
9479 Foil\SpecialChar TeX
9482 provides some powerful header and footer capabilities that are best set
9483 in the preamble although they may be set at any point in a document.
9484 If you want to change these settings in your document the best place to
9485 do so is at the very top of a foil, i.
9486 \begin_inset space \thinspace{}
9492 \begin_inset space \space{}
9497 straight after the foilhead.
9500 \begin_layout Standard
9501 For this purpose, the following command styles are provided [
9508 \begin_layout Standard
9509 \begin_inset Flex Multiple Columns
9512 \begin_layout Itemize
9516 \begin_inset space ~
9522 \begin_layout Itemize
9528 \begin_layout Itemize
9532 \begin_inset space ~
9538 \begin_layout Itemize
9542 \begin_inset space ~
9548 \begin_layout Itemize
9552 \begin_inset space ~
9559 \begin_layout Plain Layout
9560 \begin_inset space ~
9572 \begin_layout Standard
9573 There are also a few commands provided by
9575 Foil\SpecialChar TeX
9578 that aren't directly supported by \SpecialChar LyX
9579 but I'll tell you what they do and how
9580 to use them in section
9581 \begin_inset space ~
9585 \begin_inset CommandInset ref
9587 reference "sec:unsuppfoils"
9594 \begin_layout Subsubsection
9595 Building a Set of Foils
9598 \begin_layout Standard
9599 This section will give a simple introduction to using the different environments
9600 to build a set of foils.
9601 If you want to see an example set of foils, take a look at
9602 \change_deleted 564990737 1671643085
9607 file you find in \SpecialChar LyX
9613 \change_inserted 564990737 1671643099
9617 File\SpecialChar menuseparator
9620 \SpecialChar menuseparator
9621 Presentations\SpecialChar menuseparator
9629 \begin_layout Paragraph
9630 Give It a Title Page
9633 \begin_layout Standard
9634 Unlike other classes that provide
9654 creates the title on a page of its own.
9655 If you leave out the
9659 environment \SpecialChar LaTeX
9660 will substitute the current date (every time you regenerate
9664 \begin_layout Paragraph
9668 \begin_layout Standard
9669 As I mentioned earlier, there are four ways of starting a new foil.
9670 For portrait foils you should use
9679 The difference between these two environments is the amount of space between
9680 the title of the foil (the foilhead) and the body of the foil.
9683 \begin_layout Standard
9684 Landscape foils are generated using the
9693 Again the only difference is the spacing between foilhead and body.
9694 Both of the short versions have 0.5
9695 \begin_inset space ~
9698 inches less separation between the foilhead and the body.
9702 \begin_layout Standard
9703 One problem with the support for landscape foils is the requirement that
9708 driver to generate the PostScript output otherwise the foils won't be rotated.
9709 It is possible to get landscape foils even if you haven't got the
9713 driver provided you can feed your foils sideways through your printer ;-)
9716 \begin_layout Paragraph
9717 Theorems, Lemmas, Proofs and more
9720 \begin_layout Standard
9721 You can't have two of the same type of these environments directly following
9723 If you use a normal paragraph break, , you will just be extending the previous
9724 environment as if you had merged the two environments together.
9725 Rather than that, you need to insert a so-called separator.
9726 Please refer to the section entitled
9737 \begin_layout Paragraph
9741 \begin_layout Standard
9742 You get all the commonly supported list styles found in other classes as
9743 well as two new ones.
9744 I'll only describe the new ones here.
9745 If you want to find out more about the other list environments check out
9751 If you intend to use itemized lists you might also want to read about the
9755 \begin_inset space ~
9759 \begin_inset space ~
9764 dialog described above in section
9765 \begin_inset space ~
9769 \change_inserted 564990737 1671355684
9771 \begin_inset CommandInset ref
9773 reference "chap:bullets"
9778 \change_deleted 564990737 1671355684
9780 \begin_inset CommandInset ref
9782 reference "sec:bullet"
9791 \begin_layout Standard
9792 The two new list styles,
9800 , are designed to make it easier for you to create lists of do's and don'ts
9801 or right and wrong by providing dedicated environments that use a tick
9802 or a cross as the label of the list.
9803 These lists are in fact dedicated variants of the
9808 They do however require that you have the
9815 \begin_layout Paragraph
9819 \begin_layout Standard
9822 Foil\SpecialChar TeX
9825 redefines the floating tables and figures so that they appear exactly where
9826 they are in the text rather than pushing them to the top of the page or
9827 to some user specified location.
9828 In fact if you change the float placement settings they are simply ignored.
9831 \begin_layout Paragraph
9832 Page Headers and Footers
9833 \begin_inset CommandInset label
9842 \begin_layout Standard
9846 \begin_inset space ~
9855 are two commands used to control the left-footer text string.
9856 The first is meant to allow you to include a graphic logo on your foils
9858 \begin_inset Quotes eld
9863 Foil\SpecialChar TeX
9867 \begin_inset Quotes erd
9871 While the second is meant to provide a classification for the audience,
9875 \begin_inset space \thinspace{}
9881 \begin_inset space \space{}
9885 It is empty by default.
9888 \begin_layout Standard
9889 The remaining page corners can be filled by
9892 \begin_inset space ~
9897 (which defaults to page numbers),
9900 \begin_inset space ~
9908 \begin_inset space ~
9916 \begin_layout Subsubsection
9919 Foil\SpecialChar TeX
9923 \begin_inset CommandInset label
9925 name "sec:unsuppfoils"
9932 \begin_layout Standard
9933 All the commands mentioned below need to be set in a
9943 within another environment.
9946 \begin_layout Paragraph
9950 \begin_layout Standard
9951 All lengths are adjusted using the
9974 should be replaced by the name given to the length you want to change and
9979 is the length value.
9980 All lengths should be specified in units of length such as inches (
9992 ) or relative to some document or font-based length such as
10002 \begin_layout Standard
10003 It's possible to change the spacing between a foilhead and the body of the
10004 foil by adjusting the length specified by
10011 For example, to make
10016 \begin_inset space \space{}
10019 in closer to their bodies put the following in the preamble:
10025 foilheadskip}{-0.5in}
10028 \begin_layout Standard
10029 The spacings around floats can be adjusted by setting these lengths:
10032 \begin_layout Labeling
10033 \labelwidthstring MMMMMMMMMMM
10040 Separation between the text and the top of the float
10043 \begin_layout Labeling
10044 \labelwidthstring MMMMMMMMMMM
10051 Separation between the float and the caption
10054 \begin_layout Labeling
10055 \labelwidthstring MMMMMMMMMMM
10062 Separation between the caption and the following text
10065 \begin_layout Labeling
10066 \labelwidthstring MMMMMMMMMMM
10073 You can make the captions narrower than the surrounding text by adjusting
10075 Best done relative to
10084 \begin_layout Standard
10085 There are also several title page related lengths that you may find useful
10086 if you have a long title or several authors:
10089 \begin_layout Labeling
10090 \labelwidthstring MMMMMMMMMMM
10097 Separation from headers to
10102 \begin_layout Labeling
10103 \labelwidthstring MMMMMMMMMMM
10121 \begin_layout Labeling
10122 \labelwidthstring MMMMMMMMMMM
10136 \begin_layout Labeling
10137 \labelwidthstring MMMMMMMMMMM
10153 \begin_layout Labeling
10154 \labelwidthstring MMMMMMMMMMM
10170 \begin_layout Standard
10171 The last length related command affects all the list environments.
10182 a list environment then all the vertical spacing between the list items
10184 Note that this is a command not a length so it doesn't require
10190 like the stuff mentioned above.
10193 \begin_layout Paragraph
10194 Headers and Footers
10197 \begin_layout Standard
10210 commands control whether the logo in the
10214 definition appear on a given page.
10221 in the preamble then none of the foils will have the logo on them.
10222 If you don't want the logo on a particular page place the
10228 directly after the foilhead of that page and the
10234 directly after the next foilhead.
10237 \begin_layout Standard
10238 If you decide to use the
10242 page style setting in the
10245 \begin_inset space ~
10250 dialog you should probably add
10260 to your preamble so headers and footers on landscape pages are correctly
10261 placed when rotated.
10262 This is due to some clashes between the page layouts provided by the
10273 \begin_layout Subsection
10275 \change_inserted 564990737 1671459032
10281 \begin_layout Standard
10283 \change_inserted 564990737 1671643165
10289 \begin_inset space \thinspace{}
10298 document class for creating presentations.
10302 File\SpecialChar menuseparator
10303 Open Example\SpecialChar menuseparator
10304 Presentations\SpecialChar menuseparator
10308 offers guidance on its use.
10309 The documentation is available from
10310 \begin_inset CommandInset href
10313 target "http://mirrors.ctan.org/macros/latex/contrib/powerdot/doc/powerdot.pdf"
10321 \begin_layout Subsection
10323 \change_inserted 564990737 1671459032
10326 \begin_inset CommandInset label
10328 name "subsec:Seminar"
10337 \begin_layout Standard
10339 \change_inserted 564990737 1671643194
10345 \begin_inset space \thinspace{}
10354 document class for creating presentations.
10358 File\SpecialChar menuseparator
10359 Open Example\SpecialChar menuseparator
10360 Presentations\SpecialChar menuseparator
10364 offers guidance on its use.
10365 The documentation is available from
10366 \begin_inset CommandInset href
10369 target "http://mirrors.ctan.org/macros/latex/contrib/seminar/doc/seminar-doc.pdf"
10377 \begin_layout Subsection
10380 Sli\SpecialChar TeX
10384 \begin_inset CommandInset label
10393 \begin_layout Standard
10401 \begin_layout Subsubsection
10405 \begin_layout Standard
10406 This section describes how to use \SpecialChar LyX
10407 to make slides for overhead projectors.
10408 There are two document classes that can do this: the default slides class
10411 Foil\SpecialChar TeX
10415 This section documents the former.
10418 \begin_layout Standard
10419 I'm going to say this again, nice and clear, so that there's no misunderstanding
10423 \begin_layout Standard
10424 \begin_inset VSpace bigskip
10430 \begin_layout Standard
10434 This section documents the class
10435 \begin_inset Quotes eld
10443 \begin_inset Quotes erd
10451 \begin_layout Standard
10452 \begin_inset VSpace bigskip
10458 \begin_layout Standard
10459 If you're looking for the documentation for
10460 \begin_inset Quotes eld
10465 slides (Foil\SpecialChar TeX
10469 \begin_inset Quotes erd
10472 , check out section
10473 \begin_inset space ~
10477 \begin_inset CommandInset ref
10479 reference "sec:foiltex"
10489 \begin_inset Quotes eld
10494 slides (Foil\SpecialChar TeX
10498 \begin_inset Quotes erd
10501 ] is actually somewhat better than the default
10509 \begin_layout Plain Layout
10511 or so I've been told repeatedly by its advocates.
10512 Having never used it, I have no idea if this claim is true or not.
10517 which this section documents.
10520 \begin_layout Standard
10521 This class is the \SpecialChar LaTeX2e
10522 improvement of the old
10524 Sli\SpecialChar TeX
10528 Every \SpecialChar LaTeX2e
10529 distribution includes this class [which I'll just refer to as
10530 \begin_inset Quotes eld
10538 \begin_inset Quotes erd
10541 from now on], so you're bound to have it.
10542 As I noted earlier, there are other classes, such as
10546 , which also produce slides for overhead projectors and do a better job
10548 However, there are some things which
10552 can do which the others can't, such as generate overlays.
10553 Read on to learn more!
10556 \begin_layout Subsubsection
10558 \begin_inset CommandInset label
10560 name "sec:slidesetup"
10567 \begin_layout Standard
10568 Obviously, to use this document class, you need to select
10569 \begin_inset Quotes eld
10577 \begin_inset Quotes erd
10580 from the class list in the
10582 Document\SpecialChar menuseparator
10586 There are some other special things you should know about this class:
10589 \begin_layout Itemize
10590 Don't bother changing the options
10595 They're not supported by the
10602 \begin_layout Itemize
10606 \begin_inset space ~
10611 behaves a bit differently for this class.
10612 The possible choices and what they do are as follows:
10616 \begin_layout Description
10621 The final output contains page numbers in the lower right corner.
10624 \begin_layout Description
10633 , but also prints out any time markers you've put in.
10634 This is the default.
10637 \begin_layout Description
10642 The final output contains no page numbers, time markers, or alignment markers.
10646 \begin_layout Itemize
10651 class has an extra option:
10657 \begin_inset Quotes eld
10665 \begin_inset Quotes erd
10668 in the extra class options.
10672 \begin_layout Standard
10673 Using this options allows you to add time markers to
10679 \begin_inset space ~
10683 \begin_inset CommandInset ref
10685 reference "sec:slideNote"
10693 \begin_layout Standard
10694 You can also use the template file
10695 \change_deleted 564990737 1671617694
10697 \begin_inset Quotes eld
10705 \begin_inset Quotes erd
10710 to automatically set up a document to use the
10715 \change_deleted 564990737 1671617699
10720 File\SpecialChar menuseparator
10722 \begin_inset space ~
10726 \begin_inset space ~
10730 \change_inserted 564990737 1671617723
10731 \SpecialChar menuseparator
10732 Presentations\SpecialChar menuseparator
10737 to open your new document
10738 \change_deleted 564990737 1671617728
10742 The template file also contains some examples of the special paragraph
10743 environments used by this class.
10744 I'll describe those next.
10747 \begin_layout Subsubsection
10748 Paragraph Environments
10751 \begin_layout Paragraph
10752 Supported Environments
10755 \begin_layout Standard
10756 The first thing you'll notice when you start up a new
10760 document is the font size and type: it's the equivalent of the size
10761 \begin_inset Quotes eld
10769 \begin_inset Quotes erd
10775 \begin_inset space ~
10781 This is also what's used in the output.
10783 \begin_inset Quotes eld
10787 \begin_inset Quotes erd
10790 to remind you that this is a slide.
10791 Your final slides will use a larger font; ergo, you'll have less space.
10792 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
10795 \begin_layout Standard
10796 The next thing that becomes obvious is the changes to the paragraph environment
10797 pull-down box [at the far-left end of the toolbar].
10798 Most of the paragraph environments you're used to seeing are missing.
10799 There are also five new ones.
10804 class itself only supports certain paragraph environments:
10807 \begin_layout Itemize
10813 \begin_layout Itemize
10819 \begin_layout Itemize
10825 \begin_layout Itemize
10831 \begin_layout Itemize
10837 \begin_layout Itemize
10843 \begin_layout Itemize
10849 \begin_layout Itemize
10855 \begin_layout Itemize
10861 \begin_layout Itemize
10868 \begin_layout Standard
10869 All of the other standard environments, including the section-heading environmen
10870 ts, aren't used in the
10877 \begin_layout Standard
10878 On the other hand, you'll notice the following new environments:
10881 \begin_layout Itemize
10887 \begin_layout Itemize
10893 \begin_layout Itemize
10899 \begin_layout Itemize
10905 \begin_layout Itemize
10911 \begin_layout Standard
10912 These five are kind of quirky, due to a
10913 \begin_inset Quotes eld
10917 \begin_inset Quotes erd
10920 in \SpecialChar LyX
10922 You see, \SpecialChar LyX
10923 doesn't permit you to nest any other paragraph environment into
10924 an empty environment.
10925 Now, that's fine and dandy, but it means that you wouldn't be able to start
10926 a slide with anything except plain text.
10927 To deal with this, I've performed a little
10928 \begin_inset Quotes eld
10933 \begin_inset Quotes erd
10939 \begin_layout Paragraph
10940 Quirks of the New Environments
10941 \begin_inset CommandInset label
10943 name "sec:slideQuirk"
10950 \begin_layout Standard
10951 All five of the new paragraph environments are somewhat quirky due to inherent
10952 limitiations in the current version of \SpecialChar LyX
10954 As I just mentioned, \SpecialChar LyX
10955 forbids environments that begin with another environment.
10956 To get around this, the
10960 environment isn't a paragraph environment as described in the
10968 \begin_layout Standard
10969 You should consider
10982 \begin_inset Quotes eld
10985 pseudo-environments.
10986 \begin_inset Quotes erd
10989 They look like a section heading or a
10990 \begin_inset Quotes eld
10998 \begin_inset Quotes erd
11001 but really begin a [and, if necessary, end the previous] paragraph environment.
11011 \begin_inset Quotes eld
11015 \begin_inset Quotes erd
11018 These two perform some action.
11021 \begin_layout Standard
11022 A common feature of all five environments,
11042 , is a rather long-ish label.
11043 The text following this label — ordinarily the contents of the paragraph
11044 environment — is utterly irrelevant for
11066 completely ignores it.
11067 In fact, you can leave these five environments completely empty.
11071 \begin_layout Standard
11076 to put any text after the rather long-ish label, you might want to.
11077 This could be a short description of the contents of the
11082 In that case, enter your descriptive comment and hit
11086 as you normally would.
11089 \begin_layout Standard
11090 If, on the other hand, you don't want to enter any descriptive text, you'll
11091 hit another \SpecialChar LyX
11094 , like nature, abhors a vacuum, and will not let you start a new paragraph
11095 environment until you put something in the old one.
11099 \begin_layout Itemize
11100 Start entering the text that will
11128 \begin_layout Itemize
11129 Now move to the beginning of that paragraph.
11133 \begin_layout Itemize
11142 \begin_layout Itemize
11143 Finally, change this new, empty paragraph to a
11167 \begin_layout Standard
11168 Some future version of \SpecialChar LyX
11169 will, hopefully, resolve this quirkiness\SpecialChar ldots
11173 \begin_layout Subsubsection
11174 Making a Presentation with
11187 \begin_layout Paragraph
11195 \begin_layout Standard
11196 If you're expecting this section to teach you how to actually make a presentatio
11197 n, you'll be sorely disappointed.
11198 Naturally, I'll describe all of the ways the
11202 class can assist you in preparing the materials for a presentation.
11203 Filling in the contents, however, is up to you.
11208 the \SpecialChar LyX
11212 \begin_layout Standard
11217 environment [in the manner described in section
11218 \begin_inset space ~
11222 \begin_inset CommandInset ref
11224 reference "sec:slideQuirk"
11228 ] tells \SpecialChar LyX
11229 to begin a new slide [duh].
11230 The label for this environment/
11231 \begin_inset Quotes erd
11235 \begin_inset Quotes erd
11239 \begin_inset Quotes eld
11243 \begin_inset Quotes erd
11246 in cool blue, followed by the label,
11247 \begin_inset Quotes eld
11251 \begin_inset Quotes erd
11255 Any text or paragraph environments that follow this one go on the new slide.
11259 \begin_layout Standard
11260 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
11262 (this can be specified in the
11267 In fact, you'll want to, once you finish entering the contents of one slide.
11268 If you've entered more text than can physically fit on a slide, the extra
11269 overflows onto a new slide.
11270 I don't recommend doing this, however, since the overflow slide won't have
11271 any page number on it.
11272 Furthermore, it may interfere with any
11276 you've made to accompany the oversized
11283 \begin_layout Standard
11292 environments work the same way as the
11297 They both create an
11298 \begin_inset Quotes eld
11302 \begin_inset Quotes erd
11305 followed by a label [
11306 \begin_inset Quotes eld
11310 \begin_inset Quotes erd
11314 \begin_inset Quotes eld
11318 \begin_inset Quotes erd
11322 The color is a stunning magenta instead of blue, and the
11323 \begin_inset Quotes eld
11327 \begin_inset Quotes erd
11330 will look different, in style and in length.
11331 The label fonts of all three also differ from one another.
11334 \begin_layout Standard
11339 , if the contents of a
11347 exceed the physical size of a slide or sheet of paper, the extra will overflow
11349 Again, you should avoid this.
11350 It defeats the whole purpose of
11361 \begin_layout Paragraph
11371 \begin_layout Standard
11376 is a slide that sits atop another slide.
11377 Perhaps you wish to discuss a figure on the main
11381 before displaying the text associated with it.
11382 One way to accomplish this is tape a flap of dark paper over the part of
11387 you want to display later.
11388 This method fails, however, if you wish to overlap one graph with another,
11390 You would then have to fumble while speaking to align the two separate,
11395 s to align the two graphs.
11400 environment in both cases makes life much easier.
11403 \begin_layout Standard
11408 receives the page number of its
11409 \begin_inset Quotes eld
11413 \begin_inset Quotes erd
11421 \begin_inset Quotes eld
11429 \begin_inset Quotes erd
11436 \begin_layout Plain Layout
11437 Presumably, mutliple
11442 \begin_inset Quotes eld
11450 \begin_inset Quotes erd
11454 \begin_inset Quotes eld
11462 \begin_inset Quotes erd
11466 \begin_inset Quotes eld
11474 \begin_inset Quotes erd
11478 \begin_inset space ~
11481 appended to the page number of the parent
11491 Clearly, you want the contents of both the
11499 to each fit on a single physical slide! You should probably consider an
11505 \begin_inset Quotes eld
11509 \begin_inset Quotes erd
11517 Indeed, the \SpecialChar LyX
11522 class provides a visual cue for this: the label at the start of an
11526 is shorter than that at the start of a
11531 Lastly, when you generate printable output, you'll find alignment markers
11532 in all four corners of both the
11536 page and its parent
11541 These will assist you in lining up the two physical slides.
11544 \begin_layout Standard
11545 The major problem in overlaying two slides is aligning the contents of the
11546 two transparencies.
11547 How much space should you leave for that graph on the second slide? Worse
11548 still, what if you want a graph and a sentence on second slide, but there
11549 is text on the main transparency that goes in between them? You could try
11550 and insert vertical space of the right size.
11551 The better way is to use
11562 \begin_layout Standard
11563 As their names imply,
11571 are two command-like paragraph environments that make all subsequent text
11572 invisible and visible, respectively.
11574 \begin_inset space ~
11578 \begin_inset CommandInset ref
11580 reference "sec:slideQuirk"
11584 that you don't place anything
11588 these two environments, however.
11593 , it inserts a centered, sky-blue label into the page reading
11594 \begin_inset Quotes eld
11597 <Invisible Text Follows>
11598 \begin_inset Quotes erd
11602 For paragraphs following this label, the parts of the
11610 ; it doesn't matter which] where they would be contain instead blank space.
11614 \begin_layout Standard
11619 , the corresponding centered label is
11620 \begin_inset Quotes eld
11623 <Visible Text Follows>
11624 \begin_inset Quotes erd
11628 Paragraphs following this label behave normally.
11629 Note that the beginning of a new
11641 automatically shuts off an
11646 It's therefore not necessary to use
11657 \begin_layout Standard
11658 By now, it should be obvious how to create overlay transparencies using
11659 the proper combination of
11678 \begin_layout Enumerate
11683 , including everything that will appear on it, whether on the main slide
11691 \begin_layout Enumerate
11692 Before each figure or paragraph that will appear only on the
11701 If necessary, insert a
11705 environment after the
11712 \begin_layout Enumerate
11717 immediately following the
11724 \begin_layout Enumerate
11725 Copy the contents of this
11736 \begin_layout Enumerate
11741 , change all of the
11752 \begin_layout Standard
11754 You've just made an
11761 \begin_layout Standard
11762 There's one problem with the way I've designed the \SpecialChar LyX
11767 class: you can't make text in the middle of a paragraph invisible, nor
11768 make text in the middle of an invisible paragraph visible again.
11769 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
11774 \begin_layout Plain Layout
11775 The commands of interest are:
11778 \begin_layout Itemize
11783 invisible \SpecialChar ldots
11787 \begin_layout Itemize
11792 visible \SpecialChar ldots
11796 \begin_layout Plain Layout
11798 and need to be marked as \SpecialChar TeX
11801 \begin_inset Quotes eld
11805 \begin_inset Quotes erd
11808 you wish to change goes in between the brackets [and after the
11821 If you don't know how to mark text as \SpecialChar TeX
11822 , see the appropriate section of
11835 \begin_layout Paragraph
11845 \begin_inset CommandInset label
11847 name "sec:slideNote"
11854 \begin_layout Standard
11863 is associated with a
11864 \begin_inset Quotes eld
11868 \begin_inset Quotes erd
11876 Here, too, the \SpecialChar LyX
11881 class provides visual cues.
11886 is shorter than that of a
11890 [yet longer than that of an
11894 ] and, like the label of an
11898 is shockingly magenta.
11899 Additionally, the printed
11903 has the page number of its
11904 \begin_inset Quotes eld
11908 \begin_inset Quotes erd
11916 \begin_inset Quotes eld
11924 \begin_inset Quotes erd
11928 \begin_inset Quotes eld
11936 \begin_inset Quotes erd
11940 \begin_inset Quotes eld
11948 \begin_inset Quotes erd
11952 You can have multiple
11956 s associated with a single
11968 , you'll probably want to break up long
11972 s so that they fit on a single sheet of paper.
11975 \begin_layout Standard
11980 is obvious: it contains anything additional you might want to say about
11986 It could also be used as a sheet of reminders for a particular
11991 In the case of the latter, you might want to make use of time markers.
11992 Currently, the \SpecialChar LyX
11998 \begin_inset Quotes eld
12002 \begin_inset Quotes erd
12005 support for time markers, a
12007 Sli\SpecialChar TeX
12011 So, you'll have to resort to using the \SpecialChar LaTeX
12015 \begin_layout Standard
12016 To use time markers, you'll need to specify the extra class option
12017 \begin_inset Quotes eld
12025 \begin_inset Quotes erd
12029 \begin_inset space ~
12033 \begin_inset CommandInset ref
12035 reference "sec:slidesetup"
12040 This option turns on timing marks, which will appear in the lower-left-hand
12046 To set what appears in the time marker, you use the \SpecialChar LaTeX
12048 \begin_inset Quotes eld
12058 \begin_inset Quotes erd
12062 \begin_inset Quotes eld
12072 \begin_inset Quotes erd
12076 The arguments of both commands are time measured in seconds.
12078 \begin_inset Quotes eld
12088 \begin_inset Quotes erd
12091 sets the time marker to a given time.
12093 \begin_inset Quotes eld
12103 \begin_inset Quotes erd
12106 increments the time marker by the specified amount.
12107 Using time markers and
12111 s in this fashion, you can remind yourself how much time to spend on a particula
12119 \begin_layout Standard
12120 There's one last feature to describe.
12121 Clearly, you'd like to print out all of your
12129 s on transparencies while printing all of your
12146 with which it is associated.
12147 What's a person to do?
12150 \begin_layout Standard
12151 Luckily, there are two \SpecialChar LaTeX
12152 commands that allow you to select what to print
12154 Both must be placed into the preamble of your document.
12156 \begin_inset Quotes eld
12168 \begin_inset Quotes erd
12171 will cause the output to contain only the
12180 Correspondingly, the command
12181 \begin_inset Quotes eld
12193 \begin_inset Quotes erd
12196 prevents the output of anything but
12201 I'd advise placing both commands in the preamble and initially comment
12203 You can then preview your entire presentation as you write.
12204 When you're done writing, you can then uncomment one of the two to select
12205 what you want to print.
12206 I like to uncomment
12207 \begin_inset Quotes eld
12219 \begin_inset Quotes erd
12222 , print to a file with
12223 \begin_inset Quotes eld
12231 \begin_inset Quotes erd
12234 in its name, comment it back out, then uncomment
12235 \begin_inset Quotes eld
12247 \begin_inset Quotes erd
12251 \begin_inset Quotes eld
12259 \begin_inset Quotes erd
12263 I can then send either file to a printer, loading transparencies or plain
12264 paper as appropriate.
12267 \begin_layout Standard
12268 You can also provide other arguments to the
12269 \begin_inset Quotes eld
12279 \begin_inset Quotes erd
12283 \begin_inset Quotes eld
12293 \begin_inset Quotes erd
12297 See a good \SpecialChar LaTeX
12301 \begin_layout Subsubsection
12306 Class Template File
12309 \begin_layout Standard
12310 I have also provided a template file
12311 \change_deleted 564990737 1671617750
12313 \begin_inset Quotes eld
12321 \begin_inset Quotes erd
12331 To use it, begin your new presentation with
12333 File\SpecialChar menuseparator
12335 \begin_inset space ~
12339 \begin_inset space ~
12343 \change_inserted 564990737 1671616988
12344 \SpecialChar menuseparator
12345 Presentations\SpecialChar menuseparator
12351 Your new \SpecialChar LyX
12352 presentation file will contain an example
12373 additionally contain an example of the use of
12382 Lastly, the preamble will contain:
12385 \begin_layout LyX-Code
12386 % Uncomment to print out only slides and overlays
12389 \begin_layout LyX-Code
12393 \begin_layout LyX-Code
12399 \begin_inset Newline newline
12405 \begin_layout LyX-Code
12406 % Uncomment to print out only notes
12409 \begin_layout LyX-Code
12413 \begin_layout LyX-Code
12421 \begin_layout Standard
12422 One final thing: I created this class to support the \SpecialChar LaTeX2e
12424 \begin_inset Quotes eld
12429 Sli\SpecialChar TeX
12433 \begin_inset Quotes erd
12436 class, one of the built-in \SpecialChar LaTeX2e
12438 Neither I nor the rest of the \SpecialChar LyX
12439 Team endorse or oppose the use of this built-in
12441 It's here if you want it or need it.
12442 There exist other \SpecialChar LaTeX2e
12443 classes for creating presentations, such as the
12448 \begin_inset space ~
12452 \begin_inset CommandInset ref
12454 reference "sec:foiltex"
12459 \begin_inset Quotes eld
12467 \begin_inset Quotes erd
12470 package [present on some \SpecialChar TeX
12472 The latter is not yet supported under \SpecialChar LyX
12477 \begin_layout Plain Layout
12478 Perhaps you can take on the task\SpecialChar ldots
12484 I know nothing about these other classes.
12485 Try them out to see what sort of alternative they provide.
12488 \begin_layout Section
12490 \change_inserted 564990737 1670439661
12494 \begin_layout Subsection
12496 \change_inserted 564990737 1670439661
12500 \begin_layout Standard
12502 \change_inserted 564990737 1670439661
12511 document class for preparing reports.
12516 document class, this provides parts, chapters and sections but does not
12517 provide the paragraph styles needed for a book; like the
12521 document class, it provides the abstract paragraph style.
12522 In two-sided mode, it does not start a new chapter on the right hand page.
12525 \begin_layout Standard
12527 \change_inserted 564990737 1670439674
12532 document classes are described in the Collections (section
12533 \begin_inset space ~
12537 \begin_inset CommandInset ref
12539 reference "sec:Collections"
12546 \begin_layout Section
12548 \change_inserted 564990737 1670439674
12552 \begin_layout Subsection
12556 \begin_layout Standard
12562 \begin_layout Subsubsection
12566 \begin_layout Standard
12567 Broadway is for writing plays.
12568 The format is more decorative than Hollywood, and much less standardized.
12569 This format should be suitable for workshops.
12572 \begin_layout Subsubsection
12576 \begin_layout Standard
12577 The same as in Hollywood.
12580 \begin_layout Subsubsection
12584 \begin_layout Standard
12589 names as labels then cross-reference the label to insert the name.
12590 The cross-reference dialog will show the current cast of characters.
12593 \begin_layout Subsubsection
12594 Paper size and Margins
12597 \begin_layout Standard
12598 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12601 \begin_layout Subsubsection
12605 \begin_layout Standard
12606 The following environments are available.
12607 You can use broadway.bind to get the bind keys shown at the right.
12610 \begin_layout Itemize
12614 \begin_inset Newline newline
12619 You should not have to use this, but it is here for anything that does not
12623 \begin_layout Itemize
12627 \begin_inset space \hfill{}
12631 \begin_inset Newline newline
12636 Used to describe stage setting and the action.
12637 First use of speaker names in all CAPs.
12640 \begin_layout Itemize
12644 \begin_inset space \hfill{}
12648 \begin_inset Newline newline
12653 Automatically numbered.
12654 On screen it will be arabic, but will print as Roman.
12657 \begin_layout Itemize
12661 \begin_inset space \hfill{}
12665 \begin_inset Newline newline
12675 It is just centered text.
12678 \begin_layout Itemize
12682 \begin_inset space \hfill{}
12686 \begin_inset Newline newline
12691 Not automatically numbered.
12692 You supply the number.
12693 This is because I couldn't figure out how.
12696 \begin_layout Itemize
12700 \begin_inset space \hfill{}
12704 \begin_inset Newline newline
12709 A special case of Narrative to describe the setting and action as the curtain
12713 \begin_layout Itemize
12717 \begin_inset space \hfill{}
12721 \begin_inset Newline newline
12726 The speaker's (actor's) title, centered in all CAPS.
12729 \begin_layout Itemize
12733 \begin_inset space \hfill{}
12737 \begin_inset Newline newline
12742 Instructions to the speaker.
12743 The parentheses are automatically inserted.
12744 The ( will appear on screen, but both will be in the printed play.
12745 This environment is only used within
12752 \begin_layout Itemize
12756 \begin_inset space \hfill{}
12760 \begin_inset Newline newline
12765 What the Speaker says.
12768 \begin_layout Itemize
12772 \begin_inset space \hfill{}
12776 \begin_inset Newline newline
12781 The curtain comes down.
12784 \begin_layout Itemize
12788 \begin_inset space \hfill{}
12794 \begin_layout Itemize
12798 \begin_inset space \hfill{}
12804 \begin_layout Itemize
12808 \begin_inset space \hfill{}
12814 \begin_layout Standard
12818 \begin_layout Subsection
12819 Hollywood (Hollywood spec scripts)
12822 \begin_layout Standard
12828 \begin_layout Subsubsection
12832 \begin_layout Standard
12833 Getting the format of a Hollywood script right is a
12834 \begin_inset Quotes eld
12838 \begin_inset Quotes erd
12841 It is designed to make the readers focus on content and to be easy and
12842 familiar for the actors to read.
12843 Each page of a script should be one minute of film.
12844 Nothing goes in a script that you cannot see or hear on screen.
12845 The courier 12 pt font should be used throughout.
12849 \begin_layout Subsubsection
12853 \begin_layout Standard
12854 Speakers' lines should NEVER break in mid-sentence.
12855 If a speaker's lines continue over a page break, repeat the
12859 title followed by (Cont'd).
12862 \begin_layout Subsubsection
12866 \begin_layout Standard
12871 names as labels then cross-reference the label to insert the name.
12872 The cross-reference dialog will show the current cast of characters.
12873 You can use this to insert the speaker name in narratives also.
12876 \begin_layout Subsubsection
12877 Paper size and Margins
12880 \begin_layout Standard
12881 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12884 \begin_layout Subsubsection
12888 \begin_layout Standard
12889 The following environments are available.
12890 You can use hollywood.bind to get the bind keys shown at the right.
12893 \begin_layout Itemize
12897 \begin_inset Newline newline
12902 Used where nothing else works.
12906 \begin_layout Itemize
12912 \begin_inset space \hfill{}
12920 \begin_inset Newline newline
12923 Usually followed by something like
12924 \begin_inset Quotes eld
12927 on Sally waking up.
12928 \begin_inset Quotes erd
12934 \begin_layout Itemize
12938 \begin_inset space \hfill{}
12942 \begin_inset Newline newline
12947 Introduces a new INTERIOR camera set-up.
12948 Always followed by DAY or NIGHT, or something similar to define the lighting
12950 Everthing on this line in CAPS.
12953 \begin_layout Itemize
12957 \begin_inset space \hfill{}
12961 \begin_inset Newline newline
12966 Introduces a new EXTERIOR camera set-up.
12967 Everthing on this line in CAPS.
12970 \begin_layout Itemize
12974 \begin_inset space \hfill{}
12978 \begin_inset Newline newline
12983 The character speaking.
12986 \begin_layout Itemize
12990 \begin_inset space \hfill{}
12994 \begin_inset Newline newline
12999 Instructions to the speaker.
13000 The () are automatically inserted.
13003 \begin_layout Itemize
13007 \begin_inset space \hfill{}
13011 \begin_inset Newline newline
13023 \begin_layout Itemize
13027 \begin_inset space \hfill{}
13031 \begin_inset Newline newline
13036 Camera movement instruction.
13038 \begin_inset space \thinspace{}
13042 \begin_inset space \space{}
13048 \begin_layout Itemize
13052 \begin_inset space \hfill{}
13058 \begin_layout Itemize
13062 \begin_inset space \hfill{}
13068 \begin_layout Itemize
13072 \begin_inset space \hfill{}
13078 \begin_layout Itemize
13082 \begin_inset space \hfill{}
13088 \begin_layout Subsubsection
13092 \begin_layout Itemize
13096 \begin_layout Itemize
13100 \begin_layout Itemize
13102 \begin_inset space \thinspace{}
13109 \begin_layout Itemize
13114 \begin_layout Itemize
13115 PAN — camera movement
13118 \begin_layout Itemize
13119 INSERT — cut to close-up of
13122 \begin_layout Chapter
13124 \change_inserted 564990737 1671185876
13128 \begin_layout Section
13130 \change_inserted 564990737 1671716212
13133 Academic Field Specifics
13136 \begin_layout Subsection
13138 \change_inserted 564990737 1671716212
13141 Chemistry: Hazard and Precautionary Statements
13144 \begin_layout Standard
13146 \change_inserted 564990737 1671716212
13149 This module provides two insets to typeset numbers and phrases of chemical
13150 hazard and precautionary statements.
13151 For a description see
13154 File\SpecialChar menuseparator
13155 Open Example\SpecialChar menuseparator
13156 Modules\SpecialChar menuseparator
13157 Hazard and Precautionary Statements
13161 Help\SpecialChar menuseparator
13162 Specific Manuals\SpecialChar menuseparator
13163 Hazard and Precautionary Statements
13169 \begin_layout Subsection
13171 \change_inserted 564990737 1671716212
13175 Chemistry: Risk and Safety Statements
13178 \begin_layout Standard
13180 \change_inserted 564990737 1671716212
13183 This module provides two insets,
13191 , accessible via the menu
13196 nsert\SpecialChar menuseparator
13198 \begin_inset space ~
13203 and an environment to typeset numbers and phrases of chemical risk and
13207 \begin_layout Subsection
13209 \change_inserted 564990737 1671716212
13215 \begin_layout Standard
13217 \change_inserted 564990737 1671716212
13220 This module uses the
13224 package to add environments useful for linguistics (numbered examples,
13225 glosses, semantic markup, tableau floats).
13226 You can obtain information about this module in
13231 elp\SpecialChar menuseparator
13237 \begin_inset space ~
13240 Manuals\SpecialChar menuseparator
13250 File\SpecialChar menuseparator
13251 Open Example\SpecialChar menuseparator
13254 Modules\SpecialChar menuseparator
13260 \begin_layout Section
13262 \change_inserted 564990737 1671788778
13268 \begin_layout Subsection
13270 \change_inserted 564990737 1671788778
13276 \begin_layout Standard
13278 \change_inserted 564990737 1671788778
13281 This module supports the Braille writing system.
13282 It requires the \SpecialChar LaTeX
13288 This and its documentation can be obtained from
13289 \begin_inset CommandInset href
13292 target "https://www.ctan.org/pkg/braille"
13298 You do not have to reconfigure your system after installing it.
13304 elp\SpecialChar menuseparator
13310 \begin_inset space ~
13313 Manuals\SpecialChar menuseparator
13322 File\SpecialChar menuseparator
13323 Open Example\SpecialChar menuseparator
13324 Modules\SpecialChar menuseparator
13330 \begin_layout Section
13332 \change_inserted 564990737 1671788778
13335 Annotation & Revision
13338 \begin_layout Subsection
13340 \change_inserted 564990737 1671788778
13346 \begin_layout Standard
13348 \change_inserted 564990737 1671788778
13351 This module provides “FiXme” (marginal) annotations for document revision
13353 A list of annotations can be produced by using the “List of FIXMEs” paragraph
13355 The annotations are customizable via the LaTeX preamble.
13356 See the FiXme documentation which can be obtained from
13357 \begin_inset CommandInset href
13360 target "http://mirrors.ctan.org/macros/latex/contrib/fixme/fixme.pdf"
13369 \begin_layout Paragraph
13371 \change_inserted 564990737 1671788778
13377 \begin_layout Standard
13379 \change_inserted 564990737 1671788778
13382 by default, the notes are only displayed in “draft” mode (if the option
13383 “draft” has been inserted in
13385 Document\SpecialChar menuseparator
13386 Settings\SpecialChar menuseparator
13387 Document Class\SpecialChar menuseparator
13388 Class Options\SpecialChar menuseparator
13392 To display them always, insert
13400 Document\SpecialChar menuseparator
13401 Settings\SpecialChar menuseparator
13409 \begin_layout Subsection
13411 \change_inserted 564990737 1671788778
13417 \begin_layout Standard
13419 \change_inserted 564990737 1671788778
13422 This module provides various kinds of annotations for PDF output.
13425 Help\SpecialChar menuseparator
13426 Specific Manuals\SpecialChar menuseparator
13427 PDF comments and File\SpecialChar menuseparator
13428 Open Example\SpecialChar menuseparator
13429 Modules\SpecialChar menuseparator
13435 \begin_layout Subsection
13437 \change_inserted 564990737 1671788778
13444 \begin_layout Standard
13446 \change_inserted 564990737 1671788778
13449 This module provides fields and buttons for PDF forms.
13451 \begin_inset CommandInset href
13453 name "hyperref documentation"
13454 target "http://mirrors.ctan.org/macros/latex/contrib/hyperref/doc/hyperref-doc.pdf"
13461 Help\SpecialChar menuseparator
13462 Specific Manuals\SpecialChar menuseparator
13463 PDF forms and File\SpecialChar menuseparator
13464 Open Example\SpecialChar menuseparator
13465 Modules\SpecialChar menuseparator
13471 \begin_layout Subsection
13473 \change_inserted 564990737 1671788778
13480 \begin_layout Standard
13482 \change_inserted 564990737 1671788778
13485 This module defines an inset to typeset reading aids (ruby, furigana) to
13486 Chinese characters.
13487 It uses the “okumakro,” “luatexja-ruby” or “ruby” package (depending on
13488 the TeX engine) or a fallback definition.
13492 \begin_layout Subsection
13494 \change_inserted 564990737 1671788778
13501 \begin_layout Standard
13503 \change_inserted 564990737 1671788778
13506 This module provides custom insets to insert TODO items in your document.
13507 In order to generate a “List of TODOs,” the module provides a paragraph
13509 Inserting “final” in
13511 Document\SpecialChar menuseparator
13512 Settings\SpecialChar menuseparator
13513 Document Class\SpecialChar menuseparator
13514 Class Options\SpecialChar menuseparator
13517 ) suppresses the output of TODO notes.
13519 \begin_inset CommandInset href
13521 name "todonotes documentation"
13522 target "http://mirrors.ctan.org/macros/latex/contrib/todonotes/todonotes.pdf"
13530 \begin_layout Section
13532 \change_inserted 564990737 1671829045
13538 \begin_layout Subsection
13540 \change_inserted 564990737 1671829045
13543 APA Style with NatBib
13546 \begin_layout Standard
13548 \change_inserted 564990737 1671829045
13551 This module adds support for using natbib together with apacite (the bibliograph
13552 y style need not be apacite — it could be apacite, apacitex, or any bibliography
13553 that works with both the natbib and apacite packages.)
13556 \begin_layout Section
13558 \change_inserted 564990737 1671829045
13564 \begin_layout Subsection
13566 \change_inserted 564990737 1671829045
13569 Fancy Colored Boxes
13572 \begin_layout Standard
13574 \change_inserted 564990737 1671829045
13577 This module adds ten custom insets that support colored boxes via the tcolorbox
13581 Help\SpecialChar menuseparator
13582 Specific Manuals\SpecialChar menuseparator
13587 File\SpecialChar menuseparator
13588 Open Example\SpecialChar menuseparator
13589 Modules\SpecialChar menuseparator
13593 \begin_inset CommandInset href
13595 name "tcolorbox documentation"
13596 target "http://mirrors.ctan.org/macros/latex/contrib/tcolorbox/tcolorbox.pdf"
13605 \begin_layout Subsection
13607 \change_inserted 564990737 1671829045
13613 \begin_layout Standard
13615 \change_inserted 564990737 1671829045
13618 This provides the custom insets
13634 to scale and rotate its content.
13637 \begin_layout Standard
13639 \change_inserted 564990737 1671829045
13645 is a simple way of reversing text without any other enhancement:
13648 \begin_layout Standard
13650 \change_inserted 564990737 1671829045
13653 \begin_inset Flex Reflectbox
13656 \begin_layout Plain Layout
13658 \change_inserted 564990737 1671829045
13661 Great Western Railway
13671 \begin_layout Standard
13673 \change_inserted 564990737 1671829045
13676 (You will need to use Ctrl-R to see any of these examples.)
13679 \begin_layout Standard
13681 \change_inserted 564990737 1671829045
13687 allows you to specify the dimensions of the text or image; permissible
13688 units are em, ex, in, pt, pc, cm, mm, dd, cc, nd, nc, bp, or sp; if you
13697 it scales by the width factor:
13700 \begin_layout Standard
13702 \change_inserted 564990737 1671829045
13705 \begin_inset Flex Resizebox
13708 \begin_layout Plain Layout
13710 \change_inserted 564990737 1671829045
13713 \begin_inset Argument 1
13716 \begin_layout Plain Layout
13718 \change_inserted 564990737 1671829045
13729 \begin_inset Argument 2
13732 \begin_layout Plain Layout
13734 \change_inserted 564990737 1671829045
13744 Great Western Railway
13754 \begin_layout Standard
13756 \change_inserted 564990737 1671829045
13762 allows you to rotate text around the reference point of the box.
13763 If you wish to rotate the box around a different origin, place the cursor
13764 inside the box and select Insert\SpecialChar menuseparator
13789 or meaningful combinations of these and the counterclockwise rotation angle
13790 is expressed in degrees.
13794 \begin_layout Standard
13796 \change_inserted 564990737 1671829045
13799 \begin_inset Flex Rotatebox
13802 \begin_layout Plain Layout
13804 \change_inserted 564990737 1671829045
13807 \begin_inset Argument 1
13810 \begin_layout Plain Layout
13812 \change_inserted 564990737 1671829045
13823 \begin_inset Argument 2
13826 \begin_layout Plain Layout
13828 \change_inserted 564990737 1671829045
13838 Great Western Railway
13848 \begin_layout Standard
13850 \change_inserted 564990737 1671829045
13853 You can combine boxes as in:
13856 \begin_layout Standard
13858 \change_inserted 564990737 1671829045
13861 \begin_inset Flex Rotatebox
13864 \begin_layout Plain Layout
13866 \change_inserted 564990737 1671829045
13869 \begin_inset Argument 1
13872 \begin_layout Plain Layout
13874 \change_inserted 564990737 1671829045
13885 \begin_inset Argument 2
13888 \begin_layout Plain Layout
13890 \change_inserted 564990737 1671829045
13901 \begin_inset Flex Resizebox
13904 \begin_layout Plain Layout
13906 \change_inserted 564990737 1671829045
13909 \begin_inset Argument 1
13912 \begin_layout Plain Layout
13914 \change_inserted 564990737 1671829045
13925 \begin_inset Argument 2
13928 \begin_layout Plain Layout
13930 \change_inserted 564990737 1671829045
13941 \begin_inset Flex Reflectbox
13944 \begin_layout Plain Layout
13946 \change_inserted 564990737 1671829045
13949 Great Western Railway
13973 \begin_layout Standard
13975 \change_inserted 564990737 1671829045
13981 scales text; select Insert\SpecialChar menuseparator
13982 V-Factor to add a vertical factor.
13983 If the vertical factor is omitted, the horizontal is used.
13984 Adding different horizontal and vertical values creates distortion as in
13988 \begin_layout Standard
13990 \change_inserted 564990737 1671829045
13994 \begin_inset Flex Scalebox
13997 \begin_layout Plain Layout
13999 \change_inserted 564990737 1671829045
14002 \begin_inset Argument 1
14005 \begin_layout Plain Layout
14007 \change_inserted 564990737 1671829045
14018 \begin_inset Argument 2
14021 \begin_layout Plain Layout
14023 \change_inserted 564990737 1671829045
14035 Great Western Railway
14045 \begin_layout Standard
14047 \change_inserted 564990737 1671829045
14050 A negative horizontal value reverses the text and a negative vertical value
14051 inverts it so that you get
14054 \begin_layout Standard
14056 \change_inserted 564990737 1671829045
14059 \begin_inset Flex Scalebox
14062 \begin_layout Plain Layout
14064 \change_inserted 564990737 1671829045
14067 \begin_inset Argument 1
14070 \begin_layout Plain Layout
14072 \change_inserted 564990737 1671829045
14083 \begin_inset Argument 2
14086 \begin_layout Plain Layout
14088 \change_inserted 564990737 1671829045
14098 Great Western Railway
14106 \begin_inset Flex Scalebox
14109 \begin_layout Plain Layout
14111 \change_inserted 564990737 1671829045
14114 \begin_inset Argument 1
14117 \begin_layout Plain Layout
14119 \change_inserted 564990737 1671829045
14130 \begin_inset Argument 2
14133 \begin_layout Plain Layout
14135 \change_inserted 564990737 1671829045
14145 Great Western Railway
14155 \begin_layout Subsection
14157 \change_inserted 564990737 1671884699
14163 \begin_layout Standard
14165 \change_inserted 564990737 1671884699
14168 This module defines Boxes with section header.
14169 It is mainly intended for the SciPoster Document class.
14173 \begin_layout Subsection
14175 \change_inserted 564990737 1671884699
14178 Variable-width Minipages
14181 \begin_layout Standard
14183 \change_inserted 564990737 1671884699
14189 \begin_inset space \thinspace{}
14196 Insert\SpecialChar menuseparator
14208 package provides a variable-width minipage, whose resulting width is the
14209 width of its contents (if this does not exceed the specified maximum width).
14210 The inset has two optional arguments which can be added by placing the
14211 cursor inside the minipage and entering
14213 Insert\SpecialChar menuseparator
14215 \begin_inset space \thinspace{}
14226 Insert\SpecialChar menuseparator
14228 \begin_inset space \thinspace{}
14242 File\SpecialChar menuseparator
14243 Open Example\SpecialChar menuseparator
14244 Variable-width Minipages
14250 \begin_layout Section
14252 \change_inserted 564990737 1671884699
14258 \begin_layout Subsection
14260 \change_inserted 564990737 1671884699
14263 Fix Computer Modern Fonts
14266 \begin_layout Standard
14268 \change_inserted 564990737 1671884699
14271 This module uses the
14275 package to improve the appearance of Computer Modern fonts and make them
14276 available with arbitrary sizes.
14278 \begin_inset CommandInset href
14280 name "fix-cm documentation"
14281 target "http://mirrors.ctan.org/macros/latex/base/fix-cm.pdf"
14290 \begin_layout Subsection
14292 \change_inserted 564990737 1671884699
14296 Kernel Fixes (Obsolete)
14299 \begin_layout Standard
14301 \change_inserted 564990737 1671884699
14304 This module loads the \SpecialChar LaTeX
14309 which contains some bug fixes for \SpecialChar LaTeX
14311 If you use this module your typeset document may look different when you
14312 process it, depending on the respective version of
14320 \begin_layout Paragraph
14322 \change_inserted 564990737 1671884699
14328 \begin_layout Standard
14330 \change_inserted 564990737 1671884699
14333 recent \SpecialChar LaTeX
14334 kernels (as of 2015/01/01) include the functionality of
14342 module is obsolete with newer \SpecialChar LaTeX
14347 \begin_layout Subsection
14349 \change_inserted 564990737 1671884699
14352 Minimalistic Insets
14355 \begin_layout Standard
14357 \change_inserted 564990737 1671884699
14360 This module redefines several insets (Index, Branch, URL) as being Minimalistic.
14363 \begin_layout Subsection
14365 \change_inserted 564990737 1671884699
14368 Title and Preamble Hacks
14371 \begin_layout Standard
14373 \change_inserted 564990737 1671884699
14376 This module provides two new paragraph styles:
14379 \begin_layout Enumerate
14381 \change_inserted 564990737 1671884699
14387 which puts whatever is entered into it into the preamble.
14388 This can be used, if one wishes, to include preamble code in the body of
14393 \begin_layout Enumerate
14395 \change_inserted 564990737 1671884699
14401 which that will put its contents into the body of the LaTeX document, but
14409 This is useful for making branches and notes in title-related material.
14410 (However, if you put these in a Standard layout, this signals to LyX to
14417 , which may then come too early.)
14420 \begin_layout Section
14422 \change_inserted 564990737 1672081439
14428 \begin_layout Subsection
14430 \change_inserted 564990737 1672081439
14436 \begin_layout Standard
14438 \change_inserted 564990737 1672081439
14441 This module uses the
14445 package for algorithm floats rather than LyX’s home-brewed algorithm floats.
14446 Use the Algorithm paragraph style to enter and indent the algorithm.
14448 \begin_inset CommandInset href
14450 name "algorithm2e documentation"
14451 target "http://mirrors.ctan.org/macros/latex/contrib/algorithm2e/doc/algorithm2e.pdf"
14459 \begin_layout Subsection
14461 \change_inserted 564990737 1672081439
14464 Bilingual Captions AKA Multilingual Captions
14467 \begin_layout Standard
14469 \change_inserted 564990737 1672081439
14472 This module provides the paragraph style
14475 \begin_inset space ~
14480 with which to typeset multilingual captions.
14481 Within this paragraph style
14483 Insert\SpecialChar menuseparator
14486 allows you to enter the desired language using one of the babel names.
14489 File\SpecialChar menuseparator
14490 Open Example\SpecialChar menuseparator
14491 Multilingual Captions
14495 Help\SpecialChar menuseparator
14496 Specific Manuals\SpecialChar menuseparator
14497 Multilingual Captions
14499 further information on its use.
14502 \begin_layout Subsection
14504 \change_inserted 564990737 1672081439
14507 Number Figures by Section
14510 \begin_layout Standard
14512 \change_inserted 564990737 1672081439
14515 This module resets the figure number at section start and prepends the section
14516 number to the figure number, as in “Figure 2.1.” (By default book and report
14517 document classes number by Chapter and article document classes have a
14521 \begin_layout Subsection
14523 \change_inserted 564990737 1672081439
14526 Number Tables by Section
14529 \begin_layout Standard
14531 \change_inserted 564990737 1672081439
14534 This module resets the table number at section start and prepends the section
14535 number to the table number, as in “Table 2.1.” (By default book and report
14536 document classes number by Chapter and article document classes have a
14540 \begin_layout Section
14542 \change_inserted 564990737 1672081439
14548 \begin_layout Subsection
14550 \change_inserted 564990737 1672081439
14556 \begin_layout Standard
14558 \change_inserted 564990737 1672081439
14561 This module adds an endnote inset, in addition to footnotes.
14566 package, which has some limitations but works with older LaTeX distributions
14570 Insert\SpecialChar menuseparator
14571 Custom Inset\SpecialChar menuseparator
14574 to insert an endnote and
14576 Insert\SpecialChar menuseparator
14577 List/Contents/References\SpecialChar menuseparator
14580 to insert the endnotes list where you want the endnotes to appear.
14583 Help\SpecialChar menuseparator
14584 Embedded\SpecialChar menuseparator
14585 Objects\SpecialChar menuseparator
14586 Notes\SpecialChar menuseparator
14592 \begin_layout Subsection
14594 \change_inserted 564990737 1672081439
14597 Endnotes (Extended)
14600 \begin_layout Standard
14602 \change_inserted 564990737 1672081439
14605 This module adds an endnote inset, in addition to footnotes.
14610 package which is more powerful and customizable than the
14614 package, but requires a fairly modern LaTeX distribution (with LaTeX3).
14617 Insert\SpecialChar menuseparator
14618 Custom Inset\SpecialChar menuseparator
14621 to insert an endnote and
14623 Insert\SpecialChar menuseparator
14624 List/Contents/References\SpecialChar menuseparator
14627 to insert the endnotes list where you want the endnotes to appear.
14630 Help\SpecialChar menuseparator
14631 Embedded\SpecialChar menuseparator
14632 Objects\SpecialChar menuseparator
14633 Notes\SpecialChar menuseparator
14639 \begin_layout Subsection
14641 \change_inserted 564990737 1672081439
14644 Footnotes as Endnotes (Basic)
14647 \begin_layout Standard
14649 \change_inserted 564990737 1672081439
14652 This module sets all footnotes as endnotes.
14657 package, which has some limitations but works with older LaTeX distributions
14661 Insert\SpecialChar menuseparator
14662 List/Contents/References\SpecialChar menuseparator
14665 to insert the endnotes list where you want the endnotes to appear.
14668 Help\SpecialChar menuseparator
14669 Embedded\SpecialChar menuseparator
14670 Objects\SpecialChar menuseparator
14671 Notes\SpecialChar menuseparator
14677 \begin_layout Subsection
14679 \change_inserted 564990737 1672081439
14682 Footnotes as Endnotes (Extended)
14685 \begin_layout Standard
14687 \change_inserted 564990737 1672081439
14690 This module sets all footnotes as endnotes.
14695 package which is more powerful and customizable than then
14699 package, but requires a fairly modern LaTeX distribution (with LaTeX3).
14702 Insert\SpecialChar menuseparator
14703 List/Contents/References\SpecialChar menuseparator
14706 to insert the endnotes list where you want the endnotes to appear.
14709 Help\SpecialChar menuseparator
14710 Embedded\SpecialChar menuseparator
14711 Objects\SpecialChar menuseparator
14712 Notes\SpecialChar menuseparator
14718 \begin_layout Section
14720 \change_inserted 564990737 1672081439
14723 Leisure, Sports and Music
14726 \begin_layout Subsection
14728 \change_inserted 564990737 1672081439
14734 \begin_layout Standard
14736 \change_inserted 564990737 1672081439
14739 This module provides support for the
14743 package to print chess games.
14746 File\SpecialChar menuseparator
14747 Open Example\SpecialChar menuseparator
14748 Articles\SpecialChar menuseparator
14751 where you will find
14760 \begin_inset CommandInset href
14762 name "chessboard documentation"
14763 target "http://mirrors.ctan.org/macros/latex/contrib/chessboard/chessboard.pdf"
14771 \begin_layout Subsection
14773 \change_inserted 564990737 1672081439
14776 Lilypond Music Notation
14779 \begin_layout Standard
14781 \change_inserted 564990737 1672081439
14784 This module provides an inset via
14789 nsert\SpecialChar menuseparator
14790 Custom Inset\SpecialChar menuseparator
14793 in which to enter code for the LilyPond music editor.
14794 It will then be processed in the output.
14797 Help\SpecialChar menuseparator
14798 Specific Manuals\SpecialChar menuseparator
14803 File\SpecialChar menuseparator
14804 Open Example\SpecialChar menuseparator
14805 Modules\SpecialChar menuseparator
14809 It cannot be used if the modules
14812 \begin_inset space \thinspace{}
14820 \begin_layout Section
14822 \change_inserted 564990737 1672138150
14828 \begin_layout Subsection
14830 \change_inserted 564990737 1672138150
14834 \begin_inset CommandInset label
14836 name "subsec:Customizable-Lists"
14843 \begin_layout Standard
14845 \change_inserted 564990737 1672138150
14848 This module uses the
14852 package to enable the customization of various list environments.
14855 \begin_layout Subsubsection
14857 \change_inserted 564990737 1672138150
14860 Custom Enumerate Lists
14863 \begin_layout Standard
14866 \change_inserted 564990737 1672138150
14869 The default numbering of numbered lists can be changed by adding an optional
14875 nsert\SpecialChar menuseparator
14882 ) to the first item of each level in the list.
14883 There you add the command
14886 \begin_layout Standard
14888 \change_inserted 564990737 1672138150
14897 \begin_layout Standard
14899 \change_inserted 564990737 1672138150
14902 in \SpecialChar TeX
14912 \begin_layout Standard
14914 \change_inserted 564990737 1672138150
14920 is the first level counter of the enumeration.
14921 To change the numbering for the list sublevels, replace the “
14925 ” in the command by the small Roman numeral of the level (
14944 \begin_layout Standard
14946 \change_inserted 564990737 1672138150
14955 outputs the counter as a small Roman numeral.
14956 For capital Roman numerals replace
14968 in the command above.
14969 For Arabic numerals use
14977 \begin_inset Quotes eld
14981 \begin_inset Quotes erd
14984 items with capital or small Latin letters use
14999 \begin_layout Standard
15002 \change_inserted 564990737 1672138150
15005 \begin_inset Note Greyedout
15008 \begin_layout Plain Layout
15010 \change_inserted 564990737 1672138150
15016 You can only number 26
15017 \begin_inset space ~
15020 items with Latin letters, because this numbering is limited to single letters.
15028 \begin_layout Standard
15030 \change_inserted 564990737 1672138150
15033 Here is a list with custom numbering:
15036 \begin_layout Enumerate
15038 \change_inserted 564990737 1672138150
15041 \begin_inset Argument 1
15044 \begin_layout Plain Layout
15046 \change_inserted 564990737 1672138150
15052 \begin_layout Plain Layout
15054 \change_inserted 564990737 1672138150
15075 \begin_inset Separator latexpar
15082 \begin_layout Enumerate
15084 \change_inserted 564990737 1672138150
15087 \begin_inset Argument 1
15090 \begin_layout Plain Layout
15092 \change_inserted 564990737 1672138150
15098 \begin_layout Plain Layout
15100 \change_inserted 564990737 1672138150
15121 \begin_layout Enumerate
15123 \change_inserted 564990737 1672138150
15127 \begin_inset Separator latexpar
15134 \begin_layout Enumerate
15136 \change_inserted 564990737 1672138150
15139 \begin_inset Argument 1
15142 \begin_layout Plain Layout
15144 \change_inserted 564990737 1672138150
15150 \begin_layout Plain Layout
15152 \change_inserted 564990737 1672138150
15171 \begin_inset Separator latexpar
15178 \begin_layout Enumerate
15180 \change_inserted 564990737 1672138150
15183 \begin_inset Argument 1
15186 \begin_layout Plain Layout
15188 \change_inserted 564990737 1672138150
15194 \begin_layout Plain Layout
15196 \change_inserted 564990737 1672138150
15220 \begin_layout Standard
15222 \change_inserted 564990737 1672138150
15225 For this list these commands were used:
15228 \begin_layout Standard
15231 \change_inserted 564990737 1672138150
15242 \begin_inset Newline newline
15250 \begin_inset Newline newline
15258 \begin_inset Newline newline
15268 \begin_layout Standard
15270 \change_inserted 564990737 1672138150
15279 makes the label emphasized and
15288 \begin_layout Standard
15290 \change_inserted 564990737 1672138150
15293 \begin_inset Note Greyedout
15296 \begin_layout Plain Layout
15298 \change_inserted 564990737 1672138150
15304 When you change the label of a list level, it will be used for all following
15305 lists until you change the definition.
15313 \begin_layout Standard
15315 \change_inserted 564990737 1672138150
15321 \begin_layout Plain Layout
15323 \change_inserted 564990737 1672138150
15341 \begin_layout Subsubsection
15343 \change_inserted 564990737 1672138150
15346 Numbered Paragraphs in Reports
15349 \begin_layout Enumerate
15351 \change_inserted 564990737 1672138213
15354 Official reports often include numbered paragraphs; you can achieve this
15355 with a variation on the approach outlined in the footnote
15356 \begin_inset space ~
15360 \begin_inset CommandInset ref
15362 reference "fn:If-you-really"
15374 in each command with
15381 \begin_layout Enumerate
15383 \change_inserted 564990737 1672138150
15386 These numbered paragraphs were generated by inserting the \SpecialChar TeX
15388 \begin_inset Separator latexpar
15395 \begin_layout Standard
15397 \change_inserted 564990737 1672138150
15412 \begin_layout Standard
15414 \change_inserted 564990737 1672138150
15417 before the start of the section;
15423 uses the \SpecialChar LaTeX
15424 section counter to generate the first part of the number.
15428 \begin_layout Enumerate
15430 \change_inserted 564990737 1672138150
15433 I have ignored the subsection heading in this example because, with paragraphs
15434 numbered in this way, subsections are less likely to be used.
15437 \begin_layout Subsubsection
15439 \change_inserted 564990737 1672138150
15442 Resumed Enumeration
15445 \begin_layout Standard
15447 \change_inserted 564990737 1672138150
15453 \begin_layout Plain Layout
15455 \change_inserted 564990737 1672138150
15471 \begin_layout Standard
15473 \change_inserted 564990737 1672138150
15476 Enumerations can be resumed after intermediate paragraphs:
15479 \begin_layout Enumerate
15481 \change_inserted 564990737 1672138150
15484 \begin_inset Argument 1
15487 \begin_layout Plain Layout
15489 \change_inserted 564990737 1672138150
15495 \begin_layout Plain Layout
15497 \change_inserted 564990737 1672138150
15514 \begin_inset Note Note
15517 \begin_layout Plain Layout
15519 \change_inserted 564990737 1672138150
15522 goes back to default numbering
15530 \begin_layout Enumerate
15532 \change_inserted 564990737 1672138150
15538 \begin_layout Standard
15540 \change_inserted 564990737 1672138150
15546 \begin_layout Enumerate-Resume
15548 \change_inserted 564990737 1672138150
15554 \begin_layout Standard
15556 \change_inserted 564990737 1672138150
15559 To resume an enumeration, use the style
15564 Its numbering appears in blue within \SpecialChar LyX
15565 to indicate that it is a resumed
15566 list and that the numbering will not be correct in \SpecialChar LyX
15567 , but in the output.
15570 \begin_layout Standard
15572 \change_inserted 564990737 1672138150
15575 \begin_inset Note Greyedout
15578 \begin_layout Plain Layout
15580 \change_inserted 564990737 1672138150
15586 If there is no previous enumeration to resume, you will get a \SpecialChar LaTeX
15595 \begin_layout Standard
15597 \change_inserted 564990737 1672138150
15600 Perhaps you might want to resume the list with a different number from the
15602 Or you want to start a new enumeration with a defined number.
15603 This is possible by adding an optional argument to the first list item
15604 of a normal enumeration.
15605 There, insert the command
15608 \begin_layout Standard
15610 \change_inserted 564990737 1672138150
15617 \begin_layout Standard
15619 \change_inserted 564990737 1672138150
15626 is the number with which you want to resume the list.
15630 \begin_layout Enumerate
15632 \change_inserted 564990737 1672138150
15638 \begin_layout Enumerate
15640 \change_inserted 564990737 1672138150
15646 \begin_layout Standard
15648 \change_inserted 564990737 1672138150
15651 Enumeration starting at a given value:
15654 \begin_layout Enumerate
15656 \change_inserted 564990737 1672138150
15659 \begin_inset Argument 1
15662 \begin_layout Plain Layout
15664 \change_inserted 564990737 1672138150
15670 \begin_layout Plain Layout
15672 \change_inserted 564990737 1672138150
15686 This enumeration starts at 4
15689 \begin_layout Subsubsection
15691 \change_inserted 564990737 1672138150
15695 \begin_inset Index idx
15700 \begin_layout Plain Layout
15702 \change_inserted 564990737 1672138150
15715 \begin_layout Standard
15717 \change_inserted 564990737 1672138150
15720 In some cases you might want less or more vertical space between the items
15722 For example if the default space is too much in your opinion in this case:
15725 \begin_layout Itemize
15727 \change_inserted 564990737 1672138150
15733 \begin_layout Itemize
15735 \change_inserted 564990737 1672138150
15738 with standard spacing
15741 \begin_layout Standard
15743 \change_inserted 564990737 1672138150
15746 You can decrease the space by adding an optional argument to the first item
15748 Add there the command
15752 to get no additional list space like in this example:
15755 \begin_layout Itemize
15757 \change_inserted 564990737 1672138150
15760 \begin_inset Argument 1
15763 \begin_layout Plain Layout
15765 \change_inserted 564990737 1672138150
15771 \begin_layout Plain Layout
15773 \change_inserted 564990737 1672138150
15790 \begin_layout Itemize
15792 \change_inserted 564990737 1672138150
15798 \begin_layout Itemize
15800 \change_inserted 564990737 1672138150
15806 \begin_layout Standard
15808 \change_inserted 564990737 1672138150
15811 To add space you can use several other commands provided by the
15816 \begin_inset Index idx
15821 \begin_layout Plain Layout
15823 \change_inserted 564990737 1672138150
15827 -packages ! enumitem
15835 For more information see the
15836 \begin_inset CommandInset href
15838 name "enumitem documentation"
15839 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
15847 \begin_layout Standard
15849 \change_inserted 564990737 1672138150
15852 There are also many commands available to change the horizontal spacing
15854 Here is an example where the indentation was changed to that of the paragraphs
15855 in the document and the label separation was set to 2
15856 \begin_inset space \thinspace{}
15859 cm so that the number is in the page margin:
15862 \begin_layout Enumerate
15864 \change_inserted 564990737 1672138150
15867 \begin_inset Argument 1
15870 \begin_layout Plain Layout
15872 \change_inserted 564990737 1672138150
15878 \begin_layout Plain Layout
15880 \change_inserted 564990737 1672138150
15884 parindent, labelsep=2cm
15899 \begin_layout Enumerate
15901 \change_inserted 564990737 1672138150
15904 with negative indentation
15907 \begin_layout Subsubsection
15909 \change_inserted 564990737 1672138150
15912 Further Customization
15913 \begin_inset Index idx
15918 \begin_layout Plain Layout
15920 \change_inserted 564990737 1672138150
15923 Lists ! Customization
15933 \begin_layout Standard
15935 \change_inserted 564990737 1672138150
15938 You can also change the style of description lists.
15942 \begin_layout Standard
15944 \change_inserted 564990737 1672138150
15951 \begin_layout Standard
15953 \change_inserted 564990737 1672138150
15956 changes the description label font, the command
15959 \begin_layout Standard
15961 \change_inserted 564990737 1672138150
15971 \begin_layout Standard
15973 \change_inserted 564990737 1672138150
15976 sets the list style.
15979 \begin_layout Standard
15981 \change_inserted 564990737 1672138150
15984 An example where the command
15987 \begin_layout Standard
15989 \change_inserted 564990737 1672138150
15995 itshape, style=nextline
15998 \begin_layout Standard
16000 \change_inserted 564990737 1672138150
16006 \begin_layout Description
16008 \change_inserted 564990737 1672138150
16012 \begin_inset space ~
16016 \begin_inset Argument 1
16019 \begin_layout Plain Layout
16021 \change_inserted 564990737 1672138150
16027 \begin_layout Plain Layout
16029 \change_inserted 564990737 1672138150
16031 labelindent=0pt, labelsep=1cm, font=
16033 itshape, style=nextline
16045 Ionizing radiation consists of particles or electromagnetic waves that are
16046 energetic enough to detach electrons from atoms or molecules, therefore
16050 \begin_layout Description
16052 \change_inserted 564990737 1672138150
16056 \begin_inset space ~
16059 counting: In computer science, reference counting is a technique of storing
16060 the number of references, pointers, or handles to a resource such as an
16061 object, block of memory, disk space or other resource.
16064 \begin_layout Standard
16066 \change_inserted 564990737 1672138150
16069 There are many more commands and features provided by the
16074 \begin_inset Index idx
16079 \begin_layout Plain Layout
16081 \change_inserted 564990737 1672138150
16085 -packages ! enumitem
16093 For more information see the
16094 \begin_inset CommandInset href
16096 name "enumitem documentation"
16097 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
16105 \begin_layout Subsection
16107 \change_inserted 564990737 1672138150
16114 \begin_layout Standard
16116 \change_inserted 564990737 1672138150
16119 This module uses the package
16123 to provide nine new list environments.
16124 Itemized and enumerated lists can be typeset within paragraphs, as paragraphs
16125 and in a compact version.
16126 Most environments have optional arguments to format the labels.
16127 Additionally, the \SpecialChar LaTeX
16128 list environments itemize and enumerate are extended
16129 to use a similar optional argument.
16130 For further details see
16132 File\SpecialChar menuseparator
16133 Open Example\SpecialChar menuseparator
16134 Modules\SpecialChar menuseparator
16135 Paragraph Lists (paralist)
16139 Help\SpecialChar menuseparator
16140 Specific Manuals\SpecialChar menuseparator
16144 \begin_inset CommandInset href
16146 name "paralist documentation"
16147 target "http://mirrors.ctan.org/macros/latex/contrib/paralist/paralist.pdf"
16155 \begin_layout Section
16157 \change_inserted 564990737 1672161542
16160 Literate Programming
16163 \begin_layout Subsection
16165 \change_inserted 564990737 1672161542
16171 \begin_layout Standard
16173 \change_inserted 564990737 1672161542
16176 This module allows the use of Noweb as a literate programming tool.
16177 The files and the documentation for Noweb can be obtained from
16178 \begin_inset CommandInset href
16181 target "https://www.ctan.org/pkg/noweb"
16187 Literate programming is described in section
16188 \begin_inset space ~
16192 \begin_inset CommandInset ref
16194 reference "sec:Literate-Programming"
16198 and there are three example files:
16200 File\SpecialChar menuseparator
16201 Open Example\SpecialChar menuseparator
16202 Modules\SpecialChar menuseparator
16207 File\SpecialChar menuseparator
16208 Open Example\SpecialChar menuseparator
16209 Modules\SpecialChar menuseparator
16214 File\SpecialChar menuseparator
16215 Open Example\SpecialChar menuseparator
16216 Modules\SpecialChar menuseparator
16217 Noweb2\SpecialChar LyX
16223 \begin_layout Subsection
16225 \change_inserted 564990737 1672161542
16231 \begin_layout Standard
16233 \change_inserted 564990737 1672161542
16236 This module uses the
16246 \begin_inset Flex Code
16249 \begin_layout Plain Layout
16251 \change_inserted 564990737 1672161542
16261 package in R for dynamic report generation has to be installed for this
16263 \begin_inset Flex Code
16266 \begin_layout Plain Layout
16268 \change_inserted 564990737 1672161542
16271 install.packages(“knitr”)
16282 \begin_layout Paragraph
16284 \change_inserted 564990737 1672161542
16290 \begin_layout Standard
16292 \change_inserted 564990737 1672161542
16295 it depends on R >= 2.14.1.
16297 \begin_inset Flex URL
16300 \begin_layout Plain Layout
16302 \change_inserted 564990737 1672161542
16304 http://yihui.name/knitr
16315 \begin_layout Standard
16317 \change_inserted 564990737 1672161542
16324 also has to be installed.
16325 It cannot be used if the modules
16328 \begin_inset space ~
16340 Help\SpecialChar menuseparator
16341 Specific Manuals\SpecialChar menuseparator
16346 File\SpecialChar menuseparator
16347 Open Example\SpecialChar menuseparator
16348 Modules\SpecialChar menuseparator
16352 \begin_inset space ~
16356 \begin_inset CommandInset ref
16358 reference "sec:Literate-Programming"
16362 for information about literate programming.
16365 \begin_layout Subsection
16367 \change_inserted 564990737 1672161542
16373 \begin_layout Standard
16375 \change_inserted 564990737 1672161542
16378 This module allows the use of the statistical language S/R as a literate
16390 \begin_inset CommandInset href
16393 target "https://www.ctan.org/pkg/includernw"
16399 \begin_inset CommandInset href
16402 target "https://www.ctan.org/pkg/fancyvrb"
16407 are available from CTAN.
16408 It cannot be used if the module
16411 \begin_inset space ~
16419 Help\SpecialChar menuseparator
16420 Specific Manuals\SpecialChar menuseparator
16425 File\SpecialChar menuseparator
16426 Open Example\SpecialChar menuseparator
16427 Modules\SpecialChar menuseparator
16431 \begin_inset space ~
16435 \begin_inset CommandInset ref
16437 reference "sec:Literate-Programming"
16441 for information about literate programming.
16444 \begin_layout Section
16446 \change_inserted 564990737 1672224959
16452 \begin_layout Subsection
16454 \change_inserted 564990737 1672224959
16460 \begin_layout Standard
16462 \change_inserted 564990737 1672224959
16465 This modules defines theorem environments and the proof environment using
16466 the extended AMS machinery.
16467 Both numbered and unnumbered types are provided.
16468 By default, the theorems are numbered consecutively throughout the document.
16469 This can be changed by loading one of the
16471 AMS Theorems (Numbered by \SpecialChar ldots
16475 It cannot be used if the modules
16481 Standard Theorems (Unnumbered)
16486 \begin_layout Subsection
16488 \change_inserted 564990737 1672224959
16491 AMS Theorems (Extended)
16494 \begin_layout Standard
16496 \change_inserted 564990737 1672224959
16499 This module defines some additional theorem environments for use with the
16504 package (which must be loaded).
16505 It includes Criterion, Algorithm, Axiom, Condition, Note, Notation, Summary,
16506 Acknowledgement, Conclusion, Fact, Assumption, Case and Question in both
16507 numbered and unnumbered forms.
16510 \begin_layout Subsection
16512 \change_inserted 564990737 1672224959
16515 AMS Theorems (Extended, Numbered by Type within Chapters)
16518 \begin_layout Standard
16520 \change_inserted 564990737 1672224959
16523 This module defines some additional theorem environments for use with the
16526 AMS Theorems (Numbered by Type within Chapters)
16528 package (which must be loaded).
16529 It includes Criterion, Algorithm, Axiom, Condition, Note, Notation, Summary,
16530 Acknowledgement, Conclusion, Assumption and Case in both numbered and unnumbere
16534 AMS Theorems (Extended)
16536 module, the different theorem types provided here each have a separate
16537 counter, restarted with each new chapter (e.g., criterion 1.1, criterion 1.2,
16538 axiom 1.1, assumption 1.1, criterion 2.1, criterion 2.2, axiom 2.1\SpecialChar ldots
16540 to criterion 1, criterion 2, axiom 3, assumption 4...).
16543 \begin_layout Subsection
16545 \change_inserted 564990737 1672224959
16548 AMS Theorems (Extended, Numbered by Type)
16551 \begin_layout Standard
16553 \change_inserted 564990737 1672224959
16556 This module defines some additional theorem environments for use with the
16559 AMS Theorems (Numbered by Type)
16561 package (which must be loaded).
16562 It includes Criterion, Algorithm, Axiom, Condition, Note, Notation, Summary,
16563 Acknowledgement, Conclusion, Assumption and Case in both numbered and unnumbere
16567 AMS Theorems (Extended)
16569 module, the different theorem types provided here each have a separate
16570 counter (e.g., criterion 1, criterion 2, axiom 1, assumption 1, criterion
16571 3, \SpecialChar ldots
16572 , as opposed to criterion 1, criterion 2, axiom 3, assumption 4, \SpecialChar ldots
16576 \begin_layout Subsection
16578 \change_inserted 564990737 1672224959
16581 AMS Theorems (Numbered by Type within Chapters)
16584 \begin_layout Standard
16586 \change_inserted 564990737 1672224959
16589 This module defines theorem environments and the proof environment using
16590 the extended AMS machinery.
16591 Both numbered and unnumbered types are provided.
16596 module, the different theorem types provided here each have a separate
16597 counter (e.g., theorem 1.1, theorem 1.2, lemma 1.1, proposition 1.1, theorem
16598 1.3, lemma 1.2, \SpecialChar ldots
16599 , as opposed to theorem 1, theorem 2, lemma 3, proposition
16600 4, \SpecialChar ldots
16602 The numbering restarts for each chapter: theorem 1.1, theorem 2.1, \SpecialChar ldots
16604 be used if the modules
16614 Standard Theorems (Numbered by Type)
16618 Standard Theorems (Unnumbered)
16623 \begin_layout Subsection
16625 \change_inserted 564990737 1672224959
16628 AMS Theorems (Numbered by Type)
16631 \begin_layout Standard
16633 \change_inserted 564990737 1672224959
16636 This module defines theorem environments and the proof environment using
16637 the extended AMS machinery.
16638 Both numbered and unnumbered types are provided.
16643 module, the different theorem types provided here each have a separate
16644 counter (e.g., theorem 1, theorem 2, lemma 1, proposition 1, theorem 3, lemma
16645 2, \SpecialChar ldots
16646 , as opposed to theorem 1, theorem 2, lemma 3, proposition 4, \SpecialChar ldots
16648 The numbering’s scope is the whole document.
16649 For chapter- and section-wide numbering, use one of the ‘within Sections’/‘with
16650 in Chapters’ modules, respectively.
16651 It cannot be used if the modules
16661 Standard Theorems (Numbered by Type)
16665 Standard Theorems (Unnumbered)
16670 \begin_layout Subsection
16672 \change_inserted 564990737 1672224959
16675 Number Equations by Section
16678 \begin_layout Standard
16680 \change_inserted 564990737 1672224959
16683 This module resets the equation number at section start and prepends the
16684 section number to the equation number, as in “(2.1).”
16687 \begin_layout Subsection
16689 \change_inserted 564990737 1672224959
16695 \begin_layout Standard
16697 \change_inserted 564990737 1672224959
16700 This module defines some theorem environments for use with non-AMS classes.
16701 By default, the theorems are numbered consecutively throughout the document.
16702 This can be changed by loading one of the
16704 Standard Theorems (Numbered by \SpecialChar ldots
16708 It cannot be used if the modules
16714 Standard Theorems (Unnumbered)
16720 \begin_layout Subsection
16722 \change_inserted 564990737 1672224959
16725 Standard Theorems (Nameable)
16728 \begin_layout Standard
16730 \change_inserted 564990737 1672224959
16733 This module facilitates the use of named theorems.
16734 The name of the theorem goes into the “Additional Theorem Text” argument.
16738 \begin_layout Subsection
16740 \change_inserted 564990737 1672224959
16743 Standard Theorems (Numbered by Chapter)
16746 \begin_layout Standard
16748 \change_inserted 564990737 1672224959
16751 This module numbers theorems and the like by chapter (i.e., the counter is
16752 reset at each chapter start).
16753 Use this module only with document classes that provide a chapter environment.
16763 It cannot be used if the module
16765 Standard Theorems (Numbered by Section)
16770 \begin_layout Subsection
16772 \change_inserted 564990737 1672224959
16775 Standard Theorems (Numbered by Section)
16778 \begin_layout Standard
16780 \change_inserted 564990737 1672224959
16783 This module numbers theorems and the like by section (i.e., the counter is
16784 reset at each section start).
16794 It cannot be used if the module
16796 Standard Theorems (Numbered by Chapter)
16801 \begin_layout Subsection
16803 \change_inserted 564990737 1672224959
16806 Standard Theorems (Numbered by Type within Chapters)
16809 \begin_layout Standard
16811 \change_inserted 564990737 1672224959
16814 This module defines some theorem environments for use with non-AMS classes.
16823 modules, the different theorem types provided here each have a separate
16824 counter (e.g., theorem 1, theorem 2, lemma 1, proposition 1, theorem 3, lemma
16825 2, \SpecialChar ldots
16826 , as opposed to theorem 1, theorem 2, lemma 3, proposition 4, \SpecialChar ldots
16828 The numbering is reset at each chapter start.
16831 AMS Theorems (Numbered by Type)
16835 Standard Theorems (Numbered by Type)
16838 It cannot be used if any of the modules
16848 Standard Theorems (Unnumbered)
16852 Standard Theorems (Numbered by Sections)
16856 Standard Theorems (Numbered by Type within Sections)
16861 \begin_layout Subsection
16863 \change_inserted 564990737 1672224959
16866 Standard Theorems (Numbered by Type within Sections)
16869 \begin_layout Standard
16871 \change_inserted 564990737 1672224959
16874 This module defines some theorem environments for use with non-AMS classes.
16883 modules, the different theorem types provided here each have a separate
16884 counter (e.g., theorem 1, theorem 2, lemma 1, proposition 1, theorem 3, lemma
16885 2, \SpecialChar ldots
16886 , as opposed to theorem 1, theorem 2, lemma 3, proposition 4, \SpecialChar ldots
16888 The numbering is reset at each section start.
16891 AMS Theorems (Numbered by Type)
16895 Standard Theorems (Numbered by Type)
16898 It cannot be used if any of the modules
16908 Standard Theorems (Unnumbered)
16912 Standard Theorems (Numbered by Chapters)
16916 Standard Theorems (Numbered by Type within Chapters)
16921 \begin_layout Subsection
16923 \change_inserted 564990737 1672224959
16926 Standard Theorems (Numbered by Type)
16929 \begin_layout Standard
16931 \change_inserted 564990737 1672224959
16934 This module defines some theorem environments for use with non-AMS classes.
16943 modules, the different theorem types provided here each have a separate
16944 counter (e.g., theorem 1, theorem 2, lemma 1, proposition 1, theorem 3, lemma
16945 2, \SpecialChar ldots
16946 , as opposed to theorem 1, theorem 2, lemma 3, proposition 4, \SpecialChar ldots
16948 The numbering’s scope is the whole document.
16949 For chapter- and section-wide numbering, use one of the “within Chapters”/“with
16950 in Sections” modules, respectively.
16951 It cannot be used if any of the modules
16961 Standard Theorems (Unnumbered)
16965 AMS Theorems (Numbered by Type)
16970 \begin_layout Subsection
16972 \change_inserted 564990737 1672224959
16975 Standard Theorems (Unnumbered)
16978 \begin_layout Standard
16980 \change_inserted 564990737 1672224959
16983 This module defines only unnumbered theorem environments and the proof environme
16984 nt, using the extended AMS machinery.
16985 It cannot be used if either of the modules
16996 \begin_layout Subsection
16998 \change_inserted 564990737 1672224959
17004 \begin_layout Standard
17006 \change_inserted 564990737 1672224959
17009 This module provides a straightforward way to segregate subequations in
17013 Help\SpecialChar menuseparator
17014 Math\SpecialChar menuseparator
17021 \begin_layout Section
17023 \change_inserted 564990737 1672236008
17029 \begin_layout Subsection
17031 \change_inserted 564990737 1672236008
17034 Custom Header/Footer Text
17037 \begin_layout Standard
17039 \change_inserted 564990737 1672236008
17042 This module requires the
17045 \begin_inset space ~
17059 ocument\SpecialChar menuseparator
17064 ettings\SpecialChar menuseparator
17066 \begin_inset space ~
17071 dialog to be set to
17076 It adds six environments to document classes which support the
17083 \begin_layout Itemize
17085 \change_inserted 564990737 1672236008
17092 \begin_layout Itemize
17094 \change_inserted 564990737 1672236008
17101 \begin_layout Itemize
17103 \change_inserted 564990737 1672236008
17110 \begin_layout Itemize
17112 \change_inserted 564990737 1672236008
17119 \begin_layout Itemize
17121 \change_inserted 564990737 1672236008
17128 \begin_layout Itemize
17130 \change_inserted 564990737 1672236008
17137 \begin_layout Subsubsection
17139 \change_inserted 564990737 1672236008
17142 Fancy Headers and Footers
17145 \begin_layout Standard
17147 \change_inserted 564990737 1672236008
17150 The default page layout is rather plain; for an
17151 \begin_inset Flex Code
17154 \begin_layout Plain Layout
17156 \change_inserted 564990737 1672236008
17166 document class, all you get is a centered page number at the bottom of
17168 This document uses KOMA-script’s book class; so it appears to be a bit
17173 \begin_inset space ~
17187 ocument\SpecialChar menuseparator
17192 ettings\SpecialChar menuseparator
17196 \begin_inset Quotes eld
17200 \begin_inset Quotes erd
17203 , you will find that the page header is divided into three fields, not surprisin
17205 \begin_inset Quotes eld
17209 \begin_inset Quotes erd
17213 \begin_inset Quotes eld
17217 \begin_inset Quotes erd
17221 \begin_inset Quotes eld
17225 \begin_inset Quotes erd
17229 The footer is also divided into these three fields.
17230 The \SpecialChar LaTeX
17231 commands to set these fields in the simplest manner are
17256 Suppose you wish to put your name in the upper left hand corner of each
17258 Simply insert the following command in the preamble:
17261 \begin_layout Standard
17263 \change_inserted 564990737 1672236008
17280 \begin_layout Standard
17282 \change_inserted 564990737 1672236008
17285 You will now see your name in the upper left.
17286 If a field has a default entry that you would like to get rid of (often
17287 the page number appears in the central footer) simply include a command
17288 with a blank argument, e.
17289 \begin_inset space \thinspace{}
17295 \begin_layout Standard
17297 \change_inserted 564990737 1672236008
17306 \begin_layout Standard
17308 \change_inserted 564990737 1672236008
17311 There is, however, an easier way to make simple changes.
17317 ocument\SpecialChar menuseparator
17322 ettings\SpecialChar menuseparator
17323 Modules\SpecialChar menuseparator
17324 Page Layout\SpecialChar menuseparator
17325 Custom Header/Footer Text
17327 module, you will find you have six new environments corresponding to the
17328 six fields described above.
17331 \begin_layout Standard
17333 \change_inserted 564990737 1672236008
17336 Let's get really fancy: lets put the section number with the word
17337 \begin_inset Quotes eld
17341 \begin_inset Quotes erd
17345 \begin_inset space \thinspace{}
17349 \begin_inset space \space{}
17352 Section 3) in the upper left, the page number (e.
17353 \begin_inset space \thinspace{}
17357 \begin_inset space \space{}
17360 Page 4) in the upper right, your name in the lower left, and the date in
17362 Use your newly enabled environments to add these entries:
17365 \begin_layout Standard
17367 \change_inserted 564990737 1672236008
17370 \begin_inset VSpace defskip
17376 \begin_layout Standard
17378 \change_inserted 564990737 1672236008
17383 \begin_inset space ~
17400 \begin_layout Standard
17402 \change_inserted 564990737 1672236008
17409 \begin_layout Standard
17411 \change_inserted 564990737 1672236008
17426 \begin_layout Standard
17428 \change_inserted 564990737 1672236008
17438 \begin_layout Standard
17440 \change_inserted 564990737 1672236008
17447 \begin_layout Standard
17449 \change_inserted 564990737 1672236008
17464 \begin_layout Standard
17466 \change_inserted 564990737 1672236008
17469 \begin_inset VSpace defskip
17475 \begin_layout Standard
17477 \change_inserted 564990737 1672236008
17480 Make sure you enter the commands
17498 as \SpecialChar TeX
17516 access \SpecialChar LaTeX
17517 ’s section and page counters, and so print out the current section
17525 simply prints out today’s date.
17528 \begin_layout Standard
17530 \change_inserted 564990737 1672236008
17533 The thicknesses of the horizontal rules drawn beneath the header and above
17534 the footer can also be modified.
17535 If you don't want one of the rules, set its thickness to 0.
17536 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
17537 For this you will need to use \SpecialChar TeX
17541 \begin_layout Standard
17543 \change_inserted 564990737 1672236008
17551 headrulewidth}{0.4pt}
17556 \begin_layout Standard
17558 \change_inserted 564990737 1672236008
17566 footrulewidth}{0.4pt}
17568 to set the thicknesses.
17571 \begin_layout Standard
17573 \change_inserted 564990737 1672236008
17576 You can switch the header/footer settings on and off for individual pages
17577 using \SpecialChar TeX
17582 thispagestyle{empty}
17588 thispagestyle{plain}
17594 thispagestyle{fancy}
17597 Simply insert them in the text on the page you want changed and mark them
17598 as \SpecialChar TeX
17600 In fact, title pages are marked as plain by default, while following pages
17601 are marked fancy when using the global fancy setting.
17605 \begin_layout Standard
17607 \change_inserted 564990737 1672236008
17610 If you want a header or footer to be on the outer side of a two sided document,
17611 you need to use something like:
17614 \begin_layout Standard
17616 \change_inserted 564990737 1672236008
17620 \begin_inset Flex Strong
17623 \begin_layout Plain Layout
17625 \change_inserted 564990737 1672236008
17642 \begin_layout Standard
17644 \change_inserted 564990737 1672236008
17648 \begin_inset Flex Strong
17651 \begin_layout Plain Layout
17653 \change_inserted 564990737 1672236008
17672 \begin_layout Standard
17674 \change_inserted 564990737 1672236008
17677 The first command clears all existing footers avoiding any conflicts with
17681 \begin_layout Standard
17683 \change_inserted 564990737 1672236008
17686 You can enter any of these commands, the simpler ones in any of your new
17687 environments, the more complex ones as \SpecialChar TeX
17688 Code commands, at any point in
17689 your document and they will take effect on the next page.
17692 \begin_layout Standard
17694 \change_inserted 564990737 1672236008
17697 As a final example, it is possible to include an image in the header or
17699 Suppose you want to put a company logo in the upper left hand corner.
17700 You might try something like
17703 \begin_layout Standard
17705 \change_inserted 564990737 1672236008
17715 includegraphics{logo.eps}}}
17718 \begin_layout Standard
17721 \change_inserted 564990737 1672236008
17724 (you may need to preface this with
17728 usepackage{graphics}
17730 if you don't include graphics elsewhere in your document).
17733 \begin_layout Standard
17735 \change_inserted 564990737 1672236008
17738 For more information on fancy headers, you can get the
17739 \begin_inset Flex Code
17742 \begin_layout Plain Layout
17744 \change_inserted 564990737 1672236008
17755 \begin_inset CommandInset href
17758 target "http://www.ctan.org/pkg/fancyhdr"
17767 \begin_layout Subsection
17769 \change_inserted 564990737 1672236008
17772 Landscape Document Parts
17775 \begin_layout Standard
17777 \change_inserted 564990737 1672236008
17780 This module outputs parts of the document in landscape mode using
17782 Insert\SpecialChar menuseparator
17783 Custom Insets\SpecialChar menuseparator
17788 Insert\SpecialChar menuseparator
17789 Custom Insets\SpecialChar menuseparator
17790 Landscape (Floating)
17795 \begin_layout Subsection
17797 \change_inserted 564990737 1672236008
17800 \begin_inset CommandInset label
17802 name "sec:Multiple-Columns"
17809 \begin_layout Standard
17811 \change_inserted 564990737 1672236008
17814 This module uses the
17819 \begin_inset Index idx
17824 \begin_layout Plain Layout
17826 \change_inserted 564990737 1672236008
17830 -packages ! multicol
17837 package and is independent of the option
17850 ocument\SpecialChar menuseparator
17855 ettings\SpecialChar menuseparator
17857 \begin_inset space ~
17863 If you want to have two columns for the whole document, you are recommended
17873 For all other cases use this module.
17874 \change_deleted 564990737 1672236008
17877 Multiple Text Columns
17880 \begin_layout Standard
17882 \change_deleted 564990737 1672236008
17883 This feature is independent of the option
17885 Two-column document
17887 in the document settings under
17892 If you want to have 2
17893 \begin_inset space ~
17896 columns for the whole document, it is recommended to use the
17898 Two-column document
17901 For all other cases use this feature.
17904 \begin_layout Standard
17906 \change_deleted 564990737 1672236008
17907 To use multiple text columns in your document, you have to load the module
17914 Document\SpecialChar menuseparator
17915 Settings\SpecialChar menuseparator
17918 ) and must have the \SpecialChar LaTeX
17920 \begin_inset Flex Code
17923 \begin_layout Plain Layout
17934 \begin_layout Standard
17935 Footnotes within multiple columns will be placed at the bottom of the page
17936 and not under each column.
17937 Within the different columns you can use everything, with the limitation
17938 that for floats you need to
17939 \change_deleted 564990737 1672236179
17940 use the float option
17943 \change_inserted 564990737 1672236179
17953 \begin_inset space ~
17963 dit\SpecialChar menuseparator
17969 \begin_inset space ~
17980 \begin_layout Subsubsection
17984 \begin_layout Standard
17985 If you want to have 2
17986 \begin_inset space ~
17989 columns in your text, insert a multicolumn inset via the menu
17991 Insert\SpecialChar menuseparator
17993 \begin_inset space ~
17996 Insets\SpecialChar menuseparator
17998 \begin_inset space ~
18003 where the columns should start.
18004 Write all text that should be printed in 2
18005 \begin_inset space ~
18008 columns into this inset.
18011 \begin_layout Standard
18012 Here is an example:
18015 \begin_layout Standard
18017 \begin_inset Flex Multiple Columns
18020 \begin_layout Plain Layout
18025 The Adventure of the Empty House
18028 \begin_inset Newline newline
18031 by Sir Arthur Conan Doyle
18034 \begin_layout Plain Layout
18037 It was in the spring of the year 1894 that all London was interested, and
18038 the fashionable world dismayed, by the murder of the Honourable Ronald
18039 Adair under most unusual and inexplicable circumstances.
18040 The public has already learned those particulars of the crime which came
18041 out in the police investigation, but a good deal was suppressed upon that
18042 occasion, since the case for the prosecution was so overwhelmingly strong
18043 that it was not necessary to bring forward all the facts.
18044 Only now, at the end of nearly ten years, am I allowed to supply those
18045 missing links which make up the whole of that remarkable chain.
18046 The crime was of interest in itself, but that interest was as nothing to
18047 me compared to the inconceivable sequel, which afforded me the greatest
18048 shock and surprise of any event in my adventurous life.
18049 Even now, after this long interval, I find myself thrilling as I think
18050 of it, and feeling once more that sudden flood of joy, amazement, and increduli
18051 ty which utterly submerged my mind.
18052 Let me say to that public, which has shown some interest in those glimpses
18053 which I have occasionally given them of the thoughts and actions of a very
18054 remarkable man, that they are not to blame me if I have not shared my knowledge
18055 with them, for I should have considered it my first duty to do so, had
18056 I not been barred by a positive prohibition from his own lips, which was
18057 only withdrawn upon the third of last month.
18065 \begin_layout Standard
18066 To get 3 or more columns, set the cursor into the multicolumn inset and
18069 Insert\SpecialChar menuseparator
18071 \begin_inset space ~
18075 \begin_inset space ~
18081 The number of the desired columns is written into that inset (for 3
18082 \begin_inset space ~
18086 \begin_inset Quotes eld
18090 \begin_inset Quotes erd
18094 \begin_inset Newline newline
18097 Here is an example with 3
18098 \begin_inset space ~
18104 \begin_layout Standard
18105 \begin_inset Flex Multiple Columns
18108 \begin_layout Plain Layout
18111 \begin_inset Argument 1
18114 \begin_layout Plain Layout
18121 It can be imagined that my close intimacy with Sherlock Holmes had interested
18122 me deeply in crime, and that after his disappearance I never failed to
18123 read with care the various problems which came before the public.
18124 And I even attempted, more than once, for my own private satisfaction,
18125 to employ his methods in their solution, though with indifferent success.
18126 There was none, however, which appealed to me like this tragedy of Ronald
18128 As I read the evidence at the inquest, which led up to a verdict of willful
18129 murder against some person or persons unknown, I realized more clearly
18130 than I had ever done the loss which the community had sustained by the
18131 death of Sherlock Holmes.
18132 There were points about this strange business which would, I was sure,
18133 have specially appealed to him, and the efforts of the police would have
18134 been supplemented, or more probably anticipated, by the trained observation
18135 and the alert mind of the first criminal agent in Europe.
18136 All day, as I drove upon my round, I turned over the case in my mind and
18137 found no explanation which appeared to me to be adequate.
18138 At the risk of telling a twice-told tale, I will recapitulate the facts
18139 as they were known to the public at the conclusion of the inquest.
18147 \begin_layout Standard
18148 You can have up to 10
18149 \begin_inset space ~
18152 columns if you want to, but that might not be very pleasant for the readers
18156 \begin_layout Standard
18158 \change_deleted 564990737 1672236245
18159 \begin_inset Newpage newpage
18167 \begin_layout Subsubsection
18168 Columns inside Columns
18171 \begin_layout Standard
18172 You can also have columns inside columns:
18175 \begin_layout Standard
18176 \begin_inset Flex Multiple Columns
18179 \begin_layout Plain Layout
18182 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
18183 at that time governor of one of the Australian colonies.
18184 Adair's mother had returned from Australia to undergo the operation for
18185 cataract, and she, her son Ronald, and her daughter Hilda were living together
18189 \begin_layout Plain Layout
18190 \begin_inset Flex Multiple Columns
18193 \begin_layout Plain Layout
18196 The youth moved in the best society
18197 \begin_inset space ~
18200 – had, so far as was known, no enemies and no particular vices.
18201 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
18202 had been broken off by mutual consent some months before, and there was
18203 no sign that it had left any very profound feeling behind it.
18204 For the rest {sic} the man's life moved in a narrow and conventional circle,
18205 for his habits were quiet and his nature unemotional.
18206 Yet it was upon this easy-going young aristocrat that death came, in most
18207 strange and unexpected form, between the hours of ten and eleven-twenty
18208 on the night of March 30, 1894.
18216 \begin_layout Plain Layout
18219 Ronald Adair was fond of cards
18220 \begin_inset space ~
18223 – playing continually, but never for such stakes as would hurt him.
18224 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
18225 It was shown that, after dinner on the day of his death, he had played
18226 a rubber of whist at the latter club.
18227 He had also played there in the afternoon.
18232 The evidence of those who had played with him
18233 \begin_inset space ~
18237 Murray, Sir John Hardy, and Colonel Moran
18238 \begin_inset space ~
18241 – showed that the game was whist, and that there was a fairly equal fall
18243 Adair might have lost five pounds, but not more.
18244 His fortune was a considerable one, and such a loss could not in any way
18246 He had played nearly every day at one club or other, but he was a cautious
18247 player, and usually rose a winner.
18248 It came out in evidence that, in partnership with Colonel Moran, he had
18249 actually won as much as four hundred and twenty pounds in a sitting, some
18250 weeks before, from Godfrey Milner and Lord Balmoral.
18251 So much for his recent history as it came out at the inquest.
18259 \begin_layout Subsubsection
18263 \begin_layout Standard
18264 The examples in this section show some more special features of multiple
18268 \begin_layout Standard
18269 For more features of multiple columns, have a look at the
18270 \begin_inset CommandInset href
18272 name "documentation"
18273 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
18278 of the \SpecialChar LaTeX
18280 \begin_inset Flex Code
18283 \begin_layout Plain Layout
18292 \begin_layout Paragraph
18296 \begin_layout Standard
18297 To add a preface text for multiple columns, set the cursor into the multicolumn
18298 inset and use the menu
18300 Insert\SpecialChar menuseparator
18304 Write your preface text into that inset.
18305 \begin_inset Newline newline
18308 This is an example with some preface text:
18311 \begin_layout Standard
18312 \begin_inset VSpace bigskip
18318 \begin_layout Standard
18319 \begin_inset Flex Multiple Columns
18322 \begin_layout Plain Layout
18323 \begin_inset Argument 2
18326 \begin_layout Plain Layout
18327 And the story continues and continues and continues and continues\SpecialChar ldots
18335 On the evening of the crime, he returned from the club exactly at ten.
18336 His mother and sister were out spending the evening with a relation.
18337 The servant deposed that she heard him enter the front room on the second
18338 floor, generally used as his sitting-room.
18339 She had lit a fire there, and as it smoked she had opened the window.
18340 No sound was heard from the room until eleven-twenty, the hour of the return
18341 of Lady Maynooth and her daughter.
18342 Desiring to say good-night, she attempted to enter her son's room.
18343 The door was locked on the inside, and no answer could be got to their
18344 cries and knocking.
18345 Help was obtained, and the door forced.
18346 The unfortunate young man was found lying near the table.
18347 His head had been horribly mutilated by an expanding revolver bullet, but
18348 no weapon of any sort was to be found in the room.
18356 \begin_layout Standard
18357 You can also use a section heading as the preface if you use a section command
18358 as \SpecialChar TeX
18360 For example the command
18363 \begin_layout LyX-Code
18366 subsection{subsection title}
18369 \begin_layout Standard
18370 creates a subsection.
18371 In this example the preface is a subsubsection:
18374 \begin_layout Standard
18375 \begin_inset Flex Multiple Columns
18378 \begin_layout Plain Layout
18379 \begin_inset Argument 2
18382 \begin_layout Plain Layout
18386 \begin_layout Plain Layout
18395 This is a subsubsection heading as a preface
18399 \begin_layout Plain Layout
18413 A minute examination of the circumstances served only to make the case more
18415 In the first place, no reason could be given why the young man should have
18416 fastened the door upon the inside.
18417 There was the possibility that the murderer had done this, and had afterwards
18418 escaped by the window.
18419 The drop was at least twenty feet, however, and a bed of crocuses in full
18421 Neither the flowers nor the earth showed any sign of having been disturbed,
18422 nor were there any marks upon the narrow strip of grass which separated
18423 the house from the road.
18424 Apparently, therefore, it was the young man himself who had fastened the
18426 But how did he come by his death? No one could have climbed up to the window
18427 without leaving traces.
18428 Suppose a man had fired through the window, he would indeed be a remarkable
18429 shot who could with a revolver inflict so deadly a wound.
18430 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
18431 a hundred yards of the house.
18432 No one had heard a shot.
18440 \begin_layout Standard
18441 If there is less vertical space than 6
18442 \begin_inset space ~
18445 text lines is left on the page at the beginning of the multiple columns,
18446 a page break will be inserted before the multiple columns.
18447 Depending on the number of lines of the preface text, you might want to
18449 This is done by setting the cursor into the mulitcolumn inset behind the
18450 preface (if there is any) and using the menu
18452 Insert\SpecialChar menuseparator
18454 \begin_inset space ~
18458 \begin_inset space ~
18462 \begin_inset space ~
18468 Insert into that inset the amount of space like e.
18469 \begin_inset space \thinspace{}
18473 \begin_inset space \space{}
18477 \begin_inset Quotes eld
18481 \begin_inset Quotes erd
18485 \begin_inset Newline newline
18488 In this example the space is set to 7
18489 \begin_inset space ~
18492 text lines by using
18493 \begin_inset Flex Code
18496 \begin_layout Plain Layout
18505 \begin_inset Flex Code
18508 \begin_layout Plain Layout
18516 needs to be inserted as \SpecialChar TeX
18520 \begin_layout Standard
18521 \begin_inset Flex Multiple Columns
18524 \begin_layout Plain Layout
18525 \begin_inset Argument 3
18528 \begin_layout Plain Layout
18533 \begin_layout Plain Layout
18549 On the evening of the crime, he returned from the club exactly at ten.
18550 His mother and sister were out spending the evening with a relation.
18551 The servant deposed that she heard him enter the front room on the second
18552 floor, generally used as his sitting-room.
18553 She had lit a fire there, and as it smoked she had opened the window.
18554 No sound was heard from the room until eleven-twenty, the hour of the return
18555 of Lady Maynooth and her daughter.
18556 Desiring to say good-night, she attempted to enter her son's room.
18557 The door was locked on the inside, and no answer could be got to their
18558 cries and knocking.
18559 Help was obtained, and the door forced.
18560 The unfortunate young man was found lying near the table.
18561 His head had been horribly mutilated by an expanding revolver bullet, but
18562 no weapon of any sort was to be found in the room.
18570 \begin_layout Paragraph
18574 \begin_layout Standard
18575 The amount of space before and after multiple columns can be changed by
18576 changing the length
18577 \begin_inset Flex Code
18580 \begin_layout Plain Layout
18589 For example the command
18592 \begin_layout LyX-Code
18600 \begin_layout Standard
18601 in \SpecialChar TeX
18602 Code changes its value to 3
18603 \begin_inset space \thinspace{}
18607 The change must be made before the multiple columns' start.
18608 The predefined value is 13
18609 \begin_inset space \thinspace{}
18615 \begin_layout Standard
18617 \begin_inset Flex Code
18620 \begin_layout Plain Layout
18629 \begin_inset space \thinspace{}
18635 \begin_layout Standard
18639 \begin_layout Plain Layout
18645 multicolsep}{2.5cm}
18653 \begin_layout Standard
18654 \begin_inset Flex Multiple Columns
18657 \begin_layout Plain Layout
18660 All day I turned these facts over in my mind, endeavouring to hit upon some
18661 theory which could reconcile them all, and to find that line of least resistanc
18662 e which my poor friend had declared to be the starting-point of every investigat
18664 I confess that I made little progress.
18665 In the evening I strolled across the Park, and found myself about six o'clock
18666 at the Oxford Street end of Park Lane.
18667 A group of loafers upon the pavements, all staring up at a particular window,
18668 directed me to the house which I had come to see.
18669 A tall, thin man with coloured glasses, whom I strongly suspected of being
18670 a plain-clothes detective, was pointing out some theory of his own, while
18671 the others crowded round to listen to what he said.
18672 I got as near him as I could, but his observations seemed to me to be absurd,
18673 so I withdrew again in some disgust.
18674 As I did so I struck against an elderly, deformed man, who had been behind
18675 me, and I knocked down several books which he was carrying.
18683 \begin_layout Standard
18684 \begin_inset Note Greyedout
18687 \begin_layout Plain Layout
18692 The values you set with
18693 \begin_inset Flex Code
18696 \begin_layout Plain Layout
18704 will be used for all following multiple columns until you change them again.
18712 \begin_layout Standard
18716 \begin_layout Plain Layout
18728 \begin_inset Note Note
18731 \begin_layout Plain Layout
18732 go back to the default
18740 \begin_layout Standard
18742 \change_deleted 564990737 1672236355
18743 \begin_inset Newpage newpage
18751 \begin_layout Paragraph
18755 \begin_layout Standard
18756 A column break can be forced by inserting the command
18757 \begin_inset Flex Code
18760 \begin_layout Plain Layout
18768 as \SpecialChar TeX
18769 Code to that position in the text where the column should be broken.
18770 Note that this leads in most cases to whitespace in the text.
18771 \begin_inset Newline newline
18774 Here is an example:
18777 \begin_layout Standard
18778 \begin_inset Flex Multiple Columns
18781 \begin_layout Plain Layout
18784 \begin_inset Quotes eld
18787 You're surprised to see me, sir,
18788 \begin_inset Quotes erd
18791 said he, in a strange, croaking voice.
18794 \begin_layout Plain Layout
18797 I acknowledged that I was.
18800 \begin_layout Plain Layout
18803 \begin_inset Quotes eld
18806 Well, I've a conscience, sir, and when I chanced to see you go into this
18807 house, as I came hobbling after you, I thought to myself, I'll just step
18808 in and see that kind gentleman, and tell him that if I was a bit gruff
18809 in my manner there was not any harm meant, and that I am much obliged to
18810 him for picking up my books.
18811 \begin_inset Quotes erd
18817 \begin_layout Plain Layout
18820 \begin_inset Quotes eld
18823 You make too much of a trifle,
18824 \begin_inset Quotes erd
18829 \begin_inset Quotes eld
18832 May I ask how you knew who I was?
18833 \begin_inset Quotes erd
18836 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
18840 \begin_layout Plain Layout
18852 \begin_layout Plain Layout
18855 \begin_inset Quotes eld
18858 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
18859 you'll find my little bookshop at the corner of Church Street, and very
18860 happy to see you, I am sure.
18861 Maybe you collect yourself, sir.
18865 \begin_inset space ~
18879 \begin_inset space ~
18882 – a bargain, every one of them.
18883 With five volumes you could just fill that gap on that second shelf.
18884 It looks untidy, does it not, sir?
18885 \begin_inset Quotes erd
18896 \begin_layout Paragraph
18900 \begin_layout Standard
18901 The width of the columns is automatically calculated, but you can modify
18902 the space between the columns.
18903 This is done by changing the length
18904 \begin_inset Flex Code
18907 \begin_layout Plain Layout
18916 Its predefined value is 10
18917 \begin_inset space \thinspace{}
18921 Here is an example where
18922 \begin_inset Flex Code
18925 \begin_layout Plain Layout
18934 \begin_inset space \thinspace{}
18940 \begin_layout Standard
18944 \begin_layout Plain Layout
18958 \begin_layout Standard
18959 \begin_inset Flex Multiple Columns
18962 \begin_layout Plain Layout
18965 My observations of No.
18966 \begin_inset space \space{}
18969 427 Park Lane did little to clear up the problem in which I was interested.
18970 The house was separated from the street by a low wall and railing, the
18971 whole not more than five feet high.
18972 It was perfectly easy, therefore, for anyone to get into the garden, but
18973 the window was entirely inaccessible, since there was no water pipe or
18974 anything which could help the most active man to climb it.
18975 More puzzled than ever, I retraced my steps to Kensington.
18976 I had not been in my study five minutes when the maid entered to say that
18977 a person desired to see me.
18978 To my astonishment it was none other than my strange old book collector,
18979 his sharp, wizened face peering out from a frame of white hair, and his
18980 precious volumes, a dozen of them at least, wedged under his right arm.
18988 \begin_layout Standard
18992 \begin_layout Plain Layout
19004 \begin_inset Note Note
19007 \begin_layout Plain Layout
19008 go back to the default
19016 \begin_layout Paragraph
19020 \begin_layout Standard
19021 Between the columns a rule with a width of the length
19022 \begin_inset Flex Code
19025 \begin_layout Plain Layout
19034 If this rule width is set to 0
19035 \begin_inset space \thinspace{}
19038 pt (this is the default), the rule is suppressed.
19039 In the following example the rule is 2
19040 \begin_inset space \thinspace{}
19046 \begin_layout Standard
19050 \begin_layout Plain Layout
19056 columnseprule}{2pt}
19064 \begin_layout Standard
19065 \begin_inset Flex Multiple Columns
19068 \begin_layout Plain Layout
19071 \begin_inset Quotes eld
19074 You're surprised to see me, sir,
19075 \begin_inset Quotes erd
19078 said he, in a strange, croaking voice.
19081 \begin_layout Plain Layout
19084 I acknowledged that I was.
19087 \begin_layout Plain Layout
19090 \begin_inset Quotes eld
19093 Well, I've a conscience, sir, and when I chanced to see you go into this
19094 house, as I came hobbling after you, I thought to myself, I'll just step
19095 in and see that kind gentleman, and tell him that if I was a bit gruff
19096 in my manner there was not any harm meant, and that I am much obliged to
19097 him for picking up my books.
19098 \begin_inset Quotes erd
19104 \begin_layout Plain Layout
19107 \begin_inset Quotes eld
19110 You make too much of a trifle,
19111 \begin_inset Quotes erd
19116 \begin_inset Quotes eld
19119 May I ask how you knew who I was?
19120 \begin_inset Quotes erd
19126 \begin_layout Plain Layout
19129 \begin_inset Quotes eld
19132 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
19133 you'll find my little bookshop at the corner of Church Street, and very
19134 happy to see you, I am sure.
19135 Maybe you collect yourself, sir.
19139 \begin_inset space ~
19153 \begin_inset space ~
19156 – a bargain, every one of them.
19157 With five volumes you could just fill that gap on that second shelf.
19158 It looks untidy, does it not, sir?
19159 \begin_inset Quotes erd
19170 \begin_layout Standard
19171 \begin_inset VSpace defskip
19177 \begin_layout Standard
19178 The rule can be colored by redefining the command
19179 \begin_inset Flex Code
19182 \begin_layout Plain Layout
19191 This is done by inserting the command
19194 \begin_layout LyX-Code
19199 columnseprulecolor}{
19204 \begin_layout Standard
19205 as \SpecialChar TeX
19206 Code before the multicolumn inset.
19208 \begin_inset Flex Code
19211 \begin_layout Plain Layout
19217 in this command by a color of your choice.
19218 You can use all pre- and self-defined colors.
19226 \begin_inset space ~
19231 for more information about pre- and self-defined colors.
19232 To go back to the default color insert the command
19235 \begin_layout LyX-Code
19240 columnseprulecolor}{
19245 \begin_layout Standard
19246 Here is the example with a cyan rule and 1
19247 \begin_inset space \thinspace{}
19250 cm column separation:
19253 \begin_layout Standard
19257 \begin_layout Plain Layout
19266 \begin_layout Plain Layout
19272 columnseprulecolor}{
19282 \begin_layout Standard
19283 \begin_inset Flex Multiple Columns
19286 \begin_layout Plain Layout
19289 \begin_inset Quotes eld
19292 You're surprised to see me, sir,
19293 \begin_inset Quotes erd
19296 said he, in a strange, croaking voice.
19299 \begin_layout Plain Layout
19302 I acknowledged that I was.
19305 \begin_layout Plain Layout
19308 \begin_inset Quotes eld
19311 Well, I've a conscience, sir, and when I chanced to see you go into this
19312 house, as I came hobbling after you, I thought to myself, I'll just step
19313 in and see that kind gentleman, and tell him that if I was a bit gruff
19314 in my manner there was not any harm meant, and that I am much obliged to
19315 him for picking up my books.
19316 \begin_inset Quotes erd
19322 \begin_layout Plain Layout
19325 \begin_inset Quotes eld
19328 You make too much of a trifle,
19329 \begin_inset Quotes erd
19334 \begin_inset Quotes eld
19337 May I ask how you knew who I was?
19338 \begin_inset Quotes erd
19344 \begin_layout Plain Layout
19347 \begin_inset Quotes eld
19350 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
19351 you'll find my little bookshop at the corner of Church Street, and very
19352 happy to see you, I am sure.
19353 Maybe you collect yourself, sir.
19357 \begin_inset space ~
19371 \begin_inset space ~
19374 – a bargain, every one of them.
19375 With five volumes you could just fill that gap on that second shelf.
19376 It looks untidy, does it not, sir?
19377 \begin_inset Quotes erd
19388 \begin_layout Standard
19392 \begin_layout Plain Layout
19398 columnseprule}{0pt}
19401 \begin_layout Plain Layout
19407 columnseprulecolor}{
19415 \begin_inset Note Note
19418 \begin_layout Plain Layout
19419 go back to the default
19427 \begin_layout Section
19429 \change_inserted 564990737 1671270380
19433 \begin_layout Subsection
19435 \change_inserted 564990737 1671270398
19437 \change_deleted 564990737 1671270396
19443 \begin_layout Standard
19446 as well as any other text processor uses by default rectangular paragraphs.
19447 For special cases like for example posters, invitation cards or poems you
19448 can modify the paragraph shape to one of your choice.
19450 \change_deleted 564990737 1672311802
19451 This can be done by using the \SpecialChar LaTeX
19453 \begin_inset Flex Code
19456 \begin_layout Plain Layout
19462 which is loaded by using in the document settings the module
19464 Custom paragraph shapes
19467 \change_inserted 564990737 1672311802
19470 This module uses the
19474 package to provide over a dozen paragraph shapes as well as commands to
19475 define custom shapes.
19481 \begin_layout Subsubsection
19485 \begin_layout Standard
19490 provides the following shapes:
19493 \begin_layout Standard
19494 \begin_inset Tabular
19495 <lyxtabular version="3" rows="13" columns="3">
19496 <features booktabs="true" islongtable="true" longtabularalignment="center">
19497 <column alignment="left" valignment="middle" width="16col%">
19498 <column alignment="left" valignment="middle" width="40col%">
19499 <column alignment="left" valignment="middle" width="35col%">
19500 <row endhead="true">
19501 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
19504 \begin_layout Plain Layout
19513 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
19516 \begin_layout Plain Layout
19525 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
19528 \begin_layout Plain Layout
19538 <row interlinespace="default">
19539 <cell alignment="left" valignment="top" usebox="none">
19542 \begin_layout Plain Layout
19550 <cell alignment="left" valignment="top" usebox="none">
19553 \begin_layout Plain Layout
19556 Circle with circular hole (in the size of a CD/DVD)
19561 <cell alignment="left" valignment="top" usebox="none">
19564 \begin_layout Plain Layout
19567 Cannot be scaled, take care there is not too much text
19573 <row interlinespace="default">
19574 <cell alignment="left" valignment="top" usebox="none">
19577 \begin_layout Plain Layout
19585 <cell alignment="left" valignment="top" usebox="none">
19588 \begin_layout Plain Layout
19596 <cell alignment="left" valignment="top" usebox="none">
19599 \begin_layout Plain Layout
19602 Fragile, calculation might fail
19608 <row interlinespace="default">
19609 <cell alignment="left" valignment="top" usebox="none">
19612 \begin_layout Plain Layout
19620 <cell alignment="left" valignment="top" usebox="none">
19623 \begin_layout Plain Layout
19626 Rhomboid (symbolizing a
19627 \begin_inset Quotes eld
19631 \begin_inset Quotes erd
19639 <cell alignment="left" valignment="top" usebox="none">
19642 \begin_layout Plain Layout
19651 <row interlinespace="default">
19652 <cell alignment="left" valignment="top" usebox="none">
19655 \begin_layout Plain Layout
19663 <cell alignment="left" valignment="top" usebox="none">
19666 \begin_layout Plain Layout
19674 <cell alignment="left" valignment="top" usebox="none">
19677 \begin_layout Plain Layout
19686 <row interlinespace="default">
19687 <cell alignment="left" valignment="top" usebox="none">
19690 \begin_layout Plain Layout
19698 <cell alignment="left" valignment="top" usebox="none">
19701 \begin_layout Plain Layout
19709 <cell alignment="left" valignment="top" usebox="none">
19712 \begin_layout Plain Layout
19721 <row interlinespace="default">
19722 <cell alignment="left" valignment="top" usebox="none">
19725 \begin_layout Plain Layout
19733 <cell alignment="left" valignment="top" usebox="none">
19736 \begin_layout Plain Layout
19739 Nut for bolt (hexagon with circular hole)
19744 <cell alignment="left" valignment="top" usebox="none">
19747 \begin_layout Plain Layout
19756 <row interlinespace="default">
19757 <cell alignment="left" valignment="top" usebox="none">
19760 \begin_layout Plain Layout
19768 <cell alignment="left" valignment="top" usebox="none">
19771 \begin_layout Plain Layout
19779 <cell alignment="left" valignment="top" usebox="none">
19782 \begin_layout Plain Layout
19791 <row interlinespace="default">
19792 <cell alignment="left" valignment="top" usebox="none">
19795 \begin_layout Plain Layout
19803 <cell alignment="left" valignment="top" usebox="none">
19806 \begin_layout Plain Layout
19814 <cell alignment="left" valignment="top" usebox="none">
19817 \begin_layout Plain Layout
19826 <row interlinespace="default">
19827 <cell alignment="left" valignment="top" usebox="none">
19830 \begin_layout Plain Layout
19838 <cell alignment="left" valignment="top" usebox="none">
19841 \begin_layout Plain Layout
19849 <cell alignment="left" valignment="top" usebox="none">
19852 \begin_layout Plain Layout
19861 <row interlinespace="default">
19862 <cell alignment="left" valignment="top" usebox="none">
19865 \begin_layout Plain Layout
19873 <cell alignment="left" valignment="top" usebox="none">
19876 \begin_layout Plain Layout
19879 Normal/reversed rain drop
19884 <cell alignment="left" valignment="top" usebox="none">
19887 \begin_layout Plain Layout
19890 Fragile, calculation might fail
19896 <row interlinespace="default">
19897 <cell alignment="left" valignment="top" usebox="none">
19900 \begin_layout Plain Layout
19909 <cell alignment="left" valignment="top" usebox="none">
19912 \begin_layout Plain Layout
19915 The \SpecialChar TeX
19921 <cell alignment="left" valignment="top" usebox="none">
19924 \begin_layout Plain Layout
19933 <row interlinespace="default">
19934 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
19937 \begin_layout Plain Layout
19941 \begin_inset Newline newline
19949 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
19952 \begin_layout Plain Layout
19955 Triangles in different orientations
19960 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
19963 \begin_layout Plain Layout
19979 \begin_layout Standard
19980 To use a shape for your paragraph, simply select it in \SpecialChar LyX
19982 for environments in the toolbar.
19985 \begin_layout Standard
19986 \begin_inset Newpage newpage
19992 \begin_layout Standard
19993 Here is an example paragraph in the shape of a nut:
19996 \begin_layout Standard
19997 \begin_inset VSpace bigskip
20006 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
20007 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
20009 At vero eos et accusam et justo duo dolores et ea rebum.
20010 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
20012 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
20013 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
20017 \begin_layout Standard
20018 \begin_inset VSpace bigskip
20024 \begin_layout Standard
20025 \begin_inset Note Greyedout
20028 \begin_layout Plain Layout
20037 paragraphs cannot run over a page break.
20045 \begin_layout Standard
20046 \begin_inset VSpace bigskip
20052 \begin_layout Standard
20054 \begin_inset Flex Code
20057 \begin_layout Plain Layout
20063 takes care that the shape will always be preserved, no matter how much
20064 text is in the paragraph.
20065 Therefore the paragraph size changes with the amount of contained text.
20066 This can lead to paragraph sizes exceeding the page margins.
20067 To demonstrate the size scaling, here is the same example paragraph but
20068 with twice as much text:
20071 \begin_layout Standard
20072 \begin_inset Newpage newpage
20081 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
20082 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
20084 At vero eos et accusam et justo duo dolores et ea rebum.
20085 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
20087 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
20088 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
20090 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
20091 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
20093 At vero eos et accusam et justo duo dolores et ea rebum.
20094 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
20096 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
20097 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
20101 \begin_layout Standard
20102 \begin_inset VSpace bigskip
20108 \begin_layout Standard
20109 An exception is the shape
20114 It cannot be scaled because it must fit the size of a CD/DVD.
20115 Therefore the amount of text that fits into the shape is limited.
20116 \begin_inset Newline newline
20127 shape are fragile, meaning that the calculation of their size can fail,
20128 depending on the amount of text.
20129 You will then get the \SpecialChar LaTeX
20131 \begin_inset Quotes eld
20134 Arithmetic overflow
20135 \begin_inset Quotes erd
20139 In this case one can try to remove or add some text; if nothing works one
20140 has to use another shape.
20143 \begin_layout Standard
20144 \begin_inset VSpace bigskip
20150 \begin_layout Standard
20151 For shapes with tips you will maybe see that \SpecialChar LaTeX
20152 's hyphenation routine fails
20153 for text in the tips.
20154 Therefore it is often necessary to add hyphenation points
20159 arg "specialchar-insert hyphenation"
20164 ) to the corresponding text parts.
20167 \begin_layout Standard
20168 \begin_inset VSpace bigskip
20174 \begin_layout Standard
20175 Shapepar paragraphs are either always centered or placed on the page so
20176 that their left border touches the left page margin.
20177 You can therefore not use the paragraph dialog to align such paragraphs.
20178 A solution is to put the paragraph into a minipage or parbox and align
20180 The problem is hereby to find the right width for the box.
20181 Because if it is too wide and you center the box, the paragraph is not
20182 centered too because it sticks at the left side of the box.
20183 So you might have to play a bit with the width until it fits.
20184 Here are two heart-shaped paragraphs, the first one is not aligned, the
20185 second one is right-aligned:
20188 \begin_layout Standard
20189 \begin_inset Newpage newpage
20195 \begin_layout Heart
20199 Lo\SpecialChar softhyphen
20200 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
20201 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
20203 At vero eos et accusam et justo duo dolores et ea rebum.
20204 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
20208 \begin_layout Standard
20209 \begin_inset VSpace bigskip
20215 \begin_layout Standard
20218 \begin_inset Box Frameless
20228 height_special "totalheight"
20233 backgroundcolor "none"
20236 \begin_layout Heart
20240 Lo\SpecialChar softhyphen
20241 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
20242 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
20244 At vero eos et accusam et justo duo dolores et ea rebum.
20245 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
20254 \begin_layout Subsubsection
20258 \begin_layout Standard
20259 You can define any shape you want.
20260 Doing this manually is a lot of work because every coordinate must be specified.
20261 But there is a way to let the computer calculate the coordinates:
20264 \begin_layout Enumerate
20265 Install the program
20266 \begin_inset CommandInset href
20269 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
20277 \begin_layout Enumerate
20284 TeX/LaTeX\SpecialChar menuseparator
20285 Settings\SpecialChar menuseparator
20288 and select the font size you are using in your document.
20289 For example this document uses the size 12
20290 \begin_inset space \thinspace{}
20296 \begin_layout Enumerate
20300 \begin_layout Enumerate
20303 TeX/LaTeX\SpecialChar menuseparator
20306 to export the shape to coordinates.
20307 In the appearing dialog use either the outline of your shape for the coordinate
20308 s or the path itself.
20312 \begin_layout Plain Layout
20313 For more information see
20314 \begin_inset CommandInset href
20316 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
20329 \begin_layout Standard
20330 The coordinates are written into a \SpecialChar TeX
20332 To use it for your \SpecialChar LyX
20336 \begin_layout Enumerate
20337 Place the cursor before the first character of your paragraph (or into a
20341 \begin_layout Enumerate
20342 Open in \SpecialChar LyX
20345 Insert\SpecialChar menuseparator
20346 File\SpecialChar menuseparator
20348 \begin_inset space ~
20353 , select the file and use
20362 \begin_layout Standard
20363 \begin_inset VSpace defskip
20369 \begin_layout Standard
20370 \begin_inset Note Greyedout
20373 \begin_layout Plain Layout
20378 : The changed shape only applies to the current paragraph; everything is
20379 reset to normal for the next paragraph.
20380 Therefore the shape definition file must be input into every paragraph
20381 with the desired shape.
20389 \begin_layout Standard
20390 \begin_inset VSpace bigskip
20396 \begin_layout Standard
20397 Here is an example:
20400 \begin_layout Standard
20401 \begin_inset VSpace bigskip
20407 \begin_layout Standard
20408 \begin_inset CommandInset include
20410 filename "SpecialParagraphShape.tex"
20417 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
20418 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
20420 At vero eos et accusam et justo duo dolores et ea rebum.
20421 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
20423 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
20424 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
20428 \begin_layout Standard
20429 \begin_inset VSpace bigskip
20435 \begin_layout Standard
20440 to draw complexer shapes in
20444 you can draw the shape in a program of your choice and import the resulting
20450 Then you only need to draw a line or spline along the outline of the image.
20453 \begin_layout Standard
20454 \begin_inset VSpace bigskip
20460 \begin_layout Standard
20463 Custom paragraph shapes
20465 also provides the two commands
20473 which can be used to define custom shapes coordinate by coordinate.
20477 \begin_layout Plain Layout
20478 These commands are internally used for all shapes described here.
20483 For information how these styles are used and about further customization
20484 possibilities, have a look at the
20485 \begin_inset CommandInset href
20487 name "documentation"
20488 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
20494 \begin_inset Flex Code
20497 \begin_layout Plain Layout
20506 \begin_layout Subsection
20508 \change_inserted 564990737 1672311925
20514 \begin_layout Hanging
20516 \change_inserted 564990737 1672311925
20519 This module adds the
20523 paragraph style, that is, one where all but the first line of the paragraph
20525 This may not appear in your \SpecialChar LyX
20526 document but will appear in the final output.
20529 \begin_layout Subsection
20531 \change_inserted 564990737 1672311925
20534 \begin_inset CommandInset label
20536 name "subsec:Initials"
20540 Initials (Drop Caps)
20543 \begin_layout Initial
20545 \change_inserted 564990737 1672311925
20548 \begin_inset Argument 2
20551 \begin_layout Plain Layout
20553 \change_inserted 564990737 1672311925
20562 \begin_inset Argument 3
20565 \begin_layout Plain Layout
20567 \change_inserted 564990737 1672311925
20575 module adds a drop capitals paragraph style
20579 for paragraph environments which you can use wherever you want to have
20581 You then have three more items in the
20588 \begin_layout Itemize
20590 \change_inserted 564990737 1672311925
20596 which creates an inset for the drop capital
20599 \begin_layout Itemize
20601 \change_inserted 564990737 1672311925
20607 which creates an inset for the rest of the word
20610 \begin_layout Itemize
20612 \change_inserted 564990737 1672311925
20618 which allow you configure the formatting of the drop capital.
20621 \begin_layout Standard
20623 \change_inserted 564990737 1672311925
20626 To customize the appearance of the style, see
20628 Help\SpecialChar menuseparator
20629 Embedded Objects\SpecialChar menuseparator
20630 Objects Surrounded by Text\SpecialChar menuseparator
20636 \begin_layout Section
20638 \change_inserted 564990737 1672312011
20644 \begin_layout Subsection
20646 \change_inserted 564990737 1672312011
20649 Hyphenatable Text Markup
20652 \begin_layout Standard
20654 \change_inserted 564990737 1672312011
20657 This package defines text styles to highlight, space-out, strike-through,
20658 underline and capitalize/small-cap text by means of the
20663 As opposed to the markup provided by the Text Properties dialog, words
20670 \begin_inset CommandInset href
20672 name "soul documentation"
20673 target "http://mirrors.ctan.org/macros/generic/soul/soul.pdf"
20681 \begin_layout Subsection
20683 \change_inserted 564990737 1672312011
20689 \begin_layout Standard
20691 \change_inserted 564990737 1672312011
20694 This module defines some character styles for logical markup:
20697 \begin_inset Flex Noun
20700 \begin_layout Plain Layout
20702 \change_inserted 564990737 1672312011
20716 \begin_inset Flex Emph
20719 \begin_layout Plain Layout
20721 \change_inserted 564990737 1672312011
20733 \begin_inset Flex Strong
20736 \begin_layout Plain Layout
20738 \change_inserted 564990737 1672312011
20747 \begin_inset Flex Code
20750 \begin_layout Plain Layout
20752 \change_inserted 564990737 1672312011
20760 which are accessed via the
20765 dit\SpecialChar menuseparator
20767 \begin_inset space ~
20771 \begin_inset space ~
20783 \begin_layout Chapter
20785 \change_deleted 564990737 1671304317
20789 \change_inserted 564990737 1671304322
20791 \change_deleted 564990737 1671304331
20792 ies with Bib\SpecialChar TeX
20798 \begin_layout Standard
20799 The most basic information about how to use Bib\SpecialChar TeX
20804 with \SpecialChar LyX
20805 is contained in the section
20807 Bibliography databases
20814 The following subsections explain special bibliography features supported
20815 by \SpecialChar LyX
20819 \begin_layout Section
20820 Alternative Citation Styles
20823 \begin_layout Standard
20824 Standard Bib\SpecialChar TeX
20826 \begin_inset space \thinspace{}
20830 \begin_inset space \space{}
20834 \begin_inset Quotes eld
20838 \begin_inset Quotes erd
20841 ) to refer to a cited work.
20842 However, in many scientific disciplines, other citation styles are in use.
20843 The most common one is the author-year style (e.
20844 \begin_inset space \thinspace{}
20848 \begin_inset space \space{}
20852 \begin_inset Quotes eld
20856 \begin_inset Quotes erd
20861 supports three packages that provide this style,
20862 \begin_inset Flex Code
20865 \begin_layout Plain Layout
20872 \begin_inset Flex Code
20875 \begin_layout Plain Layout
20882 \begin_inset Flex Code
20885 \begin_layout Plain Layout
20892 Each of these packages has their pros and cons, which cannot be listed
20894 If you only want to have simple author-year (or author-numerical) style,
20895 or if you want to use one of the countless style files for
20896 \begin_inset Flex Code
20899 \begin_layout Plain Layout
20905 , then the established
20906 \begin_inset Flex Code
20909 \begin_layout Plain Layout
20915 package is probably your choice.
20916 If you look for specific citation styles common in law studies, you might
20918 \begin_inset Flex Code
20921 \begin_layout Plain Layout
20928 If you want to have full control over the formatting or look for advanced
20929 features such as ibidem, footnote citations, full title citations, advanced
20930 date formats (such as 400 BC) or full localization to other languages than
20931 English, you should definitely consider
20932 \begin_inset Flex Code
20935 \begin_layout Plain Layout
20941 , which exceeds all other packages in terms of features, but is also quite
20942 heavy and more resource-hungry.
20945 \begin_layout Standard
20946 The handling of these packages in \SpecialChar LyX
20947 is basically the same.
20949 \begin_inset Flex Noun
20952 \begin_layout Plain Layout
20953 Document\SpecialChar menuseparator
20960 \begin_inset Flex Noun
20963 \begin_layout Plain Layout
20970 \begin_inset Flex Noun
20973 \begin_layout Plain Layout
20980 \begin_inset Flex Noun
20983 \begin_layout Plain Layout
20990 \begin_inset Flex Noun
20993 \begin_layout Plain Layout
21000 \begin_inset Flex Noun
21003 \begin_layout Plain Layout
21004 Biblatex (Natbib mode)
21010 \begin_inset Flex Noun
21013 \begin_layout Plain Layout
21020 \begin_inset Flex Noun
21023 \begin_layout Plain Layout
21030 \begin_inset space ~
21033 6.5.3 in the User's Guide for more information on these choices).
21034 With all these packages, you will get some extra features in the citation
21035 dialog and you can select the style of the reference (
21036 \begin_inset Quotes eld
21040 \begin_inset Quotes erd
21044 \begin_inset Quotes eld
21048 \begin_inset Quotes erd
21052 \begin_inset Quotes eld
21056 \begin_inset Quotes erd
21060 \begin_inset Quotes eld
21064 \begin_inset Quotes erd
21068 Note that either package needs specifically designed style files.
21069 They all ship their own, but there are lots of additional style files,
21070 and there is even an interactive style file builder
21074 \begin_layout Plain Layout
21076 \begin_inset Flex URL
21079 \begin_layout Plain Layout
21081 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
21092 \begin_inset Flex Code
21095 \begin_layout Plain Layout
21104 \begin_layout Section
21105 Subdivided Bibliographies
21108 \begin_layout Standard
21109 Sometimes you might need to divide your bibliography into several sections.
21110 If you are for instance a historian, the possibility to separate sources
21111 and scientific works is most likely a
21112 \begin_inset Quotes eld
21116 \begin_inset Quotes erd
21120 Unfortunately, Bib\SpecialChar TeX
21121 itself does not allow you to do this.
21122 But with the help of some \SpecialChar LaTeX
21123 packages, Bib\SpecialChar TeX
21124 can be extended to fit your needs.
21127 \begin_layout Standard
21129 provides native support for one of these packages,
21137 \begin_layout Plain Layout
21139 \begin_inset Flex URL
21142 \begin_layout Plain Layout
21144 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
21154 The advantage of this package (compared to other packages such as
21158 ) is that you don't need to define new citation commands.
21159 Instead, you need to prepare different bibliographic databases which include
21160 the entries for the different sections of the bibliography.
21161 For example: If you want to divide your bibliography into the sections
21163 \begin_inset Quotes eld
21167 \begin_inset Quotes erd
21171 \begin_inset Quotes eld
21175 \begin_inset Quotes erd
21178 , you first need to create two bibliographic databases, e.
21179 \begin_inset space \thinspace{}
21183 \begin_inset space \space{}
21187 \begin_inset Flex Code
21190 \begin_layout Plain Layout
21197 \begin_inset Flex Code
21200 \begin_layout Plain Layout
21210 \begin_layout Standard
21212 \begin_inset Flex Noun
21215 \begin_layout Plain Layout
21216 Document\SpecialChar menuseparator
21223 \begin_inset Flex Noun
21226 \begin_layout Plain Layout
21233 \begin_inset Flex Noun
21236 \begin_layout Plain Layout
21237 Subdivided bibliography
21243 Now you can insert multiple Bib\SpecialChar TeX
21244 bibliographies, one for each section of
21246 Returning to our example: Insert the Bib\SpecialChar TeX
21248 \begin_inset Flex Code
21251 \begin_layout Plain Layout
21257 and a second one for the database
21258 \begin_inset Flex Code
21261 \begin_layout Plain Layout
21268 You are free to use the same or different styles for each section.
21269 Additionally, you can choose if the bibliography section should contain
21271 \begin_inset Quotes eld
21274 all cited references
21275 \begin_inset Quotes erd
21278 of the specified database(s) (which is the default),
21279 \begin_inset Quotes eld
21282 all uncited references
21283 \begin_inset Quotes erd
21287 \begin_inset Quotes eld
21291 \begin_inset Quotes erd
21295 This might be useful if you would like to separate your bibliography into
21297 \begin_inset Quotes eld
21301 \begin_inset Quotes erd
21305 \begin_inset Quotes eld
21309 \begin_inset Quotes erd
21313 \begin_inset Quotes eld
21317 \begin_inset Quotes erd
21321 The titles for the sections can be added as ordinary sections or subsections.
21323 \begin_inset Flex Code
21326 \begin_layout Plain Layout
21332 removes the bibliography title, you have to manually re-add that, too (as
21333 a chapter* or section*, for instance).
21336 \begin_layout Standard
21341 , the procedure is a bit different.
21350 , the aforementioned
21351 \begin_inset Flex Noun
21354 \begin_layout Plain Layout
21355 Subdivided bibliography
21360 option is disabled if you use
21369 provides its own means to generate subdivided bibliographies.
21370 You can either add keywords to bibliography entries via the
21371 \begin_inset Flex Code
21374 \begin_layout Plain Layout
21380 entry option and then filter bibliography sections by keyword (by adding
21382 \begin_inset Flex Code
21385 \begin_layout Plain Layout
21392 \begin_inset Flex Noun
21395 \begin_layout Plain Layout
21401 field of the dialog that opens if you left-click on the
21402 \begin_inset Flex Noun
21405 \begin_layout Plain Layout
21406 Biblatex Generated Bibliography
21411 button), or you can filter by entry types (such as
21420 \begin_inset space \thinspace{}
21425 \begin_inset Flex Code
21428 \begin_layout Plain Layout
21435 \begin_inset Flex Code
21438 \begin_layout Plain Layout
21445 \begin_inset Flex Noun
21448 \begin_layout Plain Layout
21454 field, or you can create so-called
21455 \begin_inset Quotes eld
21458 Bibliography Categories
21459 \begin_inset Quotes erd
21462 to which you can assign individual entries.
21463 Please refer to the Biblatex manual, section
21465 Subdivided Bibliographies
21470 \begin_layout Section
21471 Multiple Bibliographies
21472 \begin_inset CommandInset label
21474 name "subsec:Multiple-Bibliographies"
21481 \begin_layout Standard
21482 Multiple bibliographies, e.
21483 \begin_inset space \thinspace{}
21487 \begin_inset space \space{}
21490 a bibliography for each part, chapter, section, subsection or child (sub-documen
21491 t) of the document, are also supported by \SpecialChar LyX
21493 In order to enable it, go to
21494 \begin_inset Flex Noun
21497 \begin_layout Plain Layout
21498 Document\SpecialChar menuseparator
21499 Settings\SpecialChar menuseparator
21505 and select the relevant unit (e.
21506 \begin_inset space \thinspace{}
21510 \begin_inset Quotes eld
21514 \begin_inset Quotes erd
21518 \begin_inset Flex Noun
21521 \begin_layout Plain Layout
21522 Multiple Bibliographies
21528 Then add a Bib(la)\SpecialChar TeX
21529 bibliography to each unit (e.
21530 \begin_inset space \thinspace{}
21533 g., section) of your document.
21534 In the output, a separate bibliography, containing only the references
21535 done in the current unit is generated.
21538 \begin_layout Standard
21539 If you use Bib\SpecialChar TeX
21541 \begin_inset Flex Code
21544 \begin_layout Plain Layout
21551 \begin_inset Flex Code
21554 \begin_layout Plain Layout
21560 package is used to create multiple bibliographies.
21561 The former package is used if you select
21562 \begin_inset Quotes eld
21566 \begin_inset Quotes erd
21574 \begin_inset Flex Noun
21577 \begin_layout Plain Layout
21578 Sectioned Bibliography
21584 In all other cases,
21585 \begin_inset Flex Code
21588 \begin_layout Plain Layout
21598 \begin_layout Plain Layout
21599 An alternative approach, if you are willing to use some
21600 \begin_inset Flex Noun
21603 \begin_layout Plain Layout
21611 \begin_inset space ~
21615 \begin_inset CommandInset ref
21617 reference "sec:Inserting-TeX-Code"
21622 \begin_inset Flex Code
21625 \begin_layout Plain Layout
21637 \begin_inset Flex Code
21640 \begin_layout Plain Layout
21646 is used, \SpecialChar LyX
21647 encloses the specified units in
21648 \begin_inset Flex Code
21651 \begin_layout Plain Layout
21658 \begin_inset Flex Code
21661 \begin_layout Plain Layout
21670 \begin_inset Flex Code
21673 \begin_layout Plain Layout
21681 in order to create the units.
21682 Note that this approach has some limitations.
21683 First, every citation reference has to be inside some
21684 \begin_inset Flex Code
21687 \begin_layout Plain Layout
21694 So citations outside a defined unit (e.
21695 \begin_inset space \thinspace{}
21698 g., before the first section if you use
21699 \begin_inset Quotes eld
21703 \begin_inset Quotes erd
21707 \begin_inset Quotes eld
21711 \begin_inset Quotes erd
21715 You can also create your own units by entering
21716 \begin_inset Flex Code
21719 \begin_layout Plain Layout
21728 \begin_inset Flex Code
21731 \begin_layout Plain Layout
21739 as \SpecialChar TeX
21740 code (for instance to work around the mentioned limitation).
21742 \begin_inset Flex Code
21745 \begin_layout Plain Layout
21751 s cannot be nested.
21752 A second limitation is that
21753 \begin_inset Flex Code
21756 \begin_layout Plain Layout
21762 always processes all references of a bibliography database, even if they
21764 This can result in odd labels (e.
21765 \begin_inset space \thinspace{}
21770 \begin_inset Quotes eld
21774 \begin_inset Quotes erd
21777 if two works of this author from 2014 are in the database, even if only
21781 \begin_layout Standard
21787 \begin_inset Flex Code
21790 \begin_layout Plain Layout
21796 option is used instead.
21797 If you need specific units, you can start them with the \SpecialChar TeX
21799 \begin_inset Flex Code
21802 \begin_layout Plain Layout
21811 \begin_inset Flex Code
21814 \begin_layout Plain Layout
21823 If you also want to control the end of the unit, use the environment
21824 \begin_inset Flex Code
21827 \begin_layout Plain Layout
21837 \begin_inset Flex Code
21840 \begin_layout Plain Layout
21850 \begin_inset Flex Code
21853 \begin_layout Plain Layout
21859 s cannot be nested.
21860 In addition to the individual bibliography of the current unit,
21864 also provides an easy way to output all bibliographies, subsequently, at
21866 \begin_inset space \thinspace{}
21869 g., at the end of the document).
21871 \begin_inset Quotes eld
21874 all reference units
21875 \begin_inset Quotes erd
21878 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
21880 Please refer to the
21884 manual for more information on this topic.
21887 \begin_layout Chapter
21889 \change_deleted 564990737 1671355654
21893 \change_inserted 564990737 1671355667
21895 \change_deleted 564990737 1671355661
21897 \change_inserted 564990737 1671355684
21899 \begin_inset CommandInset label
21901 name "chap:bullets"
21906 \change_deleted 564990737 1671355684
21908 \begin_inset CommandInset label
21919 \begin_layout Standard
21925 \begin_layout Section
21929 \begin_layout Standard
21931 provides 216 bullet shapes that can be accessed from a simple dialog.
21932 Using this dialog you can easily specify what bullet shape to use at each
21933 level of an itemized list.
21934 These settings are document-wide so you won't be able to specify different
21935 sets of bullets for different paragraphs.
21939 \begin_layout Plain Layout
21940 Well, actually you can but you'll have to do it by hand.
21948 \begin_layout Section
21952 \begin_layout Standard
21953 Open the dialog by selecting the
21954 \begin_inset Flex Noun
21957 \begin_layout Plain Layout
21958 Document\SpecialChar menuseparator
21964 menu item and then select the
21965 \begin_inset Flex Noun
21968 \begin_layout Plain Layout
21977 \begin_layout Standard
21978 The dialog provides you with a table of bullet shapes.
21979 A column of buttons on the left of the table provides access to the six
21980 different panels of bullet shapes.
21981 The row of buttons across the top is used to select which bullet depth
21984 \change_deleted 244031559 1603875981
21985 A text entry under the table shows the currently selected bullet shape's
21987 equivalent and this can be edited if desired.
21988 If you do modify the text you will also need to specify any needed packages
21989 in the \SpecialChar LaTeX
21995 \begin_layout Standard
21996 The six panels are divided up by the packages they require.
21997 The following table shows the mappings from button name to \SpecialChar LaTeX
22001 \begin_layout Standard
22003 \begin_inset Tabular
22004 <lyxtabular version="3" rows="7" columns="2">
22005 <features tabularvalignment="middle">
22006 <column alignment="center" valignment="top" width="0pt">
22007 <column alignment="center" valignment="top" width="0pt">
22009 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22012 \begin_layout Plain Layout
22027 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22030 \begin_layout Plain Layout
22047 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22050 \begin_layout Plain Layout
22065 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22068 \begin_layout Plain Layout
22077 base \SpecialChar LaTeX
22085 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22088 \begin_layout Plain Layout
22103 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22106 \begin_layout Plain Layout
22123 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22126 \begin_layout Plain Layout
22141 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22144 \begin_layout Plain Layout
22161 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22164 \begin_layout Plain Layout
22179 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22182 \begin_layout Plain Layout
22199 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22202 \begin_layout Plain Layout
22217 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22220 \begin_layout Plain Layout
22237 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22240 \begin_layout Plain Layout
22255 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22258 \begin_layout Plain Layout
22281 \begin_layout Standard
22283 doesn't stop you using bullets from packages you don't have.
22284 If you get errors from \SpecialChar LaTeX
22285 when you try to view or print the file, then it
22286 is likely you are missing a package.
22290 \begin_layout Plain Layout
22292 doesn't restrict your use since you may be editing locally and exporting
22301 \begin_layout Section
22305 \begin_layout Standard
22306 Select which bullet depth you want to change then select the bullet shape
22308 Any changes will not be visible in \SpecialChar LyX
22309 , but are visible when viewing the document.
22312 \begin_layout Standard
22313 You can reset a bullet shape to the default simply by clicking your right
22314 mouse button on the appropriate bullet depth button.
22318 \begin_layout Plain Layout
22320 \change_inserted 564990737 1672138075
22321 \begin_inset CommandInset label
22323 name "fn:If-you-really"
22333 want to have multiple sets of paragraphs with different sets of bullets
22334 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
22336 The bullet selection dialog can help though because it provides you with
22337 the \SpecialChar LaTeX
22338 code for a wide range of bullet shapes.
22339 To make your own custom paragraphs you have the following options:
22342 \begin_layout Plain Layout
22346 \begin_layout Plain Layout
22362 \begin_layout Plain Layout
22366 \begin_layout Plain Layout
22388 \begin_layout Itemize
22389 Use the \SpecialChar LaTeX
22391 \begin_inset Flex Code
22394 \begin_layout Plain Layout
22402 to specify a new bullet shape for a given depth.
22403 You'll also need to save the current bullet shape so you can restore it
22405 In this itemized list the following \SpecialChar LaTeX
22406 code was used to change the bullet
22407 used for the first depth.
22411 \begin_layout LyX-Code
22421 \begin_layout LyX-Code
22438 \begin_layout Itemize
22439 Note that the itemize depth is specified in Roman numerals as part of the
22449 \begin_layout Itemize
22450 \begin_inset Argument item:1
22453 \begin_layout Plain Layout
22457 \begin_layout Plain Layout
22475 Specify each individual entry by starting each item with the bullet shape
22477 \begin_inset Quotes eld
22481 \begin_inset Quotes erd
22484 inset (available at
22486 Insert\SpecialChar menuseparator
22490 \begin_inset Flex Noun
22493 \begin_layout Plain Layout
22501 For example, this item was started with
22502 \begin_inset Flex Code
22505 \begin_layout Plain Layout
22520 \begin_layout Plain Layout
22524 \begin_layout Plain Layout
22540 \begin_layout Plain Layout
22541 You'll also need to revert the labelitem back to its previous setting for
22542 the global bullet shape settings to remain in effect.
22543 The way used here was:
22546 \begin_layout LyX-Code
22561 \begin_layout Chapter
22565 \begin_layout Section
22566 Multipart Documents
22569 \begin_layout Subsection
22573 \begin_layout Standard
22574 When you are working on a large file with many sections, it is often convenient
22575 to break up the document into several files, or perhaps you have something
22576 where a table may change from time to time, but the preceding text does
22578 In these cases, you should seriously consider using multipart documents.
22579 For example, scientific papers often have five major sections: the introduction
22580 , observations, results, discussion, and conclusion.
22581 Each of these could be its own separate \SpecialChar LyX
22583 \begin_inset Quotes eld
22587 \begin_inset Quotes erd
22590 file which contains the title, authors, abstract, references, etc., plus
22591 the five included files.
22592 It is important to note that each of these files is a full \SpecialChar LyX
22594 can be formatted and printed on its own, as well as included in a master
22596 Each of these files must have the same document class, however—don't attempt
22597 to mix book classes with article classes.
22598 You may also include \SpecialChar LaTeX
22599 files; however, these files must not have their own
22601 \begin_inset space \thinspace{}
22605 \begin_inset space \space{}
22608 everything up to and including the
22609 \begin_inset Flex Code
22612 \begin_layout Plain Layout
22620 line as well as the
22621 \begin_inset Flex Code
22624 \begin_layout Plain Layout
22632 line must be deleted) or else errors will be generated when you try to
22636 \begin_layout Standard
22638 allows you to include files quite easily with
22639 \begin_inset Flex Noun
22642 \begin_layout Plain Layout
22643 Insert\SpecialChar menuseparator
22645 \begin_inset space ~
22654 When you click on this selection a small box is inserted into the file
22655 at the current cursor location.
22656 Clicking on the box raises a dialog which allows you to select the file
22657 to be included, and the method of its inclusion.
22661 \begin_layout Standard
22662 The file selection box should by now be obvious.
22663 The three inclusion methods are
22664 \begin_inset Quotes eld
22668 \begin_inset Quotes erd
22672 \begin_inset Quotes eld
22676 \begin_inset Quotes erd
22680 \begin_inset Quotes eld
22684 \begin_inset Quotes erd
22689 \begin_inset Quotes eld
22693 \begin_inset Quotes erd
22697 \begin_inset Quotes eld
22701 \begin_inset Quotes erd
22704 are similar in many ways, but there are also some notable differences:
22707 \begin_layout Enumerate
22709 \begin_inset Quotes eld
22713 \begin_inset Quotes erd
22716 are typeset beginning on a new page, while files that are
22717 \begin_inset Quotes eld
22721 \begin_inset Quotes erd
22724 are typeset starting on the current page.
22727 \begin_layout Enumerate
22728 \begin_inset Quotes eld
22732 \begin_inset Quotes erd
22735 files cannot themselves
22736 \begin_inset Quotes eld
22740 \begin_inset Quotes erd
22744 \begin_inset Quotes eld
22748 \begin_inset Quotes erd
22753 \begin_inset Quotes eld
22757 \begin_inset Quotes erd
22760 , on the other hand, infinite sub-inputting is possible.
22763 \begin_layout Enumerate
22764 \begin_inset Quotes eld
22768 \begin_inset Quotes erd
22771 allow for the output of only selected
22772 \begin_inset Quotes eld
22776 \begin_inset Quotes erd
22779 files, while maintaining the actual counters (pagination etc.) and references
22780 (please refer to the section
22783 \begin_inset space ~
22791 \begin_inset space ~
22796 manual for details).
22799 \begin_layout Standard
22801 \begin_inset Quotes eld
22805 \begin_inset Quotes erd
22808 is the preferred method for chapters that are outsourced to child documents,
22810 \begin_inset Quotes eld
22814 \begin_inset Quotes erd
22817 is more suitable for arbitrary file inheritance.
22820 \begin_layout Standard
22822 \begin_inset Quotes eld
22826 \begin_inset Quotes erd
22829 included file allows you to include a file typeset exactly as it appears
22831 \begin_inset space \thinspace{}
22835 \begin_inset space \space{}
22839 \begin_inset Flex Code
22842 \begin_layout Plain Layout
22848 mode, with the characters set in a fixed-width typewriter font.
22849 Normally, spaces in this file are invisible, though two consecutive spaces
22850 are conserved, unlike \SpecialChar LyX
22851 's normal treatment of spaces.
22852 However, setting the
22853 \begin_inset Flex Noun
22856 \begin_layout Plain Layout
22858 \begin_inset space ~
22862 \begin_inset space ~
22866 \begin_inset space ~
22874 checkbox typesets a mark to unambiguously define the presence of a space.
22878 \begin_layout Standard
22879 Generally, the master file is converted into a full \SpecialChar LaTeX
22880 file before typesetting,
22881 while the included files are converted to \SpecialChar LaTeX
22882 files that do not have all the
22883 preamble information.
22886 \begin_layout Subsection
22887 Cross-References Between Files
22890 \begin_layout Standard
22891 \begin_inset Box Shadowbox
22901 height_special "totalheight"
22906 backgroundcolor "none"
22909 \begin_layout Plain Layout
22910 This section is somewhat out of date.
22911 Need to describe default master documents and how children are opened when
22921 \begin_layout Standard
22922 It is possible to set up cross-references between the different files.
22923 First, open all the files in question: let's call them A and B in a two
22924 file example, where B is included in A.
22925 Let's say you insert a label in A, then want to reference it in B.
22926 Open the cross-reference dialog whilst in document B, and you can select
22928 \begin_inset Quotes eld
22932 \begin_inset Quotes erd
22938 \begin_layout Subsection
22939 Bibliography Lists in all Subdocuments
22942 \begin_layout Standard
22943 If you work with child documents, you might want to have only one main bibliogra
22944 phy at the end, but still be able to have a selected bibliography for the
22945 child if you output it on its own.
22946 Here is how to achieve this.
22949 \begin_layout Standard
22950 For the main document, you just insert a bibliography inset at the place
22951 where the main bibliography has to appear (within the master file or within
22953 If the bibliography inset is in the master file, the references will be
22954 inherited by all children, so they are available in the citation dialog
22958 \begin_layout Standard
22959 For child-specific bibliographies, insert bibliography insets within the
22960 child documents, at the place where the bibliography should appear when
22961 the child is compiled separately.
22962 However, the trick is to insert them into a branch (
22964 Insert\SpecialChar menuseparator
22965 Branch\SpecialChar menuseparator
22966 Insert New Branch...
22969 \begin_inset space \thinspace{}
22974 \begin_inset Quotes eld
22978 \begin_inset Quotes erd
22982 Within the children, activate the branch (
22984 Document\SpecialChar menuseparator
22985 Settings...\SpecialChar menuseparator
22989 Within the master, deactivate the branch (
22991 Document\SpecialChar menuseparator
22992 Settings...\SpecialChar menuseparator
22996 Now the child's bibliography will be ignored by the master, but considered
23000 \begin_layout Standard
23001 If you need multiple bibliographies (e.
23002 \begin_inset space \thinspace{}
23005 g., one per child in the
23009 ), please refer to sec.
23010 \begin_inset space ~
23014 \begin_inset CommandInset ref
23016 reference "subsec:Multiple-Bibliographies"
23023 \begin_layout Section
23028 \begin_layout Standard
23029 Users sometimes need to be able to
23030 \begin_inset Quotes eld
23034 \begin_inset Quotes erd
23038 file together with all the images (and other files) on which it depends,
23039 either for sending to a publisher or for sharing with a co-author.
23041 includes a Python script (
23042 \begin_inset Flex Code
23045 \begin_layout Plain Layout
23051 ) that automates this process.
23052 To use it, you must have either the
23053 \begin_inset Flex Code
23056 \begin_layout Plain Layout
23063 \begin_inset Flex Code
23066 \begin_layout Plain Layout
23072 python modules installed on your system.
23073 By default, the script prefers the
23074 \begin_inset Flex Code
23077 \begin_layout Plain Layout
23084 \begin_inset Flex Code
23087 \begin_layout Plain Layout
23093 format on Unix-like systems and the
23094 \begin_inset Flex Code
23097 \begin_layout Plain Layout
23106 \begin_layout Standard
23108 's configuration process will set the script up to export a `\SpecialChar LyX
23110 and this format will then be available under
23111 \begin_inset Flex Code
23114 \begin_layout Plain Layout
23115 File\SpecialChar menuseparator
23124 \begin_layout Standard
23125 Independently of the platform, the generation of a particular archive format
23126 can be forced by adding either the
23127 \begin_inset Flex Code
23130 \begin_layout Plain Layout
23137 \begin_inset Flex Code
23140 \begin_layout Plain Layout
23147 \begin_inset Flex Code
23150 \begin_layout Plain Layout
23157 \begin_inset Flex Code
23160 \begin_layout Plain Layout
23166 format) switch to the
23167 \begin_inset Flex Code
23170 \begin_layout Plain Layout
23172 \SpecialChar menuseparator
23180 \begin_inset Flex Code
23183 \begin_layout Plain Layout
23184 Tools\SpecialChar menuseparator
23185 Preferences\SpecialChar menuseparator
23186 File Handling\SpecialChar menuseparator
23193 (Make sure you add the switch after the script name, not before it.)
23196 \begin_layout Section
23197 Fancy Headers and Footers
23200 \begin_layout Standard
23201 The default page layout is rather plain; for an
23202 \begin_inset Flex Code
23205 \begin_layout Plain Layout
23211 document class, all you get is a centered page number at the bottom of
23213 This document uses KOMA-script's book class, so it appears to be a bit
23215 But to really put on a show, you need to set the document page style to
23217 \begin_inset Quotes eld
23221 \begin_inset Quotes erd
23224 , as mentioned in the
23229 This section describes the \SpecialChar LaTeX
23230 code you need to insert in your \SpecialChar LaTeX
23232 order to get the desired effects.
23235 \begin_layout Standard
23236 For more information on fancy headers, see the
23237 \begin_inset Flex Code
23240 \begin_layout Plain Layout
23246 package documentation.
23248 \begin_inset Flex URL
23251 \begin_layout Plain Layout
23253 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
23261 \begin_layout Standard
23262 The page header is divided into three fields, not surprisingly labeled
23263 \begin_inset Quotes eld
23267 \begin_inset Quotes erd
23271 \begin_inset Quotes eld
23275 \begin_inset Quotes erd
23279 \begin_inset Quotes eld
23283 \begin_inset Quotes erd
23287 The footer is also divided into these three fields.
23288 The \SpecialChar LaTeX
23289 commands to set these fields in the simplest manner are
23290 \begin_inset Flex Code
23293 \begin_layout Plain Layout
23302 \begin_inset Flex Code
23305 \begin_layout Plain Layout
23314 \begin_inset Flex Code
23317 \begin_layout Plain Layout
23326 \begin_inset Flex Code
23329 \begin_layout Plain Layout
23338 Suppose you wish to put your name in the upper left hand corner of each
23340 Simply insert the following command in the preamble:
23343 \begin_layout Standard
23352 \begin_layout Standard
23353 You will now see your name in the upper left.
23354 If a field has a default entry that you would like to get rid of (often
23355 the page number appears in the central footer) simply include a command
23356 with a blank argument, e.
23357 \begin_inset space \thinspace{}
23363 \begin_layout Standard
23371 \begin_layout Standard
23372 Let's get really fancy: lets put the section number with the word
23373 \begin_inset Quotes eld
23377 \begin_inset Quotes erd
23381 \begin_inset space \thinspace{}
23385 \begin_inset space \space{}
23388 Section 3) in the upper left, the page number (e.
23389 \begin_inset space \thinspace{}
23393 \begin_inset space \space{}
23396 Page 4) in the upper right, your name in the lower left, and the date in
23398 The following commands should now appear in the preamble:
23401 \begin_layout Standard
23411 \begin_layout Standard
23419 \begin_layout Standard
23429 \begin_layout Standard
23438 \begin_layout Standard
23446 \begin_layout Standard
23456 \begin_layout Standard
23458 \begin_inset Flex Code
23461 \begin_layout Plain Layout
23470 \begin_inset Flex Code
23473 \begin_layout Plain Layout
23481 access \SpecialChar LaTeX
23482 's section and page counters, and so print out the current section
23485 \begin_inset Flex Code
23488 \begin_layout Plain Layout
23496 simply prints out today's date.
23499 \begin_layout Standard
23500 The thicknesses of the horizontal rules drawn beneath the header and above
23501 the footer can also be modified.
23502 If you don't want one of the rules, set its thickness to 0.
23503 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
23509 \begin_inset Flex Code
23512 \begin_layout Plain Layout
23517 headrulewidth}{0.4pt}
23523 \begin_inset Flex Code
23526 \begin_layout Plain Layout
23531 footrulewidth}{0.4pt}
23536 to set the thicknesses.
23539 \begin_layout Standard
23540 You can switch the header/footer settings on and off for individual pages
23541 using commands like
23542 \begin_inset Flex Code
23545 \begin_layout Plain Layout
23548 thispagestyle{empty}
23554 \begin_inset Flex Code
23557 \begin_layout Plain Layout
23560 thispagestyle{plain}
23566 \begin_inset Flex Code
23569 \begin_layout Plain Layout
23572 thispagestyle{fancy}
23578 Simply insert them in the text on the page you want changed and mark them
23579 as \SpecialChar TeX
23581 In fact, title pages are marked as plain by default, while following pages
23582 are marked fancy when using the global fancy setting.
23585 \begin_layout Standard
23586 As a final example, it is possible to include an image in the header or
23588 Suppose you want to put a company logo in the upper lefthand corner.
23589 You might try something like
23592 \begin_layout Standard
23601 includegraphics{logo.eps}}}
23604 \begin_layout Standard
23606 (you may need to preface this with
23607 \begin_inset Flex Code
23610 \begin_layout Plain Layout
23613 usepackage{graphics}
23618 if you don't include graphics elsewhere in your document).
23621 \begin_layout Chapter
23623 and the World Wide Web
23626 \begin_layout Standard
23628 has long supported the export of documents to various web-friendly formats,
23630 Before version 2.0, however, HTML export was always accomplished by the
23631 use of external converters.
23635 \begin_layout Plain Layout
23636 For details on the use of external converters with \SpecialChar LyX
23641 section of the Customization manual.
23646 These fall into two large groups: there are converters that use \SpecialChar LaTeX
23648 intermediate format, such as
23649 \begin_inset Flex Code
23652 \begin_layout Plain Layout
23659 \begin_inset Flex Code
23662 \begin_layout Plain Layout
23669 \begin_inset Flex Code
23672 \begin_layout Plain Layout
23678 , relying upon \SpecialChar LyX
23679 to produce the \SpecialChar LaTeX
23680 ; and there is a converter that works directly
23681 on \SpecialChar LyX
23683 \begin_inset Flex Code
23686 \begin_layout Plain Layout
23694 All of these have different advantages and disadvantages.
23698 \begin_layout Standard
23699 The \SpecialChar LaTeX
23700 -based converters have the advantage that, in principle, they know everythin
23701 g about the exported document that \SpecialChar LaTeX
23703 Such converters do not care, for example, if a certain block of code was
23704 produced by \SpecialChar LyX
23705 or was Evil Red Text.
23706 These converters know about
23707 \begin_inset Flex Code
23710 \begin_layout Plain Layout
23716 files, counters, and references, and can often make use of the
23717 \begin_inset Flex Code
23720 \begin_layout Plain Layout
23726 files generated by Bib\SpecialChar TeX
23728 On the other hand, \SpecialChar LaTeX
23729 is a very hard language to parse—it is sometimes said
23730 that only \SpecialChar TeX
23731 itself understands \SpecialChar TeX
23732 —and \SpecialChar LaTeX
23733 -based converters will often choke on
23734 what seem to be quite simple constructs; complex ones can throw them completely
23735 , and as of this writing, for example, the
23739 manual will not export with
23740 \begin_inset Flex Code
23743 \begin_layout Plain Layout
23749 , though the others will.
23750 The other issue concerns how math is handled.
23751 These converters typically convert the formulae into little pictures that
23752 are then linked from the HTML document.
23753 Since these are actually generated by \SpecialChar LaTeX
23754 , they are accurate.
23755 But they do not scale well, and just getting them to look as if they are
23756 actually meant to be in your document—so that the font sizes seem to be
23757 roughly the same—can be a challenge.
23760 \begin_layout Standard
23762 \begin_inset Flex Code
23765 \begin_layout Plain Layout
23773 \begin_inset CommandInset href
23775 name "http://pinchito.es/elyxer/"
23776 target "http://pinchito.es/elyxer/"
23781 ) solves some of these problems.
23782 In particular, the formulae it produces scale perfectly, since it renders
23783 math using a combination of HTML and CSS rather than converting the formulae
23785 But even moderately complex formula are rendered less well than with
23786 \begin_inset Flex Code
23789 \begin_layout Plain Layout
23795 ; this reflects the limitations of HTML.
23799 \begin_layout Plain Layout
23801 \begin_inset Flex Code
23804 \begin_layout Plain Layout
23811 can also use jsMath and MathJax for equations, but this setting is only
23812 available globally and requires one to have access to a server that runs
23818 More importantly (as of version 1.1.1, at least),
23819 \begin_inset Flex Code
23822 \begin_layout Plain Layout
23829 has limited support for math macros and no support for user-defined paragraph
23830 or character styles.
23831 These limitations make
23832 \begin_inset Flex Code
23835 \begin_layout Plain Layout
23842 unsuitable for many of the documents \SpecialChar LyX
23844 In principle, of course, these problems could be solved, but the \SpecialChar LyX
23846 have decided to follow a different path and have made \SpecialChar LyX
23848 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
23849 , DocBook, and plaintext.
23852 \begin_layout Standard
23853 As of this writing, XHTML output remains under development and should probably
23855 \begin_inset Quotes eld
23859 \begin_inset Quotes erd
23866 \begin_layout Plain Layout
23868 \begin_inset Flex Code
23871 \begin_layout Plain Layout
23872 development/HTML/HTML.notes
23877 , which can be found in the \SpecialChar LyX
23879 \begin_inset CommandInset href
23881 name "accessed online"
23882 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
23887 , usually contains up-to-date information about the state of XHTML output.
23888 See also the list of XHTML bugs on
23889 \begin_inset CommandInset href
23891 name "the bug tracker"
23892 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"
23902 Still, the developers have chosen this approach because it has several
23903 potential advantages over the other two.
23906 \begin_layout Standard
23907 These advantages are primarily due to the fact that the XHTML output routines,
23908 since they are part of \SpecialChar LyX
23909 , know everything \SpecialChar LyX
23910 knows about the document being
23915 \begin_layout Plain Layout
23916 Another advantage is that, since these routines are internal to \SpecialChar LyX
23918 immune to changes in \SpecialChar LyX
23919 's file format, or to changes in the semantics of
23925 So they know about the table of contents (as displayed in the outline),
23926 about the counters associated with different paragraph styles, and about
23927 user-defined styles.
23928 The XHTML output routines know what \SpecialChar LyX
23929 knows about internationalization,
23930 too, so they will output
23931 \begin_inset Quotes eld
23935 \begin_inset Quotes erd
23939 \begin_inset Quotes eld
23947 \begin_inset Quotes erd
23950 , depending upon the language in effect at the time.
23954 \begin_layout Standard
23955 Quite generally, the output routines know what \SpecialChar LyX
23956 knows about document layout,
23957 that is, about how the document is to be rendered on screen.
23958 We use this information when we output the document as XHTML.
23959 In particular, \SpecialChar LyX
23964 generates CSS style information corresponding to the layout information
23965 it uses to render the document on screen: if section headings are supposed
23966 to be sans-serif and bold as seen in \SpecialChar LyX
23967 , then (by default) they will be sans-seri
23968 f and bold when viewed in a web browser, too.
23969 And this is true not just for pre-defined styles, like Section, but for
23970 any style, including user-defined styles.
23971 Indeed, the XHTML output routines make no distinction between user-defined
23973 \change_deleted 244031559 1603876931
23975 \change_inserted 244031559 1603876940
23978 styles and \SpecialChar LyX
23979 's own pre-defined styles: in each case, everything \SpecialChar LyX
23981 the styles is contained in the layout files.
23982 And much the same is true as regards pre-defined textual insets, such as
23983 footnotes, and various custom insets.
23987 \begin_layout Standard
23988 The result is that XHTML output can be customized and extended in exactly
23989 the same way \SpecialChar LaTeX
23990 output can be customized and extended: through layout files
23992 See chapter five of the
23996 manual for the details.
23999 \begin_layout Standard
24000 The remainder of this chapter contains more detailed information on XHTML
24001 output, its limitations, and ways to work around those limitations.
24004 \begin_layout Section
24005 Math Output in XHTML
24008 \begin_layout Standard
24010 offers four choices for how math is rendered.
24011 These have various advantages and disadvantages:
24014 \begin_layout Itemize
24016 \begin_inset Newline newline
24019 MathML is a dialect of XML designed specifically for mathematics on the
24020 web, and it typically renders very well in browsers that support it.
24021 The disadvantage is that not all browsers support MathML, and support is
24022 not complete even in the Gecko-based browsers, such as Firefox.
24023 \begin_inset Newline newline
24026 If \SpecialChar LyX
24027 is unable to render a formula as MathML—for example, if the formula
24029 \begin_inset Flex Code
24032 \begin_layout Plain Layout
24038 package or ERT—then it will instead output the formula as an image.
24042 \begin_layout Itemize
24044 \begin_inset Newline newline
24047 As mentioned above,
24048 \begin_inset Flex Code
24051 \begin_layout Plain Layout
24057 outputs math as HTML, styled by CSS.
24061 \begin_layout Plain Layout
24063 has borrowed some of the CSS for its HTML output from
24064 \begin_inset Flex Code
24067 \begin_layout Plain Layout
24078 For simple formulae, this can work quite well, though with more complicated
24079 formulae it tends to break down.
24080 Still, this method has the advantage that it is very widely supported and
24081 so it may be appropriate for documents that contain only a little, fairly
24083 \begin_inset Newline newline
24086 If Lyx is unable to render a formula as HTML—for example, if the formula
24088 \begin_inset Flex Code
24091 \begin_layout Plain Layout
24097 package or ERT—then it will instead output the formula as an image.
24101 \begin_layout Itemize
24103 \begin_inset Newline newline
24107 \begin_inset Flex Code
24110 \begin_layout Plain Layout
24117 will output formulae as images, the very same images, in fact, that are
24118 used for instant preview.
24122 \begin_layout Plain Layout
24123 Instant preview does
24127 have to be on for images to be output, however.
24132 The advantage to this method is that the images are simply generated by
24134 , so they are very accurate.
24135 The disadvantage, as mentioned earlier, is that these are bitmapped images,
24136 so they do not scale terribly well, and one cannot copy them, etc.
24137 \begin_inset Newline newline
24140 The size of the images can be controlled by setting the
24141 \begin_inset Quotes eld
24144 Math Images Scaling
24145 \begin_inset Quotes erd
24149 \begin_inset Flex Noun
24152 \begin_layout Plain Layout
24153 Document\SpecialChar menuseparator
24154 Settings\SpecialChar menuseparator
24164 \begin_layout Plain Layout
24165 For those who want to know, this controls the resolution of the image in
24166 dots per inch and is based upon a default of 75 dpi.
24172 \begin_inset Newline newline
24175 If \SpecialChar LyX
24176 for some reason fails to create an image for a formula (e.g., if a required
24178 package is not installed), then it will fall back to outputing the raw
24183 \begin_layout Itemize
24186 \begin_inset Newline newline
24189 Finally, \SpecialChar LyX
24190 will happily output math as \SpecialChar LaTeX
24192 As well as being the output of last resort, this method can be used with
24194 \begin_inset CommandInset href
24197 target "http://www.math.union.edu/~dpvc/jsMath/"
24202 , which uses JavaScript to render \SpecialChar LaTeX
24203 embedded in HTML documents.
24205 wraps the \SpecialChar LaTeX
24207 \begin_inset Flex Code
24210 \begin_layout Plain Layout
24216 (for inline formulas) or
24217 \begin_inset Flex Code
24220 \begin_layout Plain Layout
24226 (for displayed formulas) with
24227 \begin_inset Flex Code
24230 \begin_layout Plain Layout
24236 , as is required for jsMath.
24239 \begin_layout Standard
24240 One of these output methods must be selected under
24241 \begin_inset Flex Noun
24244 \begin_layout Plain Layout
24245 Document\SpecialChar menuseparator
24246 Settings\SpecialChar menuseparator
24253 By default, \SpecialChar LyX
24255 This is a document-wide setting, therefore.
24258 \begin_layout Standard
24259 Eventually, \SpecialChar LyX
24260 will offer the user the option to select an alternate output
24261 method for a particular inset, say, one that isn't being rendered very
24266 \begin_layout Plain Layout
24267 That said, since \SpecialChar LyX
24268 falls back to images if the inset contains ERT, then one
24269 can force output as an image by putting some harmless ERT into the math,
24271 \begin_inset Formula $a=b\relax$
24282 \begin_layout Section
24283 Bibliography and Citations
24286 \begin_layout Standard
24287 XHTML output fully supports bibliographies and citations.
24291 \begin_layout Standard
24292 Citation labels are generated by the same machinery that generates \SpecialChar LyX
24294 labels, so the labels will look in the output much as they do in \SpecialChar LyX
24297 If you are using numerical citations, then \SpecialChar LyX
24298 will output numerical labels,
24299 such as [1] or [17], rather than simply showing the citation key in square
24300 brackets, as it does on-screen.
24301 If you are using author-year citations, then \SpecialChar LyX
24302 will add lowercase letters
24303 to the years, just as Bib\SpecialChar TeX
24304 does, if it finds more than one citation for
24305 a given author-year combination.
24306 The labels will be printed with the bibliography entries.
24307 Note that there is, at present, no way to customize the appearance of the
24308 labels, for example, to choose between square brackets and parentheses.
24311 \begin_layout Standard
24312 Bibliography output is handled by the same machinery that handles the presentati
24313 on of reference information in the citation dialog, so you will see in the
24314 XHTML output pretty much what you would see if you were to look at a given
24315 entry in the citation dialog.
24316 The formatting can be customized in your layout file or, preferably, in
24322 manual for the details.
24325 \begin_layout Standard
24326 The main defect at present is that cross-referenced information is printed
24327 with every entry with which it is associated.
24328 So you can see things like this:
24331 \begin_layout Quote
24333 \begin_inset Quotes eld
24336 Context and Logical Form
24337 \begin_inset Quotes erd
24342 Language in Context: Selected Essays
24344 (Oxford: Oxford University Press, 2007), pp.
24348 \begin_layout Quote
24350 \begin_inset Quotes eld
24353 Semantics in Context
24354 \begin_inset Quotes erd
24359 Language in Context: Selected Essays
24361 (Oxford: Oxford University Press, 2007), pp.
24365 \begin_layout Standard
24366 This should be fixed before long.
24369 \begin_layout Standard
24370 There is no support at present for sectioned bibliographies.
24371 If you have multiple bibliographies, then \SpecialChar LyX
24372 will print the same bibliography
24376 \begin_layout Section
24380 \begin_layout Standard
24382 will happily export indexes as XHTML, but with certain limitations at the
24386 \begin_layout Standard
24387 Index export will be most reliable when you do not attempt to use the fancy
24388 constructs that are described in the section on indexes in the
24396 \begin_layout Plain Layout
24397 The main issue here is that \SpecialChar LyX
24398 itself does not really handle these.
24399 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
24405 We'll describe how they are handled using the subsection headings from
24409 \begin_layout Itemize
24410 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
24411 makes an effort to support these,
24412 but the entries must be separated by
24413 \begin_inset Quotes eld
24417 \begin_inset Quotes erd
24420 , that is, there must be spaces around the exclamation point.
24421 This is because it is otherwise too difficult to check for escaped exclamation
24422 points, ones in math, and so forth.
24425 \begin_layout Itemize
24426 Page Ranges: There is no support at all for page ranges, since these make
24427 no sense with XHMTL.
24428 Instead, you will just get two index entries, one at either end.
24431 \begin_layout Itemize
24432 Cross-referencing: There is no support for cross-referencing.
24433 If \SpecialChar LyX
24434 finds an entry containing the
24435 \begin_inset Quotes eld
24438 |see\SpecialChar ldots
24440 \begin_inset Quotes erd
24443 construct, it is just dropped, and the rest is treated as an ordinary index
24447 \begin_layout Itemize
24448 Index Entry Order: \SpecialChar LyX
24449 does support attempts to fix the sorting order.
24450 It will take what is before the first `@' it finds and use that for sorting,
24451 taking what follows the first `@' to be the actual entry.
24452 At present, \SpecialChar LyX
24453 does not check for escaped `@', so do not try to index email
24457 \begin_layout Itemize
24458 Index Entry Layout: You can format entries by using the text style dialog,
24459 or by using any other method available within \SpecialChar LyX
24461 There is no support for constructs like:
24462 \begin_inset Quotes eld
24466 \begin_inset Quotes erd
24470 Indeed, if \SpecialChar LyX
24471 finds a pipe symbol, `|', in an entry, it will delete it and
24472 everything that follows it.
24475 \begin_layout Itemize
24476 Multiple Indexes: There is no support for multiple indexes.
24477 Rather, all index entries will be printed as one large index.
24478 To avoid our printing several versions of the index, we print only the
24479 main index, so make sure you have one.
24482 \begin_layout Section
24483 Nomenclature and Glossary
24486 \begin_layout Standard
24487 There is at present no support for glossaries.
24488 Adding it would be fairly trivial, and welcome.
24491 \begin_layout Chapter
24493 \change_inserted 1075283030 1616534180
24497 \begin_layout Standard
24499 \change_inserted 1075283030 1616534386
24500 Apart from HTML, \SpecialChar LyX
24501 can generate documents in the DocBook XML vocabulary.
24502 With versions 2.3 and before, only select templates could be used to generate
24503 DocBook documents (only version 4).
24504 Starting with \SpecialChar LyX
24505 2.4, most \SpecialChar LyX
24506 layouts can generate valid DocBook documents (only
24508 This feature is built into \SpecialChar LyX
24509 and does not require the use of external tools.
24512 \begin_layout Standard
24514 \change_inserted 1075283030 1616534437
24515 The result is that the DocBook output can be customized and extended in
24516 exactly the same way \SpecialChar LaTeX
24517 output can be customized and extended: through layout
24519 See chapter five of the
24523 manual for the details.
24526 \begin_layout Standard
24528 \change_inserted 1075283030 1616534475
24529 Most \SpecialChar LyX
24530 features are supported with DocBook, like math output.
24533 \begin_layout Itemize
24535 \change_inserted 1075283030 1616534741
24536 Math output is performed mostly in MathML (the major exception being constructio
24537 ns not supported by \SpecialChar LyX
24540 All formulae are also available in raw \SpecialChar TeX
24541 in the DocBook output for further
24545 \begin_layout Itemize
24547 \change_inserted 1075283030 1616534852
24548 Bibliographies and citations are implemented, including with an external
24550 Bibliography entries are not prerendered when the detailed information
24551 are available, but rather output with the standard DocBook constructs.
24552 The external DocBook processor is expected to handle the rendering of entries.
24555 \begin_layout Itemize
24557 \change_inserted 1075283030 1616534863
24558 Indexes are supported, including multiple indices.
24563 ), page ranges, and cross-references (
24567 ) are supported, with the exception of the same symbols escaped.
24576 ) are not supported.
24577 There is no support for escaping of index entries.
24580 \begin_layout Itemize
24582 \change_inserted 1075283030 1616534884
24583 Glossaries are implemented.
24586 \begin_layout Standard
24588 \change_inserted 1075283030 1616534894
24589 Two major parameters can be set at the document level.
24592 \begin_layout Itemize
24594 \change_inserted 1075283030 1616534948
24595 Format for tables: \SpecialChar LyX
24596 can generate tables either as HTML (default value) or
24597 CALS, depending on the user's requirements.
24598 Most DocBook processors accept both formats.
24601 \begin_layout Itemize
24603 \change_inserted 1075283030 1616535006
24604 MathML prefix: in DocBook, MathML is included within its own name space,
24606 The implication is that there must be an indication of the tags belonging
24607 to the MathML standard.
24608 Three choices are offered:
24612 \begin_layout Itemize
24614 \change_inserted 1075283030 1616535044
24615 Inline: the MathML name space is defined for each formula (using the
24619 attribute on each formula)
24622 \begin_layout Itemize
24624 \change_inserted 1075283030 1616535090
24629 prefix (default): the MathML name space is defined at the document level
24634 attribute on the root element).
24635 Each MathML is prefixed with
24644 \begin_layout Itemize
24646 \change_inserted 1075283030 1616620405
24651 prefix: similar to the
24660 \begin_layout Standard
24662 \change_inserted 1075283030 1616620470
24663 This option is especially useful if you want \SpecialChar LyX
24664 to match your personal style
24665 or to work with buggy software that only accepts one prefix for MathML.
24671 \begin_layout Chapter
24672 The \SpecialChar LyX
24676 \begin_layout Section
24680 \begin_layout Standard
24681 The `\SpecialChar LyX
24682 server' allows other programs to talk to \SpecialChar LyX
24683 , invoke \SpecialChar LyX
24684 commands, and retrieve
24685 information about the \SpecialChar LyX
24687 This is only intended for advanced users, but they should find it useful.
24688 It is by writing to the \SpecialChar LyX
24689 server, for example, that bibliography managers,
24690 such as JabRef, are able to
24691 \begin_inset Quotes eld
24695 \begin_inset Quotes erd
24698 citations to \SpecialChar LyX
24702 \begin_layout Section
24703 Starting the \SpecialChar LyX
24705 \begin_inset CommandInset label
24707 name "sec:Starting-the-Server"
24714 \begin_layout Standard
24715 The \SpecialChar LyX
24716 server works through the use of a pair of named pipes.
24717 These are usually located in
24718 \begin_inset Flex Code
24721 \begin_layout Plain Layout
24727 , (except on Windows, where
24731 named pipes are special objects located in
24732 \begin_inset Flex Code
24735 \begin_layout Plain Layout
24747 ) and have the names
24748 \begin_inset Quotes eld
24752 \begin_inset Flex Code
24755 \begin_layout Plain Layout
24762 \begin_inset Quotes erd
24766 \begin_inset Quotes eld
24770 \begin_inset Flex Code
24773 \begin_layout Plain Layout
24780 \begin_inset Quotes erd
24784 External programs write into
24785 \begin_inset Flex Code
24788 \begin_layout Plain Layout
24794 and read back data from
24795 \begin_inset Flex Code
24798 \begin_layout Plain Layout
24805 The stem of the pipe names can be defined in the
24806 \begin_inset Flex Noun
24809 \begin_layout Plain Layout
24810 Tools\SpecialChar menuseparator
24816 dialog, for example
24817 \begin_inset Flex Code
24820 \begin_layout Plain Layout
24821 "/home/myhome/lyxpipe"
24827 \begin_inset Flex Code
24830 \begin_layout Plain Layout
24844 on Windows (where any working path instead of lyxpipe can be used, for
24846 \begin_inset Flex Code
24849 \begin_layout Plain Layout
24872 configure this manually in order for the server to start.
24875 \begin_layout Standard
24878 \begin_inset Flex Code
24881 \begin_layout Plain Layout
24888 \begin_inset Flex Code
24891 \begin_layout Plain Layout
24897 ' to create the pipes.
24898 If one of the pipes already exists, \SpecialChar LyX
24899 will assume that another \SpecialChar LyX
24901 is already running and will not start the server.
24902 On POSIX (Unix like) systems, if for some other reason, an unused
24903 \begin_inset Quotes eld
24907 \begin_inset Quotes erd
24910 pipe is left in existence when \SpecialChar LyX
24911 closes, then \SpecialChar LyX
24912 will try to delete it.
24913 If this fails for some reason, you will need to delete the pipes manually
24914 and then restart \SpecialChar LyX
24916 On Windows, pipes are deleted by the OS on program termination or crash,
24918 \begin_inset Quotes eld
24922 \begin_inset Quotes erd
24925 pipes should not be possible.
24928 \begin_layout Standard
24929 To have several \SpecialChar LyX
24930 processes with servers at the same time, you have to use
24931 different configurations, perhaps by using separate user directories, each
24933 \begin_inset Flex Code
24936 \begin_layout Plain Layout
24942 file, for each process.
24945 \begin_layout Standard
24946 If you are developing a client program, you might find it useful to enable
24947 debugging information from the \SpecialChar LyX
24949 Do this by starting \SpecialChar LyX
24951 \begin_inset Flex Code
24954 \begin_layout Plain Layout
24963 \begin_layout Standard
24964 You can find a complete example client written in C++ in the source distribution
24966 \begin_inset Flex Code
24969 \begin_layout Plain Layout
24970 development/lyxserver/server_monitor.cpp
24978 \begin_layout Standard
24979 Another useful tool is the command-line based client found in
24980 \begin_inset Flex Code
24983 \begin_layout Plain Layout
24984 src/client/lyxclient
24992 \begin_layout Section
24993 Normal communication
24996 \begin_layout Standard
24997 To issue a \SpecialChar LyX
24998 call, the client writes a line of ASCII text into the input
25000 This line has the following format:
25003 \begin_layout Quote
25017 \begin_layout Description
25018 clientname is a name that the client can choose arbitrarily.
25019 Its only use is that \SpecialChar LyX
25020 will echo it if it sends an answer—so a client can
25021 dispatch results from different requesters.
25024 \begin_layout Description
25025 function is the function you want \SpecialChar LyX
25027 It is the same as the commands you'd use in the minibuffer.
25030 \begin_layout Description
25031 argument is an optional argument which is meaningful only to some functions
25033 \begin_inset Quotes eld
25037 \begin_inset Quotes erd
25040 LFUN will insert the argument as text at the cursor position).
25043 \begin_layout Standard
25044 The answer from \SpecialChar LyX
25045 will arrive in the output pipe and be of the form
25048 \begin_layout Quote
25062 \begin_layout Standard
25071 are just echoed from the command request, while
25075 is more or less useful information filled according to how the command
25076 execution worked out.
25077 Some commands, such as
25078 \begin_inset Quotes eld
25082 \begin_inset Quotes erd
25085 , will return information about the internal state of \SpecialChar LyX
25087 return an empty data-response.
25088 This means that the command execution went fine.
25091 \begin_layout Standard
25092 In case of errors, the response from \SpecialChar LyX
25093 will have this form
25096 \begin_layout Quote
25110 \begin_layout Standard
25115 should contain an explanation of why the command failed.
25118 \begin_layout Standard
25122 \begin_layout LyX-Code
25123 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
25124 \begin_inset Newline newline
25127 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
25128 \begin_inset Newline newline
25131 read a <~/.lyxpipe.out
25132 \begin_inset Newline newline
25138 \begin_layout Subsection
25139 AppleScript (Mac OS X)
25142 \begin_layout Standard
25143 Since \SpecialChar LyX
25144 2.1, \SpecialChar LyX
25145 supports basic interactions with AppleScript for normal communicatio
25146 n through the command run.
25147 This command takes a direct argument (the
25151 to perform) and an optional argument.
25152 It either returns the output of the function or triggers an error with
25153 the error message and code.
25156 \begin_layout Standard
25160 \begin_layout LyX-Code
25161 tell application "\SpecialChar LyX
25165 \begin_layout LyX-Code
25169 \begin_layout LyX-Code
25170 -- Stores the current file name into f
25173 \begin_layout LyX-Code
25174 set f to (run "server-get-filename" with argument "")
25177 \begin_layout LyX-Code
25178 on error the error_message number the error_number
25181 \begin_layout LyX-Code
25182 display dialog "Error: " & the error_number & ".
25186 \begin_layout LyX-Code
25187 & the error_message buttons {"OK"} default button 1
25190 \begin_layout LyX-Code
25194 \begin_layout LyX-Code
25198 \begin_layout Section
25202 \begin_layout Standard
25204 can notify clients of events going on asynchronously.
25205 Currently it will only do this if the user binds a key sequence with the
25207 \begin_inset Quotes eld
25211 \begin_inset Quotes erd
25215 The format of the string \SpecialChar LyX
25216 sends is as follows:
25219 \begin_layout Quote
25220 \begin_inset Flex Code
25223 \begin_layout Plain Layout
25234 \begin_layout Standard
25239 is the printed representation of the key sequence that was actually typed
25243 \begin_layout Standard
25244 This mechanism can be used to extend \SpecialChar LyX
25245 's command set and implement macros.
25246 Bind some key sequence to
25247 \begin_inset Quotes eld
25251 \begin_inset Quotes erd
25255 Then start a client that listens on the output pipe, dispatches the command
25256 according to the sequence, and starts a function that may use \SpecialChar LyX
25259 requests to issue a command or a series of commands to \SpecialChar LyX
25263 \begin_layout Section
25264 The simple \SpecialChar LyX
25268 \begin_layout Standard
25270 implements a simple protocol that can be used for session management.
25271 All messages are of the form
25274 \begin_layout Quote
25284 \begin_layout Standard
25290 \begin_inset Quotes eld
25294 \begin_inset Quotes erd
25298 \begin_inset Quotes eld
25302 \begin_inset Quotes erd
25307 \begin_inset Quotes eld
25311 \begin_inset Quotes erd
25314 is received from a client, \SpecialChar LyX
25315 will report back to inform the client that
25316 it's listening to it's messages, while
25317 \begin_inset Quotes eld
25321 \begin_inset Quotes erd
25324 sent from \SpecialChar LyX
25325 will inform clients that \SpecialChar LyX
25329 \begin_layout Section
25330 Reverse DVI/PDF search
25333 \begin_layout Standard
25334 Some DVI/PDF viewers
25338 \begin_layout Plain Layout
25339 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
25340 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
25349 facility (also called
25354 This means that you can tell \SpecialChar LyX
25355 to put the cursor to a specific line in the
25356 document by clicking at the respective position in the DVI/PDF output.
25357 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
25359 This is done via the \SpecialChar LyX
25360 server either by using the named pipe (
25364 ), or the UNIX domain socket (
25368 ) that \SpecialChar LyX
25369 creates in its temporary directory (this is the way the
25370 \begin_inset Flex Code
25373 \begin_layout Plain Layout
25379 program communicates with \SpecialChar LyX
25381 In some cases, you need a helper script that mediates between the viewer
25382 and \SpecialChar LyX
25383 , in others, the viewer can communicate with \SpecialChar LyX
25385 This depends on the selected viewer and on your operating system.
25386 The same applies to the way viewers need to be configured and the way the
25387 reverse search is actually performed.
25388 In what follows, we will thus describe how to setup reverse search for
25390 Before we turn to this, though, we will explain what needs to be done generally
25391 to enable reverse search in the DVI/PDF output.
25394 \begin_layout Subsection
25396 \begin_inset CommandInset label
25398 name "subsec:rev-search"
25405 \begin_layout Standard
25406 In most cases \SpecialChar LyX
25407 will do the work for you by pressing the following button
25411 arg "buffer-toggle-output-sync"
25415 Alternatively, you can also enable the feature by checking
25417 Synchronize with Output
25420 \begin_inset Flex Noun
25423 \begin_layout Plain Layout
25424 Document\SpecialChar menuseparator
25425 Settings\SpecialChar menuseparator
25432 In such a case \SpecialChar LyX
25433 will automatically insert the necessary Sync\SpecialChar TeX
25435 PDF) or load the srcltx package (for DVI) respectively.
25436 This option can be easily reached also on
25437 \begin_inset Flex Code
25440 \begin_layout Plain Layout
25449 \begin_layout Standard
25450 If you need a different setting, you can select or input a custom macro
25451 from the drop down box just below
25452 \begin_inset Flex Noun
25455 \begin_layout Plain Layout
25456 Document\SpecialChar menuseparator
25457 Settings\SpecialChar menuseparator
25458 Output\SpecialChar menuseparator
25459 Synchronize with Output
25467 \begin_layout Standard
25468 Note that the method
25469 \begin_inset Flex Code
25472 \begin_layout Plain Layout
25480 enables gzip compression.
25481 If your viewer does not support it, you should instead use
25482 \begin_inset Flex Code
25485 \begin_layout Plain Layout
25496 \begin_layout Standard
25497 Please also note that including the
25498 \begin_inset Flex Code
25501 \begin_layout Plain Layout
25508 \begin_inset Flex Code
25511 \begin_layout Plain Layout
25517 sometimes has an undesired impact on the typesetting.
25518 Thus, you should switch output synchronization off for the final typesetting
25520 \begin_inset Flex Code
25523 \begin_layout Plain Layout
25530 \begin_inset Flex Code
25533 \begin_layout Plain Layout
25543 \begin_layout Standard
25544 In case you need some more special settings that are not covered by the
25545 automatic settings, read the next section about how to set up output synchroniz
25547 If the automatic setup suits your needs, you can readily jump to section
25548 \begin_inset space ~
25552 \begin_inset CommandInset ref
25554 reference "subsec:configuring-viewers"
25558 , where the necessary configuration steps in your viewer – needed both with
25559 the automatic and the manual setup – are described.
25562 \begin_layout Subsection
25566 \begin_layout Standard
25568 provides several different methods for reverse search.
25569 Some are built-in in the
25570 \begin_inset Flex Code
25573 \begin_layout Plain Layout
25579 program, some are provided by external packages.
25580 Your choice depends on whether your \SpecialChar LaTeX
25581 distribution already provides a given
25582 method (the built-in methods are rather new) and whether your viewer can
25584 The available methods are described in the following.
25587 \begin_layout Subsubsection*
25588 Built-in DVI-search via src-specials (DVI only)
25591 \begin_layout Standard
25592 This method provides the DVI file with the necessary information for reverse
25594 It is available in \SpecialChar LaTeX
25595 since quite some time (any somewhat recent \SpecialChar LaTeX
25597 should include it), and it works reliably.
25598 To enable it, change the
25599 \begin_inset Flex Noun
25602 \begin_layout Plain Layout
25613 \begin_inset Flex Noun
25616 \begin_layout Plain Layout
25627 \begin_inset Flex Noun
25630 \begin_layout Plain Layout
25631 Preferences\SpecialChar menuseparator
25632 File Handling\SpecialChar menuseparator
25639 \begin_inset Flex Code
25642 \begin_layout Plain Layout
25643 latex -src-specials $$i
25649 If this doesn't work, check if your \SpecialChar TeX
25650 engine needs different options (the
25651 syntax might differ in some distributions).
25654 \begin_layout Subsubsection*
25655 External Packages (PDFSync and scrltx)
25658 \begin_layout Standard
25667 provide reverse search facility for PDF output (via pdflatex) and DVI output,
25669 In order to enable it, load the packages in the \SpecialChar LyX
25673 \begin_layout Itemize
25674 \begin_inset Flex Code
25677 \begin_layout Plain Layout
25680 usepackage{pdfsync}
25685 for reverse PDF search,
25688 \begin_layout Itemize
25689 \begin_inset Flex Code
25692 \begin_layout Plain Layout
25695 usepackage[active]{srcltx}
25700 for reverse DVI search.
25703 \begin_layout Standard
25704 If you want to be able to perform both DVI and PDF reverse searches, you
25705 can also insert in the preamble the following lines
25708 \begin_layout LyX-Code
25712 \begin_inset Newline newline
25718 \begin_inset Newline newline
25723 usepackage{pdfsync}
25724 \begin_inset Newline newline
25730 \begin_inset Newline newline
25735 usepackage[active]{srcltx}
25736 \begin_inset Newline newline
25744 \begin_layout Standard
25745 This way, you can preview the file as either DVI or PDF (pdflatex) and the
25746 right package will be used.
25749 \begin_layout Standard
25750 Note that PDFSync might affect the output layout of your document.
25751 It is therefore advised to disable PDFsync for final documents.
25754 \begin_layout Subsubsection*
25755 Built-in reverse search via Sync\SpecialChar TeX
25759 \begin_layout Standard
25761 \begin_inset Flex Code
25764 \begin_layout Plain Layout
25770 have built-in support for both PDF and DVI reverse search.
25773 Sync\SpecialChar TeX
25776 facility is basically the result of the integration of the PDFSync package
25777 to the pdftex program and its merge with the
25782 You need at least \SpecialChar TeX
25783 Live 2008 or a recent Mik\SpecialChar TeX
25784 distribution in order to use
25789 \begin_layout Plain Layout
25790 For some reason, Mik\SpecialChar TeX
25791 does not understand/obey the command \SpecialChar LyX
25793 the preamble when you check the "Enable Forward/Reverse Search" button
25794 in the toolbar and does not generate the necessary info.
25797 \begin_layout Plain Layout
25798 The generation of the required info can be forced by changing the converter
25799 "\SpecialChar LaTeX
25800 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
25801 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
25802 the -synctex=1 switch).
25807 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
25808 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
25809 already provide Sync\SpecialChar TeX
25813 \begin_layout Standard
25814 To enable Sync\SpecialChar TeX
25815 for DVI output, change the
25816 \begin_inset Flex Noun
25819 \begin_layout Plain Layout
25830 \begin_inset Flex Noun
25833 \begin_layout Plain Layout
25838 (plain) -> DraftDVI
25844 \begin_inset Flex Noun
25847 \begin_layout Plain Layout
25848 Preferences\SpecialChar menuseparator
25849 File Handling\SpecialChar menuseparator
25856 \begin_inset Flex Code
25859 \begin_layout Plain Layout
25860 latex -synctex=1 $$i
25865 , and for PDF output, change the
25866 \begin_inset Flex Noun
25869 \begin_layout Plain Layout
25874 (pdflatex) -> PDF (pdflatex)
25880 \begin_inset Flex Code
25883 \begin_layout Plain Layout
25884 pdflatex -synctex=1 $$i
25890 Should your viewer not be considered in the following description, or in
25891 case of missing success, please check the documentation of your viewer
25892 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
25897 \begin_layout Plain Layout
25898 Note that the option
25899 \begin_inset Flex Code
25902 \begin_layout Plain Layout
25908 option enables gzip compression.
25909 If your viewer does not support it, you should instead use
25910 \begin_inset Flex Code
25913 \begin_layout Plain Layout
25927 \begin_layout Subsection
25928 Configuring and using specific viewers
25929 \begin_inset CommandInset label
25931 name "subsec:configuring-viewers"
25938 \begin_layout Subsubsection*
25939 Xdvi (all platforms)
25942 \begin_layout Standard
25944 \begin_inset Flex Code
25947 \begin_layout Plain Layout
25953 , you don't need to do anything else for performing a reverse DVI search,
25954 as \SpecialChar LyX
25955 already provides the necessary hooks for automatically using the
25956 \begin_inset Flex Code
25959 \begin_layout Plain Layout
25966 Just setup your document as described above (reverse search is triggered
25967 by Ctrl-click or Alt-click on Mac OSX, respectively).
25970 \begin_layout Standard
25971 However, if for whatever reason you want to use the named pipe instead of
25972 the socket for communicating with \SpecialChar LyX
25973 , simply change the DVI viewer in
25974 \begin_inset Flex Noun
25977 \begin_layout Plain Layout
25978 Preferences\SpecialChar menuseparator
25979 File Handling\SpecialChar menuseparator
25989 \begin_layout Plain Layout
25990 On Mac OSX you have to use
25991 \begin_inset Flex Code
25994 \begin_layout Plain Layout
25995 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
26006 \begin_inset Flex Code
26009 \begin_layout Plain Layout
26010 xdvi -editor "lyxeditor.sh %f %l"
26016 \begin_inset Flex Code
26019 \begin_layout Plain Layout
26025 is a suitable script.
26026 For example, a minimal shell script is the following one:
26029 \begin_layout LyX-Code
26031 \begin_inset Newline newline
26034 LYXPIPE="/path/to/lyxpipe"
26035 \begin_inset Newline newline
26038 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
26039 \begin_inset Newline newline
26042 echo "$COMMAND" > "${LYXPIPE}".in || exit
26043 \begin_inset Newline newline
26046 read TMP < "${LYXPIPE}".out || exit
26049 \begin_layout Standard
26051 \begin_inset Flex Code
26054 \begin_layout Plain Layout
26060 is the LyXServer pipe path specified in
26061 \begin_inset Flex Noun
26064 \begin_layout Plain Layout
26065 Preferences\SpecialChar menuseparator
26075 \begin_layout Plain Layout
26077 \begin_inset Flex Code
26080 \begin_layout Plain Layout
26086 folder of a source distribution you can find a
26087 \begin_inset Flex Code
26090 \begin_layout Plain Layout
26096 script which is able to locate the
26100 based on your preferences.
26108 \begin_layout Subsubsection*
26112 \begin_layout Standard
26114 \begin_inset Flex Code
26117 \begin_layout Plain Layout
26118 /Applications/MacDviX_Folder/calleditor.script
26123 , add the following lines:
26126 \begin_layout LyX-Code
26127 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
26128 \begin_inset Newline newline
26134 \begin_layout Standard
26135 Modify the lines accordingly if you install \SpecialChar LyX
26136 somewhere else than in the
26137 Applications folder.
26140 \begin_layout Standard
26141 Reverse search is triggered by Alt-click (OPTION-click).
26144 \begin_layout Subsubsection*
26148 \begin_layout Standard
26150 \begin_inset Flex Code
26153 \begin_layout Plain Layout
26154 open -a Skim.app $$i
26159 to the viewer setting in
26160 \begin_inset Flex Noun
26163 \begin_layout Plain Layout
26164 Preferences\SpecialChar menuseparator
26165 File Handling\SpecialChar menuseparator
26166 File formats\SpecialChar menuseparator
26173 \begin_inset Flex Noun
26176 \begin_layout Plain Layout
26177 Skim\SpecialChar menuseparator
26178 Preferences\SpecialChar menuseparator
26185 \begin_inset Flex Noun
26188 \begin_layout Plain Layout
26194 preset and enter command
26195 \begin_inset Flex Noun
26198 \begin_layout Plain Layout
26199 /Applications/\SpecialChar LyX
26200 .app/Contents/MacOS/lyxeditor
26208 \begin_layout Standard
26209 Reverse search is triggered by COMMAND-SHIFT-click
26212 \begin_layout Subsubsection*
26216 \begin_layout Standard
26217 Reverse search with evince does not work out of the box, but it can be achieved
26218 by means of some third party helper scripts.
26220 \begin_inset CommandInset href
26222 target "https://wiki.lyx.org/LyX/SyncTeX"
26230 \begin_layout Subsubsection*
26234 \begin_layout Standard
26236 \begin_inset Flex Noun
26239 \begin_layout Plain Layout
26240 Settings\SpecialChar menuseparator
26241 Configure Okular\SpecialChar menuseparator
26248 \begin_inset Quotes erd
26252 This inserts the appropriate command (
26253 \begin_inset Flex Code
26256 \begin_layout Plain Layout
26265 \begin_layout Standard
26266 Reverse search is triggered by SHIFT-click.
26268 \change_inserted -712698321 1578211026
26269 Note that this only works if Okular is in
26270 \begin_inset Quotes eld
26274 \begin_inset Quotes erd
26278 \begin_inset space \thinspace{}
26281 e., the hand symbol is clicked).
26286 \begin_layout Subsubsection*
26290 \begin_layout Standard
26291 Qpdfview supports Sync\SpecialChar TeX
26292 since version 0.3.5.
26294 \begin_inset Flex Noun
26297 \begin_layout Plain Layout
26298 Edit\SpecialChar menuseparator
26299 Settings\SpecialChar menuseparator
26305 , click on the input field of the
26306 \begin_inset Quotes eld
26310 \begin_inset Quotes erd
26313 item and add the command
26314 \begin_inset Flex Code
26317 \begin_layout Plain Layout
26326 \begin_layout Standard
26327 Reverse search is triggered by double-click or, in more recent versions,
26331 \begin_layout Subsubsection*
26335 \begin_layout Standard
26336 Launch yap, choose its
26337 \begin_inset Flex Noun
26340 \begin_layout Plain Layout
26341 View\SpecialChar menuseparator
26347 menu and select the
26348 \begin_inset Quotes eld
26352 \begin_inset Quotes erd
26357 \begin_inset Quotes eld
26360 New\SpecialChar ldots
26362 \begin_inset Quotes erd
26365 button and, in the window that opens, enter
26366 \begin_inset Quotes eld
26371 \begin_inset Quotes erd
26374 (or any other name you like) in the
26375 \begin_inset Quotes eld
26379 \begin_inset Quotes erd
26383 Now click on the button labeled
26384 \begin_inset Quotes eld
26389 \begin_inset Quotes erd
26392 to open a file dialog and navigate to the directory containing the batch
26394 \begin_inset Flex Code
26397 \begin_layout Plain Layout
26405 \begin_inset Flex Code
26408 \begin_layout Plain Layout
26414 and then specify the program arguments as
26415 \begin_inset Flex Code
26418 \begin_layout Plain Layout
26426 \begin_inset Flex Code
26429 \begin_layout Plain Layout
26435 wrapper is used for communicating with \SpecialChar LyX
26443 \begin_layout LyX-Code
26445 \begin_inset Newline newline
26448 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
26457 \begin_inset Newline newline
26471 \begin_layout Standard
26472 Make sure that the \SpecialChar LyX
26473 Server pipe path you specified in \SpecialChar LyX
26475 \begin_inset Flex Code
26478 \begin_layout Plain Layout
26492 , otherwise change the
26493 \begin_inset Flex Code
26496 \begin_layout Plain Layout
26502 wrapper accordingly.
26505 \begin_layout Standard
26506 In yap, reverse search is triggered by double-click.
26509 \begin_layout Subsubsection*
26510 SumatraPDF (Windows)
26513 \begin_layout Standard
26514 In order to use SumatraPDF for inverse search, enter
26515 \begin_inset Flex Code
26518 \begin_layout Plain Layout
26519 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
26524 in the viewer setting in
26525 \begin_inset Flex Noun
26528 \begin_layout Plain Layout
26529 Preferences\SpecialChar menuseparator
26530 File Handling\SpecialChar menuseparator
26531 File formats\SpecialChar menuseparator
26538 \begin_inset Flex Code
26541 \begin_layout Plain Layout
26547 is the previous wrapper.
26548 If SumatraPDF.exe is not in your command PATH, use its full file name.
26551 \begin_layout Standard
26552 Reverse search is triggered by double-click.
26555 \begin_layout Subsubsection*
26559 \begin_layout Standard
26560 First of all, make sure that yap is your default DVI viewer in the Windows
26561 environment, then launch it, choose its
26562 \begin_inset Flex Noun
26565 \begin_layout Plain Layout
26566 View\SpecialChar menuseparator
26572 menu and select the
26573 \begin_inset Quotes eld
26577 \begin_inset Quotes erd
26582 \begin_inset Quotes eld
26585 New\SpecialChar ldots
26587 \begin_inset Quotes erd
26590 button and, in the window that opens, enter
26591 \begin_inset Quotes eld
26596 \begin_inset Quotes erd
26599 (or any other name you like) in the
26600 \begin_inset Quotes eld
26604 \begin_inset Quotes erd
26608 Now click on the button labeled
26609 \begin_inset Quotes eld
26614 \begin_inset Quotes erd
26617 to open a file dialog and navigate to the directory containing the
26618 \begin_inset Flex Code
26621 \begin_layout Plain Layout
26627 program (which is installed by default on Cygwin along with the \SpecialChar LyX
26630 \begin_inset Flex Code
26633 \begin_layout Plain Layout
26639 and then specify the program arguments as
26640 \begin_inset Flex Code
26643 \begin_layout Plain Layout
26650 In this way, you will be using the
26654 for communicating with \SpecialChar LyX
26656 If, for whatever reason, you want to use the
26661 \begin_inset Flex Code
26664 \begin_layout Plain Layout
26670 option and be sure to specify the \SpecialChar LyX
26671 Server pipe path in the \SpecialChar LyX
26675 \begin_layout Standard
26676 In yap, reverse search is triggered by double-click.
26679 \begin_layout Subsubsection*
26680 SumatraPDF (Cygwin)
26683 \begin_layout Standard
26684 In order to use SumatraPDF for inverse search, enter
26685 \begin_inset Flex Code
26688 \begin_layout Plain Layout
26689 SumatraPDF -inverse-search "lyxeditor -g %f %l"
26694 in the viewer setting in
26695 \begin_inset Flex Noun
26698 \begin_layout Plain Layout
26699 Preferences\SpecialChar menuseparator
26700 File Handling\SpecialChar menuseparator
26701 File formats\SpecialChar menuseparator
26708 If SumatraPDF.exe is not in your command PATH, use its full posix path.
26710 \begin_inset Flex Code
26713 \begin_layout Plain Layout
26719 enables communication via the
26725 \begin_inset Flex Code
26728 \begin_layout Plain Layout
26734 option if you want to use the
26738 , and be sure to specify the \SpecialChar LyX
26739 Server pipe path in the \SpecialChar LyX
26743 \begin_layout Standard
26744 Reverse search is triggered by double-click.
26747 \begin_layout Section
26751 \begin_layout Standard
26752 Forward search is, as the name implies, in a sense the
26753 \begin_inset Quotes eld
26757 \begin_inset Quotes erd
26761 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
26763 If forward search is set up (as described in what follows), you can put
26764 the cursor anywhere in your \SpecialChar LyX
26766 \begin_inset Flex Noun
26769 \begin_layout Plain Layout
26770 Navigate\SpecialChar menuseparator
26777 \begin_inset Flex Noun
26780 \begin_layout Plain Layout
26786 in the context menu via right mouse click), and then the viewer will jump
26787 to that position as well.
26788 This implies, of course, that your viewer supports this function.
26791 \begin_layout Standard
26792 To make forward search possible, you first need to provide the generated
26793 output PDF/DVI file with additional information about the \SpecialChar TeX
26795 This can be done via the methods described in the section
26796 \begin_inset CommandInset ref
26798 reference "subsec:rev-search"
26805 \begin_layout Standard
26806 Additionally, you need to configure \SpecialChar LyX
26807 for using your viewers in
26808 \begin_inset Flex Noun
26811 \begin_layout Plain Layout
26812 Tools\SpecialChar menuseparator
26813 Preferences\SpecialChar menuseparator
26814 Output\SpecialChar menuseparator
26821 We provide a range of tested configurations for some viewers, which you
26822 can select from the drop down list.
26823 If none of these configurations suits you, you have to find out and enter
26824 a suitable configuration yourself.
26825 The definition syntax uses the following placeholders:
26828 \begin_layout Itemize
26830 \begin_inset Flex Code
26833 \begin_layout Plain Layout
26842 \begin_layout Itemize
26844 \begin_inset Flex Code
26847 \begin_layout Plain Layout
26853 : name of the (temporary) exported .tex file (without path)
26856 \begin_layout Itemize
26858 \begin_inset Flex Code
26861 \begin_layout Plain Layout
26867 : name of the (temporary) exported .tex file (including path)
26870 \begin_layout Itemize
26872 \begin_inset Flex Code
26875 \begin_layout Plain Layout
26881 : name of the exported output file (either dvi or pdf, depending on which
26882 one exists in the temporary directory)
26885 \begin_layout Standard
26886 Note that only some of the viewers provide full and usable forward search
26887 functionality out of the box, among them yap, xdvi, okular
26891 \begin_layout Plain Layout
26892 You might want to set
26893 \begin_inset Flex Code
26896 \begin_layout Plain Layout
26903 \begin_inset Flex Noun
26906 \begin_layout Plain Layout
26907 Tools\SpecialChar menuseparator
26908 Preferences\SpecialChar menuseparator
26909 File Handling\SpecialChar menuseparator
26911 \begin_inset space ~
26924 , qpdfview, and SumatraPDF
26928 \begin_layout Plain Layout
26929 SumatraPDF can also use DDE commands through the external program CMCDDE
26930 — downloadable from
26931 \begin_inset CommandInset href
26933 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
26944 Others, such as evince
26948 \begin_layout Plain Layout
26949 Forward search with evince can be achieved by means of third party helper
26952 \begin_inset CommandInset href
26954 target "https://wiki.lyx.org/LyX/SyncTeX"
26964 , require some extra tools in order to use forward search.
26965 While many of the widespread PDF viewers (most notably Adobe Reader) do
26966 not support forward search at all, some other viewers – e.
26967 \begin_inset space \thinspace{}
26971 xpdf – allow at least to reload the document and jump to a specific page
26972 of the file, so you can at least navigate
26973 \begin_inset Quotes eld
26977 \begin_inset Quotes erd
26981 This latter functionality is provided by an external call of synctex (see
26982 the predefined example configurations).
26986 \begin_layout Standard
26987 Forward search works both with DVI and PDF output.
26989 simply checks which preview format you have used before (i.
26990 \begin_inset space \thinspace{}
26993 e., which format is already there in the temporary directory) and chooses
26994 the appropriate configuration for the respective format.
26997 \begin_layout Chapter
26999 \change_deleted 564990737 1671097409
27000 Special Document Classes
27005 \begin_layout Section
27007 \change_deleted 564990737 1669742044
27011 \begin_layout Standard
27013 \change_deleted 564990737 1669742044
27019 \begin_layout Subsection
27021 \change_deleted 564990737 1669742044
27025 \begin_layout Standard
27027 \change_deleted 564990737 1669742044
27028 This section describes how \SpecialChar LyX
27029 can be used to write articles for submission
27030 to the scientific journal
27032 Astronomy and Astrophysics
27035 \begin_inset Flex URL
27038 \begin_layout Plain Layout
27040 https://www.aanda.org/
27045 ) using Version 5.01 of the document class
27050 This package can be downloaded from the ftp site
27053 \begin_layout Standard
27055 \change_deleted 564990737 1669742044
27056 \begin_inset VSpace medskip
27062 \begin_layout Standard
27065 \change_deleted 564990737 1669742044
27066 \begin_inset Flex URL
27069 \begin_layout Plain Layout
27071 ftp://ftp.edpsciences.org/pub/aa/readme.html
27079 \begin_layout Standard
27081 \change_deleted 564990737 1669742044
27082 \begin_inset VSpace medskip
27088 \begin_layout Standard
27090 \change_deleted 564990737 1669742044
27091 A manual comes together with that package, and this text is not meant to
27092 replace the original manual but is merely a short guide in how to realize
27093 the correct form of your paper.
27097 \begin_layout Standard
27099 \change_deleted 564990737 1669742044
27100 Please note that the publisher of the journal was changed from Springer
27101 to EDP Sciences starting January 1, 2001.
27102 That change involved also some slight changes to the style files, namely
27103 the removal of the thesaurus command.
27104 The \SpecialChar LyX
27105 class aa supports the newest version of these style files, V 5.01.
27106 If you have an older version installed, please upgrade.
27107 For compatibility, the old (version 4) layout has been kept as
27112 Please refer to the comments in
27115 Dir/layouts/aapaper.layout
27120 \begin_layout Subsection
27122 \change_deleted 564990737 1669742044
27126 \begin_layout Standard
27128 \change_deleted 564990737 1669742044
27129 It is recommended you start from the example template distributed with \SpecialChar LyX
27131 If you are not using a template, note the following settings:
27134 \begin_layout Itemize
27136 \change_deleted 564990737 1669742044
27143 Document\SpecialChar menuseparator
27146 dialog (OK, that one was obvious).
27149 \begin_layout Itemize
27151 \change_deleted 564990737 1669742044
27152 Don't change the option
27155 \begin_inset space ~
27165 The whole layout is done by the macros, you shouldn't change anything.
27168 \begin_layout Subsection
27170 \change_deleted 564990737 1669742044
27174 \begin_layout Standard
27176 \change_deleted 564990737 1669742044
27177 First thing to enter is the header information.
27178 It consists of seven entries, of which some are optional.
27182 \begin_layout Itemize
27184 \change_deleted 564990737 1669742044
27192 \begin_layout Itemize
27194 \change_deleted 564990737 1669742044
27202 \begin_layout Itemize
27204 \change_deleted 564990737 1669742044
27212 \begin_layout Itemize
27214 \change_deleted 564990737 1669742044
27222 \begin_layout Itemize
27224 \change_deleted 564990737 1669742044
27229 : [optional] if more than one author: whom to contact for offprint requests.
27232 \begin_layout Itemize
27234 \change_deleted 564990737 1669742044
27239 : [optional] mail address for contacts.
27242 \begin_layout Itemize
27244 \change_deleted 564990737 1669742044
27250 Suggested format is
27252 Received: <date>; Accepted <date>
27255 \begin_layout Standard
27257 \change_deleted 564990737 1669742044
27258 There is no need to issue the
27264 command, this is done automatically by \SpecialChar LyX
27265 when the header is finished.
27266 Although the order of the single header entries doesn't matter it is advised
27267 to keep the above sequence, just to get the best optics and meets the layout
27268 of the real document.
27271 \begin_layout Standard
27273 \change_deleted 564990737 1669742044
27274 If you want to place footnotes in the header block, e.
27275 \begin_inset space \thinspace{}
27279 \begin_inset space \space{}
27282 to state your present address, just use the standard footnote via the menu
27285 Insert\SpecialChar menuseparator
27290 will automagically use the term
27299 \begin_layout Standard
27301 \change_deleted 564990737 1669742044
27304 Edit\SpecialChar menuseparator
27307 , you'll find two insets which are relevant for the titling:
27310 \begin_layout Itemize
27312 \change_deleted 564990737 1669742044
27319 to mark corresponding author\SpecialChar breakableslash
27321 The institutes are numbered sequentially as they appear in the
27325 field, so you have to put a marker to each author.
27328 \begin_layout Itemize
27330 \change_deleted 564990737 1669742044
27335 to supply an email address for fast contact.
27338 \begin_layout Standard
27340 \change_deleted 564990737 1669742044
27341 In addition to these topics, the macros use one additional \SpecialChar LaTeX
27343 has no counterpart in \SpecialChar LyX
27347 \begin_layout Itemize
27349 \change_deleted 564990737 1669742044
27356 to separate different names for more than one author and institute, respectivel
27360 \begin_layout Standard
27362 \change_deleted 564990737 1669742044
27363 The appropriate command has to be entered in \SpecialChar LyX
27364 and marked as \SpecialChar LaTeX
27370 \begin_layout Subsection
27372 \change_deleted 564990737 1669742044
27376 \begin_layout Standard
27378 \change_deleted 564990737 1669742044
27379 The abstract should immediately follow the header block.
27380 With version 5 the abstract environment was changed to a command, and there
27381 is now a restriction to only one paragraph.
27382 In addition, it should contain an entry with the keywords.
27383 This is done via the paragraph style
27388 Refer to the example paper.
27391 \begin_layout Subsection
27393 \change_deleted 564990737 1669742044
27394 Supported environments
27397 \begin_layout Standard
27399 \change_deleted 564990737 1669742044
27400 The A&A paper layout supports the following environments for structuring
27404 \begin_layout Itemize
27406 \change_deleted 564990737 1669742044
27412 \begin_layout Itemize
27414 \change_deleted 564990737 1669742044
27420 \begin_layout Itemize
27422 \change_deleted 564990737 1669742044
27428 \begin_layout Itemize
27430 \change_deleted 564990737 1669742044
27436 \begin_layout Itemize
27438 \change_deleted 564990737 1669742044
27444 \begin_layout Itemize
27446 \change_deleted 564990737 1669742044
27452 \begin_layout Itemize
27454 \change_deleted 564990737 1669742044
27460 \begin_layout Itemize
27462 \change_deleted 564990737 1669742044
27468 \begin_layout Itemize
27470 \change_deleted 564990737 1669742044
27476 \begin_layout Itemize
27478 \change_deleted 564990737 1669742044
27484 \begin_layout Itemize
27486 \change_deleted 564990737 1669742044
27492 \begin_layout Itemize
27494 \change_deleted 564990737 1669742044
27501 \begin_layout Subsection
27503 \change_deleted 564990737 1669742044
27504 Commands not supported by \SpecialChar LyX
27508 \begin_layout Standard
27510 \change_deleted 564990737 1669742044
27511 Some commands are not yet supported by the
27515 layout for \SpecialChar LyX
27517 Some have already been mentioned.
27518 For the sake of completeness, they are listed all together here:
27521 \begin_layout Itemize
27523 \change_deleted 564990737 1669742044
27531 \begin_layout Itemize
27533 \change_deleted 564990737 1669742044
27541 \begin_layout Itemize
27543 \change_deleted 564990737 1669742044
27551 \begin_layout Itemize
27553 \change_deleted 564990737 1669742044
27561 \begin_layout Standard
27563 \change_deleted 564990737 1669742044
27564 If you want to use any of these commands, you have to enter them yourself.
27567 Do not forget to mark them as \SpecialChar LaTeX
27571 \begin_layout Subsection
27573 \change_deleted 564990737 1669742044
27574 Figure and Table Floats
27577 \begin_layout Standard
27579 \change_deleted 564990737 1669742044
27581 provides support for the necessary float environments
27583 figure, figure*, table
27589 , therefore we won't tell much about it here.
27593 \begin_inset space ~
27599 Just remember that tables should be left-aligned.
27600 For that, select the table and change the alignment in
27602 Edit\SpecialChar menuseparator
27604 \begin_inset space ~
27610 \begin_layout Standard
27612 \change_deleted 564990737 1669742044
27613 There is only one special thing: the figures with caption besides the figure.
27614 To create such a figure, you have to do the following:
27617 \begin_layout Enumerate
27619 \change_deleted 564990737 1669742044
27620 Create a wide figure float:
27622 Insert\SpecialChar menuseparator
27623 Float\SpecialChar menuseparator
27626 , then right click in the figure and select
27629 \begin_inset space ~
27637 \begin_layout Enumerate
27639 \change_deleted 564990737 1669742044
27640 Enter your caption text.
27643 \begin_layout Enumerate
27645 \change_deleted 564990737 1669742044
27650 to move the cursor above the caption.
27653 \begin_layout Enumerate
27655 \change_deleted 564990737 1669742044
27659 \begin_layout Enumerate
27661 \change_deleted 564990737 1669742044
27662 Position the cursor behind the figure and insert a horizontal fill:
27664 Insert\SpecialChar menuseparator
27666 \begin_inset space ~
27669 Character\SpecialChar menuseparator
27671 \begin_inset space ~
27679 \begin_layout Enumerate
27681 \change_deleted 564990737 1669742044
27682 Switch to \SpecialChar LaTeX
27686 \begin_inset space ~
27694 \begin_layout Enumerate
27696 \change_deleted 564990737 1669742044
27706 Do not close the brace!
27709 \begin_layout Enumerate
27711 \change_deleted 564990737 1669742044
27712 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
27717 \begin_inset space ~
27729 \begin_layout Standard
27731 \change_deleted 564990737 1669742044
27732 Also, refer to the figures in the example paper.
27735 \begin_layout Subsection
27737 \change_deleted 564990737 1669742044
27741 \begin_layout Standard
27743 \change_deleted 564990737 1669742044
27744 For submission, the paper has to be formated in a special double-spacing
27746 For this purpose, you have to give the option
27750 to the document class.
27751 This must be done using the custom class options field in the
27753 Document\SpecialChar menuseparator
27757 Just enter the string
27764 \begin_layout Subsection
27766 \change_deleted 564990737 1669742044
27770 \begin_layout Standard
27772 \change_deleted 564990737 1669742044
27777 directory contains an example paper written with \SpecialChar LyX
27779 It is the example paper from the original macro package, translated to
27782 Use it for inspiration, and compare the original \SpecialChar LaTeX
27783 code with \SpecialChar LyX
27787 \begin_layout Section
27789 \change_deleted 564990737 1671097429
27793 \begin_layout Standard
27795 \change_deleted 564990737 1671097429
27800 can be used to type letters according to German conventions.
27801 A template file is included in
27803 .../lyx/share/templates
27805 for you to use as a starting point.
27808 \begin_layout Section
27810 \change_deleted 564990737 1671097429
27814 \begin_layout Standard
27816 \change_deleted 564990737 1671097429
27817 See the \SpecialChar LyX
27823 It contains all infos you need.
27826 \begin_layout Section
27828 \change_deleted 564990737 1669755802
27832 \begin_layout Standard
27834 \change_deleted 564990737 1669755802
27837 Panayotis Papasotiriou
27840 \begin_layout Subsection
27842 \change_deleted 564990737 1669755802
27846 \begin_layout Standard
27848 \change_deleted 564990737 1669755802
27849 The ijmpc package is a set of macros that facilitates electronic manuscript
27852 International Journal of Modern Physics C
27855 Similarly, the ijmpd package is for creating manuscripts to be submitted
27858 International Journal of Modern Physics D
27861 Both journals are published by World Scientific.
27862 The corresponding document classes are named
27871 These files, together with instructions for the authors, can be downloaded
27873 \begin_inset Flex URL
27876 \begin_layout Plain Layout
27878 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
27884 \begin_inset Flex URL
27887 \begin_layout Plain Layout
27889 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
27895 Both packages are modified versions of the standard
27896 \begin_inset Quotes eld
27900 \begin_inset Quotes erd
27903 package, and they are almost (but not exactly) identical.
27904 Most of their features are supported by \SpecialChar LyX
27906 I have used \SpecialChar LyX
27907 successfully to write articles submitted to both journals
27908 without any problem.
27911 \begin_layout Subsection
27913 \change_deleted 564990737 1669755802
27917 \begin_layout Standard
27919 \change_deleted 564990737 1669755802
27920 As usual, the easiest way to write a paper is to start with a template.
27923 File\SpecialChar menuseparator
27939 This will give an (almost) empty document that includes the most common
27940 fields found in a manuscript.
27941 Simply overwrite the existing text (including the brackets,
27946 You should keep in mind the following remarks.
27949 \begin_layout Enumerate
27951 \change_deleted 564990737 1669755802
27953 won't let you change the font size and the page style of the document,
27954 because such modifications are not allowed by both packages.
27957 \begin_layout Enumerate
27959 \change_deleted 564990737 1669755802
27960 The language of the document should not be changed.
27961 Before previewing your paper, be sure that the babel package is not used.
27962 To do this, click on
27965 arg "dialog-show document"
27970 \SpecialChar menuseparator
27974 \begin_inset Quotes eld
27978 \begin_inset Quotes erd
27988 \begin_layout Enumerate
27990 \change_deleted 564990737 1669755802
27992 \begin_inset Quotes eld
27996 \begin_inset Quotes erd
27999 style must be used to define keywords.
28002 \begin_layout Enumerate
28004 \change_deleted 564990737 1669755802
28005 The ijmpc package provides a style named
28006 \begin_inset Quotes eld
28009 Classification Codes
28010 \begin_inset Quotes erd
28013 , which can be used to define classification codes, such as PACS numbers.
28014 Note that this facility is not supported by the ijmpd package.
28017 \begin_layout Enumerate
28019 \change_deleted 564990737 1669755802
28020 Several new environments are available:
28021 \begin_inset Quotes eld
28025 \begin_inset Quotes erd
28029 \begin_inset Quotes eld
28033 \begin_inset Quotes erd
28037 \begin_inset Quotes eld
28041 \begin_inset Quotes erd
28045 \begin_inset Quotes eld
28049 \begin_inset Quotes erd
28053 \begin_inset Quotes eld
28057 \begin_inset Quotes erd
28061 \begin_inset Quotes eld
28065 \begin_inset Quotes erd
28069 \begin_inset Quotes eld
28073 \begin_inset Quotes erd
28077 \begin_inset Quotes eld
28081 \begin_inset Quotes erd
28085 \begin_inset Quotes eld
28089 \begin_inset Quotes erd
28093 \begin_inset Quotes eld
28097 \begin_inset Quotes erd
28101 \begin_inset Quotes eld
28105 \begin_inset Quotes erd
28109 \begin_inset Quotes eld
28113 \begin_inset Quotes erd
28117 \begin_inset Quotes eld
28121 \begin_inset Quotes erd
28125 \begin_inset Quotes eld
28129 \begin_inset Quotes erd
28133 Their use is more or less obvious.
28135 supports all these environments; it will use the proper label, text style,
28136 and numbering scheme for each of them.
28139 \begin_layout Enumerate
28141 \change_deleted 564990737 1669755802
28142 Both packages use basic citations; the natbib package should not be used.
28143 In \SpecialChar LyX
28144 , citation references are shown as usual; in the output, citations are
28145 shown as superscripts.
28146 If you want to use a citation as normal text, you should use the
28151 \begin_inset space \thinspace{}
28155 \begin_inset space \space{}
28159 \begin_inset Quotes eld
28163 \begin_inset space \space{}
28173 \begin_inset Quotes erd
28179 \begin_layout Enumerate
28181 \change_deleted 564990737 1669755802
28183 \begin_inset Quotes eld
28187 \begin_inset Quotes erd
28190 section in both packages.
28191 To put acknowledgments, just use the
28192 \begin_inset Quotes eld
28196 \begin_inset Quotes erd
28202 \begin_layout Enumerate
28204 \change_deleted 564990737 1669755802
28205 Appendices may be added to the paper,
28209 the Acknowledgments and
28215 provides a special environment, called
28216 \begin_inset Quotes eld
28220 \begin_inset Quotes erd
28223 which marks the beginning of the appendices.
28224 This environment should be left blank; it just sends a \SpecialChar LaTeX
28225 command, but nothing
28227 In \SpecialChar LyX
28229 \begin_inset Quotes eld
28233 \begin_inset Quotes erd
28236 is printed with blue letters, as a signal that all sections after that
28237 point are appendices.
28238 To write an appendix, use the
28239 \begin_inset Quotes eld
28243 \begin_inset Quotes erd
28248 will number each appendix with capital letters, as required by both journals.
28250 \begin_inset Quotes eld
28254 \begin_inset Quotes erd
28261 be present before the first appendix; if not, all appendices will be numbered
28262 as normal sections in the output.
28265 \begin_layout Enumerate
28267 \change_deleted 564990737 1669755802
28268 The ijmpc and the ijmpd packages use the
28272 command to implement table captions.
28273 As a result, a table created by \SpecialChar LyX
28274 is printed correctly, but its caption
28276 However, you can use some \SpecialChar TeX
28277 code to overcome this problem, so that captions
28278 are printed as expected.
28279 To do so, create a float table as usual, remove the caption, and replace
28280 it with the \SpecialChar TeX
28291 (sic); you must also the \SpecialChar TeX
28296 immediately after the tabular material.
28297 Study the example table included in the template files to see how this
28298 trick is implemented.
28299 Alternatively, If you need table captions, you should implement the whole
28304 file, then include this file to the \SpecialChar LyX
28307 Insert\SpecialChar menuseparator
28308 File\SpecialChar menuseparator
28310 \begin_inset space ~
28316 Details on how to create a table float can be found in the files
28324 , included in the corresponding packages.
28327 \begin_layout Subsection
28329 \change_deleted 564990737 1669755802
28330 Preparing a paper for submission
28333 \begin_layout Standard
28335 \change_deleted 564990737 1669755802
28336 Before you submit your paper you must export the \SpecialChar LyX
28337 document as a \SpecialChar LaTeX
28340 File\SpecialChar menuseparator
28341 Export\SpecialChar menuseparator
28349 \begin_layout Plain Layout
28350 Actually you have the choice between \SpecialChar LaTeX
28351 (plain) and pdflatex.
28352 If you intend to use pdflatex to prepare the paper, you should use the
28353 pdflatex option so that included graphics are converted to PDF format,
28354 ready for use by pdflatex.
28359 , then make the following changes to the resulting
28366 \begin_layout Enumerate
28368 \change_deleted 564990737 1669755802
28369 Remove the comment lines before the
28378 \begin_layout Enumerate
28380 \change_deleted 564990737 1669755802
28381 Remove everything between (and including) the
28393 commands, except for any commands you specifically put into the \SpecialChar LaTeX
28397 \begin_layout Standard
28399 \change_deleted 564990737 1669755802
28404 file should be saved and processed through \SpecialChar LaTeX
28405 as many times as necessary.
28406 You may also want to check the resulting
28415 \begin_layout Section
28417 \change_deleted 564990737 1669801478
28421 \begin_layout Standard
28423 \change_deleted 564990737 1669801478
28429 \begin_layout Subsection
28431 \change_deleted 564990737 1669801478
28435 \begin_layout Standard
28437 \change_deleted 564990737 1669801478
28438 The iopart package provides a document class to create electronic manuscript
28439 submission to the journals published by the Institute of Physics.
28440 Instructions for the authors how to create a paper using the iopart class
28441 can be downloaded together with the iopart package from the site
28442 \begin_inset Flex URL
28445 \begin_layout Plain Layout
28447 ftp://ftp.iop.org/pub/journals/latex2e
28455 \begin_layout Subsection
28457 \change_deleted 564990737 1669801478
28461 \begin_layout Standard
28463 \change_deleted 564990737 1669801478
28464 The easiest way to write a paper is to start with the template
28468 that is available via
28470 File\SpecialChar menuseparator
28473 The template explains how to use the special text environments.
28474 Here are the most important advices:
28477 \begin_layout Itemize
28479 \change_deleted 564990737 1669801478
28480 To be able to compile your document to a PDF, PS, or DVI, ensure that the
28481 no AMS packages are loaded in
28483 Document\SpecialChar menuseparator
28484 Settings\SpecialChar menuseparator
28490 \begin_layout Itemize
28492 \change_deleted 564990737 1669801478
28495 The title environment defines the kind of your paper.
28496 So use one of the following environments for the title:
28500 \begin_layout Itemize
28502 \change_deleted 564990737 1669801478
28511 \begin_layout Itemize
28513 \change_deleted 564990737 1669801478
28522 \begin_layout Itemize
28524 \change_deleted 564990737 1669801478
28530 for a Topical review
28533 \begin_layout Itemize
28535 \change_deleted 564990737 1669801478
28544 \begin_layout Itemize
28546 \change_deleted 564990737 1669801478
28555 \begin_layout Itemize
28557 \change_deleted 564990737 1669801478
28563 for a Paper (same as Title)
28566 \begin_layout Itemize
28568 \change_deleted 564990737 1669801478
28574 for a Preliminary communication
28577 \begin_layout Itemize
28579 \change_deleted 564990737 1669801478
28585 for a Rapid communication
28588 \begin_layout Itemize
28590 \change_deleted 564990737 1669801478
28596 for a Letter to the editor
28600 \begin_layout Itemize
28602 \change_deleted 564990737 1669801478
28605 All title environments except of
28609 can have an optional short title.
28612 \begin_layout Itemize
28614 \change_deleted 564990737 1669801478
28615 There is a general title environment
28619 which is not directly supported by \SpecialChar LyX
28621 This can be used as \SpecialChar TeX
28622 code when your document doesn't fit into one of the
28626 \begin_layout Standard
28628 \change_deleted 564990737 1669801478
28629 For more informations like hints for special table and formula formatting,
28630 look at the IOP author guidelines.
28635 \begin_layout Section
28637 \change_deleted 564990737 1670317155
28641 \begin_layout Standard
28643 \change_deleted 564990737 1670317155
28646 Panayotis Papasotiriou
28649 \begin_layout Subsection
28651 \change_deleted 564990737 1670317155
28655 \begin_layout Standard
28657 \change_deleted 564990737 1670317155
28658 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
28659 that facilitates electronic manuscript submission to the journals they
28661 Most known of them (at least in my domain of interest) are
28663 Astrophysics and Space Science
28669 , but there are many others (see a complete list at
28670 \begin_inset Flex URL
28673 \begin_layout Plain Layout
28675 http://www.wkap.nl/jrnllist.htm/JRNLHOME
28681 The Kluwer package may be downloaded from the site
28682 \begin_inset Flex URL
28685 \begin_layout Plain Layout
28687 http://www.wkap.nl/kaphtml.htm/STYLEFILES
28693 A complete user guide is contained in that package (but it can also be
28694 downloaded separately).
28697 \begin_layout Standard
28699 \change_deleted 564990737 1670317155
28701 supports many features of the package but not everything.
28702 However, the \SpecialChar TeX
28703 code needed is reduced to some
28704 \begin_inset Quotes eld
28708 \begin_inset Quotes erd
28711 commands of the package (see
28712 \begin_inset space ~
28716 \begin_inset CommandInset ref
28718 reference "subsec:kluwer_peculiarities"
28723 I have recently used \SpecialChar LyX
28724 to write an article submitted to the
28726 Astrophysics and Space Science
28728 without any problem.
28731 \begin_layout Subsection
28733 \change_deleted 564990737 1670317155
28737 \begin_layout Standard
28739 \change_deleted 564990737 1670317155
28740 The easiest way to write a paper is to start with the Kluwer template file.
28743 File\SpecialChar menuseparator
28755 This will give an (almost) empty document that includes the most common
28756 fields found in a manuscript and a short description of their use.
28757 As in most templates, simply overwrite the existing text (including the
28762 ) with the correct information.
28765 \begin_layout Subsection
28767 \change_deleted 564990737 1670317155
28768 Preparing a paper for submission
28771 \begin_layout Standard
28773 \change_deleted 564990737 1670317155
28774 As in the AAS\SpecialChar TeX
28775 package, before you submit your paper to a journal you must
28777 \begin_inset Quotes eld
28781 \begin_inset Quotes erd
28787 \begin_layout Enumerate
28789 \change_deleted 564990737 1670317155
28790 Export your paper as a \SpecialChar LaTeX
28792 To do this, click on
28794 File\SpecialChar menuseparator
28795 Export\SpecialChar menuseparator
28803 \begin_layout Enumerate
28805 \change_deleted 564990737 1670317155
28810 file with a text editor and make the following changes
28814 \begin_layout Enumerate
28816 \change_deleted 564990737 1670317155
28817 remove the comment lines before the
28826 \begin_layout Enumerate
28828 \change_deleted 564990737 1670317155
28829 remove everything between (and including) the
28841 commands, except for any commands you specifically put into the \SpecialChar LaTeX
28845 \begin_layout Standard
28847 \change_deleted 564990737 1670317155
28856 \begin_layout Enumerate
28858 \change_deleted 564990737 1670317155
28863 file through \SpecialChar LaTeX
28864 as many times as necessary (usually up to three).
28867 \begin_layout Enumerate
28869 \change_deleted 564990737 1670317155
28875 \begin_inset space \thinspace{}
28879 \begin_inset space \space{}
28886 , and check if everything is OK (it should, if you didn't make any mistake).
28889 \begin_layout Subsection
28891 \change_deleted 564990737 1670317155
28892 \begin_inset Quotes eld
28896 \begin_inset Quotes erd
28899 of the Kluwer package
28900 \begin_inset CommandInset label
28902 name "subsec:kluwer_peculiarities"
28909 \begin_layout Standard
28911 \change_deleted 564990737 1670317155
28912 The Kluwer package has the following
28913 \begin_inset Quotes eld
28917 \begin_inset Quotes erd
28923 \begin_layout Enumerate
28925 \change_deleted 564990737 1670317155
28926 It is possible to write multiple articles in the same \SpecialChar LaTeX
28931 \begin_layout Plain Layout
28932 I can't imagine any good reason to do this.
28938 Each article must be included in the environment
28939 \begin_inset Quotes eld
28943 \begin_inset Quotes erd
28947 Unfortunately, this environment cannot be omitted, even if you write just
28949 Therefore, each article starts with the command
28955 and, obviously, ends with the command
28962 Although this can be implemented in \SpecialChar LyX
28963 , I didn't included it, since it looks
28964 ugly and can confuse the novice user.
28965 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
28968 \begin_inset Quotes eld
28973 \begin_inset Quotes erd
28979 \begin_layout Enumerate
28981 \change_deleted 564990737 1670317155
28982 Information given at the beginning of the article (i.
28983 \begin_inset space \thinspace{}
28987 \begin_inset space \space{}
28990 title, subtitle, author, institution, running title, running author, abstract
28991 and keywords) must be included in an environment called
28992 \begin_inset Quotes eld
28996 \begin_inset Quotes erd
29000 This is not implemented in \SpecialChar LyX
29001 , so you must enter title, subtitle etc.
29002 \begin_inset space ~
29005 between two \SpecialChar TeX
29021 \begin_layout Enumerate
29023 \change_deleted 564990737 1670317155
29024 According to the user manual, the label of each bibliography item must be
29048 \begin_layout Standard
29050 \change_deleted 564990737 1670317155
29055 template takes care of all these
29056 \begin_inset Quotes eld
29060 \begin_inset Quotes erd
29064 If you start a new paper using this template you don't need to do anything
29069 \begin_layout Enumerate
29071 \change_deleted 564990737 1670317155
29072 don't delete the \SpecialChar TeX
29073 code included in the template, and
29076 \begin_layout Enumerate
29078 \change_deleted 564990737 1670317155
29079 copy the example bibliography item included in the template and modify it
29080 as necessary to enter new bibliography items.
29083 \begin_layout Section
29085 \change_deleted 564990737 1671097446
29089 \begin_layout Standard
29091 \change_deleted 564990737 1671097446
29096 provides an alternative to the standard
29101 It provides similar functionality, but you might prefer this layout with
29102 sans serif sections, headings, and more.
29105 \begin_layout Section
29107 \change_deleted 564990737 1671097446
29108 Springer Journals (
29115 \begin_layout Standard
29117 \change_deleted 564990737 1671097446
29123 \begin_layout Subsection
29125 \change_deleted 564990737 1671097446
29129 \begin_layout Standard
29131 \change_deleted 564990737 1671097446
29132 These are the layout files for some of the journal formats used by Springer
29133 Verlag and listed on
29134 \begin_inset Flex URL
29137 \begin_layout Plain Layout
29139 http://www.springer.de/author/tex/help-journals.html
29144 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
29146 It is a modular system: the things common to all journals are implemented
29151 , which journal-specific layout files (such as, e.
29152 \begin_inset space \thinspace{}
29156 \begin_inset space \space{}
29163 for Journal of Geodesy) can include.
29166 \begin_layout Standard
29168 \change_deleted 564990737 1671097446
29169 This means that implementing support for any other Springer journal on this
29170 list is as simple as writing your own
29178 file following the outline given in
29186 \begin_layout Standard
29188 \change_deleted 564990737 1671097446
29189 It is reasonably well tested only for the Journal of Geodesy.
29198 come with the standard \SpecialChar LyX
29200 Install the relevant class file (downloaded from Springer) in a proper
29201 directory, reconfigure \SpecialChar LaTeX
29202 (in the te\SpecialChar TeX
29207 , as root if necessary — doesn't \SpecialChar LyX
29208 take care of this?), reconfigure \SpecialChar LyX
29213 \begin_layout Subsection
29215 \change_deleted 564990737 1671097446
29219 \begin_layout Standard
29221 \change_deleted 564990737 1671097446
29222 A large number of theorem-like styles —
29234 \begin_layout Standard
29236 \change_deleted 564990737 1671097446
29239 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
29240 _Title, Author_Running, Institute,
29241 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
29244 See the Springer class file documentation for details.
29247 \begin_layout Subsection
29249 \change_deleted 564990737 1671097446
29253 \begin_layout Itemize
29255 \change_deleted 564990737 1671097446
29267 \begin_layout Itemize
29269 \change_deleted 564990737 1671097446
29272 Probability Theory and Related Fields
29278 — Jean-Marc Lasgouttes
29281 \begin_layout Standard
29283 \change_deleted 564990737 1671097446
29284 Add your own, it isn't so hard!
29287 \begin_layout Subsection
29289 \change_deleted 564990737 1671097446
29293 \begin_layout Standard
29295 \change_deleted 564990737 1671097446
29296 These files are partly based on the older
29300 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
29302 file from Springer.
29307 layout, are now defunct.
29308 Jean-Marc Lasgouttes helped out big in making me find my way around the
29310 layout file mechanism.
29313 \begin_layout Subsection
29315 \change_deleted 564990737 1671097446
29319 \begin_layout Standard
29321 \change_deleted 564990737 1671097446
29323 But probably less than in the old hacked-\SpecialChar LaTeX
29331 \begin_layout Chapter
29333 Features needing Extra Software
29336 \begin_layout Section
29337 Checking \SpecialChar TeX
29341 \begin_layout Standard
29347 \begin_layout Subsection
29351 \begin_layout Standard
29360 \begin_layout Plain Layout
29365 is not yet available when you are using the \SpecialChar LaTeX
29366 distribution MiK\SpecialChar TeX
29372 , you'll find in the
29379 \begin_inset space ~
29390 \begin_inset Newline newline
29394 \begin_inset CommandInset href
29396 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
29404 \begin_layout Standard
29407 Chk\SpecialChar TeX
29410 package is a program that was written by
29411 \begin_inset Flex Noun
29414 \begin_layout Plain Layout
29416 \begin_inset space ~
29424 in frustration because some constructs in \SpecialChar LaTeX
29425 are sometimes non-intuitive,
29426 and easy to forget.
29427 The program runs over your \SpecialChar LaTeX
29428 file, checks the integrity of the file, and
29429 flags some common errors.
29430 In other technical words, it is
29434 for \SpecialChar LaTeX
29438 \begin_layout Standard
29439 Well, what is a syntax checker doing in \SpecialChar LyX
29440 which is supposed to produce correct
29442 anyways? The answer is simple: Just as
29446 not only checks the
29450 of C programs, but also does
29454 checks for type-errors,
29456 Chk\SpecialChar TeX
29459 catches some common
29463 errors, in addition to the syntactical ones.
29466 Chk\SpecialChar TeX
29469 is capable of detecting several common errors, such as
29472 \begin_layout Itemize
29473 Ellipsis detection:
29474 \begin_inset Newline newline
29477 Use \SpecialChar ldots
29481 \begin_layout Itemize
29482 No space in front of/after parenthesis:
29483 \begin_inset Newline newline
29489 \begin_layout Itemize
29490 Enforcement of normal space after common abbreviations:
29491 \begin_inset Newline newline
29495 \begin_inset space \thinspace{}
29499 \begin_inset space \space{}
29502 is too wide spacing.
29505 \begin_layout Itemize
29506 Enforcement of end-of-sentence space when the last sentence ends with a
29508 \begin_inset Newline newline
29512 And this is wrong spacing.
29515 \begin_layout Itemize
29516 Space in front of labels and similar commands:
29517 \begin_inset Newline newline
29520 The label should stick right up to the text to avoid falling to a wrong
29523 \begin_inset CommandInset label
29533 \begin_layout Plain Layout
29534 This footnote is in danger of falling off to a wrong page
29539 The label is separated too much.
29542 \begin_layout Itemize
29543 Space in front of references, instead of hard spaces:
29544 \begin_inset Newline newline
29547 If you have bad luck, the text will break right between the referenced text
29548 and reference number, and that's a pity.
29550 \begin_inset CommandInset ref
29552 reference "sec:chktex"
29559 \begin_layout Itemize
29561 \begin_inset Quotes eld
29565 \begin_inset Quotes erd
29569 \begin_inset Formula $\times$
29573 \begin_inset Newline newline
29576 2x2 looks cheap compared to
29577 \begin_inset Formula $2\times2$
29583 \begin_layout Standard
29584 and more \SpecialChar ldots
29585 It is an invaluable tool when you are
29586 \begin_inset Quotes eld
29590 \begin_inset Quotes erd
29593 your document before printing, and you should run it right after the obligatory
29594 spelling check, and before you go fine tuning the typesetting.
29597 \begin_layout Subsection
29601 \begin_layout Standard
29602 If you have the program installed, usage is as simple as choosing
29604 Tools\SpecialChar menuseparator
29606 \begin_inset space ~
29612 This will make \SpecialChar LyX
29613 generate a \SpecialChar LaTeX
29614 file of your document, start
29616 Chk\SpecialChar TeX
29619 to check it, and then make \SpecialChar LyX
29621 \begin_inset Quotes eld
29625 \begin_inset Quotes erd
29628 with the warnings from
29630 Chk\SpecialChar TeX
29633 , if there were any.
29634 The warnings will be placed close to the point of the mistake, and you
29635 can quickly find them by using the
29637 Navigate\SpecialChar menuseparator
29640 menu item, or the shortcut key
29649 Open the error boxes by clicking on them with the mouse, or use the shortcut
29658 bindings, or the corresponding
29667 Read the warning and correct the mistake, if it is a mistake.
29668 If you have trouble understanding what the warning is about, you can safely
29670 Remember that there is a hidden layer between the document on screen and
29671 the technical details in invoking
29673 Chk\SpecialChar TeX
29676 , and this gap can make some warnings seem arcane or just plain silly.
29679 \begin_layout Standard
29680 This document is an excellent testing bed for the feature, and it should
29681 provide quite a few warnings for you to fiddle with.
29682 Since computers are only so smart, expect most of the warnings to be false
29686 \begin_layout Subsection
29687 How to fine tune it
29690 \begin_layout Standard
29691 Sometimes, you'll find that
29693 Chk\SpecialChar TeX
29696 makes more noise than suits your mood.
29697 Then you can choose not to use it, wait until your mood changes, or try
29700 Chk\SpecialChar TeX
29703 to get better along with you.
29706 \begin_layout Standard
29709 Chk\SpecialChar TeX
29716 very configurable and extensible, you should not expect to solve all problems
29719 Chk\SpecialChar TeX
29722 in \SpecialChar LyX
29724 Since \SpecialChar LyX
29725 has to generate a somewhat special \SpecialChar LaTeX
29726 file to be able to match the
29727 line numbers from the
29729 Chk\SpecialChar TeX
29736 \begin_layout Plain Layout
29737 You can inspect the specific output from
29743 Document\SpecialChar menuseparator
29746 \begin_inset space ~
29760 to the internal document structure, some of the warnings will not appear
29762 There are two things you can do about this:
29765 \begin_layout Itemize
29768 Chk\SpecialChar TeX
29771 invocation command line in
29772 \begin_inset Flex Noun
29775 \begin_layout Plain Layout
29776 Tools\SpecialChar menuseparator
29777 Preferences\SpecialChar menuseparator
29778 Output\SpecialChar menuseparator
29779 LaTeX\SpecialChar menuseparator
29787 Chk\SpecialChar TeX
29790 installation configuration file (usually with the file
29795 See below to learn what warnings can be enabled and disabled on the command
29799 \begin_layout Itemize
29800 Export your document as a raw \SpecialChar LaTeX
29803 File\SpecialChar menuseparator
29804 Export\SpecialChar menuseparator
29813 Invoked in this way, it can be a hassle to find the corresponding place
29814 in the document inside \SpecialChar LyX
29815 , but with a little patience, you should be able
29819 \begin_layout Standard
29820 Here follows the warning messages that can be enabled and disabled in
29829 to disable a warning, and
29833 to enable a warning.
29834 The emphasized entries are disabled by default, because the default is
29837 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
29842 \begin_layout Standard
29843 Notice that you should only use the options that enable and disable warnings,
29844 because \SpecialChar LyX
29845 relies on some of the other command line parameters to be set
29846 in a specific way to have a chance to communicate with
29853 \begin_layout Enumerate
29857 Command terminated with space.
29860 \begin_layout Enumerate
29863 Non-breaking space (
29864 \begin_inset Quotes eld
29872 \begin_inset Quotes erd
29875 ) should have been used.
29878 \begin_layout Enumerate
29882 You should enclose the previous parenthesis with
29883 \begin_inset Quotes eld
29891 \begin_inset Quotes erd
29897 \begin_layout Enumerate
29900 Italic correction (
29901 \begin_inset Quotes eld
29911 \begin_inset Quotes erd
29914 ) found in non-italic buffer.
29917 \begin_layout Enumerate
29920 Italic correction (
29921 \begin_inset Quotes eld
29931 \begin_inset Quotes erd
29934 ) found more than once.
29937 \begin_layout Enumerate
29941 No italic correction (
29942 \begin_inset Quotes eld
29952 \begin_inset Quotes erd
29958 \begin_layout Enumerate
29962 \begin_inset Quotes eld
29970 \begin_inset Quotes erd
29974 \begin_inset Quotes eld
29982 \begin_inset Quotes erd
29988 \begin_layout Enumerate
29991 Wrong length of dash may have been used.
29994 \begin_layout Enumerate
29998 \begin_inset Quotes eld
30006 \begin_inset Quotes erd
30010 \begin_inset Quotes eld
30018 \begin_inset Quotes erd
30024 \begin_layout Enumerate
30028 \begin_inset Quotes eld
30036 \begin_inset Quotes erd
30042 \begin_layout Enumerate
30046 \begin_inset Quotes eld
30054 \begin_inset Quotes erd
30057 to achieve an ellipsis.
30060 \begin_layout Enumerate
30063 Inter-word spacing (
30064 \begin_inset Quotes eld
30074 \begin_inset Quotes eld
30077 ) should perhaps be used.
30080 \begin_layout Enumerate
30083 Inter-sentence spacing (
30084 \begin_inset Quotes eld
30094 \begin_inset Quotes erd
30097 ) should perhaps be used.
30100 \begin_layout Enumerate
30103 Could not find argument for command.
30106 \begin_layout Enumerate
30110 \begin_inset Quotes eld
30118 \begin_inset Quotes erd
30124 \begin_layout Enumerate
30127 Math mode still on at end of \SpecialChar LaTeX
30131 \begin_layout Enumerate
30135 \begin_inset Quotes eld
30143 \begin_inset Quotes erd
30146 doesn't match the number of
30147 \begin_inset Quotes eld
30155 \begin_inset Quotes erd
30161 \begin_layout Enumerate
30164 You should use either
30167 \begin_inset Quotes eld
30175 \begin_inset Quotes erd
30180 as an alternative to
30181 \begin_inset Quotes eld
30189 \begin_inset Quotes erd
30195 \begin_layout Enumerate
30202 " (ASCII 39) instead of "
30209 \begin_layout Enumerate
30212 User-specified pattern found.
30215 \begin_layout Enumerate
30218 This command might not be intended.
30221 \begin_layout Enumerate
30228 \begin_layout Enumerate
30246 \begin_layout Enumerate
30249 Delete this space to maintain correct page references.
30252 \begin_layout Enumerate
30256 You might wish to put this between a pair of
30257 \begin_inset Quotes eld
30265 \begin_inset Quotes erd
30271 \begin_layout Enumerate
30274 You ought to remove spaces in front of punctuation.
30277 \begin_layout Enumerate
30280 Could not execute \SpecialChar LaTeX
30284 \begin_layout Enumerate
30293 in front of small punctuation.
30296 \begin_layout Enumerate
30304 may look prettier here.
30307 \begin_layout Enumerate
30311 Multiple spaces detected in output.
30314 \begin_layout Enumerate
30317 This text may be ignored.
30320 \begin_layout Enumerate
30326 \begin_inset Quotes eld
30331 to begin quotation, not
30338 \begin_layout Enumerate
30345 to end quotation, not
30348 \begin_inset Quotes eld
30356 \begin_layout Enumerate
30362 \begin_layout Enumerate
30365 You should perhaps use
30366 \begin_inset Quotes eld
30374 \begin_inset Quotes erd
30380 \begin_layout Enumerate
30383 You should put a space in front of/after parenthesis.
30386 \begin_layout Enumerate
30389 You should avoid spaces in front of/after parenthesis.
30392 \begin_layout Enumerate
30396 You should not use punctuation in front of/after quotes.
30399 \begin_layout Enumerate
30402 Double space found.
30405 \begin_layout Enumerate
30408 You should put punctuation outside inner/inside display math mode.
30411 \begin_layout Enumerate
30414 You ought to not use primitive \SpecialChar TeX
30415 in \SpecialChar LaTeX
30419 \begin_layout Enumerate
30422 You should remove spaces in front of
30423 \begin_inset Quotes eld
30431 \begin_inset Quotes erd
30437 \begin_layout Enumerate
30440 \begin_inset Quotes eld
30448 \begin_inset Quotes erd
30451 is normally not followed by
30452 \begin_inset Quotes eld
30460 \begin_inset Quotes erd
30466 \begin_layout Standard
30467 In later versions of \SpecialChar LyX
30468 , we hope to provide a more complete interface to this
30469 tool (and it's smaller cousin
30473 ) to exploit the full power of it.
30474 But it's not exactly useless as it is now: go try it on one of your existing
30475 documents of a certain length and be surprised.
30478 \begin_layout Section
30479 Version Control in \SpecialChar LyX
30483 \begin_layout Standard
30486 Lars Gullik Bjønnes
30493 \begin_layout Subsection
30497 \begin_layout Standard
30499 supports some of the most basic RCS/CVS/SVN/GIT commands.
30500 If you need something a bit more sophisticated you will have to do that
30501 manually in a terminal.
30504 \begin_layout Standard
30505 Also note that CVS support is not as good as subversion support, so we advise
30507 A good place to start learning Subversion is the SVN Book
30511 \begin_layout Plain Layout
30512 \begin_inset CommandInset href
30514 target "http://svnbook.red-bean.com/"
30525 In the case of RCS you should read
30526 \begin_inset Quotes eld
30530 \begin_inset Quotes erd
30533 (a man file, read it with
30538 This file describes all the basic features of RCS.
30539 You should especially notice the comment about a RCS directory, and the
30540 notion of a master RCS file (the file ending in
30547 \begin_layout Standard
30548 Before you begin to use the version control features in \SpecialChar LyX
30550 familiar with RCS/CVS/SVN/GIT usage.
30551 The implementation in \SpecialChar LyX
30552 assumes a recent version of the GNU RCS or CVS/SVN
30553 package — no guarantees are made for older versions.
30554 Most of the log messages are not currently displayed after operations —
30555 you can check them in the Messages pane if you are unsure.
30556 Regular users of version control will appreciate the VC toolbar, which
30559 View\SpecialChar menuseparator
30560 Toolbars\SpecialChar menuseparator
30562 \begin_inset space ~
30570 \begin_layout Standard
30571 For introducing your own external commands consult
30572 \begin_inset Flex Code
30575 \begin_layout Plain Layout
30589 \begin_layout Standard
30590 It is strongly recommended to store documents in uncompressed format if
30591 using version control (uncheck
30593 Document\SpecialChar menuseparator
30596 if it is checked): Uncompressed LyX documents are text files and therefore
30597 for merging two different versions by version control systems.
30598 Compressed LyX documents are binary files, which cannot be merged by version
30602 \begin_layout Subsection
30603 RCS commands in \SpecialChar LyX
30607 \begin_layout Standard
30608 The following sections describe the RCS commands supported by \SpecialChar LyX
30610 You can find them in the
30612 File\SpecialChar menuseparator
30614 \begin_inset space ~
30621 was tested against RCS 5.7/5.8.
30624 \begin_layout Subsubsection
30630 \begin_layout Standard
30631 If your document is not under revision control, this is the only item shown
30633 And if it is under revision control, the
30637 item is not visible.
30641 \begin_layout Standard
30642 This command registers your document with RCS (unless you are under the
30643 directory managed by CVS)\SpecialChar endofsentence
30644 You are asked interactively to supply an initial
30645 description of the document.
30646 The document is now set in Read-Only mode and you have to
30649 \begin_inset space ~
30653 \begin_inset space ~
30657 \begin_inset space ~
30662 , before making any changes to it.
30663 A document under revision control has a
30664 \begin_inset Quotes eld
30667 [RCS:<version> <locker>]
30668 \begin_inset Quotes erd
30671 item tagged to the filename in the minibuffer.
30674 \begin_layout Standard
30675 RCS command that is run:
30678 \begin_layout LyX-Code
30681 ci -q -u -i -t-"<initial description>" <file-name>
30684 \begin_layout Standard
30689 to understand the switches.
30693 \begin_layout Subsubsection
30699 \begin_layout Standard
30700 When you are finished editing a file, you check in your changes.
30701 When you do this, you are asked for a description of the changes.
30702 This is stored in the history log.
30703 The version number is bumped, your changes are applied to the master RCS
30704 file, the document is unlocked and set to Read-Only mode.
30707 \begin_layout Itemize
30710 ci -q -u -m"<description>" <file-name>
30713 \begin_layout Subsubsection
30719 \begin_layout Standard
30720 By doing this you lock the document so that only you can edit it.
30721 This will also make the document Read-Write only for you.
30722 You will usually continue editing for a while and when you are finished
30723 you check in your changes.
30724 The status line is changed to reflect that you have locked the file.
30727 \begin_layout Itemize
30730 co -q -l <file-name>
30733 \begin_layout Subsubsection
30736 Revert To Repository Version
30739 \begin_layout Standard
30740 This will discard all changes made to the document since the last check
30742 You get a warning before changes are discarded.
30745 \begin_layout Itemize
30748 co -f -u<version> <file-name>
30751 \begin_layout Subsubsection
30757 \begin_layout Standard
30758 This will create a copy of the current document.
30759 Since RCS does not support copy operations natively, the version history
30760 is not preserved, and the copy is added as a new file.
30761 It requires a clean document without any changes since the last checkin.
30762 You are asked for a file name and a description of the copy operation.
30763 After that the copy is created, both locally and in the repository.
30764 If the parent directories of the copied and original document differ, all
30765 relative paths of included files of the copy are adjusted (like in
30767 File\SpecialChar menuseparator
30772 Finally, the copy is loaded instead of the original document.
30775 \begin_layout Labeling
30776 \labelwidthstring 00.00.0000
30778 \begin_inset space ~
30782 \begin_inset space ~
30786 \begin_inset Newline newline
30790 \begin_inset Flex Code
30793 \begin_layout Plain Layout
30796 \begin_inset Quotes qld
30800 \begin_inset Quotes qld
30809 \begin_inset Flex Code
30812 \begin_layout Plain Layout
30815 \begin_inset Quotes qld
30819 \begin_inset Quotes qld
30828 \begin_inset Newline newline
30832 \begin_inset Flex Code
30835 \begin_layout Plain Layout
30839 \begin_inset Quotes qld
30843 \begin_inset Quotes qld
30854 \begin_layout Subsubsection
30860 \begin_layout Standard
30861 This makes as if the last check in never happened.
30862 No changes are made to the document loaded into \SpecialChar LyX
30863 , but the last version
30864 is removed from the master RCS file.
30867 \begin_layout Itemize
30870 rcs -o<version> <file-name>
30873 \begin_layout Subsubsection
30879 \begin_layout Standard
30880 This shows the complete history of the RCS document.
30885 is shown in a browser.
30893 \begin_layout Subsubsection
30897 \begin_layout Standard
30899 supports RCS version number, author name, date and time of last commit.
30900 All those are extracted from
30902 rlog -r <file-name>
30906 \begin_inset CommandInset ref
30908 reference "subsec:VCS-Revision-Information"
30915 \begin_layout Subsection
30916 CVS commands in \SpecialChar LyX
30920 \begin_layout Standard
30921 A subset of CVS operations is supported by \SpecialChar LyX
30923 You can find the commands in the
30925 File\SpecialChar menuseparator
30927 \begin_inset space ~
30933 The version control system SVN is more powerful, so please use it instead
30934 of CVS if possible.
30937 \begin_layout Subsubsection
30943 \begin_layout Standard
30944 If you start from scratch with CVS you have to create your repository and
30945 checkout the working copy with external tools.
30946 If you're using a client-server setup you may need to login before doing
30947 the first repository checkout.
30950 \begin_layout Standard
30951 If your documents are under revision control and others are using the same
30952 repository problems arise when different changes to the same document at
30953 the same location happen.
30954 Standard CVS repositories don't operate with a file locking mechanism.
30955 This may be surprising, but conflicts only occur if people disagree on
30956 the proper content of the same part of a document.
30957 So, if co-workers are used to communicate regularly, these conflicts occur
30959 If they don't communicate they have a fundamental problem anyway.
30960 Nevertheless some people like to work with so called
30961 \begin_inset Quotes eld
30965 \begin_inset Quotes erd
30969 If they do so the working copy of all files is readonly when checked out
30970 first and the user starts editing after using a special command to make
30971 the working copy writable.
30972 When the changes are checked in the working copy returns to readonly state.
30973 With \SpecialChar LyX
30974 one has to edit the
30975 \begin_inset Flex Code
30978 \begin_layout Plain Layout
30984 file and add the line
30985 \begin_inset Flex Code
30988 \begin_layout Plain Layout
30994 to work with reserved checkouts.
30995 The benefit is the possibility to see who is using a writable copy of some
30997 It's not guaranteed only one user makes a copy writable.
31000 \begin_layout Standard
31002 tries to guess if you're using reserved or non-reserved checkouts.
31003 If your working copy is readonly or it is writable and an additional copy
31004 of your document exists in the CVS/Base sub-directory a reserved otherwise
31005 a non-reserved checkout is assumed.
31006 When a reserved checkout is detected you have to use
31007 \begin_inset Flex Noun
31010 \begin_layout Plain Layout
31016 to make your working copy writable if it's readonly.
31018 \begin_inset Flex Noun
31021 \begin_layout Plain Layout
31027 operation is possible and that makes your working copy readonly again after
31028 transferring your changes to the repository.
31031 \begin_layout Standard
31032 More information about CVS can be found here
31033 \begin_inset Flex URL
31036 \begin_layout Plain Layout
31038 http://www.nongnu.org/cvs
31044 \begin_inset Flex URL
31047 \begin_layout Plain Layout
31049 http://ximbiot.com/cvs
31057 \begin_layout Standard
31062 to understand the sub-commands and the switches mentioned below.
31065 \begin_layout Subsubsection
31071 \begin_layout Standard
31072 If your document is not under revision control, this is the only item shown
31074 And if it is under revision control, the
31078 item is not visible.
31082 \begin_layout Standard
31083 This command registers in CVS your document
31084 \begin_inset Flex Strong
31087 \begin_layout Plain Layout
31095 in the case you have already the documents directory under CVS control
31101 This means you have to create or checkout the archive by yourself using
31103 (In case you forget that step \SpecialChar LyX
31104 registers the document with RCS.)
31107 \begin_layout Standard
31108 Then you are asked interactively to supply an initial description of the
31110 Don't forget that registered file is not yet checked in.
31113 \begin_layout Standard
31114 CVS command that is run:
31116 cvs -q add -m"<entered message>" "<file-name>"
31119 \begin_layout Standard
31124 above and for all other CVS commands is an abbreviation for
31125 \begin_inset Quotes eld
31128 change the current working directory to file location and use the file name
31129 without path component as argument
31130 \begin_inset Quotes erd
31136 \begin_layout Subsubsection
31142 \begin_layout Standard
31143 When you are finished editing a file, you commit your changes.
31144 When you do this and you had changed the document, you are asked for a
31145 description of the changes.
31146 After that changes are written to the repository.
31147 In case you didn't change the document and a reserved checkout is detected
31148 the reservation made on
31149 \begin_inset Flex Noun
31152 \begin_layout Plain Layout
31161 \begin_layout Labeling
31162 \labelwidthstring 00.00.0000
31164 \begin_inset space ~
31168 \begin_inset space ~
31172 \begin_inset Newline newline
31176 \begin_inset Flex Code
31179 \begin_layout Plain Layout
31182 -q commit -m"<description>" "<file-name>"
31188 \begin_inset Newline newline
31192 \begin_inset Flex Code
31195 \begin_layout Plain Layout
31206 \begin_layout Subsubsection
31212 \begin_layout Standard
31213 When you are sharing a repository with others, you may have to incorporate
31214 their changes into your working copy.
31217 \begin_layout Standard
31220 cvs -q update "<file-name>"
31223 \begin_layout Standard
31224 If a readonly checkout is detected the working copy is made writable and
31228 \begin_layout Standard
31231 cvs -q edit "<file-name>"
31234 \begin_layout Subsubsection
31237 Revert To Repository Version
31240 \begin_layout Standard
31241 This will discard all changes made to the document since the last check
31243 You get a warning before changes are discarded.
31244 Firstly the file is deleted, secondly CVS update command is run.
31247 \begin_layout Standard
31250 cvs -q update "<file-name>"
31253 \begin_layout Standard
31254 If a reserved checkout is detected and the working copy has no changes only
31255 the reservation is undone.
31258 \begin_layout Standard
31261 cvs -q unedit "<file-name>"
31264 \begin_layout Subsubsection
31270 \begin_layout Standard
31271 This will create a copy of the current document.
31272 Since CVS does not support copy operations natively, the version history
31273 is not preserved, and the copy is added as a new file.
31274 It requires a clean document without any changes since the last checkin.
31275 You are asked for a file name and a description of the copy operation.
31276 After that the copy is created, both locally and in the repository.
31277 If the parent directories of the copied and original document differ, all
31278 relative paths of included files of the copy are adjusted (like in
31280 File\SpecialChar menuseparator
31285 Finally, the copy is loaded instead of the original document.
31288 \begin_layout Labeling
31289 \labelwidthstring 00.00.0000
31291 \begin_inset space ~
31295 \begin_inset space ~
31299 \begin_inset Newline newline
31303 \begin_inset Flex Code
31306 \begin_layout Plain Layout
31313 \begin_inset Flex Code
31316 \begin_layout Plain Layout
31323 \begin_inset Newline newline
31327 \begin_inset Flex Code
31330 \begin_layout Plain Layout
31331 cvs -q add "<new-file-name>"
31339 \begin_layout Subsubsection
31345 \begin_layout Standard
31346 This will rename the current document.
31347 Since CVS does not support rename operations natively, the version history
31348 is not preserved, the renamed document is added as a new file, and the
31349 original document is deleted.
31350 It requires a clean document without any changes since the last checkin.
31351 You are asked for a file name and a description of the rename operation.
31352 After that the document is renamed, both locally and in the repository.
31353 If the parent directories of the new and old file names differ, all relative
31354 paths of included files are adjusted (like in
31356 File\SpecialChar menuseparator
31361 Finally, the document is reloaded using the new name.
31364 \begin_layout Labeling
31365 \labelwidthstring 00.00.0000
31367 \begin_inset space ~
31371 \begin_inset space ~
31375 \begin_inset Newline newline
31379 \begin_inset Flex Code
31382 \begin_layout Plain Layout
31389 \begin_inset Flex Code
31392 \begin_layout Plain Layout
31399 \begin_inset Newline newline
31403 \begin_inset Flex Code
31406 \begin_layout Plain Layout
31407 cvs -q add "<new-file-name>"
31413 \begin_inset Newline newline
31417 \begin_inset Flex Code
31420 \begin_layout Plain Layout
31421 cvs -q remove "<file-name>"
31429 \begin_layout Subsubsection
31430 Update of the local directory checkout from repository
31433 \begin_layout Standard
31434 Once your documents gets more complex, containing sub-documents and pictures,
31436 \begin_inset Flex Code
31439 \begin_layout Plain Layout
31445 files and so on using version control becomes more complicated.
31447 supports updating the whole tree in which resides the document.
31448 This become especially useful once you cooperate with people which neither
31449 have detailed knowledge about CVS usage nor they have ambition to commit
31450 additional material to the repository.
31451 You have to organize the files structure so that all external files are
31452 in the same directory or subdirectories of the document.
31453 It's good practice anyway to store multipart documents in an extra directory.
31456 \begin_layout Standard
31458 \begin_inset Flex Code
31461 \begin_layout Plain Layout
31462 Update local directory from repository
31467 command updates the whole directory.
31468 If local changes are detected user is warned before update starts.
31469 In case of merge conflicts both versions of the conflicting document parts
31470 are placed in the final document.
31471 You have to review and correct the result of the merge.
31472 You'll find the conflicts enclosed in pairs of
31473 \begin_inset Flex Code
31476 \begin_layout Plain Layout
31483 \begin_inset Flex Code
31486 \begin_layout Plain Layout
31493 \begin_inset Flex Code
31496 \begin_layout Plain Layout
31503 The first part is your version as before the update operation with the
31504 document name prepended.
31505 The second one is the repository version with the version number after
31507 \begin_inset Flex Code
31510 \begin_layout Plain Layout
31519 \begin_layout Labeling
31520 \labelwidthstring 00.00.0000
31522 \begin_inset space ~
31526 \begin_inset space ~
31530 \begin_inset Newline newline
31534 \begin_inset Flex Code
31537 \begin_layout Plain Layout
31545 (Ask if changes are detected.)
31546 \begin_inset Newline newline
31550 \begin_inset Flex Code
31553 \begin_layout Plain Layout
31554 cd $path; cvs -q update
31564 \begin_layout Standard
31566 \begin_inset Flex Code
31569 \begin_layout Plain Layout
31575 stands for the path to the document.
31578 \begin_layout Subsubsection
31584 \begin_layout Standard
31585 This shows the complete history of the CVS document.
31588 cvs log "<file-name>"
31590 is shown in a browser.
31593 \begin_layout Subsubsection
31597 \begin_layout Standard
31599 supports CVS version number, author name, date and time of last commit.
31600 All those are extracted from
31602 cvs log -r <file-name>
31606 \begin_inset CommandInset ref
31608 reference "subsec:VCS-Revision-Information"
31615 \begin_layout Subsection
31616 SVN commands in \SpecialChar LyX
31620 \begin_layout Standard
31621 SVN is now partially supported by \SpecialChar LyX
31623 You can find the commands in the
31625 File\SpecialChar menuseparator
31627 \begin_inset space ~
31633 Please note that if you use password protected access to repository via
31634 ssh, you will be asked in terminal window.
31636 was tested against SVN 1.5, 1.6, 1.7 and 1.8
31640 \begin_layout Plain Layout
31641 Most of the commands will work with 1.4 too, see
31642 \begin_inset CommandInset ref
31644 reference "subsec:SVN-Repo-Update"
31649 There seems to be currently unresolved permissions problem under SVN 1.8
31650 with reverting changes when file is locked.
31658 \begin_layout Subsubsection
31664 \begin_layout Standard
31665 If your document is not under revision control, this is the only item shown
31667 And if it is under revision control, the
31671 item is not visible.
31674 \begin_layout Standard
31675 This command registers in SVN your document ONLY in case you have already
31676 the documents directory under SVN control (in particular
31681 This means you have to checkout the archive by yourself.
31684 \begin_layout Standard
31685 Then you are asked interactively to supply an initial description of the
31687 Don't forget that registered file is not yet commited.
31690 \begin_layout Standard
31691 SVN command that is run:
31694 \begin_inset Quotes qld
31698 \begin_inset Quotes qld
31704 \begin_layout Standard
31709 to understand the switches.
31712 \begin_layout Subsubsection
31718 \begin_layout Standard
31719 When you are finished editing a file, you commit your changes.
31720 When you do this, you are asked for a description of the changes.
31721 After that changes are commited.
31724 \begin_layout Standard
31729 \begin_layout Plain Layout
31730 In case locking is not enabled.
31732 \begin_inset CommandInset ref
31734 reference "subsec:SVN-File-Locking"
31745 svn commit -q -m"<description>" <file-name>
31748 \begin_layout Subsubsection
31754 \begin_layout Standard
31755 Updates the changes of this file from the repository.
31756 Be sure you understand SVN merging and conflicts resolving before using
31757 this function, because all conflicts has to be resolved manually by you!
31760 \begin_layout Standard
31765 \begin_layout Plain Layout
31773 svn update --non-interactive
31774 \begin_inset Quotes qld
31778 \begin_inset Quotes qld
31784 \begin_layout Subsubsection
31787 Revert To Repository Version
31790 \begin_layout Standard
31791 This will discard all changes made to the document since the last check
31793 You get a warning before changes are discarded.
31796 \begin_layout Standard
31800 \begin_inset Quotes qld
31804 \begin_inset Quotes qld
31810 \begin_layout Subsubsection
31816 \begin_layout Standard
31817 This will create a copy of the current document including the version history.
31818 It requires a clean document without any changes since the last checkin.
31819 You are asked for a file name and a description of the copy operation.
31820 After that the copy is created, both locally and in the repository.
31821 If the parent directories of the copied and original document differ, all
31822 relative paths of included files of the copy are adjusted (like in
31824 File\SpecialChar menuseparator
31829 Finally, the copy is loaded instead of the original document.
31832 \begin_layout Labeling
31833 \labelwidthstring 00.00.0000
31835 \begin_inset space ~
31839 \begin_inset space ~
31843 \begin_inset Newline newline
31847 \begin_inset Flex Code
31850 \begin_layout Plain Layout
31854 \begin_inset Quotes qld
31858 \begin_inset Quotes qld
31862 \begin_inset Quotes qld
31866 \begin_inset Quotes qld
31875 \begin_inset Newline newline
31879 \begin_inset Flex Code
31882 \begin_layout Plain Layout
31891 \begin_layout Subsubsection
31897 \begin_layout Standard
31898 This will rename the current document including the version history.
31899 It requires a clean document without any changes since the last checkin.
31900 You are asked for a file name and a description of the rename operation.
31901 After that the document is renamed, both locally and in the repository.
31902 If the parent directories of the new and old file names differ, all relative
31903 paths of included files are adjusted (like in
31905 File\SpecialChar menuseparator
31910 Finally, the document is reloaded using the new name.
31913 \begin_layout Labeling
31914 \labelwidthstring 00.00.0000
31916 \begin_inset space ~
31920 \begin_inset space ~
31924 \begin_inset Newline newline
31928 \begin_inset Flex Code
31931 \begin_layout Plain Layout
31935 \begin_inset Quotes qld
31939 \begin_inset Quotes qld
31943 \begin_inset Quotes qld
31947 \begin_inset Quotes qld
31956 \begin_inset Newline newline
31960 \begin_inset Flex Code
31963 \begin_layout Plain Layout
31972 \begin_layout Subsubsection
31973 \begin_inset CommandInset label
31975 name "subsec:SVN-Repo-Update"
31979 Update of the local directory checkout from repository
31983 \begin_layout Plain Layout
31984 Note that this command will work only with subversion
31985 \begin_inset Formula $\geqq1.5$
31996 \begin_layout Standard
31997 All the commands above have one shortcoming – they deal with the current
31999 Once your document contains pictures, includes external
32000 \begin_inset Flex Code
32003 \begin_layout Plain Layout
32009 files and so on administration becomes more complicated.
32011 now supports updating the whole tree in which resides the document
32015 \begin_layout Plain Layout
32016 One need to organize the files structure so that all external files are
32017 in the same directory or subdirectories of the document.
32024 This become especially useful once you cooperate with people which neither
32025 know about subversion management nor they have ambition to commit additional
32026 material to the repository.
32030 \begin_layout Standard
32031 \begin_inset Flex Code
32034 \begin_layout Plain Layout
32035 Update local directory from repository
32040 command updates the whole directory and in case of merge conflicts local
32041 version of the files are left, so no unintended data loss occurs.
32042 If local changes are detected user is warned before update starts.
32045 \begin_layout Labeling
32046 \labelwidthstring 00.00.0000
32048 \begin_inset space ~
32052 \begin_inset space ~
32056 \begin_inset Newline newline
32060 \begin_inset Flex Code
32063 \begin_layout Plain Layout
32069 (Ask if changes are detected.)
32070 \begin_inset Newline newline
32074 \begin_inset Flex Code
32077 \begin_layout Plain Layout
32078 svn update --accept mine-full $path
32086 \begin_layout Standard
32088 \begin_inset Flex Code
32091 \begin_layout Plain Layout
32097 stands for the path to the document.
32100 \begin_layout Subsubsection
32106 \begin_layout Standard
32107 This shows the complete history of the SVN document.
32111 \begin_inset Quotes qld
32115 \begin_inset Quotes qld
32120 is shown in a browser.
32123 \begin_layout Subsubsection
32125 \begin_inset CommandInset label
32127 name "subsec:SVN-File-Locking"
32134 \begin_layout Standard
32135 The file exchange through various revision control systems brings the problem
32136 of merge conflicts in case two different users try to edit the same (parts
32138 When such a conflict happens it needs manual resolving and one reasonable
32139 alternative is to provide some kind of locking mechanism, which guarantees
32140 that only one user is allowed to edit file at the given time.
32143 \begin_layout Standard
32144 SVN has two such mechanisms to provide mutual exclusivity for file access
32145 – locks and automatic setting of write permissions (see sec.
32147 \begin_inset CommandInset ref
32149 reference "subsec:Automatical-Locking-Property"
32154 \begin_inset Flex Code
32157 \begin_layout Plain Layout
32167 \begin_layout Plain Layout
32168 \begin_inset Flex URL
32171 \begin_layout Plain Layout
32173 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
32184 If this property is detected for a given document \SpecialChar LyX
32185 starts to use SVN locks
32186 for document editing automatically and the whole check-in/out mechanism
32187 switches to the same regimen as for RCS.
32188 This in particular means there are two different modes of file use in \SpecialChar LyX
32192 \begin_layout Itemize
32194 The loaded file is in the read-only mode.
32195 For editing on needs to check-out.
32200 consists of updating from the repository and gaining write lock.
32201 If the lock is not possible to obtain, we remain in unlocked state.
32204 \begin_layout Itemize
32206 The loaded file is in the
32207 \begin_inset Quotes els
32211 \begin_inset Quotes ers
32215 No other user is allowed to edit the file.
32220 consists of commiting changes and releasing write-lock.
32221 If no changes have been made to the document, no commit will be produced
32225 \begin_layout Plain Layout
32226 Don't be puzzled by the fact that you will be asked for commit message anyway.
32231 and only the write-lock will be released.
32234 \begin_layout Standard
32238 \begin_layout Labeling
32239 \labelwidthstring 00.00.0000
32242 svn commit -q -m"<description>" "<file-name>"
32243 \begin_inset Newline newline
32246 svn unlock "<file-name>"
32249 \begin_layout Labeling
32250 \labelwidthstring 00.00.0000
32253 svn update "<file-name>"
32254 \begin_inset Newline newline
32257 svn lock "<file-name>"
32260 \begin_layout Subsubsection
32263 \begin_inset CommandInset label
32265 name "subsec:Automatical-Locking-Property"
32271 Automatic Locking Property
32274 \begin_layout Standard
32275 The above mentioned automatic setting of write permissions of the .lyx file
32278 File\SpecialChar menuseparator
32280 \begin_inset space ~
32283 Control\SpecialChar menuseparator
32284 Use Locking Property
32287 This command is active only when the file is not locked on the svn server
32289 you need to check-out before proceeding).
32292 \begin_layout Labeling
32293 \labelwidthstring 00.00.0000
32295 \begin_inset space ~
32301 \begin_layout Labeling
32302 \labelwidthstring 00.00.0000
32305 svn propset svn:needs-lock ON "<file-name>"
32308 \begin_layout Labeling
32309 \labelwidthstring 00.00.0000
32312 svn propdel svn:needs-lock "<file-name>"
32315 \begin_layout Subsubsection
32316 \begin_inset CommandInset label
32318 name "subsec:VCS-Revision-Information"
32322 Revision Information in Documents
32325 \begin_layout Standard
32326 There are more possibilities how to activate revision information in our
32330 \begin_layout Itemize
32336 \begin_layout Itemize
32337 tree revision information (
32338 \begin_inset Flex Code
32341 \begin_layout Plain Layout
32348 The result is the output of the
32349 \begin_inset Flex Code
32352 \begin_layout Plain Layout
32358 command, the following table gives you an idea, how to read the results.
32361 \begin_layout Standard
32363 \begin_inset Tabular
32364 <lyxtabular version="3" rows="6" columns="2">
32365 <features tabularvalignment="middle">
32366 <column alignment="left" valignment="top">
32367 <column alignment="left" valignment="top">
32369 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
32372 \begin_layout Plain Layout
32380 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
32383 \begin_layout Plain Layout
32393 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
32396 \begin_layout Plain Layout
32402 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
32405 \begin_layout Plain Layout
32406 mixed revision working copy
32413 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
32416 \begin_layout Plain Layout
32422 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
32425 \begin_layout Plain Layout
32426 modified working copy
32433 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
32436 \begin_layout Plain Layout
32442 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
32445 \begin_layout Plain Layout
32446 switched working copy
32453 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
32456 \begin_layout Plain Layout
32462 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
32465 \begin_layout Plain Layout
32466 partial working copy, from a sparse checkout
32473 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
32476 \begin_layout Plain Layout
32482 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
32485 \begin_layout Plain Layout
32486 mixed revision, modified, switched working copy
32499 \begin_layout Itemize
32500 file revision information.
32501 The result comes from parsing the output of
32502 \begin_inset Flex Code
32505 \begin_layout Plain Layout
32507 \begin_inset space ~
32511 \begin_inset space ~
32515 \begin_inset space ~
32524 Supported flags are:
32528 \begin_layout Itemize
32529 version number of the last commit (
32530 \begin_inset Flex Code
32533 \begin_layout Plain Layout
32542 \begin_layout Itemize
32543 author of the last commit (
32544 \begin_inset Flex Code
32547 \begin_layout Plain Layout
32556 \begin_layout Itemize
32557 date of the last commit (
32558 \begin_inset Flex Code
32561 \begin_layout Plain Layout
32570 \begin_layout Itemize
32571 time of the last commit (
32572 \begin_inset Flex Code
32575 \begin_layout Plain Layout
32585 \begin_layout Standard
32586 You can obtain this info via InsetInfo (
32587 \change_inserted 5863208 1564400022
32590 Insert\SpecialChar menuseparator
32591 Field\SpecialChar menuseparator
32592 Version Control Revision
32593 \change_deleted 5863208 1564399852
32598 \begin_inset Flex Code
32601 \begin_layout Plain Layout
32602 info-insert buffer vcs-date
32610 The information will be available only when you have the file stored under
32611 svn managment (i.e.
32613 \begin_inset Flex Code
32616 \begin_layout Plain Layout
32622 directory is available with your document).
32626 \begin_layout Itemize
32627 Another—a hacking one—possibility is to use svn keywords
32631 \begin_layout Plain Layout
32632 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
32638 In short – you set file keywords property (e.g.
32641 svn propset svn:keywords 'Rev' file.lyx
32643 ) and then paste keyword \SpecialChar TeX
32648 \begin_layout Plain Layout
32649 This is an easy way how to ensure that \SpecialChar LyX
32650 won't break the line in the middle
32656 tag in your document (e.g.
32658 \begin_inset Flex Code
32661 \begin_layout Plain Layout
32668 This way svn client will automatically substitute revision number (e.g.
32670 \begin_inset Flex Code
32673 \begin_layout Plain Layout
32679 ) after each update and commit.
32680 There are more problems with this approach.
32681 Firstly, the '$' character is used in \SpecialChar TeX
32682 world for math equations, so any
32683 occurence of math formula
32684 \begin_inset Formula $Rev$
32688 \begin_inset Formula $Rev:59$
32691 in your \SpecialChar LyX
32693 Similarly for other keywords like Id, Date, Author, etc.
32694 Secondly svn output is dependent on your locales, so its very easy that
32695 svn would produce some problematic strings once Date is used.
32696 Thirdly you get the whole 'Rev: 59' string in your document instead of
32698 Until subversion implements user's custom keywords it will be hard to use
32699 this approach reliably or let \SpecialChar LyX
32700 to support it directly.
32703 \begin_layout Subsection
32704 SVN and Windows Environment
32707 \begin_layout Quote
32708 My inclination is to say that if the user cannot figure out the command
32709 line operations on their own fairly quickly, they would be well advised
32710 to use TortoiseSVN.
32716 \begin_layout Subsubsection
32720 \begin_layout Standard
32721 In addition to installing \SpecialChar LyX
32722 , and having access to a Subversion repository,
32723 the user will need to install the Subversion client program.
32724 A Windows installer for the client program is available from
32725 \begin_inset CommandInset href
32728 target "http://www.collab.net/nonav/downloads/subversion/"
32734 The user may also want to install
32735 \begin_inset CommandInset href
32738 target "http://tortoisesvn.tigris.org/"
32743 , which integrates Subversion operations into the context (rightclick) menu
32744 of Windows Explorer.
32745 Operations done outside \SpecialChar LyX
32746 will typically be more convenient using the Explorer
32748 Note that TortoiseSVN is not a replacement for the client program, which
32749 is what \SpecialChar LyX
32753 \begin_layout Subsubsection
32754 Bringing a document under Subversion control
32757 \begin_layout Standard
32758 Before a \SpecialChar LyX
32759 document can be brought under version control in Subversion, its
32760 parent directory needs to be under version control.
32761 If the document is being added to a project already in the repository,
32762 this is accomplished by checking the project out to the directory where
32763 the new document will be placed.
32764 If the project itself is not yet under version control (for instance, if
32765 this document starts a new project), the directory must be imported into
32767 This is done outside \SpecialChar LyX
32769 Both import and checkout are easily accomplished from the Explorer context
32770 menu using TortoiseSVN, or alternatively can be done using the command
32771 line client at a DOS prompt.
32772 The procedure for importing the project using TortoiseSVN is described
32773 below, assuming an existing repository and a new project being started
32781 For information on using the Subversion client program, run
32788 \begin_layout Enumerate
32795 in Windows Explorer, right click it, and select
32797 TortoiseSVN\SpecialChar menuseparator
32801 If necessary, adjust the URL for the repository, then click OK.
32804 \begin_layout Enumerate
32805 Right click the level of the repository under which you want to place the
32806 new project folder (typically the top level) and click
32810 Supply a name for the project folder and click OK.
32811 Add a message for the log file if desired, then click OK again.
32812 The new project folder should appear in the repository.
32813 Finally, click OK again to exit the repository browser.
32816 \begin_layout Enumerate
32817 Once again right click
32823 , this time selecting SVN Checkout\SpecialChar ldots
32824 Select the URL of the project folder
32825 you just created in the repository, and set the checkout directory to
32833 You will be warned about a non-empty folder; click OK to proceed.
32834 You should now have a
32845 \begin_layout Enumerate
32846 Create or open your document in \SpecialChar LyX
32849 File\SpecialChar menuseparator
32851 \begin_inset space ~
32854 Control\SpecialChar menuseparator
32858 Add a log message and click OK to commit the document to version control.
32861 \begin_layout Standard
32862 From this point onward, you should have full functionality in the
32864 File\SpecialChar menuseparator
32866 \begin_inset space ~
32872 You also have the option of checking the document in and out, viewing its
32874 using the TortoiseSVN context menu in Windows Explorer or the Subversion
32875 client program from a command prompt.
32878 \begin_layout Subsubsection
32879 SSH tunnel used with SVN under Windows
32882 \begin_layout Standard
32883 Compared with Linux setting up an svn client to communicate over ssh under
32884 Windows is a rather troublesome task.
32885 We will at least offer some hints how to setup the client side but prior
32886 knowledge about ssh and the Windows command line is needed, also be prepared
32887 for a great deal of frustration\SpecialChar ldots
32891 \begin_layout Enumerate
32892 Get an svn client for windows, as described in the previous sections.
32893 When it is a fresh install run some svn command (e.g.
32895 \begin_inset Flex Code
32898 \begin_layout Plain Layout
32904 ) to create config files, which you will need to change later on.
32907 \begin_layout Enumerate
32908 Choose an ssh client for Windows.
32909 There are several possibilities, we will use the one from Putty tools
32913 \begin_layout Plain Layout
32914 \begin_inset Flex URL
32917 \begin_layout Plain Layout
32919 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
32930 You will need to set the connection up so that the client doesn't ask for
32931 any password from you.
32932 To keep things easy we will use only keys without any additional password
32937 \begin_layout Enumerate
32939 \begin_inset Flex Code
32942 \begin_layout Plain Layout
32949 Save your private .ppk key file and put the public one on the server side.
32950 If the SVN server runs on Linux, note that the format of the public key
32951 is not compatible with Linux openssh and you will need to direcly copy-paste
32953 \begin_inset Quotes eld
32958 Public key for pasting into OpenSSH authorized_keys file
32961 \begin_inset Quotes erd
32964 edit field into the server's
32965 \begin_inset Flex Code
32968 \begin_layout Plain Layout
32969 ~/.ssh/authorized_keys
32975 \begin_inset Flex Code
32978 \begin_layout Plain Layout
32987 \begin_layout Enumerate
32989 \begin_inset Flex Code
32992 \begin_layout Plain Layout
32999 In the SVN config file
33003 \begin_layout Plain Layout
33004 Exact path depends on Windows version, usually somewhere around
33005 \begin_inset Flex Code
33008 \begin_layout Plain Layout
33011 Documents and Settings
33025 \begin_inset Flex Code
33028 \begin_layout Plain Layout
33043 , section [tunnels], setup ssh command, e.g.
33045 \begin_inset Flex Code
33048 \begin_layout Plain Layout
33049 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
33058 \begin_layout Plain Layout
33059 It will usually take a lot of time to get exact command right and it depends
33061 For example do not have some remote server saved as a default session in
33063 If things fail, try to connect via plink without SVN first.
33072 \begin_layout Enumerate
33073 Checkout the SVN archive, e.
33074 \begin_inset space \thinspace{}
33078 \begin_inset Newline newline
33082 \begin_inset Flex Code
33085 \begin_layout Plain Layout
33086 svn co svn+ssh://user@server/repository_path
33094 \begin_layout Subsubsection
33095 End-of-Line Conversions
33098 \begin_layout Standard
33099 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
33101 use different line endings inside the .lyx files.
33102 This is not a problem as far as \SpecialChar LyX
33103 functionality is concerned, but the commit
33104 diffs will be huge and merge-conflicts prone.
33105 Fortunately SVN itself knows
33109 \begin_layout Plain Layout
33110 \begin_inset Flex URL
33113 \begin_layout Plain Layout
33115 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
33125 how to deal with CR/LF problems when switching .lyx files to the
33126 \begin_inset Flex Code
33129 \begin_layout Plain Layout
33139 \begin_layout Plain Layout
33141 \begin_inset Flex Code
33144 \begin_layout Plain Layout
33145 svn propset svn:eol-style native FILE_NAME
33158 \begin_layout Subsection
33159 GIT commands in \SpecialChar LyX
33163 \begin_layout Standard
33164 A minimal subset of GIT commands is now supported by \SpecialChar LyX
33166 You can find the commands in the
33168 File\SpecialChar menuseparator
33170 \begin_inset space ~
33176 Please note that if you use password protected access to repository via
33177 ssh, you will be asked in terminal window.
33179 was tested against GIT 1.7.
33183 \begin_layout Plain Layout
33184 Windows users please note that you need to ensure that git is on the path.
33185 This can be set from within \SpecialChar LyX
33188 Tools\SpecialChar menuseparator
33189 Preferences\SpecialChar menuseparator
33190 Paths\SpecialChar menuseparator
33201 \begin_layout Standard
33202 One big difference of GIT and the other supported version control systems
33203 is the distributed nature of GIT: With traditional version control systems
33204 there is one central server which hosts the repository.
33205 Users commit their changes to the server, and get updates made by other
33207 With GIT, users commit to a local repository.
33208 The local repository can be synchronized with one or more remote repositories
33210 \begin_inset Flex Code
33213 \begin_layout Plain Layout
33220 \begin_inset Flex Code
33223 \begin_layout Plain Layout
33231 does not interact in any way with remote GIT repositories.
33232 It works exclusively with the local repository in a very similar way as
33233 with a central CVS or SVN repository.
33234 If you use remote GIT repositories you need to do the
33235 \begin_inset Flex Code
33238 \begin_layout Plain Layout
33245 \begin_inset Flex Code
33248 \begin_layout Plain Layout
33254 operations with your favourite GIT client.
33257 \begin_layout Subsubsection
33263 \begin_layout Standard
33264 If your document is not under revision control, this is the only item shown
33266 And if it is under revision control, the
33270 item is not visible.
33273 \begin_layout Standard
33274 This command registers in GIT your document ONLY in case you have already
33275 the documents directory under GIT control (in particular
33280 This means you have to checkout the archive by yourself.
33283 \begin_layout Standard
33284 Then you are asked interactively to supply an initial description of the
33286 Don't forget that registered file is not yet committed.
33289 \begin_layout Standard
33290 GIT command that is run:
33293 \begin_inset Quotes qld
33297 \begin_inset Quotes qld
33303 \begin_layout Standard
33308 to understand the switches.
33311 \begin_layout Subsubsection
33317 \begin_layout Standard
33318 When you are finished editing a file, you commit your changes.
33319 When you do this, you are asked for a description of the changes.
33320 After that changes are committed.
33323 \begin_layout Standard
33326 git commit -q -m"<description>" <file-name>
33329 \begin_layout Subsubsection
33332 Revert To Repository Version
33335 \begin_layout Standard
33336 This will discard all changes made to the document since the last check
33338 You get a warning before changes are discarded.
33341 \begin_layout Standard
33345 \begin_inset Quotes qld
33349 \begin_inset Quotes qld
33355 \begin_layout Subsubsection
33361 \begin_layout Standard
33362 This will rename the current document including the version history.
33363 It requires a clean document without any changes since the last checkin.
33364 You are asked for a file name and a description of the rename operation.
33365 After that the document is renamed, both locally and in the repository.
33366 If the parent directories of the new and old file names differ, all relative
33367 paths of included files are adjusted (like in
33369 File\SpecialChar menuseparator
33374 Finally, the document is reloaded using the new name.
33377 \begin_layout Labeling
33378 \labelwidthstring 00.00.0000
33380 \begin_inset space ~
33384 \begin_inset space ~
33388 \begin_inset Newline newline
33392 \begin_inset Flex Code
33395 \begin_layout Plain Layout
33399 \begin_inset Quotes qld
33403 \begin_inset Quotes qld
33407 \begin_inset Quotes qld
33411 \begin_inset Quotes qld
33420 \begin_inset Newline newline
33424 \begin_inset Flex Code
33427 \begin_layout Plain Layout
33436 \begin_layout Subsubsection
33442 \begin_layout Standard
33443 This shows the complete history of the GIT document.
33447 \begin_inset Quotes qld
33451 \begin_inset Quotes qld
33456 is shown in a browser.
33459 \begin_layout Subsubsection
33463 \begin_layout Standard
33465 supports GIT hash number of the last commit to the file,
33466 \change_inserted 1119979965 1564297456
33467 its abbreviated form,
33469 author name, date and time of last commit.
33470 All those are extracted from
33472 git log -n 1 --pretty=format:%H%n
33473 \change_inserted 1119979965 1564297427
33479 Tree version information is obtained via
33481 git describe --abbrev --dirty --long
33485 \begin_inset CommandInset ref
33487 reference "subsec:VCS-Revision-Information"
33494 \begin_layout Subsection
33498 \begin_layout Standard
33499 With the recent addition of the
33500 \begin_inset Flex Code
33503 \begin_layout Plain Layout
33509 function \SpecialChar LyX
33510 power users are allowed to create their own commands for revision
33514 \begin_layout Standard
33515 As an example you can see how two TortoiseSVN commands could be integrated
33519 \begin_layout Description
33521 \begin_inset Flex Code
33524 \begin_layout Plain Layout
33525 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
33533 \begin_layout Description
33535 \begin_inset Flex Code
33538 \begin_layout Plain Layout
33539 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
33547 \begin_layout Subsection
33548 Version control and Document comparison
33551 \begin_layout Standard
33552 One of the typical uses of version control is to inspect the changes between
33553 revisions, usually by creating
33554 \begin_inset Flex Code
33557 \begin_layout Plain Layout
33564 While this is useful for plain text files, it is much less useful in the
33565 case of \SpecialChar LyX
33566 files, which have more a complicated structure.
33567 Hence we provide binding to the Document comparison feature.
33568 There are two ways of calling this feature – either by direct call of
33569 \begin_inset Flex Code
33572 \begin_layout Plain Layout
33579 function (for details see \SpecialChar LyX
33580 functions manual) or by the toolbar icon
33593 One can either compare two chosen revisions of the document or he can simply
33594 compare the current version of edited text with older revisions (where
33596 \begin_inset Flex Noun
33599 \begin_layout Plain Layout
33605 ' revisions back means comparison of the edited file with last commited
33610 \begin_layout Standard
33611 This feature is supported for SVN and RCS though due to the more complicated
33612 versioning scheme of RCS there is a constraint – when addressing the revisions
33613 in dialog, numbers always point to the last number in RCS revision number,
33616 We don't currently support GIT addressing of revisions, one can just compare
33617 edited document with its revision X steps backs, where X is addressed as
33619 \begin_inset Flex Code
33622 \begin_layout Plain Layout
33631 \begin_layout Section
33633 \change_inserted 564990737 1672161575
33634 \begin_inset CommandInset label
33636 name "sec:Literate-Programming"
33642 Literate Programming
33645 \begin_layout Standard
33650 (kayvan@sylvan.com)
33654 original documentation written by
33656 Edmar Wienskoski Jr.
33659 (edmar-w-jr@technologist.com)
33662 \begin_layout Subsection
33666 \begin_layout Standard
33667 The main purpose of this documentation is to show you how to use \SpecialChar LyX
33669 programming, where it is assumed that you are familiar with this programming
33670 technique, and know what
33671 \begin_inset Quotes eld
33675 \begin_inset Quotes erd
33679 \begin_inset Quotes eld
33683 \begin_inset Quotes erd
33687 If that is not the case, please follow the web links provided in the following
33689 There is a lot of good documentation out there covering old development
33690 history to the latest tools tips.
33693 \begin_layout Standard
33694 It is also assumed that you are familiar with \SpecialChar LyX
33695 itself to a point that you
33696 are comfortable changing your \SpecialChar LyX
33697 preferences, and X resources file.
33698 If that is not the case please refer to other \SpecialChar LyX
33699 documentation to cover your
33703 \begin_layout Subsection
33704 Literate Programming
33707 \begin_layout Standard
33708 From the Literate Programming FAQ:
33711 \begin_layout Quotation
33712 Literate programming is the combination of documentation and source together
33713 in a fashion suited for reading by human beings.
33714 In fact, literate programs should be enjoyable reading, even inviting!
33715 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
33716 and documentation in a single file.
33717 Literate programming tools then parse the file to produce either readable
33718 documentation or compilable source.
33719 The WEB style of literate programming was created by D.
33720 \begin_inset space \thinspace{}
33724 Knuth during the development of his \SpecialChar TeX
33725 typesetting software.
33729 \begin_layout Standard
33730 Another excerpt says:
33733 \begin_layout Quotation
33736 How is literate programming different from verbose commenting?
33739 \begin_layout Quotation
33740 There are three distinguishing characteristics.
33741 In order of importance, they are:
33745 \begin_layout Itemize
33746 flexible order of elaboration
33749 \begin_layout Itemize
33750 automatic support for browsing
33753 \begin_layout Itemize
33754 typeset documentation, especially diagrams and mathematics
33758 \begin_layout Standard
33759 Now that I sparked your curiosity, take a look in the references.
33762 \begin_layout Subsubsection
33766 \begin_layout Standard
33767 The complete Literate Programming FAQ can be found at:
33770 \begin_layout Quote
33771 Literate Programming FAQ
33772 \begin_inset Flex URL
33775 \begin_layout Plain Layout
33777 http://www.literateprogramming.com/lpfaq.pdf
33785 \begin_layout Standard
33786 The FAQ lists 23 (twenty three!) different literate programming tools.
33787 Where some are specialized or
33788 \begin_inset Quotes eld
33792 \begin_inset Quotes erd
33795 for particular programming languages, while other have general scope.
33800 for my own use for several reasons:
33803 \begin_layout Itemize
33804 It can generate the documentation either in \SpecialChar LaTeX
33808 \begin_layout Itemize
33809 It has a open architecture, i.
33810 \begin_inset space \thinspace{}
33814 \begin_inset space \space{}
33817 it is easy to plug in new filters
33821 \begin_layout Plain Layout
33826 are programs that read a given data stream and output a manipulated data
33828 That way, a WEB file (consisting of literate code) can be turned into a
33829 file consisting only of C program code or \SpecialChar LaTeX
33835 and to perform special processing that you may need.
33839 \begin_layout Itemize
33840 There is a good selection of filters available already (the HTML is one
33844 \begin_layout Itemize
33848 \begin_layout Standard
33849 The Noweb web page can be found at:
33852 \begin_layout Quote
33854 \begin_inset Flex URL
33857 \begin_layout Plain Layout
33859 https://www.cs.tufts.edu/~nr/noweb/
33867 \begin_layout Standard
33868 Starting from there you can reach many other interesting links and even
33869 some literate program examples.
33872 \begin_layout Subsection
33874 and Literate Programming with Noweb
33877 \begin_layout Standard
33878 The \SpecialChar LyX
33879 support for Literate Programming is provided by using the generic \SpecialChar LyX
33881 converters mechanism.
33882 This support is provided in a
33883 \begin_inset Quotes eld
33887 \begin_inset Quotes erd
33891 \begin_inset space \thinspace{}
33895 \begin_inset space \space{}
33898 you will be able to use this new \SpecialChar LyX
33899 feature with some other literate programming
33900 tool of your choice by just changing your \SpecialChar LyX
33904 \begin_layout Subsubsection
33905 Generating documents and code (weaving and tangling)
33908 \begin_layout Paragraph
33909 Using the noweb module
33912 \begin_layout Standard
33913 If you have installed Noweb and \SpecialChar LyX
33914 successfully, whenever you open a new document,
33915 after you have chosen its document class, use the
33917 Document\SpecialChar menuseparator
33921 \begin_inset Quotes eld
33925 \begin_inset Quotes erd
33929 If Noweb is correctly installed, when you click on the
33930 \begin_inset Quotes eld
33934 \begin_inset Quotes erd
33937 link, you will see the
33938 \begin_inset Quotes eld
33942 \begin_inset Quotes erd
33945 module in the available list and you can add it to your document.
33948 \begin_layout Paragraph
33952 \begin_layout Standard
33954 enables you to write code with a custom inset named
33955 \begin_inset Flex Noun
33958 \begin_layout Plain Layout
33965 Noweb delimits chunks like this:
33968 \begin_layout LyX-Code
33972 \begin_layout LyX-Code
33976 \begin_layout LyX-Code
33980 \begin_layout LyX-Code
33984 \begin_layout LyX-Code
33988 \begin_layout Standard
33989 The problem is that whatever is written in between the << and the
33993 must be taken literally, i.
33994 \begin_inset space \thinspace{}
33998 \begin_inset space \space{}
34002 should be prevented from making any special interpretation of what has
34004 This is also handled by
34005 \begin_inset Flex Noun
34008 \begin_layout Plain Layout
34014 , that works like a normal text inset but has a free spacing capability.
34017 \begin_layout Standard
34018 As a special note, you can also use the
34019 \begin_inset Quotes eld
34023 \begin_inset Quotes erd
34026 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
34030 \begin_layout LyX-Code
34034 \begin_layout LyX-Code
34035 def some_function(args):
34038 \begin_layout LyX-Code
34039 "This is the doc string for this function."
34042 \begin_layout LyX-Code
34043 print "My args: ", args
34046 \begin_layout LyX-Code
34047 @ %def some_function
34050 \begin_layout Standard
34051 For an example of this usage and the resulting cross-reference output, look
34052 at the Literate python program in
34054 LIBDIR/examples/listerrors.lyx
34056 which should make this all clear.
34059 \begin_layout Paragraph
34060 Generating the documentation
34063 \begin_layout Standard
34064 At this point you already have a new document file with a proper document
34065 class, and with some code and text on it.
34066 How do I print it? The answer is simple, you select
34068 View\SpecialChar menuseparator
34072 Just like you would do for a plain document.
34073 No special procedure is required.
34076 \begin_layout Standard
34077 To help orientate you, I will now explain what happens inside \SpecialChar LyX
34081 \begin_layout Enumerate
34084 Update\SpecialChar menuseparator
34087 menu option is chosen, a \SpecialChar LaTeX
34093 \begin_layout Standard
34094 If the document is of any literate class the generated file will be named
34095 with an extension name defined by the
34096 \begin_inset Quotes eld
34100 \begin_inset Quotes erd
34103 format (defined in the Preferences panel), otherwise the file will have
34112 \begin_layout Enumerate
34113 Note that the only difference so far is in the name of the file, no special
34114 processing is required by \SpecialChar LyX
34116 Given that you formatted the code using the
34117 \begin_inset Flex Noun
34120 \begin_layout Plain Layout
34126 inset that, by itself, takes care of the business.
34129 \begin_layout Enumerate
34130 If the document is of any literate class \SpecialChar LyX
34131 will then use the internal \SpecialChar LyX
34133 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
34138 \begin_layout Plain Layout
34139 The converters are defined in the
34141 Tools\SpecialChar menuseparator
34145 \begin_inset Quotes eld
34149 \begin_inset Quotes erd
34161 manual for general information about converters.
34166 to generate the \SpecialChar LaTeX
34171 \begin_layout Standard
34172 Otherwise it will just skip this step.
34176 \begin_layout Enumerate
34177 Finally, \SpecialChar LaTeX
34178 is invoked and the regular post processing continues as in a plain
34182 \begin_layout Standard
34183 Independence from a particular
34184 \begin_inset Quotes eld
34188 \begin_inset Quotes erd
34191 is easily achieved by changing the commands that are run by the various
34195 \begin_layout Paragraph
34196 Generating the code
34199 \begin_layout Standard
34200 When the build menu option is chosen or the corresponding button in the
34201 toolbar is pressed, a \SpecialChar LaTeX
34202 file is generated just like step 1 above.
34203 Next, \SpecialChar LyX
34209 This converter needs to be defined by the user and is not installed by
34210 default, though the Program format is.
34211 This converter (like any other converter) will have two parts:
34214 \begin_layout Enumerate
34215 The converter program itself.
34216 This program performs the conversion from the one format to the other (in
34217 this case, from the Noweb format to the Program pseudo-format).
34220 \begin_layout Enumerate
34221 The error log parser.
34222 This is a program whose sole purpose is to rewrite error messages in a
34223 format that \SpecialChar LyX
34225 This makes it possible for \SpecialChar LyX
34226 to place error boxes in the right places in
34230 \begin_layout Standard
34231 The first part, the
34232 \begin_inset Quotes eld
34236 \begin_inset Quotes erd
34239 setting, should be set to
34242 \begin_layout LyX-Code
34250 \begin_layout Standard
34251 This basically means that \SpecialChar LyX
34253 \begin_inset Quotes eld
34257 \begin_inset Quotes erd
34260 (a program or script) with the name of the Noweb file (normally a file
34261 in the \SpecialChar LyX
34262 temp directory) and the directory path of the original \SpecialChar LyX
34267 \begin_layout Standard
34268 This is an implementation of
34269 \begin_inset Quotes eld
34273 \begin_inset Quotes erd
34276 that you can place in a directory on your path:
34279 \begin_layout LyX-Code
34285 \begin_layout LyX-Code
34291 \begin_layout LyX-Code
34294 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
34297 \begin_layout Standard
34298 The next part of the converter setting is the
34299 \begin_inset Quotes eld
34303 \begin_inset Quotes erd
34306 which is to be set to
34309 \begin_layout LyX-Code
34312 parselog=$$s/scripts/listerrors
34315 \begin_layout Standard
34316 This will run any errors that are generated by the
34317 \begin_inset Quotes eld
34321 \begin_inset Quotes erd
34324 process through the
34325 \begin_inset Quotes eld
34329 \begin_inset Quotes erd
34335 \begin_layout Standard
34336 The build will normally take place in \SpecialChar LyX
34337 's temporary directory, so the files
34338 produced by the conversion will be in that directory.
34340 will copy out what it regards as the `main' file, but the
34344 conversion may produce several files, and so most of these would then be
34345 deleted when \SpecialChar LyX
34347 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
34348 the build-script chunk can place the generated files in that location.
34351 \begin_layout Paragraph
34352 Build instructions in the document
34355 \begin_layout Standard
34356 The last piece of the integration between \SpecialChar LyX
34358 \begin_inset Quotes eld
34362 \begin_inset Quotes erd
34366 Generally, the instructions for building your program should be embedded
34367 in a chunk of its own.
34369 \begin_inset Quotes eld
34373 \begin_inset Quotes erd
34376 above uses the notangle command to look for this chunk (called
34377 \begin_inset Quotes eld
34381 \begin_inset Quotes erd
34384 ) and runs its contents through
34385 \begin_inset Quotes eld
34389 \begin_inset Quotes erd
34395 \begin_layout Standard
34396 Typically, such a chunk would look something like this:
34399 \begin_layout LyX-Code
34403 \begin_layout LyX-Code
34405 \begin_inset Newline newline
34408 if [ -z "${NOWEB_SOURCE}" ]
34409 \begin_inset Newline newline
34415 \begin_layout LyX-Code
34416 NOWEB_SOURCE=myfile.nw
34417 \begin_inset Newline newline
34421 \begin_inset Newline newline
34425 code to extract files ...
34426 use NOWEB_OUTPUT_DIR here ...]
34427 \begin_inset Newline newline
34431 code to compile files ...]
34432 \begin_inset Newline newline
34438 \begin_layout Standard
34440 \change_deleted 564990737 1672161716
34443 LIBDIR/examples/listerrors.lyx
34447 LIBDIR/examples/Literate.lyx
34448 \change_inserted 564990737 1672161716
34453 File\SpecialChar menuseparator
34454 Open Example\SpecialChar menuseparator
34455 Modules\SpecialChar menuseparator
34462 \change_deleted 564990737 1672161729
34466 \begin_inset Quotes eld
34470 \begin_inset Quotes erd
34473 program for some illustrations of how all of these pieces go together or
34475 \change_deleted 564990737 1672161756
34478 LIBDIR/examples/noweb2lyx.lyx
34479 \change_inserted 564990737 1672161756
34484 File\SpecialChar menuseparator
34485 Open Example\SpecialChar menuseparator
34486 Modules\SpecialChar menuseparator
34487 Noweb2\SpecialChar LyX
34497 Interestingly, these
34498 \change_deleted 564990737 1672161767
34501 files show off the language-indepence of the \SpecialChar LyX
34502 literate programming support
34503 since they are written in Python
34504 \change_deleted 564990737 1672161782
34507 and Perl respectively.
34510 \begin_layout Subsubsection
34511 Configuring \SpecialChar LyX
34515 \begin_layout Standard
34516 All the Literate Programming support is configured by the
34518 Tools\SpecialChar menuseparator
34522 \begin_inset Quotes eld
34526 \begin_inset Quotes erd
34530 The important parts are:
34533 \begin_layout Description
34535 \begin_inset space ~
34539 \begin_inset Quotes eld
34543 \begin_inset Quotes erd
34547 \begin_inset space ~
34550 format Set up via the File Formats tab, this is where the Noweb-specific
34560 , the file extension is set to
34565 This tells \SpecialChar LyX
34566 to create a file with a
34570 extension in the first step of the conversion process.
34573 \begin_layout Description
34575 \begin_inset space ~
34583 \begin_inset space ~
34586 format This is an empty format whose sole purpose is to be the endpoint
34587 of a conversion (which then allows us to set up a converter for it).
34590 \begin_layout Description
34600 This converter performs the
34601 \begin_inset Quotes eld
34605 \begin_inset Quotes erd
34608 of the literate document.
34609 For Noweb, it is set to
34610 \begin_inset Quotes eld
34615 noweave -delay -index $$i > $$o
34618 \begin_inset Quotes erd
34624 \begin_layout Description
34634 \begin_inset Quotes eld
34638 \begin_inset Quotes erd
34642 As stated above, the Converter is set to
34643 \begin_inset Quotes eld
34651 \begin_inset Quotes erd
34654 , with Flags set to
34655 \begin_inset Newline newline
34659 \begin_inset Quotes eld
34664 parselog=$$s/scripts/listerrors
34667 \begin_inset Quotes erd
34673 \begin_layout Subsubsection
34677 \begin_layout Standard
34678 There is also a new function implemented in the \SpecialChar LyX
34680 \begin_inset Quotes eld
34683 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
34687 \begin_layout Standard
34688 When debugging code with ddd/gdb, it is possible to invoke a text editor
34689 at the current execution position with a single key stroke.
34690 The default ddd configuration for that is shift-ctrl-V.
34691 It happens that you can define the editor command line invocation in ddd
34694 Edit\SpecialChar menuseparator
34695 Preferences\SpecialChar menuseparator
34698 dialog and changing the "Edit Sources" entry.
34701 \begin_layout Standard
34702 I take advantage of the newly created \SpecialChar LyX
34703 server function and this ddd feature,
34705 \begin_inset Quotes eld
34709 \begin_inset Quotes erd
34715 \begin_layout LyX-Code
34716 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
34719 \begin_layout Standard
34720 With this, whenever you are using ddd and find a point in the program that
34721 you want to edit, you just press shift-ctrl-V (in the ddd window), and
34722 ddd will forward this information to \SpecialChar LyX
34723 through the \SpecialChar LyX
34724 server and then the
34726 window will show the same file with the cursor at the same position ddd
34728 No more guessing or long scrolling to locate a point in the program back
34732 \begin_layout Standard
34733 Note however that you must enable the \SpecialChar LyX
34734 server to get this feature working
34735 (it is disabled by default).
34737 \begin_inset space ~
34741 \begin_inset CommandInset ref
34743 reference "sec:Starting-the-Server"
34747 explains how to do that.
34750 \begin_layout Subsubsection
34754 \begin_layout Standard
34755 There are six new buttons that can be added to your \SpecialChar LyX
34757 Four of these buttons are short cuts to layout styles:
34775 , one for the custom inset
34780 The last one is a short cut to the
34781 \begin_inset Quotes eld
34785 \begin_inset Quotes erd
34792 \begin_layout Standard
34794 has a range of buttons that are available for tool bar customization.
34795 In my toolbar I like to combine the six short cuts above with two more:
34800 \SpecialChar menuseparator
34805 \SpecialChar menuseparator
34812 Document\SpecialChar menuseparator
34813 View\SpecialChar menuseparator
34817 Here is how it looks like:
34820 \begin_layout LyX-Code
34824 \begin_layout LyX-Code
34828 \begin_layout LyX-Code
34829 Icon "layout Standard"
34832 \begin_layout LyX-Code
34833 Icon "layout Section"
34836 \begin_layout LyX-Code
34837 Icon "layout \SpecialChar LaTeX
34841 \begin_layout LyX-Code
34842 Icon "layout \SpecialChar LyX
34846 \begin_layout LyX-Code
34847 Icon "flex.insert Chunk"
34850 \begin_layout LyX-Code
34854 \begin_layout LyX-Code
34858 \begin_layout LyX-Code
34859 Icon "buffer-typeset"
34862 \begin_layout LyX-Code
34863 Icon "build-program"
34866 \begin_layout LyX-Code
34870 \begin_layout LyX-Code
34874 \begin_layout LyX-Code
34878 \begin_layout LyX-Code
34882 \begin_layout LyX-Code
34886 \begin_layout Subsubsection
34887 Colors customization
34890 \begin_layout Standard
34891 There are a number of colors in \SpecialChar LyX
34892 that can be customized in
34897 One of the things that bothers people is the \SpecialChar LaTeX
34899 The default color is red, since the chunks uses \SpecialChar LaTeX
34900 font, and there is a lot
34901 of chunks in literate documents, you may get tired of seeing everything
34903 You can change it by going to the tabs
34912 \begin_layout Standard
34913 The next thing is the visible presence of the newline character in the screen.
34914 You can choose the color of this particular character and make it blend
34916 I recommend you choosing a color that is close to the background but not
34917 equal, that way you still can see it is there, but it is not bothering
34921 \begin_layout Subsection
34926 \begin_layout Standard
34936 \change_inserted 564990737 1672161863
34940 Help\SpecialChar menuseparator
34941 Specific Manuals\SpecialChar menuseparator
34949 \change_deleted 564990737 1671643409
34955 \change_inserted 564990737 1672161856
34959 File\SpecialChar menuseparator
34960 Open Example\SpecialChar menuseparator
34961 Modules\SpecialChar menuseparator
34968 \change_deleted 564990737 1671643461
34969 the Sweave manual (menu
34971 Help\SpecialChar menuseparator
34975 \change_inserted 564990737 1672161856
34979 Help\SpecialChar menuseparator
34980 Specific Manuals\SpecialChar menuseparator
34982 \change_deleted 564990737 1672161921
34988 \change_inserted 564990737 1672161917
34992 File\SpecialChar menuseparator
34993 Open Example\SpecialChar menuseparator
34994 Modules\SpecialChar menuseparator
35002 \begin_layout Chapter
35004 \change_deleted 564990737 1671355343
35008 \begin_layout Standard
35010 \change_deleted 564990737 1671355343
35011 You can do everything with \SpecialChar LyX
35012 that you can do with \SpecialChar LaTeX
35014 However, \SpecialChar LyX
35015 cannot support every \SpecialChar LaTeX
35017 But you can always use \SpecialChar TeX
35019 This chapter shows you some more special things you might want to use.
35020 For other special things you can do with figures, tables, floats, boxes
35021 and notes, have a look at the
35024 \begin_inset space ~