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
42 \maintain_unincluded_children no
44 \language_package default
47 \font_roman "lmodern" "default"
48 \font_sans "lmss" "default"
49 \font_typewriter "lmtt" "default"
50 \font_math "auto" "auto"
51 \font_default_family default
52 \use_non_tex_fonts false
56 \font_typewriter_osf false
57 \font_sf_scale 100 100
58 \font_tt_scale 100 100
60 \use_dash_ligatures true
62 \default_output_format pdf2
64 \bibtex_command default
65 \index_command default
66 \float_placement class
67 \float_alignment class
71 \pdf_title "LyX's Additional Features manual"
72 \pdf_author "LyX Team"
73 \pdf_subject "LyX's additional features documentation"
74 \pdf_keywords "LyX, Documentation, Additional"
76 \pdf_bookmarksnumbered true
77 \pdf_bookmarksopen false
78 \pdf_bookmarksopenlevel 1
83 \pdf_pdfusetitle false
84 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
87 \use_package amsmath 1
88 \use_package amssymb 1
91 \use_package mathdots 1
92 \use_package mathtools 1
94 \use_package stackrel 1
95 \use_package stmaryrd 1
96 \use_package undertilde 1
98 \cite_engine_type default
102 \paperorientation portrait
108 \notefontcolor #0000ff
115 \paragraph_separation indent
116 \paragraph_indentation default
118 \math_indentation default
119 \math_numbering_side default
120 \quotes_style english
124 \paperpagestyle headings
126 \tracking_changes true
127 \output_changes false
129 \postpone_fragile_content false
133 \docbook_table_output 0
134 \docbook_mathml_prefix 1
135 \author -712698321 "Jürgen Spitzmüller"
138 \author 244031559 "Yuriy"
139 \author 564990737 "John Lyx"
140 \author 630872221 "Jean-Pierre Chrétien" jeanpierre.chretien@free.fr
141 \author 1075283030 "Thibaut"
142 \author 1119979965 "Joel A. Kulesza"
148 Additional \SpecialChar LyX
152 \begin_layout Subtitle
154 \change_deleted 630872221 1622909155
156 \change_inserted 630872221 1622909155
163 by the \SpecialChar LyX
168 \begin_layout Plain Layout
170 Principal maintainer of this file is
172 Richard Kimberly Heck
175 If you have comments or error corrections, please send them to the \SpecialChar LyX
178 \begin_inset Flex Code
181 \begin_layout Plain Layout
182 <lyx-docs@lists.lyx.org>
195 \begin_layout Standard
196 \begin_inset CommandInset toc
197 LatexCommand tableofcontents
204 \begin_layout Chapter
208 \begin_layout Standard
209 This manual is essentially Part II of the
211 User's Guide\SpecialChar endofsentence
214 The reason for separating the two documents is simple: the
218 is already quite lengthy, and it contains information on all of the basic
219 features one needs to know in order to prepare most documents.
220 However, the \SpecialChar LyX
221 Team has worked to make \SpecialChar LyX
222 extensible through various configuration
223 files and external packages.
224 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
226 create a layout file (or module) for it without having to alter \SpecialChar LyX
228 We've already had contributions of several new features this way, and some
229 of them are documented here.
230 There are also some more `advanced' features, such as how to control the
231 presentation of bibliographies and how to work with multi-part documents,
232 that are not covered in the
236 and are discussed here.
239 \begin_layout Standard
240 This manual also documents some special features, like fax support
241 \change_deleted 244031559 1603802929
243 \change_inserted 244031559 1603802931
247 \change_deleted 244031559 1603802954
250 , which require additional software to work properly.
251 There is also a chapter on \SpecialChar LyX
253 And lastly, there's a chapter of \SpecialChar LaTeX
254 tools and tips, things you can use to
255 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
257 After all, \SpecialChar LyX
262 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
266 \begin_layout Standard
267 If you haven't read the
271 yet, you are definitely in the wrong manual.
276 is the first place to go, since it describes the notation and format of
278 You should also be thoroughly familiar with the
282 and all of the basic features of \SpecialChar LyX
283 before attempting to read this one.
286 \begin_layout Standard
287 Since many of the topics in this manual depend heavily on \SpecialChar LyX
289 with \SpecialChar LaTeX
290 , this first chapter covers the inner workings of \SpecialChar LyX
293 to generate exactly the \SpecialChar LaTeX
295 It is obviously for more seasoned \SpecialChar LyX
299 \begin_layout Chapter
301 and \SpecialChar LaTeX
305 \begin_layout Section
307 Uses \SpecialChar LaTeX
311 \begin_layout Standard
312 This chapter is for both \SpecialChar TeX
313 -nicians and the \SpecialChar LaTeX
315 In it, we'll explain how \SpecialChar LyX
316 and \SpecialChar LaTeX
317 work together to produce printable output.
318 This is the only place in any of the manuals where we assume you know something
319 about \SpecialChar LaTeX
323 \begin_layout Standard
324 At one time, \SpecialChar LyX
326 \begin_inset Quotes eld
329 WYSIWYM frontend to \SpecialChar LaTeX
331 \begin_inset Quotes erd
334 but that's no longer true.
335 There are frontends to \SpecialChar LaTeX
340 \begin_layout Plain Layout
341 Some familar ones are \SpecialChar TeX
342 maker and kile, on Linux, and \SpecialChar TeX
344 There are also the \SpecialChar LaTeX
345 modes for vi and emacs, of course.
350 These are basically text editors with the ability to run \SpecialChar LaTeX
352 errors in the file you're editing.
353 Although \SpecialChar LyX
362 run \SpecialChar LaTeX
363 , and it also indicates errors in the file, it also does much, much
365 For one thing, you don't need to know \SpecialChar LaTeX
366 to use \SpecialChar LyX
369 has added its own extensions to \SpecialChar LaTeX
371 Try the following sometime: select
372 \begin_inset Flex Noun
375 \begin_layout Plain Layout
376 Export\SpecialChar menuseparator
383 \begin_inset Flex Noun
386 \begin_layout Plain Layout
393 \begin_inset Flex Noun
396 \begin_layout Plain Layout
397 View\SpecialChar menuseparator
407 ), then look at the preamble of the resulting
408 \begin_inset Flex Code
411 \begin_layout Plain Layout
418 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
420 These macros are defined automatically, according to the features you use
424 \begin_layout Standard
425 There are several commands that automatically invoke \SpecialChar LaTeX
430 \begin_layout Itemize
431 \begin_inset Flex Noun
434 \begin_layout Plain Layout
435 Document\SpecialChar menuseparator
444 \begin_layout Itemize
445 \begin_inset Flex Noun
448 \begin_layout Plain Layout
449 Document\SpecialChar menuseparator
458 \begin_layout Standard
459 They will only invoke \SpecialChar LaTeX
460 if the file has changed since the last time \SpecialChar LaTeX
466 \begin_layout Standard
467 When \SpecialChar LyX
468 runs \SpecialChar LaTeX
469 on the file you're editing, it performs these steps:
472 \begin_layout Enumerate
473 Convert the document to \SpecialChar LaTeX
474 and save to a file with the extension
475 \begin_inset Flex Code
478 \begin_layout Plain Layout
485 \begin_inset Flex Code
488 \begin_layout Plain Layout
497 \begin_layout Enumerate
498 Run \SpecialChar LaTeX
500 \begin_inset Flex Code
503 \begin_layout Plain Layout
509 file (maybe several times), and run any other commands (such as
510 \begin_inset Flex Code
513 \begin_layout Plain Layout
520 \begin_inset Flex Code
523 \begin_layout Plain Layout
529 ) needed to compile the \SpecialChar LaTeX
533 \begin_layout Enumerate
534 If there are any errors, show the error log.
537 \begin_layout Standard
538 If you have run \SpecialChar LaTeX
540 \begin_inset Flex Noun
543 \begin_layout Plain Layout
544 View\SpecialChar menuseparator
551 then runs a DVI viewer to display the DVI-file.
553 \begin_inset Flex Noun
556 \begin_layout Plain Layout
557 View\SpecialChar menuseparator
564 performs further steps:
567 \begin_layout Enumerate
569 \begin_inset Flex Code
572 \begin_layout Plain Layout
578 to convert the DVI file to PostScript.
581 \begin_layout Enumerate
582 Run a PostScript viewer, such as
583 \begin_inset Flex Code
586 \begin_layout Plain Layout
592 , to display the PostScript file.
595 \begin_layout Standard
597 does similar things when viewing, or exporting, other formats.
600 \begin_layout Section
601 Translating \SpecialChar LaTeX
602 files into \SpecialChar LyX
606 \begin_layout Standard
607 You can import a \SpecialChar LaTeX
608 file into \SpecialChar LyX
610 \begin_inset Flex Noun
613 \begin_layout Plain Layout
614 File\SpecialChar menuseparator
615 Import\SpecialChar menuseparator
621 command in \SpecialChar LyX
623 This will call a program named
624 \begin_inset Flex Code
627 \begin_layout Plain Layout
633 which will create a file
634 \begin_inset Flex Code
637 \begin_layout Plain Layout
644 \begin_inset Flex Code
647 \begin_layout Plain Layout
655 will then open that file.
659 \begin_layout Plain Layout
660 \begin_inset Flex Code
663 \begin_layout Plain Layout
669 can also be run from the command line, of course.
677 \begin_layout Standard
678 \begin_inset Flex Code
681 \begin_layout Plain Layout
687 will translate most legal \SpecialChar LaTeX
688 , but not everything.
689 It will put things it doesn't understand into \SpecialChar TeX
690 code, so after translating
692 \begin_inset Flex Code
695 \begin_layout Plain Layout
701 , you can look for \SpecialChar TeX
702 code and hand-edit it until it looks right.
705 \begin_layout Standard
706 If you don't know what \SpecialChar TeX
707 code is, read the next section.
710 \begin_layout Section
711 \begin_inset CommandInset label
713 name "sec:Inserting-TeX-Code"
717 Inserting \SpecialChar TeX
718 Code into \SpecialChar LyX
722 \begin_layout Standard
723 Anything you can do in \SpecialChar LaTeX
724 you can do in \SpecialChar LyX
725 , for a very simple reason: You can
726 always insert \SpecialChar TeX
727 code into any \SpecialChar LyX
730 cannot, and will never be able to, display every possible \SpecialChar LaTeX
732 If ever you need to insert \SpecialChar LaTeX
733 commands into your \SpecialChar LyX
734 document, you can use the
736 \begin_inset Flex Code
739 \begin_layout Plain Layout
746 box, which you can insert into your document with
747 \begin_inset Flex Noun
750 \begin_layout Plain Layout
751 Insert\SpecialChar menuseparator
761 or the keyboard shortcut
770 \begin_layout Standard
771 Here's an example of inserting \SpecialChar LaTeX
772 commands in a \SpecialChar LyX
774 The code looks like this:
777 \begin_layout LyX-Code
781 \begin_inset Newline newline
787 \begin_inset Newline newline
790 This is an example of a minipage environment.
792 \begin_inset Newline newline
795 can put nearly everything in it, even (non-floating)
796 \begin_inset Newline newline
801 \begin_inset Newline newline
807 \begin_inset Newline newline
811 \begin_inset Newline newline
817 \begin_inset Newline newline
823 \begin_inset Newline newline
829 \begin_inset Newline newline
834 \begin_inset Newline newline
840 \begin_inset Newline newline
846 \begin_inset Newline newline
852 \begin_inset Newline newline
860 \begin_layout LyX-Code
864 \begin_layout Standard
866 \begin_inset Flex Code
869 \begin_layout Plain Layout
876 box containing this text is directly after this paragraph.
877 Those of you reading the manual in \SpecialChar LyX
878 will only see the \SpecialChar TeX
880 Those reading a printed version of the manuals will see the actual results:
881 \begin_inset VSpace bigskip
887 \begin_layout Standard
891 \begin_layout Plain Layout
898 \begin_layout Plain Layout
905 \begin_layout Plain Layout
907 This is an example of a minipage environment.
908 You can put nearly everything in it, even (non-floating) figures and tables.
912 \begin_layout Plain Layout
919 \begin_layout Plain Layout
924 \begin_layout Plain Layout
931 \begin_layout Plain Layout
938 \begin_layout Plain Layout
945 \begin_layout Plain Layout
951 \begin_layout Plain Layout
958 \begin_layout Plain Layout
965 \begin_layout Plain Layout
972 \begin_layout Plain Layout
982 \begin_inset VSpace bigskip
988 \begin_layout Standard
989 In addition to using \SpecialChar TeX
990 code, you can also create a separate file containing
991 some complex \SpecialChar LaTeX
992 structure and then use
993 \begin_inset Flex Noun
996 \begin_layout Plain Layout
997 Insert\SpecialChar menuseparator
1007 to include your file (you should select the type
1008 \begin_inset Flex Code
1011 \begin_layout Plain Layout
1018 We recommend that you only do this if you have a
1019 \begin_inset Flex Code
1022 \begin_layout Plain Layout
1033 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1037 \begin_layout Standard
1038 There are a few last points to emphasize:
1041 \begin_layout Itemize
1047 check if your \SpecialChar LaTeX
1051 \begin_layout Itemize
1052 Beware of reinventing the wheel.
1055 \begin_layout Standard
1056 On that last point, \SpecialChar LyX
1057 does have quite a few features tucked into it, and
1059 Be sure to check the manuals to make sure that \SpecialChar LyX
1060 doesn't have such-and-such
1061 feature before you decide you have to do it by hand.
1062 Moreover, there are numerous \SpecialChar LaTeX
1063 packages out there to do all sorts of things,
1064 from labels to envelopes to fancy multipage tables.
1066 \change_inserted 244031559 1603815732
1068 \begin_inset CommandInset href
1071 target "https://www.ctan.org/"
1077 \change_deleted 244031559 1603815732
1079 \begin_inset CommandInset href
1082 target "http://www.ctan.org/"
1092 \begin_layout Standard
1093 If you do need to do some wild and fancy things within your document, be
1094 sure to check out a good \SpecialChar LaTeX
1095 book for assistance.
1096 There are a number of them listed in the bibliography of the
1103 \begin_layout Section
1105 and the \SpecialChar LaTeX
1109 \begin_layout Subsection
1110 About the \SpecialChar LaTeX
1114 \begin_layout Standard
1115 If you already know \SpecialChar LaTeX
1116 , there is no need to explain here what the preamble
1118 If you don't, the following will give you some ideas—we recommend again
1119 that you consult a \SpecialChar LaTeX
1120 book for further information.
1121 In any case, you should read the points below, because they explain what
1122 you can do and what you don't need to do in the \SpecialChar LaTeX
1123 preamble of a \SpecialChar LyX
1127 \begin_layout Standard
1128 The \SpecialChar LaTeX
1129 preamble comes at the very beginning of a document,
1137 \begin_layout Itemize
1138 Declare the document class.
1140 \begin_inset Newline newline
1144 already does this for you.
1145 If you're a seasoned \SpecialChar LaTeX
1146 -nician, and you have a custom document class you
1147 want to use, check out the
1149 Customization Manual
1151 for information on how to make \SpecialChar LyX
1155 \begin_layout Itemize
1156 Declare the usage of packages.
1158 \begin_inset Newline newline
1162 packages provide special commands, which are only available within a document
1163 when the package has been declared in the preamble.
1164 In addition to providing special commands, the inclusion of a package can
1165 change the document.
1166 For example, the package
1167 \begin_inset Flex Code
1170 \begin_layout Plain Layout
1176 forces all paragraphs to be indented.
1177 There are other packages for labels, envelopes, margins, etc.
1181 \begin_layout Itemize
1182 Set counters, variables, lengths and widths.
1184 \begin_inset Newline newline
1187 There are several \SpecialChar LaTeX
1188 counters and variables that
1192 be set globally from within the preamble in order to have the desired effect.
1193 (There are variables that you can set and reset inside the document, too.)
1194 Margins are a good example of something that must be set in the preamble.
1195 Another example is the label format for lists.
1196 You can actually set these just about anywhere, but it's best to do it
1197 just once, inside the preamble.
1200 \begin_layout Itemize
1201 Declare user defined commands (with
1202 \begin_inset Flex Code
1205 \begin_layout Plain Layout
1214 \begin_inset Flex Code
1217 \begin_layout Plain Layout
1226 \begin_inset Newline newline
1229 These are abbreviations for \SpecialChar LaTeX
1230 commands which appear very often inside a document.
1231 Although the preamble is a good place to declare such commands, they
1235 be declared anywhere (before they are used for the first time, of course).
1236 This can be useful if there is a lot of raw \SpecialChar LaTeX
1237 code in your document, which
1238 normally should not be the case.
1241 \begin_layout Standard
1243 adds its own set of definitions to the preamble of the
1244 \begin_inset Flex Code
1247 \begin_layout Plain Layout
1254 This makes \SpecialChar LaTeX
1255 files generated by \SpecialChar LyX
1259 \begin_layout Subsection
1260 Changing the Preamble
1263 \begin_layout Standard
1264 The commands which \SpecialChar LyX
1265 adds to the preamble of a \SpecialChar LaTeX
1266 file are fixed; you can't
1267 change them without patching \SpecialChar LyX
1269 You can, however, add your own stuff to the preamble by selecting
1270 \begin_inset Flex Noun
1273 \begin_layout Plain Layout
1276 \begin_inset space ~
1285 \begin_inset Flex Noun
1288 \begin_layout Plain Layout
1289 Document\SpecialChar menuseparator
1297 adds anything in the
1298 \begin_inset Flex Noun
1301 \begin_layout Plain Layout
1307 dialog to its own built-in preamble.
1308 Before adding your own declarations in the preamble, you should make sure
1309 that \SpecialChar LyX
1310 doesn't already support what you want to do.
1311 (Remember what we said about reinventing the wheel?) Also,
1313 make sure your preamble code is correct
1317 doesn't check it for you.
1318 If there is an error, you're likely to get an error like
1319 \begin_inset Quotes eld
1323 \begin_inset Flex Code
1326 \begin_layout Plain Layout
1335 \begin_inset Quotes erd
1339 If you see this error, check your preamble.
1342 \begin_layout Subsection
1346 \begin_layout Standard
1347 Here are some examples of what you can add to a preamble, and what they
1351 \begin_layout Subsubsection
1355 \begin_layout Standard
1356 There are two variables under \SpecialChar LaTeX
1357 that control page position:
1358 \begin_inset Flex Code
1361 \begin_layout Plain Layout
1370 \begin_inset Flex Code
1373 \begin_layout Plain Layout
1382 Their names should be self-explanatory.
1383 These variables are useful if you think for a moment about computer labels.
1384 Sometimes, the size of a print medium and the area of the medium that you
1385 can actually print on aren't the same.
1387 \begin_inset Flex Code
1390 \begin_layout Plain Layout
1399 \begin_inset Flex Code
1402 \begin_layout Plain Layout
1413 \begin_layout Standard
1414 The default values for
1415 \begin_inset Flex Code
1418 \begin_layout Plain Layout
1427 \begin_inset Flex Code
1430 \begin_layout Plain Layout
1439 \begin_inset space \thinspace{}
1443 \begin_inset space \thinspace{}
1447 \begin_inset space \space{}
1450 the page isn't shifted.
1451 Unfortunately, some DVI drivers always seem to shift the page.
1452 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1453 If you're using \SpecialChar LyX
1454 on a system that you don't personally maintain, and your
1455 sysadmin is a doofus,
1456 \begin_inset Flex Code
1459 \begin_layout Plain Layout
1468 \begin_inset Flex Code
1471 \begin_layout Plain Layout
1480 Suppose your left and top margins are always 0.5
1481 \begin_inset space \thinspace{}
1485 You can add this to the preamble:
1488 \begin_layout LyX-Code
1496 \begin_layout LyX-Code
1504 \begin_layout Standard
1505 and your margins should now be correct.
1508 \begin_layout Subsubsection
1512 \begin_layout Standard
1513 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1514 There's a rather nice package, available at your nearest CTAN archive,
1515 for printing sheets of labels:
1516 \begin_inset Flex Code
1519 \begin_layout Plain Layout
1526 Now, your system may not have this package installed by default.
1527 We leave that up to you to check.
1528 You'll also want to read the documentation for it; we're not going to do
1530 Since this is an example, however, we'll give you an example of how you
1534 \begin_layout Standard
1535 First, make sure you're using the
1536 \begin_inset Flex Code
1539 \begin_layout Plain Layout
1546 Next, you need to put the following in your preamble:
1549 \begin_layout LyX-Code
1555 \begin_layout LyX-Code
1561 \begin_layout LyX-Code
1567 \begin_layout LyX-Code
1573 \begin_layout LyX-Code
1579 \begin_layout LyX-Code
1585 \begin_layout LyX-Code
1591 \begin_layout Standard
1592 This sets things up for Avery label sheets, stock #5360.
1593 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1596 \begin_inset Flex Code
1599 \begin_layout Plain Layout
1608 \begin_inset Flex Code
1611 \begin_layout Plain Layout
1619 around each label text.
1620 This and other special features of
1621 \begin_inset Flex Code
1624 \begin_layout Plain Layout
1630 are explained in its documentation.
1633 \begin_layout Standard
1634 Someday, someone may write a \SpecialChar LyX
1635 layout file to support this package directly.
1636 Maybe that someone is you.
1639 \begin_layout Subsubsection
1640 Example #3: Paragraph Indentation
1643 \begin_layout Standard
1644 Americans are trained to indent the first line of
1649 As with all of their other weird quirks, most Americans will whine and
1650 moan until they can have their way and indent the first line of all paragraphs.
1659 \begin_layout Standard
1660 Of course, this behavior isn't standard typography.
1661 In books, you typically only indent the first line of a paragraph
1665 it follows another one.
1666 The idea behind indenting the first line of a paragraph is to distinguish
1667 neighboring paragraphs from one another.
1668 If there is no previous paragraph—for example, if it follows a figure or
1669 is the first paragraph in a section—then there is no need for indentation.
1673 \begin_layout Standard
1674 If you're a typical American (we're still joking!), though, you don't care
1675 about such esoteric things; you want your indentation! Add this to the
1679 \begin_layout LyX-Code
1682 usepackage{indentfirst}
1685 \begin_layout Standard
1686 If your \SpecialChar TeX
1687 distribution isn't braindead, you'll have this package, and all
1688 of your paragraphs will get the indentation the Founding Fathers intended
1692 \begin_layout Subsubsection
1693 Example #4: This Document
1696 \begin_layout Standard
1697 You can also check out the preamble of this document to get an idea of some
1698 of the advanced things you can do.
1701 \begin_layout Section
1703 and \SpecialChar LaTeX
1707 \begin_layout Standard
1708 When \SpecialChar LyX
1709 calls \SpecialChar LaTeX
1710 , it tells \SpecialChar LaTeX
1711 to blithely ignore any errors and keep going.
1712 It then uses the logfile from the \SpecialChar LaTeX
1713 run to do a post-mortem.
1714 After analyzing the logfile, \SpecialChar LyX
1715 displays a dialog listing the errors.
1716 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1718 where the error occurred.
1722 \begin_layout Plain Layout
1724 Analyzing the logfile is a tough job, and \SpecialChar LyX
1725 doesn't always go to the right
1727 There are also cases where \SpecialChar LaTeX
1728 reports the error on one line, but the actual
1730 This is not unlike forgetting a closing brace in a program: You'll get
1731 an error, but only later.
1739 \begin_layout Standard
1740 Some folks also like to look at the log file directly: It is available from
1742 \begin_inset Flex Noun
1745 \begin_layout Plain Layout
1746 Document\SpecialChar menuseparator
1748 \begin_inset space ~
1757 There are some fairly common error messages and warnings.
1758 We'll cover those here.
1759 You should look at a good \SpecialChar LaTeX
1760 book for a complete listing.
1763 \begin_layout Itemize
1764 \begin_inset Flex Code
1767 \begin_layout Plain Layout
1774 \begin_inset Newline newline
1777 Anything beginning with these words is a warning message for the purpose
1779 \begin_inset Quotes eld
1783 \begin_inset Quotes erd
1786 the \SpecialChar LaTeX
1788 You'll get messages like this if you added or changed cross-references
1789 or bibliography entries, in which case, \SpecialChar LaTeX
1790 is trying to tell you that you
1791 need to make another run.
1792 You can by-and-large ignore these.
1795 \begin_layout Itemize
1796 \begin_inset Flex Code
1799 \begin_layout Plain Layout
1806 \begin_inset Newline newline
1809 Another warning message, this time about fonts which \SpecialChar LaTeX
1811 The rest of the message will often say something about a replacement font
1812 that \SpecialChar LaTeX
1814 You can safely ignore these, too.
1817 \begin_layout Itemize
1818 \begin_inset Flex Code
1821 \begin_layout Plain Layout
1830 \begin_inset Newline newline
1839 It seems to generate at least one of these messages for just about any
1841 They are warnings about lines that were too long and run past the right
1843 This happens if \SpecialChar LaTeX
1844 does not find a reasonable way to break the lines (notoriously
1845 often with typewriter font, since this does not allow for automatic break
1847 In many cases, this is unnoticeable in the final output.
1848 (It can be just a point or two.) Sometimes, however, the lines run rather
1849 visibly into the margin; something you will not want to have in your final
1852 \begin_inset Newline newline
1855 There are several global ways to try to minimize the overfull lines.
1858 Enable micro-typographic extensions
1862 Document\SpecialChar menuseparator
1863 Settings\SpecialChar menuseparator
1866 might already improve things a lot.
1867 Furthermore, \SpecialChar LaTeX
1868 code such as the following in
1870 Document\SpecialChar menuseparator
1871 Settings\SpecialChar menuseparator
1874 usually reduces the overfull lines drastically (we use this in the preamble
1879 \begin_layout LyX-Code
1883 \begin_inset Newline newline
1889 \begin_inset Newline newline
1894 emergencystretch 1.5em
1895 \begin_inset Newline newline
1903 \begin_layout Standard
1904 In some cases, however, you eventually have to rewrite the text to get the
1905 line breaking right.
1909 \begin_layout Plain Layout
1910 For more information, see
1911 \begin_inset Flex URL
1914 \begin_layout Plain Layout
1916 http://www.tex.ac.uk/FAQ-overfull.html
1929 \begin_layout Standard
1930 In any case, you should check the respective lines, at least for the final
1931 version of your document.
1932 Your eyes will tell you if there's a problem with something that's too
1937 \begin_layout Plain Layout
1938 You can also enable the `draft' option in
1939 \begin_inset Flex Noun
1942 \begin_layout Plain Layout
1943 Document\SpecialChar menuseparator
1949 , and then \SpecialChar LaTeX
1950 will draw a black box in the margin of lines that are overfull.
1959 \begin_layout Itemize
1960 \begin_inset Flex Code
1963 \begin_layout Plain Layout
1972 \begin_inset Newline newline
1975 Not quite as common as its cousin.
1976 This happens again if \SpecialChar LaTeX
1977 does not find a reasonable break point and consequently
1978 generates too loose lines.
1979 As with the overfull lines, you should check if this is a visible problem.
1982 \begin_layout Itemize
1983 \begin_inset Flex Code
1986 \begin_layout Plain Layout
1995 \begin_inset Flex Code
1998 \begin_layout Plain Layout
2007 \begin_inset Newline newline
2010 Warnings about troubles breaking the page.
2011 Once again, just look at the output.
2012 Your eyes will tell you where something has gone wrong.
2015 \begin_layout Itemize
2016 \begin_inset Flex Code
2019 \begin_layout Plain Layout
2021 \begin_inset Quotes els
2025 \begin_inset Quotes ers
2034 \begin_inset Newline newline
2038 \begin_inset Quotes eld
2042 \begin_inset Quotes erd
2045 isn't installed on this system.
2046 This usually appears because some package your document needs isn't installed.
2047 If you didn't touch the preamble or didn't use the
2048 \begin_inset Flex Code
2051 \begin_layout Plain Layout
2059 command, then one of the packages \SpecialChar LyX
2060 tried to load is missing.
2062 \begin_inset Flex Noun
2065 \begin_layout Plain Layout
2066 Help\SpecialChar menuseparator
2073 to get a list of packages that \SpecialChar LyX
2075 This file is updated whenever you reconfigure \SpecialChar LyX
2077 \begin_inset Flex Noun
2080 \begin_layout Plain Layout
2081 Tools\SpecialChar menuseparator
2087 ) and tells you which packages have been detected and what they do.
2088 \begin_inset Newline newline
2092 \begin_inset Flex Code
2095 \begin_layout Plain Layout
2103 command and the package in question isn't installed, then you'll need to
2104 install it yourself.
2107 \begin_layout Itemize
2108 \begin_inset Flex Code
2111 \begin_layout Plain Layout
2112 LaTeX Error: Unknown option
2118 \begin_inset Newline newline
2121 Error messages beginning with this are trying to tell you that you specified
2122 a bad or undefined option to a package.
2123 Check the package's documentation.
2126 \begin_layout Itemize
2127 \begin_inset Flex Code
2130 \begin_layout Plain Layout
2131 Undefined control sequence
2137 \begin_inset Newline newline
2140 If you've inserted \SpecialChar LaTeX
2141 code into your document, but made a typo, you'll get
2143 You may have forgotten to load a package.
2144 In any case, this error message usually means that you used an undefined
2149 \begin_layout Standard
2150 There are other error and warning messages.
2151 Some are self-explanatory.
2152 These are usually \SpecialChar LaTeX
2154 Others are downright cryptic.
2155 These are usually \SpecialChar TeX
2156 error messages, and we really have
2160 what they mean or how to decipher them.
2164 \begin_layout Standard
2165 There's a general sequence you should follow if you get error messages:
2168 \begin_layout Enumerate
2169 Look at the \SpecialChar LaTeX
2170 code you inserted for typos.
2173 \begin_layout Enumerate
2174 If there are no typos, check that you used the command(s) correctly.
2177 \begin_layout Enumerate
2178 If you get a bunch of error boxes piled up at the very top of the document—and
2179 especially if you see a
2180 \begin_inset Quotes eld
2184 \begin_inset Flex Code
2187 \begin_layout Plain Layout
2196 \begin_inset Quotes erd
2199 error—it means that there are errors in the preamble.
2200 Start debugging your preamble.
2203 \begin_layout Enumerate
2204 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2206 document, the first suspect is your \SpecialChar LaTeX
2207 distribution itself.
2208 Check for missing packages and install them.
2211 \begin_layout Enumerate
2212 Okay, so there are no missing packages.
2213 Did you use any of the fine-tuning options in \SpecialChar LyX
2214 ? Specifically, did you
2218 any of them, like trying to manually insert lots of
2219 \begin_inset Flex Code
2222 \begin_layout Plain Layout
2224 \change_deleted 177693 1654669036
2226 \change_inserted 177693 1654669038
2230 \begin_inset space ~
2234 \change_deleted 177693 1654669040
2236 \change_inserted 177693 1654669041
2245 \begin_inset Flex Code
2248 \begin_layout Plain Layout
2255 \begin_inset Flex Code
2258 \begin_layout Plain Layout
2264 ? Did you try to kludge something together with these instead of using the
2265 appropriate paragraph environment?
2268 \begin_layout Enumerate
2269 All right, you didn't use any of the fine-tuning options, you played by
2271 Did you try to pull a fancy maneuver? Did you do something funky inside
2272 a table or an equation, like inserting a graphic into a table cell?
2275 \begin_layout Enumerate
2276 Do you have long sections of text where \SpecialChar LaTeX
2277 cannot find a place to break a
2278 line? By default, \SpecialChar LaTeX
2279 is rather strict about how much extra inter-word spacing
2280 it will add in order to break a line.
2281 Preferably, you should rework the paragraph to avoid the problem.
2284 \begin_layout Enumerate
2285 Did you go overboard with the nesting? \SpecialChar LyX
2286 (currently) doesn't check to make
2287 sure you're in the limits for nesting environments.
2288 If you nested a bunch of environments to the
2289 \begin_inset Formula $17^{\mathrm{th}}$
2292 level, that's the problem.
2293 (The limit in \SpecialChar LaTeX
2297 \begin_layout Enumerate
2298 Okay, you didn't get any error messages, but your output looks awful.
2299 If you have a table or figure that's too wide or long for the page, you
2304 \begin_layout Enumerate
2305 rescale the figure so it fits.
2308 \begin_layout Enumerate
2309 trim down the table so it fits.
2313 \begin_layout Enumerate
2314 If something else is wrong with the output, and you didn't try to pull anything
2315 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2318 \begin_layout Standard
2319 If all this doesn't help—well, then
2323 you might have found a bug in \SpecialChar LyX
2328 \begin_layout Chapter
2330 \change_inserted 564990737 1670439508
2334 \begin_layout Section
2336 \change_inserted 564990737 1670439533
2337 \begin_inset CommandInset label
2339 name "sec:Collections"
2346 \begin_layout Subsection
2347 AMS \SpecialChar LaTeX
2351 \begin_layout Standard
2358 Richard Kimberly Heck
2361 \begin_layout Standard
2362 \begin_inset VSpace bigskip
2368 \begin_layout Standard
2370 The AMS \SpecialChar LaTeX
2371 layouts are set up to conform to suggested styles for mathematical
2372 papers to be submitted to American Mathematical Society publications.
2373 The layouts are not tailored to a specific journal, but easily can be.
2374 You should refer to the AMS documentation for specific instructions for
2375 each journal (usually it will entail only changing a single line in the
2378 That documentation is available on the Web at
2379 \begin_inset Flex URL
2382 \begin_layout Plain Layout
2390 \begin_inset Flex URL
2393 \begin_layout Plain Layout
2395 ftp://ftp.ams.org/pub/tex/amslatex/
2401 These layouts are appropriate, and useful, for any mathematical writing.
2405 \begin_layout Standard
2406 There are two basic AMS \SpecialChar LaTeX
2410 \begin_layout Itemize
2411 amsart: The standard AMS article format.
2414 \begin_layout Itemize
2415 amsbook: the standard AMS book (really, monograph) format.
2419 \begin_layout Standard
2420 The layouts themselves contain only the minimum necessary to use the AMS
2422 They do not, in particular, contain any of the `theorem' environments used
2423 for setting theorems, lemmas, and the like.
2424 These are contained, instead, in the
2425 \begin_inset Flex Code
2428 \begin_layout Plain Layout
2434 module, which is loaded by default when you select one of the AMS classes.
2435 (It can also be used with other classes and can be removed, if you would
2436 rather use something else.) Less commonly used environments are in the
2437 \begin_inset Flex Code
2440 \begin_layout Plain Layout
2441 Theorems (AMS-Extended)
2446 module, which must be loaded manually.
2449 \begin_layout Standard
2450 By default, theorems and the like are numbered consecutively throughout
2451 the document, but this may be modified by loading the module
2452 \begin_inset Flex Code
2455 \begin_layout Plain Layout
2456 Theorems (Order by Section)
2461 or, if you are using
2462 \begin_inset Flex Code
2465 \begin_layout Plain Layout
2472 \begin_inset Flex Code
2475 \begin_layout Plain Layout
2476 Theorems (Order by Chapter)
2482 These will number the results as
2483 \begin_inset Formula $n.m$
2486 , where the first number refers to the section (or chapter) and the second
2487 refers to the total number of results so far in that section (or chapter).
2488 Many environments are also available unnumbered.
2489 These are indicated by an asterisk at the end.
2490 If you happen to want
2494 unnumbered results, the module
2495 \begin_inset Flex Code
2498 \begin_layout Plain Layout
2504 provides that option.
2507 \begin_layout Standard
2508 Note that these modules do not
2512 to be used with the AMS classes.
2513 It is perfectly possible to use the
2514 \begin_inset Flex Code
2517 \begin_layout Plain Layout
2523 module, and the others mentioned, with other classes, such as
2524 \begin_inset Flex Code
2527 \begin_layout Plain Layout
2534 \begin_inset Flex Code
2537 \begin_layout Plain Layout
2544 \begin_inset Flex Code
2547 \begin_layout Plain Layout
2556 \begin_layout Subsubsection
2557 What these layouts provide
2560 \begin_layout Standard
2561 There is a long list of included environments provided by these layouts.
2562 In AMS-\SpecialChar LaTeX
2563 , there is, in fact, an opportunity to define an unlimited variety
2564 of `theorem' environments.
2565 However, the AMS recommends the environments that are available in \SpecialChar LyX
2570 \begin_layout Standard
2571 The following environments—as well as the standard environments, such as
2573 \begin_inset Flex Noun
2576 \begin_layout Plain Layout
2583 \begin_inset Flex Noun
2586 \begin_layout Plain Layout
2593 \begin_inset Flex Noun
2596 \begin_layout Plain Layout
2603 \begin_inset Flex Noun
2606 \begin_layout Plain Layout
2613 \begin_inset Flex Noun
2616 \begin_layout Plain Layout
2623 \begin_inset Flex Code
2626 \begin_layout Plain Layout
2633 \begin_inset Flex Code
2636 \begin_layout Plain Layout
2645 \begin_layout Description
2646 Address This should be the author's permanent address.
2649 \begin_layout Description
2651 \begin_inset space ~
2654 Address This should be the author's temporary address at the time of submission,
2655 if different from the Address.
2658 \begin_layout Description
2659 Email Author's e-mail address
2662 \begin_layout Description
2663 URL Author's Web address, if desired.
2666 \begin_layout Description
2667 Keywords Key words or phrases used to identify specific topics discussed
2671 \begin_layout Description
2672 Subjectclass These refer to the AMS Subject Classifications, published and
2675 Mathematical Reviews
2678 These are also available online at the AMS cites listed above.
2681 \begin_layout Description
2685 \begin_layout Description
2689 \begin_layout Description
2693 \begin_layout Standard
2694 The following environments are provided by both the
2695 \begin_inset Flex Code
2698 \begin_layout Plain Layout
2705 \begin_inset Flex Code
2708 \begin_layout Plain Layout
2714 modules, in the latter case in both starred (unnumbered) and unstarred
2715 (numbered) versions.
2716 These same environments are provided only in the starred versions by the
2718 \begin_inset Flex Code
2721 \begin_layout Plain Layout
2730 \begin_layout Theorem
2731 This is typically used for the statements of major results.
2735 \begin_layout Corollary*
2736 This is used for statements which follow fairly directly from previous statement
2738 Again, these can be major results.
2743 These are smaller results needed to prove other statements.
2746 \begin_layout Proposition
2747 These are less major results which (hopefully) add to the general theory
2751 \begin_layout Conjecture
2752 These are statements provided without justification, which the author does
2753 not know how to prove, but which seem to be true (to the author, at least).
2756 \begin_layout Definition*
2757 Guess what this is for.
2758 The font is different for this environment than for the previous ones.
2762 \begin_layout Example*
2763 Used for examples illustrating proven results.
2766 \begin_layout Problem
2767 It's not really known what this is for.
2768 You should figure it out.
2771 \begin_layout Exercise*
2772 Write a description for this one.
2775 \begin_layout Remark
2776 This environment is also a type of theorem, usually a lesser sort of observation.
2779 \begin_layout Claim*
2780 Often used in the course of giving a proof of a larger result.
2784 Generally, these are used to break up long arguments, using specific instances
2790 The numbering scheme for cases is on its own, not together with other numbered
2796 At the end of this environment, a QED symbol (usually a square, but it can
2797 vary with different styles) is placed.
2798 If you want to have other environments within this one—for example, Case
2799 environments—and have the QED symbol appear only after them, then the other
2800 environments need to be nested within the proof environment.
2803 Nesting Environments
2809 for information on nesting.
2812 \begin_layout Standard
2813 And these environments are provided by
2814 \begin_inset Flex Code
2817 \begin_layout Plain Layout
2818 Theorems (AMS-Extended)
2826 \begin_layout Criterion*
2827 A required condition.
2830 \begin_layout Algorithm*
2831 A general procedure to be used.
2834 \begin_layout Axiom*
2835 This is a property or statement taken as true within the system being discussed.
2838 \begin_layout Condition*
2839 Sometimes used to state a condition assumed within the present context of
2844 Similar to a Remark.
2847 \begin_layout Notation*
2848 Used for the explanation of, yes, notation.
2851 \begin_layout Summary
2852 Do we really need to tell you?
2855 \begin_layout Acknowledgement*
2859 \begin_layout Conclusion*
2860 Sometimes used at the end of a long train of argument.
2864 Used in a way similar to Proposition, though perhaps lower on the scale.
2867 \begin_layout Standard
2868 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
2871 They need to be available on your system in order to use these environments.
2874 \begin_layout Subsection
2876 \change_inserted 564990737 1671383236
2879 \begin_inset CommandInset label
2881 name "subsec:Extra-font-sizes"
2888 \begin_layout Standard
2890 \change_inserted 564990737 1671383236
2893 The “Extra font sizes” collection provides the document classes
2896 \begin_inset space \thinspace{}
2899 (with extra font sizes)
2904 \begin_inset space \thinspace{}
2907 (with extra font sizes)
2912 \begin_inset space \thinspace{}
2915 (with extra font sizes)
2920 \begin_inset space \thinspace{}
2923 (with extra font sizes)
2941 document classes respectively but offer the additional
2947 \begin_inset space ~
2952 options 8, 9, 14, 17 and 20 in the
2957 ocument\SpecialChar menuseparator
2962 ettings\SpecialChar menuseparator
2968 \begin_layout Subsection
2970 \change_inserted 564990737 1671383236
2976 \begin_layout Standard
2978 \change_inserted 564990737 1671383236
2981 The document classes
2984 \begin_inset space \thinspace{}
2992 \begin_inset space \thinspace{}
3007 document classes to facilitate the use of Hebrew in \SpecialChar LyX
3011 \begin_layout Subsection
3013 \change_inserted 564990737 1671383236
3016 \begin_inset CommandInset label
3018 name "subsec:Japanese"
3025 \begin_layout Standard
3027 \change_inserted 564990737 1671383236
3030 The document classes
3033 \begin_inset space \thinspace{}
3041 \begin_inset space \thinspace{}
3044 (Japanese Standard Class Vertical Writing)
3049 \begin_inset space \thinspace{}
3052 (Japanese Standard Class)
3057 \begin_inset space \thinspace{}
3065 \begin_inset space \thinspace{}
3068 (Japanese Standard Class Vertical Writing)
3073 \begin_inset space \thinspace{}
3076 (Japanese Standard Class)
3081 \begin_inset space \thinspace{}
3084 (Japanese Vertical Writing)
3089 \begin_inset space \thinspace{}
3092 (Japanese Standard Class)
3094 provide document classes for the Japanese language.
3097 \begin_layout Subsection
3101 \begin_layout Standard
3107 \begin_layout Subsubsection
3111 \begin_layout Standard
3112 The \SpecialChar LyX
3115 article (koma-script)
3119 report (koma-script)
3137 correspond to the \SpecialChar LaTeX
3155 \begin_inset space ~
3158 of the Koma-Script family.
3159 They are replacements for the standard document classes
3175 , resp., and fit better to European typography conventions in a number of
3179 \begin_layout Itemize
3180 Standard character size is 11pt in
3182 article (koma-script)
3186 report (koma-script)
3194 letter (koma-script)
3199 \begin_layout Itemize
3200 Headings, labels of the description environment, and a number of elements
3203 letter (koma-script)
3205 document class are set in a bold sans serif font.
3209 \begin_layout Plain Layout
3210 There is a big difference between the bold sans serif old cm fonts and new
3211 ec fonts, especially in the appearance of headings.
3212 In comparison, the ec bold sans serif fonts look a bit thin.
3213 Here the \SpecialChar LaTeX
3222 helps to produce the
3223 \begin_inset Quotes eld
3227 \begin_inset Quotes erd
3230 appearance when using the ec fonts.
3235 The numbering of chapter headings is made in the same way as the numbering
3236 of section headings, that is without the extra line
3237 \begin_inset Quotes eld
3240 Chapter\SpecialChar ldots
3242 \begin_inset Quotes erd
3246 In addition, the appearance of the headings can be modified by using a
3247 number of options (in \SpecialChar LyX
3248 to be entered in the field
3251 \begin_inset space ~
3258 Layout\SpecialChar menuseparator
3265 \begin_layout Itemize
3266 The main means in the Koma-Script document classes to design the type area
3275 (in \SpecialChar LyX
3276 to be entered in the extra class options field in the dialog
3278 Document\SpecialChar menuseparator
3282 They make a clearer modification of page margins possible as do the options
3285 Document\SpecialChar menuseparator
3292 \begin_layout Itemize
3293 The \SpecialChar LaTeX
3294 document classes of the Koma-Script family define a number of additional
3296 Those part of it which makes sense in \SpecialChar LyX
3297 is implemented in corresponding
3301 \begin_layout Standard
3302 Detailed descriptions of the \SpecialChar LaTeX
3303 document classes of the Koma-Script family
3304 can be found in the Koma-Script documentation
3315 \begin_layout Subsubsection
3316 article (koma-script), report (koma-script), and book (koma-script)
3319 \begin_layout Standard
3320 The document classes
3322 article (koma-script)
3326 report (koma-script)
3336 are implemented in the layout files
3349 They contain all the paragraph types of the corresponding standard document
3362 , resp., partly modified, with the exception of the \SpecialChar LyX
3367 -type, which is replaced by the new
3371 -type having the same functionality.
3376 -Type there is a number of new paragraph types added.
3383 letter (koma-script)
3388 \begin_layout Itemize
3397 : are equivalents to
3405 , resp., additionally inserting an entry in the table of contents.
3414 are not contained in
3416 article (koma-script)
3421 \begin_layout Itemize
3438 , resp., additionally clearing running heads.
3445 article (koma-script)
3451 \begin_layout Plain Layout
3464 report (koma-script)
3466 , but since this is identical to
3470 , is has not been implemented in \SpecialChar LyX
3479 \begin_layout Itemize
3484 : generates a heading directly above the following paragraph in the standard
3485 character size without affecting the structure of the document.
3488 \begin_layout Itemize
3497 are special captions which respect the different space settings needed
3498 for captions placed above or below an element (if you follow strict typographic
3499 rules, you might want to place table captions always above the table).
3500 You can also use the class option
3517 You need at least Koma-Script version 2.8q to use this.
3520 \begin_layout Itemize
3525 : can be used to set a bonmot, e.
3526 \begin_inset space \thinspace{}
3530 \begin_inset space \space{}
3533 at the beginning of a chapter.
3534 If you use the optional argument (
3536 Insert\SpecialChar menuseparator
3538 \begin_inset space ~
3543 ), you can insert the dictum's author there.
3544 Dictum and author are separated by a line.
3545 You need at least Koma-Script version 2.8q to use this.
3552 article (koma-script)
3557 \begin_layout Standard
3558 The following types, together with the standard types
3570 , form the title area of the document.
3571 They must be entered ahead of the first
3572 \begin_inset Quotes eld
3576 \begin_inset Quotes erd
3583 \begin_layout Plain Layout
3584 The corresponding \SpecialChar LaTeX
3585 commands must appear before the
3596 When such a type is used more than once, the latter usage overwrites the
3597 former one, that means, for every type only the latest usage is valid.
3598 The order of the different types however has, like
3610 , no effect on the appearance of the produced document.
3613 \begin_layout Itemize
3618 : produces a centered paragraph above the ordinary title (
3630 ) for the subject of the document.
3633 \begin_layout Itemize
3638 : produces a centered paragraph below the ordinary title (
3650 ) for the publishers' name.
3653 \begin_layout Itemize
3660 report (koma-script)
3666 produces a centered paragraph on its own page behind the title page, or
3669 article (koma-script)
3671 produces a centered paragraph below the ordinary title (
3690 \begin_layout Itemize
3695 : produces a left aligned paragraph above the ordinary title (
3711 ) for a document`s head.
3714 \begin_layout Itemize
3719 : produces in a double-sided print in
3721 report (koma-script)
3727 a left-aligned paragraph at the top of the title page`s back or has no
3728 effect in a single-sided print or in
3730 article (koma-script)
3735 \begin_layout Itemize
3740 : produces in a double-sided print in
3742 report (koma-script)
3748 a left-aligned paragraph at the bottom of the title page`s back or has
3749 no effect in a single-sided print or in
3751 article (koma-script)
3756 \begin_layout Itemize
3761 : produces a special
3762 \begin_inset Quotes eld
3766 \begin_inset Quotes erd
3769 page ahead of the actual document containing a paragraph without special
3773 \begin_layout Standard
3774 The layout files for the document classes
3776 article (koma-script)
3780 report (koma-script)
3791 This is thought of as a place to define your own types.
3796 in your personal layout directory and edit the file!
3799 \begin_layout Subsubsection
3800 letter (koma-script)
3803 \begin_layout Description
3804 Note: This section discusses the obsolete
3806 KOMA-Script-Letter (v.
3807 \begin_inset space ~
3812 , which is not even included anymore in recent KOMA releases.
3813 Please refer to the next section for the current KOMA-Script-Letter class
3815 \begin_inset space ~
3821 \begin_layout Standard
3825 letter (koma-script)
3827 is implemented in the layout file
3832 It contains all the paragraph types of the corresponding standard document
3837 , partly modified, with the exception of the \SpecialChar LyX
3851 type, which is replaced by the new
3856 In addition, it contains, in contrast to the standard document class, the
3875 Furthermore, there are a number of new letter specific types.
3878 \begin_layout Standard
3879 The appearance of the letter produced by this document class can be controlled
3880 by a number of \SpecialChar LaTeX
3881 commands, which you can put in the \SpecialChar LaTeX
3886 \begin_layout Plain Layout
3887 For example, the standard appearance of the letter`s heading, consisting
3888 of name and address, is quite self-willed.
3890 \begin_inset Quotes eld
3894 \begin_inset Quotes erd
3897 heading is produced by the following \SpecialChar LaTeX
3898 commands in the preamble:
3901 \begin_layout LyX-Code
3911 \begin_layout LyX-Code
3927 \begin_layout LyX-Code
3937 \begin_layout LyX-Code
3957 A detailed German description of such \SpecialChar LaTeX
3958 commands can be found in the Koma-Script
3964 With it, the letter's author can produce his personal letter layout.
3967 \begin_layout Standard
3976 define the beginning of the letter and must be used in every letter.
3977 To emphasize them in the \SpecialChar LyX
3978 document class, they are marked with the letter
3988 \begin_inset space ~
3992 It is possible to write any number of letters in one file.
3997 type produces a new letter using the same addressee and a
4001 type produces a new addressee.
4018 are ordinary paragraph types and can also be used several times in one
4019 and the same letter.
4022 \begin_layout Itemize
4027 : produces a paragraph for the addressee and implicitly defines the beginning
4031 \begin_layout Itemize
4036 : produces a paragraph for the form of address and implicitly produces a
4040 \begin_layout Itemize
4045 : produces a paragraph for a close.
4048 \begin_layout Itemize
4053 : produces a paragraph for a postscript.
4056 \begin_layout Itemize
4061 : produces a paragraph for a distribution list.
4064 \begin_layout Itemize
4069 : produces a paragraph for enclosures.
4072 \begin_layout Standard
4113 are input types provided with a label to enter information, which will
4114 be processed by the document class.
4118 \begin_layout Plain Layout
4119 It could be seen as a matter of inconsequence, that the types
4127 described above are not such input types as well.
4128 Because of the special meaning of those types, however, I have implemented
4129 them as ordinary paragraph types with a one letter mark in the left margin.
4130 Moreover, it would affect my feeling of symmetry, if the
4138 type had such a serious different appearance.
4143 The types must be used ahead of the corresponding
4150 \begin_layout Standard
4151 An implementation of these types in a WYSIWYG fashion does not seem to make
4152 sense, because the real appearance of the produced letter does not only
4153 depend on the usage of the particular type, but also on other factors.
4154 For example, a signature entered in the
4158 type will in the standard behavior appear in the produced letter only,
4159 when in the same letter also a
4164 The entered value of the
4168 type will in the standard behavior not appear in the produced letter at
4170 The possibility to design the letter`s heading freely is already indicated
4171 in a footnote above.
4174 \begin_layout Standard
4175 The input types can also be used as empty paragraphs.
4177 \begin_inset space \thinspace{}
4181 \begin_inset space \space{}
4193 type is not used at all, in the standard behavior the value of the
4197 type is used as signature, whereas if an empty
4201 type is used, no signature value is defined.
4204 \begin_layout Standard
4205 By using the input types it is possible to write a letter template, containing
4206 filled input types with your personal dates (name, address, etc.) and empty
4207 input types for other dates you want to enter.
4210 \begin_layout Itemize
4215 : sender's name, in the standard behavior appears as a centered paragraph
4216 in small caps in the letter`s heading.
4219 \begin_layout Itemize
4224 : sender's signature, in the standard behavior appears below the
4233 type is used, the value of the
4237 type appears instead.
4240 \begin_layout Itemize
4245 : sender's address, in the standard behavior appears in a centered paragraph
4246 in the letter`s heading below the sender's name.
4249 \begin_layout Itemize
4254 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
4265 \begin_layout Itemize
4270 : place of the letter`s making.
4273 \begin_layout Itemize
4278 : date of the letter`s making.
4287 , in the standard behavior, produce the place and the date in a right-aligned
4288 line below the addressee's field.
4293 type is used, neither place nor date appear, independent of the value of
4303 type is used, the date of the letter `s production is used.
4306 \begin_layout Itemize
4311 : sender`s back address, in the standard behavior appears above the addressee's
4312 field in a small sans serif font.
4315 \begin_layout Itemize
4320 : special mail information, in the standard behavior appears underlined
4321 above the addressee's field below the back address.
4324 \begin_layout Itemize
4329 : additional information, in the standard behavior appears on right side
4330 below the addressee`s field.
4333 \begin_layout Itemize
4338 : the letter's title, in the standard behavior appears in a big, bold, sans
4339 serif font above the subject.
4342 \begin_layout Itemize
4347 : the letter's subject, in the standard behavior appears in a bold font
4355 \begin_layout Standard
4376 produce a business letter like line above the
4380 line containing the fields
4381 \begin_inset Quotes eld
4385 \begin_inset Quotes erd
4389 \begin_inset Quotes eld
4393 \begin_inset Quotes erd
4397 \begin_inset Quotes eld
4401 \begin_inset Quotes erd
4405 \begin_inset Quotes eld
4409 \begin_inset Quotes erd
4413 \begin_inset Quotes eld
4417 \begin_inset Quotes erd
4421 \begin_inset Quotes eld
4425 \begin_inset Quotes erd
4429 For the date field, the value of the
4435 \begin_inset Quotes eld
4438 business letter types
4439 \begin_inset Quotes erd
4442 is used, the value of the
4446 type however does not appear, but only the \SpecialChar LaTeX
4454 The ordinary output of place and date in a right-aligned line below the
4455 addressee`s field is suppressed.
4456 The types are implemented as input types provided with a label and must
4457 be used ahead of the corresponding
4464 \begin_layout Itemize
4472 \begin_layout Itemize
4480 \begin_layout Itemize
4488 \begin_layout Itemize
4496 \begin_layout Itemize
4504 \begin_layout Subsubsection
4505 The new letter class: letter (koma-script v.2)
4508 \begin_layout Standard
4514 \begin_layout Standard
4515 \begin_inset VSpace medskip
4521 \begin_layout Standard
4523 Koma-Script version 2.8 has introduced a new letter class
4527 which supersedes the now unsupported
4532 It has — on the \SpecialChar LaTeX
4533 side — a completely new interface and is not compatible
4535 Therefore, \SpecialChar LyX
4536 supports both, though it is recommended you use the new class.
4539 \begin_layout Standard
4540 This class covers the same functionality as
4542 letter (koma-script),
4549 (receiver's address, same as
4566 will start a new letter (i.
4567 \begin_inset space \thinspace{}
4571 \begin_inset space \space{}
4574 you can write several letters per document).
4575 New elements are sender's
4591 and the possibility to use a
4597 Insert\SpecialChar menuseparator
4603 \begin_layout Standard
4604 The biggest improvement is, though, that the letter's layout is configurable
4605 to meet almost any needs.
4606 This can be done via the preamble or with a special style file (Letter
4607 Class Option, extension
4611 ), that will be read in as a class option.
4615 \begin_layout Plain Layout
4616 The KOMA package comes with some default
4621 There is, for instance, a
4625 file that follows german typesetting rules, or a
4629 that provides the default layout of the old
4634 The latter can be loaded with the class option
4640 Layout\SpecialChar menuseparator
4641 Document\SpecialChar menuseparator
4650 \change_deleted 564990737 1671617922
4658 \change_deleted 564990737 1671617938
4659 that is included in \SpecialChar LyX
4661 \change_inserted 564990737 1671617997
4668 ile\SpecialChar menuseparator
4670 \begin_inset space ~
4678 \begin_inset space ~
4681 Template\SpecialChar menuseparator
4684 \SpecialChar menuseparator
4685 KOMA-Script Letter (V.2)
4690 A detailed description is to be found in the Koma-Script documentation
4698 \begin_layout Subsubsection
4702 \begin_layout Standard
4703 Visualizing the Koma-Script document classes in \SpecialChar LyX
4704 , the \SpecialChar LyX
4705 internals cause some
4709 \begin_layout Itemize
4710 The chapter number of a
4714 type appears on a line of its own above the chapter heading instead of
4715 appearing in the same line ahead of it.
4716 The cause for that is the \SpecialChar LyX
4717 internal behavior for the labeltype
4724 \begin_layout Itemize
4725 The headings of the types
4734 \begin_inset Quotes eld
4738 \begin_inset Quotes erd
4742 table of contents, but not in the \SpecialChar LyX
4745 Document\SpecialChar menuseparator
4747 \begin_inset space ~
4751 \begin_inset space ~
4759 \begin_layout Itemize
4764 document class appear in a skip separation mode, not indented.
4765 This is the standard behavior, no special \SpecialChar LaTeX
4766 commands are needed for that.
4769 Document\SpecialChar menuseparator
4772 dialog the corresponding radio button indicates
4781 value always has the effect that extra \SpecialChar LaTeX
4782 commands are inserted in the document
4783 to produce the gap, which is not what is wanted in this case.
4786 \begin_layout Subsection
4788 \change_inserted 564990737 1670924924
4790 \begin_inset space \thinspace{}
4794 \begin_inset space \space{}
4798 \change_deleted 564990737 1670924933
4799 Article (mwart), book (mwbk) and report (mwrep)
4800 \begin_inset Argument status
4803 \begin_layout Plain Layout
4818 \begin_layout Standard
4824 \begin_layout Standard
4825 The \SpecialChar LyX
4842 correspond to the \SpecialChar LaTeX
4856 They are replacements for the standard document classes
4868 , resp., and fit better to Polish typography conventions in a number of points.
4872 \begin_layout Standard
4876 \begin_layout Itemize
4877 Unnumbered titles (with star, e.
4878 \begin_inset space \thinspace{}
4882 \begin_inset space \space{}
4889 ) are added into table of contents,
4892 \begin_layout Itemize
4893 Additional page styles:
4897 \begin_layout Description
4898 uheadings header with separated lines,
4901 \begin_layout Description
4902 myheadings custom header, contents headers via commands:
4917 \begin_layout Description
4918 myuheadings custom header with separated lines,
4921 \begin_layout Description
4922 outer page number is placed on outer side of page
4926 \begin_layout Itemize
4931 \begin_layout Description
4932 rmheadings serif titles — default,
4935 \begin_layout Description
4936 sfheadings sansserif titles,
4939 \begin_layout Description
4940 authortitle on title page first placed is author next title — default,
4943 \begin_layout Description
4944 titleauthor on title page first placed is title next author,
4947 \begin_layout Description
4948 withmarginpar reserve place on page for margins.
4952 \begin_layout Section
4954 \change_inserted 564990737 1670439534
4958 \begin_layout Standard
4960 \change_inserted 564990737 1670794710
4961 See also the document classes in the Collections (section
4962 \begin_inset space ~
4966 \begin_inset CommandInset ref
4968 reference "sec:Collections"
4975 \begin_layout Subsection
4977 \change_inserted 564990737 1670794716
4983 \begin_layout Standard
4985 \change_inserted 564990737 1670794716
4992 ; updated by the \SpecialChar LyX
4996 \begin_layout Subsubsection
4998 \change_inserted 564990737 1670794716
5004 \begin_layout Standard
5006 \change_inserted 564990737 1670794716
5009 This section describes how \SpecialChar LyX
5010 can be used to write articles for submission
5011 to the scientific journal
5013 Astronomy and Astrophysics
5016 \begin_inset CommandInset href
5019 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
5024 ) using Version 9.1 of the document class
5028 ; information about it is available at
5029 \begin_inset Flex URL
5032 \begin_layout Plain Layout
5034 \change_inserted 564990737 1670794716
5036 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
5046 \begin_layout Standard
5048 \change_inserted 564990737 1670794716
5051 A manual comes together with the package and should be consulted before
5052 installing this document class as described in the
5054 Installing New Document Classe
5064 \begin_layout Standard
5066 \change_inserted 564990737 1670794716
5069 \begin_inset Note Greyedout
5072 \begin_layout Plain Layout
5074 \change_inserted 564990737 1670794716
5077 Please note that the publisher of the journal was changed from Springer
5078 to EDP Sciences starting January 1, 2001.
5079 That change also involved some slight changes to the style files, namely
5080 the removal of the thesaurus command.
5081 If you have an older version installed, please upgrade.
5082 For information about compatibility with the old (version 4) layout, please
5083 refer to the comments in
5086 Dir/layouts/aapaper.layout
5096 \begin_layout Subsubsection
5098 \change_inserted 564990737 1670794716
5104 \begin_layout Standard
5106 \change_inserted 564990737 1671617129
5109 It is recommended you start from the template in the menu
5114 ile\SpecialChar menuseparator
5116 \begin_inset space ~
5124 \begin_inset space ~
5129 \SpecialChar menuseparator
5130 Articles\SpecialChar menuseparator
5131 Astronomy & Astrophysics
5135 If you are not using the template, note the following settings:
5138 \begin_layout Itemize
5140 \change_inserted 564990737 1670794716
5152 ocument\SpecialChar menuseparator
5157 ettings\SpecialChar menuseparator
5159 \begin_inset space ~
5164 dialog (OK, that one was obvious).
5167 \begin_layout Itemize
5169 \change_inserted 564990737 1670794716
5175 \begin_inset space ~
5187 \begin_inset space ~
5192 dialog: leave it set to
5197 The whole layout is done by the macros, you shouldn't change anything.
5200 \begin_layout Subsubsection
5202 \change_inserted 564990737 1670794716
5208 \begin_layout Standard
5210 \change_inserted 564990737 1670794716
5213 First thing to enter is the header information.
5214 It consists of five entries, of which one is optional.
5218 \begin_layout Itemize
5220 \change_inserted 564990737 1670794716
5229 \begin_layout Itemize
5231 \change_inserted 564990737 1670794716
5240 \begin_layout Itemize
5242 \change_inserted 564990737 1670794716
5251 \begin_layout Itemize
5253 \change_inserted 564990737 1670794716
5262 \begin_layout Itemize
5264 \change_inserted 564990737 1670794716
5273 Received: <date>; Accepted <date>
5276 \begin_layout Standard
5278 \change_inserted 564990737 1670794716
5281 Although the order of the single header entries doesn't matter it is advised
5282 to keep the above sequence, just to get the best optics and meets the layout
5283 of the real document.
5286 \begin_layout Standard
5288 \change_inserted 564990737 1670794716
5291 If you want to place footnotes in the header block, e.
5292 \begin_inset space \thinspace{}
5296 \begin_inset space \space{}
5299 to state your present address, just use the standard footnote via the menu
5305 nsert\SpecialChar menuseparator
5314 will automagically use the term
5323 \begin_layout Standard
5325 \change_inserted 564990737 1670794716
5328 In addition to these topics, the macros use three additional \SpecialChar LaTeX
5330 have no counterpart in \SpecialChar LyX
5334 \begin_layout Itemize
5336 \change_inserted 564990737 1670794716
5344 to separate different names for more than one author and institute, respectivel
5348 \begin_layout Itemize
5350 \change_inserted 564990737 1670794716
5358 to mark corresponding author/institute pairs.
5359 The institutes are numbered sequentially as they appear in the
5363 field, so you have to put a marker to each author.
5366 \begin_layout Itemize
5368 \change_inserted 564990737 1670794716
5376 to supply an email address for fast contact.
5379 \begin_layout Standard
5381 \change_inserted 564990737 1671642374
5384 In all cases, the appropriate command has to be entered as \SpecialChar TeX
5385 code in \SpecialChar LyX
5387 See the examples in the template and in
5390 File\SpecialChar menuseparator
5391 Open Example\SpecialChar menuseparator
5392 Articles\SpecialChar menuseparator
5393 Astronomy & Astrophysics
5401 \begin_layout Subsubsection
5403 \change_inserted 564990737 1670794716
5409 \begin_layout Standard
5411 \change_inserted 564990737 1670794716
5414 The abstract should immediately follow the header block and must contain
5424 \begin_layout Enumerate
5426 \change_inserted 564990737 1670794716
5432 (optional) {} leave it empty if necessary
5435 \begin_layout Enumerate
5437 \change_inserted 564990737 1670794716
5446 \begin_layout Enumerate
5448 \change_inserted 564990737 1670794716
5457 \begin_layout Enumerate
5459 \change_inserted 564990737 1670794716
5468 \begin_layout Enumerate
5470 \change_inserted 564990737 1670794716
5476 (optional) {} leave it empty if necessary
5479 \begin_layout Standard
5481 \change_inserted 564990737 1670794716
5485 This structure not shown in
5492 \begin_layout Subsubsection
5494 \change_inserted 564990737 1670794716
5497 Supported environments
5500 \begin_layout Standard
5502 \change_inserted 564990737 1670794716
5505 The A&A paper layout supports the following environments for structuring
5509 \begin_layout Itemize
5511 \change_inserted 564990737 1670794716
5518 \begin_layout Itemize
5520 \change_inserted 564990737 1670794716
5527 \begin_layout Itemize
5529 \change_inserted 564990737 1670794716
5536 \begin_layout Itemize
5538 \change_inserted 564990737 1670794716
5545 \begin_layout Itemize
5547 \change_inserted 564990737 1670794716
5554 \begin_layout Itemize
5556 \change_inserted 564990737 1670794716
5563 \begin_layout Itemize
5565 \change_inserted 564990737 1670794716
5572 \begin_layout Itemize
5574 \change_inserted 564990737 1670794716
5581 \begin_layout Itemize
5583 \change_inserted 564990737 1670794716
5590 \begin_layout Itemize
5592 \change_inserted 564990737 1670794716
5599 \begin_layout Itemize
5601 \change_inserted 564990737 1670794716
5608 \begin_layout Itemize
5610 \change_inserted 564990737 1670794716
5618 \begin_layout Subsubsection
5620 \change_inserted 564990737 1670794716
5623 Commands not supported by \SpecialChar LyX
5627 \begin_layout Standard
5629 \change_inserted 564990737 1670794716
5632 Some commands are not yet supported by the
5636 layout for \SpecialChar LyX
5638 Some have already been mentioned.
5639 For the sake of completeness, they are listed all together here:
5642 \begin_layout Itemize
5644 \change_inserted 564990737 1670794716
5653 \begin_layout Itemize
5655 \change_inserted 564990737 1670794716
5664 \begin_layout Itemize
5666 \change_inserted 564990737 1670794716
5675 \begin_layout Itemize
5677 \change_inserted 564990737 1670794716
5686 \begin_layout Itemize
5688 \change_inserted 564990737 1670794716
5697 \begin_layout Standard
5699 \change_inserted 564990737 1670794716
5702 If you want to use any of these commands, you have to enter them yourself.
5705 Do not forget to use
5711 nsert\SpecialChar menuseparator
5714 \begin_inset space ~
5723 \begin_layout Subsubsection
5725 \change_inserted 564990737 1670794716
5728 Figure and Table Floats
5731 \begin_layout Standard
5733 \change_inserted 564990737 1670794716
5737 provides support for the necessary float environments
5739 figure, figure*, table
5745 , therefore we won't tell much about it here.
5749 \begin_inset space ~
5755 Just remember that tables should be left-aligned.
5756 For that, select the table and change the alignment in
5761 dit\SpecialChar menuseparator
5767 \begin_inset space ~
5773 \begin_layout Standard
5775 \change_inserted 564990737 1670794716
5778 There is only one special thing: the figures with a caption beside the figure.
5779 To create such a figure, you have to do the following:
5782 \begin_layout Enumerate
5784 \change_inserted 564990737 1670794716
5787 Create a wide figure float:
5792 nsert\SpecialChar menuseparator
5797 t\SpecialChar menuseparator
5800 , then, from within the float, use the menu
5805 dit\SpecialChar menuseparator
5811 \begin_inset space ~
5822 \begin_inset space ~
5834 \begin_layout Enumerate
5836 \change_inserted 564990737 1670794716
5839 Enter your caption text.
5842 \begin_layout Enumerate
5844 \change_inserted 564990737 1670794716
5851 to move the cursor above the caption.
5854 \begin_layout Enumerate
5856 \change_inserted 564990737 1670794716
5862 \begin_layout Enumerate
5864 \change_inserted 564990737 1670794716
5867 Position the cursor after the figure and insert a horizontal fill by using
5873 nsert\SpecialChar menuseparator
5878 rmatting\SpecialChar menuseparator
5884 \begin_inset space ~
5893 dialog and select the
5907 \begin_layout Enumerate
5909 \change_inserted 564990737 1670794716
5912 Switch to \SpecialChar LaTeX
5916 \begin_inset space ~
5924 \begin_layout Enumerate
5926 \change_inserted 564990737 1670794716
5937 Do not close the brace!
5940 \begin_layout Enumerate
5942 \change_inserted 564990737 1670794716
5945 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
5950 \begin_inset space ~
5962 \begin_layout Standard
5964 \change_inserted 564990737 1671642458
5967 Also, refer to the figures in the file in
5970 File\SpecialChar menuseparator
5971 Open Example\SpecialChar menuseparator
5972 Articles\SpecialChar menuseparator
5973 Astronomy & Astrophysics
5979 \begin_layout Subsubsection
5981 \change_inserted 564990737 1670794716
5987 \begin_layout Standard
5989 \change_inserted 564990737 1670794716
5992 For submission, the paper has to be formatted in a special double-spacing
5994 For this purpose, you have to add the option
6005 \begin_inset space ~
6015 ocument\SpecialChar menuseparator
6020 ettings\SpecialChar menuseparator
6022 \begin_inset space ~
6031 \begin_layout Subsubsection
6033 \change_inserted 564990737 1670794716
6039 \begin_layout Standard
6041 \change_inserted 564990737 1671642520
6047 File\SpecialChar menuseparator
6048 Open Example\SpecialChar menuseparator
6049 Articles\SpecialChar menuseparator
6050 Astronomy & Astrophysics
6053 was written with \SpecialChar LyX
6055 It is the example paper from the original macro package,
6060 \begin_inset CommandInset href
6063 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
6068 , but translated to \SpecialChar LyX
6069 using the older unstructured abstract type.
6070 Use it for inspiration, and compare the \SpecialChar LaTeX
6075 with the \SpecialChar LyX
6079 \begin_layout Subsection
6084 \begin_layout Standard
6090 \begin_layout Subsubsection
6094 \begin_layout Standard
6096 is a set of macros produced by the American Astronomical Society to
6097 facilitate electronic manuscript submission to the three journals they
6098 publish: the Astrophysical Journal (including the Letters and Supplement),
6099 the Astronomical Journal, and the Publications of the Astronomical Society
6102 has proven to be an excellent tool for generating these documents, especially
6103 given its equation, citation, and figure handling capabilities.
6105 requires version 5.0 (or higher) of these macros; preferably 6.0, which
6106 is the version described here, or higher.
6107 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
6108 2.09 and are fundamentally
6109 incompatible with \SpecialChar LyX
6111 The AAS\SpecialChar TeX
6112 package may be downloaded from the AAS\SpecialChar TeX
6116 \begin_layout Standard
6117 \begin_inset VSpace medskip
6123 \begin_layout Standard
6125 \begin_inset Flex URL
6128 \begin_layout Plain Layout
6130 https://aas.org/aastex/aastex-downloads
6138 \begin_layout Standard
6139 \begin_inset VSpace medskip
6145 \begin_layout Standard
6146 A complete user guide is contained in that package and you should familiarize
6147 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
6150 will not reduce the need to figure out all the AAS\SpecialChar TeX
6151 commands, it will only
6152 reduce the drudgery of typing everything in.
6153 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
6155 completely to the requirements of the journal to which you are submitting
6159 \begin_layout Subsubsection
6160 Starting a New Paper
6163 \begin_layout Standard
6164 I strongly suggest that you start with the AAS\SpecialChar TeX
6168 File\SpecialChar menuseparator
6174 \change_inserted 564990737 1671617265
6175 \SpecialChar menuseparator
6176 Articles\SpecialChar menuseparator
6177 American Astronomical Society
6178 \change_deleted 564990737 1671617310
6181 , enter the new file name, then choose the
6188 This will show the most common fields found in a manuscript.
6189 Simply overwrite the existing text (including the brackets,
6193 ) with the correct information.
6194 Many of the AAS\SpecialChar TeX
6195 commands and environments can be implemented directly in
6198 For commands such as these, the \SpecialChar LaTeX
6199 code must be entered directly and marked
6201 Such commands are referred to as \SpecialChar TeX
6202 code, or Evil Red Text.
6203 I tried to minimize the amount of \SpecialChar TeX
6204 code needed in an AAS\SpecialChar TeX
6208 \begin_layout Subsubsection
6209 Finishing Your Paper
6212 \begin_layout Standard
6213 When the paper is finished to your satisfaction and previews/prints correctly,
6215 \begin_inset Quotes eld
6219 \begin_inset Quotes erd
6222 actions which need to be done before you submit it to the journals.
6226 \begin_layout Enumerate
6227 Export your paper as a \SpecialChar LaTeX
6230 File\SpecialChar menuseparator
6231 Export\SpecialChar menuseparator
6239 \begin_layout Enumerate
6244 file with your favorite text editor
6248 \begin_layout Enumerate
6249 remove the comment lines before the
6258 \begin_layout Enumerate
6263 usepackage...{fontenc}
6265 line if it appears (usually just after
6280 \begin_layout Enumerate
6281 remove everything between (and including) the
6293 commands, except for any commands you specifically put into the \SpecialChar LaTeX
6295 (which should appear immediately after the
6296 \begin_inset Quotes eld
6299 User specified \SpecialChar LaTeX
6301 \begin_inset Quotes erd
6312 \begin_layout Enumerate
6313 Run the resulting file through \SpecialChar LaTeX
6314 to make sure it still processes correctly.
6317 \begin_layout Enumerate
6318 Reread the journal requirements to make sure your filenames and formats
6322 \begin_layout Enumerate
6326 \begin_layout Subsubsection
6327 Comments On Specific Commands
6330 \begin_layout Standard
6331 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
6338 ) gives a good description of each.
6339 Thus it's probably easiest for me to go down the list as found in the guide
6340 and offer comments where necessary.
6341 So let's begin \SpecialChar ldots
6345 \begin_layout Paragraph
6346 Things that work as expected
6349 \begin_layout Standard
6350 Because they work as you might expect, I simply list them and the section
6451 begin{thebibliography}
6459 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6460 graphicx figure commands (2.14.1),
6484 (2.15.4, amongst other places),
6511 \begin_layout Standard
6512 The following style options also work correctly:
6533 Simply put them in the
6539 Layout\SpecialChar menuseparator
6545 \begin_layout Paragraph
6546 Things that work, but require more comment
6549 \begin_layout Standard
6550 The following items work, but require a little more discussion:
6553 \begin_layout Itemize
6554 These items are reserved for use by the journal editors, but you can put
6555 them into the \SpecialChar LaTeX
6556 preamble if you feel compelled to do so:
6589 \begin_layout Itemize
6590 These items may be placed in the \SpecialChar LaTeX
6591 preamble, and are included as blanks in
6613 \begin_layout Itemize
6620 (2.3) – can only be used
6621 \begin_inset Quotes eld
6625 \begin_inset Quotes erd
6628 , not in the middle of a paragraph.
6629 Use \SpecialChar TeX
6630 code if you need to embed it.
6633 \begin_layout Itemize
6640 (2.3) – will have extra {} after it.
6641 This should not cause an error.
6644 \begin_layout Itemize
6651 (2.6) – can only be used
6652 \begin_inset Quotes eld
6656 \begin_inset Quotes erd
6659 , not in the middle of a paragraph.
6660 Use \SpecialChar TeX
6661 code if you need to embed it.
6664 \begin_layout Itemize
6671 (2.8) – can't insert a cross-reference tag, you must type the tag name by
6675 \begin_layout Itemize
6689 \begin_layout Itemize
6696 (2.9) – will have extra {} after it.
6697 This should not cause an error.
6700 \begin_layout Itemize
6707 (2.11) – will have extra {} after it.
6708 This should not cause an error.
6711 \begin_layout Itemize
6718 (2.14.2) – you can insert an optional filename argument by placing the cursor
6719 at the beginning of the text and selecting
6721 Insert\SpecialChar menuseparator
6726 \begin_inset Quotes eld
6730 \begin_inset Quotes erd
6733 inserts an optional argument of the type needed by
6740 Hopefully it will be renamed someday.
6743 \begin_layout Itemize
6756 for the catalog ID optional parameter
6759 \begin_layout Itemize
6772 for the catalog ID optional parameter
6775 \begin_layout Paragraph
6776 Things not implemented, use \SpecialChar TeX
6780 \begin_layout Standard
6791 setcounter{equation}
6793 (2.12), Journal name abbreviations (2.13.4),
6829 (2.15.4, insert it as the first element in the lefthand cell after where
6831 Don't use any of \SpecialChar LyX
6832 's rules in the table),
6844 (2.15.5), much of Misc (2.17, except
6895 \begin_layout Paragraph
6896 Things that cannot be implemented
6899 \begin_layout Standard
6901 at least in any meaningful sort of way, so I suggest ignoring them.
6902 They are the references environment (2.13.3), and the deluxetable environment
6904 If you really, really need to use deluxetable, I suggest editing it in
6905 a separate file with a text editor, then using
6907 Insert\SpecialChar menuseparator
6909 \begin_inset space ~
6914 to include it in your \SpecialChar LyX
6917 \change_deleted 564990737 1671642564
6923 \change_inserted 564990737 1671642618
6927 File\SpecialChar menuseparator
6928 Open Example\SpecialChar menuseparator
6929 Articles\SpecialChar menuseparator
6930 American Astronomical Society
6936 \change_inserted 564990737 1671642621
6942 \begin_layout Subsubsection
6943 FAQs, Tips, Tricks, and Other Ruminations
6946 \begin_layout Paragraph
6947 Getting \SpecialChar LyX
6948 and AAS\SpecialChar TeX
6952 \begin_layout Standard
6953 It can be a bit tricky to get \SpecialChar LyX
6954 to recognize a new layout and document class.
6955 When all else fails, do this:
6958 \begin_layout Enumerate
6959 Make certain that \SpecialChar LaTeX
6960 can find AAS\SpecialChar TeX
6962 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
6964 directory completely unrelated to \SpecialChar LaTeX
6965 or AAS\SpecialChar TeX
6966 and run \SpecialChar LaTeX
6974 \begin_layout Enumerate
6979 appears in \SpecialChar LyX
6987 \begin_layout Enumerate
6990 Tools\SpecialChar menuseparator
6994 , then restart \SpecialChar LyX
6998 \begin_layout Enumerate
6999 Open a regular new file, not from a template.
7000 Does AAS\SpecialChar TeX
7001 appear in the class list in
7003 Document\SpecialChar menuseparator
7009 \begin_layout Standard
7010 If you get a warning from an existing AAS\SpecialChar TeX
7011 document about not being able
7012 to find the AAS\SpecialChar TeX
7013 layout or a message about
7014 \begin_inset Quotes eld
7017 You should not mix title layouts with normal ones
7018 \begin_inset Quotes erd
7021 , things haven't been installed correctly.
7024 \begin_layout Paragraph
7026 error processing a table
7029 \begin_layout Standard
7031 , by default, attempts to center the table caption/title.
7032 This seems to produce a bad interaction in AAS\SpecialChar TeX
7033 so you should click somewhere
7034 in the caption/title, then select
7036 Edit\SpecialChar menuseparator
7038 \begin_inset space ~
7052 This took care of it for me.
7055 \begin_layout Paragraph
7059 \begin_layout Standard
7060 A couple of things: 1) I have noticed some funny spacing in the reference
7061 entries in the text.
7062 When you enter the bibliography item data, make sure their is
7066 space between the last author and the parenthesis setting off the year;
7070 \begin_inset space \thinspace{}
7074 \begin_inset space \space{}
7088 2) Entering the references at all is not obvious.
7089 The easiest thing is to start typing your first reference at the end of
7090 the document, then mark it as type
7095 That will put a small gray box in front of what you just typed.
7096 Click on the box to fill in the rest of the information.
7097 For new references, go to the end of an existing reference and press return.
7098 That will create a new line with its own box, etc.
7101 \begin_layout Paragraph
7105 \begin_layout Standard
7106 Even though AAS\SpecialChar TeX
7107 provides its own figure commands (
7113 , for example), I much prefer \SpecialChar LaTeX
7114 's standard figure commands (with the default
7123 \begin_inset space ~
7126 commands as \SpecialChar TeX
7127 code into a Figure Float box if you desire, but I never have
7128 much luck getting the layout right.
7129 With the standard graphics, \SpecialChar LyX
7134 usepackage{graphicx}
7136 command into the \SpecialChar LaTeX
7137 preamble and handle the figures in the standard \SpecialChar LaTeX2e
7139 interspersing the figures in the text.
7140 I believe ApJ accepts figures exactly this way now; AJ might still use
7142 \begin_inset Quotes eld
7145 stack everything at the end
7146 \begin_inset Quotes erd
7152 \begin_layout Paragraph
7153 Things I could have done, but didn't
7156 \begin_layout Standard
7158 \begin_inset Quotes eld
7162 \begin_inset Quotes erd
7165 things I could have implemented, but chose not to.
7166 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
7168 even though it is double-spaced in the paper manuscript.
7169 Also, I chose not to make separate layouts for the preprint and preprint2
7171 Since I assume you will spend most of your time in the plain manuscript
7172 mode anyway, I decided not to chew up more disk space with this.
7176 \begin_layout Subsubsection
7180 \begin_layout Standard
7181 Your mileage may vary.
7182 I've now had papers published by both ApJ and AJ that have had 98% of the
7183 effort done in \SpecialChar LyX
7184 ; the last 2% was the \SpecialChar LaTeX
7185 post-processing and a few cleanups.
7186 I have had no trouble with the submission process, and I'm sure the journals
7187 were never aware that there might be a difference.
7188 So, go forth and publish!
7191 \begin_layout Subsection
7193 \change_inserted 564990737 1671442131
7199 \begin_layout Standard
7201 \change_inserted 564990737 1671642768
7207 \begin_inset space \thinspace{}
7216 document class together with the style
7220 to facilitate the description of chess games.
7224 File\SpecialChar menuseparator
7227 \SpecialChar menuseparator
7228 Articles\SpecialChar menuseparator
7247 \begin_layout Subsection
7249 \change_inserted 564990737 1671042028
7255 \begin_layout Standard
7257 \change_inserted 564990737 1671617396
7263 \begin_inset space \thinspace{}
7273 This provides the following additional environments:
7276 \begin_inset space ~
7284 \begin_inset space ~
7292 \begin_inset space ~
7310 A template is available in the menu
7315 ile\SpecialChar menuseparator
7317 \begin_inset space ~
7325 \begin_inset space ~
7330 \SpecialChar menuseparator
7331 Articles\SpecialChar menuseparator
7336 It has been customized with further environments and contains all the informati
7338 However, the documentation is also available from
7339 \begin_inset CommandInset href
7342 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
7350 \begin_layout Subsection
7352 \change_inserted 564990737 1671042046
7358 \begin_layout Standard
7360 \change_inserted 564990737 1671042046
7366 \begin_inset space \thinspace{}
7371 provides an alternative to the
7376 It provides similar functionality, but you might prefer this layout with
7377 sans serif sections, headings, and more.
7380 \begin_layout Subsection
7385 \begin_layout Standard
7391 \begin_layout Standard
7392 \begin_inset VSpace bigskip
7398 \begin_layout Standard
7403 \begin_inset space ~
7408 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
7410 \begin_inset Formula $\beta$
7413 release of May, 1999) class.
7416 \begin_layout Standard
7422 textclass, which works with Rev\SpecialChar TeX
7424 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
7426 That means that it doesn't interact very well with \SpecialChar LyX
7427 , which requires \SpecialChar LaTeX2e
7429 it has been kludged to work.
7430 Since Rev\SpecialChar TeX
7431 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
7438 \begin_inset space ~
7443 textclass should also be pretty easy to use.
7446 \begin_layout Standard
7447 These documents are supposed to be used in
7451 to the Rev\SpecialChar TeX
7452 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
7454 and assume you'll know what to put in the preamble if necessary.
7457 \begin_layout Subsubsection
7461 \begin_layout Standard
7462 All you need to do is install Rev\SpecialChar TeX
7463 4, as described in the package's README
7465 The package can be found at The Rev\SpecialChar TeX
7467 \begin_inset Flex URL
7470 \begin_layout Plain Layout
7472 http://publish.aps.org/revtex4/
7478 Install it somewhere that \SpecialChar LaTeX
7480 Test it by trying to \SpecialChar LaTeX
7481 a short Rev\SpecialChar TeX
7482 4 document in some random directory (i.
7483 \begin_inset space \thinspace{}
7487 \begin_inset space \space{}
7490 not the directory where you installed the class file.) Then, if you reconfigure
7492 , it will find the class file and let you use the Rev\SpecialChar TeX
7496 \begin_layout Standard
7497 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
7506 \begin_inset space ~
7511 template, found in the templates directory.
7514 \begin_layout Subsubsection
7518 \begin_layout Standard
7519 Optional arguments to
7526 \begin_inset Quotes eld
7530 \begin_inset Quotes erd
7534 \begin_inset Quotes eld
7538 \begin_inset Quotes erd
7544 \begin_inset space ~
7552 \begin_inset space ~
7558 Remember that in Rev\SpecialChar TeX
7559 , at least one optional argument is required!
7562 \begin_layout Standard
7563 Other preamble matter, like
7570 \begin_inset space ~
7577 \begin_inset space ~
7582 dialog, also as usual.
7585 \begin_layout Subsubsection
7589 \begin_layout Standard
7590 The layouts basically correspond to the commands in Rev\SpecialChar TeX
7592 For example, the Email layout corresponds to
7599 Note that (at least as of Rev\SpecialChar TeX
7608 layouts are exactly equivalent, so you shouldn't need to use both.
7612 \begin_layout Plain Layout
7613 In case you're curious, both were included so that
7617 would be able to translate both
7637 \begin_layout Subsubsection
7641 \begin_layout Standard
7642 There are a couple of important unique aspects of Rev\SpecialChar TeX
7644 bugs that will be even more confusing in \SpecialChar LyX
7648 \begin_layout Standard
7649 In Rev\SpecialChar TeX
7667 The \SpecialChar LyX
7668 equivalent is that there is a separate Thanks layout.
7673 write footnotes in the
7677 layout, or weird things may happen.
7678 See the Rev\SpecialChar TeX
7679 4 documentation for more details.
7682 \begin_layout Standard
7686 \begin_inset space ~
7694 \begin_inset space ~
7703 layouts must be placed
7711 layout and the corresponding
7728 , the \SpecialChar LaTeX
7732 \begin_layout Subsection
7734 \change_inserted 564990737 1671042072
7740 \begin_layout Standard
7742 \change_inserted 564990737 1671042072
7749 classes were replaced in 2013 with a completely new
7754 This package provides a \SpecialChar LaTeX
7755 class and templates for books to be published
7756 at Springer Gabler Research, Springer Vieweg Research, Springer Spektrum
7757 Research, Springer VS Research, or Springer VS Forschung.
7758 The documentation is available in German from
7759 \begin_inset CommandInset href
7762 target "http://mirrors.ctan.org/macros/latex/contrib/springer/sr-vorl/sr-vorl.pdf"
7770 \begin_layout Section
7772 \change_inserted 564990737 1670439560
7776 \begin_layout Standard
7778 \change_inserted 564990737 1670439581
7779 See also the document classes in the Collections (section
7780 \begin_inset space ~
7784 \begin_inset CommandInset ref
7786 reference "sec:Collections"
7793 \begin_layout Subsection
7797 \begin_layout Standard
7803 \begin_layout Subsubsection
7807 \begin_layout Standard
7808 Memoir is a very powerful and constantly evolving class.
7809 It has been designed with regard to fictional and non-fictional literature.
7810 Its aim is to let the user have maximum control over the typesetting of
7812 Memoir is based on the standard book class, but it can also emulate the
7813 article class (see below).
7816 \begin_layout Standard
7817 Peter Wilson, the developer of Memoir, is known as the author of lots of
7818 useful packages in the \SpecialChar LaTeX
7820 Most of them have been merged with Memoir.
7821 Therefore, it is much easier to layout the table of contents, appendices,
7822 chapter designs and such.
7824 , though, does not support all of these goodies natively.
7825 Some of them might be added to forthcoming releases
7829 \begin_layout Plain Layout
7830 You are invited to send suggestions to
7831 \begin_inset Flex URL
7834 \begin_layout Plain Layout
7836 lyx-devel@lists.lyx.org
7846 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
7848 Of course you can still use all features with the help of some native \SpecialChar LaTeX
7850 commands (\SpecialChar TeX
7855 \begin_layout Plain Layout
7860 \begin_layout Plain Layout
7870 \begin_inset space ~
7874 \begin_inset CommandInset ref
7876 reference "sec:Inserting-TeX-Code"
7886 In this section, we can only list those features that are natively supported
7889 For detailed descriptions (and for the rest of features) we recommend you
7890 have a look at the detailed manual of the Memoir class
7894 \begin_layout Plain Layout
7899 \begin_layout Plain Layout
7909 \begin_inset Flex URL
7912 \begin_layout Plain Layout
7914 CTAN:/macros/latex/memoir/memman.pdf
7924 , which is not only a user guide for the class, but also both a comprehensive
7925 description on good typesetting and a superb example for good typesetting
7929 \begin_layout Subsubsection
7930 Basic features and restrictions
7933 \begin_layout Standard
7934 Memoir supports basically all features of the standard book classes.
7935 There are, however, some differences, as follows:
7938 \begin_layout Description
7940 \begin_inset space ~
7943 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
7946 \begin_layout Description
7948 \begin_inset space ~
7951 style: The fancy page style is not supported, due to a command clash between
7952 Memoir and the fancyhdr package (they both define a command with the same
7953 name, which confuses \SpecialChar LaTeX
7955 Instead, Memoir comes with a number of its own page styles (see
7957 Document\SpecialChar menuseparator
7958 Settings\SpecialChar menuseparator
7960 \begin_inset space ~
7966 If you want to use these for the chapter pages, you have to use the command
7973 in the main text or in preamble (e.
7974 \begin_inset space \thinspace{}
7978 \begin_inset space \space{}
7985 chapterstyle{companion}
7990 \begin_layout Description
7991 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
7992 optional argument in the standard classes.
7993 With this, you can specify an alternative version of the title for the
7994 table of contents and the headers (for instance, if the title is too long).
7996 , you can do this via
7998 Insert\SpecialChar menuseparator
8000 \begin_inset space ~
8005 at the beginning of a chapter/section.
8006 Memoir features a second optional argument and thus separates the table
8007 of contents from the header.
8008 You can define three variants of a title with this: one for the main text,
8009 one for the table of contents, and one for the headers.
8011 makes these available in form of specific
8022 \begin_layout Description
8023 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
8024 of contents, the list of figures and the list of table start a new page
8026 Memoir does not follow this route.
8027 You have to insert a page break yourself, if you want to have one.
8030 \begin_layout Description
8031 Titlepage: For some unknown reason, Memoir uses pagination on the title
8032 page (in the standard classes, title pages are
8033 \begin_inset Quotes eld
8037 \begin_inset Quotes erd
8041 If you want an empty title page, type
8045 aliaspagestyle{title}{empty}
8050 \begin_layout Description
8051 Article: With the class option
8057 Document\SpecialChar menuseparator
8058 Settings\SpecialChar menuseparator
8059 Class Settings\SpecialChar menuseparator
8061 \begin_inset space ~
8066 ), you can emulate article style.
8067 That is, counters (footnotes, figures, tables etc.) will not be reset on
8068 new chapters, chapters don't start a new page (but are—in contrary to
8069 \begin_inset Quotes eld
8073 \begin_inset Quotes erd
8076 article classes—still allowed), parts, though, use their own page, as in
8080 \begin_layout Description
8081 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
8082 font commands, which have been used in the old \SpecialChar LaTeX
8084 \begin_inset space \thinspace{}
8088 \begin_inset space \space{}
8104 It produces an error and stops \SpecialChar LaTeX
8105 whenever such a command appears.
8110 reallows the commands and spits out warnings instead (which does at least
8111 not stop \SpecialChar LaTeX
8113 Since a lot of packages and particularly Bib\SpecialChar TeX
8114 style files are still using
8115 those commands, we have decided to use this option by default.
8118 \begin_layout Subsubsection
8122 \begin_layout Standard
8123 We will only describe the features supported by \SpecialChar LyX
8124 (which is not much currently).
8125 Please consult the Memoir manual
8129 \begin_layout Plain Layout
8134 \begin_layout Plain Layout
8144 \begin_inset Flex URL
8147 \begin_layout Plain Layout
8149 CTAN:/macros/latex/memoir/memman.pdf
8162 \begin_layout Description
8163 Abstract: You may wonder why an abstract is an extra feature.
8164 Well, it is in book class.
8165 Usually books don't have abstracts.
8166 Memoir, however, has.
8167 You can use it wherever and how often you like.
8170 \begin_layout Description
8171 Chapterprecis: You may know this older typesetting style: The contents of
8172 a chapter are summarized below the title and also in the table of contents
8174 \begin_inset space \thinspace{}
8178 \begin_inset space \space{}
8183 Our hero arrives in Troia; he loses some friends; he finds others
8186 Chapterprecis does exactly this.
8187 It is therefore only sensible below a chapter.
8190 \begin_layout Description
8191 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
8192 The epigraph environment provides an elegant way of typesetting such a
8194 The motto itself (text) and its (optional) author (source) are divided
8196 The author (source) can be inserted via
8198 Insert\SpecialChar menuseparator
8205 \begin_layout Description
8206 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
8207 complex figurative poems).
8209 can only support a few of them.
8210 One is poemtitle, which is a centered title for poems, which will also
8211 be added to the table of contents (verse is the standard environment for
8213 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
8215 because they have to be nested inside regular verse environments, which
8216 is not possible with \SpecialChar LyX
8220 \begin_layout Description
8221 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
8224 \begin_layout Subsection
8226 \change_inserted 564990737 1671442175
8232 \begin_layout Standard
8234 \change_inserted 564990737 1671442175
8244 \begin_inset space \thinspace{}
8249 document class but adds two environments:
8252 \begin_layout Description
8254 \change_inserted 564990737 1671442175
8257 Recipe a numbered section environment at the
8261 level which generates a bold centered heading above a double horizontal
8265 \begin_layout Description
8267 \change_inserted 564990737 1671442175
8280 are what are being described and the environment ends with a horizontal
8284 \begin_layout Standard
8286 \change_inserted 564990737 1671642866
8290 File\SpecialChar menuseparator
8291 Open Example\SpecialChar menuseparator
8292 Books\SpecialChar menuseparator
8296 illustrates its use.
8299 \begin_layout Standard
8301 \change_inserted 564990737 1671442175
8304 It is designed for typesetting one or two recipes per page, with dimensions
8306 \begin_inset Quotes qrd
8310 \begin_inset Quotes qrd
8314 The hyperlinked table of contents (ToC) and page numbers make browsing
8315 recipes convenient, and the pages can be joined together or printed 2 per
8316 page to normal letterpaper easily.
8317 The size was chosen to work in half-page 3-ring binder cover sheets, because
8318 un-laminated paper just doesn't last in the kitchen.
8321 \begin_layout Standard
8323 \change_inserted 564990737 1671442175
8326 The half-letter pages can be printed two per page using your printer driver,
8327 or bound together using
8329 pdfjam --nup 2x1 --papersize '{11in,8.5in}'
8339 is the compiled version of your recipes.
8342 \begin_layout Section
8344 \change_inserted 564990737 1671442207
8348 \begin_layout Subsection
8350 \change_inserted 564990737 1671442208
8356 \begin_layout Standard
8358 \change_inserted 564990737 1671642942
8364 \begin_inset space \space{}
8368 \begin_inset space \thinspace{}
8377 document class, an unofficial implementation of the ‘Europass CV’ recommended
8378 by the European Commission in 2013.
8382 File\SpecialChar menuseparator
8383 Open Example\SpecialChar menuseparator
8384 Curricula Vitae\SpecialChar menuseparator
8388 offers guidance on its use.
8389 Its documentation is available from
8390 \begin_inset CommandInset href
8393 target "http://mirrors.ctan.org/macros/latex/contrib/europasscv/europasscv.pdf"
8401 \begin_layout Subsection
8403 \change_inserted 564990737 1671442208
8409 \begin_layout Standard
8411 \change_inserted 564990737 1671642984
8417 \begin_inset space \space{}
8421 \begin_inset space \thinspace{}
8430 document class, an unofficial implementation of the “Europass CV” recommended
8431 by the European Commission in 2002.
8435 File\SpecialChar menuseparator
8436 Open Example\SpecialChar menuseparator
8437 Curricula Vitae\SpecialChar menuseparator
8441 offers guidance on its use.
8442 Its documentation is available from
8443 \begin_inset CommandInset href
8446 target "http://mirrors.ctan.org/macros/latex/contrib/europecv/europecv.pdf"
8454 \begin_layout Subsection
8456 \change_inserted 564990737 1671442208
8462 \begin_layout Standard
8464 \change_inserted 564990737 1671643003
8470 \begin_inset space \space{}
8474 \begin_inset space \thinspace{}
8484 This allows the creation of customizable CVs.
8488 File\SpecialChar menuseparator
8489 Open Example\SpecialChar menuseparator
8490 Curricula Vitae\SpecialChar menuseparator
8494 offers guidance on its use.
8495 Its documentation is available from
8496 \begin_inset CommandInset href
8499 target "http://mirrors.ctan.org/macros/latex/contrib/moderncv/manual/moderncv_userguide.pdf"
8507 \begin_layout Subsection
8509 \change_inserted 564990737 1671442208
8515 \begin_layout Standard
8517 \change_inserted 564990737 1671643024
8523 \begin_inset space \space{}
8527 \begin_inset space \thinspace{}
8536 document class, originally developed for use with \SpecialChar LyX
8541 File\SpecialChar menuseparator
8542 Open Example\SpecialChar menuseparator
8543 Curricula Vitae\SpecialChar menuseparator
8547 offers guidance on its use.
8548 Its documentation is available from
8549 \begin_inset CommandInset href
8552 target "http://mirrors.ctan.org/macros/latex/contrib/simplecv/simplecv.pdf"
8560 \begin_layout Section
8562 \change_inserted 564990737 1671041968
8566 \begin_layout Subsection
8568 \change_inserted 564990737 1671041970
8574 \begin_layout Standard
8576 \change_inserted 564990737 1671617528
8587 document class for writing letters according to the
8589 Deutsches Institut für Normung
8592 The file in the menu
8597 ile\SpecialChar menuseparator
8599 \begin_inset space ~
8607 \begin_inset space ~
8610 Template\SpecialChar menuseparator
8611 Letters\SpecialChar menuseparator
8614 offers guidance on its use.
8615 The documentation is available from
8616 \begin_inset CommandInset href
8619 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
8627 \begin_layout Subsection
8629 \change_inserted 564990737 1671458835
8635 \begin_layout Standard
8637 \change_inserted 564990737 1671617591
8648 document class for English letters and to create mailing labels.
8649 The file in the menu
8654 ile\SpecialChar menuseparator
8656 \begin_inset space ~
8664 \begin_inset space ~
8667 Template\SpecialChar menuseparator
8668 Letters\SpecialChar menuseparator
8669 Letter (Standard Class)
8671 offers guidance on its use.
8674 \begin_layout Section
8676 \change_inserted 564990737 1670439660
8680 \begin_layout Subsection
8682 \change_inserted 564990737 1671458922
8688 \begin_layout Standard
8690 \change_inserted 564990737 1671617655
8696 \begin_inset space \thinspace{}
8705 document class for creating presentations.
8706 The file in the menu
8711 ile\SpecialChar menuseparator
8713 \begin_inset space ~
8721 \begin_inset space ~
8724 Template\SpecialChar menuseparator
8725 Presentations\SpecialChar menuseparator
8728 offers guidance on its use.
8729 The documentation is available from
8730 \begin_inset CommandInset href
8733 target "http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf"
8741 \begin_layout Subsection
8744 Foil\SpecialChar TeX
8748 \begin_inset CommandInset label
8757 \begin_layout Standard
8763 \begin_layout Subsubsection
8767 \begin_layout Standard
8768 This section describes how to use \SpecialChar LyX
8769 to make slides for overhead projectors.
8770 There are two document classes that can do this: the default slides class
8773 Foil\SpecialChar TeX
8777 This section documents the latter.
8780 \begin_layout Standard
8781 I'm going to say this again, nice and clear, so that there's no misunderstanding
8785 \begin_layout Standard
8786 \begin_inset VSpace bigskip
8792 \begin_layout Standard
8796 This section documents the class
8797 \begin_inset Quotes eld
8805 \begin_inset Quotes erd
8813 \begin_layout Standard
8814 \begin_inset VSpace bigskip
8820 \begin_layout Standard
8821 If you're looking for the documentation for
8822 \begin_inset Quotes eld
8830 \begin_inset Quotes erd
8834 \begin_inset space ~
8838 \begin_inset CommandInset ref
8840 reference "sec:slitex"
8845 If your machine doesn't have the
8853 installed, you'll probably have to use the default
8857 class, which isn't quite as good as
8862 \begin_layout Standard
8867 class is designed for use with version
8868 \begin_inset space ~
8876 class file which is now an integral part of \SpecialChar LaTeX2e
8880 \begin_layout Subsubsection
8884 \begin_layout Standard
8885 Obviously, to use this document class, you need to select
8896 \begin_inset space ~
8902 There are some settings in the
8905 \begin_inset space ~
8910 dialog that you should know about that are specific to this class:
8913 \begin_layout Itemize
8914 Don't change the options
8925 \begin_inset space ~
8931 They're ignored by the
8938 \begin_layout Itemize
8939 The default font size is 20
8940 \begin_inset space \thinspace{}
8943 pt with the other options being 17
8944 \begin_inset space \thinspace{}
8948 \begin_inset space \thinspace{}
8952 \begin_inset space \thinspace{}
8958 \begin_layout Itemize
8967 but all math equations are still typeset in the usual roman font.
8970 \begin_layout Itemize
8973 Foil\SpecialChar TeX
8976 supports A4 and Letter paper sizes as well as a special size for working
8978 \begin_inset space \thinspace{}
8982 It doesn't support A5, B5, legal or executive paper sizes.
8985 \begin_layout Itemize
8986 Don't bother changing the
8990 settings because they are ignored anyway.
8991 All floats appear where they are defined in the text.
8994 \begin_layout Itemize
8999 setting behaves a bit differently for this class.
9002 Foil\SpecialChar TeX
9005 provides extensive footer and header capabilities including a user-defined
9008 \begin_inset space ~
9012 \begin_inset CommandInset ref
9014 reference "sec:foilfoot"
9019 The title page is treated differently to all other pages in the document
9028 has the logo centered at the bottom of the page (if one is defined).
9029 The possible page style choices and what they do are as follows:
9033 \begin_layout Labeling
9034 \labelwidthstring MMMMMMM
9041 The final output contains no page numbers, or other headers or footers
9042 (except footnotes of course).
9046 \begin_layout Labeling
9047 \labelwidthstring MMMMMMM
9054 The final output contains page numbers centered at the bottom of the page.
9055 No other headings or footers (other than footnotes).
9058 \begin_layout Labeling
9059 \labelwidthstring MMMMMMM
9064 Page numbers in lower right corner.
9065 Additional headers and footers are also shown.
9066 This is also the default.
9069 \begin_layout Labeling
9070 \labelwidthstring MMMMMMM
9075 Gives you access to the
9079 package although its use with
9081 Foil\SpecialChar TeX
9084 is discouraged by the writer of the
9086 Foil\SpecialChar TeX
9089 package because of some potential page layout clashes.
9093 \begin_layout Paragraph
9097 \begin_layout Standard
9098 The following options may be used in the extra class options in the
9100 Document\SpecialChar menuseparator
9106 \begin_layout Labeling
9107 \labelwidthstring MMMMMMx
9112 This sets up the page layout for 7.33
9113 \begin_inset space \thinspace{}
9117 \begin_inset space \thinspace{}
9120 in paper, which is about the same aspect ratio as a 35
9121 \begin_inset space \thinspace{}
9124 mm slide, making it a bit easier to work with this medium.
9127 \begin_layout Labeling
9128 \labelwidthstring MMMMMMx
9133 Places a rule across the page below the header on every page except the
9137 \begin_layout Labeling
9138 \labelwidthstring MMMMMMx
9143 Places a rule across the page above the footer on every page except the
9147 \begin_layout Labeling
9148 \labelwidthstring MMMMMMx
9153 This is automatically set each time you create a new
9160 Foil\SpecialChar TeX
9163 to use the dvips driver to rotate those pages that are set as landscape
9167 \begin_layout Labeling
9168 \labelwidthstring MMMMMMx
9173 Simply changes the page dimensions to those of a landscape page but doesn't
9175 Thus if you use this option you need to use an external program to rotate
9176 each page or feed your paper through your printer as landscape.
9177 Note that this option effectively reverses the roles of the
9185 environments (don't worry these are described in the next section).
9188 \begin_layout Labeling
9189 \labelwidthstring MMMMMMx
9194 Equation numbers on the left.
9197 \begin_layout Labeling
9198 \labelwidthstring MMMMMMx
9203 Flush-left equations.
9206 \begin_layout Subsubsection
9207 Supported Environments
9210 \begin_layout Standard
9211 Most of the environments commonly supported in other classes are also supported
9217 There are several additional environments provided by
9219 Foil\SpecialChar TeX
9222 as well as a couple added by \SpecialChar LyX
9224 The following environments are shared with other classes:
9227 \begin_layout Standard
9228 \begin_inset Flex Multiple Columns
9231 \begin_layout Itemize
9237 \begin_layout Itemize
9243 \begin_layout Itemize
9249 \begin_layout Itemize
9255 \begin_layout Itemize
9261 \begin_layout Itemize
9268 \begin_layout Itemize
9274 \begin_layout Itemize
9280 \begin_layout Itemize
9286 \begin_layout Itemize
9292 \begin_layout Itemize
9298 \begin_layout Itemize
9304 \begin_layout Itemize
9310 \begin_layout Itemize
9316 \begin_layout Itemize
9327 \begin_layout Standard
9328 That is, all the major environments apart from the sectioning environments.
9329 Since foils are essentially self-contained sections, with a title and body,
9332 Foil\SpecialChar TeX
9335 provides specific commands for starting new foils and these are:
9338 \begin_layout Itemize
9344 \begin_layout Itemize
9350 \begin_layout Standard
9352 also provides slightly modified versions of these two environments called:
9355 \begin_layout Itemize
9361 \begin_layout Itemize
9367 \begin_layout Standard
9368 and the differences will be explained in the next section.
9371 \begin_layout Standard
9372 Since foils are often used in presenting ideas or new theorems and such
9375 Foil\SpecialChar TeX
9378 also provides a comprehensive box of goodies for presenting them:
9381 \begin_layout Standard
9382 \begin_inset Flex Multiple Columns
9385 \begin_layout Itemize
9391 \begin_layout Itemize
9397 \begin_layout Itemize
9403 \begin_layout Itemize
9409 \begin_layout Itemize
9415 \begin_layout Itemize
9421 \begin_layout Itemize
9427 \begin_layout Itemize
9433 \begin_layout Itemize
9439 \begin_layout Itemize
9445 \begin_layout Itemize
9456 \begin_layout Standard
9457 The starred versions are unnumbered while the unstarred versions are numbered.
9458 There are also two list environments added by \SpecialChar LyX
9462 \begin_layout Itemize
9468 \begin_layout Itemize
9474 \begin_layout Standard
9477 Foil\SpecialChar TeX
9480 provides some powerful header and footer capabilities that are best set
9481 in the preamble although they may be set at any point in a document.
9482 If you want to change these settings in your document the best place to
9483 do so is at the very top of a foil, i.
9484 \begin_inset space \thinspace{}
9490 \begin_inset space \space{}
9495 straight after the foilhead.
9498 \begin_layout Standard
9499 For this purpose, the following command styles are provided [
9506 \begin_layout Standard
9507 \begin_inset Flex Multiple Columns
9510 \begin_layout Itemize
9514 \begin_inset space ~
9520 \begin_layout Itemize
9526 \begin_layout Itemize
9530 \begin_inset space ~
9536 \begin_layout Itemize
9540 \begin_inset space ~
9546 \begin_layout Itemize
9550 \begin_inset space ~
9557 \begin_layout Plain Layout
9558 \begin_inset space ~
9570 \begin_layout Standard
9571 There are also a few commands provided by
9573 Foil\SpecialChar TeX
9576 that aren't directly supported by \SpecialChar LyX
9577 but I'll tell you what they do and how
9578 to use them in section
9579 \begin_inset space ~
9583 \begin_inset CommandInset ref
9585 reference "sec:unsuppfoils"
9592 \begin_layout Subsubsection
9593 Building a Set of Foils
9596 \begin_layout Standard
9597 This section will give a simple introduction to using the different environments
9598 to build a set of foils.
9599 If you want to see an example set of foils, take a look at
9600 \change_deleted 564990737 1671643085
9605 file you find in \SpecialChar LyX
9611 \change_inserted 564990737 1671643099
9615 File\SpecialChar menuseparator
9618 \SpecialChar menuseparator
9619 Presentations\SpecialChar menuseparator
9627 \begin_layout Paragraph
9628 Give It a Title Page
9631 \begin_layout Standard
9632 Unlike other classes that provide
9652 creates the title on a page of its own.
9653 If you leave out the
9657 environment \SpecialChar LaTeX
9658 will substitute the current date (every time you regenerate
9662 \begin_layout Paragraph
9666 \begin_layout Standard
9667 As I mentioned earlier, there are four ways of starting a new foil.
9668 For portrait foils you should use
9677 The difference between these two environments is the amount of space between
9678 the title of the foil (the foilhead) and the body of the foil.
9681 \begin_layout Standard
9682 Landscape foils are generated using the
9691 Again the only difference is the spacing between foilhead and body.
9692 Both of the short versions have 0.5
9693 \begin_inset space ~
9696 inches less separation between the foilhead and the body.
9700 \begin_layout Standard
9701 One problem with the support for landscape foils is the requirement that
9706 driver to generate the PostScript output otherwise the foils won't be rotated.
9707 It is possible to get landscape foils even if you haven't got the
9711 driver provided you can feed your foils sideways through your printer ;-)
9714 \begin_layout Paragraph
9715 Theorems, Lemmas, Proofs and more
9718 \begin_layout Standard
9719 You can't have two of the same type of these environments directly following
9721 If you use a normal paragraph break, , you will just be extending the previous
9722 environment as if you had merged the two environments together.
9723 Rather than that, you need to insert a so-called separator.
9724 Please refer to the section entitled
9735 \begin_layout Paragraph
9739 \begin_layout Standard
9740 You get all the commonly supported list styles found in other classes as
9741 well as two new ones.
9742 I'll only describe the new ones here.
9743 If you want to find out more about the other list environments check out
9749 If you intend to use itemized lists you might also want to read about the
9753 \begin_inset space ~
9757 \begin_inset space ~
9762 dialog described above in section
9763 \begin_inset space ~
9767 \change_inserted 564990737 1671355684
9769 \begin_inset CommandInset ref
9771 reference "chap:bullets"
9776 \change_deleted 564990737 1671355684
9778 \begin_inset CommandInset ref
9780 reference "sec:bullet"
9789 \begin_layout Standard
9790 The two new list styles,
9798 , are designed to make it easier for you to create lists of do's and don'ts
9799 or right and wrong by providing dedicated environments that use a tick
9800 or a cross as the label of the list.
9801 These lists are in fact dedicated variants of the
9806 They do however require that you have the
9813 \begin_layout Paragraph
9817 \begin_layout Standard
9820 Foil\SpecialChar TeX
9823 redefines the floating tables and figures so that they appear exactly where
9824 they are in the text rather than pushing them to the top of the page or
9825 to some user specified location.
9826 In fact if you change the float placement settings they are simply ignored.
9829 \begin_layout Paragraph
9830 Page Headers and Footers
9831 \begin_inset CommandInset label
9840 \begin_layout Standard
9844 \begin_inset space ~
9853 are two commands used to control the left-footer text string.
9854 The first is meant to allow you to include a graphic logo on your foils
9856 \begin_inset Quotes eld
9861 Foil\SpecialChar TeX
9865 \begin_inset Quotes erd
9869 While the second is meant to provide a classification for the audience,
9873 \begin_inset space \thinspace{}
9879 \begin_inset space \space{}
9883 It is empty by default.
9886 \begin_layout Standard
9887 The remaining page corners can be filled by
9890 \begin_inset space ~
9895 (which defaults to page numbers),
9898 \begin_inset space ~
9906 \begin_inset space ~
9914 \begin_layout Subsubsection
9917 Foil\SpecialChar TeX
9921 \begin_inset CommandInset label
9923 name "sec:unsuppfoils"
9930 \begin_layout Standard
9931 All the commands mentioned below need to be set in a
9941 within another environment.
9944 \begin_layout Paragraph
9948 \begin_layout Standard
9949 All lengths are adjusted using the
9972 should be replaced by the name given to the length you want to change and
9977 is the length value.
9978 All lengths should be specified in units of length such as inches (
9990 ) or relative to some document or font-based length such as
10000 \begin_layout Standard
10001 It's possible to change the spacing between a foilhead and the body of the
10002 foil by adjusting the length specified by
10009 For example, to make
10014 \begin_inset space \space{}
10017 in closer to their bodies put the following in the preamble:
10023 foilheadskip}{-0.5in}
10026 \begin_layout Standard
10027 The spacings around floats can be adjusted by setting these lengths:
10030 \begin_layout Labeling
10031 \labelwidthstring MMMMMMMMMMM
10038 Separation between the text and the top of the float
10041 \begin_layout Labeling
10042 \labelwidthstring MMMMMMMMMMM
10049 Separation between the float and the caption
10052 \begin_layout Labeling
10053 \labelwidthstring MMMMMMMMMMM
10060 Separation between the caption and the following text
10063 \begin_layout Labeling
10064 \labelwidthstring MMMMMMMMMMM
10071 You can make the captions narrower than the surrounding text by adjusting
10073 Best done relative to
10082 \begin_layout Standard
10083 There are also several title page related lengths that you may find useful
10084 if you have a long title or several authors:
10087 \begin_layout Labeling
10088 \labelwidthstring MMMMMMMMMMM
10095 Separation from headers to
10100 \begin_layout Labeling
10101 \labelwidthstring MMMMMMMMMMM
10119 \begin_layout Labeling
10120 \labelwidthstring MMMMMMMMMMM
10134 \begin_layout Labeling
10135 \labelwidthstring MMMMMMMMMMM
10151 \begin_layout Labeling
10152 \labelwidthstring MMMMMMMMMMM
10168 \begin_layout Standard
10169 The last length related command affects all the list environments.
10180 a list environment then all the vertical spacing between the list items
10182 Note that this is a command not a length so it doesn't require
10188 like the stuff mentioned above.
10191 \begin_layout Paragraph
10192 Headers and Footers
10195 \begin_layout Standard
10208 commands control whether the logo in the
10212 definition appear on a given page.
10219 in the preamble then none of the foils will have the logo on them.
10220 If you don't want the logo on a particular page place the
10226 directly after the foilhead of that page and the
10232 directly after the next foilhead.
10235 \begin_layout Standard
10236 If you decide to use the
10240 page style setting in the
10243 \begin_inset space ~
10248 dialog you should probably add
10258 to your preamble so headers and footers on landscape pages are correctly
10259 placed when rotated.
10260 This is due to some clashes between the page layouts provided by the
10271 \begin_layout Subsection
10273 \change_inserted 564990737 1671459032
10279 \begin_layout Standard
10281 \change_inserted 564990737 1671643165
10287 \begin_inset space \thinspace{}
10296 document class for creating presentations.
10300 File\SpecialChar menuseparator
10301 Open Example\SpecialChar menuseparator
10302 Presentations\SpecialChar menuseparator
10306 offers guidance on its use.
10307 The documentation is available from
10308 \begin_inset CommandInset href
10311 target "http://mirrors.ctan.org/macros/latex/contrib/powerdot/doc/powerdot.pdf"
10319 \begin_layout Subsection
10321 \change_inserted 564990737 1671459032
10324 \begin_inset CommandInset label
10326 name "subsec:Seminar"
10335 \begin_layout Standard
10337 \change_inserted 564990737 1671643194
10343 \begin_inset space \thinspace{}
10352 document class for creating presentations.
10356 File\SpecialChar menuseparator
10357 Open Example\SpecialChar menuseparator
10358 Presentations\SpecialChar menuseparator
10362 offers guidance on its use.
10363 The documentation is available from
10364 \begin_inset CommandInset href
10367 target "http://mirrors.ctan.org/macros/latex/contrib/seminar/doc/seminar-doc.pdf"
10375 \begin_layout Subsection
10378 Sli\SpecialChar TeX
10382 \begin_inset CommandInset label
10391 \begin_layout Standard
10399 \begin_layout Subsubsection
10403 \begin_layout Standard
10404 This section describes how to use \SpecialChar LyX
10405 to make slides for overhead projectors.
10406 There are two document classes that can do this: the default slides class
10409 Foil\SpecialChar TeX
10413 This section documents the former.
10416 \begin_layout Standard
10417 I'm going to say this again, nice and clear, so that there's no misunderstanding
10421 \begin_layout Standard
10422 \begin_inset VSpace bigskip
10428 \begin_layout Standard
10432 This section documents the class
10433 \begin_inset Quotes eld
10441 \begin_inset Quotes erd
10449 \begin_layout Standard
10450 \begin_inset VSpace bigskip
10456 \begin_layout Standard
10457 If you're looking for the documentation for
10458 \begin_inset Quotes eld
10463 slides (Foil\SpecialChar TeX
10467 \begin_inset Quotes erd
10470 , check out section
10471 \begin_inset space ~
10475 \begin_inset CommandInset ref
10477 reference "sec:foiltex"
10487 \begin_inset Quotes eld
10492 slides (Foil\SpecialChar TeX
10496 \begin_inset Quotes erd
10499 ] is actually somewhat better than the default
10507 \begin_layout Plain Layout
10509 or so I've been told repeatedly by its advocates.
10510 Having never used it, I have no idea if this claim is true or not.
10515 which this section documents.
10518 \begin_layout Standard
10519 This class is the \SpecialChar LaTeX2e
10520 improvement of the old
10522 Sli\SpecialChar TeX
10526 Every \SpecialChar LaTeX2e
10527 distribution includes this class [which I'll just refer to as
10528 \begin_inset Quotes eld
10536 \begin_inset Quotes erd
10539 from now on], so you're bound to have it.
10540 As I noted earlier, there are other classes, such as
10544 , which also produce slides for overhead projectors and do a better job
10546 However, there are some things which
10550 can do which the others can't, such as generate overlays.
10551 Read on to learn more!
10554 \begin_layout Subsubsection
10556 \begin_inset CommandInset label
10558 name "sec:slidesetup"
10565 \begin_layout Standard
10566 Obviously, to use this document class, you need to select
10567 \begin_inset Quotes eld
10575 \begin_inset Quotes erd
10578 from the class list in the
10580 Document\SpecialChar menuseparator
10584 There are some other special things you should know about this class:
10587 \begin_layout Itemize
10588 Don't bother changing the options
10593 They're not supported by the
10600 \begin_layout Itemize
10604 \begin_inset space ~
10609 behaves a bit differently for this class.
10610 The possible choices and what they do are as follows:
10614 \begin_layout Description
10619 The final output contains page numbers in the lower right corner.
10622 \begin_layout Description
10631 , but also prints out any time markers you've put in.
10632 This is the default.
10635 \begin_layout Description
10640 The final output contains no page numbers, time markers, or alignment markers.
10644 \begin_layout Itemize
10649 class has an extra option:
10655 \begin_inset Quotes eld
10663 \begin_inset Quotes erd
10666 in the extra class options.
10670 \begin_layout Standard
10671 Using this options allows you to add time markers to
10677 \begin_inset space ~
10681 \begin_inset CommandInset ref
10683 reference "sec:slideNote"
10691 \begin_layout Standard
10692 You can also use the template file
10693 \change_deleted 564990737 1671617694
10695 \begin_inset Quotes eld
10703 \begin_inset Quotes erd
10708 to automatically set up a document to use the
10713 \change_deleted 564990737 1671617699
10718 File\SpecialChar menuseparator
10720 \begin_inset space ~
10724 \begin_inset space ~
10728 \change_inserted 564990737 1671617723
10729 \SpecialChar menuseparator
10730 Presentations\SpecialChar menuseparator
10735 to open your new document
10736 \change_deleted 564990737 1671617728
10740 The template file also contains some examples of the special paragraph
10741 environments used by this class.
10742 I'll describe those next.
10745 \begin_layout Subsubsection
10746 Paragraph Environments
10749 \begin_layout Paragraph
10750 Supported Environments
10753 \begin_layout Standard
10754 The first thing you'll notice when you start up a new
10758 document is the font size and type: it's the equivalent of the size
10759 \begin_inset Quotes eld
10767 \begin_inset Quotes erd
10773 \begin_inset space ~
10779 This is also what's used in the output.
10781 \begin_inset Quotes eld
10785 \begin_inset Quotes erd
10788 to remind you that this is a slide.
10789 Your final slides will use a larger font; ergo, you'll have less space.
10790 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
10793 \begin_layout Standard
10794 The next thing that becomes obvious is the changes to the paragraph environment
10795 pull-down box [at the far-left end of the toolbar].
10796 Most of the paragraph environments you're used to seeing are missing.
10797 There are also five new ones.
10802 class itself only supports certain paragraph environments:
10805 \begin_layout Itemize
10811 \begin_layout Itemize
10817 \begin_layout Itemize
10823 \begin_layout Itemize
10829 \begin_layout Itemize
10835 \begin_layout Itemize
10841 \begin_layout Itemize
10847 \begin_layout Itemize
10853 \begin_layout Itemize
10859 \begin_layout Itemize
10866 \begin_layout Standard
10867 All of the other standard environments, including the section-heading environmen
10868 ts, aren't used in the
10875 \begin_layout Standard
10876 On the other hand, you'll notice the following new environments:
10879 \begin_layout Itemize
10885 \begin_layout Itemize
10891 \begin_layout Itemize
10897 \begin_layout Itemize
10903 \begin_layout Itemize
10909 \begin_layout Standard
10910 These five are kind of quirky, due to a
10911 \begin_inset Quotes eld
10915 \begin_inset Quotes erd
10918 in \SpecialChar LyX
10920 You see, \SpecialChar LyX
10921 doesn't permit you to nest any other paragraph environment into
10922 an empty environment.
10923 Now, that's fine and dandy, but it means that you wouldn't be able to start
10924 a slide with anything except plain text.
10925 To deal with this, I've performed a little
10926 \begin_inset Quotes eld
10931 \begin_inset Quotes erd
10937 \begin_layout Paragraph
10938 Quirks of the New Environments
10939 \begin_inset CommandInset label
10941 name "sec:slideQuirk"
10948 \begin_layout Standard
10949 All five of the new paragraph environments are somewhat quirky due to inherent
10950 limitiations in the current version of \SpecialChar LyX
10952 As I just mentioned, \SpecialChar LyX
10953 forbids environments that begin with another environment.
10954 To get around this, the
10958 environment isn't a paragraph environment as described in the
10966 \begin_layout Standard
10967 You should consider
10980 \begin_inset Quotes eld
10983 pseudo-environments.
10984 \begin_inset Quotes erd
10987 They look like a section heading or a
10988 \begin_inset Quotes eld
10996 \begin_inset Quotes erd
10999 but really begin a [and, if necessary, end the previous] paragraph environment.
11009 \begin_inset Quotes eld
11013 \begin_inset Quotes erd
11016 These two perform some action.
11019 \begin_layout Standard
11020 A common feature of all five environments,
11040 , is a rather long-ish label.
11041 The text following this label — ordinarily the contents of the paragraph
11042 environment — is utterly irrelevant for
11064 completely ignores it.
11065 In fact, you can leave these five environments completely empty.
11069 \begin_layout Standard
11074 to put any text after the rather long-ish label, you might want to.
11075 This could be a short description of the contents of the
11080 In that case, enter your descriptive comment and hit
11084 as you normally would.
11087 \begin_layout Standard
11088 If, on the other hand, you don't want to enter any descriptive text, you'll
11089 hit another \SpecialChar LyX
11092 , like nature, abhors a vacuum, and will not let you start a new paragraph
11093 environment until you put something in the old one.
11097 \begin_layout Itemize
11098 Start entering the text that will
11126 \begin_layout Itemize
11127 Now move to the beginning of that paragraph.
11131 \begin_layout Itemize
11140 \begin_layout Itemize
11141 Finally, change this new, empty paragraph to a
11165 \begin_layout Standard
11166 Some future version of \SpecialChar LyX
11167 will, hopefully, resolve this quirkiness\SpecialChar ldots
11171 \begin_layout Subsubsection
11172 Making a Presentation with
11185 \begin_layout Paragraph
11193 \begin_layout Standard
11194 If you're expecting this section to teach you how to actually make a presentatio
11195 n, you'll be sorely disappointed.
11196 Naturally, I'll describe all of the ways the
11200 class can assist you in preparing the materials for a presentation.
11201 Filling in the contents, however, is up to you.
11206 the \SpecialChar LyX
11210 \begin_layout Standard
11215 environment [in the manner described in section
11216 \begin_inset space ~
11220 \begin_inset CommandInset ref
11222 reference "sec:slideQuirk"
11226 ] tells \SpecialChar LyX
11227 to begin a new slide [duh].
11228 The label for this environment/
11229 \begin_inset Quotes erd
11233 \begin_inset Quotes erd
11237 \begin_inset Quotes eld
11241 \begin_inset Quotes erd
11244 in cool blue, followed by the label,
11245 \begin_inset Quotes eld
11249 \begin_inset Quotes erd
11253 Any text or paragraph environments that follow this one go on the new slide.
11257 \begin_layout Standard
11258 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
11260 (this can be specified in the
11265 In fact, you'll want to, once you finish entering the contents of one slide.
11266 If you've entered more text than can physically fit on a slide, the extra
11267 overflows onto a new slide.
11268 I don't recommend doing this, however, since the overflow slide won't have
11269 any page number on it.
11270 Furthermore, it may interfere with any
11274 you've made to accompany the oversized
11281 \begin_layout Standard
11290 environments work the same way as the
11295 They both create an
11296 \begin_inset Quotes eld
11300 \begin_inset Quotes erd
11303 followed by a label [
11304 \begin_inset Quotes eld
11308 \begin_inset Quotes erd
11312 \begin_inset Quotes eld
11316 \begin_inset Quotes erd
11320 The color is a stunning magenta instead of blue, and the
11321 \begin_inset Quotes eld
11325 \begin_inset Quotes erd
11328 will look different, in style and in length.
11329 The label fonts of all three also differ from one another.
11332 \begin_layout Standard
11337 , if the contents of a
11345 exceed the physical size of a slide or sheet of paper, the extra will overflow
11347 Again, you should avoid this.
11348 It defeats the whole purpose of
11359 \begin_layout Paragraph
11369 \begin_layout Standard
11374 is a slide that sits atop another slide.
11375 Perhaps you wish to discuss a figure on the main
11379 before displaying the text associated with it.
11380 One way to accomplish this is tape a flap of dark paper over the part of
11385 you want to display later.
11386 This method fails, however, if you wish to overlap one graph with another,
11388 You would then have to fumble while speaking to align the two separate,
11393 s to align the two graphs.
11398 environment in both cases makes life much easier.
11401 \begin_layout Standard
11406 receives the page number of its
11407 \begin_inset Quotes eld
11411 \begin_inset Quotes erd
11419 \begin_inset Quotes eld
11427 \begin_inset Quotes erd
11434 \begin_layout Plain Layout
11435 Presumably, mutliple
11440 \begin_inset Quotes eld
11448 \begin_inset Quotes erd
11452 \begin_inset Quotes eld
11460 \begin_inset Quotes erd
11464 \begin_inset Quotes eld
11472 \begin_inset Quotes erd
11476 \begin_inset space ~
11479 appended to the page number of the parent
11489 Clearly, you want the contents of both the
11497 to each fit on a single physical slide! You should probably consider an
11503 \begin_inset Quotes eld
11507 \begin_inset Quotes erd
11515 Indeed, the \SpecialChar LyX
11520 class provides a visual cue for this: the label at the start of an
11524 is shorter than that at the start of a
11529 Lastly, when you generate printable output, you'll find alignment markers
11530 in all four corners of both the
11534 page and its parent
11539 These will assist you in lining up the two physical slides.
11542 \begin_layout Standard
11543 The major problem in overlaying two slides is aligning the contents of the
11544 two transparencies.
11545 How much space should you leave for that graph on the second slide? Worse
11546 still, what if you want a graph and a sentence on second slide, but there
11547 is text on the main transparency that goes in between them? You could try
11548 and insert vertical space of the right size.
11549 The better way is to use
11560 \begin_layout Standard
11561 As their names imply,
11569 are two command-like paragraph environments that make all subsequent text
11570 invisible and visible, respectively.
11572 \begin_inset space ~
11576 \begin_inset CommandInset ref
11578 reference "sec:slideQuirk"
11582 that you don't place anything
11586 these two environments, however.
11591 , it inserts a centered, sky-blue label into the page reading
11592 \begin_inset Quotes eld
11595 <Invisible Text Follows>
11596 \begin_inset Quotes erd
11600 For paragraphs following this label, the parts of the
11608 ; it doesn't matter which] where they would be contain instead blank space.
11612 \begin_layout Standard
11617 , the corresponding centered label is
11618 \begin_inset Quotes eld
11621 <Visible Text Follows>
11622 \begin_inset Quotes erd
11626 Paragraphs following this label behave normally.
11627 Note that the beginning of a new
11639 automatically shuts off an
11644 It's therefore not necessary to use
11655 \begin_layout Standard
11656 By now, it should be obvious how to create overlay transparencies using
11657 the proper combination of
11676 \begin_layout Enumerate
11681 , including everything that will appear on it, whether on the main slide
11689 \begin_layout Enumerate
11690 Before each figure or paragraph that will appear only on the
11699 If necessary, insert a
11703 environment after the
11710 \begin_layout Enumerate
11715 immediately following the
11722 \begin_layout Enumerate
11723 Copy the contents of this
11734 \begin_layout Enumerate
11739 , change all of the
11750 \begin_layout Standard
11752 You've just made an
11759 \begin_layout Standard
11760 There's one problem with the way I've designed the \SpecialChar LyX
11765 class: you can't make text in the middle of a paragraph invisible, nor
11766 make text in the middle of an invisible paragraph visible again.
11767 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
11772 \begin_layout Plain Layout
11773 The commands of interest are:
11776 \begin_layout Itemize
11781 invisible \SpecialChar ldots
11785 \begin_layout Itemize
11790 visible \SpecialChar ldots
11794 \begin_layout Plain Layout
11796 and need to be marked as \SpecialChar TeX
11799 \begin_inset Quotes eld
11803 \begin_inset Quotes erd
11806 you wish to change goes in between the brackets [and after the
11819 If you don't know how to mark text as \SpecialChar TeX
11820 , see the appropriate section of
11833 \begin_layout Paragraph
11843 \begin_inset CommandInset label
11845 name "sec:slideNote"
11852 \begin_layout Standard
11861 is associated with a
11862 \begin_inset Quotes eld
11866 \begin_inset Quotes erd
11874 Here, too, the \SpecialChar LyX
11879 class provides visual cues.
11884 is shorter than that of a
11888 [yet longer than that of an
11892 ] and, like the label of an
11896 is shockingly magenta.
11897 Additionally, the printed
11901 has the page number of its
11902 \begin_inset Quotes eld
11906 \begin_inset Quotes erd
11914 \begin_inset Quotes eld
11922 \begin_inset Quotes erd
11926 \begin_inset Quotes eld
11934 \begin_inset Quotes erd
11938 \begin_inset Quotes eld
11946 \begin_inset Quotes erd
11950 You can have multiple
11954 s associated with a single
11966 , you'll probably want to break up long
11970 s so that they fit on a single sheet of paper.
11973 \begin_layout Standard
11978 is obvious: it contains anything additional you might want to say about
11984 It could also be used as a sheet of reminders for a particular
11989 In the case of the latter, you might want to make use of time markers.
11990 Currently, the \SpecialChar LyX
11996 \begin_inset Quotes eld
12000 \begin_inset Quotes erd
12003 support for time markers, a
12005 Sli\SpecialChar TeX
12009 So, you'll have to resort to using the \SpecialChar LaTeX
12013 \begin_layout Standard
12014 To use time markers, you'll need to specify the extra class option
12015 \begin_inset Quotes eld
12023 \begin_inset Quotes erd
12027 \begin_inset space ~
12031 \begin_inset CommandInset ref
12033 reference "sec:slidesetup"
12038 This option turns on timing marks, which will appear in the lower-left-hand
12044 To set what appears in the time marker, you use the \SpecialChar LaTeX
12046 \begin_inset Quotes eld
12056 \begin_inset Quotes erd
12060 \begin_inset Quotes eld
12070 \begin_inset Quotes erd
12074 The arguments of both commands are time measured in seconds.
12076 \begin_inset Quotes eld
12086 \begin_inset Quotes erd
12089 sets the time marker to a given time.
12091 \begin_inset Quotes eld
12101 \begin_inset Quotes erd
12104 increments the time marker by the specified amount.
12105 Using time markers and
12109 s in this fashion, you can remind yourself how much time to spend on a particula
12117 \begin_layout Standard
12118 There's one last feature to describe.
12119 Clearly, you'd like to print out all of your
12127 s on transparencies while printing all of your
12144 with which it is associated.
12145 What's a person to do?
12148 \begin_layout Standard
12149 Luckily, there are two \SpecialChar LaTeX
12150 commands that allow you to select what to print
12152 Both must be placed into the preamble of your document.
12154 \begin_inset Quotes eld
12166 \begin_inset Quotes erd
12169 will cause the output to contain only the
12178 Correspondingly, the command
12179 \begin_inset Quotes eld
12191 \begin_inset Quotes erd
12194 prevents the output of anything but
12199 I'd advise placing both commands in the preamble and initially comment
12201 You can then preview your entire presentation as you write.
12202 When you're done writing, you can then uncomment one of the two to select
12203 what you want to print.
12204 I like to uncomment
12205 \begin_inset Quotes eld
12217 \begin_inset Quotes erd
12220 , print to a file with
12221 \begin_inset Quotes eld
12229 \begin_inset Quotes erd
12232 in its name, comment it back out, then uncomment
12233 \begin_inset Quotes eld
12245 \begin_inset Quotes erd
12249 \begin_inset Quotes eld
12257 \begin_inset Quotes erd
12261 I can then send either file to a printer, loading transparencies or plain
12262 paper as appropriate.
12265 \begin_layout Standard
12266 You can also provide other arguments to the
12267 \begin_inset Quotes eld
12277 \begin_inset Quotes erd
12281 \begin_inset Quotes eld
12291 \begin_inset Quotes erd
12295 See a good \SpecialChar LaTeX
12299 \begin_layout Subsubsection
12304 Class Template File
12307 \begin_layout Standard
12308 I have also provided a template file
12309 \change_deleted 564990737 1671617750
12311 \begin_inset Quotes eld
12319 \begin_inset Quotes erd
12329 To use it, begin your new presentation with
12331 File\SpecialChar menuseparator
12333 \begin_inset space ~
12337 \begin_inset space ~
12341 \change_inserted 564990737 1671616988
12342 \SpecialChar menuseparator
12343 Presentations\SpecialChar menuseparator
12349 Your new \SpecialChar LyX
12350 presentation file will contain an example
12371 additionally contain an example of the use of
12380 Lastly, the preamble will contain:
12383 \begin_layout LyX-Code
12384 % Uncomment to print out only slides and overlays
12387 \begin_layout LyX-Code
12391 \begin_layout LyX-Code
12397 \begin_inset Newline newline
12403 \begin_layout LyX-Code
12404 % Uncomment to print out only notes
12407 \begin_layout LyX-Code
12411 \begin_layout LyX-Code
12419 \begin_layout Standard
12420 One final thing: I created this class to support the \SpecialChar LaTeX2e
12422 \begin_inset Quotes eld
12427 Sli\SpecialChar TeX
12431 \begin_inset Quotes erd
12434 class, one of the built-in \SpecialChar LaTeX2e
12436 Neither I nor the rest of the \SpecialChar LyX
12437 Team endorse or oppose the use of this built-in
12439 It's here if you want it or need it.
12440 There exist other \SpecialChar LaTeX2e
12441 classes for creating presentations, such as the
12446 \begin_inset space ~
12450 \begin_inset CommandInset ref
12452 reference "sec:foiltex"
12457 \begin_inset Quotes eld
12465 \begin_inset Quotes erd
12468 package [present on some \SpecialChar TeX
12470 The latter is not yet supported under \SpecialChar LyX
12475 \begin_layout Plain Layout
12476 Perhaps you can take on the task\SpecialChar ldots
12482 I know nothing about these other classes.
12483 Try them out to see what sort of alternative they provide.
12486 \begin_layout Section
12488 \change_inserted 564990737 1670439661
12492 \begin_layout Subsection
12494 \change_inserted 564990737 1670439661
12498 \begin_layout Standard
12500 \change_inserted 564990737 1670439661
12509 document class for preparing reports.
12514 document class, this provides parts, chapters and sections but does not
12515 provide the paragraph styles needed for a book; like the
12519 document class, it provides the abstract paragraph style.
12520 In two-sided mode, it does not start a new chapter on the right hand page.
12523 \begin_layout Standard
12525 \change_inserted 564990737 1670439674
12530 document classes are described in the Collections (section
12531 \begin_inset space ~
12535 \begin_inset CommandInset ref
12537 reference "sec:Collections"
12544 \begin_layout Section
12546 \change_inserted 564990737 1670439674
12550 \begin_layout Subsection
12554 \begin_layout Standard
12560 \begin_layout Subsubsection
12564 \begin_layout Standard
12565 Broadway is for writing plays.
12566 The format is more decorative than Hollywood, and much less standardized.
12567 This format should be suitable for workshops.
12570 \begin_layout Subsubsection
12574 \begin_layout Standard
12575 The same as in Hollywood.
12578 \begin_layout Subsubsection
12582 \begin_layout Standard
12587 names as labels then cross-reference the label to insert the name.
12588 The cross-reference dialog will show the current cast of characters.
12591 \begin_layout Subsubsection
12592 Paper size and Margins
12595 \begin_layout Standard
12596 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12599 \begin_layout Subsubsection
12603 \begin_layout Standard
12604 The following environments are available.
12605 You can use broadway.bind to get the bind keys shown at the right.
12608 \begin_layout Itemize
12612 \begin_inset Newline newline
12617 You should not have to use this, but it is here for anything that does not
12621 \begin_layout Itemize
12625 \begin_inset space \hfill{}
12629 \begin_inset Newline newline
12634 Used to describe stage setting and the action.
12635 First use of speaker names in all CAPs.
12638 \begin_layout Itemize
12642 \begin_inset space \hfill{}
12646 \begin_inset Newline newline
12651 Automatically numbered.
12652 On screen it will be arabic, but will print as Roman.
12655 \begin_layout Itemize
12659 \begin_inset space \hfill{}
12663 \begin_inset Newline newline
12673 It is just centered text.
12676 \begin_layout Itemize
12680 \begin_inset space \hfill{}
12684 \begin_inset Newline newline
12689 Not automatically numbered.
12690 You supply the number.
12691 This is because I couldn't figure out how.
12694 \begin_layout Itemize
12698 \begin_inset space \hfill{}
12702 \begin_inset Newline newline
12707 A special case of Narrative to describe the setting and action as the curtain
12711 \begin_layout Itemize
12715 \begin_inset space \hfill{}
12719 \begin_inset Newline newline
12724 The speaker's (actor's) title, centered in all CAPS.
12727 \begin_layout Itemize
12731 \begin_inset space \hfill{}
12735 \begin_inset Newline newline
12740 Instructions to the speaker.
12741 The parentheses are automatically inserted.
12742 The ( will appear on screen, but both will be in the printed play.
12743 This environment is only used within
12750 \begin_layout Itemize
12754 \begin_inset space \hfill{}
12758 \begin_inset Newline newline
12763 What the Speaker says.
12766 \begin_layout Itemize
12770 \begin_inset space \hfill{}
12774 \begin_inset Newline newline
12779 The curtain comes down.
12782 \begin_layout Itemize
12786 \begin_inset space \hfill{}
12792 \begin_layout Itemize
12796 \begin_inset space \hfill{}
12802 \begin_layout Itemize
12806 \begin_inset space \hfill{}
12812 \begin_layout Standard
12816 \begin_layout Subsection
12817 Hollywood (Hollywood spec scripts)
12820 \begin_layout Standard
12826 \begin_layout Subsubsection
12830 \begin_layout Standard
12831 Getting the format of a Hollywood script right is a
12832 \begin_inset Quotes eld
12836 \begin_inset Quotes erd
12839 It is designed to make the readers focus on content and to be easy and
12840 familiar for the actors to read.
12841 Each page of a script should be one minute of film.
12842 Nothing goes in a script that you cannot see or hear on screen.
12843 The courier 12 pt font should be used throughout.
12847 \begin_layout Subsubsection
12851 \begin_layout Standard
12852 Speakers' lines should NEVER break in mid-sentence.
12853 If a speaker's lines continue over a page break, repeat the
12857 title followed by (Cont'd).
12860 \begin_layout Subsubsection
12864 \begin_layout Standard
12869 names as labels then cross-reference the label to insert the name.
12870 The cross-reference dialog will show the current cast of characters.
12871 You can use this to insert the speaker name in narratives also.
12874 \begin_layout Subsubsection
12875 Paper size and Margins
12878 \begin_layout Standard
12879 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12882 \begin_layout Subsubsection
12886 \begin_layout Standard
12887 The following environments are available.
12888 You can use hollywood.bind to get the bind keys shown at the right.
12891 \begin_layout Itemize
12895 \begin_inset Newline newline
12900 Used where nothing else works.
12904 \begin_layout Itemize
12910 \begin_inset space \hfill{}
12918 \begin_inset Newline newline
12921 Usually followed by something like
12922 \begin_inset Quotes eld
12925 on Sally waking up.
12926 \begin_inset Quotes erd
12932 \begin_layout Itemize
12936 \begin_inset space \hfill{}
12940 \begin_inset Newline newline
12945 Introduces a new INTERIOR camera set-up.
12946 Always followed by DAY or NIGHT, or something similar to define the lighting
12948 Everthing on this line in CAPS.
12951 \begin_layout Itemize
12955 \begin_inset space \hfill{}
12959 \begin_inset Newline newline
12964 Introduces a new EXTERIOR camera set-up.
12965 Everthing on this line in CAPS.
12968 \begin_layout Itemize
12972 \begin_inset space \hfill{}
12976 \begin_inset Newline newline
12981 The character speaking.
12984 \begin_layout Itemize
12988 \begin_inset space \hfill{}
12992 \begin_inset Newline newline
12997 Instructions to the speaker.
12998 The () are automatically inserted.
13001 \begin_layout Itemize
13005 \begin_inset space \hfill{}
13009 \begin_inset Newline newline
13021 \begin_layout Itemize
13025 \begin_inset space \hfill{}
13029 \begin_inset Newline newline
13034 Camera movement instruction.
13036 \begin_inset space \thinspace{}
13040 \begin_inset space \space{}
13046 \begin_layout Itemize
13050 \begin_inset space \hfill{}
13056 \begin_layout Itemize
13060 \begin_inset space \hfill{}
13066 \begin_layout Itemize
13070 \begin_inset space \hfill{}
13076 \begin_layout Itemize
13080 \begin_inset space \hfill{}
13086 \begin_layout Subsubsection
13090 \begin_layout Itemize
13094 \begin_layout Itemize
13098 \begin_layout Itemize
13100 \begin_inset space \thinspace{}
13107 \begin_layout Itemize
13112 \begin_layout Itemize
13113 PAN — camera movement
13116 \begin_layout Itemize
13117 INSERT — cut to close-up of
13120 \begin_layout Chapter
13122 \change_inserted 564990737 1671185876
13126 \begin_layout Section
13128 \change_inserted 564990737 1671716212
13131 Academic Field Specifics
13134 \begin_layout Subsection
13136 \change_inserted 564990737 1671716212
13139 Chemistry: Hazard and Precautionary Statements
13142 \begin_layout Standard
13144 \change_inserted 564990737 1671716212
13147 This module provides two insets to typeset numbers and phrases of chemical
13148 hazard and precautionary statements.
13149 For a description see
13152 File\SpecialChar menuseparator
13153 Open Example\SpecialChar menuseparator
13154 Modules\SpecialChar menuseparator
13155 Hazard and Precautionary Statements
13159 Help\SpecialChar menuseparator
13160 Specific Manuals\SpecialChar menuseparator
13161 Hazard and Precautionary Statements
13167 \begin_layout Subsection
13169 \change_inserted 564990737 1671716212
13173 Chemistry: Risk and Safety Statements
13176 \begin_layout Standard
13178 \change_inserted 564990737 1671716212
13181 This module provides two insets,
13189 , accessible via the menu
13194 nsert\SpecialChar menuseparator
13196 \begin_inset space ~
13201 and an environment to typeset numbers and phrases of chemical risk and
13205 \begin_layout Subsection
13207 \change_inserted 564990737 1671716212
13213 \begin_layout Standard
13215 \change_inserted 564990737 1671716212
13218 This module uses the
13222 package to add environments useful for linguistics (numbered examples,
13223 glosses, semantic markup, tableau floats).
13224 You can obtain information about this module in
13229 elp\SpecialChar menuseparator
13235 \begin_inset space ~
13238 Manuals\SpecialChar menuseparator
13248 File\SpecialChar menuseparator
13249 Open Example\SpecialChar menuseparator
13252 Modules\SpecialChar menuseparator
13258 \begin_layout Section
13260 \change_inserted 564990737 1671788778
13266 \begin_layout Subsection
13268 \change_inserted 564990737 1671788778
13274 \begin_layout Standard
13276 \change_inserted 564990737 1671788778
13279 This module supports the Braille writing system.
13280 It requires the \SpecialChar LaTeX
13286 This and its documentation can be obtained from
13287 \begin_inset CommandInset href
13290 target "https://www.ctan.org/pkg/braille"
13296 You do not have to reconfigure your system after installing it.
13302 elp\SpecialChar menuseparator
13308 \begin_inset space ~
13311 Manuals\SpecialChar menuseparator
13320 File\SpecialChar menuseparator
13321 Open Example\SpecialChar menuseparator
13322 Modules\SpecialChar menuseparator
13328 \begin_layout Section
13330 \change_inserted 564990737 1671788778
13333 Annotation & Revision
13336 \begin_layout Subsection
13338 \change_inserted 564990737 1671788778
13344 \begin_layout Standard
13346 \change_inserted 564990737 1671788778
13349 This module provides “FiXme” (marginal) annotations for document revision
13351 A list of annotations can be produced by using the “List of FIXMEs” paragraph
13353 The annotations are customizable via the LaTeX preamble.
13354 See the FiXme documentation which can be obtained from
13355 \begin_inset CommandInset href
13358 target "http://mirrors.ctan.org/macros/latex/contrib/fixme/fixme.pdf"
13367 \begin_layout Paragraph
13369 \change_inserted 564990737 1671788778
13375 \begin_layout Standard
13377 \change_inserted 564990737 1671788778
13380 by default, the notes are only displayed in “draft” mode (if the option
13381 “draft” has been inserted in
13383 Document\SpecialChar menuseparator
13384 Settings\SpecialChar menuseparator
13385 Document Class\SpecialChar menuseparator
13386 Class Options\SpecialChar menuseparator
13390 To display them always, insert
13398 Document\SpecialChar menuseparator
13399 Settings\SpecialChar menuseparator
13407 \begin_layout Subsection
13409 \change_inserted 564990737 1671788778
13415 \begin_layout Standard
13417 \change_inserted 564990737 1671788778
13420 This module provides various kinds of annotations for PDF output.
13423 Help\SpecialChar menuseparator
13424 Specific Manuals\SpecialChar menuseparator
13425 PDF comments and File\SpecialChar menuseparator
13426 Open Example\SpecialChar menuseparator
13427 Modules\SpecialChar menuseparator
13433 \begin_layout Subsection
13435 \change_inserted 564990737 1671788778
13442 \begin_layout Standard
13444 \change_inserted 564990737 1671788778
13447 This module provides fields and buttons for PDF forms.
13449 \begin_inset CommandInset href
13451 name "hyperref documentation"
13452 target "http://mirrors.ctan.org/macros/latex/contrib/hyperref/doc/hyperref-doc.pdf"
13459 Help\SpecialChar menuseparator
13460 Specific Manuals\SpecialChar menuseparator
13461 PDF forms and File\SpecialChar menuseparator
13462 Open Example\SpecialChar menuseparator
13463 Modules\SpecialChar menuseparator
13469 \begin_layout Subsection
13471 \change_inserted 564990737 1671788778
13478 \begin_layout Standard
13480 \change_inserted 564990737 1671788778
13483 This module defines an inset to typeset reading aids (ruby, furigana) to
13484 Chinese characters.
13485 It uses the “okumakro,” “luatexja-ruby” or “ruby” package (depending on
13486 the TeX engine) or a fallback definition.
13490 \begin_layout Subsection
13492 \change_inserted 564990737 1671788778
13499 \begin_layout Standard
13501 \change_inserted 564990737 1671788778
13504 This module provides custom insets to insert TODO items in your document.
13505 In order to generate a “List of TODOs,” the module provides a paragraph
13507 Inserting “final” in
13509 Document\SpecialChar menuseparator
13510 Settings\SpecialChar menuseparator
13511 Document Class\SpecialChar menuseparator
13512 Class Options\SpecialChar menuseparator
13515 ) suppresses the output of TODO notes.
13517 \begin_inset CommandInset href
13519 name "todonotes documentation"
13520 target "http://mirrors.ctan.org/macros/latex/contrib/todonotes/todonotes.pdf"
13528 \begin_layout Section
13530 \change_inserted 564990737 1671829045
13536 \begin_layout Subsection
13538 \change_inserted 564990737 1671829045
13541 APA Style with NatBib
13544 \begin_layout Standard
13546 \change_inserted 564990737 1671829045
13549 This module adds support for using natbib together with apacite (the bibliograph
13550 y style need not be apacite — it could be apacite, apacitex, or any bibliography
13551 that works with both the natbib and apacite packages.)
13554 \begin_layout Section
13556 \change_inserted 564990737 1671829045
13562 \begin_layout Subsection
13564 \change_inserted 564990737 1671829045
13567 Fancy Colored Boxes
13570 \begin_layout Standard
13572 \change_inserted 564990737 1671829045
13575 This module adds ten custom insets that support colored boxes via the tcolorbox
13579 Help\SpecialChar menuseparator
13580 Specific Manuals\SpecialChar menuseparator
13585 File\SpecialChar menuseparator
13586 Open Example\SpecialChar menuseparator
13587 Modules\SpecialChar menuseparator
13591 \begin_inset CommandInset href
13593 name "tcolorbox documentation"
13594 target "http://mirrors.ctan.org/macros/latex/contrib/tcolorbox/tcolorbox.pdf"
13603 \begin_layout Subsection
13605 \change_inserted 564990737 1671829045
13611 \begin_layout Standard
13613 \change_inserted 564990737 1671829045
13616 This provides the custom insets
13632 to scale and rotate its content.
13635 \begin_layout Standard
13637 \change_inserted 564990737 1671829045
13643 is a simple way of reversing text without any other enhancement:
13646 \begin_layout Standard
13648 \change_inserted 564990737 1671829045
13651 \begin_inset Flex Reflectbox
13654 \begin_layout Plain Layout
13656 \change_inserted 564990737 1671829045
13659 Great Western Railway
13669 \begin_layout Standard
13671 \change_inserted 564990737 1671829045
13674 (You will need to use Ctrl-R to see any of these examples.)
13677 \begin_layout Standard
13679 \change_inserted 564990737 1671829045
13685 allows you to specify the dimensions of the text or image; permissible
13686 units are em, ex, in, pt, pc, cm, mm, dd, cc, nd, nc, bp, or sp; if you
13695 it scales by the width factor:
13698 \begin_layout Standard
13700 \change_inserted 564990737 1671829045
13703 \begin_inset Flex Resizebox
13706 \begin_layout Plain Layout
13708 \change_inserted 564990737 1671829045
13711 \begin_inset Argument 1
13714 \begin_layout Plain Layout
13716 \change_inserted 564990737 1671829045
13727 \begin_inset Argument 2
13730 \begin_layout Plain Layout
13732 \change_inserted 564990737 1671829045
13742 Great Western Railway
13752 \begin_layout Standard
13754 \change_inserted 564990737 1671829045
13760 allows you to rotate text around the reference point of the box.
13761 If you wish to rotate the box around a different origin, place the cursor
13762 inside the box and select Insert\SpecialChar menuseparator
13787 or meaningful combinations of these and the counterclockwise rotation angle
13788 is expressed in degrees.
13792 \begin_layout Standard
13794 \change_inserted 564990737 1671829045
13797 \begin_inset Flex Rotatebox
13800 \begin_layout Plain Layout
13802 \change_inserted 564990737 1671829045
13805 \begin_inset Argument 1
13808 \begin_layout Plain Layout
13810 \change_inserted 564990737 1671829045
13821 \begin_inset Argument 2
13824 \begin_layout Plain Layout
13826 \change_inserted 564990737 1671829045
13836 Great Western Railway
13846 \begin_layout Standard
13848 \change_inserted 564990737 1671829045
13851 You can combine boxes as in:
13854 \begin_layout Standard
13856 \change_inserted 564990737 1671829045
13859 \begin_inset Flex Rotatebox
13862 \begin_layout Plain Layout
13864 \change_inserted 564990737 1671829045
13867 \begin_inset Argument 1
13870 \begin_layout Plain Layout
13872 \change_inserted 564990737 1671829045
13883 \begin_inset Argument 2
13886 \begin_layout Plain Layout
13888 \change_inserted 564990737 1671829045
13899 \begin_inset Flex Resizebox
13902 \begin_layout Plain Layout
13904 \change_inserted 564990737 1671829045
13907 \begin_inset Argument 1
13910 \begin_layout Plain Layout
13912 \change_inserted 564990737 1671829045
13923 \begin_inset Argument 2
13926 \begin_layout Plain Layout
13928 \change_inserted 564990737 1671829045
13939 \begin_inset Flex Reflectbox
13942 \begin_layout Plain Layout
13944 \change_inserted 564990737 1671829045
13947 Great Western Railway
13971 \begin_layout Standard
13973 \change_inserted 564990737 1671829045
13979 scales text; select Insert\SpecialChar menuseparator
13980 V-Factor to add a vertical factor.
13981 If the vertical factor is omitted, the horizontal is used.
13982 Adding different horizontal and vertical values creates distortion as in
13986 \begin_layout Standard
13988 \change_inserted 564990737 1671829045
13992 \begin_inset Flex Scalebox
13995 \begin_layout Plain Layout
13997 \change_inserted 564990737 1671829045
14000 \begin_inset Argument 1
14003 \begin_layout Plain Layout
14005 \change_inserted 564990737 1671829045
14016 \begin_inset Argument 2
14019 \begin_layout Plain Layout
14021 \change_inserted 564990737 1671829045
14033 Great Western Railway
14043 \begin_layout Standard
14045 \change_inserted 564990737 1671829045
14048 A negative horizontal value reverses the text and a negative vertical value
14049 inverts it so that you get
14052 \begin_layout Standard
14054 \change_inserted 564990737 1671829045
14057 \begin_inset Flex Scalebox
14060 \begin_layout Plain Layout
14062 \change_inserted 564990737 1671829045
14065 \begin_inset Argument 1
14068 \begin_layout Plain Layout
14070 \change_inserted 564990737 1671829045
14081 \begin_inset Argument 2
14084 \begin_layout Plain Layout
14086 \change_inserted 564990737 1671829045
14096 Great Western Railway
14104 \begin_inset Flex Scalebox
14107 \begin_layout Plain Layout
14109 \change_inserted 564990737 1671829045
14112 \begin_inset Argument 1
14115 \begin_layout Plain Layout
14117 \change_inserted 564990737 1671829045
14128 \begin_inset Argument 2
14131 \begin_layout Plain Layout
14133 \change_inserted 564990737 1671829045
14143 Great Western Railway
14153 \begin_layout Subsection
14155 \change_inserted 564990737 1671884699
14161 \begin_layout Standard
14163 \change_inserted 564990737 1671884699
14166 This module defines Boxes with section header.
14167 It is mainly intended for the SciPoster Document class.
14171 \begin_layout Subsection
14173 \change_inserted 564990737 1671884699
14176 Variable-width Minipages
14179 \begin_layout Standard
14181 \change_inserted 564990737 1671884699
14187 \begin_inset space \thinspace{}
14194 Insert\SpecialChar menuseparator
14206 package provides a variable-width minipage, whose resulting width is the
14207 width of its contents (if this does not exceed the specified maximum width).
14208 The inset has two optional arguments which can be added by placing the
14209 cursor inside the minipage and entering
14211 Insert\SpecialChar menuseparator
14213 \begin_inset space \thinspace{}
14224 Insert\SpecialChar menuseparator
14226 \begin_inset space \thinspace{}
14240 File\SpecialChar menuseparator
14241 Open Example\SpecialChar menuseparator
14242 Variable-width Minipages
14248 \begin_layout Section
14250 \change_inserted 564990737 1671884699
14256 \begin_layout Subsection
14258 \change_inserted 564990737 1671884699
14261 Fix Computer Modern Fonts
14264 \begin_layout Standard
14266 \change_inserted 564990737 1671884699
14269 This module uses the
14273 package to improve the appearance of Computer Modern fonts and make them
14274 available with arbitrary sizes.
14276 \begin_inset CommandInset href
14278 name "fix-cm documentation"
14279 target "http://mirrors.ctan.org/macros/latex/base/fix-cm.pdf"
14288 \begin_layout Subsection
14290 \change_inserted 564990737 1671884699
14294 Kernel Fixes (Obsolete)
14297 \begin_layout Standard
14299 \change_inserted 564990737 1671884699
14302 This module loads the \SpecialChar LaTeX
14307 which contains some bug fixes for \SpecialChar LaTeX
14309 If you use this module your typeset document may look different when you
14310 process it, depending on the respective version of
14318 \begin_layout Paragraph
14320 \change_inserted 564990737 1671884699
14326 \begin_layout Standard
14328 \change_inserted 564990737 1671884699
14331 recent \SpecialChar LaTeX
14332 kernels (as of 2015/01/01) include the functionality of
14340 module is obsolete with newer \SpecialChar LaTeX
14345 \begin_layout Subsection
14347 \change_inserted 564990737 1671884699
14350 Minimalistic Insets
14353 \begin_layout Standard
14355 \change_inserted 564990737 1671884699
14358 This module redefines several insets (Index, Branch, URL) as being Minimalistic.
14361 \begin_layout Subsection
14363 \change_inserted 564990737 1671884699
14366 Title and Preamble Hacks
14369 \begin_layout Standard
14371 \change_inserted 564990737 1671884699
14374 This module provides two new paragraph styles:
14377 \begin_layout Enumerate
14379 \change_inserted 564990737 1671884699
14385 which puts whatever is entered into it into the preamble.
14386 This can be used, if one wishes, to include preamble code in the body of
14391 \begin_layout Enumerate
14393 \change_inserted 564990737 1671884699
14399 which that will put its contents into the body of the LaTeX document, but
14407 This is useful for making branches and notes in title-related material.
14408 (However, if you put these in a Standard layout, this signals to LyX to
14415 , which may then come too early.)
14418 \begin_layout Section
14420 \change_inserted 564990737 1672081439
14426 \begin_layout Subsection
14428 \change_inserted 564990737 1672081439
14434 \begin_layout Standard
14436 \change_inserted 564990737 1672081439
14439 This module uses the
14443 package for algorithm floats rather than LyX’s home-brewed algorithm floats.
14444 Use the Algorithm paragraph style to enter and indent the algorithm.
14446 \begin_inset CommandInset href
14448 name "algorithm2e documentation"
14449 target "http://mirrors.ctan.org/macros/latex/contrib/algorithm2e/doc/algorithm2e.pdf"
14457 \begin_layout Subsection
14459 \change_inserted 564990737 1672081439
14462 Bilingual Captions AKA Multilingual Captions
14465 \begin_layout Standard
14467 \change_inserted 564990737 1672081439
14470 This module provides the paragraph style
14473 \begin_inset space ~
14478 with which to typeset multilingual captions.
14479 Within this paragraph style
14481 Insert\SpecialChar menuseparator
14484 allows you to enter the desired language using one of the babel names.
14487 File\SpecialChar menuseparator
14488 Open Example\SpecialChar menuseparator
14489 Multilingual Captions
14493 Help\SpecialChar menuseparator
14494 Specific Manuals\SpecialChar menuseparator
14495 Multilingual Captions
14497 further information on its use.
14500 \begin_layout Subsection
14502 \change_inserted 564990737 1672081439
14505 Number Figures by Section
14508 \begin_layout Standard
14510 \change_inserted 564990737 1672081439
14513 This module resets the figure number at section start and prepends the section
14514 number to the figure number, as in “Figure 2.1.” (By default book and report
14515 document classes number by Chapter and article document classes have a
14519 \begin_layout Subsection
14521 \change_inserted 564990737 1672081439
14524 Number Tables by Section
14527 \begin_layout Standard
14529 \change_inserted 564990737 1672081439
14532 This module resets the table number at section start and prepends the section
14533 number to the table number, as in “Table 2.1.” (By default book and report
14534 document classes number by Chapter and article document classes have a
14538 \begin_layout Section
14540 \change_inserted 564990737 1672081439
14546 \begin_layout Subsection
14548 \change_inserted 564990737 1672081439
14554 \begin_layout Standard
14556 \change_inserted 564990737 1672081439
14559 This module adds an endnote inset, in addition to footnotes.
14564 package, which has some limitations but works with older LaTeX distributions
14568 Insert\SpecialChar menuseparator
14569 Custom Inset\SpecialChar menuseparator
14572 to insert an endnote and
14574 Insert\SpecialChar menuseparator
14575 List/Contents/References\SpecialChar menuseparator
14578 to insert the endnotes list where you want the endnotes to appear.
14581 Help\SpecialChar menuseparator
14582 Embedded\SpecialChar menuseparator
14583 Objects\SpecialChar menuseparator
14584 Notes\SpecialChar menuseparator
14590 \begin_layout Subsection
14592 \change_inserted 564990737 1672081439
14595 Endnotes (Extended)
14598 \begin_layout Standard
14600 \change_inserted 564990737 1672081439
14603 This module adds an endnote inset, in addition to footnotes.
14608 package which is more powerful and customizable than the
14612 package, but requires a fairly modern LaTeX distribution (with LaTeX3).
14615 Insert\SpecialChar menuseparator
14616 Custom Inset\SpecialChar menuseparator
14619 to insert an endnote and
14621 Insert\SpecialChar menuseparator
14622 List/Contents/References\SpecialChar menuseparator
14625 to insert the endnotes list where you want the endnotes to appear.
14628 Help\SpecialChar menuseparator
14629 Embedded\SpecialChar menuseparator
14630 Objects\SpecialChar menuseparator
14631 Notes\SpecialChar menuseparator
14637 \begin_layout Subsection
14639 \change_inserted 564990737 1672081439
14642 Footnotes as Endnotes (Basic)
14645 \begin_layout Standard
14647 \change_inserted 564990737 1672081439
14650 This module sets all footnotes as endnotes.
14655 package, which has some limitations but works with older LaTeX distributions
14659 Insert\SpecialChar menuseparator
14660 List/Contents/References\SpecialChar menuseparator
14663 to insert the endnotes list where you want the endnotes to appear.
14666 Help\SpecialChar menuseparator
14667 Embedded\SpecialChar menuseparator
14668 Objects\SpecialChar menuseparator
14669 Notes\SpecialChar menuseparator
14675 \begin_layout Subsection
14677 \change_inserted 564990737 1672081439
14680 Footnotes as Endnotes (Extended)
14683 \begin_layout Standard
14685 \change_inserted 564990737 1672081439
14688 This module sets all footnotes as endnotes.
14693 package which is more powerful and customizable than then
14697 package, but requires a fairly modern LaTeX distribution (with LaTeX3).
14700 Insert\SpecialChar menuseparator
14701 List/Contents/References\SpecialChar menuseparator
14704 to insert the endnotes list where you want the endnotes to appear.
14707 Help\SpecialChar menuseparator
14708 Embedded\SpecialChar menuseparator
14709 Objects\SpecialChar menuseparator
14710 Notes\SpecialChar menuseparator
14716 \begin_layout Section
14718 \change_inserted 564990737 1672081439
14721 Leisure, Sports and Music
14724 \begin_layout Subsection
14726 \change_inserted 564990737 1672081439
14732 \begin_layout Standard
14734 \change_inserted 564990737 1672081439
14737 This module provides support for the
14741 package to print chess games.
14744 File\SpecialChar menuseparator
14745 Open Example\SpecialChar menuseparator
14746 Articles\SpecialChar menuseparator
14749 where you will find
14758 \begin_inset CommandInset href
14760 name "chessboard documentation"
14761 target "http://mirrors.ctan.org/macros/latex/contrib/chessboard/chessboard.pdf"
14769 \begin_layout Subsection
14771 \change_inserted 564990737 1672081439
14774 Lilypond Music Notation
14777 \begin_layout Standard
14779 \change_inserted 564990737 1672081439
14782 This module provides an inset via
14787 nsert\SpecialChar menuseparator
14788 Custom Inset\SpecialChar menuseparator
14791 in which to enter code for the LilyPond music editor.
14792 It will then be processed in the output.
14795 Help\SpecialChar menuseparator
14796 Specific Manuals\SpecialChar menuseparator
14801 File\SpecialChar menuseparator
14802 Open Example\SpecialChar menuseparator
14803 Modules\SpecialChar menuseparator
14807 It cannot be used if the modules
14810 \begin_inset space \thinspace{}
14818 \begin_layout Section
14820 \change_inserted 564990737 1672138150
14826 \begin_layout Subsection
14828 \change_inserted 564990737 1672138150
14832 \begin_inset CommandInset label
14834 name "subsec:Customizable-Lists"
14841 \begin_layout Standard
14843 \change_inserted 564990737 1672138150
14846 This module uses the
14850 package to enable the customization of various list environments.
14853 \begin_layout Subsubsection
14855 \change_inserted 564990737 1672138150
14858 Custom Enumerate Lists
14861 \begin_layout Standard
14864 \change_inserted 564990737 1672138150
14867 The default numbering of numbered lists can be changed by adding an optional
14873 nsert\SpecialChar menuseparator
14880 ) to the first item of each level in the list.
14881 There you add the command
14884 \begin_layout Standard
14886 \change_inserted 564990737 1672138150
14895 \begin_layout Standard
14897 \change_inserted 564990737 1672138150
14900 in \SpecialChar TeX
14910 \begin_layout Standard
14912 \change_inserted 564990737 1672138150
14918 is the first level counter of the enumeration.
14919 To change the numbering for the list sublevels, replace the “
14923 ” in the command by the small Roman numeral of the level (
14942 \begin_layout Standard
14944 \change_inserted 564990737 1672138150
14953 outputs the counter as a small Roman numeral.
14954 For capital Roman numerals replace
14966 in the command above.
14967 For Arabic numerals use
14975 \begin_inset Quotes eld
14979 \begin_inset Quotes erd
14982 items with capital or small Latin letters use
14997 \begin_layout Standard
15000 \change_inserted 564990737 1672138150
15003 \begin_inset Note Greyedout
15006 \begin_layout Plain Layout
15008 \change_inserted 564990737 1672138150
15014 You can only number 26
15015 \begin_inset space ~
15018 items with Latin letters, because this numbering is limited to single letters.
15026 \begin_layout Standard
15028 \change_inserted 564990737 1672138150
15031 Here is a list with custom numbering:
15034 \begin_layout Enumerate
15036 \change_inserted 564990737 1672138150
15039 \begin_inset Argument 1
15042 \begin_layout Plain Layout
15044 \change_inserted 564990737 1672138150
15050 \begin_layout Plain Layout
15052 \change_inserted 564990737 1672138150
15073 \begin_inset Separator latexpar
15080 \begin_layout Enumerate
15082 \change_inserted 564990737 1672138150
15085 \begin_inset Argument 1
15088 \begin_layout Plain Layout
15090 \change_inserted 564990737 1672138150
15096 \begin_layout Plain Layout
15098 \change_inserted 564990737 1672138150
15119 \begin_layout Enumerate
15121 \change_inserted 564990737 1672138150
15125 \begin_inset Separator latexpar
15132 \begin_layout Enumerate
15134 \change_inserted 564990737 1672138150
15137 \begin_inset Argument 1
15140 \begin_layout Plain Layout
15142 \change_inserted 564990737 1672138150
15148 \begin_layout Plain Layout
15150 \change_inserted 564990737 1672138150
15169 \begin_inset Separator latexpar
15176 \begin_layout Enumerate
15178 \change_inserted 564990737 1672138150
15181 \begin_inset Argument 1
15184 \begin_layout Plain Layout
15186 \change_inserted 564990737 1672138150
15192 \begin_layout Plain Layout
15194 \change_inserted 564990737 1672138150
15218 \begin_layout Standard
15220 \change_inserted 564990737 1672138150
15223 For this list these commands were used:
15226 \begin_layout Standard
15229 \change_inserted 564990737 1672138150
15240 \begin_inset Newline newline
15248 \begin_inset Newline newline
15256 \begin_inset Newline newline
15266 \begin_layout Standard
15268 \change_inserted 564990737 1672138150
15277 makes the label emphasized and
15286 \begin_layout Standard
15288 \change_inserted 564990737 1672138150
15291 \begin_inset Note Greyedout
15294 \begin_layout Plain Layout
15296 \change_inserted 564990737 1672138150
15302 When you change the label of a list level, it will be used for all following
15303 lists until you change the definition.
15311 \begin_layout Standard
15313 \change_inserted 564990737 1672138150
15319 \begin_layout Plain Layout
15321 \change_inserted 564990737 1672138150
15339 \begin_layout Subsubsection
15341 \change_inserted 564990737 1672138150
15344 Numbered Paragraphs in Reports
15347 \begin_layout Enumerate
15349 \change_inserted 564990737 1672138213
15352 Official reports often include numbered paragraphs; you can achieve this
15353 with a variation on the approach outlined in the footnote
15354 \begin_inset space ~
15358 \begin_inset CommandInset ref
15360 reference "fn:If-you-really"
15372 in each command with
15379 \begin_layout Enumerate
15381 \change_inserted 564990737 1672138150
15384 These numbered paragraphs were generated by inserting the \SpecialChar TeX
15386 \begin_inset Separator latexpar
15393 \begin_layout Standard
15395 \change_inserted 564990737 1672138150
15410 \begin_layout Standard
15412 \change_inserted 564990737 1672138150
15415 before the start of the section;
15421 uses the \SpecialChar LaTeX
15422 section counter to generate the first part of the number.
15426 \begin_layout Enumerate
15428 \change_inserted 564990737 1672138150
15431 I have ignored the subsection heading in this example because, with paragraphs
15432 numbered in this way, subsections are less likely to be used.
15435 \begin_layout Subsubsection
15437 \change_inserted 564990737 1672138150
15440 Resumed Enumeration
15443 \begin_layout Standard
15445 \change_inserted 564990737 1672138150
15451 \begin_layout Plain Layout
15453 \change_inserted 564990737 1672138150
15469 \begin_layout Standard
15471 \change_inserted 564990737 1672138150
15474 Enumerations can be resumed after intermediate paragraphs:
15477 \begin_layout Enumerate
15479 \change_inserted 564990737 1672138150
15482 \begin_inset Argument 1
15485 \begin_layout Plain Layout
15487 \change_inserted 564990737 1672138150
15493 \begin_layout Plain Layout
15495 \change_inserted 564990737 1672138150
15512 \begin_inset Note Note
15515 \begin_layout Plain Layout
15517 \change_inserted 564990737 1672138150
15520 goes back to default numbering
15528 \begin_layout Enumerate
15530 \change_inserted 564990737 1672138150
15536 \begin_layout Standard
15538 \change_inserted 564990737 1672138150
15544 \begin_layout Enumerate-Resume
15546 \change_inserted 564990737 1672138150
15552 \begin_layout Standard
15554 \change_inserted 564990737 1672138150
15557 To resume an enumeration, use the style
15562 Its numbering appears in blue within \SpecialChar LyX
15563 to indicate that it is a resumed
15564 list and that the numbering will not be correct in \SpecialChar LyX
15565 , but in the output.
15568 \begin_layout Standard
15570 \change_inserted 564990737 1672138150
15573 \begin_inset Note Greyedout
15576 \begin_layout Plain Layout
15578 \change_inserted 564990737 1672138150
15584 If there is no previous enumeration to resume, you will get a \SpecialChar LaTeX
15593 \begin_layout Standard
15595 \change_inserted 564990737 1672138150
15598 Perhaps you might want to resume the list with a different number from the
15600 Or you want to start a new enumeration with a defined number.
15601 This is possible by adding an optional argument to the first list item
15602 of a normal enumeration.
15603 There, insert the command
15606 \begin_layout Standard
15608 \change_inserted 564990737 1672138150
15615 \begin_layout Standard
15617 \change_inserted 564990737 1672138150
15624 is the number with which you want to resume the list.
15628 \begin_layout Enumerate
15630 \change_inserted 564990737 1672138150
15636 \begin_layout Enumerate
15638 \change_inserted 564990737 1672138150
15644 \begin_layout Standard
15646 \change_inserted 564990737 1672138150
15649 Enumeration starting at a given value:
15652 \begin_layout Enumerate
15654 \change_inserted 564990737 1672138150
15657 \begin_inset Argument 1
15660 \begin_layout Plain Layout
15662 \change_inserted 564990737 1672138150
15668 \begin_layout Plain Layout
15670 \change_inserted 564990737 1672138150
15684 This enumeration starts at 4
15687 \begin_layout Subsubsection
15689 \change_inserted 564990737 1672138150
15693 \begin_inset Index idx
15698 \begin_layout Plain Layout
15700 \change_inserted 564990737 1672138150
15713 \begin_layout Standard
15715 \change_inserted 564990737 1672138150
15718 In some cases you might want less or more vertical space between the items
15720 For example if the default space is too much in your opinion in this case:
15723 \begin_layout Itemize
15725 \change_inserted 564990737 1672138150
15731 \begin_layout Itemize
15733 \change_inserted 564990737 1672138150
15736 with standard spacing
15739 \begin_layout Standard
15741 \change_inserted 564990737 1672138150
15744 You can decrease the space by adding an optional argument to the first item
15746 Add there the command
15750 to get no additional list space like in this example:
15753 \begin_layout Itemize
15755 \change_inserted 564990737 1672138150
15758 \begin_inset Argument 1
15761 \begin_layout Plain Layout
15763 \change_inserted 564990737 1672138150
15769 \begin_layout Plain Layout
15771 \change_inserted 564990737 1672138150
15788 \begin_layout Itemize
15790 \change_inserted 564990737 1672138150
15796 \begin_layout Itemize
15798 \change_inserted 564990737 1672138150
15804 \begin_layout Standard
15806 \change_inserted 564990737 1672138150
15809 To add space you can use several other commands provided by the
15814 \begin_inset Index idx
15819 \begin_layout Plain Layout
15821 \change_inserted 564990737 1672138150
15825 -packages ! enumitem
15833 For more information see the
15834 \begin_inset CommandInset href
15836 name "enumitem documentation"
15837 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
15845 \begin_layout Standard
15847 \change_inserted 564990737 1672138150
15850 There are also many commands available to change the horizontal spacing
15852 Here is an example where the indentation was changed to that of the paragraphs
15853 in the document and the label separation was set to 2
15854 \begin_inset space \thinspace{}
15857 cm so that the number is in the page margin:
15860 \begin_layout Enumerate
15862 \change_inserted 564990737 1672138150
15865 \begin_inset Argument 1
15868 \begin_layout Plain Layout
15870 \change_inserted 564990737 1672138150
15876 \begin_layout Plain Layout
15878 \change_inserted 564990737 1672138150
15882 parindent, labelsep=2cm
15897 \begin_layout Enumerate
15899 \change_inserted 564990737 1672138150
15902 with negative indentation
15905 \begin_layout Subsubsection
15907 \change_inserted 564990737 1672138150
15910 Further Customization
15911 \begin_inset Index idx
15916 \begin_layout Plain Layout
15918 \change_inserted 564990737 1672138150
15921 Lists ! Customization
15931 \begin_layout Standard
15933 \change_inserted 564990737 1672138150
15936 You can also change the style of description lists.
15940 \begin_layout Standard
15942 \change_inserted 564990737 1672138150
15949 \begin_layout Standard
15951 \change_inserted 564990737 1672138150
15954 changes the description label font, the command
15957 \begin_layout Standard
15959 \change_inserted 564990737 1672138150
15969 \begin_layout Standard
15971 \change_inserted 564990737 1672138150
15974 sets the list style.
15977 \begin_layout Standard
15979 \change_inserted 564990737 1672138150
15982 An example where the command
15985 \begin_layout Standard
15987 \change_inserted 564990737 1672138150
15993 itshape, style=nextline
15996 \begin_layout Standard
15998 \change_inserted 564990737 1672138150
16004 \begin_layout Description
16006 \change_inserted 564990737 1672138150
16010 \begin_inset space ~
16014 \begin_inset Argument 1
16017 \begin_layout Plain Layout
16019 \change_inserted 564990737 1672138150
16025 \begin_layout Plain Layout
16027 \change_inserted 564990737 1672138150
16029 labelindent=0pt, labelsep=1cm, font=
16031 itshape, style=nextline
16043 Ionizing radiation consists of particles or electromagnetic waves that are
16044 energetic enough to detach electrons from atoms or molecules, therefore
16048 \begin_layout Description
16050 \change_inserted 564990737 1672138150
16054 \begin_inset space ~
16057 counting: In computer science, reference counting is a technique of storing
16058 the number of references, pointers, or handles to a resource such as an
16059 object, block of memory, disk space or other resource.
16062 \begin_layout Standard
16064 \change_inserted 564990737 1672138150
16067 There are many more commands and features provided by the
16072 \begin_inset Index idx
16077 \begin_layout Plain Layout
16079 \change_inserted 564990737 1672138150
16083 -packages ! enumitem
16091 For more information see the
16092 \begin_inset CommandInset href
16094 name "enumitem documentation"
16095 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
16103 \begin_layout Subsection
16105 \change_inserted 564990737 1672138150
16112 \begin_layout Standard
16114 \change_inserted 564990737 1672138150
16117 This module uses the package
16121 to provide nine new list environments.
16122 Itemized and enumerated lists can be typeset within paragraphs, as paragraphs
16123 and in a compact version.
16124 Most environments have optional arguments to format the labels.
16125 Additionally, the \SpecialChar LaTeX
16126 list environments itemize and enumerate are extended
16127 to use a similar optional argument.
16128 For further details see
16130 File\SpecialChar menuseparator
16131 Open Example\SpecialChar menuseparator
16132 Modules\SpecialChar menuseparator
16133 Paragraph Lists (paralist)
16137 Help\SpecialChar menuseparator
16138 Specific Manuals\SpecialChar menuseparator
16142 \begin_inset CommandInset href
16144 name "paralist documentation"
16145 target "http://mirrors.ctan.org/macros/latex/contrib/paralist/paralist.pdf"
16153 \begin_layout Section
16155 \change_inserted 564990737 1672161542
16158 Literate Programming
16161 \begin_layout Subsection
16163 \change_inserted 564990737 1672161542
16169 \begin_layout Standard
16171 \change_inserted 564990737 1672161542
16174 This module allows the use of Noweb as a literate programming tool.
16175 The files and the documentation for Noweb can be obtained from
16176 \begin_inset CommandInset href
16179 target "https://www.ctan.org/pkg/noweb"
16185 Literate programming is described in section
16186 \begin_inset space ~
16190 \begin_inset CommandInset ref
16192 reference "sec:Literate-Programming"
16196 and there are three example files:
16198 File\SpecialChar menuseparator
16199 Open Example\SpecialChar menuseparator
16200 Modules\SpecialChar menuseparator
16205 File\SpecialChar menuseparator
16206 Open Example\SpecialChar menuseparator
16207 Modules\SpecialChar menuseparator
16212 File\SpecialChar menuseparator
16213 Open Example\SpecialChar menuseparator
16214 Modules\SpecialChar menuseparator
16215 Noweb2\SpecialChar LyX
16221 \begin_layout Subsection
16223 \change_inserted 564990737 1672161542
16229 \begin_layout Standard
16231 \change_inserted 564990737 1672161542
16234 This module uses the
16244 \begin_inset Flex Code
16247 \begin_layout Plain Layout
16249 \change_inserted 564990737 1672161542
16259 package in R for dynamic report generation has to be installed for this
16261 \begin_inset Flex Code
16264 \begin_layout Plain Layout
16266 \change_inserted 564990737 1672161542
16269 install.packages(“knitr”)
16280 \begin_layout Paragraph
16282 \change_inserted 564990737 1672161542
16288 \begin_layout Standard
16290 \change_inserted 564990737 1672161542
16293 it depends on R >= 2.14.1.
16295 \begin_inset Flex URL
16298 \begin_layout Plain Layout
16300 \change_inserted 564990737 1672161542
16302 http://yihui.name/knitr
16313 \begin_layout Standard
16315 \change_inserted 564990737 1672161542
16322 also has to be installed.
16323 It cannot be used if the modules
16326 \begin_inset space ~
16338 Help\SpecialChar menuseparator
16339 Specific Manuals\SpecialChar menuseparator
16344 File\SpecialChar menuseparator
16345 Open Example\SpecialChar menuseparator
16346 Modules\SpecialChar menuseparator
16350 \begin_inset space ~
16354 \begin_inset CommandInset ref
16356 reference "sec:Literate-Programming"
16360 for information about literate programming.
16363 \begin_layout Subsection
16365 \change_inserted 564990737 1672161542
16371 \begin_layout Standard
16373 \change_inserted 564990737 1672161542
16376 This module allows the use of the statistical language S/R as a literate
16388 \begin_inset CommandInset href
16391 target "https://www.ctan.org/pkg/includernw"
16397 \begin_inset CommandInset href
16400 target "https://www.ctan.org/pkg/fancyvrb"
16405 are available from CTAN.
16406 It cannot be used if the module
16409 \begin_inset space ~
16417 Help\SpecialChar menuseparator
16418 Specific Manuals\SpecialChar menuseparator
16423 File\SpecialChar menuseparator
16424 Open Example\SpecialChar menuseparator
16425 Modules\SpecialChar menuseparator
16429 \begin_inset space ~
16433 \begin_inset CommandInset ref
16435 reference "sec:Literate-Programming"
16439 for information about literate programming.
16442 \begin_layout Section
16444 \change_inserted 564990737 1672224959
16450 \begin_layout Subsection
16452 \change_inserted 564990737 1672224959
16458 \begin_layout Standard
16460 \change_inserted 564990737 1672224959
16463 This modules defines theorem environments and the proof environment using
16464 the extended AMS machinery.
16465 Both numbered and unnumbered types are provided.
16466 By default, the theorems are numbered consecutively throughout the document.
16467 This can be changed by loading one of the
16469 AMS Theorems (Numbered by \SpecialChar ldots
16473 It cannot be used if the modules
16479 Standard Theorems (Unnumbered)
16484 \begin_layout Subsection
16486 \change_inserted 564990737 1672224959
16489 AMS Theorems (Extended)
16492 \begin_layout Standard
16494 \change_inserted 564990737 1672224959
16497 This module defines some additional theorem environments for use with the
16502 package (which must be loaded).
16503 It includes Criterion, Algorithm, Axiom, Condition, Note, Notation, Summary,
16504 Acknowledgement, Conclusion, Fact, Assumption, Case and Question in both
16505 numbered and unnumbered forms.
16508 \begin_layout Subsection
16510 \change_inserted 564990737 1672224959
16513 AMS Theorems (Extended, Numbered by Type within Chapters)
16516 \begin_layout Standard
16518 \change_inserted 564990737 1672224959
16521 This module defines some additional theorem environments for use with the
16524 AMS Theorems (Numbered by Type within Chapters)
16526 package (which must be loaded).
16527 It includes Criterion, Algorithm, Axiom, Condition, Note, Notation, Summary,
16528 Acknowledgement, Conclusion, Assumption and Case in both numbered and unnumbere
16532 AMS Theorems (Extended)
16534 module, the different theorem types provided here each have a separate
16535 counter, restarted with each new chapter (e.g., criterion 1.1, criterion 1.2,
16536 axiom 1.1, assumption 1.1, criterion 2.1, criterion 2.2, axiom 2.1\SpecialChar ldots
16538 to criterion 1, criterion 2, axiom 3, assumption 4...).
16541 \begin_layout Subsection
16543 \change_inserted 564990737 1672224959
16546 AMS Theorems (Extended, Numbered by Type)
16549 \begin_layout Standard
16551 \change_inserted 564990737 1672224959
16554 This module defines some additional theorem environments for use with the
16557 AMS Theorems (Numbered by Type)
16559 package (which must be loaded).
16560 It includes Criterion, Algorithm, Axiom, Condition, Note, Notation, Summary,
16561 Acknowledgement, Conclusion, Assumption and Case in both numbered and unnumbere
16565 AMS Theorems (Extended)
16567 module, the different theorem types provided here each have a separate
16568 counter (e.g., criterion 1, criterion 2, axiom 1, assumption 1, criterion
16569 3, \SpecialChar ldots
16570 , as opposed to criterion 1, criterion 2, axiom 3, assumption 4, \SpecialChar ldots
16574 \begin_layout Subsection
16576 \change_inserted 564990737 1672224959
16579 AMS Theorems (Numbered by Type within Chapters)
16582 \begin_layout Standard
16584 \change_inserted 564990737 1672224959
16587 This module defines theorem environments and the proof environment using
16588 the extended AMS machinery.
16589 Both numbered and unnumbered types are provided.
16594 module, the different theorem types provided here each have a separate
16595 counter (e.g., theorem 1.1, theorem 1.2, lemma 1.1, proposition 1.1, theorem
16596 1.3, lemma 1.2, \SpecialChar ldots
16597 , as opposed to theorem 1, theorem 2, lemma 3, proposition
16598 4, \SpecialChar ldots
16600 The numbering restarts for each chapter: theorem 1.1, theorem 2.1, \SpecialChar ldots
16602 be used if the modules
16612 Standard Theorems (Numbered by Type)
16616 Standard Theorems (Unnumbered)
16621 \begin_layout Subsection
16623 \change_inserted 564990737 1672224959
16626 AMS Theorems (Numbered by Type)
16629 \begin_layout Standard
16631 \change_inserted 564990737 1672224959
16634 This module defines theorem environments and the proof environment using
16635 the extended AMS machinery.
16636 Both numbered and unnumbered types are provided.
16641 module, the different theorem types provided here each have a separate
16642 counter (e.g., theorem 1, theorem 2, lemma 1, proposition 1, theorem 3, lemma
16643 2, \SpecialChar ldots
16644 , as opposed to theorem 1, theorem 2, lemma 3, proposition 4, \SpecialChar ldots
16646 The numbering’s scope is the whole document.
16647 For chapter- and section-wide numbering, use one of the ‘within Sections’/‘with
16648 in Chapters’ modules, respectively.
16649 It cannot be used if the modules
16659 Standard Theorems (Numbered by Type)
16663 Standard Theorems (Unnumbered)
16668 \begin_layout Subsection
16670 \change_inserted 564990737 1672224959
16673 Number Equations by Section
16676 \begin_layout Standard
16678 \change_inserted 564990737 1672224959
16681 This module resets the equation number at section start and prepends the
16682 section number to the equation number, as in “(2.1).”
16685 \begin_layout Subsection
16687 \change_inserted 564990737 1672224959
16693 \begin_layout Standard
16695 \change_inserted 564990737 1672224959
16698 This module defines some theorem environments for use with non-AMS classes.
16699 By default, the theorems are numbered consecutively throughout the document.
16700 This can be changed by loading one of the
16702 Standard Theorems (Numbered by \SpecialChar ldots
16706 It cannot be used if the modules
16712 Standard Theorems (Unnumbered)
16718 \begin_layout Subsection
16720 \change_inserted 564990737 1672224959
16723 Standard Theorems (Nameable)
16726 \begin_layout Standard
16728 \change_inserted 564990737 1672224959
16731 This module facilitates the use of named theorems.
16732 The name of the theorem goes into the “Additional Theorem Text” argument.
16736 \begin_layout Subsection
16738 \change_inserted 564990737 1672224959
16741 Standard Theorems (Numbered by Chapter)
16744 \begin_layout Standard
16746 \change_inserted 564990737 1672224959
16749 This module numbers theorems and the like by chapter (i.e., the counter is
16750 reset at each chapter start).
16751 Use this module only with document classes that provide a chapter environment.
16761 It cannot be used if the module
16763 Standard Theorems (Numbered by Section)
16768 \begin_layout Subsection
16770 \change_inserted 564990737 1672224959
16773 Standard Theorems (Numbered by Section)
16776 \begin_layout Standard
16778 \change_inserted 564990737 1672224959
16781 This module numbers theorems and the like by section (i.e., the counter is
16782 reset at each section start).
16792 It cannot be used if the module
16794 Standard Theorems (Numbered by Chapter)
16799 \begin_layout Subsection
16801 \change_inserted 564990737 1672224959
16804 Standard Theorems (Numbered by Type within Chapters)
16807 \begin_layout Standard
16809 \change_inserted 564990737 1672224959
16812 This module defines some theorem environments for use with non-AMS classes.
16821 modules, the different theorem types provided here each have a separate
16822 counter (e.g., theorem 1, theorem 2, lemma 1, proposition 1, theorem 3, lemma
16823 2, \SpecialChar ldots
16824 , as opposed to theorem 1, theorem 2, lemma 3, proposition 4, \SpecialChar ldots
16826 The numbering is reset at each chapter start.
16829 AMS Theorems (Numbered by Type)
16833 Standard Theorems (Numbered by Type)
16836 It cannot be used if any of the modules
16846 Standard Theorems (Unnumbered)
16850 Standard Theorems (Numbered by Sections)
16854 Standard Theorems (Numbered by Type within Sections)
16859 \begin_layout Subsection
16861 \change_inserted 564990737 1672224959
16864 Standard Theorems (Numbered by Type within Sections)
16867 \begin_layout Standard
16869 \change_inserted 564990737 1672224959
16872 This module defines some theorem environments for use with non-AMS classes.
16881 modules, the different theorem types provided here each have a separate
16882 counter (e.g., theorem 1, theorem 2, lemma 1, proposition 1, theorem 3, lemma
16883 2, \SpecialChar ldots
16884 , as opposed to theorem 1, theorem 2, lemma 3, proposition 4, \SpecialChar ldots
16886 The numbering is reset at each section start.
16889 AMS Theorems (Numbered by Type)
16893 Standard Theorems (Numbered by Type)
16896 It cannot be used if any of the modules
16906 Standard Theorems (Unnumbered)
16910 Standard Theorems (Numbered by Chapters)
16914 Standard Theorems (Numbered by Type within Chapters)
16919 \begin_layout Subsection
16921 \change_inserted 564990737 1672224959
16924 Standard Theorems (Numbered by Type)
16927 \begin_layout Standard
16929 \change_inserted 564990737 1672224959
16932 This module defines some theorem environments for use with non-AMS classes.
16941 modules, the different theorem types provided here each have a separate
16942 counter (e.g., theorem 1, theorem 2, lemma 1, proposition 1, theorem 3, lemma
16943 2, \SpecialChar ldots
16944 , as opposed to theorem 1, theorem 2, lemma 3, proposition 4, \SpecialChar ldots
16946 The numbering’s scope is the whole document.
16947 For chapter- and section-wide numbering, use one of the “within Chapters”/“with
16948 in Sections” modules, respectively.
16949 It cannot be used if any of the modules
16959 Standard Theorems (Unnumbered)
16963 AMS Theorems (Numbered by Type)
16968 \begin_layout Subsection
16970 \change_inserted 564990737 1672224959
16973 Standard Theorems (Unnumbered)
16976 \begin_layout Standard
16978 \change_inserted 564990737 1672224959
16981 This module defines only unnumbered theorem environments and the proof environme
16982 nt, using the extended AMS machinery.
16983 It cannot be used if either of the modules
16994 \begin_layout Subsection
16996 \change_inserted 564990737 1672224959
17002 \begin_layout Standard
17004 \change_inserted 564990737 1672224959
17007 This module provides a straightforward way to segregate subequations in
17011 Help\SpecialChar menuseparator
17012 Math\SpecialChar menuseparator
17019 \begin_layout Section
17021 \change_inserted 564990737 1672236008
17027 \begin_layout Subsection
17029 \change_inserted 564990737 1672236008
17032 Custom Header/Footer Text
17035 \begin_layout Standard
17037 \change_inserted 564990737 1672236008
17040 This module requires the
17043 \begin_inset space ~
17057 ocument\SpecialChar menuseparator
17062 ettings\SpecialChar menuseparator
17064 \begin_inset space ~
17069 dialog to be set to
17074 It adds six environments to document classes which support the
17081 \begin_layout Itemize
17083 \change_inserted 564990737 1672236008
17090 \begin_layout Itemize
17092 \change_inserted 564990737 1672236008
17099 \begin_layout Itemize
17101 \change_inserted 564990737 1672236008
17108 \begin_layout Itemize
17110 \change_inserted 564990737 1672236008
17117 \begin_layout Itemize
17119 \change_inserted 564990737 1672236008
17126 \begin_layout Itemize
17128 \change_inserted 564990737 1672236008
17135 \begin_layout Subsubsection
17137 \change_inserted 564990737 1672236008
17140 Fancy Headers and Footers
17143 \begin_layout Standard
17145 \change_inserted 564990737 1672236008
17148 The default page layout is rather plain; for an
17149 \begin_inset Flex Code
17152 \begin_layout Plain Layout
17154 \change_inserted 564990737 1672236008
17162 document class, all you get is a centered page number at the bottom of
17164 This document uses KOMA-script’s book class; so it appears to be a bit
17169 \begin_inset space ~
17183 ocument\SpecialChar menuseparator
17188 ettings\SpecialChar menuseparator
17192 \begin_inset Quotes eld
17196 \begin_inset Quotes erd
17199 , you will find that the page header is divided into three fields, not surprisin
17201 \begin_inset Quotes eld
17205 \begin_inset Quotes erd
17209 \begin_inset Quotes eld
17213 \begin_inset Quotes erd
17217 \begin_inset Quotes eld
17221 \begin_inset Quotes erd
17225 The footer is also divided into these three fields.
17226 The \SpecialChar LaTeX
17227 commands to set these fields in the simplest manner are
17252 Suppose you wish to put your name in the upper left hand corner of each
17254 Simply insert the following command in the preamble:
17257 \begin_layout Standard
17259 \change_inserted 564990737 1672236008
17276 \begin_layout Standard
17278 \change_inserted 564990737 1672236008
17281 You will now see your name in the upper left.
17282 If a field has a default entry that you would like to get rid of (often
17283 the page number appears in the central footer) simply include a command
17284 with a blank argument, e.
17285 \begin_inset space \thinspace{}
17291 \begin_layout Standard
17293 \change_inserted 564990737 1672236008
17302 \begin_layout Standard
17304 \change_inserted 564990737 1672236008
17307 There is, however, an easier way to make simple changes.
17313 ocument\SpecialChar menuseparator
17318 ettings\SpecialChar menuseparator
17319 Modules\SpecialChar menuseparator
17320 Page Layout\SpecialChar menuseparator
17321 Custom Header/Footer Text
17323 module, you will find you have six new environments corresponding to the
17324 six fields described above.
17327 \begin_layout Standard
17329 \change_inserted 564990737 1672236008
17332 Let's get really fancy: lets put the section number with the word
17333 \begin_inset Quotes eld
17337 \begin_inset Quotes erd
17341 \begin_inset space \thinspace{}
17345 \begin_inset space \space{}
17348 Section 3) in the upper left, the page number (e.
17349 \begin_inset space \thinspace{}
17353 \begin_inset space \space{}
17356 Page 4) in the upper right, your name in the lower left, and the date in
17358 Use your newly enabled environments to add these entries:
17361 \begin_layout Standard
17363 \change_inserted 564990737 1672236008
17366 \begin_inset VSpace defskip
17372 \begin_layout Standard
17374 \change_inserted 564990737 1672236008
17379 \begin_inset space ~
17396 \begin_layout Standard
17398 \change_inserted 564990737 1672236008
17405 \begin_layout Standard
17407 \change_inserted 564990737 1672236008
17422 \begin_layout Standard
17424 \change_inserted 564990737 1672236008
17434 \begin_layout Standard
17436 \change_inserted 564990737 1672236008
17443 \begin_layout Standard
17445 \change_inserted 564990737 1672236008
17460 \begin_layout Standard
17462 \change_inserted 564990737 1672236008
17465 \begin_inset VSpace defskip
17471 \begin_layout Standard
17473 \change_inserted 564990737 1672236008
17476 Make sure you enter the commands
17494 as \SpecialChar TeX
17512 access \SpecialChar LaTeX
17513 ’s section and page counters, and so print out the current section
17521 simply prints out today’s date.
17524 \begin_layout Standard
17526 \change_inserted 564990737 1672236008
17529 The thicknesses of the horizontal rules drawn beneath the header and above
17530 the footer can also be modified.
17531 If you don't want one of the rules, set its thickness to 0.
17532 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
17533 For this you will need to use \SpecialChar TeX
17537 \begin_layout Standard
17539 \change_inserted 564990737 1672236008
17547 headrulewidth}{0.4pt}
17552 \begin_layout Standard
17554 \change_inserted 564990737 1672236008
17562 footrulewidth}{0.4pt}
17564 to set the thicknesses.
17567 \begin_layout Standard
17569 \change_inserted 564990737 1672236008
17572 You can switch the header/footer settings on and off for individual pages
17573 using \SpecialChar TeX
17578 thispagestyle{empty}
17584 thispagestyle{plain}
17590 thispagestyle{fancy}
17593 Simply insert them in the text on the page you want changed and mark them
17594 as \SpecialChar TeX
17596 In fact, title pages are marked as plain by default, while following pages
17597 are marked fancy when using the global fancy setting.
17601 \begin_layout Standard
17603 \change_inserted 564990737 1672236008
17606 If you want a header or footer to be on the outer side of a two sided document,
17607 you need to use something like:
17610 \begin_layout Standard
17612 \change_inserted 564990737 1672236008
17616 \begin_inset Flex Strong
17619 \begin_layout Plain Layout
17621 \change_inserted 564990737 1672236008
17636 \begin_layout Standard
17638 \change_inserted 564990737 1672236008
17642 \begin_inset Flex Strong
17645 \begin_layout Plain Layout
17647 \change_inserted 564990737 1672236008
17664 \begin_layout Standard
17666 \change_inserted 564990737 1672236008
17669 The first command clears all existing footers avoiding any conflicts with
17673 \begin_layout Standard
17675 \change_inserted 564990737 1672236008
17678 You can enter any of these commands, the simpler ones in any of your new
17679 environments, the more complex ones as \SpecialChar TeX
17680 Code commands, at any point in
17681 your document and they will take effect on the next page.
17684 \begin_layout Standard
17686 \change_inserted 564990737 1672236008
17689 As a final example, it is possible to include an image in the header or
17691 Suppose you want to put a company logo in the upper left hand corner.
17692 You might try something like
17695 \begin_layout Standard
17697 \change_inserted 564990737 1672236008
17707 includegraphics{logo.eps}}}
17710 \begin_layout Standard
17713 \change_inserted 564990737 1672236008
17716 (you may need to preface this with
17720 usepackage{graphics}
17722 if you don't include graphics elsewhere in your document).
17725 \begin_layout Standard
17727 \change_inserted 564990737 1672236008
17730 For more information on fancy headers, you can get the
17731 \begin_inset Flex Code
17734 \begin_layout Plain Layout
17736 \change_inserted 564990737 1672236008
17745 \begin_inset CommandInset href
17748 target "http://www.ctan.org/pkg/fancyhdr"
17757 \begin_layout Subsection
17759 \change_inserted 564990737 1672236008
17762 Landscape Document Parts
17765 \begin_layout Standard
17767 \change_inserted 564990737 1672236008
17770 This module outputs parts of the document in landscape mode using
17772 Insert\SpecialChar menuseparator
17773 Custom Insets\SpecialChar menuseparator
17778 Insert\SpecialChar menuseparator
17779 Custom Insets\SpecialChar menuseparator
17780 Landscape (Floating)
17785 \begin_layout Subsection
17787 \change_inserted 564990737 1672236008
17790 \begin_inset CommandInset label
17792 name "sec:Multiple-Columns"
17799 \begin_layout Standard
17801 \change_inserted 564990737 1672236008
17804 This module uses the
17809 \begin_inset Index idx
17814 \begin_layout Plain Layout
17816 \change_inserted 564990737 1672236008
17820 -packages ! multicol
17825 package and is independent of the option
17838 ocument\SpecialChar menuseparator
17843 ettings\SpecialChar menuseparator
17845 \begin_inset space ~
17851 If you want to have two columns for the whole document, you are recommended
17861 For all other cases use this module.
17862 \change_deleted 564990737 1672236008
17865 Multiple Text Columns
17868 \begin_layout Standard
17870 \change_deleted 564990737 1672236008
17871 This feature is independent of the option
17873 Two-column document
17875 in the document settings under
17880 If you want to have 2
17881 \begin_inset space ~
17884 columns for the whole document, it is recommended to use the
17886 Two-column document
17889 For all other cases use this feature.
17892 \begin_layout Standard
17894 \change_deleted 564990737 1672236008
17895 To use multiple text columns in your document, you have to load the module
17902 Document\SpecialChar menuseparator
17903 Settings\SpecialChar menuseparator
17906 ) and must have the \SpecialChar LaTeX
17908 \begin_inset Flex Code
17911 \begin_layout Plain Layout
17922 \begin_layout Standard
17923 Footnotes within multiple columns will be placed at the bottom of the page
17924 and not under each column.
17925 Within the different columns you can use everything, with the limitation
17926 that for floats you need to
17927 \change_deleted 564990737 1672236179
17928 use the float option
17931 \change_inserted 564990737 1672236179
17941 \begin_inset space ~
17951 dit\SpecialChar menuseparator
17957 \begin_inset space ~
17968 \begin_layout Subsubsection
17972 \begin_layout Standard
17973 If you want to have 2
17974 \begin_inset space ~
17977 columns in your text, insert a multicolumn inset via the menu
17979 Insert\SpecialChar menuseparator
17981 \begin_inset space ~
17984 Insets\SpecialChar menuseparator
17986 \begin_inset space ~
17991 where the columns should start.
17992 Write all text that should be printed in 2
17993 \begin_inset space ~
17996 columns into this inset.
17999 \begin_layout Standard
18000 Here is an example:
18003 \begin_layout Standard
18005 \begin_inset Flex Multiple Columns
18008 \begin_layout Plain Layout
18013 The Adventure of the Empty House
18016 \begin_inset Newline newline
18019 by Sir Arthur Conan Doyle
18022 \begin_layout Plain Layout
18025 It was in the spring of the year 1894 that all London was interested, and
18026 the fashionable world dismayed, by the murder of the Honourable Ronald
18027 Adair under most unusual and inexplicable circumstances.
18028 The public has already learned those particulars of the crime which came
18029 out in the police investigation, but a good deal was suppressed upon that
18030 occasion, since the case for the prosecution was so overwhelmingly strong
18031 that it was not necessary to bring forward all the facts.
18032 Only now, at the end of nearly ten years, am I allowed to supply those
18033 missing links which make up the whole of that remarkable chain.
18034 The crime was of interest in itself, but that interest was as nothing to
18035 me compared to the inconceivable sequel, which afforded me the greatest
18036 shock and surprise of any event in my adventurous life.
18037 Even now, after this long interval, I find myself thrilling as I think
18038 of it, and feeling once more that sudden flood of joy, amazement, and increduli
18039 ty which utterly submerged my mind.
18040 Let me say to that public, which has shown some interest in those glimpses
18041 which I have occasionally given them of the thoughts and actions of a very
18042 remarkable man, that they are not to blame me if I have not shared my knowledge
18043 with them, for I should have considered it my first duty to do so, had
18044 I not been barred by a positive prohibition from his own lips, which was
18045 only withdrawn upon the third of last month.
18053 \begin_layout Standard
18054 To get 3 or more columns, set the cursor into the multicolumn inset and
18057 Insert\SpecialChar menuseparator
18059 \begin_inset space ~
18063 \begin_inset space ~
18069 The number of the desired columns is written into that inset (for 3
18070 \begin_inset space ~
18074 \begin_inset Quotes eld
18078 \begin_inset Quotes erd
18082 \begin_inset Newline newline
18085 Here is an example with 3
18086 \begin_inset space ~
18092 \begin_layout Standard
18093 \begin_inset Flex Multiple Columns
18096 \begin_layout Plain Layout
18099 \begin_inset Argument 1
18102 \begin_layout Plain Layout
18109 It can be imagined that my close intimacy with Sherlock Holmes had interested
18110 me deeply in crime, and that after his disappearance I never failed to
18111 read with care the various problems which came before the public.
18112 And I even attempted, more than once, for my own private satisfaction,
18113 to employ his methods in their solution, though with indifferent success.
18114 There was none, however, which appealed to me like this tragedy of Ronald
18116 As I read the evidence at the inquest, which led up to a verdict of willful
18117 murder against some person or persons unknown, I realized more clearly
18118 than I had ever done the loss which the community had sustained by the
18119 death of Sherlock Holmes.
18120 There were points about this strange business which would, I was sure,
18121 have specially appealed to him, and the efforts of the police would have
18122 been supplemented, or more probably anticipated, by the trained observation
18123 and the alert mind of the first criminal agent in Europe.
18124 All day, as I drove upon my round, I turned over the case in my mind and
18125 found no explanation which appeared to me to be adequate.
18126 At the risk of telling a twice-told tale, I will recapitulate the facts
18127 as they were known to the public at the conclusion of the inquest.
18135 \begin_layout Standard
18136 You can have up to 10
18137 \begin_inset space ~
18140 columns if you want to, but that might not be very pleasant for the readers
18144 \begin_layout Standard
18146 \change_deleted 564990737 1672236245
18147 \begin_inset Newpage newpage
18155 \begin_layout Subsubsection
18156 Columns inside Columns
18159 \begin_layout Standard
18160 You can also have columns inside columns:
18163 \begin_layout Standard
18164 \begin_inset Flex Multiple Columns
18167 \begin_layout Plain Layout
18170 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
18171 at that time governor of one of the Australian colonies.
18172 Adair's mother had returned from Australia to undergo the operation for
18173 cataract, and she, her son Ronald, and her daughter Hilda were living together
18177 \begin_layout Plain Layout
18178 \begin_inset Flex Multiple Columns
18181 \begin_layout Plain Layout
18184 The youth moved in the best society
18185 \begin_inset space ~
18188 – had, so far as was known, no enemies and no particular vices.
18189 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
18190 had been broken off by mutual consent some months before, and there was
18191 no sign that it had left any very profound feeling behind it.
18192 For the rest {sic} the man's life moved in a narrow and conventional circle,
18193 for his habits were quiet and his nature unemotional.
18194 Yet it was upon this easy-going young aristocrat that death came, in most
18195 strange and unexpected form, between the hours of ten and eleven-twenty
18196 on the night of March 30, 1894.
18204 \begin_layout Plain Layout
18207 Ronald Adair was fond of cards
18208 \begin_inset space ~
18211 – playing continually, but never for such stakes as would hurt him.
18212 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
18213 It was shown that, after dinner on the day of his death, he had played
18214 a rubber of whist at the latter club.
18215 He had also played there in the afternoon.
18220 The evidence of those who had played with him
18221 \begin_inset space ~
18225 Murray, Sir John Hardy, and Colonel Moran
18226 \begin_inset space ~
18229 – showed that the game was whist, and that there was a fairly equal fall
18231 Adair might have lost five pounds, but not more.
18232 His fortune was a considerable one, and such a loss could not in any way
18234 He had played nearly every day at one club or other, but he was a cautious
18235 player, and usually rose a winner.
18236 It came out in evidence that, in partnership with Colonel Moran, he had
18237 actually won as much as four hundred and twenty pounds in a sitting, some
18238 weeks before, from Godfrey Milner and Lord Balmoral.
18239 So much for his recent history as it came out at the inquest.
18247 \begin_layout Subsubsection
18251 \begin_layout Standard
18252 The examples in this section show some more special features of multiple
18256 \begin_layout Standard
18257 For more features of multiple columns, have a look at the
18258 \begin_inset CommandInset href
18260 name "documentation"
18261 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
18266 of the \SpecialChar LaTeX
18268 \begin_inset Flex Code
18271 \begin_layout Plain Layout
18280 \begin_layout Paragraph
18284 \begin_layout Standard
18285 To add a preface text for multiple columns, set the cursor into the multicolumn
18286 inset and use the menu
18288 Insert\SpecialChar menuseparator
18292 Write your preface text into that inset.
18293 \begin_inset Newline newline
18296 This is an example with some preface text:
18299 \begin_layout Standard
18300 \begin_inset VSpace bigskip
18306 \begin_layout Standard
18307 \begin_inset Flex Multiple Columns
18310 \begin_layout Plain Layout
18311 \begin_inset Argument 2
18314 \begin_layout Plain Layout
18315 And the story continues and continues and continues and continues\SpecialChar ldots
18323 On the evening of the crime, he returned from the club exactly at ten.
18324 His mother and sister were out spending the evening with a relation.
18325 The servant deposed that she heard him enter the front room on the second
18326 floor, generally used as his sitting-room.
18327 She had lit a fire there, and as it smoked she had opened the window.
18328 No sound was heard from the room until eleven-twenty, the hour of the return
18329 of Lady Maynooth and her daughter.
18330 Desiring to say good-night, she attempted to enter her son's room.
18331 The door was locked on the inside, and no answer could be got to their
18332 cries and knocking.
18333 Help was obtained, and the door forced.
18334 The unfortunate young man was found lying near the table.
18335 His head had been horribly mutilated by an expanding revolver bullet, but
18336 no weapon of any sort was to be found in the room.
18344 \begin_layout Standard
18345 You can also use a section heading as the preface if you use a section command
18346 as \SpecialChar TeX
18348 For example the command
18351 \begin_layout LyX-Code
18354 subsection{subsection title}
18357 \begin_layout Standard
18358 creates a subsection.
18359 In this example the preface is a subsubsection:
18362 \begin_layout Standard
18363 \begin_inset Flex Multiple Columns
18366 \begin_layout Plain Layout
18367 \begin_inset Argument 2
18370 \begin_layout Plain Layout
18374 \begin_layout Plain Layout
18383 This is a subsubsection heading as a preface
18387 \begin_layout Plain Layout
18401 A minute examination of the circumstances served only to make the case more
18403 In the first place, no reason could be given why the young man should have
18404 fastened the door upon the inside.
18405 There was the possibility that the murderer had done this, and had afterwards
18406 escaped by the window.
18407 The drop was at least twenty feet, however, and a bed of crocuses in full
18409 Neither the flowers nor the earth showed any sign of having been disturbed,
18410 nor were there any marks upon the narrow strip of grass which separated
18411 the house from the road.
18412 Apparently, therefore, it was the young man himself who had fastened the
18414 But how did he come by his death? No one could have climbed up to the window
18415 without leaving traces.
18416 Suppose a man had fired through the window, he would indeed be a remarkable
18417 shot who could with a revolver inflict so deadly a wound.
18418 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
18419 a hundred yards of the house.
18420 No one had heard a shot.
18428 \begin_layout Standard
18429 If there is less vertical space than 6
18430 \begin_inset space ~
18433 text lines is left on the page at the beginning of the multiple columns,
18434 a page break will be inserted before the multiple columns.
18435 Depending on the number of lines of the preface text, you might want to
18437 This is done by setting the cursor into the mulitcolumn inset behind the
18438 preface (if there is any) and using the menu
18440 Insert\SpecialChar menuseparator
18442 \begin_inset space ~
18446 \begin_inset space ~
18450 \begin_inset space ~
18456 Insert into that inset the amount of space like e.
18457 \begin_inset space \thinspace{}
18461 \begin_inset space \space{}
18465 \begin_inset Quotes eld
18469 \begin_inset Quotes erd
18473 \begin_inset Newline newline
18476 In this example the space is set to 7
18477 \begin_inset space ~
18480 text lines by using
18481 \begin_inset Flex Code
18484 \begin_layout Plain Layout
18493 \begin_inset Flex Code
18496 \begin_layout Plain Layout
18504 needs to be inserted as \SpecialChar TeX
18508 \begin_layout Standard
18509 \begin_inset Flex Multiple Columns
18512 \begin_layout Plain Layout
18513 \begin_inset Argument 3
18516 \begin_layout Plain Layout
18521 \begin_layout Plain Layout
18537 On the evening of the crime, he returned from the club exactly at ten.
18538 His mother and sister were out spending the evening with a relation.
18539 The servant deposed that she heard him enter the front room on the second
18540 floor, generally used as his sitting-room.
18541 She had lit a fire there, and as it smoked she had opened the window.
18542 No sound was heard from the room until eleven-twenty, the hour of the return
18543 of Lady Maynooth and her daughter.
18544 Desiring to say good-night, she attempted to enter her son's room.
18545 The door was locked on the inside, and no answer could be got to their
18546 cries and knocking.
18547 Help was obtained, and the door forced.
18548 The unfortunate young man was found lying near the table.
18549 His head had been horribly mutilated by an expanding revolver bullet, but
18550 no weapon of any sort was to be found in the room.
18558 \begin_layout Paragraph
18562 \begin_layout Standard
18563 The amount of space before and after multiple columns can be changed by
18564 changing the length
18565 \begin_inset Flex Code
18568 \begin_layout Plain Layout
18577 For example the command
18580 \begin_layout LyX-Code
18588 \begin_layout Standard
18589 in \SpecialChar TeX
18590 Code changes its value to 3
18591 \begin_inset space \thinspace{}
18595 The change must be made before the multiple columns' start.
18596 The predefined value is 13
18597 \begin_inset space \thinspace{}
18603 \begin_layout Standard
18605 \begin_inset Flex Code
18608 \begin_layout Plain Layout
18617 \begin_inset space \thinspace{}
18623 \begin_layout Standard
18627 \begin_layout Plain Layout
18633 multicolsep}{2.5cm}
18641 \begin_layout Standard
18642 \begin_inset Flex Multiple Columns
18645 \begin_layout Plain Layout
18648 All day I turned these facts over in my mind, endeavouring to hit upon some
18649 theory which could reconcile them all, and to find that line of least resistanc
18650 e which my poor friend had declared to be the starting-point of every investigat
18652 I confess that I made little progress.
18653 In the evening I strolled across the Park, and found myself about six o'clock
18654 at the Oxford Street end of Park Lane.
18655 A group of loafers upon the pavements, all staring up at a particular window,
18656 directed me to the house which I had come to see.
18657 A tall, thin man with coloured glasses, whom I strongly suspected of being
18658 a plain-clothes detective, was pointing out some theory of his own, while
18659 the others crowded round to listen to what he said.
18660 I got as near him as I could, but his observations seemed to me to be absurd,
18661 so I withdrew again in some disgust.
18662 As I did so I struck against an elderly, deformed man, who had been behind
18663 me, and I knocked down several books which he was carrying.
18671 \begin_layout Standard
18672 \begin_inset Note Greyedout
18675 \begin_layout Plain Layout
18680 The values you set with
18681 \begin_inset Flex Code
18684 \begin_layout Plain Layout
18692 will be used for all following multiple columns until you change them again.
18700 \begin_layout Standard
18704 \begin_layout Plain Layout
18716 \begin_inset Note Note
18719 \begin_layout Plain Layout
18720 go back to the default
18728 \begin_layout Standard
18730 \change_deleted 564990737 1672236355
18731 \begin_inset Newpage newpage
18739 \begin_layout Paragraph
18743 \begin_layout Standard
18744 A column break can be forced by inserting the command
18745 \begin_inset Flex Code
18748 \begin_layout Plain Layout
18756 as \SpecialChar TeX
18757 Code to that position in the text where the column should be broken.
18758 Note that this leads in most cases to whitespace in the text.
18759 \begin_inset Newline newline
18762 Here is an example:
18765 \begin_layout Standard
18766 \begin_inset Flex Multiple Columns
18769 \begin_layout Plain Layout
18772 \begin_inset Quotes eld
18775 You're surprised to see me, sir,
18776 \begin_inset Quotes erd
18779 said he, in a strange, croaking voice.
18782 \begin_layout Plain Layout
18785 I acknowledged that I was.
18788 \begin_layout Plain Layout
18791 \begin_inset Quotes eld
18794 Well, I've a conscience, sir, and when I chanced to see you go into this
18795 house, as I came hobbling after you, I thought to myself, I'll just step
18796 in and see that kind gentleman, and tell him that if I was a bit gruff
18797 in my manner there was not any harm meant, and that I am much obliged to
18798 him for picking up my books.
18799 \begin_inset Quotes erd
18805 \begin_layout Plain Layout
18808 \begin_inset Quotes eld
18811 You make too much of a trifle,
18812 \begin_inset Quotes erd
18817 \begin_inset Quotes eld
18820 May I ask how you knew who I was?
18821 \begin_inset Quotes erd
18824 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
18828 \begin_layout Plain Layout
18840 \begin_layout Plain Layout
18843 \begin_inset Quotes eld
18846 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
18847 you'll find my little bookshop at the corner of Church Street, and very
18848 happy to see you, I am sure.
18849 Maybe you collect yourself, sir.
18853 \begin_inset space ~
18867 \begin_inset space ~
18870 – a bargain, every one of them.
18871 With five volumes you could just fill that gap on that second shelf.
18872 It looks untidy, does it not, sir?
18873 \begin_inset Quotes erd
18884 \begin_layout Paragraph
18888 \begin_layout Standard
18889 The width of the columns is automatically calculated, but you can modify
18890 the space between the columns.
18891 This is done by changing the length
18892 \begin_inset Flex Code
18895 \begin_layout Plain Layout
18904 Its predefined value is 10
18905 \begin_inset space \thinspace{}
18909 Here is an example where
18910 \begin_inset Flex Code
18913 \begin_layout Plain Layout
18922 \begin_inset space \thinspace{}
18928 \begin_layout Standard
18932 \begin_layout Plain Layout
18946 \begin_layout Standard
18947 \begin_inset Flex Multiple Columns
18950 \begin_layout Plain Layout
18953 My observations of No.
18954 \begin_inset space \space{}
18957 427 Park Lane did little to clear up the problem in which I was interested.
18958 The house was separated from the street by a low wall and railing, the
18959 whole not more than five feet high.
18960 It was perfectly easy, therefore, for anyone to get into the garden, but
18961 the window was entirely inaccessible, since there was no water pipe or
18962 anything which could help the most active man to climb it.
18963 More puzzled than ever, I retraced my steps to Kensington.
18964 I had not been in my study five minutes when the maid entered to say that
18965 a person desired to see me.
18966 To my astonishment it was none other than my strange old book collector,
18967 his sharp, wizened face peering out from a frame of white hair, and his
18968 precious volumes, a dozen of them at least, wedged under his right arm.
18976 \begin_layout Standard
18980 \begin_layout Plain Layout
18992 \begin_inset Note Note
18995 \begin_layout Plain Layout
18996 go back to the default
19004 \begin_layout Paragraph
19008 \begin_layout Standard
19009 Between the columns a rule with a width of the length
19010 \begin_inset Flex Code
19013 \begin_layout Plain Layout
19022 If this rule width is set to 0
19023 \begin_inset space \thinspace{}
19026 pt (this is the default), the rule is suppressed.
19027 In the following example the rule is 2
19028 \begin_inset space \thinspace{}
19034 \begin_layout Standard
19038 \begin_layout Plain Layout
19044 columnseprule}{2pt}
19052 \begin_layout Standard
19053 \begin_inset Flex Multiple Columns
19056 \begin_layout Plain Layout
19059 \begin_inset Quotes eld
19062 You're surprised to see me, sir,
19063 \begin_inset Quotes erd
19066 said he, in a strange, croaking voice.
19069 \begin_layout Plain Layout
19072 I acknowledged that I was.
19075 \begin_layout Plain Layout
19078 \begin_inset Quotes eld
19081 Well, I've a conscience, sir, and when I chanced to see you go into this
19082 house, as I came hobbling after you, I thought to myself, I'll just step
19083 in and see that kind gentleman, and tell him that if I was a bit gruff
19084 in my manner there was not any harm meant, and that I am much obliged to
19085 him for picking up my books.
19086 \begin_inset Quotes erd
19092 \begin_layout Plain Layout
19095 \begin_inset Quotes eld
19098 You make too much of a trifle,
19099 \begin_inset Quotes erd
19104 \begin_inset Quotes eld
19107 May I ask how you knew who I was?
19108 \begin_inset Quotes erd
19114 \begin_layout Plain Layout
19117 \begin_inset Quotes eld
19120 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
19121 you'll find my little bookshop at the corner of Church Street, and very
19122 happy to see you, I am sure.
19123 Maybe you collect yourself, sir.
19127 \begin_inset space ~
19141 \begin_inset space ~
19144 – a bargain, every one of them.
19145 With five volumes you could just fill that gap on that second shelf.
19146 It looks untidy, does it not, sir?
19147 \begin_inset Quotes erd
19158 \begin_layout Standard
19159 \begin_inset VSpace defskip
19165 \begin_layout Standard
19166 The rule can be colored by redefining the command
19167 \begin_inset Flex Code
19170 \begin_layout Plain Layout
19179 This is done by inserting the command
19182 \begin_layout LyX-Code
19187 columnseprulecolor}{
19192 \begin_layout Standard
19193 as \SpecialChar TeX
19194 Code before the multicolumn inset.
19196 \begin_inset Flex Code
19199 \begin_layout Plain Layout
19205 in this command by a color of your choice.
19206 You can use all pre- and self-defined colors.
19214 \begin_inset space ~
19219 for more information about pre- and self-defined colors.
19220 To go back to the default color insert the command
19223 \begin_layout LyX-Code
19228 columnseprulecolor}{
19233 \begin_layout Standard
19234 Here is the example with a cyan rule and 1
19235 \begin_inset space \thinspace{}
19238 cm column separation:
19241 \begin_layout Standard
19245 \begin_layout Plain Layout
19254 \begin_layout Plain Layout
19260 columnseprulecolor}{
19270 \begin_layout Standard
19271 \begin_inset Flex Multiple Columns
19274 \begin_layout Plain Layout
19277 \begin_inset Quotes eld
19280 You're surprised to see me, sir,
19281 \begin_inset Quotes erd
19284 said he, in a strange, croaking voice.
19287 \begin_layout Plain Layout
19290 I acknowledged that I was.
19293 \begin_layout Plain Layout
19296 \begin_inset Quotes eld
19299 Well, I've a conscience, sir, and when I chanced to see you go into this
19300 house, as I came hobbling after you, I thought to myself, I'll just step
19301 in and see that kind gentleman, and tell him that if I was a bit gruff
19302 in my manner there was not any harm meant, and that I am much obliged to
19303 him for picking up my books.
19304 \begin_inset Quotes erd
19310 \begin_layout Plain Layout
19313 \begin_inset Quotes eld
19316 You make too much of a trifle,
19317 \begin_inset Quotes erd
19322 \begin_inset Quotes eld
19325 May I ask how you knew who I was?
19326 \begin_inset Quotes erd
19332 \begin_layout Plain Layout
19335 \begin_inset Quotes eld
19338 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
19339 you'll find my little bookshop at the corner of Church Street, and very
19340 happy to see you, I am sure.
19341 Maybe you collect yourself, sir.
19345 \begin_inset space ~
19359 \begin_inset space ~
19362 – a bargain, every one of them.
19363 With five volumes you could just fill that gap on that second shelf.
19364 It looks untidy, does it not, sir?
19365 \begin_inset Quotes erd
19376 \begin_layout Standard
19380 \begin_layout Plain Layout
19386 columnseprule}{0pt}
19389 \begin_layout Plain Layout
19395 columnseprulecolor}{
19403 \begin_inset Note Note
19406 \begin_layout Plain Layout
19407 go back to the default
19415 \begin_layout Section
19417 \change_inserted 564990737 1671270380
19421 \begin_layout Subsection
19423 \change_inserted 564990737 1671270398
19425 \change_deleted 564990737 1671270396
19431 \begin_layout Standard
19434 as well as any other text processor uses by default rectangular paragraphs.
19435 For special cases like for example posters, invitation cards or poems you
19436 can modify the paragraph shape to one of your choice.
19437 This can be done by using the \SpecialChar LaTeX
19439 \begin_inset Flex Code
19442 \begin_layout Plain Layout
19448 which is loaded by using in the document settings the module
19450 Custom paragraph shapes
19455 \begin_layout Subsubsection
19459 \begin_layout Standard
19464 provides the following shapes:
19467 \begin_layout Standard
19468 \begin_inset Tabular
19469 <lyxtabular version="3" rows="13" columns="3">
19470 <features booktabs="true" islongtable="true" longtabularalignment="center">
19471 <column alignment="left" valignment="middle" width="16col%">
19472 <column alignment="left" valignment="middle" width="40col%">
19473 <column alignment="left" valignment="middle" width="35col%">
19474 <row endhead="true">
19475 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
19478 \begin_layout Plain Layout
19487 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
19490 \begin_layout Plain Layout
19499 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
19502 \begin_layout Plain Layout
19512 <row interlinespace="default">
19513 <cell alignment="left" valignment="top" usebox="none">
19516 \begin_layout Plain Layout
19524 <cell alignment="left" valignment="top" usebox="none">
19527 \begin_layout Plain Layout
19530 Circle with circular hole (in the size of a CD/DVD)
19535 <cell alignment="left" valignment="top" usebox="none">
19538 \begin_layout Plain Layout
19541 Cannot be scaled, take care there is not too much text
19547 <row interlinespace="default">
19548 <cell alignment="left" valignment="top" usebox="none">
19551 \begin_layout Plain Layout
19559 <cell alignment="left" valignment="top" usebox="none">
19562 \begin_layout Plain Layout
19570 <cell alignment="left" valignment="top" usebox="none">
19573 \begin_layout Plain Layout
19576 Fragile, calculation might fail
19582 <row interlinespace="default">
19583 <cell alignment="left" valignment="top" usebox="none">
19586 \begin_layout Plain Layout
19594 <cell alignment="left" valignment="top" usebox="none">
19597 \begin_layout Plain Layout
19600 Rhomboid (symbolizing a
19601 \begin_inset Quotes eld
19605 \begin_inset Quotes erd
19613 <cell alignment="left" valignment="top" usebox="none">
19616 \begin_layout Plain Layout
19625 <row interlinespace="default">
19626 <cell alignment="left" valignment="top" usebox="none">
19629 \begin_layout Plain Layout
19637 <cell alignment="left" valignment="top" usebox="none">
19640 \begin_layout Plain Layout
19648 <cell alignment="left" valignment="top" usebox="none">
19651 \begin_layout Plain Layout
19660 <row interlinespace="default">
19661 <cell alignment="left" valignment="top" usebox="none">
19664 \begin_layout Plain Layout
19672 <cell alignment="left" valignment="top" usebox="none">
19675 \begin_layout Plain Layout
19683 <cell alignment="left" valignment="top" usebox="none">
19686 \begin_layout Plain Layout
19695 <row interlinespace="default">
19696 <cell alignment="left" valignment="top" usebox="none">
19699 \begin_layout Plain Layout
19707 <cell alignment="left" valignment="top" usebox="none">
19710 \begin_layout Plain Layout
19713 Nut for bolt (hexagon with circular hole)
19718 <cell alignment="left" valignment="top" usebox="none">
19721 \begin_layout Plain Layout
19730 <row interlinespace="default">
19731 <cell alignment="left" valignment="top" usebox="none">
19734 \begin_layout Plain Layout
19742 <cell alignment="left" valignment="top" usebox="none">
19745 \begin_layout Plain Layout
19753 <cell alignment="left" valignment="top" usebox="none">
19756 \begin_layout Plain Layout
19765 <row interlinespace="default">
19766 <cell alignment="left" valignment="top" usebox="none">
19769 \begin_layout Plain Layout
19777 <cell alignment="left" valignment="top" usebox="none">
19780 \begin_layout Plain Layout
19788 <cell alignment="left" valignment="top" usebox="none">
19791 \begin_layout Plain Layout
19800 <row interlinespace="default">
19801 <cell alignment="left" valignment="top" usebox="none">
19804 \begin_layout Plain Layout
19812 <cell alignment="left" valignment="top" usebox="none">
19815 \begin_layout Plain Layout
19823 <cell alignment="left" valignment="top" usebox="none">
19826 \begin_layout Plain Layout
19835 <row interlinespace="default">
19836 <cell alignment="left" valignment="top" usebox="none">
19839 \begin_layout Plain Layout
19847 <cell alignment="left" valignment="top" usebox="none">
19850 \begin_layout Plain Layout
19853 Normal/reversed rain drop
19858 <cell alignment="left" valignment="top" usebox="none">
19861 \begin_layout Plain Layout
19864 Fragile, calculation might fail
19870 <row interlinespace="default">
19871 <cell alignment="left" valignment="top" usebox="none">
19874 \begin_layout Plain Layout
19883 <cell alignment="left" valignment="top" usebox="none">
19886 \begin_layout Plain Layout
19889 The \SpecialChar TeX
19895 <cell alignment="left" valignment="top" usebox="none">
19898 \begin_layout Plain Layout
19907 <row interlinespace="default">
19908 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
19911 \begin_layout Plain Layout
19915 \begin_inset Newline newline
19923 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
19926 \begin_layout Plain Layout
19929 Triangles in different orientations
19934 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
19937 \begin_layout Plain Layout
19953 \begin_layout Standard
19954 To use a shape for your paragraph, simply select it in \SpecialChar LyX
19956 for environments in the toolbar.
19959 \begin_layout Standard
19960 \begin_inset Newpage newpage
19966 \begin_layout Standard
19967 Here is an example paragraph in the shape of a nut:
19970 \begin_layout Standard
19971 \begin_inset VSpace bigskip
19980 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
19981 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
19983 At vero eos et accusam et justo duo dolores et ea rebum.
19984 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
19986 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
19987 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
19991 \begin_layout Standard
19992 \begin_inset VSpace bigskip
19998 \begin_layout Standard
19999 \begin_inset Note Greyedout
20002 \begin_layout Plain Layout
20011 paragraphs cannot run over a page break.
20019 \begin_layout Standard
20020 \begin_inset VSpace bigskip
20026 \begin_layout Standard
20028 \begin_inset Flex Code
20031 \begin_layout Plain Layout
20037 takes care that the shape will always be preserved, no matter how much
20038 text is in the paragraph.
20039 Therefore the paragraph size changes with the amount of contained text.
20040 This can lead to paragraph sizes exceeding the page margins.
20041 To demonstrate the size scaling, here is the same example paragraph but
20042 with twice as much text:
20045 \begin_layout Standard
20046 \begin_inset Newpage newpage
20055 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
20056 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
20058 At vero eos et accusam et justo duo dolores et ea rebum.
20059 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
20061 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
20062 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
20064 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
20065 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
20067 At vero eos et accusam et justo duo dolores et ea rebum.
20068 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
20070 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
20071 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
20075 \begin_layout Standard
20076 \begin_inset VSpace bigskip
20082 \begin_layout Standard
20083 An exception is the shape
20088 It cannot be scaled because it must fit the size of a CD/DVD.
20089 Therefore the amount of text that fits into the shape is limited.
20090 \begin_inset Newline newline
20101 shape are fragile, meaning that the calculation of their size can fail,
20102 depending on the amount of text.
20103 You will then get the \SpecialChar LaTeX
20105 \begin_inset Quotes eld
20108 Arithmetic overflow
20109 \begin_inset Quotes erd
20113 In this case one can try to remove or add some text; if nothing works one
20114 has to use another shape.
20117 \begin_layout Standard
20118 \begin_inset VSpace bigskip
20124 \begin_layout Standard
20125 For shapes with tips you will maybe see that \SpecialChar LaTeX
20126 's hyphenation routine fails
20127 for text in the tips.
20128 Therefore it is often necessary to add hyphenation points
20133 arg "specialchar-insert hyphenation"
20138 ) to the corresponding text parts.
20141 \begin_layout Standard
20142 \begin_inset VSpace bigskip
20148 \begin_layout Standard
20149 Shapepar paragraphs are either always centered or placed on the page so
20150 that their left border touches the left page margin.
20151 You can therefore not use the paragraph dialog to align such paragraphs.
20152 A solution is to put the paragraph into a minipage or parbox and align
20154 The problem is hereby to find the right width for the box.
20155 Because if it is too wide and you center the box, the paragraph is not
20156 centered too because it sticks at the left side of the box.
20157 So you might have to play a bit with the width until it fits.
20158 Here are two heart-shaped paragraphs, the first one is not aligned, the
20159 second one is right-aligned:
20162 \begin_layout Standard
20163 \begin_inset Newpage newpage
20169 \begin_layout Heart
20173 Lo\SpecialChar softhyphen
20174 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
20175 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
20177 At vero eos et accusam et justo duo dolores et ea rebum.
20178 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
20182 \begin_layout Standard
20183 \begin_inset VSpace bigskip
20189 \begin_layout Standard
20192 \begin_inset Box Frameless
20202 height_special "totalheight"
20207 backgroundcolor "none"
20210 \begin_layout Heart
20214 Lo\SpecialChar softhyphen
20215 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
20216 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
20218 At vero eos et accusam et justo duo dolores et ea rebum.
20219 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
20228 \begin_layout Subsubsection
20232 \begin_layout Standard
20233 You can define any shape you want.
20234 Doing this manually is a lot of work because every coordinate must be specified.
20235 But there is a way to let the computer calculate the coordinates:
20238 \begin_layout Enumerate
20239 Install the program
20240 \begin_inset CommandInset href
20243 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
20251 \begin_layout Enumerate
20258 TeX/LaTeX\SpecialChar menuseparator
20259 Settings\SpecialChar menuseparator
20262 and select the font size you are using in your document.
20263 For example this document uses the size 12
20264 \begin_inset space \thinspace{}
20270 \begin_layout Enumerate
20274 \begin_layout Enumerate
20277 TeX/LaTeX\SpecialChar menuseparator
20280 to export the shape to coordinates.
20281 In the appearing dialog use either the outline of your shape for the coordinate
20282 s or the path itself.
20286 \begin_layout Plain Layout
20287 For more information see
20288 \begin_inset CommandInset href
20290 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
20303 \begin_layout Standard
20304 The coordinates are written into a \SpecialChar TeX
20306 To use it for your \SpecialChar LyX
20310 \begin_layout Enumerate
20311 Place the cursor before the first character of your paragraph (or into a
20315 \begin_layout Enumerate
20316 Open in \SpecialChar LyX
20319 Insert\SpecialChar menuseparator
20320 File\SpecialChar menuseparator
20322 \begin_inset space ~
20327 , select the file and use
20336 \begin_layout Standard
20337 \begin_inset VSpace defskip
20343 \begin_layout Standard
20344 \begin_inset Note Greyedout
20347 \begin_layout Plain Layout
20352 : The changed shape only applies to the current paragraph; everything is
20353 reset to normal for the next paragraph.
20354 Therefore the shape definition file must be input into every paragraph
20355 with the desired shape.
20363 \begin_layout Standard
20364 \begin_inset VSpace bigskip
20370 \begin_layout Standard
20371 Here is an example:
20374 \begin_layout Standard
20375 \begin_inset VSpace bigskip
20381 \begin_layout Standard
20382 \begin_inset CommandInset include
20384 filename "SpecialParagraphShape.tex"
20391 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
20392 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
20394 At vero eos et accusam et justo duo dolores et ea rebum.
20395 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
20397 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
20398 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
20402 \begin_layout Standard
20403 \begin_inset VSpace bigskip
20409 \begin_layout Standard
20414 to draw complexer shapes in
20418 you can draw the shape in a program of your choice and import the resulting
20424 Then you only need to draw a line or spline along the outline of the image.
20427 \begin_layout Standard
20428 \begin_inset VSpace bigskip
20434 \begin_layout Standard
20437 Custom paragraph shapes
20439 also provides the two commands
20447 which can be used to define custom shapes coordinate by coordinate.
20451 \begin_layout Plain Layout
20452 These commands are internally used for all shapes described here.
20457 For information how these styles are used and about further customization
20458 possibilities, have a look at the
20459 \begin_inset CommandInset href
20461 name "documentation"
20462 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
20468 \begin_inset Flex Code
20471 \begin_layout Plain Layout
20480 \begin_layout Chapter
20482 \change_deleted 564990737 1671304317
20486 \change_inserted 564990737 1671304322
20488 \change_deleted 564990737 1671304331
20489 ies with Bib\SpecialChar TeX
20495 \begin_layout Standard
20496 The most basic information about how to use Bib\SpecialChar TeX
20501 with \SpecialChar LyX
20502 is contained in the section
20504 Bibliography databases
20511 The following subsections explain special bibliography features supported
20512 by \SpecialChar LyX
20516 \begin_layout Section
20517 Alternative Citation Styles
20520 \begin_layout Standard
20521 Standard Bib\SpecialChar TeX
20523 \begin_inset space \thinspace{}
20527 \begin_inset space \space{}
20531 \begin_inset Quotes eld
20535 \begin_inset Quotes erd
20538 ) to refer to a cited work.
20539 However, in many scientific disciplines, other citation styles are in use.
20540 The most common one is the author-year style (e.
20541 \begin_inset space \thinspace{}
20545 \begin_inset space \space{}
20549 \begin_inset Quotes eld
20553 \begin_inset Quotes erd
20558 supports three packages that provide this style,
20559 \begin_inset Flex Code
20562 \begin_layout Plain Layout
20569 \begin_inset Flex Code
20572 \begin_layout Plain Layout
20579 \begin_inset Flex Code
20582 \begin_layout Plain Layout
20589 Each of these packages has their pros and cons, which cannot be listed
20591 If you only want to have simple author-year (or author-numerical) style,
20592 or if you want to use one of the countless style files for
20593 \begin_inset Flex Code
20596 \begin_layout Plain Layout
20602 , then the established
20603 \begin_inset Flex Code
20606 \begin_layout Plain Layout
20612 package is probably your choice.
20613 If you look for specific citation styles common in law studies, you might
20615 \begin_inset Flex Code
20618 \begin_layout Plain Layout
20625 If you want to have full control over the formatting or look for advanced
20626 features such as ibidem, footnote citations, full title citations, advanced
20627 date formats (such as 400 BC) or full localization to other languages than
20628 English, you should definitely consider
20629 \begin_inset Flex Code
20632 \begin_layout Plain Layout
20638 , which exceeds all other packages in terms of features, but is also quite
20639 heavy and more resource-hungry.
20642 \begin_layout Standard
20643 The handling of these packages in \SpecialChar LyX
20644 is basically the same.
20646 \begin_inset Flex Noun
20649 \begin_layout Plain Layout
20650 Document\SpecialChar menuseparator
20657 \begin_inset Flex Noun
20660 \begin_layout Plain Layout
20667 \begin_inset Flex Noun
20670 \begin_layout Plain Layout
20677 \begin_inset Flex Noun
20680 \begin_layout Plain Layout
20687 \begin_inset Flex Noun
20690 \begin_layout Plain Layout
20697 \begin_inset Flex Noun
20700 \begin_layout Plain Layout
20701 Biblatex (Natbib mode)
20707 \begin_inset Flex Noun
20710 \begin_layout Plain Layout
20717 \begin_inset Flex Noun
20720 \begin_layout Plain Layout
20727 \begin_inset space ~
20730 6.5.3 in the User's Guide for more information on these choices).
20731 With all these packages, you will get some extra features in the citation
20732 dialog and you can select the style of the reference (
20733 \begin_inset Quotes eld
20737 \begin_inset Quotes erd
20741 \begin_inset Quotes eld
20745 \begin_inset Quotes erd
20749 \begin_inset Quotes eld
20753 \begin_inset Quotes erd
20757 \begin_inset Quotes eld
20761 \begin_inset Quotes erd
20765 Note that either package needs specifically designed style files.
20766 They all ship their own, but there are lots of additional style files,
20767 and there is even an interactive style file builder
20771 \begin_layout Plain Layout
20773 \begin_inset Flex URL
20776 \begin_layout Plain Layout
20778 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
20789 \begin_inset Flex Code
20792 \begin_layout Plain Layout
20801 \begin_layout Section
20802 Subdivided Bibliographies
20805 \begin_layout Standard
20806 Sometimes you might need to divide your bibliography into several sections.
20807 If you are for instance a historian, the possibility to separate sources
20808 and scientific works is most likely a
20809 \begin_inset Quotes eld
20813 \begin_inset Quotes erd
20817 Unfortunately, Bib\SpecialChar TeX
20818 itself does not allow you to do this.
20819 But with the help of some \SpecialChar LaTeX
20820 packages, Bib\SpecialChar TeX
20821 can be extended to fit your needs.
20824 \begin_layout Standard
20826 provides native support for one of these packages,
20834 \begin_layout Plain Layout
20836 \begin_inset Flex URL
20839 \begin_layout Plain Layout
20841 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
20851 The advantage of this package (compared to other packages such as
20855 ) is that you don't need to define new citation commands.
20856 Instead, you need to prepare different bibliographic databases which include
20857 the entries for the different sections of the bibliography.
20858 For example: If you want to divide your bibliography into the sections
20860 \begin_inset Quotes eld
20864 \begin_inset Quotes erd
20868 \begin_inset Quotes eld
20872 \begin_inset Quotes erd
20875 , you first need to create two bibliographic databases, e.
20876 \begin_inset space \thinspace{}
20880 \begin_inset space \space{}
20884 \begin_inset Flex Code
20887 \begin_layout Plain Layout
20894 \begin_inset Flex Code
20897 \begin_layout Plain Layout
20907 \begin_layout Standard
20909 \begin_inset Flex Noun
20912 \begin_layout Plain Layout
20913 Document\SpecialChar menuseparator
20920 \begin_inset Flex Noun
20923 \begin_layout Plain Layout
20930 \begin_inset Flex Noun
20933 \begin_layout Plain Layout
20934 Subdivided bibliography
20940 Now you can insert multiple Bib\SpecialChar TeX
20941 bibliographies, one for each section of
20943 Returning to our example: Insert the Bib\SpecialChar TeX
20945 \begin_inset Flex Code
20948 \begin_layout Plain Layout
20954 and a second one for the database
20955 \begin_inset Flex Code
20958 \begin_layout Plain Layout
20965 You are free to use the same or different styles for each section.
20966 Additionally, you can choose if the bibliography section should contain
20968 \begin_inset Quotes eld
20971 all cited references
20972 \begin_inset Quotes erd
20975 of the specified database(s) (which is the default),
20976 \begin_inset Quotes eld
20979 all uncited references
20980 \begin_inset Quotes erd
20984 \begin_inset Quotes eld
20988 \begin_inset Quotes erd
20992 This might be useful if you would like to separate your bibliography into
20994 \begin_inset Quotes eld
20998 \begin_inset Quotes erd
21002 \begin_inset Quotes eld
21006 \begin_inset Quotes erd
21010 \begin_inset Quotes eld
21014 \begin_inset Quotes erd
21018 The titles for the sections can be added as ordinary sections or subsections.
21020 \begin_inset Flex Code
21023 \begin_layout Plain Layout
21029 removes the bibliography title, you have to manually re-add that, too (as
21030 a chapter* or section*, for instance).
21033 \begin_layout Standard
21038 , the procedure is a bit different.
21047 , the aforementioned
21048 \begin_inset Flex Noun
21051 \begin_layout Plain Layout
21052 Subdivided bibliography
21057 option is disabled if you use
21066 provides its own means to generate subdivided bibliographies.
21067 You can either add keywords to bibliography entries via the
21068 \begin_inset Flex Code
21071 \begin_layout Plain Layout
21077 entry option and then filter bibliography sections by keyword (by adding
21079 \begin_inset Flex Code
21082 \begin_layout Plain Layout
21089 \begin_inset Flex Noun
21092 \begin_layout Plain Layout
21098 field of the dialog that opens if you left-click on the
21099 \begin_inset Flex Noun
21102 \begin_layout Plain Layout
21103 Biblatex Generated Bibliography
21108 button), or you can filter by entry types (such as
21117 \begin_inset space \thinspace{}
21122 \begin_inset Flex Code
21125 \begin_layout Plain Layout
21132 \begin_inset Flex Code
21135 \begin_layout Plain Layout
21142 \begin_inset Flex Noun
21145 \begin_layout Plain Layout
21151 field, or you can create so-called
21152 \begin_inset Quotes eld
21155 Bibliography Categories
21156 \begin_inset Quotes erd
21159 to which you can assign individual entries.
21160 Please refer to the Biblatex manual, section
21162 Subdivided Bibliographies
21167 \begin_layout Section
21168 Multiple Bibliographies
21169 \begin_inset CommandInset label
21171 name "subsec:Multiple-Bibliographies"
21178 \begin_layout Standard
21179 Multiple bibliographies, e.
21180 \begin_inset space \thinspace{}
21184 \begin_inset space \space{}
21187 a bibliography for each part, chapter, section, subsection or child (sub-documen
21188 t) of the document, are also supported by \SpecialChar LyX
21190 In order to enable it, go to
21191 \begin_inset Flex Noun
21194 \begin_layout Plain Layout
21195 Document\SpecialChar menuseparator
21196 Settings\SpecialChar menuseparator
21202 and select the relevant unit (e.
21203 \begin_inset space \thinspace{}
21207 \begin_inset Quotes eld
21211 \begin_inset Quotes erd
21215 \begin_inset Flex Noun
21218 \begin_layout Plain Layout
21219 Multiple Bibliographies
21225 Then add a Bib(la)\SpecialChar TeX
21226 bibliography to each unit (e.
21227 \begin_inset space \thinspace{}
21230 g., section) of your document.
21231 In the output, a separate bibliography, containing only the references
21232 done in the current unit is generated.
21235 \begin_layout Standard
21236 If you use Bib\SpecialChar TeX
21238 \begin_inset Flex Code
21241 \begin_layout Plain Layout
21248 \begin_inset Flex Code
21251 \begin_layout Plain Layout
21257 package is used to create multiple bibliographies.
21258 The former package is used if you select
21259 \begin_inset Quotes eld
21263 \begin_inset Quotes erd
21271 \begin_inset Flex Noun
21274 \begin_layout Plain Layout
21275 Sectioned Bibliography
21281 In all other cases,
21282 \begin_inset Flex Code
21285 \begin_layout Plain Layout
21295 \begin_layout Plain Layout
21296 An alternative approach, if you are willing to use some
21297 \begin_inset Flex Noun
21300 \begin_layout Plain Layout
21308 \begin_inset space ~
21312 \begin_inset CommandInset ref
21314 reference "sec:Inserting-TeX-Code"
21319 \begin_inset Flex Code
21322 \begin_layout Plain Layout
21334 \begin_inset Flex Code
21337 \begin_layout Plain Layout
21343 is used, \SpecialChar LyX
21344 encloses the specified units in
21345 \begin_inset Flex Code
21348 \begin_layout Plain Layout
21355 \begin_inset Flex Code
21358 \begin_layout Plain Layout
21367 \begin_inset Flex Code
21370 \begin_layout Plain Layout
21378 in order to create the units.
21379 Note that this approach has some limitations.
21380 First, every citation reference has to be inside some
21381 \begin_inset Flex Code
21384 \begin_layout Plain Layout
21391 So citations outside a defined unit (e.
21392 \begin_inset space \thinspace{}
21395 g., before the first section if you use
21396 \begin_inset Quotes eld
21400 \begin_inset Quotes erd
21404 \begin_inset Quotes eld
21408 \begin_inset Quotes erd
21412 You can also create your own units by entering
21413 \begin_inset Flex Code
21416 \begin_layout Plain Layout
21425 \begin_inset Flex Code
21428 \begin_layout Plain Layout
21436 as \SpecialChar TeX
21437 code (for instance to work around the mentioned limitation).
21439 \begin_inset Flex Code
21442 \begin_layout Plain Layout
21448 s cannot be nested.
21449 A second limitation is that
21450 \begin_inset Flex Code
21453 \begin_layout Plain Layout
21459 always processes all references of a bibliography database, even if they
21461 This can result in odd labels (e.
21462 \begin_inset space \thinspace{}
21467 \begin_inset Quotes eld
21471 \begin_inset Quotes erd
21474 if two works of this author from 2014 are in the database, even if only
21478 \begin_layout Standard
21484 \begin_inset Flex Code
21487 \begin_layout Plain Layout
21493 option is used instead.
21494 If you need specific units, you can start them with the \SpecialChar TeX
21496 \begin_inset Flex Code
21499 \begin_layout Plain Layout
21508 \begin_inset Flex Code
21511 \begin_layout Plain Layout
21520 If you also want to control the end of the unit, use the environment
21521 \begin_inset Flex Code
21524 \begin_layout Plain Layout
21534 \begin_inset Flex Code
21537 \begin_layout Plain Layout
21547 \begin_inset Flex Code
21550 \begin_layout Plain Layout
21556 s cannot be nested.
21557 In addition to the individual bibliography of the current unit,
21561 also provides an easy way to output all bibliographies, subsequently, at
21563 \begin_inset space \thinspace{}
21566 g., at the end of the document).
21568 \begin_inset Quotes eld
21571 all reference units
21572 \begin_inset Quotes erd
21575 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
21577 Please refer to the
21581 manual for more information on this topic.
21584 \begin_layout Chapter
21586 \change_deleted 564990737 1671355654
21590 \change_inserted 564990737 1671355667
21592 \change_deleted 564990737 1671355661
21594 \change_inserted 564990737 1671355684
21596 \begin_inset CommandInset label
21598 name "chap:bullets"
21603 \change_deleted 564990737 1671355684
21605 \begin_inset CommandInset label
21616 \begin_layout Standard
21622 \begin_layout Section
21626 \begin_layout Standard
21628 provides 216 bullet shapes that can be accessed from a simple dialog.
21629 Using this dialog you can easily specify what bullet shape to use at each
21630 level of an itemized list.
21631 These settings are document-wide so you won't be able to specify different
21632 sets of bullets for different paragraphs.
21636 \begin_layout Plain Layout
21637 Well, actually you can but you'll have to do it by hand.
21645 \begin_layout Section
21649 \begin_layout Standard
21650 Open the dialog by selecting the
21651 \begin_inset Flex Noun
21654 \begin_layout Plain Layout
21655 Document\SpecialChar menuseparator
21661 menu item and then select the
21662 \begin_inset Flex Noun
21665 \begin_layout Plain Layout
21674 \begin_layout Standard
21675 The dialog provides you with a table of bullet shapes.
21676 A column of buttons on the left of the table provides access to the six
21677 different panels of bullet shapes.
21678 The row of buttons across the top is used to select which bullet depth
21681 \change_deleted 244031559 1603875981
21682 A text entry under the table shows the currently selected bullet shape's
21684 equivalent and this can be edited if desired.
21685 If you do modify the text you will also need to specify any needed packages
21686 in the \SpecialChar LaTeX
21692 \begin_layout Standard
21693 The six panels are divided up by the packages they require.
21694 The following table shows the mappings from button name to \SpecialChar LaTeX
21698 \begin_layout Standard
21700 \begin_inset Tabular
21701 <lyxtabular version="3" rows="7" columns="2">
21702 <features tabularvalignment="middle">
21703 <column alignment="center" valignment="top" width="0pt">
21704 <column alignment="center" valignment="top" width="0pt">
21706 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21709 \begin_layout Plain Layout
21724 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21727 \begin_layout Plain Layout
21744 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21747 \begin_layout Plain Layout
21762 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21765 \begin_layout Plain Layout
21774 base \SpecialChar LaTeX
21782 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21785 \begin_layout Plain Layout
21800 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21803 \begin_layout Plain Layout
21820 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21823 \begin_layout Plain Layout
21838 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21841 \begin_layout Plain Layout
21858 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21861 \begin_layout Plain Layout
21876 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21879 \begin_layout Plain Layout
21896 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21899 \begin_layout Plain Layout
21914 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21917 \begin_layout Plain Layout
21934 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21937 \begin_layout Plain Layout
21952 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21955 \begin_layout Plain Layout
21978 \begin_layout Standard
21980 doesn't stop you using bullets from packages you don't have.
21981 If you get errors from \SpecialChar LaTeX
21982 when you try to view or print the file, then it
21983 is likely you are missing a package.
21987 \begin_layout Plain Layout
21989 doesn't restrict your use since you may be editing locally and exporting
21998 \begin_layout Section
22002 \begin_layout Standard
22003 Select which bullet depth you want to change then select the bullet shape
22005 Any changes will not be visible in \SpecialChar LyX
22006 , but are visible when viewing the document.
22009 \begin_layout Standard
22010 You can reset a bullet shape to the default simply by clicking your right
22011 mouse button on the appropriate bullet depth button.
22015 \begin_layout Plain Layout
22017 \change_inserted 564990737 1672138075
22018 \begin_inset CommandInset label
22020 name "fn:If-you-really"
22030 want to have multiple sets of paragraphs with different sets of bullets
22031 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
22033 The bullet selection dialog can help though because it provides you with
22034 the \SpecialChar LaTeX
22035 code for a wide range of bullet shapes.
22036 To make your own custom paragraphs you have the following options:
22039 \begin_layout Plain Layout
22043 \begin_layout Plain Layout
22059 \begin_layout Plain Layout
22063 \begin_layout Plain Layout
22085 \begin_layout Itemize
22086 Use the \SpecialChar LaTeX
22088 \begin_inset Flex Code
22091 \begin_layout Plain Layout
22099 to specify a new bullet shape for a given depth.
22100 You'll also need to save the current bullet shape so you can restore it
22102 In this itemized list the following \SpecialChar LaTeX
22103 code was used to change the bullet
22104 used for the first depth.
22108 \begin_layout LyX-Code
22118 \begin_layout LyX-Code
22135 \begin_layout Itemize
22136 Note that the itemize depth is specified in Roman numerals as part of the
22146 \begin_layout Itemize
22147 \begin_inset Argument item:1
22150 \begin_layout Plain Layout
22154 \begin_layout Plain Layout
22172 Specify each individual entry by starting each item with the bullet shape
22174 \begin_inset Quotes eld
22178 \begin_inset Quotes erd
22181 inset (available at
22183 Insert\SpecialChar menuseparator
22187 \begin_inset Flex Noun
22190 \begin_layout Plain Layout
22198 For example, this item was started with
22199 \begin_inset Flex Code
22202 \begin_layout Plain Layout
22217 \begin_layout Plain Layout
22221 \begin_layout Plain Layout
22237 \begin_layout Plain Layout
22238 You'll also need to revert the labelitem back to its previous setting for
22239 the global bullet shape settings to remain in effect.
22240 The way used here was:
22243 \begin_layout LyX-Code
22258 \begin_layout Chapter
22262 \begin_layout Section
22263 Multipart Documents
22266 \begin_layout Subsection
22270 \begin_layout Standard
22271 When you are working on a large file with many sections, it is often convenient
22272 to break up the document into several files, or perhaps you have something
22273 where a table may change from time to time, but the preceding text does
22275 In these cases, you should seriously consider using multipart documents.
22276 For example, scientific papers often have five major sections: the introduction
22277 , observations, results, discussion, and conclusion.
22278 Each of these could be its own separate \SpecialChar LyX
22280 \begin_inset Quotes eld
22284 \begin_inset Quotes erd
22287 file which contains the title, authors, abstract, references, etc., plus
22288 the five included files.
22289 It is important to note that each of these files is a full \SpecialChar LyX
22291 can be formatted and printed on its own, as well as included in a master
22293 Each of these files must have the same document class, however—don't attempt
22294 to mix book classes with article classes.
22295 You may also include \SpecialChar LaTeX
22296 files; however, these files must not have their own
22298 \begin_inset space \thinspace{}
22302 \begin_inset space \space{}
22305 everything up to and including the
22306 \begin_inset Flex Code
22309 \begin_layout Plain Layout
22317 line as well as the
22318 \begin_inset Flex Code
22321 \begin_layout Plain Layout
22329 line must be deleted) or else errors will be generated when you try to
22333 \begin_layout Standard
22335 allows you to include files quite easily with
22336 \begin_inset Flex Noun
22339 \begin_layout Plain Layout
22340 Insert\SpecialChar menuseparator
22342 \begin_inset space ~
22351 When you click on this selection a small box is inserted into the file
22352 at the current cursor location.
22353 Clicking on the box raises a dialog which allows you to select the file
22354 to be included, and the method of its inclusion.
22358 \begin_layout Standard
22359 The file selection box should by now be obvious.
22360 The three inclusion methods are
22361 \begin_inset Quotes eld
22365 \begin_inset Quotes erd
22369 \begin_inset Quotes eld
22373 \begin_inset Quotes erd
22377 \begin_inset Quotes eld
22381 \begin_inset Quotes erd
22386 \begin_inset Quotes eld
22390 \begin_inset Quotes erd
22394 \begin_inset Quotes eld
22398 \begin_inset Quotes erd
22401 are similar in many ways, but there are also some notable differences:
22404 \begin_layout Enumerate
22406 \begin_inset Quotes eld
22410 \begin_inset Quotes erd
22413 are typeset beginning on a new page, while files that are
22414 \begin_inset Quotes eld
22418 \begin_inset Quotes erd
22421 are typeset starting on the current page.
22424 \begin_layout Enumerate
22425 \begin_inset Quotes eld
22429 \begin_inset Quotes erd
22432 files cannot themselves
22433 \begin_inset Quotes eld
22437 \begin_inset Quotes erd
22441 \begin_inset Quotes eld
22445 \begin_inset Quotes erd
22450 \begin_inset Quotes eld
22454 \begin_inset Quotes erd
22457 , on the other hand, infinite sub-inputting is possible.
22460 \begin_layout Enumerate
22461 \begin_inset Quotes eld
22465 \begin_inset Quotes erd
22468 allow for the output of only selected
22469 \begin_inset Quotes eld
22473 \begin_inset Quotes erd
22476 files, while maintaining the actual counters (pagination etc.) and references
22477 (please refer to the section
22480 \begin_inset space ~
22488 \begin_inset space ~
22493 manual for details).
22496 \begin_layout Standard
22498 \begin_inset Quotes eld
22502 \begin_inset Quotes erd
22505 is the preferred method for chapters that are outsourced to child documents,
22507 \begin_inset Quotes eld
22511 \begin_inset Quotes erd
22514 is more suitable for arbitrary file inheritance.
22517 \begin_layout Standard
22519 \begin_inset Quotes eld
22523 \begin_inset Quotes erd
22526 included file allows you to include a file typeset exactly as it appears
22528 \begin_inset space \thinspace{}
22532 \begin_inset space \space{}
22536 \begin_inset Flex Code
22539 \begin_layout Plain Layout
22545 mode, with the characters set in a fixed-width typewriter font.
22546 Normally, spaces in this file are invisible, though two consecutive spaces
22547 are conserved, unlike \SpecialChar LyX
22548 's normal treatment of spaces.
22549 However, setting the
22550 \begin_inset Flex Noun
22553 \begin_layout Plain Layout
22555 \begin_inset space ~
22559 \begin_inset space ~
22563 \begin_inset space ~
22571 checkbox typesets a mark to unambiguously define the presence of a space.
22575 \begin_layout Standard
22576 Generally, the master file is converted into a full \SpecialChar LaTeX
22577 file before typesetting,
22578 while the included files are converted to \SpecialChar LaTeX
22579 files that do not have all the
22580 preamble information.
22583 \begin_layout Subsection
22584 Cross-References Between Files
22587 \begin_layout Standard
22588 \begin_inset Box Shadowbox
22598 height_special "totalheight"
22603 backgroundcolor "none"
22606 \begin_layout Plain Layout
22607 This section is somewhat out of date.
22608 Need to describe default master documents and how children are opened when
22618 \begin_layout Standard
22619 It is possible to set up cross-references between the different files.
22620 First, open all the files in question: let's call them A and B in a two
22621 file example, where B is included in A.
22622 Let's say you insert a label in A, then want to reference it in B.
22623 Open the cross-reference dialog whilst in document B, and you can select
22625 \begin_inset Quotes eld
22629 \begin_inset Quotes erd
22635 \begin_layout Subsection
22636 Bibliography Lists in all Subdocuments
22639 \begin_layout Standard
22640 If you work with child documents, you might want to have only one main bibliogra
22641 phy at the end, but still be able to have a selected bibliography for the
22642 child if you output it on its own.
22643 Here is how to achieve this.
22646 \begin_layout Standard
22647 For the main document, you just insert a bibliography inset at the place
22648 where the main bibliography has to appear (within the master file or within
22650 If the bibliography inset is in the master file, the references will be
22651 inherited by all children, so they are available in the citation dialog
22655 \begin_layout Standard
22656 For child-specific bibliographies, insert bibliography insets within the
22657 child documents, at the place where the bibliography should appear when
22658 the child is compiled separately.
22659 However, the trick is to insert them into a branch (
22661 Insert\SpecialChar menuseparator
22662 Branch\SpecialChar menuseparator
22663 Insert New Branch...
22666 \begin_inset space \thinspace{}
22671 \begin_inset Quotes eld
22675 \begin_inset Quotes erd
22679 Within the children, activate the branch (
22681 Document\SpecialChar menuseparator
22682 Settings...\SpecialChar menuseparator
22686 Within the master, deactivate the branch (
22688 Document\SpecialChar menuseparator
22689 Settings...\SpecialChar menuseparator
22693 Now the child's bibliography will be ignored by the master, but considered
22697 \begin_layout Standard
22698 If you need multiple bibliographies (e.
22699 \begin_inset space \thinspace{}
22702 g., one per child in the
22706 ), please refer to sec.
22707 \begin_inset space ~
22711 \begin_inset CommandInset ref
22713 reference "subsec:Multiple-Bibliographies"
22720 \begin_layout Section
22725 \begin_layout Standard
22726 Users sometimes need to be able to
22727 \begin_inset Quotes eld
22731 \begin_inset Quotes erd
22735 file together with all the images (and other files) on which it depends,
22736 either for sending to a publisher or for sharing with a co-author.
22738 includes a Python script (
22739 \begin_inset Flex Code
22742 \begin_layout Plain Layout
22748 ) that automates this process.
22749 To use it, you must have either the
22750 \begin_inset Flex Code
22753 \begin_layout Plain Layout
22760 \begin_inset Flex Code
22763 \begin_layout Plain Layout
22769 python modules installed on your system.
22770 By default, the script prefers the
22771 \begin_inset Flex Code
22774 \begin_layout Plain Layout
22781 \begin_inset Flex Code
22784 \begin_layout Plain Layout
22790 format on Unix-like systems and the
22791 \begin_inset Flex Code
22794 \begin_layout Plain Layout
22803 \begin_layout Standard
22805 's configuration process will set the script up to export a `\SpecialChar LyX
22807 and this format will then be available under
22808 \begin_inset Flex Code
22811 \begin_layout Plain Layout
22812 File\SpecialChar menuseparator
22821 \begin_layout Standard
22822 Independently of the platform, the generation of a particular archive format
22823 can be forced by adding either the
22824 \begin_inset Flex Code
22827 \begin_layout Plain Layout
22834 \begin_inset Flex Code
22837 \begin_layout Plain Layout
22844 \begin_inset Flex Code
22847 \begin_layout Plain Layout
22854 \begin_inset Flex Code
22857 \begin_layout Plain Layout
22863 format) switch to the
22864 \begin_inset Flex Code
22867 \begin_layout Plain Layout
22869 \SpecialChar menuseparator
22877 \begin_inset Flex Code
22880 \begin_layout Plain Layout
22881 Tools\SpecialChar menuseparator
22882 Preferences\SpecialChar menuseparator
22883 File Handling\SpecialChar menuseparator
22890 (Make sure you add the switch after the script name, not before it.)
22893 \begin_layout Section
22894 Fancy Headers and Footers
22897 \begin_layout Standard
22898 The default page layout is rather plain; for an
22899 \begin_inset Flex Code
22902 \begin_layout Plain Layout
22908 document class, all you get is a centered page number at the bottom of
22910 This document uses KOMA-script's book class, so it appears to be a bit
22912 But to really put on a show, you need to set the document page style to
22914 \begin_inset Quotes eld
22918 \begin_inset Quotes erd
22921 , as mentioned in the
22926 This section describes the \SpecialChar LaTeX
22927 code you need to insert in your \SpecialChar LaTeX
22929 order to get the desired effects.
22932 \begin_layout Standard
22933 For more information on fancy headers, see the
22934 \begin_inset Flex Code
22937 \begin_layout Plain Layout
22943 package documentation.
22945 \begin_inset Flex URL
22948 \begin_layout Plain Layout
22950 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
22958 \begin_layout Standard
22959 The page header is divided into three fields, not surprisingly labeled
22960 \begin_inset Quotes eld
22964 \begin_inset Quotes erd
22968 \begin_inset Quotes eld
22972 \begin_inset Quotes erd
22976 \begin_inset Quotes eld
22980 \begin_inset Quotes erd
22984 The footer is also divided into these three fields.
22985 The \SpecialChar LaTeX
22986 commands to set these fields in the simplest manner are
22987 \begin_inset Flex Code
22990 \begin_layout Plain Layout
22999 \begin_inset Flex Code
23002 \begin_layout Plain Layout
23011 \begin_inset Flex Code
23014 \begin_layout Plain Layout
23023 \begin_inset Flex Code
23026 \begin_layout Plain Layout
23035 Suppose you wish to put your name in the upper left hand corner of each
23037 Simply insert the following command in the preamble:
23040 \begin_layout Standard
23049 \begin_layout Standard
23050 You will now see your name in the upper left.
23051 If a field has a default entry that you would like to get rid of (often
23052 the page number appears in the central footer) simply include a command
23053 with a blank argument, e.
23054 \begin_inset space \thinspace{}
23060 \begin_layout Standard
23068 \begin_layout Standard
23069 Let's get really fancy: lets put the section number with the word
23070 \begin_inset Quotes eld
23074 \begin_inset Quotes erd
23078 \begin_inset space \thinspace{}
23082 \begin_inset space \space{}
23085 Section 3) in the upper left, the page number (e.
23086 \begin_inset space \thinspace{}
23090 \begin_inset space \space{}
23093 Page 4) in the upper right, your name in the lower left, and the date in
23095 The following commands should now appear in the preamble:
23098 \begin_layout Standard
23108 \begin_layout Standard
23116 \begin_layout Standard
23126 \begin_layout Standard
23135 \begin_layout Standard
23143 \begin_layout Standard
23153 \begin_layout Standard
23155 \begin_inset Flex Code
23158 \begin_layout Plain Layout
23167 \begin_inset Flex Code
23170 \begin_layout Plain Layout
23178 access \SpecialChar LaTeX
23179 's section and page counters, and so print out the current section
23182 \begin_inset Flex Code
23185 \begin_layout Plain Layout
23193 simply prints out today's date.
23196 \begin_layout Standard
23197 The thicknesses of the horizontal rules drawn beneath the header and above
23198 the footer can also be modified.
23199 If you don't want one of the rules, set its thickness to 0.
23200 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
23206 \begin_inset Flex Code
23209 \begin_layout Plain Layout
23214 headrulewidth}{0.4pt}
23220 \begin_inset Flex Code
23223 \begin_layout Plain Layout
23228 footrulewidth}{0.4pt}
23233 to set the thicknesses.
23236 \begin_layout Standard
23237 You can switch the header/footer settings on and off for individual pages
23238 using commands like
23239 \begin_inset Flex Code
23242 \begin_layout Plain Layout
23245 thispagestyle{empty}
23251 \begin_inset Flex Code
23254 \begin_layout Plain Layout
23257 thispagestyle{plain}
23263 \begin_inset Flex Code
23266 \begin_layout Plain Layout
23269 thispagestyle{fancy}
23275 Simply insert them in the text on the page you want changed and mark them
23276 as \SpecialChar TeX
23278 In fact, title pages are marked as plain by default, while following pages
23279 are marked fancy when using the global fancy setting.
23282 \begin_layout Standard
23283 As a final example, it is possible to include an image in the header or
23285 Suppose you want to put a company logo in the upper lefthand corner.
23286 You might try something like
23289 \begin_layout Standard
23298 includegraphics{logo.eps}}}
23301 \begin_layout Standard
23303 (you may need to preface this with
23304 \begin_inset Flex Code
23307 \begin_layout Plain Layout
23310 usepackage{graphics}
23315 if you don't include graphics elsewhere in your document).
23318 \begin_layout Chapter
23320 and the World Wide Web
23323 \begin_layout Standard
23325 has long supported the export of documents to various web-friendly formats,
23327 Before version 2.0, however, HTML export was always accomplished by the
23328 use of external converters.
23332 \begin_layout Plain Layout
23333 For details on the use of external converters with \SpecialChar LyX
23338 section of the Customization manual.
23343 These fall into two large groups: there are converters that use \SpecialChar LaTeX
23345 intermediate format, such as
23346 \begin_inset Flex Code
23349 \begin_layout Plain Layout
23356 \begin_inset Flex Code
23359 \begin_layout Plain Layout
23366 \begin_inset Flex Code
23369 \begin_layout Plain Layout
23375 , relying upon \SpecialChar LyX
23376 to produce the \SpecialChar LaTeX
23377 ; and there is a converter that works directly
23378 on \SpecialChar LyX
23380 \begin_inset Flex Code
23383 \begin_layout Plain Layout
23391 All of these have different advantages and disadvantages.
23395 \begin_layout Standard
23396 The \SpecialChar LaTeX
23397 -based converters have the advantage that, in principle, they know everythin
23398 g about the exported document that \SpecialChar LaTeX
23400 Such converters do not care, for example, if a certain block of code was
23401 produced by \SpecialChar LyX
23402 or was Evil Red Text.
23403 These converters know about
23404 \begin_inset Flex Code
23407 \begin_layout Plain Layout
23413 files, counters, and references, and can often make use of the
23414 \begin_inset Flex Code
23417 \begin_layout Plain Layout
23423 files generated by Bib\SpecialChar TeX
23425 On the other hand, \SpecialChar LaTeX
23426 is a very hard language to parse—it is sometimes said
23427 that only \SpecialChar TeX
23428 itself understands \SpecialChar TeX
23429 —and \SpecialChar LaTeX
23430 -based converters will often choke on
23431 what seem to be quite simple constructs; complex ones can throw them completely
23432 , and as of this writing, for example, the
23436 manual will not export with
23437 \begin_inset Flex Code
23440 \begin_layout Plain Layout
23446 , though the others will.
23447 The other issue concerns how math is handled.
23448 These converters typically convert the formulae into little pictures that
23449 are then linked from the HTML document.
23450 Since these are actually generated by \SpecialChar LaTeX
23451 , they are accurate.
23452 But they do not scale well, and just getting them to look as if they are
23453 actually meant to be in your document—so that the font sizes seem to be
23454 roughly the same—can be a challenge.
23457 \begin_layout Standard
23459 \begin_inset Flex Code
23462 \begin_layout Plain Layout
23470 \begin_inset CommandInset href
23472 name "http://pinchito.es/elyxer/"
23473 target "http://pinchito.es/elyxer/"
23478 ) solves some of these problems.
23479 In particular, the formulae it produces scale perfectly, since it renders
23480 math using a combination of HTML and CSS rather than converting the formulae
23482 But even moderately complex formula are rendered less well than with
23483 \begin_inset Flex Code
23486 \begin_layout Plain Layout
23492 ; this reflects the limitations of HTML.
23496 \begin_layout Plain Layout
23498 \begin_inset Flex Code
23501 \begin_layout Plain Layout
23508 can also use jsMath and MathJax for equations, but this setting is only
23509 available globally and requires one to have access to a server that runs
23515 More importantly (as of version 1.1.1, at least),
23516 \begin_inset Flex Code
23519 \begin_layout Plain Layout
23526 has limited support for math macros and no support for user-defined paragraph
23527 or character styles.
23528 These limitations make
23529 \begin_inset Flex Code
23532 \begin_layout Plain Layout
23539 unsuitable for many of the documents \SpecialChar LyX
23541 In principle, of course, these problems could be solved, but the \SpecialChar LyX
23543 have decided to follow a different path and have made \SpecialChar LyX
23545 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
23546 , DocBook, and plaintext.
23549 \begin_layout Standard
23550 As of this writing, XHTML output remains under development and should probably
23552 \begin_inset Quotes eld
23556 \begin_inset Quotes erd
23563 \begin_layout Plain Layout
23565 \begin_inset Flex Code
23568 \begin_layout Plain Layout
23569 development/HTML/HTML.notes
23574 , which can be found in the \SpecialChar LyX
23576 \begin_inset CommandInset href
23578 name "accessed online"
23579 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
23584 , usually contains up-to-date information about the state of XHTML output.
23585 See also the list of XHTML bugs on
23586 \begin_inset CommandInset href
23588 name "the bug tracker"
23589 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"
23599 Still, the developers have chosen this approach because it has several
23600 potential advantages over the other two.
23603 \begin_layout Standard
23604 These advantages are primarily due to the fact that the XHTML output routines,
23605 since they are part of \SpecialChar LyX
23606 , know everything \SpecialChar LyX
23607 knows about the document being
23612 \begin_layout Plain Layout
23613 Another advantage is that, since these routines are internal to \SpecialChar LyX
23615 immune to changes in \SpecialChar LyX
23616 's file format, or to changes in the semantics of
23622 So they know about the table of contents (as displayed in the outline),
23623 about the counters associated with different paragraph styles, and about
23624 user-defined styles.
23625 The XHTML output routines know what \SpecialChar LyX
23626 knows about internationalization,
23627 too, so they will output
23628 \begin_inset Quotes eld
23632 \begin_inset Quotes erd
23636 \begin_inset Quotes eld
23644 \begin_inset Quotes erd
23647 , depending upon the language in effect at the time.
23651 \begin_layout Standard
23652 Quite generally, the output routines know what \SpecialChar LyX
23653 knows about document layout,
23654 that is, about how the document is to be rendered on screen.
23655 We use this information when we output the document as XHTML.
23656 In particular, \SpecialChar LyX
23661 generates CSS style information corresponding to the layout information
23662 it uses to render the document on screen: if section headings are supposed
23663 to be sans-serif and bold as seen in \SpecialChar LyX
23664 , then (by default) they will be sans-seri
23665 f and bold when viewed in a web browser, too.
23666 And this is true not just for pre-defined styles, like Section, but for
23667 any style, including user-defined styles.
23668 Indeed, the XHTML output routines make no distinction between user-defined
23670 \change_deleted 244031559 1603876931
23672 \change_inserted 244031559 1603876940
23675 styles and \SpecialChar LyX
23676 's own pre-defined styles: in each case, everything \SpecialChar LyX
23678 the styles is contained in the layout files.
23679 And much the same is true as regards pre-defined textual insets, such as
23680 footnotes, and various custom insets.
23684 \begin_layout Standard
23685 The result is that XHTML output can be customized and extended in exactly
23686 the same way \SpecialChar LaTeX
23687 output can be customized and extended: through layout files
23689 See chapter five of the
23693 manual for the details.
23696 \begin_layout Standard
23697 The remainder of this chapter contains more detailed information on XHTML
23698 output, its limitations, and ways to work around those limitations.
23701 \begin_layout Section
23702 Math Output in XHTML
23705 \begin_layout Standard
23707 offers four choices for how math is rendered.
23708 These have various advantages and disadvantages:
23711 \begin_layout Itemize
23713 \begin_inset Newline newline
23716 MathML is a dialect of XML designed specifically for mathematics on the
23717 web, and it typically renders very well in browsers that support it.
23718 The disadvantage is that not all browsers support MathML, and support is
23719 not complete even in the Gecko-based browsers, such as Firefox.
23720 \begin_inset Newline newline
23723 If \SpecialChar LyX
23724 is unable to render a formula as MathML—for example, if the formula
23726 \begin_inset Flex Code
23729 \begin_layout Plain Layout
23735 package or ERT—then it will instead output the formula as an image.
23739 \begin_layout Itemize
23741 \begin_inset Newline newline
23744 As mentioned above,
23745 \begin_inset Flex Code
23748 \begin_layout Plain Layout
23754 outputs math as HTML, styled by CSS.
23758 \begin_layout Plain Layout
23760 has borrowed some of the CSS for its HTML output from
23761 \begin_inset Flex Code
23764 \begin_layout Plain Layout
23775 For simple formulae, this can work quite well, though with more complicated
23776 formulae it tends to break down.
23777 Still, this method has the advantage that it is very widely supported and
23778 so it may be appropriate for documents that contain only a little, fairly
23780 \begin_inset Newline newline
23783 If Lyx is unable to render a formula as HTML—for example, if the formula
23785 \begin_inset Flex Code
23788 \begin_layout Plain Layout
23794 package or ERT—then it will instead output the formula as an image.
23798 \begin_layout Itemize
23800 \begin_inset Newline newline
23804 \begin_inset Flex Code
23807 \begin_layout Plain Layout
23814 will output formulae as images, the very same images, in fact, that are
23815 used for instant preview.
23819 \begin_layout Plain Layout
23820 Instant preview does
23824 have to be on for images to be output, however.
23829 The advantage to this method is that the images are simply generated by
23831 , so they are very accurate.
23832 The disadvantage, as mentioned earlier, is that these are bitmapped images,
23833 so they do not scale terribly well, and one cannot copy them, etc.
23834 \begin_inset Newline newline
23837 The size of the images can be controlled by setting the
23838 \begin_inset Quotes eld
23841 Math Images Scaling
23842 \begin_inset Quotes erd
23846 \begin_inset Flex Noun
23849 \begin_layout Plain Layout
23850 Document\SpecialChar menuseparator
23851 Settings\SpecialChar menuseparator
23861 \begin_layout Plain Layout
23862 For those who want to know, this controls the resolution of the image in
23863 dots per inch and is based upon a default of 75 dpi.
23869 \begin_inset Newline newline
23872 If \SpecialChar LyX
23873 for some reason fails to create an image for a formula (e.g., if a required
23875 package is not installed), then it will fall back to outputing the raw
23880 \begin_layout Itemize
23883 \begin_inset Newline newline
23886 Finally, \SpecialChar LyX
23887 will happily output math as \SpecialChar LaTeX
23889 As well as being the output of last resort, this method can be used with
23891 \begin_inset CommandInset href
23894 target "http://www.math.union.edu/~dpvc/jsMath/"
23899 , which uses JavaScript to render \SpecialChar LaTeX
23900 embedded in HTML documents.
23902 wraps the \SpecialChar LaTeX
23904 \begin_inset Flex Code
23907 \begin_layout Plain Layout
23913 (for inline formulas) or
23914 \begin_inset Flex Code
23917 \begin_layout Plain Layout
23923 (for displayed formulas) with
23924 \begin_inset Flex Code
23927 \begin_layout Plain Layout
23933 , as is required for jsMath.
23936 \begin_layout Standard
23937 One of these output methods must be selected under
23938 \begin_inset Flex Noun
23941 \begin_layout Plain Layout
23942 Document\SpecialChar menuseparator
23943 Settings\SpecialChar menuseparator
23950 By default, \SpecialChar LyX
23952 This is a document-wide setting, therefore.
23955 \begin_layout Standard
23956 Eventually, \SpecialChar LyX
23957 will offer the user the option to select an alternate output
23958 method for a particular inset, say, one that isn't being rendered very
23963 \begin_layout Plain Layout
23964 That said, since \SpecialChar LyX
23965 falls back to images if the inset contains ERT, then one
23966 can force output as an image by putting some harmless ERT into the math,
23968 \begin_inset Formula $a=b\relax$
23979 \begin_layout Section
23980 Bibliography and Citations
23983 \begin_layout Standard
23984 XHTML output fully supports bibliographies and citations.
23988 \begin_layout Standard
23989 Citation labels are generated by the same machinery that generates \SpecialChar LyX
23991 labels, so the labels will look in the output much as they do in \SpecialChar LyX
23994 If you are using numerical citations, then \SpecialChar LyX
23995 will output numerical labels,
23996 such as [1] or [17], rather than simply showing the citation key in square
23997 brackets, as it does on-screen.
23998 If you are using author-year citations, then \SpecialChar LyX
23999 will add lowercase letters
24000 to the years, just as Bib\SpecialChar TeX
24001 does, if it finds more than one citation for
24002 a given author-year combination.
24003 The labels will be printed with the bibliography entries.
24004 Note that there is, at present, no way to customize the appearance of the
24005 labels, for example, to choose between square brackets and parentheses.
24008 \begin_layout Standard
24009 Bibliography output is handled by the same machinery that handles the presentati
24010 on of reference information in the citation dialog, so you will see in the
24011 XHTML output pretty much what you would see if you were to look at a given
24012 entry in the citation dialog.
24013 The formatting can be customized in your layout file or, preferably, in
24019 manual for the details.
24022 \begin_layout Standard
24023 The main defect at present is that cross-referenced information is printed
24024 with every entry with which it is associated.
24025 So you can see things like this:
24028 \begin_layout Quote
24030 \begin_inset Quotes eld
24033 Context and Logical Form
24034 \begin_inset Quotes erd
24039 Language in Context: Selected Essays
24041 (Oxford: Oxford University Press, 2007), pp.
24045 \begin_layout Quote
24047 \begin_inset Quotes eld
24050 Semantics in Context
24051 \begin_inset Quotes erd
24056 Language in Context: Selected Essays
24058 (Oxford: Oxford University Press, 2007), pp.
24062 \begin_layout Standard
24063 This should be fixed before long.
24066 \begin_layout Standard
24067 There is no support at present for sectioned bibliographies.
24068 If you have multiple bibliographies, then \SpecialChar LyX
24069 will print the same bibliography
24073 \begin_layout Section
24077 \begin_layout Standard
24079 will happily export indexes as XHTML, but with certain limitations at the
24083 \begin_layout Standard
24084 Index export will be most reliable when you do not attempt to use the fancy
24085 constructs that are described in the section on indexes in the
24093 \begin_layout Plain Layout
24094 The main issue here is that \SpecialChar LyX
24095 itself does not really handle these.
24096 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
24102 We'll describe how they are handled using the subsection headings from
24106 \begin_layout Itemize
24107 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
24108 makes an effort to support these,
24109 but the entries must be separated by
24110 \begin_inset Quotes eld
24114 \begin_inset Quotes erd
24117 , that is, there must be spaces around the exclamation point.
24118 This is because it is otherwise too difficult to check for escaped exclamation
24119 points, ones in math, and so forth.
24122 \begin_layout Itemize
24123 Page Ranges: There is no support at all for page ranges, since these make
24124 no sense with XHMTL.
24125 Instead, you will just get two index entries, one at either end.
24128 \begin_layout Itemize
24129 Cross-referencing: There is no support for cross-referencing.
24130 If \SpecialChar LyX
24131 finds an entry containing the
24132 \begin_inset Quotes eld
24135 |see\SpecialChar ldots
24137 \begin_inset Quotes erd
24140 construct, it is just dropped, and the rest is treated as an ordinary index
24144 \begin_layout Itemize
24145 Index Entry Order: \SpecialChar LyX
24146 does support attempts to fix the sorting order.
24147 It will take what is before the first `@' it finds and use that for sorting,
24148 taking what follows the first `@' to be the actual entry.
24149 At present, \SpecialChar LyX
24150 does not check for escaped `@', so do not try to index email
24154 \begin_layout Itemize
24155 Index Entry Layout: You can format entries by using the text style dialog,
24156 or by using any other method available within \SpecialChar LyX
24158 There is no support for constructs like:
24159 \begin_inset Quotes eld
24163 \begin_inset Quotes erd
24167 Indeed, if \SpecialChar LyX
24168 finds a pipe symbol, `|', in an entry, it will delete it and
24169 everything that follows it.
24172 \begin_layout Itemize
24173 Multiple Indexes: There is no support for multiple indexes.
24174 Rather, all index entries will be printed as one large index.
24175 To avoid our printing several versions of the index, we print only the
24176 main index, so make sure you have one.
24179 \begin_layout Section
24180 Nomenclature and Glossary
24183 \begin_layout Standard
24184 There is at present no support for glossaries.
24185 Adding it would be fairly trivial, and welcome.
24188 \begin_layout Chapter
24190 \change_inserted 1075283030 1616534180
24194 \begin_layout Standard
24196 \change_inserted 1075283030 1616534386
24197 Apart from HTML, \SpecialChar LyX
24198 can generate documents in the DocBook XML vocabulary.
24199 With versions 2.3 and before, only select templates could be used to generate
24200 DocBook documents (only version 4).
24201 Starting with \SpecialChar LyX
24202 2.4, most \SpecialChar LyX
24203 layouts can generate valid DocBook documents (only
24205 This feature is built into \SpecialChar LyX
24206 and does not require the use of external tools.
24209 \begin_layout Standard
24211 \change_inserted 1075283030 1616534437
24212 The result is that the DocBook output can be customized and extended in
24213 exactly the same way \SpecialChar LaTeX
24214 output can be customized and extended: through layout
24216 See chapter five of the
24220 manual for the details.
24223 \begin_layout Standard
24225 \change_inserted 1075283030 1616534475
24226 Most \SpecialChar LyX
24227 features are supported with DocBook, like math output.
24230 \begin_layout Itemize
24232 \change_inserted 1075283030 1616534741
24233 Math output is performed mostly in MathML (the major exception being constructio
24234 ns not supported by \SpecialChar LyX
24237 All formulae are also available in raw \SpecialChar TeX
24238 in the DocBook output for further
24242 \begin_layout Itemize
24244 \change_inserted 1075283030 1616534852
24245 Bibliographies and citations are implemented, including with an external
24247 Bibliography entries are not prerendered when the detailed information
24248 are available, but rather output with the standard DocBook constructs.
24249 The external DocBook processor is expected to handle the rendering of entries.
24252 \begin_layout Itemize
24254 \change_inserted 1075283030 1616534863
24255 Indexes are supported, including multiple indices.
24260 ), page ranges, and cross-references (
24264 ) are supported, with the exception of the same symbols escaped.
24273 ) are not supported.
24274 There is no support for escaping of index entries.
24277 \begin_layout Itemize
24279 \change_inserted 1075283030 1616534884
24280 Glossaries are implemented.
24283 \begin_layout Standard
24285 \change_inserted 1075283030 1616534894
24286 Two major parameters can be set at the document level.
24289 \begin_layout Itemize
24291 \change_inserted 1075283030 1616534948
24292 Format for tables: \SpecialChar LyX
24293 can generate tables either as HTML (default value) or
24294 CALS, depending on the user's requirements.
24295 Most DocBook processors accept both formats.
24298 \begin_layout Itemize
24300 \change_inserted 1075283030 1616535006
24301 MathML prefix: in DocBook, MathML is included within its own name space,
24303 The implication is that there must be an indication of the tags belonging
24304 to the MathML standard.
24305 Three choices are offered:
24309 \begin_layout Itemize
24311 \change_inserted 1075283030 1616535044
24312 Inline: the MathML name space is defined for each formula (using the
24316 attribute on each formula)
24319 \begin_layout Itemize
24321 \change_inserted 1075283030 1616535090
24326 prefix (default): the MathML name space is defined at the document level
24331 attribute on the root element).
24332 Each MathML is prefixed with
24341 \begin_layout Itemize
24343 \change_inserted 1075283030 1616620405
24348 prefix: similar to the
24357 \begin_layout Standard
24359 \change_inserted 1075283030 1616620470
24360 This option is especially useful if you want \SpecialChar LyX
24361 to match your personal style
24362 or to work with buggy software that only accepts one prefix for MathML.
24368 \begin_layout Chapter
24369 The \SpecialChar LyX
24373 \begin_layout Section
24377 \begin_layout Standard
24378 The `\SpecialChar LyX
24379 server' allows other programs to talk to \SpecialChar LyX
24380 , invoke \SpecialChar LyX
24381 commands, and retrieve
24382 information about the \SpecialChar LyX
24384 This is only intended for advanced users, but they should find it useful.
24385 It is by writing to the \SpecialChar LyX
24386 server, for example, that bibliography managers,
24387 such as JabRef, are able to
24388 \begin_inset Quotes eld
24392 \begin_inset Quotes erd
24395 citations to \SpecialChar LyX
24399 \begin_layout Section
24400 Starting the \SpecialChar LyX
24402 \begin_inset CommandInset label
24404 name "sec:Starting-the-Server"
24411 \begin_layout Standard
24412 The \SpecialChar LyX
24413 server works through the use of a pair of named pipes.
24414 These are usually located in
24415 \begin_inset Flex Code
24418 \begin_layout Plain Layout
24424 , (except on Windows, where
24428 named pipes are special objects located in
24429 \begin_inset Flex Code
24432 \begin_layout Plain Layout
24444 ) and have the names
24445 \begin_inset Quotes eld
24449 \begin_inset Flex Code
24452 \begin_layout Plain Layout
24459 \begin_inset Quotes erd
24463 \begin_inset Quotes eld
24467 \begin_inset Flex Code
24470 \begin_layout Plain Layout
24477 \begin_inset Quotes erd
24481 External programs write into
24482 \begin_inset Flex Code
24485 \begin_layout Plain Layout
24491 and read back data from
24492 \begin_inset Flex Code
24495 \begin_layout Plain Layout
24502 The stem of the pipe names can be defined in the
24503 \begin_inset Flex Noun
24506 \begin_layout Plain Layout
24507 Tools\SpecialChar menuseparator
24513 dialog, for example
24514 \begin_inset Flex Code
24517 \begin_layout Plain Layout
24518 "/home/myhome/lyxpipe"
24524 \begin_inset Flex Code
24527 \begin_layout Plain Layout
24541 on Windows (where any working path instead of lyxpipe can be used, for
24543 \begin_inset Flex Code
24546 \begin_layout Plain Layout
24569 configure this manually in order for the server to start.
24572 \begin_layout Standard
24575 \begin_inset Flex Code
24578 \begin_layout Plain Layout
24585 \begin_inset Flex Code
24588 \begin_layout Plain Layout
24594 ' to create the pipes.
24595 If one of the pipes already exists, \SpecialChar LyX
24596 will assume that another \SpecialChar LyX
24598 is already running and will not start the server.
24599 On POSIX (Unix like) systems, if for some other reason, an unused
24600 \begin_inset Quotes eld
24604 \begin_inset Quotes erd
24607 pipe is left in existence when \SpecialChar LyX
24608 closes, then \SpecialChar LyX
24609 will try to delete it.
24610 If this fails for some reason, you will need to delete the pipes manually
24611 and then restart \SpecialChar LyX
24613 On Windows, pipes are deleted by the OS on program termination or crash,
24615 \begin_inset Quotes eld
24619 \begin_inset Quotes erd
24622 pipes should not be possible.
24625 \begin_layout Standard
24626 To have several \SpecialChar LyX
24627 processes with servers at the same time, you have to use
24628 different configurations, perhaps by using separate user directories, each
24630 \begin_inset Flex Code
24633 \begin_layout Plain Layout
24639 file, for each process.
24642 \begin_layout Standard
24643 If you are developing a client program, you might find it useful to enable
24644 debugging information from the \SpecialChar LyX
24646 Do this by starting \SpecialChar LyX
24648 \begin_inset Flex Code
24651 \begin_layout Plain Layout
24660 \begin_layout Standard
24661 You can find a complete example client written in C++ in the source distribution
24663 \begin_inset Flex Code
24666 \begin_layout Plain Layout
24667 development/lyxserver/server_monitor.cpp
24675 \begin_layout Standard
24676 Another useful tool is the command-line based client found in
24677 \begin_inset Flex Code
24680 \begin_layout Plain Layout
24681 src/client/lyxclient
24689 \begin_layout Section
24690 Normal communication
24693 \begin_layout Standard
24694 To issue a \SpecialChar LyX
24695 call, the client writes a line of ASCII text into the input
24697 This line has the following format:
24700 \begin_layout Quote
24714 \begin_layout Description
24715 clientname is a name that the client can choose arbitrarily.
24716 Its only use is that \SpecialChar LyX
24717 will echo it if it sends an answer—so a client can
24718 dispatch results from different requesters.
24721 \begin_layout Description
24722 function is the function you want \SpecialChar LyX
24724 It is the same as the commands you'd use in the minibuffer.
24727 \begin_layout Description
24728 argument is an optional argument which is meaningful only to some functions
24730 \begin_inset Quotes eld
24734 \begin_inset Quotes erd
24737 LFUN will insert the argument as text at the cursor position).
24740 \begin_layout Standard
24741 The answer from \SpecialChar LyX
24742 will arrive in the output pipe and be of the form
24745 \begin_layout Quote
24759 \begin_layout Standard
24768 are just echoed from the command request, while
24772 is more or less useful information filled according to how the command
24773 execution worked out.
24774 Some commands, such as
24775 \begin_inset Quotes eld
24779 \begin_inset Quotes erd
24782 , will return information about the internal state of \SpecialChar LyX
24784 return an empty data-response.
24785 This means that the command execution went fine.
24788 \begin_layout Standard
24789 In case of errors, the response from \SpecialChar LyX
24790 will have this form
24793 \begin_layout Quote
24807 \begin_layout Standard
24812 should contain an explanation of why the command failed.
24815 \begin_layout Standard
24819 \begin_layout LyX-Code
24820 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
24821 \begin_inset Newline newline
24824 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
24825 \begin_inset Newline newline
24828 read a <~/.lyxpipe.out
24829 \begin_inset Newline newline
24835 \begin_layout Subsection
24836 AppleScript (Mac OS X)
24839 \begin_layout Standard
24840 Since \SpecialChar LyX
24841 2.1, \SpecialChar LyX
24842 supports basic interactions with AppleScript for normal communicatio
24843 n through the command run.
24844 This command takes a direct argument (the
24848 to perform) and an optional argument.
24849 It either returns the output of the function or triggers an error with
24850 the error message and code.
24853 \begin_layout Standard
24857 \begin_layout LyX-Code
24858 tell application "\SpecialChar LyX
24862 \begin_layout LyX-Code
24866 \begin_layout LyX-Code
24867 -- Stores the current file name into f
24870 \begin_layout LyX-Code
24871 set f to (run "server-get-filename" with argument "")
24874 \begin_layout LyX-Code
24875 on error the error_message number the error_number
24878 \begin_layout LyX-Code
24879 display dialog "Error: " & the error_number & ".
24883 \begin_layout LyX-Code
24884 & the error_message buttons {"OK"} default button 1
24887 \begin_layout LyX-Code
24891 \begin_layout LyX-Code
24895 \begin_layout Section
24899 \begin_layout Standard
24901 can notify clients of events going on asynchronously.
24902 Currently it will only do this if the user binds a key sequence with the
24904 \begin_inset Quotes eld
24908 \begin_inset Quotes erd
24912 The format of the string \SpecialChar LyX
24913 sends is as follows:
24916 \begin_layout Quote
24917 \begin_inset Flex Code
24920 \begin_layout Plain Layout
24931 \begin_layout Standard
24936 is the printed representation of the key sequence that was actually typed
24940 \begin_layout Standard
24941 This mechanism can be used to extend \SpecialChar LyX
24942 's command set and implement macros.
24943 Bind some key sequence to
24944 \begin_inset Quotes eld
24948 \begin_inset Quotes erd
24952 Then start a client that listens on the output pipe, dispatches the command
24953 according to the sequence, and starts a function that may use \SpecialChar LyX
24956 requests to issue a command or a series of commands to \SpecialChar LyX
24960 \begin_layout Section
24961 The simple \SpecialChar LyX
24965 \begin_layout Standard
24967 implements a simple protocol that can be used for session management.
24968 All messages are of the form
24971 \begin_layout Quote
24981 \begin_layout Standard
24987 \begin_inset Quotes eld
24991 \begin_inset Quotes erd
24995 \begin_inset Quotes eld
24999 \begin_inset Quotes erd
25004 \begin_inset Quotes eld
25008 \begin_inset Quotes erd
25011 is received from a client, \SpecialChar LyX
25012 will report back to inform the client that
25013 it's listening to it's messages, while
25014 \begin_inset Quotes eld
25018 \begin_inset Quotes erd
25021 sent from \SpecialChar LyX
25022 will inform clients that \SpecialChar LyX
25026 \begin_layout Section
25027 Reverse DVI/PDF search
25030 \begin_layout Standard
25031 Some DVI/PDF viewers
25035 \begin_layout Plain Layout
25036 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
25037 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
25046 facility (also called
25051 This means that you can tell \SpecialChar LyX
25052 to put the cursor to a specific line in the
25053 document by clicking at the respective position in the DVI/PDF output.
25054 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
25056 This is done via the \SpecialChar LyX
25057 server either by using the named pipe (
25061 ), or the UNIX domain socket (
25065 ) that \SpecialChar LyX
25066 creates in its temporary directory (this is the way the
25067 \begin_inset Flex Code
25070 \begin_layout Plain Layout
25076 program communicates with \SpecialChar LyX
25078 In some cases, you need a helper script that mediates between the viewer
25079 and \SpecialChar LyX
25080 , in others, the viewer can communicate with \SpecialChar LyX
25082 This depends on the selected viewer and on your operating system.
25083 The same applies to the way viewers need to be configured and the way the
25084 reverse search is actually performed.
25085 In what follows, we will thus describe how to setup reverse search for
25087 Before we turn to this, though, we will explain what needs to be done generally
25088 to enable reverse search in the DVI/PDF output.
25091 \begin_layout Subsection
25093 \begin_inset CommandInset label
25095 name "subsec:rev-search"
25102 \begin_layout Standard
25103 In most cases \SpecialChar LyX
25104 will do the work for you by pressing the following button
25108 arg "buffer-toggle-output-sync"
25112 Alternatively, you can also enable the feature by checking
25114 Synchronize with Output
25117 \begin_inset Flex Noun
25120 \begin_layout Plain Layout
25121 Document\SpecialChar menuseparator
25122 Settings\SpecialChar menuseparator
25129 In such a case \SpecialChar LyX
25130 will automatically insert the necessary Sync\SpecialChar TeX
25132 PDF) or load the srcltx package (for DVI) respectively.
25133 This option can be easily reached also on
25134 \begin_inset Flex Code
25137 \begin_layout Plain Layout
25146 \begin_layout Standard
25147 If you need a different setting, you can select or input a custom macro
25148 from the drop down box just below
25149 \begin_inset Flex Noun
25152 \begin_layout Plain Layout
25153 Document\SpecialChar menuseparator
25154 Settings\SpecialChar menuseparator
25155 Output\SpecialChar menuseparator
25156 Synchronize with Output
25164 \begin_layout Standard
25165 Note that the method
25166 \begin_inset Flex Code
25169 \begin_layout Plain Layout
25177 enables gzip compression.
25178 If your viewer does not support it, you should instead use
25179 \begin_inset Flex Code
25182 \begin_layout Plain Layout
25193 \begin_layout Standard
25194 Please also note that including the
25195 \begin_inset Flex Code
25198 \begin_layout Plain Layout
25205 \begin_inset Flex Code
25208 \begin_layout Plain Layout
25214 sometimes has an undesired impact on the typesetting.
25215 Thus, you should switch output synchronization off for the final typesetting
25217 \begin_inset Flex Code
25220 \begin_layout Plain Layout
25227 \begin_inset Flex Code
25230 \begin_layout Plain Layout
25240 \begin_layout Standard
25241 In case you need some more special settings that are not covered by the
25242 automatic settings, read the next section about how to set up output synchroniz
25244 If the automatic setup suits your needs, you can readily jump to section
25245 \begin_inset space ~
25249 \begin_inset CommandInset ref
25251 reference "subsec:configuring-viewers"
25255 , where the necessary configuration steps in your viewer – needed both with
25256 the automatic and the manual setup – are described.
25259 \begin_layout Subsection
25263 \begin_layout Standard
25265 provides several different methods for reverse search.
25266 Some are built-in in the
25267 \begin_inset Flex Code
25270 \begin_layout Plain Layout
25276 program, some are provided by external packages.
25277 Your choice depends on whether your \SpecialChar LaTeX
25278 distribution already provides a given
25279 method (the built-in methods are rather new) and whether your viewer can
25281 The available methods are described in the following.
25284 \begin_layout Subsubsection*
25285 Built-in DVI-search via src-specials (DVI only)
25288 \begin_layout Standard
25289 This method provides the DVI file with the necessary information for reverse
25291 It is available in \SpecialChar LaTeX
25292 since quite some time (any somewhat recent \SpecialChar LaTeX
25294 should include it), and it works reliably.
25295 To enable it, change the
25296 \begin_inset Flex Noun
25299 \begin_layout Plain Layout
25310 \begin_inset Flex Noun
25313 \begin_layout Plain Layout
25324 \begin_inset Flex Noun
25327 \begin_layout Plain Layout
25328 Preferences\SpecialChar menuseparator
25329 File Handling\SpecialChar menuseparator
25336 \begin_inset Flex Code
25339 \begin_layout Plain Layout
25340 latex -src-specials $$i
25346 If this doesn't work, check if your \SpecialChar TeX
25347 engine needs different options (the
25348 syntax might differ in some distributions).
25351 \begin_layout Subsubsection*
25352 External Packages (PDFSync and scrltx)
25355 \begin_layout Standard
25364 provide reverse search facility for PDF output (via pdflatex) and DVI output,
25366 In order to enable it, load the packages in the \SpecialChar LyX
25370 \begin_layout Itemize
25371 \begin_inset Flex Code
25374 \begin_layout Plain Layout
25377 usepackage{pdfsync}
25382 for reverse PDF search,
25385 \begin_layout Itemize
25386 \begin_inset Flex Code
25389 \begin_layout Plain Layout
25392 usepackage[active]{srcltx}
25397 for reverse DVI search.
25400 \begin_layout Standard
25401 If you want to be able to perform both DVI and PDF reverse searches, you
25402 can also insert in the preamble the following lines
25405 \begin_layout LyX-Code
25409 \begin_inset Newline newline
25415 \begin_inset Newline newline
25420 usepackage{pdfsync}
25421 \begin_inset Newline newline
25427 \begin_inset Newline newline
25432 usepackage[active]{srcltx}
25433 \begin_inset Newline newline
25441 \begin_layout Standard
25442 This way, you can preview the file as either DVI or PDF (pdflatex) and the
25443 right package will be used.
25446 \begin_layout Standard
25447 Note that PDFSync might affect the output layout of your document.
25448 It is therefore advised to disable PDFsync for final documents.
25451 \begin_layout Subsubsection*
25452 Built-in reverse search via Sync\SpecialChar TeX
25456 \begin_layout Standard
25458 \begin_inset Flex Code
25461 \begin_layout Plain Layout
25467 have built-in support for both PDF and DVI reverse search.
25470 Sync\SpecialChar TeX
25473 facility is basically the result of the integration of the PDFSync package
25474 to the pdftex program and its merge with the
25479 You need at least \SpecialChar TeX
25480 Live 2008 or a recent Mik\SpecialChar TeX
25481 distribution in order to use
25486 \begin_layout Plain Layout
25487 For some reason, Mik\SpecialChar TeX
25488 does not understand/obey the command \SpecialChar LyX
25490 the preamble when you check the "Enable Forward/Reverse Search" button
25491 in the toolbar and does not generate the necessary info.
25494 \begin_layout Plain Layout
25495 The generation of the required info can be forced by changing the converter
25496 "\SpecialChar LaTeX
25497 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
25498 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
25499 the -synctex=1 switch).
25504 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
25505 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
25506 already provide Sync\SpecialChar TeX
25510 \begin_layout Standard
25511 To enable Sync\SpecialChar TeX
25512 for DVI output, change the
25513 \begin_inset Flex Noun
25516 \begin_layout Plain Layout
25527 \begin_inset Flex Noun
25530 \begin_layout Plain Layout
25535 (plain) -> DraftDVI
25541 \begin_inset Flex Noun
25544 \begin_layout Plain Layout
25545 Preferences\SpecialChar menuseparator
25546 File Handling\SpecialChar menuseparator
25553 \begin_inset Flex Code
25556 \begin_layout Plain Layout
25557 latex -synctex=1 $$i
25562 , and for PDF output, change the
25563 \begin_inset Flex Noun
25566 \begin_layout Plain Layout
25571 (pdflatex) -> PDF (pdflatex)
25577 \begin_inset Flex Code
25580 \begin_layout Plain Layout
25581 pdflatex -synctex=1 $$i
25587 Should your viewer not be considered in the following description, or in
25588 case of missing success, please check the documentation of your viewer
25589 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
25594 \begin_layout Plain Layout
25595 Note that the option
25596 \begin_inset Flex Code
25599 \begin_layout Plain Layout
25605 option enables gzip compression.
25606 If your viewer does not support it, you should instead use
25607 \begin_inset Flex Code
25610 \begin_layout Plain Layout
25624 \begin_layout Subsection
25625 Configuring and using specific viewers
25626 \begin_inset CommandInset label
25628 name "subsec:configuring-viewers"
25635 \begin_layout Subsubsection*
25636 Xdvi (all platforms)
25639 \begin_layout Standard
25641 \begin_inset Flex Code
25644 \begin_layout Plain Layout
25650 , you don't need to do anything else for performing a reverse DVI search,
25651 as \SpecialChar LyX
25652 already provides the necessary hooks for automatically using the
25653 \begin_inset Flex Code
25656 \begin_layout Plain Layout
25663 Just setup your document as described above (reverse search is triggered
25664 by Ctrl-click or Alt-click on Mac OSX, respectively).
25667 \begin_layout Standard
25668 However, if for whatever reason you want to use the named pipe instead of
25669 the socket for communicating with \SpecialChar LyX
25670 , simply change the DVI viewer in
25671 \begin_inset Flex Noun
25674 \begin_layout Plain Layout
25675 Preferences\SpecialChar menuseparator
25676 File Handling\SpecialChar menuseparator
25686 \begin_layout Plain Layout
25687 On Mac OSX you have to use
25688 \begin_inset Flex Code
25691 \begin_layout Plain Layout
25692 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
25703 \begin_inset Flex Code
25706 \begin_layout Plain Layout
25707 xdvi -editor "lyxeditor.sh %f %l"
25713 \begin_inset Flex Code
25716 \begin_layout Plain Layout
25722 is a suitable script.
25723 For example, a minimal shell script is the following one:
25726 \begin_layout LyX-Code
25728 \begin_inset Newline newline
25731 LYXPIPE="/path/to/lyxpipe"
25732 \begin_inset Newline newline
25735 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
25736 \begin_inset Newline newline
25739 echo "$COMMAND" > "${LYXPIPE}".in || exit
25740 \begin_inset Newline newline
25743 read TMP < "${LYXPIPE}".out || exit
25746 \begin_layout Standard
25748 \begin_inset Flex Code
25751 \begin_layout Plain Layout
25757 is the LyXServer pipe path specified in
25758 \begin_inset Flex Noun
25761 \begin_layout Plain Layout
25762 Preferences\SpecialChar menuseparator
25772 \begin_layout Plain Layout
25774 \begin_inset Flex Code
25777 \begin_layout Plain Layout
25783 folder of a source distribution you can find a
25784 \begin_inset Flex Code
25787 \begin_layout Plain Layout
25793 script which is able to locate the
25797 based on your preferences.
25805 \begin_layout Subsubsection*
25809 \begin_layout Standard
25811 \begin_inset Flex Code
25814 \begin_layout Plain Layout
25815 /Applications/MacDviX_Folder/calleditor.script
25820 , add the following lines:
25823 \begin_layout LyX-Code
25824 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
25825 \begin_inset Newline newline
25831 \begin_layout Standard
25832 Modify the lines accordingly if you install \SpecialChar LyX
25833 somewhere else than in the
25834 Applications folder.
25837 \begin_layout Standard
25838 Reverse search is triggered by Alt-click (OPTION-click).
25841 \begin_layout Subsubsection*
25845 \begin_layout Standard
25847 \begin_inset Flex Code
25850 \begin_layout Plain Layout
25851 open -a Skim.app $$i
25856 to the viewer setting in
25857 \begin_inset Flex Noun
25860 \begin_layout Plain Layout
25861 Preferences\SpecialChar menuseparator
25862 File Handling\SpecialChar menuseparator
25863 File formats\SpecialChar menuseparator
25870 \begin_inset Flex Noun
25873 \begin_layout Plain Layout
25874 Skim\SpecialChar menuseparator
25875 Preferences\SpecialChar menuseparator
25882 \begin_inset Flex Noun
25885 \begin_layout Plain Layout
25891 preset and enter command
25892 \begin_inset Flex Noun
25895 \begin_layout Plain Layout
25896 /Applications/\SpecialChar LyX
25897 .app/Contents/MacOS/lyxeditor
25905 \begin_layout Standard
25906 Reverse search is triggered by COMMAND-SHIFT-click
25909 \begin_layout Subsubsection*
25913 \begin_layout Standard
25914 Reverse search with evince does not work out of the box, but it can be achieved
25915 by means of some third party helper scripts.
25917 \begin_inset CommandInset href
25919 target "https://wiki.lyx.org/LyX/SyncTeX"
25927 \begin_layout Subsubsection*
25931 \begin_layout Standard
25933 \begin_inset Flex Noun
25936 \begin_layout Plain Layout
25937 Settings\SpecialChar menuseparator
25938 Configure Okular\SpecialChar menuseparator
25945 \begin_inset Quotes erd
25949 This inserts the appropriate command (
25950 \begin_inset Flex Code
25953 \begin_layout Plain Layout
25962 \begin_layout Standard
25963 Reverse search is triggered by SHIFT-click.
25965 \change_inserted -712698321 1578211026
25966 Note that this only works if Okular is in
25967 \begin_inset Quotes eld
25971 \begin_inset Quotes erd
25975 \begin_inset space \thinspace{}
25978 e., the hand symbol is clicked).
25983 \begin_layout Subsubsection*
25987 \begin_layout Standard
25988 Qpdfview supports Sync\SpecialChar TeX
25989 since version 0.3.5.
25991 \begin_inset Flex Noun
25994 \begin_layout Plain Layout
25995 Edit\SpecialChar menuseparator
25996 Settings\SpecialChar menuseparator
26002 , click on the input field of the
26003 \begin_inset Quotes eld
26007 \begin_inset Quotes erd
26010 item and add the command
26011 \begin_inset Flex Code
26014 \begin_layout Plain Layout
26023 \begin_layout Standard
26024 Reverse search is triggered by double-click or, in more recent versions,
26028 \begin_layout Subsubsection*
26032 \begin_layout Standard
26033 Launch yap, choose its
26034 \begin_inset Flex Noun
26037 \begin_layout Plain Layout
26038 View\SpecialChar menuseparator
26044 menu and select the
26045 \begin_inset Quotes eld
26049 \begin_inset Quotes erd
26054 \begin_inset Quotes eld
26057 New\SpecialChar ldots
26059 \begin_inset Quotes erd
26062 button and, in the window that opens, enter
26063 \begin_inset Quotes eld
26068 \begin_inset Quotes erd
26071 (or any other name you like) in the
26072 \begin_inset Quotes eld
26076 \begin_inset Quotes erd
26080 Now click on the button labeled
26081 \begin_inset Quotes eld
26086 \begin_inset Quotes erd
26089 to open a file dialog and navigate to the directory containing the batch
26091 \begin_inset Flex Code
26094 \begin_layout Plain Layout
26102 \begin_inset Flex Code
26105 \begin_layout Plain Layout
26111 and then specify the program arguments as
26112 \begin_inset Flex Code
26115 \begin_layout Plain Layout
26123 \begin_inset Flex Code
26126 \begin_layout Plain Layout
26132 wrapper is used for communicating with \SpecialChar LyX
26140 \begin_layout LyX-Code
26142 \begin_inset Newline newline
26145 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
26154 \begin_inset Newline newline
26168 \begin_layout Standard
26169 Make sure that the \SpecialChar LyX
26170 Server pipe path you specified in \SpecialChar LyX
26172 \begin_inset Flex Code
26175 \begin_layout Plain Layout
26189 , otherwise change the
26190 \begin_inset Flex Code
26193 \begin_layout Plain Layout
26199 wrapper accordingly.
26202 \begin_layout Standard
26203 In yap, reverse search is triggered by double-click.
26206 \begin_layout Subsubsection*
26207 SumatraPDF (Windows)
26210 \begin_layout Standard
26211 In order to use SumatraPDF for inverse search, enter
26212 \begin_inset Flex Code
26215 \begin_layout Plain Layout
26216 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
26221 in the viewer setting in
26222 \begin_inset Flex Noun
26225 \begin_layout Plain Layout
26226 Preferences\SpecialChar menuseparator
26227 File Handling\SpecialChar menuseparator
26228 File formats\SpecialChar menuseparator
26235 \begin_inset Flex Code
26238 \begin_layout Plain Layout
26244 is the previous wrapper.
26245 If SumatraPDF.exe is not in your command PATH, use its full file name.
26248 \begin_layout Standard
26249 Reverse search is triggered by double-click.
26252 \begin_layout Subsubsection*
26256 \begin_layout Standard
26257 First of all, make sure that yap is your default DVI viewer in the Windows
26258 environment, then launch it, choose its
26259 \begin_inset Flex Noun
26262 \begin_layout Plain Layout
26263 View\SpecialChar menuseparator
26269 menu and select the
26270 \begin_inset Quotes eld
26274 \begin_inset Quotes erd
26279 \begin_inset Quotes eld
26282 New\SpecialChar ldots
26284 \begin_inset Quotes erd
26287 button and, in the window that opens, enter
26288 \begin_inset Quotes eld
26293 \begin_inset Quotes erd
26296 (or any other name you like) in the
26297 \begin_inset Quotes eld
26301 \begin_inset Quotes erd
26305 Now click on the button labeled
26306 \begin_inset Quotes eld
26311 \begin_inset Quotes erd
26314 to open a file dialog and navigate to the directory containing the
26315 \begin_inset Flex Code
26318 \begin_layout Plain Layout
26324 program (which is installed by default on Cygwin along with the \SpecialChar LyX
26327 \begin_inset Flex Code
26330 \begin_layout Plain Layout
26336 and then specify the program arguments as
26337 \begin_inset Flex Code
26340 \begin_layout Plain Layout
26347 In this way, you will be using the
26351 for communicating with \SpecialChar LyX
26353 If, for whatever reason, you want to use the
26358 \begin_inset Flex Code
26361 \begin_layout Plain Layout
26367 option and be sure to specify the \SpecialChar LyX
26368 Server pipe path in the \SpecialChar LyX
26372 \begin_layout Standard
26373 In yap, reverse search is triggered by double-click.
26376 \begin_layout Subsubsection*
26377 SumatraPDF (Cygwin)
26380 \begin_layout Standard
26381 In order to use SumatraPDF for inverse search, enter
26382 \begin_inset Flex Code
26385 \begin_layout Plain Layout
26386 SumatraPDF -inverse-search "lyxeditor -g %f %l"
26391 in the viewer setting in
26392 \begin_inset Flex Noun
26395 \begin_layout Plain Layout
26396 Preferences\SpecialChar menuseparator
26397 File Handling\SpecialChar menuseparator
26398 File formats\SpecialChar menuseparator
26405 If SumatraPDF.exe is not in your command PATH, use its full posix path.
26407 \begin_inset Flex Code
26410 \begin_layout Plain Layout
26416 enables communication via the
26422 \begin_inset Flex Code
26425 \begin_layout Plain Layout
26431 option if you want to use the
26435 , and be sure to specify the \SpecialChar LyX
26436 Server pipe path in the \SpecialChar LyX
26440 \begin_layout Standard
26441 Reverse search is triggered by double-click.
26444 \begin_layout Section
26448 \begin_layout Standard
26449 Forward search is, as the name implies, in a sense the
26450 \begin_inset Quotes eld
26454 \begin_inset Quotes erd
26458 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
26460 If forward search is set up (as described in what follows), you can put
26461 the cursor anywhere in your \SpecialChar LyX
26463 \begin_inset Flex Noun
26466 \begin_layout Plain Layout
26467 Navigate\SpecialChar menuseparator
26474 \begin_inset Flex Noun
26477 \begin_layout Plain Layout
26483 in the context menu via right mouse click), and then the viewer will jump
26484 to that position as well.
26485 This implies, of course, that your viewer supports this function.
26488 \begin_layout Standard
26489 To make forward search possible, you first need to provide the generated
26490 output PDF/DVI file with additional information about the \SpecialChar TeX
26492 This can be done via the methods described in the section
26493 \begin_inset CommandInset ref
26495 reference "subsec:rev-search"
26502 \begin_layout Standard
26503 Additionally, you need to configure \SpecialChar LyX
26504 for using your viewers in
26505 \begin_inset Flex Noun
26508 \begin_layout Plain Layout
26509 Tools\SpecialChar menuseparator
26510 Preferences\SpecialChar menuseparator
26511 Output\SpecialChar menuseparator
26518 We provide a range of tested configurations for some viewers, which you
26519 can select from the drop down list.
26520 If none of these configurations suits you, you have to find out and enter
26521 a suitable configuration yourself.
26522 The definition syntax uses the following placeholders:
26525 \begin_layout Itemize
26527 \begin_inset Flex Code
26530 \begin_layout Plain Layout
26539 \begin_layout Itemize
26541 \begin_inset Flex Code
26544 \begin_layout Plain Layout
26550 : name of the (temporary) exported .tex file (without path)
26553 \begin_layout Itemize
26555 \begin_inset Flex Code
26558 \begin_layout Plain Layout
26564 : name of the (temporary) exported .tex file (including path)
26567 \begin_layout Itemize
26569 \begin_inset Flex Code
26572 \begin_layout Plain Layout
26578 : name of the exported output file (either dvi or pdf, depending on which
26579 one exists in the temporary directory)
26582 \begin_layout Standard
26583 Note that only some of the viewers provide full and usable forward search
26584 functionality out of the box, among them yap, xdvi, okular
26588 \begin_layout Plain Layout
26589 You might want to set
26590 \begin_inset Flex Code
26593 \begin_layout Plain Layout
26600 \begin_inset Flex Noun
26603 \begin_layout Plain Layout
26604 Tools\SpecialChar menuseparator
26605 Preferences\SpecialChar menuseparator
26606 File Handling\SpecialChar menuseparator
26608 \begin_inset space ~
26621 , qpdfview, and SumatraPDF
26625 \begin_layout Plain Layout
26626 SumatraPDF can also use DDE commands through the external program CMCDDE
26627 — downloadable from
26628 \begin_inset CommandInset href
26630 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
26641 Others, such as evince
26645 \begin_layout Plain Layout
26646 Forward search with evince can be achieved by means of third party helper
26649 \begin_inset CommandInset href
26651 target "https://wiki.lyx.org/LyX/SyncTeX"
26661 , require some extra tools in order to use forward search.
26662 While many of the widespread PDF viewers (most notably Adobe Reader) do
26663 not support forward search at all, some other viewers – e.
26664 \begin_inset space \thinspace{}
26668 xpdf – allow at least to reload the document and jump to a specific page
26669 of the file, so you can at least navigate
26670 \begin_inset Quotes eld
26674 \begin_inset Quotes erd
26678 This latter functionality is provided by an external call of synctex (see
26679 the predefined example configurations).
26683 \begin_layout Standard
26684 Forward search works both with DVI and PDF output.
26686 simply checks which preview format you have used before (i.
26687 \begin_inset space \thinspace{}
26690 e., which format is already there in the temporary directory) and chooses
26691 the appropriate configuration for the respective format.
26694 \begin_layout Chapter
26696 \change_deleted 564990737 1671097409
26697 Special Document Classes
26702 \begin_layout Section
26704 \change_deleted 564990737 1669742044
26708 \begin_layout Standard
26710 \change_deleted 564990737 1669742044
26716 \begin_layout Subsection
26718 \change_deleted 564990737 1669742044
26722 \begin_layout Standard
26724 \change_deleted 564990737 1669742044
26725 This section describes how \SpecialChar LyX
26726 can be used to write articles for submission
26727 to the scientific journal
26729 Astronomy and Astrophysics
26732 \begin_inset Flex URL
26735 \begin_layout Plain Layout
26737 https://www.aanda.org/
26742 ) using Version 5.01 of the document class
26747 This package can be downloaded from the ftp site
26750 \begin_layout Standard
26752 \change_deleted 564990737 1669742044
26753 \begin_inset VSpace medskip
26759 \begin_layout Standard
26762 \change_deleted 564990737 1669742044
26763 \begin_inset Flex URL
26766 \begin_layout Plain Layout
26768 ftp://ftp.edpsciences.org/pub/aa/readme.html
26776 \begin_layout Standard
26778 \change_deleted 564990737 1669742044
26779 \begin_inset VSpace medskip
26785 \begin_layout Standard
26787 \change_deleted 564990737 1669742044
26788 A manual comes together with that package, and this text is not meant to
26789 replace the original manual but is merely a short guide in how to realize
26790 the correct form of your paper.
26794 \begin_layout Standard
26796 \change_deleted 564990737 1669742044
26797 Please note that the publisher of the journal was changed from Springer
26798 to EDP Sciences starting January 1, 2001.
26799 That change involved also some slight changes to the style files, namely
26800 the removal of the thesaurus command.
26801 The \SpecialChar LyX
26802 class aa supports the newest version of these style files, V 5.01.
26803 If you have an older version installed, please upgrade.
26804 For compatibility, the old (version 4) layout has been kept as
26809 Please refer to the comments in
26812 Dir/layouts/aapaper.layout
26817 \begin_layout Subsection
26819 \change_deleted 564990737 1669742044
26823 \begin_layout Standard
26825 \change_deleted 564990737 1669742044
26826 It is recommended you start from the example template distributed with \SpecialChar LyX
26828 If you are not using a template, note the following settings:
26831 \begin_layout Itemize
26833 \change_deleted 564990737 1669742044
26840 Document\SpecialChar menuseparator
26843 dialog (OK, that one was obvious).
26846 \begin_layout Itemize
26848 \change_deleted 564990737 1669742044
26849 Don't change the option
26852 \begin_inset space ~
26862 The whole layout is done by the macros, you shouldn't change anything.
26865 \begin_layout Subsection
26867 \change_deleted 564990737 1669742044
26871 \begin_layout Standard
26873 \change_deleted 564990737 1669742044
26874 First thing to enter is the header information.
26875 It consists of seven entries, of which some are optional.
26879 \begin_layout Itemize
26881 \change_deleted 564990737 1669742044
26889 \begin_layout Itemize
26891 \change_deleted 564990737 1669742044
26899 \begin_layout Itemize
26901 \change_deleted 564990737 1669742044
26909 \begin_layout Itemize
26911 \change_deleted 564990737 1669742044
26919 \begin_layout Itemize
26921 \change_deleted 564990737 1669742044
26926 : [optional] if more than one author: whom to contact for offprint requests.
26929 \begin_layout Itemize
26931 \change_deleted 564990737 1669742044
26936 : [optional] mail address for contacts.
26939 \begin_layout Itemize
26941 \change_deleted 564990737 1669742044
26947 Suggested format is
26949 Received: <date>; Accepted <date>
26952 \begin_layout Standard
26954 \change_deleted 564990737 1669742044
26955 There is no need to issue the
26961 command, this is done automatically by \SpecialChar LyX
26962 when the header is finished.
26963 Although the order of the single header entries doesn't matter it is advised
26964 to keep the above sequence, just to get the best optics and meets the layout
26965 of the real document.
26968 \begin_layout Standard
26970 \change_deleted 564990737 1669742044
26971 If you want to place footnotes in the header block, e.
26972 \begin_inset space \thinspace{}
26976 \begin_inset space \space{}
26979 to state your present address, just use the standard footnote via the menu
26982 Insert\SpecialChar menuseparator
26987 will automagically use the term
26996 \begin_layout Standard
26998 \change_deleted 564990737 1669742044
27001 Edit\SpecialChar menuseparator
27004 , you'll find two insets which are relevant for the titling:
27007 \begin_layout Itemize
27009 \change_deleted 564990737 1669742044
27016 to mark corresponding author\SpecialChar breakableslash
27018 The institutes are numbered sequentially as they appear in the
27022 field, so you have to put a marker to each author.
27025 \begin_layout Itemize
27027 \change_deleted 564990737 1669742044
27032 to supply an email address for fast contact.
27035 \begin_layout Standard
27037 \change_deleted 564990737 1669742044
27038 In addition to these topics, the macros use one additional \SpecialChar LaTeX
27040 has no counterpart in \SpecialChar LyX
27044 \begin_layout Itemize
27046 \change_deleted 564990737 1669742044
27053 to separate different names for more than one author and institute, respectivel
27057 \begin_layout Standard
27059 \change_deleted 564990737 1669742044
27060 The appropriate command has to be entered in \SpecialChar LyX
27061 and marked as \SpecialChar LaTeX
27067 \begin_layout Subsection
27069 \change_deleted 564990737 1669742044
27073 \begin_layout Standard
27075 \change_deleted 564990737 1669742044
27076 The abstract should immediately follow the header block.
27077 With version 5 the abstract environment was changed to a command, and there
27078 is now a restriction to only one paragraph.
27079 In addition, it should contain an entry with the keywords.
27080 This is done via the paragraph style
27085 Refer to the example paper.
27088 \begin_layout Subsection
27090 \change_deleted 564990737 1669742044
27091 Supported environments
27094 \begin_layout Standard
27096 \change_deleted 564990737 1669742044
27097 The A&A paper layout supports the following environments for structuring
27101 \begin_layout Itemize
27103 \change_deleted 564990737 1669742044
27109 \begin_layout Itemize
27111 \change_deleted 564990737 1669742044
27117 \begin_layout Itemize
27119 \change_deleted 564990737 1669742044
27125 \begin_layout Itemize
27127 \change_deleted 564990737 1669742044
27133 \begin_layout Itemize
27135 \change_deleted 564990737 1669742044
27141 \begin_layout Itemize
27143 \change_deleted 564990737 1669742044
27149 \begin_layout Itemize
27151 \change_deleted 564990737 1669742044
27157 \begin_layout Itemize
27159 \change_deleted 564990737 1669742044
27165 \begin_layout Itemize
27167 \change_deleted 564990737 1669742044
27173 \begin_layout Itemize
27175 \change_deleted 564990737 1669742044
27181 \begin_layout Itemize
27183 \change_deleted 564990737 1669742044
27189 \begin_layout Itemize
27191 \change_deleted 564990737 1669742044
27198 \begin_layout Subsection
27200 \change_deleted 564990737 1669742044
27201 Commands not supported by \SpecialChar LyX
27205 \begin_layout Standard
27207 \change_deleted 564990737 1669742044
27208 Some commands are not yet supported by the
27212 layout for \SpecialChar LyX
27214 Some have already been mentioned.
27215 For the sake of completeness, they are listed all together here:
27218 \begin_layout Itemize
27220 \change_deleted 564990737 1669742044
27228 \begin_layout Itemize
27230 \change_deleted 564990737 1669742044
27238 \begin_layout Itemize
27240 \change_deleted 564990737 1669742044
27248 \begin_layout Itemize
27250 \change_deleted 564990737 1669742044
27258 \begin_layout Standard
27260 \change_deleted 564990737 1669742044
27261 If you want to use any of these commands, you have to enter them yourself.
27264 Do not forget to mark them as \SpecialChar LaTeX
27268 \begin_layout Subsection
27270 \change_deleted 564990737 1669742044
27271 Figure and Table Floats
27274 \begin_layout Standard
27276 \change_deleted 564990737 1669742044
27278 provides support for the necessary float environments
27280 figure, figure*, table
27286 , therefore we won't tell much about it here.
27290 \begin_inset space ~
27296 Just remember that tables should be left-aligned.
27297 For that, select the table and change the alignment in
27299 Edit\SpecialChar menuseparator
27301 \begin_inset space ~
27307 \begin_layout Standard
27309 \change_deleted 564990737 1669742044
27310 There is only one special thing: the figures with caption besides the figure.
27311 To create such a figure, you have to do the following:
27314 \begin_layout Enumerate
27316 \change_deleted 564990737 1669742044
27317 Create a wide figure float:
27319 Insert\SpecialChar menuseparator
27320 Float\SpecialChar menuseparator
27323 , then right click in the figure and select
27326 \begin_inset space ~
27334 \begin_layout Enumerate
27336 \change_deleted 564990737 1669742044
27337 Enter your caption text.
27340 \begin_layout Enumerate
27342 \change_deleted 564990737 1669742044
27347 to move the cursor above the caption.
27350 \begin_layout Enumerate
27352 \change_deleted 564990737 1669742044
27356 \begin_layout Enumerate
27358 \change_deleted 564990737 1669742044
27359 Position the cursor behind the figure and insert a horizontal fill:
27361 Insert\SpecialChar menuseparator
27363 \begin_inset space ~
27366 Character\SpecialChar menuseparator
27368 \begin_inset space ~
27376 \begin_layout Enumerate
27378 \change_deleted 564990737 1669742044
27379 Switch to \SpecialChar LaTeX
27383 \begin_inset space ~
27391 \begin_layout Enumerate
27393 \change_deleted 564990737 1669742044
27403 Do not close the brace!
27406 \begin_layout Enumerate
27408 \change_deleted 564990737 1669742044
27409 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
27414 \begin_inset space ~
27426 \begin_layout Standard
27428 \change_deleted 564990737 1669742044
27429 Also, refer to the figures in the example paper.
27432 \begin_layout Subsection
27434 \change_deleted 564990737 1669742044
27438 \begin_layout Standard
27440 \change_deleted 564990737 1669742044
27441 For submission, the paper has to be formated in a special double-spacing
27443 For this purpose, you have to give the option
27447 to the document class.
27448 This must be done using the custom class options field in the
27450 Document\SpecialChar menuseparator
27454 Just enter the string
27461 \begin_layout Subsection
27463 \change_deleted 564990737 1669742044
27467 \begin_layout Standard
27469 \change_deleted 564990737 1669742044
27474 directory contains an example paper written with \SpecialChar LyX
27476 It is the example paper from the original macro package, translated to
27479 Use it for inspiration, and compare the original \SpecialChar LaTeX
27480 code with \SpecialChar LyX
27484 \begin_layout Section
27486 \change_deleted 564990737 1671097429
27490 \begin_layout Standard
27492 \change_deleted 564990737 1671097429
27497 can be used to type letters according to German conventions.
27498 A template file is included in
27500 .../lyx/share/templates
27502 for you to use as a starting point.
27505 \begin_layout Section
27507 \change_deleted 564990737 1671097429
27511 \begin_layout Standard
27513 \change_deleted 564990737 1671097429
27514 See the \SpecialChar LyX
27520 It contains all infos you need.
27523 \begin_layout Section
27525 \change_deleted 564990737 1669755802
27529 \begin_layout Standard
27531 \change_deleted 564990737 1669755802
27534 Panayotis Papasotiriou
27537 \begin_layout Subsection
27539 \change_deleted 564990737 1669755802
27543 \begin_layout Standard
27545 \change_deleted 564990737 1669755802
27546 The ijmpc package is a set of macros that facilitates electronic manuscript
27549 International Journal of Modern Physics C
27552 Similarly, the ijmpd package is for creating manuscripts to be submitted
27555 International Journal of Modern Physics D
27558 Both journals are published by World Scientific.
27559 The corresponding document classes are named
27568 These files, together with instructions for the authors, can be downloaded
27570 \begin_inset Flex URL
27573 \begin_layout Plain Layout
27575 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
27581 \begin_inset Flex URL
27584 \begin_layout Plain Layout
27586 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
27592 Both packages are modified versions of the standard
27593 \begin_inset Quotes eld
27597 \begin_inset Quotes erd
27600 package, and they are almost (but not exactly) identical.
27601 Most of their features are supported by \SpecialChar LyX
27603 I have used \SpecialChar LyX
27604 successfully to write articles submitted to both journals
27605 without any problem.
27608 \begin_layout Subsection
27610 \change_deleted 564990737 1669755802
27614 \begin_layout Standard
27616 \change_deleted 564990737 1669755802
27617 As usual, the easiest way to write a paper is to start with a template.
27620 File\SpecialChar menuseparator
27636 This will give an (almost) empty document that includes the most common
27637 fields found in a manuscript.
27638 Simply overwrite the existing text (including the brackets,
27643 You should keep in mind the following remarks.
27646 \begin_layout Enumerate
27648 \change_deleted 564990737 1669755802
27650 won't let you change the font size and the page style of the document,
27651 because such modifications are not allowed by both packages.
27654 \begin_layout Enumerate
27656 \change_deleted 564990737 1669755802
27657 The language of the document should not be changed.
27658 Before previewing your paper, be sure that the babel package is not used.
27659 To do this, click on
27662 arg "dialog-show document"
27667 \SpecialChar menuseparator
27671 \begin_inset Quotes eld
27675 \begin_inset Quotes erd
27685 \begin_layout Enumerate
27687 \change_deleted 564990737 1669755802
27689 \begin_inset Quotes eld
27693 \begin_inset Quotes erd
27696 style must be used to define keywords.
27699 \begin_layout Enumerate
27701 \change_deleted 564990737 1669755802
27702 The ijmpc package provides a style named
27703 \begin_inset Quotes eld
27706 Classification Codes
27707 \begin_inset Quotes erd
27710 , which can be used to define classification codes, such as PACS numbers.
27711 Note that this facility is not supported by the ijmpd package.
27714 \begin_layout Enumerate
27716 \change_deleted 564990737 1669755802
27717 Several new environments are available:
27718 \begin_inset Quotes eld
27722 \begin_inset Quotes erd
27726 \begin_inset Quotes eld
27730 \begin_inset Quotes erd
27734 \begin_inset Quotes eld
27738 \begin_inset Quotes erd
27742 \begin_inset Quotes eld
27746 \begin_inset Quotes erd
27750 \begin_inset Quotes eld
27754 \begin_inset Quotes erd
27758 \begin_inset Quotes eld
27762 \begin_inset Quotes erd
27766 \begin_inset Quotes eld
27770 \begin_inset Quotes erd
27774 \begin_inset Quotes eld
27778 \begin_inset Quotes erd
27782 \begin_inset Quotes eld
27786 \begin_inset Quotes erd
27790 \begin_inset Quotes eld
27794 \begin_inset Quotes erd
27798 \begin_inset Quotes eld
27802 \begin_inset Quotes erd
27806 \begin_inset Quotes eld
27810 \begin_inset Quotes erd
27814 \begin_inset Quotes eld
27818 \begin_inset Quotes erd
27822 \begin_inset Quotes eld
27826 \begin_inset Quotes erd
27830 Their use is more or less obvious.
27832 supports all these environments; it will use the proper label, text style,
27833 and numbering scheme for each of them.
27836 \begin_layout Enumerate
27838 \change_deleted 564990737 1669755802
27839 Both packages use basic citations; the natbib package should not be used.
27840 In \SpecialChar LyX
27841 , citation references are shown as usual; in the output, citations are
27842 shown as superscripts.
27843 If you want to use a citation as normal text, you should use the
27848 \begin_inset space \thinspace{}
27852 \begin_inset space \space{}
27856 \begin_inset Quotes eld
27860 \begin_inset space \space{}
27870 \begin_inset Quotes erd
27876 \begin_layout Enumerate
27878 \change_deleted 564990737 1669755802
27880 \begin_inset Quotes eld
27884 \begin_inset Quotes erd
27887 section in both packages.
27888 To put acknowledgments, just use the
27889 \begin_inset Quotes eld
27893 \begin_inset Quotes erd
27899 \begin_layout Enumerate
27901 \change_deleted 564990737 1669755802
27902 Appendices may be added to the paper,
27906 the Acknowledgments and
27912 provides a special environment, called
27913 \begin_inset Quotes eld
27917 \begin_inset Quotes erd
27920 which marks the beginning of the appendices.
27921 This environment should be left blank; it just sends a \SpecialChar LaTeX
27922 command, but nothing
27924 In \SpecialChar LyX
27926 \begin_inset Quotes eld
27930 \begin_inset Quotes erd
27933 is printed with blue letters, as a signal that all sections after that
27934 point are appendices.
27935 To write an appendix, use the
27936 \begin_inset Quotes eld
27940 \begin_inset Quotes erd
27945 will number each appendix with capital letters, as required by both journals.
27947 \begin_inset Quotes eld
27951 \begin_inset Quotes erd
27958 be present before the first appendix; if not, all appendices will be numbered
27959 as normal sections in the output.
27962 \begin_layout Enumerate
27964 \change_deleted 564990737 1669755802
27965 The ijmpc and the ijmpd packages use the
27969 command to implement table captions.
27970 As a result, a table created by \SpecialChar LyX
27971 is printed correctly, but its caption
27973 However, you can use some \SpecialChar TeX
27974 code to overcome this problem, so that captions
27975 are printed as expected.
27976 To do so, create a float table as usual, remove the caption, and replace
27977 it with the \SpecialChar TeX
27988 (sic); you must also the \SpecialChar TeX
27993 immediately after the tabular material.
27994 Study the example table included in the template files to see how this
27995 trick is implemented.
27996 Alternatively, If you need table captions, you should implement the whole
28001 file, then include this file to the \SpecialChar LyX
28004 Insert\SpecialChar menuseparator
28005 File\SpecialChar menuseparator
28007 \begin_inset space ~
28013 Details on how to create a table float can be found in the files
28021 , included in the corresponding packages.
28024 \begin_layout Subsection
28026 \change_deleted 564990737 1669755802
28027 Preparing a paper for submission
28030 \begin_layout Standard
28032 \change_deleted 564990737 1669755802
28033 Before you submit your paper you must export the \SpecialChar LyX
28034 document as a \SpecialChar LaTeX
28037 File\SpecialChar menuseparator
28038 Export\SpecialChar menuseparator
28046 \begin_layout Plain Layout
28047 Actually you have the choice between \SpecialChar LaTeX
28048 (plain) and pdflatex.
28049 If you intend to use pdflatex to prepare the paper, you should use the
28050 pdflatex option so that included graphics are converted to PDF format,
28051 ready for use by pdflatex.
28056 , then make the following changes to the resulting
28063 \begin_layout Enumerate
28065 \change_deleted 564990737 1669755802
28066 Remove the comment lines before the
28075 \begin_layout Enumerate
28077 \change_deleted 564990737 1669755802
28078 Remove everything between (and including) the
28090 commands, except for any commands you specifically put into the \SpecialChar LaTeX
28094 \begin_layout Standard
28096 \change_deleted 564990737 1669755802
28101 file should be saved and processed through \SpecialChar LaTeX
28102 as many times as necessary.
28103 You may also want to check the resulting
28112 \begin_layout Section
28114 \change_deleted 564990737 1669801478
28118 \begin_layout Standard
28120 \change_deleted 564990737 1669801478
28126 \begin_layout Subsection
28128 \change_deleted 564990737 1669801478
28132 \begin_layout Standard
28134 \change_deleted 564990737 1669801478
28135 The iopart package provides a document class to create electronic manuscript
28136 submission to the journals published by the Institute of Physics.
28137 Instructions for the authors how to create a paper using the iopart class
28138 can be downloaded together with the iopart package from the site
28139 \begin_inset Flex URL
28142 \begin_layout Plain Layout
28144 ftp://ftp.iop.org/pub/journals/latex2e
28152 \begin_layout Subsection
28154 \change_deleted 564990737 1669801478
28158 \begin_layout Standard
28160 \change_deleted 564990737 1669801478
28161 The easiest way to write a paper is to start with the template
28165 that is available via
28167 File\SpecialChar menuseparator
28170 The template explains how to use the special text environments.
28171 Here are the most important advices:
28174 \begin_layout Itemize
28176 \change_deleted 564990737 1669801478
28177 To be able to compile your document to a PDF, PS, or DVI, ensure that the
28178 no AMS packages are loaded in
28180 Document\SpecialChar menuseparator
28181 Settings\SpecialChar menuseparator
28187 \begin_layout Itemize
28189 \change_deleted 564990737 1669801478
28192 The title environment defines the kind of your paper.
28193 So use one of the following environments for the title:
28197 \begin_layout Itemize
28199 \change_deleted 564990737 1669801478
28208 \begin_layout Itemize
28210 \change_deleted 564990737 1669801478
28219 \begin_layout Itemize
28221 \change_deleted 564990737 1669801478
28227 for a Topical review
28230 \begin_layout Itemize
28232 \change_deleted 564990737 1669801478
28241 \begin_layout Itemize
28243 \change_deleted 564990737 1669801478
28252 \begin_layout Itemize
28254 \change_deleted 564990737 1669801478
28260 for a Paper (same as Title)
28263 \begin_layout Itemize
28265 \change_deleted 564990737 1669801478
28271 for a Preliminary communication
28274 \begin_layout Itemize
28276 \change_deleted 564990737 1669801478
28282 for a Rapid communication
28285 \begin_layout Itemize
28287 \change_deleted 564990737 1669801478
28293 for a Letter to the editor
28297 \begin_layout Itemize
28299 \change_deleted 564990737 1669801478
28302 All title environments except of
28306 can have an optional short title.
28309 \begin_layout Itemize
28311 \change_deleted 564990737 1669801478
28312 There is a general title environment
28316 which is not directly supported by \SpecialChar LyX
28318 This can be used as \SpecialChar TeX
28319 code when your document doesn't fit into one of the
28323 \begin_layout Standard
28325 \change_deleted 564990737 1669801478
28326 For more informations like hints for special table and formula formatting,
28327 look at the IOP author guidelines.
28332 \begin_layout Section
28334 \change_deleted 564990737 1670317155
28338 \begin_layout Standard
28340 \change_deleted 564990737 1670317155
28343 Panayotis Papasotiriou
28346 \begin_layout Subsection
28348 \change_deleted 564990737 1670317155
28352 \begin_layout Standard
28354 \change_deleted 564990737 1670317155
28355 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
28356 that facilitates electronic manuscript submission to the journals they
28358 Most known of them (at least in my domain of interest) are
28360 Astrophysics and Space Science
28366 , but there are many others (see a complete list at
28367 \begin_inset Flex URL
28370 \begin_layout Plain Layout
28372 http://www.wkap.nl/jrnllist.htm/JRNLHOME
28378 The Kluwer package may be downloaded from the site
28379 \begin_inset Flex URL
28382 \begin_layout Plain Layout
28384 http://www.wkap.nl/kaphtml.htm/STYLEFILES
28390 A complete user guide is contained in that package (but it can also be
28391 downloaded separately).
28394 \begin_layout Standard
28396 \change_deleted 564990737 1670317155
28398 supports many features of the package but not everything.
28399 However, the \SpecialChar TeX
28400 code needed is reduced to some
28401 \begin_inset Quotes eld
28405 \begin_inset Quotes erd
28408 commands of the package (see
28409 \begin_inset space ~
28413 \begin_inset CommandInset ref
28415 reference "subsec:kluwer_peculiarities"
28420 I have recently used \SpecialChar LyX
28421 to write an article submitted to the
28423 Astrophysics and Space Science
28425 without any problem.
28428 \begin_layout Subsection
28430 \change_deleted 564990737 1670317155
28434 \begin_layout Standard
28436 \change_deleted 564990737 1670317155
28437 The easiest way to write a paper is to start with the Kluwer template file.
28440 File\SpecialChar menuseparator
28452 This will give an (almost) empty document that includes the most common
28453 fields found in a manuscript and a short description of their use.
28454 As in most templates, simply overwrite the existing text (including the
28459 ) with the correct information.
28462 \begin_layout Subsection
28464 \change_deleted 564990737 1670317155
28465 Preparing a paper for submission
28468 \begin_layout Standard
28470 \change_deleted 564990737 1670317155
28471 As in the AAS\SpecialChar TeX
28472 package, before you submit your paper to a journal you must
28474 \begin_inset Quotes eld
28478 \begin_inset Quotes erd
28484 \begin_layout Enumerate
28486 \change_deleted 564990737 1670317155
28487 Export your paper as a \SpecialChar LaTeX
28489 To do this, click on
28491 File\SpecialChar menuseparator
28492 Export\SpecialChar menuseparator
28500 \begin_layout Enumerate
28502 \change_deleted 564990737 1670317155
28507 file with a text editor and make the following changes
28511 \begin_layout Enumerate
28513 \change_deleted 564990737 1670317155
28514 remove the comment lines before the
28523 \begin_layout Enumerate
28525 \change_deleted 564990737 1670317155
28526 remove everything between (and including) the
28538 commands, except for any commands you specifically put into the \SpecialChar LaTeX
28542 \begin_layout Standard
28544 \change_deleted 564990737 1670317155
28553 \begin_layout Enumerate
28555 \change_deleted 564990737 1670317155
28560 file through \SpecialChar LaTeX
28561 as many times as necessary (usually up to three).
28564 \begin_layout Enumerate
28566 \change_deleted 564990737 1670317155
28572 \begin_inset space \thinspace{}
28576 \begin_inset space \space{}
28583 , and check if everything is OK (it should, if you didn't make any mistake).
28586 \begin_layout Subsection
28588 \change_deleted 564990737 1670317155
28589 \begin_inset Quotes eld
28593 \begin_inset Quotes erd
28596 of the Kluwer package
28597 \begin_inset CommandInset label
28599 name "subsec:kluwer_peculiarities"
28606 \begin_layout Standard
28608 \change_deleted 564990737 1670317155
28609 The Kluwer package has the following
28610 \begin_inset Quotes eld
28614 \begin_inset Quotes erd
28620 \begin_layout Enumerate
28622 \change_deleted 564990737 1670317155
28623 It is possible to write multiple articles in the same \SpecialChar LaTeX
28628 \begin_layout Plain Layout
28629 I can't imagine any good reason to do this.
28635 Each article must be included in the environment
28636 \begin_inset Quotes eld
28640 \begin_inset Quotes erd
28644 Unfortunately, this environment cannot be omitted, even if you write just
28646 Therefore, each article starts with the command
28652 and, obviously, ends with the command
28659 Although this can be implemented in \SpecialChar LyX
28660 , I didn't included it, since it looks
28661 ugly and can confuse the novice user.
28662 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
28665 \begin_inset Quotes eld
28670 \begin_inset Quotes erd
28676 \begin_layout Enumerate
28678 \change_deleted 564990737 1670317155
28679 Information given at the beginning of the article (i.
28680 \begin_inset space \thinspace{}
28684 \begin_inset space \space{}
28687 title, subtitle, author, institution, running title, running author, abstract
28688 and keywords) must be included in an environment called
28689 \begin_inset Quotes eld
28693 \begin_inset Quotes erd
28697 This is not implemented in \SpecialChar LyX
28698 , so you must enter title, subtitle etc.
28699 \begin_inset space ~
28702 between two \SpecialChar TeX
28718 \begin_layout Enumerate
28720 \change_deleted 564990737 1670317155
28721 According to the user manual, the label of each bibliography item must be
28745 \begin_layout Standard
28747 \change_deleted 564990737 1670317155
28752 template takes care of all these
28753 \begin_inset Quotes eld
28757 \begin_inset Quotes erd
28761 If you start a new paper using this template you don't need to do anything
28766 \begin_layout Enumerate
28768 \change_deleted 564990737 1670317155
28769 don't delete the \SpecialChar TeX
28770 code included in the template, and
28773 \begin_layout Enumerate
28775 \change_deleted 564990737 1670317155
28776 copy the example bibliography item included in the template and modify it
28777 as necessary to enter new bibliography items.
28780 \begin_layout Section
28782 \change_deleted 564990737 1671097446
28786 \begin_layout Standard
28788 \change_deleted 564990737 1671097446
28793 provides an alternative to the standard
28798 It provides similar functionality, but you might prefer this layout with
28799 sans serif sections, headings, and more.
28802 \begin_layout Section
28804 \change_deleted 564990737 1671097446
28805 Springer Journals (
28812 \begin_layout Standard
28814 \change_deleted 564990737 1671097446
28820 \begin_layout Subsection
28822 \change_deleted 564990737 1671097446
28826 \begin_layout Standard
28828 \change_deleted 564990737 1671097446
28829 These are the layout files for some of the journal formats used by Springer
28830 Verlag and listed on
28831 \begin_inset Flex URL
28834 \begin_layout Plain Layout
28836 http://www.springer.de/author/tex/help-journals.html
28841 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
28843 It is a modular system: the things common to all journals are implemented
28848 , which journal-specific layout files (such as, e.
28849 \begin_inset space \thinspace{}
28853 \begin_inset space \space{}
28860 for Journal of Geodesy) can include.
28863 \begin_layout Standard
28865 \change_deleted 564990737 1671097446
28866 This means that implementing support for any other Springer journal on this
28867 list is as simple as writing your own
28875 file following the outline given in
28883 \begin_layout Standard
28885 \change_deleted 564990737 1671097446
28886 It is reasonably well tested only for the Journal of Geodesy.
28895 come with the standard \SpecialChar LyX
28897 Install the relevant class file (downloaded from Springer) in a proper
28898 directory, reconfigure \SpecialChar LaTeX
28899 (in the te\SpecialChar TeX
28904 , as root if necessary — doesn't \SpecialChar LyX
28905 take care of this?), reconfigure \SpecialChar LyX
28910 \begin_layout Subsection
28912 \change_deleted 564990737 1671097446
28916 \begin_layout Standard
28918 \change_deleted 564990737 1671097446
28919 A large number of theorem-like styles —
28931 \begin_layout Standard
28933 \change_deleted 564990737 1671097446
28936 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
28937 _Title, Author_Running, Institute,
28938 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
28941 See the Springer class file documentation for details.
28944 \begin_layout Subsection
28946 \change_deleted 564990737 1671097446
28950 \begin_layout Itemize
28952 \change_deleted 564990737 1671097446
28964 \begin_layout Itemize
28966 \change_deleted 564990737 1671097446
28969 Probability Theory and Related Fields
28975 — Jean-Marc Lasgouttes
28978 \begin_layout Standard
28980 \change_deleted 564990737 1671097446
28981 Add your own, it isn't so hard!
28984 \begin_layout Subsection
28986 \change_deleted 564990737 1671097446
28990 \begin_layout Standard
28992 \change_deleted 564990737 1671097446
28993 These files are partly based on the older
28997 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
28999 file from Springer.
29004 layout, are now defunct.
29005 Jean-Marc Lasgouttes helped out big in making me find my way around the
29007 layout file mechanism.
29010 \begin_layout Subsection
29012 \change_deleted 564990737 1671097446
29016 \begin_layout Standard
29018 \change_deleted 564990737 1671097446
29020 But probably less than in the old hacked-\SpecialChar LaTeX
29028 \begin_layout Chapter
29030 Features needing Extra Software
29033 \begin_layout Section
29034 Checking \SpecialChar TeX
29038 \begin_layout Standard
29044 \begin_layout Subsection
29048 \begin_layout Standard
29057 \begin_layout Plain Layout
29062 is not yet available when you are using the \SpecialChar LaTeX
29063 distribution MiK\SpecialChar TeX
29069 , you'll find in the
29076 \begin_inset space ~
29087 \begin_inset Newline newline
29091 \begin_inset CommandInset href
29093 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
29101 \begin_layout Standard
29104 Chk\SpecialChar TeX
29107 package is a program that was written by
29108 \begin_inset Flex Noun
29111 \begin_layout Plain Layout
29113 \begin_inset space ~
29121 in frustration because some constructs in \SpecialChar LaTeX
29122 are sometimes non-intuitive,
29123 and easy to forget.
29124 The program runs over your \SpecialChar LaTeX
29125 file, checks the integrity of the file, and
29126 flags some common errors.
29127 In other technical words, it is
29131 for \SpecialChar LaTeX
29135 \begin_layout Standard
29136 Well, what is a syntax checker doing in \SpecialChar LyX
29137 which is supposed to produce correct
29139 anyways? The answer is simple: Just as
29143 not only checks the
29147 of C programs, but also does
29151 checks for type-errors,
29153 Chk\SpecialChar TeX
29156 catches some common
29160 errors, in addition to the syntactical ones.
29163 Chk\SpecialChar TeX
29166 is capable of detecting several common errors, such as
29169 \begin_layout Itemize
29170 Ellipsis detection:
29171 \begin_inset Newline newline
29174 Use \SpecialChar ldots
29178 \begin_layout Itemize
29179 No space in front of/after parenthesis:
29180 \begin_inset Newline newline
29186 \begin_layout Itemize
29187 Enforcement of normal space after common abbreviations:
29188 \begin_inset Newline newline
29192 \begin_inset space \thinspace{}
29196 \begin_inset space \space{}
29199 is too wide spacing.
29202 \begin_layout Itemize
29203 Enforcement of end-of-sentence space when the last sentence ends with a
29205 \begin_inset Newline newline
29209 And this is wrong spacing.
29212 \begin_layout Itemize
29213 Space in front of labels and similar commands:
29214 \begin_inset Newline newline
29217 The label should stick right up to the text to avoid falling to a wrong
29220 \begin_inset CommandInset label
29230 \begin_layout Plain Layout
29231 This footnote is in danger of falling off to a wrong page
29236 The label is separated too much.
29239 \begin_layout Itemize
29240 Space in front of references, instead of hard spaces:
29241 \begin_inset Newline newline
29244 If you have bad luck, the text will break right between the referenced text
29245 and reference number, and that's a pity.
29247 \begin_inset CommandInset ref
29249 reference "sec:chktex"
29256 \begin_layout Itemize
29258 \begin_inset Quotes eld
29262 \begin_inset Quotes erd
29266 \begin_inset Formula $\times$
29270 \begin_inset Newline newline
29273 2x2 looks cheap compared to
29274 \begin_inset Formula $2\times2$
29280 \begin_layout Standard
29281 and more \SpecialChar ldots
29282 It is an invaluable tool when you are
29283 \begin_inset Quotes eld
29287 \begin_inset Quotes erd
29290 your document before printing, and you should run it right after the obligatory
29291 spelling check, and before you go fine tuning the typesetting.
29294 \begin_layout Subsection
29298 \begin_layout Standard
29299 If you have the program installed, usage is as simple as choosing
29301 Tools\SpecialChar menuseparator
29303 \begin_inset space ~
29309 This will make \SpecialChar LyX
29310 generate a \SpecialChar LaTeX
29311 file of your document, start
29313 Chk\SpecialChar TeX
29316 to check it, and then make \SpecialChar LyX
29318 \begin_inset Quotes eld
29322 \begin_inset Quotes erd
29325 with the warnings from
29327 Chk\SpecialChar TeX
29330 , if there were any.
29331 The warnings will be placed close to the point of the mistake, and you
29332 can quickly find them by using the
29334 Navigate\SpecialChar menuseparator
29337 menu item, or the shortcut key
29346 Open the error boxes by clicking on them with the mouse, or use the shortcut
29355 bindings, or the corresponding
29364 Read the warning and correct the mistake, if it is a mistake.
29365 If you have trouble understanding what the warning is about, you can safely
29367 Remember that there is a hidden layer between the document on screen and
29368 the technical details in invoking
29370 Chk\SpecialChar TeX
29373 , and this gap can make some warnings seem arcane or just plain silly.
29376 \begin_layout Standard
29377 This document is an excellent testing bed for the feature, and it should
29378 provide quite a few warnings for you to fiddle with.
29379 Since computers are only so smart, expect most of the warnings to be false
29383 \begin_layout Subsection
29384 How to fine tune it
29387 \begin_layout Standard
29388 Sometimes, you'll find that
29390 Chk\SpecialChar TeX
29393 makes more noise than suits your mood.
29394 Then you can choose not to use it, wait until your mood changes, or try
29397 Chk\SpecialChar TeX
29400 to get better along with you.
29403 \begin_layout Standard
29406 Chk\SpecialChar TeX
29413 very configurable and extensible, you should not expect to solve all problems
29416 Chk\SpecialChar TeX
29419 in \SpecialChar LyX
29421 Since \SpecialChar LyX
29422 has to generate a somewhat special \SpecialChar LaTeX
29423 file to be able to match the
29424 line numbers from the
29426 Chk\SpecialChar TeX
29433 \begin_layout Plain Layout
29434 You can inspect the specific output from
29440 Document\SpecialChar menuseparator
29443 \begin_inset space ~
29457 to the internal document structure, some of the warnings will not appear
29459 There are two things you can do about this:
29462 \begin_layout Itemize
29465 Chk\SpecialChar TeX
29468 invocation command line in
29469 \begin_inset Flex Noun
29472 \begin_layout Plain Layout
29473 Tools\SpecialChar menuseparator
29474 Preferences\SpecialChar menuseparator
29475 Output\SpecialChar menuseparator
29476 LaTeX\SpecialChar menuseparator
29484 Chk\SpecialChar TeX
29487 installation configuration file (usually with the file
29492 See below to learn what warnings can be enabled and disabled on the command
29496 \begin_layout Itemize
29497 Export your document as a raw \SpecialChar LaTeX
29500 File\SpecialChar menuseparator
29501 Export\SpecialChar menuseparator
29510 Invoked in this way, it can be a hassle to find the corresponding place
29511 in the document inside \SpecialChar LyX
29512 , but with a little patience, you should be able
29516 \begin_layout Standard
29517 Here follows the warning messages that can be enabled and disabled in
29526 to disable a warning, and
29530 to enable a warning.
29531 The emphasized entries are disabled by default, because the default is
29534 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
29539 \begin_layout Standard
29540 Notice that you should only use the options that enable and disable warnings,
29541 because \SpecialChar LyX
29542 relies on some of the other command line parameters to be set
29543 in a specific way to have a chance to communicate with
29550 \begin_layout Enumerate
29554 Command terminated with space.
29557 \begin_layout Enumerate
29560 Non-breaking space (
29561 \begin_inset Quotes eld
29569 \begin_inset Quotes erd
29572 ) should have been used.
29575 \begin_layout Enumerate
29579 You should enclose the previous parenthesis with
29580 \begin_inset Quotes eld
29588 \begin_inset Quotes erd
29594 \begin_layout Enumerate
29597 Italic correction (
29598 \begin_inset Quotes eld
29608 \begin_inset Quotes erd
29611 ) found in non-italic buffer.
29614 \begin_layout Enumerate
29617 Italic correction (
29618 \begin_inset Quotes eld
29628 \begin_inset Quotes erd
29631 ) found more than once.
29634 \begin_layout Enumerate
29638 No italic correction (
29639 \begin_inset Quotes eld
29649 \begin_inset Quotes erd
29655 \begin_layout Enumerate
29659 \begin_inset Quotes eld
29667 \begin_inset Quotes erd
29671 \begin_inset Quotes eld
29679 \begin_inset Quotes erd
29685 \begin_layout Enumerate
29688 Wrong length of dash may have been used.
29691 \begin_layout Enumerate
29695 \begin_inset Quotes eld
29703 \begin_inset Quotes erd
29707 \begin_inset Quotes eld
29715 \begin_inset Quotes erd
29721 \begin_layout Enumerate
29725 \begin_inset Quotes eld
29733 \begin_inset Quotes erd
29739 \begin_layout Enumerate
29743 \begin_inset Quotes eld
29751 \begin_inset Quotes erd
29754 to achieve an ellipsis.
29757 \begin_layout Enumerate
29760 Inter-word spacing (
29761 \begin_inset Quotes eld
29771 \begin_inset Quotes eld
29774 ) should perhaps be used.
29777 \begin_layout Enumerate
29780 Inter-sentence spacing (
29781 \begin_inset Quotes eld
29791 \begin_inset Quotes erd
29794 ) should perhaps be used.
29797 \begin_layout Enumerate
29800 Could not find argument for command.
29803 \begin_layout Enumerate
29807 \begin_inset Quotes eld
29815 \begin_inset Quotes erd
29821 \begin_layout Enumerate
29824 Math mode still on at end of \SpecialChar LaTeX
29828 \begin_layout Enumerate
29832 \begin_inset Quotes eld
29840 \begin_inset Quotes erd
29843 doesn't match the number of
29844 \begin_inset Quotes eld
29852 \begin_inset Quotes erd
29858 \begin_layout Enumerate
29861 You should use either
29864 \begin_inset Quotes eld
29872 \begin_inset Quotes erd
29877 as an alternative to
29878 \begin_inset Quotes eld
29886 \begin_inset Quotes erd
29892 \begin_layout Enumerate
29899 " (ASCII 39) instead of "
29906 \begin_layout Enumerate
29909 User-specified pattern found.
29912 \begin_layout Enumerate
29915 This command might not be intended.
29918 \begin_layout Enumerate
29925 \begin_layout Enumerate
29943 \begin_layout Enumerate
29946 Delete this space to maintain correct page references.
29949 \begin_layout Enumerate
29953 You might wish to put this between a pair of
29954 \begin_inset Quotes eld
29962 \begin_inset Quotes erd
29968 \begin_layout Enumerate
29971 You ought to remove spaces in front of punctuation.
29974 \begin_layout Enumerate
29977 Could not execute \SpecialChar LaTeX
29981 \begin_layout Enumerate
29990 in front of small punctuation.
29993 \begin_layout Enumerate
30001 may look prettier here.
30004 \begin_layout Enumerate
30008 Multiple spaces detected in output.
30011 \begin_layout Enumerate
30014 This text may be ignored.
30017 \begin_layout Enumerate
30023 \begin_inset Quotes eld
30028 to begin quotation, not
30035 \begin_layout Enumerate
30042 to end quotation, not
30045 \begin_inset Quotes eld
30053 \begin_layout Enumerate
30059 \begin_layout Enumerate
30062 You should perhaps use
30063 \begin_inset Quotes eld
30071 \begin_inset Quotes erd
30077 \begin_layout Enumerate
30080 You should put a space in front of/after parenthesis.
30083 \begin_layout Enumerate
30086 You should avoid spaces in front of/after parenthesis.
30089 \begin_layout Enumerate
30093 You should not use punctuation in front of/after quotes.
30096 \begin_layout Enumerate
30099 Double space found.
30102 \begin_layout Enumerate
30105 You should put punctuation outside inner/inside display math mode.
30108 \begin_layout Enumerate
30111 You ought to not use primitive \SpecialChar TeX
30112 in \SpecialChar LaTeX
30116 \begin_layout Enumerate
30119 You should remove spaces in front of
30120 \begin_inset Quotes eld
30128 \begin_inset Quotes erd
30134 \begin_layout Enumerate
30137 \begin_inset Quotes eld
30145 \begin_inset Quotes erd
30148 is normally not followed by
30149 \begin_inset Quotes eld
30157 \begin_inset Quotes erd
30163 \begin_layout Standard
30164 In later versions of \SpecialChar LyX
30165 , we hope to provide a more complete interface to this
30166 tool (and it's smaller cousin
30170 ) to exploit the full power of it.
30171 But it's not exactly useless as it is now: go try it on one of your existing
30172 documents of a certain length and be surprised.
30175 \begin_layout Section
30176 Version Control in \SpecialChar LyX
30180 \begin_layout Standard
30183 Lars Gullik Bjønnes
30190 \begin_layout Subsection
30194 \begin_layout Standard
30196 supports some of the most basic RCS/CVS/SVN/GIT commands.
30197 If you need something a bit more sophisticated you will have to do that
30198 manually in a terminal.
30201 \begin_layout Standard
30202 Also note that CVS support is not as good as subversion support, so we advise
30204 A good place to start learning Subversion is the SVN Book
30208 \begin_layout Plain Layout
30209 \begin_inset CommandInset href
30211 target "http://svnbook.red-bean.com/"
30222 In the case of RCS you should read
30223 \begin_inset Quotes eld
30227 \begin_inset Quotes erd
30230 (a man file, read it with
30235 This file describes all the basic features of RCS.
30236 You should especially notice the comment about a RCS directory, and the
30237 notion of a master RCS file (the file ending in
30244 \begin_layout Standard
30245 Before you begin to use the version control features in \SpecialChar LyX
30247 familiar with RCS/CVS/SVN/GIT usage.
30248 The implementation in \SpecialChar LyX
30249 assumes a recent version of the GNU RCS or CVS/SVN
30250 package — no guarantees are made for older versions.
30251 Most of the log messages are not currently displayed after operations —
30252 you can check them in the Messages pane if you are unsure.
30253 Regular users of version control will appreciate the VC toolbar, which
30256 View\SpecialChar menuseparator
30257 Toolbars\SpecialChar menuseparator
30259 \begin_inset space ~
30267 \begin_layout Standard
30268 For introducing your own external commands consult
30269 \begin_inset Flex Code
30272 \begin_layout Plain Layout
30286 \begin_layout Standard
30287 It is strongly recommended to store documents in uncompressed format if
30288 using version control (uncheck
30290 Document\SpecialChar menuseparator
30293 if it is checked): Uncompressed LyX documents are text files and therefore
30294 for merging two different versions by version control systems.
30295 Compressed LyX documents are binary files, which cannot be merged by version
30299 \begin_layout Subsection
30300 RCS commands in \SpecialChar LyX
30304 \begin_layout Standard
30305 The following sections describe the RCS commands supported by \SpecialChar LyX
30307 You can find them in the
30309 File\SpecialChar menuseparator
30311 \begin_inset space ~
30318 was tested against RCS 5.7/5.8.
30321 \begin_layout Subsubsection
30327 \begin_layout Standard
30328 If your document is not under revision control, this is the only item shown
30330 And if it is under revision control, the
30334 item is not visible.
30338 \begin_layout Standard
30339 This command registers your document with RCS (unless you are under the
30340 directory managed by CVS)\SpecialChar endofsentence
30341 You are asked interactively to supply an initial
30342 description of the document.
30343 The document is now set in Read-Only mode and you have to
30346 \begin_inset space ~
30350 \begin_inset space ~
30354 \begin_inset space ~
30359 , before making any changes to it.
30360 A document under revision control has a
30361 \begin_inset Quotes eld
30364 [RCS:<version> <locker>]
30365 \begin_inset Quotes erd
30368 item tagged to the filename in the minibuffer.
30371 \begin_layout Standard
30372 RCS command that is run:
30375 \begin_layout LyX-Code
30378 ci -q -u -i -t-"<initial description>" <file-name>
30381 \begin_layout Standard
30386 to understand the switches.
30390 \begin_layout Subsubsection
30396 \begin_layout Standard
30397 When you are finished editing a file, you check in your changes.
30398 When you do this, you are asked for a description of the changes.
30399 This is stored in the history log.
30400 The version number is bumped, your changes are applied to the master RCS
30401 file, the document is unlocked and set to Read-Only mode.
30404 \begin_layout Itemize
30407 ci -q -u -m"<description>" <file-name>
30410 \begin_layout Subsubsection
30416 \begin_layout Standard
30417 By doing this you lock the document so that only you can edit it.
30418 This will also make the document Read-Write only for you.
30419 You will usually continue editing for a while and when you are finished
30420 you check in your changes.
30421 The status line is changed to reflect that you have locked the file.
30424 \begin_layout Itemize
30427 co -q -l <file-name>
30430 \begin_layout Subsubsection
30433 Revert To Repository Version
30436 \begin_layout Standard
30437 This will discard all changes made to the document since the last check
30439 You get a warning before changes are discarded.
30442 \begin_layout Itemize
30445 co -f -u<version> <file-name>
30448 \begin_layout Subsubsection
30454 \begin_layout Standard
30455 This will create a copy of the current document.
30456 Since RCS does not support copy operations natively, the version history
30457 is not preserved, and the copy is added as a new file.
30458 It requires a clean document without any changes since the last checkin.
30459 You are asked for a file name and a description of the copy operation.
30460 After that the copy is created, both locally and in the repository.
30461 If the parent directories of the copied and original document differ, all
30462 relative paths of included files of the copy are adjusted (like in
30464 File\SpecialChar menuseparator
30469 Finally, the copy is loaded instead of the original document.
30472 \begin_layout Labeling
30473 \labelwidthstring 00.00.0000
30475 \begin_inset space ~
30479 \begin_inset space ~
30483 \begin_inset Newline newline
30487 \begin_inset Flex Code
30490 \begin_layout Plain Layout
30493 \begin_inset Quotes qld
30497 \begin_inset Quotes qld
30506 \begin_inset Flex Code
30509 \begin_layout Plain Layout
30512 \begin_inset Quotes qld
30516 \begin_inset Quotes qld
30525 \begin_inset Newline newline
30529 \begin_inset Flex Code
30532 \begin_layout Plain Layout
30536 \begin_inset Quotes qld
30540 \begin_inset Quotes qld
30551 \begin_layout Subsubsection
30557 \begin_layout Standard
30558 This makes as if the last check in never happened.
30559 No changes are made to the document loaded into \SpecialChar LyX
30560 , but the last version
30561 is removed from the master RCS file.
30564 \begin_layout Itemize
30567 rcs -o<version> <file-name>
30570 \begin_layout Subsubsection
30576 \begin_layout Standard
30577 This shows the complete history of the RCS document.
30582 is shown in a browser.
30590 \begin_layout Subsubsection
30594 \begin_layout Standard
30596 supports RCS version number, author name, date and time of last commit.
30597 All those are extracted from
30599 rlog -r <file-name>
30603 \begin_inset CommandInset ref
30605 reference "subsec:VCS-Revision-Information"
30612 \begin_layout Subsection
30613 CVS commands in \SpecialChar LyX
30617 \begin_layout Standard
30618 A subset of CVS operations is supported by \SpecialChar LyX
30620 You can find the commands in the
30622 File\SpecialChar menuseparator
30624 \begin_inset space ~
30630 The version control system SVN is more powerful, so please use it instead
30631 of CVS if possible.
30634 \begin_layout Subsubsection
30640 \begin_layout Standard
30641 If you start from scratch with CVS you have to create your repository and
30642 checkout the working copy with external tools.
30643 If you're using a client-server setup you may need to login before doing
30644 the first repository checkout.
30647 \begin_layout Standard
30648 If your documents are under revision control and others are using the same
30649 repository problems arise when different changes to the same document at
30650 the same location happen.
30651 Standard CVS repositories don't operate with a file locking mechanism.
30652 This may be surprising, but conflicts only occur if people disagree on
30653 the proper content of the same part of a document.
30654 So, if co-workers are used to communicate regularly, these conflicts occur
30656 If they don't communicate they have a fundamental problem anyway.
30657 Nevertheless some people like to work with so called
30658 \begin_inset Quotes eld
30662 \begin_inset Quotes erd
30666 If they do so the working copy of all files is readonly when checked out
30667 first and the user starts editing after using a special command to make
30668 the working copy writable.
30669 When the changes are checked in the working copy returns to readonly state.
30670 With \SpecialChar LyX
30671 one has to edit the
30672 \begin_inset Flex Code
30675 \begin_layout Plain Layout
30681 file and add the line
30682 \begin_inset Flex Code
30685 \begin_layout Plain Layout
30691 to work with reserved checkouts.
30692 The benefit is the possibility to see who is using a writable copy of some
30694 It's not guaranteed only one user makes a copy writable.
30697 \begin_layout Standard
30699 tries to guess if you're using reserved or non-reserved checkouts.
30700 If your working copy is readonly or it is writable and an additional copy
30701 of your document exists in the CVS/Base sub-directory a reserved otherwise
30702 a non-reserved checkout is assumed.
30703 When a reserved checkout is detected you have to use
30704 \begin_inset Flex Noun
30707 \begin_layout Plain Layout
30713 to make your working copy writable if it's readonly.
30715 \begin_inset Flex Noun
30718 \begin_layout Plain Layout
30724 operation is possible and that makes your working copy readonly again after
30725 transferring your changes to the repository.
30728 \begin_layout Standard
30729 More information about CVS can be found here
30730 \begin_inset Flex URL
30733 \begin_layout Plain Layout
30735 http://www.nongnu.org/cvs
30741 \begin_inset Flex URL
30744 \begin_layout Plain Layout
30746 http://ximbiot.com/cvs
30754 \begin_layout Standard
30759 to understand the sub-commands and the switches mentioned below.
30762 \begin_layout Subsubsection
30768 \begin_layout Standard
30769 If your document is not under revision control, this is the only item shown
30771 And if it is under revision control, the
30775 item is not visible.
30779 \begin_layout Standard
30780 This command registers in CVS your document
30781 \begin_inset Flex Strong
30784 \begin_layout Plain Layout
30792 in the case you have already the documents directory under CVS control
30798 This means you have to create or checkout the archive by yourself using
30800 (In case you forget that step \SpecialChar LyX
30801 registers the document with RCS.)
30804 \begin_layout Standard
30805 Then you are asked interactively to supply an initial description of the
30807 Don't forget that registered file is not yet checked in.
30810 \begin_layout Standard
30811 CVS command that is run:
30813 cvs -q add -m"<entered message>" "<file-name>"
30816 \begin_layout Standard
30821 above and for all other CVS commands is an abbreviation for
30822 \begin_inset Quotes eld
30825 change the current working directory to file location and use the file name
30826 without path component as argument
30827 \begin_inset Quotes erd
30833 \begin_layout Subsubsection
30839 \begin_layout Standard
30840 When you are finished editing a file, you commit your changes.
30841 When you do this and you had changed the document, you are asked for a
30842 description of the changes.
30843 After that changes are written to the repository.
30844 In case you didn't change the document and a reserved checkout is detected
30845 the reservation made on
30846 \begin_inset Flex Noun
30849 \begin_layout Plain Layout
30858 \begin_layout Labeling
30859 \labelwidthstring 00.00.0000
30861 \begin_inset space ~
30865 \begin_inset space ~
30869 \begin_inset Newline newline
30873 \begin_inset Flex Code
30876 \begin_layout Plain Layout
30879 -q commit -m"<description>" "<file-name>"
30885 \begin_inset Newline newline
30889 \begin_inset Flex Code
30892 \begin_layout Plain Layout
30903 \begin_layout Subsubsection
30909 \begin_layout Standard
30910 When you are sharing a repository with others, you may have to incorporate
30911 their changes into your working copy.
30914 \begin_layout Standard
30917 cvs -q update "<file-name>"
30920 \begin_layout Standard
30921 If a readonly checkout is detected the working copy is made writable and
30925 \begin_layout Standard
30928 cvs -q edit "<file-name>"
30931 \begin_layout Subsubsection
30934 Revert To Repository Version
30937 \begin_layout Standard
30938 This will discard all changes made to the document since the last check
30940 You get a warning before changes are discarded.
30941 Firstly the file is deleted, secondly CVS update command is run.
30944 \begin_layout Standard
30947 cvs -q update "<file-name>"
30950 \begin_layout Standard
30951 If a reserved checkout is detected and the working copy has no changes only
30952 the reservation is undone.
30955 \begin_layout Standard
30958 cvs -q unedit "<file-name>"
30961 \begin_layout Subsubsection
30967 \begin_layout Standard
30968 This will create a copy of the current document.
30969 Since CVS does not support copy operations natively, the version history
30970 is not preserved, and the copy is added as a new file.
30971 It requires a clean document without any changes since the last checkin.
30972 You are asked for a file name and a description of the copy operation.
30973 After that the copy is created, both locally and in the repository.
30974 If the parent directories of the copied and original document differ, all
30975 relative paths of included files of the copy are adjusted (like in
30977 File\SpecialChar menuseparator
30982 Finally, the copy is loaded instead of the original document.
30985 \begin_layout Labeling
30986 \labelwidthstring 00.00.0000
30988 \begin_inset space ~
30992 \begin_inset space ~
30996 \begin_inset Newline newline
31000 \begin_inset Flex Code
31003 \begin_layout Plain Layout
31010 \begin_inset Flex Code
31013 \begin_layout Plain Layout
31020 \begin_inset Newline newline
31024 \begin_inset Flex Code
31027 \begin_layout Plain Layout
31028 cvs -q add "<new-file-name>"
31036 \begin_layout Subsubsection
31042 \begin_layout Standard
31043 This will rename the current document.
31044 Since CVS does not support rename operations natively, the version history
31045 is not preserved, the renamed document is added as a new file, and the
31046 original document is deleted.
31047 It requires a clean document without any changes since the last checkin.
31048 You are asked for a file name and a description of the rename operation.
31049 After that the document is renamed, both locally and in the repository.
31050 If the parent directories of the new and old file names differ, all relative
31051 paths of included files are adjusted (like in
31053 File\SpecialChar menuseparator
31058 Finally, the document is reloaded using the new name.
31061 \begin_layout Labeling
31062 \labelwidthstring 00.00.0000
31064 \begin_inset space ~
31068 \begin_inset space ~
31072 \begin_inset Newline newline
31076 \begin_inset Flex Code
31079 \begin_layout Plain Layout
31086 \begin_inset Flex Code
31089 \begin_layout Plain Layout
31096 \begin_inset Newline newline
31100 \begin_inset Flex Code
31103 \begin_layout Plain Layout
31104 cvs -q add "<new-file-name>"
31110 \begin_inset Newline newline
31114 \begin_inset Flex Code
31117 \begin_layout Plain Layout
31118 cvs -q remove "<file-name>"
31126 \begin_layout Subsubsection
31127 Update of the local directory checkout from repository
31130 \begin_layout Standard
31131 Once your documents gets more complex, containing sub-documents and pictures,
31133 \begin_inset Flex Code
31136 \begin_layout Plain Layout
31142 files and so on using version control becomes more complicated.
31144 supports updating the whole tree in which resides the document.
31145 This become especially useful once you cooperate with people which neither
31146 have detailed knowledge about CVS usage nor they have ambition to commit
31147 additional material to the repository.
31148 You have to organize the files structure so that all external files are
31149 in the same directory or subdirectories of the document.
31150 It's good practice anyway to store multipart documents in an extra directory.
31153 \begin_layout Standard
31155 \begin_inset Flex Code
31158 \begin_layout Plain Layout
31159 Update local directory from repository
31164 command updates the whole directory.
31165 If local changes are detected user is warned before update starts.
31166 In case of merge conflicts both versions of the conflicting document parts
31167 are placed in the final document.
31168 You have to review and correct the result of the merge.
31169 You'll find the conflicts enclosed in pairs of
31170 \begin_inset Flex Code
31173 \begin_layout Plain Layout
31180 \begin_inset Flex Code
31183 \begin_layout Plain Layout
31190 \begin_inset Flex Code
31193 \begin_layout Plain Layout
31200 The first part is your version as before the update operation with the
31201 document name prepended.
31202 The second one is the repository version with the version number after
31204 \begin_inset Flex Code
31207 \begin_layout Plain Layout
31216 \begin_layout Labeling
31217 \labelwidthstring 00.00.0000
31219 \begin_inset space ~
31223 \begin_inset space ~
31227 \begin_inset Newline newline
31231 \begin_inset Flex Code
31234 \begin_layout Plain Layout
31242 (Ask if changes are detected.)
31243 \begin_inset Newline newline
31247 \begin_inset Flex Code
31250 \begin_layout Plain Layout
31251 cd $path; cvs -q update
31261 \begin_layout Standard
31263 \begin_inset Flex Code
31266 \begin_layout Plain Layout
31272 stands for the path to the document.
31275 \begin_layout Subsubsection
31281 \begin_layout Standard
31282 This shows the complete history of the CVS document.
31285 cvs log "<file-name>"
31287 is shown in a browser.
31290 \begin_layout Subsubsection
31294 \begin_layout Standard
31296 supports CVS version number, author name, date and time of last commit.
31297 All those are extracted from
31299 cvs log -r <file-name>
31303 \begin_inset CommandInset ref
31305 reference "subsec:VCS-Revision-Information"
31312 \begin_layout Subsection
31313 SVN commands in \SpecialChar LyX
31317 \begin_layout Standard
31318 SVN is now partially supported by \SpecialChar LyX
31320 You can find the commands in the
31322 File\SpecialChar menuseparator
31324 \begin_inset space ~
31330 Please note that if you use password protected access to repository via
31331 ssh, you will be asked in terminal window.
31333 was tested against SVN 1.5, 1.6, 1.7 and 1.8
31337 \begin_layout Plain Layout
31338 Most of the commands will work with 1.4 too, see
31339 \begin_inset CommandInset ref
31341 reference "subsec:SVN-Repo-Update"
31346 There seems to be currently unresolved permissions problem under SVN 1.8
31347 with reverting changes when file is locked.
31355 \begin_layout Subsubsection
31361 \begin_layout Standard
31362 If your document is not under revision control, this is the only item shown
31364 And if it is under revision control, the
31368 item is not visible.
31371 \begin_layout Standard
31372 This command registers in SVN your document ONLY in case you have already
31373 the documents directory under SVN control (in particular
31378 This means you have to checkout the archive by yourself.
31381 \begin_layout Standard
31382 Then you are asked interactively to supply an initial description of the
31384 Don't forget that registered file is not yet commited.
31387 \begin_layout Standard
31388 SVN command that is run:
31391 \begin_inset Quotes qld
31395 \begin_inset Quotes qld
31401 \begin_layout Standard
31406 to understand the switches.
31409 \begin_layout Subsubsection
31415 \begin_layout Standard
31416 When you are finished editing a file, you commit your changes.
31417 When you do this, you are asked for a description of the changes.
31418 After that changes are commited.
31421 \begin_layout Standard
31426 \begin_layout Plain Layout
31427 In case locking is not enabled.
31429 \begin_inset CommandInset ref
31431 reference "subsec:SVN-File-Locking"
31442 svn commit -q -m"<description>" <file-name>
31445 \begin_layout Subsubsection
31451 \begin_layout Standard
31452 Updates the changes of this file from the repository.
31453 Be sure you understand SVN merging and conflicts resolving before using
31454 this function, because all conflicts has to be resolved manually by you!
31457 \begin_layout Standard
31462 \begin_layout Plain Layout
31470 svn update --non-interactive
31471 \begin_inset Quotes qld
31475 \begin_inset Quotes qld
31481 \begin_layout Subsubsection
31484 Revert To Repository Version
31487 \begin_layout Standard
31488 This will discard all changes made to the document since the last check
31490 You get a warning before changes are discarded.
31493 \begin_layout Standard
31497 \begin_inset Quotes qld
31501 \begin_inset Quotes qld
31507 \begin_layout Subsubsection
31513 \begin_layout Standard
31514 This will create a copy of the current document including the version history.
31515 It requires a clean document without any changes since the last checkin.
31516 You are asked for a file name and a description of the copy operation.
31517 After that the copy is created, both locally and in the repository.
31518 If the parent directories of the copied and original document differ, all
31519 relative paths of included files of the copy are adjusted (like in
31521 File\SpecialChar menuseparator
31526 Finally, the copy is loaded instead of the original document.
31529 \begin_layout Labeling
31530 \labelwidthstring 00.00.0000
31532 \begin_inset space ~
31536 \begin_inset space ~
31540 \begin_inset Newline newline
31544 \begin_inset Flex Code
31547 \begin_layout Plain Layout
31551 \begin_inset Quotes qld
31555 \begin_inset Quotes qld
31559 \begin_inset Quotes qld
31563 \begin_inset Quotes qld
31572 \begin_inset Newline newline
31576 \begin_inset Flex Code
31579 \begin_layout Plain Layout
31588 \begin_layout Subsubsection
31594 \begin_layout Standard
31595 This will rename the current document including the version history.
31596 It requires a clean document without any changes since the last checkin.
31597 You are asked for a file name and a description of the rename operation.
31598 After that the document is renamed, both locally and in the repository.
31599 If the parent directories of the new and old file names differ, all relative
31600 paths of included files are adjusted (like in
31602 File\SpecialChar menuseparator
31607 Finally, the document is reloaded using the new name.
31610 \begin_layout Labeling
31611 \labelwidthstring 00.00.0000
31613 \begin_inset space ~
31617 \begin_inset space ~
31621 \begin_inset Newline newline
31625 \begin_inset Flex Code
31628 \begin_layout Plain Layout
31632 \begin_inset Quotes qld
31636 \begin_inset Quotes qld
31640 \begin_inset Quotes qld
31644 \begin_inset Quotes qld
31653 \begin_inset Newline newline
31657 \begin_inset Flex Code
31660 \begin_layout Plain Layout
31669 \begin_layout Subsubsection
31670 \begin_inset CommandInset label
31672 name "subsec:SVN-Repo-Update"
31676 Update of the local directory checkout from repository
31680 \begin_layout Plain Layout
31681 Note that this command will work only with subversion
31682 \begin_inset Formula $\geqq1.5$
31693 \begin_layout Standard
31694 All the commands above have one shortcoming – they deal with the current
31696 Once your document contains pictures, includes external
31697 \begin_inset Flex Code
31700 \begin_layout Plain Layout
31706 files and so on administration becomes more complicated.
31708 now supports updating the whole tree in which resides the document
31712 \begin_layout Plain Layout
31713 One need to organize the files structure so that all external files are
31714 in the same directory or subdirectories of the document.
31721 This become especially useful once you cooperate with people which neither
31722 know about subversion management nor they have ambition to commit additional
31723 material to the repository.
31727 \begin_layout Standard
31728 \begin_inset Flex Code
31731 \begin_layout Plain Layout
31732 Update local directory from repository
31737 command updates the whole directory and in case of merge conflicts local
31738 version of the files are left, so no unintended data loss occurs.
31739 If local changes are detected user is warned before update starts.
31742 \begin_layout Labeling
31743 \labelwidthstring 00.00.0000
31745 \begin_inset space ~
31749 \begin_inset space ~
31753 \begin_inset Newline newline
31757 \begin_inset Flex Code
31760 \begin_layout Plain Layout
31766 (Ask if changes are detected.)
31767 \begin_inset Newline newline
31771 \begin_inset Flex Code
31774 \begin_layout Plain Layout
31775 svn update --accept mine-full $path
31783 \begin_layout Standard
31785 \begin_inset Flex Code
31788 \begin_layout Plain Layout
31794 stands for the path to the document.
31797 \begin_layout Subsubsection
31803 \begin_layout Standard
31804 This shows the complete history of the SVN document.
31808 \begin_inset Quotes qld
31812 \begin_inset Quotes qld
31817 is shown in a browser.
31820 \begin_layout Subsubsection
31822 \begin_inset CommandInset label
31824 name "subsec:SVN-File-Locking"
31831 \begin_layout Standard
31832 The file exchange through various revision control systems brings the problem
31833 of merge conflicts in case two different users try to edit the same (parts
31835 When such a conflict happens it needs manual resolving and one reasonable
31836 alternative is to provide some kind of locking mechanism, which guarantees
31837 that only one user is allowed to edit file at the given time.
31840 \begin_layout Standard
31841 SVN has two such mechanisms to provide mutual exclusivity for file access
31842 – locks and automatic setting of write permissions (see sec.
31844 \begin_inset CommandInset ref
31846 reference "subsec:Automatical-Locking-Property"
31851 \begin_inset Flex Code
31854 \begin_layout Plain Layout
31864 \begin_layout Plain Layout
31865 \begin_inset Flex URL
31868 \begin_layout Plain Layout
31870 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
31881 If this property is detected for a given document \SpecialChar LyX
31882 starts to use SVN locks
31883 for document editing automatically and the whole check-in/out mechanism
31884 switches to the same regimen as for RCS.
31885 This in particular means there are two different modes of file use in \SpecialChar LyX
31889 \begin_layout Itemize
31891 The loaded file is in the read-only mode.
31892 For editing on needs to check-out.
31897 consists of updating from the repository and gaining write lock.
31898 If the lock is not possible to obtain, we remain in unlocked state.
31901 \begin_layout Itemize
31903 The loaded file is in the
31904 \begin_inset Quotes els
31908 \begin_inset Quotes ers
31912 No other user is allowed to edit the file.
31917 consists of commiting changes and releasing write-lock.
31918 If no changes have been made to the document, no commit will be produced
31922 \begin_layout Plain Layout
31923 Don't be puzzled by the fact that you will be asked for commit message anyway.
31928 and only the write-lock will be released.
31931 \begin_layout Standard
31935 \begin_layout Labeling
31936 \labelwidthstring 00.00.0000
31939 svn commit -q -m"<description>" "<file-name>"
31940 \begin_inset Newline newline
31943 svn unlock "<file-name>"
31946 \begin_layout Labeling
31947 \labelwidthstring 00.00.0000
31950 svn update "<file-name>"
31951 \begin_inset Newline newline
31954 svn lock "<file-name>"
31957 \begin_layout Subsubsection
31960 \begin_inset CommandInset label
31962 name "subsec:Automatical-Locking-Property"
31968 Automatic Locking Property
31971 \begin_layout Standard
31972 The above mentioned automatic setting of write permissions of the .lyx file
31975 File\SpecialChar menuseparator
31977 \begin_inset space ~
31980 Control\SpecialChar menuseparator
31981 Use Locking Property
31984 This command is active only when the file is not locked on the svn server
31986 you need to check-out before proceeding).
31989 \begin_layout Labeling
31990 \labelwidthstring 00.00.0000
31992 \begin_inset space ~
31998 \begin_layout Labeling
31999 \labelwidthstring 00.00.0000
32002 svn propset svn:needs-lock ON "<file-name>"
32005 \begin_layout Labeling
32006 \labelwidthstring 00.00.0000
32009 svn propdel svn:needs-lock "<file-name>"
32012 \begin_layout Subsubsection
32013 \begin_inset CommandInset label
32015 name "subsec:VCS-Revision-Information"
32019 Revision Information in Documents
32022 \begin_layout Standard
32023 There are more possibilities how to activate revision information in our
32027 \begin_layout Itemize
32033 \begin_layout Itemize
32034 tree revision information (
32035 \begin_inset Flex Code
32038 \begin_layout Plain Layout
32045 The result is the output of the
32046 \begin_inset Flex Code
32049 \begin_layout Plain Layout
32055 command, the following table gives you an idea, how to read the results.
32058 \begin_layout Standard
32060 \begin_inset Tabular
32061 <lyxtabular version="3" rows="6" columns="2">
32062 <features tabularvalignment="middle">
32063 <column alignment="left" valignment="top">
32064 <column alignment="left" valignment="top">
32066 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
32069 \begin_layout Plain Layout
32077 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
32080 \begin_layout Plain Layout
32090 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
32093 \begin_layout Plain Layout
32099 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
32102 \begin_layout Plain Layout
32103 mixed revision working copy
32110 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
32113 \begin_layout Plain Layout
32119 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
32122 \begin_layout Plain Layout
32123 modified working copy
32130 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
32133 \begin_layout Plain Layout
32139 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
32142 \begin_layout Plain Layout
32143 switched working copy
32150 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
32153 \begin_layout Plain Layout
32159 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
32162 \begin_layout Plain Layout
32163 partial working copy, from a sparse checkout
32170 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
32173 \begin_layout Plain Layout
32179 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
32182 \begin_layout Plain Layout
32183 mixed revision, modified, switched working copy
32196 \begin_layout Itemize
32197 file revision information.
32198 The result comes from parsing the output of
32199 \begin_inset Flex Code
32202 \begin_layout Plain Layout
32204 \begin_inset space ~
32208 \begin_inset space ~
32212 \begin_inset space ~
32221 Supported flags are:
32225 \begin_layout Itemize
32226 version number of the last commit (
32227 \begin_inset Flex Code
32230 \begin_layout Plain Layout
32239 \begin_layout Itemize
32240 author of the last commit (
32241 \begin_inset Flex Code
32244 \begin_layout Plain Layout
32253 \begin_layout Itemize
32254 date of the last commit (
32255 \begin_inset Flex Code
32258 \begin_layout Plain Layout
32267 \begin_layout Itemize
32268 time of the last commit (
32269 \begin_inset Flex Code
32272 \begin_layout Plain Layout
32282 \begin_layout Standard
32283 You can obtain this info via InsetInfo (
32284 \change_inserted 5863208 1564400022
32287 Insert\SpecialChar menuseparator
32288 Field\SpecialChar menuseparator
32289 Version Control Revision
32290 \change_deleted 5863208 1564399852
32295 \begin_inset Flex Code
32298 \begin_layout Plain Layout
32299 info-insert buffer vcs-date
32307 The information will be available only when you have the file stored under
32308 svn managment (i.e.
32310 \begin_inset Flex Code
32313 \begin_layout Plain Layout
32319 directory is available with your document).
32323 \begin_layout Itemize
32324 Another—a hacking one—possibility is to use svn keywords
32328 \begin_layout Plain Layout
32329 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
32335 In short – you set file keywords property (e.g.
32338 svn propset svn:keywords 'Rev' file.lyx
32340 ) and then paste keyword \SpecialChar TeX
32345 \begin_layout Plain Layout
32346 This is an easy way how to ensure that \SpecialChar LyX
32347 won't break the line in the middle
32353 tag in your document (e.g.
32355 \begin_inset Flex Code
32358 \begin_layout Plain Layout
32365 This way svn client will automatically substitute revision number (e.g.
32367 \begin_inset Flex Code
32370 \begin_layout Plain Layout
32376 ) after each update and commit.
32377 There are more problems with this approach.
32378 Firstly, the '$' character is used in \SpecialChar TeX
32379 world for math equations, so any
32380 occurence of math formula
32381 \begin_inset Formula $Rev$
32385 \begin_inset Formula $Rev:59$
32388 in your \SpecialChar LyX
32390 Similarly for other keywords like Id, Date, Author, etc.
32391 Secondly svn output is dependent on your locales, so its very easy that
32392 svn would produce some problematic strings once Date is used.
32393 Thirdly you get the whole 'Rev: 59' string in your document instead of
32395 Until subversion implements user's custom keywords it will be hard to use
32396 this approach reliably or let \SpecialChar LyX
32397 to support it directly.
32400 \begin_layout Subsection
32401 SVN and Windows Environment
32404 \begin_layout Quote
32405 My inclination is to say that if the user cannot figure out the command
32406 line operations on their own fairly quickly, they would be well advised
32407 to use TortoiseSVN.
32413 \begin_layout Subsubsection
32417 \begin_layout Standard
32418 In addition to installing \SpecialChar LyX
32419 , and having access to a Subversion repository,
32420 the user will need to install the Subversion client program.
32421 A Windows installer for the client program is available from
32422 \begin_inset CommandInset href
32425 target "http://www.collab.net/nonav/downloads/subversion/"
32431 The user may also want to install
32432 \begin_inset CommandInset href
32435 target "http://tortoisesvn.tigris.org/"
32440 , which integrates Subversion operations into the context (rightclick) menu
32441 of Windows Explorer.
32442 Operations done outside \SpecialChar LyX
32443 will typically be more convenient using the Explorer
32445 Note that TortoiseSVN is not a replacement for the client program, which
32446 is what \SpecialChar LyX
32450 \begin_layout Subsubsection
32451 Bringing a document under Subversion control
32454 \begin_layout Standard
32455 Before a \SpecialChar LyX
32456 document can be brought under version control in Subversion, its
32457 parent directory needs to be under version control.
32458 If the document is being added to a project already in the repository,
32459 this is accomplished by checking the project out to the directory where
32460 the new document will be placed.
32461 If the project itself is not yet under version control (for instance, if
32462 this document starts a new project), the directory must be imported into
32464 This is done outside \SpecialChar LyX
32466 Both import and checkout are easily accomplished from the Explorer context
32467 menu using TortoiseSVN, or alternatively can be done using the command
32468 line client at a DOS prompt.
32469 The procedure for importing the project using TortoiseSVN is described
32470 below, assuming an existing repository and a new project being started
32478 For information on using the Subversion client program, run
32485 \begin_layout Enumerate
32492 in Windows Explorer, right click it, and select
32494 TortoiseSVN\SpecialChar menuseparator
32498 If necessary, adjust the URL for the repository, then click OK.
32501 \begin_layout Enumerate
32502 Right click the level of the repository under which you want to place the
32503 new project folder (typically the top level) and click
32507 Supply a name for the project folder and click OK.
32508 Add a message for the log file if desired, then click OK again.
32509 The new project folder should appear in the repository.
32510 Finally, click OK again to exit the repository browser.
32513 \begin_layout Enumerate
32514 Once again right click
32520 , this time selecting SVN Checkout\SpecialChar ldots
32521 Select the URL of the project folder
32522 you just created in the repository, and set the checkout directory to
32530 You will be warned about a non-empty folder; click OK to proceed.
32531 You should now have a
32542 \begin_layout Enumerate
32543 Create or open your document in \SpecialChar LyX
32546 File\SpecialChar menuseparator
32548 \begin_inset space ~
32551 Control\SpecialChar menuseparator
32555 Add a log message and click OK to commit the document to version control.
32558 \begin_layout Standard
32559 From this point onward, you should have full functionality in the
32561 File\SpecialChar menuseparator
32563 \begin_inset space ~
32569 You also have the option of checking the document in and out, viewing its
32571 using the TortoiseSVN context menu in Windows Explorer or the Subversion
32572 client program from a command prompt.
32575 \begin_layout Subsubsection
32576 SSH tunnel used with SVN under Windows
32579 \begin_layout Standard
32580 Compared with Linux setting up an svn client to communicate over ssh under
32581 Windows is a rather troublesome task.
32582 We will at least offer some hints how to setup the client side but prior
32583 knowledge about ssh and the Windows command line is needed, also be prepared
32584 for a great deal of frustration\SpecialChar ldots
32588 \begin_layout Enumerate
32589 Get an svn client for windows, as described in the previous sections.
32590 When it is a fresh install run some svn command (e.g.
32592 \begin_inset Flex Code
32595 \begin_layout Plain Layout
32601 ) to create config files, which you will need to change later on.
32604 \begin_layout Enumerate
32605 Choose an ssh client for Windows.
32606 There are several possibilities, we will use the one from Putty tools
32610 \begin_layout Plain Layout
32611 \begin_inset Flex URL
32614 \begin_layout Plain Layout
32616 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
32627 You will need to set the connection up so that the client doesn't ask for
32628 any password from you.
32629 To keep things easy we will use only keys without any additional password
32634 \begin_layout Enumerate
32636 \begin_inset Flex Code
32639 \begin_layout Plain Layout
32646 Save your private .ppk key file and put the public one on the server side.
32647 If the SVN server runs on Linux, note that the format of the public key
32648 is not compatible with Linux openssh and you will need to direcly copy-paste
32650 \begin_inset Quotes eld
32655 Public key for pasting into OpenSSH authorized_keys file
32658 \begin_inset Quotes erd
32661 edit field into the server's
32662 \begin_inset Flex Code
32665 \begin_layout Plain Layout
32666 ~/.ssh/authorized_keys
32672 \begin_inset Flex Code
32675 \begin_layout Plain Layout
32684 \begin_layout Enumerate
32686 \begin_inset Flex Code
32689 \begin_layout Plain Layout
32696 In the SVN config file
32700 \begin_layout Plain Layout
32701 Exact path depends on Windows version, usually somewhere around
32702 \begin_inset Flex Code
32705 \begin_layout Plain Layout
32708 Documents and Settings
32722 \begin_inset Flex Code
32725 \begin_layout Plain Layout
32740 , section [tunnels], setup ssh command, e.g.
32742 \begin_inset Flex Code
32745 \begin_layout Plain Layout
32746 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
32755 \begin_layout Plain Layout
32756 It will usually take a lot of time to get exact command right and it depends
32758 For example do not have some remote server saved as a default session in
32760 If things fail, try to connect via plink without SVN first.
32769 \begin_layout Enumerate
32770 Checkout the SVN archive, e.
32771 \begin_inset space \thinspace{}
32775 \begin_inset Newline newline
32779 \begin_inset Flex Code
32782 \begin_layout Plain Layout
32783 svn co svn+ssh://user@server/repository_path
32791 \begin_layout Subsubsection
32792 End-of-Line Conversions
32795 \begin_layout Standard
32796 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
32798 use different line endings inside the .lyx files.
32799 This is not a problem as far as \SpecialChar LyX
32800 functionality is concerned, but the commit
32801 diffs will be huge and merge-conflicts prone.
32802 Fortunately SVN itself knows
32806 \begin_layout Plain Layout
32807 \begin_inset Flex URL
32810 \begin_layout Plain Layout
32812 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
32822 how to deal with CR/LF problems when switching .lyx files to the
32823 \begin_inset Flex Code
32826 \begin_layout Plain Layout
32836 \begin_layout Plain Layout
32838 \begin_inset Flex Code
32841 \begin_layout Plain Layout
32842 svn propset svn:eol-style native FILE_NAME
32855 \begin_layout Subsection
32856 GIT commands in \SpecialChar LyX
32860 \begin_layout Standard
32861 A minimal subset of GIT commands is now supported by \SpecialChar LyX
32863 You can find the commands in the
32865 File\SpecialChar menuseparator
32867 \begin_inset space ~
32873 Please note that if you use password protected access to repository via
32874 ssh, you will be asked in terminal window.
32876 was tested against GIT 1.7.
32880 \begin_layout Plain Layout
32881 Windows users please note that you need to ensure that git is on the path.
32882 This can be set from within \SpecialChar LyX
32885 Tools\SpecialChar menuseparator
32886 Preferences\SpecialChar menuseparator
32887 Paths\SpecialChar menuseparator
32898 \begin_layout Standard
32899 One big difference of GIT and the other supported version control systems
32900 is the distributed nature of GIT: With traditional version control systems
32901 there is one central server which hosts the repository.
32902 Users commit their changes to the server, and get updates made by other
32904 With GIT, users commit to a local repository.
32905 The local repository can be synchronized with one or more remote repositories
32907 \begin_inset Flex Code
32910 \begin_layout Plain Layout
32917 \begin_inset Flex Code
32920 \begin_layout Plain Layout
32928 does not interact in any way with remote GIT repositories.
32929 It works exclusively with the local repository in a very similar way as
32930 with a central CVS or SVN repository.
32931 If you use remote GIT repositories you need to do the
32932 \begin_inset Flex Code
32935 \begin_layout Plain Layout
32942 \begin_inset Flex Code
32945 \begin_layout Plain Layout
32951 operations with your favourite GIT client.
32954 \begin_layout Subsubsection
32960 \begin_layout Standard
32961 If your document is not under revision control, this is the only item shown
32963 And if it is under revision control, the
32967 item is not visible.
32970 \begin_layout Standard
32971 This command registers in GIT your document ONLY in case you have already
32972 the documents directory under GIT control (in particular
32977 This means you have to checkout the archive by yourself.
32980 \begin_layout Standard
32981 Then you are asked interactively to supply an initial description of the
32983 Don't forget that registered file is not yet committed.
32986 \begin_layout Standard
32987 GIT command that is run:
32990 \begin_inset Quotes qld
32994 \begin_inset Quotes qld
33000 \begin_layout Standard
33005 to understand the switches.
33008 \begin_layout Subsubsection
33014 \begin_layout Standard
33015 When you are finished editing a file, you commit your changes.
33016 When you do this, you are asked for a description of the changes.
33017 After that changes are committed.
33020 \begin_layout Standard
33023 git commit -q -m"<description>" <file-name>
33026 \begin_layout Subsubsection
33029 Revert To Repository Version
33032 \begin_layout Standard
33033 This will discard all changes made to the document since the last check
33035 You get a warning before changes are discarded.
33038 \begin_layout Standard
33042 \begin_inset Quotes qld
33046 \begin_inset Quotes qld
33052 \begin_layout Subsubsection
33058 \begin_layout Standard
33059 This will rename the current document including the version history.
33060 It requires a clean document without any changes since the last checkin.
33061 You are asked for a file name and a description of the rename operation.
33062 After that the document is renamed, both locally and in the repository.
33063 If the parent directories of the new and old file names differ, all relative
33064 paths of included files are adjusted (like in
33066 File\SpecialChar menuseparator
33071 Finally, the document is reloaded using the new name.
33074 \begin_layout Labeling
33075 \labelwidthstring 00.00.0000
33077 \begin_inset space ~
33081 \begin_inset space ~
33085 \begin_inset Newline newline
33089 \begin_inset Flex Code
33092 \begin_layout Plain Layout
33096 \begin_inset Quotes qld
33100 \begin_inset Quotes qld
33104 \begin_inset Quotes qld
33108 \begin_inset Quotes qld
33117 \begin_inset Newline newline
33121 \begin_inset Flex Code
33124 \begin_layout Plain Layout
33133 \begin_layout Subsubsection
33139 \begin_layout Standard
33140 This shows the complete history of the GIT document.
33144 \begin_inset Quotes qld
33148 \begin_inset Quotes qld
33153 is shown in a browser.
33156 \begin_layout Subsubsection
33160 \begin_layout Standard
33162 supports GIT hash number of the last commit to the file,
33163 \change_inserted 1119979965 1564297456
33164 its abbreviated form,
33166 author name, date and time of last commit.
33167 All those are extracted from
33169 git log -n 1 --pretty=format:%H%n
33170 \change_inserted 1119979965 1564297427
33176 Tree version information is obtained via
33178 git describe --abbrev --dirty --long
33182 \begin_inset CommandInset ref
33184 reference "subsec:VCS-Revision-Information"
33191 \begin_layout Subsection
33195 \begin_layout Standard
33196 With the recent addition of the
33197 \begin_inset Flex Code
33200 \begin_layout Plain Layout
33206 function \SpecialChar LyX
33207 power users are allowed to create their own commands for revision
33211 \begin_layout Standard
33212 As an example you can see how two TortoiseSVN commands could be integrated
33216 \begin_layout Description
33218 \begin_inset Flex Code
33221 \begin_layout Plain Layout
33222 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
33230 \begin_layout Description
33232 \begin_inset Flex Code
33235 \begin_layout Plain Layout
33236 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
33244 \begin_layout Subsection
33245 Version control and Document comparison
33248 \begin_layout Standard
33249 One of the typical uses of version control is to inspect the changes between
33250 revisions, usually by creating
33251 \begin_inset Flex Code
33254 \begin_layout Plain Layout
33261 While this is useful for plain text files, it is much less useful in the
33262 case of \SpecialChar LyX
33263 files, which have more a complicated structure.
33264 Hence we provide binding to the Document comparison feature.
33265 There are two ways of calling this feature – either by direct call of
33266 \begin_inset Flex Code
33269 \begin_layout Plain Layout
33276 function (for details see \SpecialChar LyX
33277 functions manual) or by the toolbar icon
33290 One can either compare two chosen revisions of the document or he can simply
33291 compare the current version of edited text with older revisions (where
33293 \begin_inset Flex Noun
33296 \begin_layout Plain Layout
33302 ' revisions back means comparison of the edited file with last commited
33307 \begin_layout Standard
33308 This feature is supported for SVN and RCS though due to the more complicated
33309 versioning scheme of RCS there is a constraint – when addressing the revisions
33310 in dialog, numbers always point to the last number in RCS revision number,
33313 We don't currently support GIT addressing of revisions, one can just compare
33314 edited document with its revision X steps backs, where X is addressed as
33316 \begin_inset Flex Code
33319 \begin_layout Plain Layout
33328 \begin_layout Section
33330 \change_inserted 564990737 1672161575
33331 \begin_inset CommandInset label
33333 name "sec:Literate-Programming"
33339 Literate Programming
33342 \begin_layout Standard
33347 (kayvan@sylvan.com)
33351 original documentation written by
33353 Edmar Wienskoski Jr.
33356 (edmar-w-jr@technologist.com)
33359 \begin_layout Subsection
33363 \begin_layout Standard
33364 The main purpose of this documentation is to show you how to use \SpecialChar LyX
33366 programming, where it is assumed that you are familiar with this programming
33367 technique, and know what
33368 \begin_inset Quotes eld
33372 \begin_inset Quotes erd
33376 \begin_inset Quotes eld
33380 \begin_inset Quotes erd
33384 If that is not the case, please follow the web links provided in the following
33386 There is a lot of good documentation out there covering old development
33387 history to the latest tools tips.
33390 \begin_layout Standard
33391 It is also assumed that you are familiar with \SpecialChar LyX
33392 itself to a point that you
33393 are comfortable changing your \SpecialChar LyX
33394 preferences, and X resources file.
33395 If that is not the case please refer to other \SpecialChar LyX
33396 documentation to cover your
33400 \begin_layout Subsection
33401 Literate Programming
33404 \begin_layout Standard
33405 From the Literate Programming FAQ:
33408 \begin_layout Quotation
33409 Literate programming is the combination of documentation and source together
33410 in a fashion suited for reading by human beings.
33411 In fact, literate programs should be enjoyable reading, even inviting!
33412 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
33413 and documentation in a single file.
33414 Literate programming tools then parse the file to produce either readable
33415 documentation or compilable source.
33416 The WEB style of literate programming was created by D.
33417 \begin_inset space \thinspace{}
33421 Knuth during the development of his \SpecialChar TeX
33422 typesetting software.
33426 \begin_layout Standard
33427 Another excerpt says:
33430 \begin_layout Quotation
33433 How is literate programming different from verbose commenting?
33436 \begin_layout Quotation
33437 There are three distinguishing characteristics.
33438 In order of importance, they are:
33442 \begin_layout Itemize
33443 flexible order of elaboration
33446 \begin_layout Itemize
33447 automatic support for browsing
33450 \begin_layout Itemize
33451 typeset documentation, especially diagrams and mathematics
33455 \begin_layout Standard
33456 Now that I sparked your curiosity, take a look in the references.
33459 \begin_layout Subsubsection
33463 \begin_layout Standard
33464 The complete Literate Programming FAQ can be found at:
33467 \begin_layout Quote
33468 Literate Programming FAQ
33469 \begin_inset Flex URL
33472 \begin_layout Plain Layout
33474 http://www.literateprogramming.com/lpfaq.pdf
33482 \begin_layout Standard
33483 The FAQ lists 23 (twenty three!) different literate programming tools.
33484 Where some are specialized or
33485 \begin_inset Quotes eld
33489 \begin_inset Quotes erd
33492 for particular programming languages, while other have general scope.
33497 for my own use for several reasons:
33500 \begin_layout Itemize
33501 It can generate the documentation either in \SpecialChar LaTeX
33505 \begin_layout Itemize
33506 It has a open architecture, i.
33507 \begin_inset space \thinspace{}
33511 \begin_inset space \space{}
33514 it is easy to plug in new filters
33518 \begin_layout Plain Layout
33523 are programs that read a given data stream and output a manipulated data
33525 That way, a WEB file (consisting of literate code) can be turned into a
33526 file consisting only of C program code or \SpecialChar LaTeX
33532 and to perform special processing that you may need.
33536 \begin_layout Itemize
33537 There is a good selection of filters available already (the HTML is one
33541 \begin_layout Itemize
33545 \begin_layout Standard
33546 The Noweb web page can be found at:
33549 \begin_layout Quote
33551 \begin_inset Flex URL
33554 \begin_layout Plain Layout
33556 https://www.cs.tufts.edu/~nr/noweb/
33564 \begin_layout Standard
33565 Starting from there you can reach many other interesting links and even
33566 some literate program examples.
33569 \begin_layout Subsection
33571 and Literate Programming with Noweb
33574 \begin_layout Standard
33575 The \SpecialChar LyX
33576 support for Literate Programming is provided by using the generic \SpecialChar LyX
33578 converters mechanism.
33579 This support is provided in a
33580 \begin_inset Quotes eld
33584 \begin_inset Quotes erd
33588 \begin_inset space \thinspace{}
33592 \begin_inset space \space{}
33595 you will be able to use this new \SpecialChar LyX
33596 feature with some other literate programming
33597 tool of your choice by just changing your \SpecialChar LyX
33601 \begin_layout Subsubsection
33602 Generating documents and code (weaving and tangling)
33605 \begin_layout Paragraph
33606 Using the noweb module
33609 \begin_layout Standard
33610 If you have installed Noweb and \SpecialChar LyX
33611 successfully, whenever you open a new document,
33612 after you have chosen its document class, use the
33614 Document\SpecialChar menuseparator
33618 \begin_inset Quotes eld
33622 \begin_inset Quotes erd
33626 If Noweb is correctly installed, when you click on the
33627 \begin_inset Quotes eld
33631 \begin_inset Quotes erd
33634 link, you will see the
33635 \begin_inset Quotes eld
33639 \begin_inset Quotes erd
33642 module in the available list and you can add it to your document.
33645 \begin_layout Paragraph
33649 \begin_layout Standard
33651 enables you to write code with a custom inset named
33652 \begin_inset Flex Noun
33655 \begin_layout Plain Layout
33662 Noweb delimits chunks like this:
33665 \begin_layout LyX-Code
33669 \begin_layout LyX-Code
33673 \begin_layout LyX-Code
33677 \begin_layout LyX-Code
33681 \begin_layout LyX-Code
33685 \begin_layout Standard
33686 The problem is that whatever is written in between the << and the
33690 must be taken literally, i.
33691 \begin_inset space \thinspace{}
33695 \begin_inset space \space{}
33699 should be prevented from making any special interpretation of what has
33701 This is also handled by
33702 \begin_inset Flex Noun
33705 \begin_layout Plain Layout
33711 , that works like a normal text inset but has a free spacing capability.
33714 \begin_layout Standard
33715 As a special note, you can also use the
33716 \begin_inset Quotes eld
33720 \begin_inset Quotes erd
33723 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
33727 \begin_layout LyX-Code
33731 \begin_layout LyX-Code
33732 def some_function(args):
33735 \begin_layout LyX-Code
33736 "This is the doc string for this function."
33739 \begin_layout LyX-Code
33740 print "My args: ", args
33743 \begin_layout LyX-Code
33744 @ %def some_function
33747 \begin_layout Standard
33748 For an example of this usage and the resulting cross-reference output, look
33749 at the Literate python program in
33751 LIBDIR/examples/listerrors.lyx
33753 which should make this all clear.
33756 \begin_layout Paragraph
33757 Generating the documentation
33760 \begin_layout Standard
33761 At this point you already have a new document file with a proper document
33762 class, and with some code and text on it.
33763 How do I print it? The answer is simple, you select
33765 View\SpecialChar menuseparator
33769 Just like you would do for a plain document.
33770 No special procedure is required.
33773 \begin_layout Standard
33774 To help orientate you, I will now explain what happens inside \SpecialChar LyX
33778 \begin_layout Enumerate
33781 Update\SpecialChar menuseparator
33784 menu option is chosen, a \SpecialChar LaTeX
33790 \begin_layout Standard
33791 If the document is of any literate class the generated file will be named
33792 with an extension name defined by the
33793 \begin_inset Quotes eld
33797 \begin_inset Quotes erd
33800 format (defined in the Preferences panel), otherwise the file will have
33809 \begin_layout Enumerate
33810 Note that the only difference so far is in the name of the file, no special
33811 processing is required by \SpecialChar LyX
33813 Given that you formatted the code using the
33814 \begin_inset Flex Noun
33817 \begin_layout Plain Layout
33823 inset that, by itself, takes care of the business.
33826 \begin_layout Enumerate
33827 If the document is of any literate class \SpecialChar LyX
33828 will then use the internal \SpecialChar LyX
33830 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
33835 \begin_layout Plain Layout
33836 The converters are defined in the
33838 Tools\SpecialChar menuseparator
33842 \begin_inset Quotes eld
33846 \begin_inset Quotes erd
33858 manual for general information about converters.
33863 to generate the \SpecialChar LaTeX
33868 \begin_layout Standard
33869 Otherwise it will just skip this step.
33873 \begin_layout Enumerate
33874 Finally, \SpecialChar LaTeX
33875 is invoked and the regular post processing continues as in a plain
33879 \begin_layout Standard
33880 Independence from a particular
33881 \begin_inset Quotes eld
33885 \begin_inset Quotes erd
33888 is easily achieved by changing the commands that are run by the various
33892 \begin_layout Paragraph
33893 Generating the code
33896 \begin_layout Standard
33897 When the build menu option is chosen or the corresponding button in the
33898 toolbar is pressed, a \SpecialChar LaTeX
33899 file is generated just like step 1 above.
33900 Next, \SpecialChar LyX
33906 This converter needs to be defined by the user and is not installed by
33907 default, though the Program format is.
33908 This converter (like any other converter) will have two parts:
33911 \begin_layout Enumerate
33912 The converter program itself.
33913 This program performs the conversion from the one format to the other (in
33914 this case, from the Noweb format to the Program pseudo-format).
33917 \begin_layout Enumerate
33918 The error log parser.
33919 This is a program whose sole purpose is to rewrite error messages in a
33920 format that \SpecialChar LyX
33922 This makes it possible for \SpecialChar LyX
33923 to place error boxes in the right places in
33927 \begin_layout Standard
33928 The first part, the
33929 \begin_inset Quotes eld
33933 \begin_inset Quotes erd
33936 setting, should be set to
33939 \begin_layout LyX-Code
33947 \begin_layout Standard
33948 This basically means that \SpecialChar LyX
33950 \begin_inset Quotes eld
33954 \begin_inset Quotes erd
33957 (a program or script) with the name of the Noweb file (normally a file
33958 in the \SpecialChar LyX
33959 temp directory) and the directory path of the original \SpecialChar LyX
33964 \begin_layout Standard
33965 This is an implementation of
33966 \begin_inset Quotes eld
33970 \begin_inset Quotes erd
33973 that you can place in a directory on your path:
33976 \begin_layout LyX-Code
33982 \begin_layout LyX-Code
33988 \begin_layout LyX-Code
33991 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
33994 \begin_layout Standard
33995 The next part of the converter setting is the
33996 \begin_inset Quotes eld
34000 \begin_inset Quotes erd
34003 which is to be set to
34006 \begin_layout LyX-Code
34009 parselog=$$s/scripts/listerrors
34012 \begin_layout Standard
34013 This will run any errors that are generated by the
34014 \begin_inset Quotes eld
34018 \begin_inset Quotes erd
34021 process through the
34022 \begin_inset Quotes eld
34026 \begin_inset Quotes erd
34032 \begin_layout Standard
34033 The build will normally take place in \SpecialChar LyX
34034 's temporary directory, so the files
34035 produced by the conversion will be in that directory.
34037 will copy out what it regards as the `main' file, but the
34041 conversion may produce several files, and so most of these would then be
34042 deleted when \SpecialChar LyX
34044 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
34045 the build-script chunk can place the generated files in that location.
34048 \begin_layout Paragraph
34049 Build instructions in the document
34052 \begin_layout Standard
34053 The last piece of the integration between \SpecialChar LyX
34055 \begin_inset Quotes eld
34059 \begin_inset Quotes erd
34063 Generally, the instructions for building your program should be embedded
34064 in a chunk of its own.
34066 \begin_inset Quotes eld
34070 \begin_inset Quotes erd
34073 above uses the notangle command to look for this chunk (called
34074 \begin_inset Quotes eld
34078 \begin_inset Quotes erd
34081 ) and runs its contents through
34082 \begin_inset Quotes eld
34086 \begin_inset Quotes erd
34092 \begin_layout Standard
34093 Typically, such a chunk would look something like this:
34096 \begin_layout LyX-Code
34100 \begin_layout LyX-Code
34102 \begin_inset Newline newline
34105 if [ -z "${NOWEB_SOURCE}" ]
34106 \begin_inset Newline newline
34112 \begin_layout LyX-Code
34113 NOWEB_SOURCE=myfile.nw
34114 \begin_inset Newline newline
34118 \begin_inset Newline newline
34122 code to extract files ...
34123 use NOWEB_OUTPUT_DIR here ...]
34124 \begin_inset Newline newline
34128 code to compile files ...]
34129 \begin_inset Newline newline
34135 \begin_layout Standard
34137 \change_deleted 564990737 1672161716
34140 LIBDIR/examples/listerrors.lyx
34144 LIBDIR/examples/Literate.lyx
34145 \change_inserted 564990737 1672161716
34150 File\SpecialChar menuseparator
34151 Open Example\SpecialChar menuseparator
34152 Modules\SpecialChar menuseparator
34159 \change_deleted 564990737 1672161729
34163 \begin_inset Quotes eld
34167 \begin_inset Quotes erd
34170 program for some illustrations of how all of these pieces go together or
34172 \change_deleted 564990737 1672161756
34175 LIBDIR/examples/noweb2lyx.lyx
34176 \change_inserted 564990737 1672161756
34181 File\SpecialChar menuseparator
34182 Open Example\SpecialChar menuseparator
34183 Modules\SpecialChar menuseparator
34184 Noweb2\SpecialChar LyX
34194 Interestingly, these
34195 \change_deleted 564990737 1672161767
34198 files show off the language-indepence of the \SpecialChar LyX
34199 literate programming support
34200 since they are written in Python
34201 \change_deleted 564990737 1672161782
34204 and Perl respectively.
34207 \begin_layout Subsubsection
34208 Configuring \SpecialChar LyX
34212 \begin_layout Standard
34213 All the Literate Programming support is configured by the
34215 Tools\SpecialChar menuseparator
34219 \begin_inset Quotes eld
34223 \begin_inset Quotes erd
34227 The important parts are:
34230 \begin_layout Description
34232 \begin_inset space ~
34236 \begin_inset Quotes eld
34240 \begin_inset Quotes erd
34244 \begin_inset space ~
34247 format Set up via the File Formats tab, this is where the Noweb-specific
34257 , the file extension is set to
34262 This tells \SpecialChar LyX
34263 to create a file with a
34267 extension in the first step of the conversion process.
34270 \begin_layout Description
34272 \begin_inset space ~
34280 \begin_inset space ~
34283 format This is an empty format whose sole purpose is to be the endpoint
34284 of a conversion (which then allows us to set up a converter for it).
34287 \begin_layout Description
34297 This converter performs the
34298 \begin_inset Quotes eld
34302 \begin_inset Quotes erd
34305 of the literate document.
34306 For Noweb, it is set to
34307 \begin_inset Quotes eld
34312 noweave -delay -index $$i > $$o
34315 \begin_inset Quotes erd
34321 \begin_layout Description
34331 \begin_inset Quotes eld
34335 \begin_inset Quotes erd
34339 As stated above, the Converter is set to
34340 \begin_inset Quotes eld
34348 \begin_inset Quotes erd
34351 , with Flags set to
34352 \begin_inset Newline newline
34356 \begin_inset Quotes eld
34361 parselog=$$s/scripts/listerrors
34364 \begin_inset Quotes erd
34370 \begin_layout Subsubsection
34374 \begin_layout Standard
34375 There is also a new function implemented in the \SpecialChar LyX
34377 \begin_inset Quotes eld
34380 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
34384 \begin_layout Standard
34385 When debugging code with ddd/gdb, it is possible to invoke a text editor
34386 at the current execution position with a single key stroke.
34387 The default ddd configuration for that is shift-ctrl-V.
34388 It happens that you can define the editor command line invocation in ddd
34391 Edit\SpecialChar menuseparator
34392 Preferences\SpecialChar menuseparator
34395 dialog and changing the "Edit Sources" entry.
34398 \begin_layout Standard
34399 I take advantage of the newly created \SpecialChar LyX
34400 server function and this ddd feature,
34402 \begin_inset Quotes eld
34406 \begin_inset Quotes erd
34412 \begin_layout LyX-Code
34413 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
34416 \begin_layout Standard
34417 With this, whenever you are using ddd and find a point in the program that
34418 you want to edit, you just press shift-ctrl-V (in the ddd window), and
34419 ddd will forward this information to \SpecialChar LyX
34420 through the \SpecialChar LyX
34421 server and then the
34423 window will show the same file with the cursor at the same position ddd
34425 No more guessing or long scrolling to locate a point in the program back
34429 \begin_layout Standard
34430 Note however that you must enable the \SpecialChar LyX
34431 server to get this feature working
34432 (it is disabled by default).
34434 \begin_inset space ~
34438 \begin_inset CommandInset ref
34440 reference "sec:Starting-the-Server"
34444 explains how to do that.
34447 \begin_layout Subsubsection
34451 \begin_layout Standard
34452 There are six new buttons that can be added to your \SpecialChar LyX
34454 Four of these buttons are short cuts to layout styles:
34472 , one for the custom inset
34477 The last one is a short cut to the
34478 \begin_inset Quotes eld
34482 \begin_inset Quotes erd
34489 \begin_layout Standard
34491 has a range of buttons that are available for tool bar customization.
34492 In my toolbar I like to combine the six short cuts above with two more:
34497 \SpecialChar menuseparator
34502 \SpecialChar menuseparator
34509 Document\SpecialChar menuseparator
34510 View\SpecialChar menuseparator
34514 Here is how it looks like:
34517 \begin_layout LyX-Code
34521 \begin_layout LyX-Code
34525 \begin_layout LyX-Code
34526 Icon "layout Standard"
34529 \begin_layout LyX-Code
34530 Icon "layout Section"
34533 \begin_layout LyX-Code
34534 Icon "layout \SpecialChar LaTeX
34538 \begin_layout LyX-Code
34539 Icon "layout \SpecialChar LyX
34543 \begin_layout LyX-Code
34544 Icon "flex.insert Chunk"
34547 \begin_layout LyX-Code
34551 \begin_layout LyX-Code
34555 \begin_layout LyX-Code
34556 Icon "buffer-typeset"
34559 \begin_layout LyX-Code
34560 Icon "build-program"
34563 \begin_layout LyX-Code
34567 \begin_layout LyX-Code
34571 \begin_layout LyX-Code
34575 \begin_layout LyX-Code
34579 \begin_layout LyX-Code
34583 \begin_layout Subsubsection
34584 Colors customization
34587 \begin_layout Standard
34588 There are a number of colors in \SpecialChar LyX
34589 that can be customized in
34594 One of the things that bothers people is the \SpecialChar LaTeX
34596 The default color is red, since the chunks uses \SpecialChar LaTeX
34597 font, and there is a lot
34598 of chunks in literate documents, you may get tired of seeing everything
34600 You can change it by going to the tabs
34609 \begin_layout Standard
34610 The next thing is the visible presence of the newline character in the screen.
34611 You can choose the color of this particular character and make it blend
34613 I recommend you choosing a color that is close to the background but not
34614 equal, that way you still can see it is there, but it is not bothering
34618 \begin_layout Subsection
34623 \begin_layout Standard
34633 \change_inserted 564990737 1672161863
34637 Help\SpecialChar menuseparator
34638 Specific Manuals\SpecialChar menuseparator
34646 \change_deleted 564990737 1671643409
34652 \change_inserted 564990737 1672161856
34656 File\SpecialChar menuseparator
34657 Open Example\SpecialChar menuseparator
34658 Modules\SpecialChar menuseparator
34665 \change_deleted 564990737 1671643461
34666 the Sweave manual (menu
34668 Help\SpecialChar menuseparator
34672 \change_inserted 564990737 1672161856
34676 Help\SpecialChar menuseparator
34677 Specific Manuals\SpecialChar menuseparator
34679 \change_deleted 564990737 1672161921
34685 \change_inserted 564990737 1672161917
34689 File\SpecialChar menuseparator
34690 Open Example\SpecialChar menuseparator
34691 Modules\SpecialChar menuseparator
34699 \begin_layout Chapter
34701 \change_deleted 564990737 1671355343
34705 \begin_layout Standard
34707 \change_deleted 564990737 1671355343
34708 You can do everything with \SpecialChar LyX
34709 that you can do with \SpecialChar LaTeX
34711 However, \SpecialChar LyX
34712 cannot support every \SpecialChar LaTeX
34714 But you can always use \SpecialChar TeX
34716 This chapter shows you some more special things you might want to use.
34717 For other special things you can do with figures, tables, floats, boxes
34718 and notes, have a look at the
34721 \begin_inset space ~