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
17020 Multiple Text Columns
17023 \begin_layout Standard
17024 This feature is independent of the option
17026 Two-column document
17028 in the document settings under
17033 If you want to have 2
17034 \begin_inset space ~
17037 columns for the whole document, it is recommended to use the
17039 Two-column document
17042 For all other cases use this feature.
17045 \begin_layout Standard
17046 To use multiple text columns in your document, you have to load the module
17053 Document\SpecialChar menuseparator
17054 Settings\SpecialChar menuseparator
17057 ) and must have the \SpecialChar LaTeX
17059 \begin_inset Flex Code
17062 \begin_layout Plain Layout
17071 \begin_layout Standard
17072 Footnotes within multiple columns will be placed at the bottom of the page
17073 and not under each column.
17074 Within the different columns you can use everything, with the limitation
17075 that for floats you need to use the float option
17082 \begin_layout Subsection
17086 \begin_layout Standard
17087 If you want to have 2
17088 \begin_inset space ~
17091 columns in your text, insert a multicolumn inset via the menu
17093 Insert\SpecialChar menuseparator
17095 \begin_inset space ~
17098 Insets\SpecialChar menuseparator
17100 \begin_inset space ~
17105 where the columns should start.
17106 Write all text that should be printed in 2
17107 \begin_inset space ~
17110 columns into this inset.
17113 \begin_layout Standard
17114 Here is an example:
17117 \begin_layout Standard
17119 \begin_inset Flex Multiple Columns
17122 \begin_layout Plain Layout
17127 The Adventure of the Empty House
17130 \begin_inset Newline newline
17133 by Sir Arthur Conan Doyle
17136 \begin_layout Plain Layout
17139 It was in the spring of the year 1894 that all London was interested, and
17140 the fashionable world dismayed, by the murder of the Honourable Ronald
17141 Adair under most unusual and inexplicable circumstances.
17142 The public has already learned those particulars of the crime which came
17143 out in the police investigation, but a good deal was suppressed upon that
17144 occasion, since the case for the prosecution was so overwhelmingly strong
17145 that it was not necessary to bring forward all the facts.
17146 Only now, at the end of nearly ten years, am I allowed to supply those
17147 missing links which make up the whole of that remarkable chain.
17148 The crime was of interest in itself, but that interest was as nothing to
17149 me compared to the inconceivable sequel, which afforded me the greatest
17150 shock and surprise of any event in my adventurous life.
17151 Even now, after this long interval, I find myself thrilling as I think
17152 of it, and feeling once more that sudden flood of joy, amazement, and increduli
17153 ty which utterly submerged my mind.
17154 Let me say to that public, which has shown some interest in those glimpses
17155 which I have occasionally given them of the thoughts and actions of a very
17156 remarkable man, that they are not to blame me if I have not shared my knowledge
17157 with them, for I should have considered it my first duty to do so, had
17158 I not been barred by a positive prohibition from his own lips, which was
17159 only withdrawn upon the third of last month.
17167 \begin_layout Standard
17168 To get 3 or more columns, set the cursor into the multicolumn inset and
17171 Insert\SpecialChar menuseparator
17173 \begin_inset space ~
17177 \begin_inset space ~
17183 The number of the desired columns is written into that inset (for 3
17184 \begin_inset space ~
17188 \begin_inset Quotes eld
17192 \begin_inset Quotes erd
17196 \begin_inset Newline newline
17199 Here is an example with 3
17200 \begin_inset space ~
17206 \begin_layout Standard
17207 \begin_inset Flex Multiple Columns
17210 \begin_layout Plain Layout
17213 \begin_inset Argument 1
17216 \begin_layout Plain Layout
17223 It can be imagined that my close intimacy with Sherlock Holmes had interested
17224 me deeply in crime, and that after his disappearance I never failed to
17225 read with care the various problems which came before the public.
17226 And I even attempted, more than once, for my own private satisfaction,
17227 to employ his methods in their solution, though with indifferent success.
17228 There was none, however, which appealed to me like this tragedy of Ronald
17230 As I read the evidence at the inquest, which led up to a verdict of willful
17231 murder against some person or persons unknown, I realized more clearly
17232 than I had ever done the loss which the community had sustained by the
17233 death of Sherlock Holmes.
17234 There were points about this strange business which would, I was sure,
17235 have specially appealed to him, and the efforts of the police would have
17236 been supplemented, or more probably anticipated, by the trained observation
17237 and the alert mind of the first criminal agent in Europe.
17238 All day, as I drove upon my round, I turned over the case in my mind and
17239 found no explanation which appeared to me to be adequate.
17240 At the risk of telling a twice-told tale, I will recapitulate the facts
17241 as they were known to the public at the conclusion of the inquest.
17249 \begin_layout Standard
17250 You can have up to 10
17251 \begin_inset space ~
17254 columns if you want to, but that might not be very pleasant for the readers
17258 \begin_layout Standard
17259 \begin_inset Newpage newpage
17265 \begin_layout Subsection
17266 Columns inside Columns
17269 \begin_layout Standard
17270 You can also have columns inside columns:
17273 \begin_layout Standard
17274 \begin_inset Flex Multiple Columns
17277 \begin_layout Plain Layout
17280 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
17281 at that time governor of one of the Australian colonies.
17282 Adair's mother had returned from Australia to undergo the operation for
17283 cataract, and she, her son Ronald, and her daughter Hilda were living together
17287 \begin_layout Plain Layout
17288 \begin_inset Flex Multiple Columns
17291 \begin_layout Plain Layout
17294 The youth moved in the best society
17295 \begin_inset space ~
17298 – had, so far as was known, no enemies and no particular vices.
17299 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
17300 had been broken off by mutual consent some months before, and there was
17301 no sign that it had left any very profound feeling behind it.
17302 For the rest {sic} the man's life moved in a narrow and conventional circle,
17303 for his habits were quiet and his nature unemotional.
17304 Yet it was upon this easy-going young aristocrat that death came, in most
17305 strange and unexpected form, between the hours of ten and eleven-twenty
17306 on the night of March 30, 1894.
17314 \begin_layout Plain Layout
17317 Ronald Adair was fond of cards
17318 \begin_inset space ~
17321 – playing continually, but never for such stakes as would hurt him.
17322 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
17323 It was shown that, after dinner on the day of his death, he had played
17324 a rubber of whist at the latter club.
17325 He had also played there in the afternoon.
17330 The evidence of those who had played with him
17331 \begin_inset space ~
17335 Murray, Sir John Hardy, and Colonel Moran
17336 \begin_inset space ~
17339 – showed that the game was whist, and that there was a fairly equal fall
17341 Adair might have lost five pounds, but not more.
17342 His fortune was a considerable one, and such a loss could not in any way
17344 He had played nearly every day at one club or other, but he was a cautious
17345 player, and usually rose a winner.
17346 It came out in evidence that, in partnership with Colonel Moran, he had
17347 actually won as much as four hundred and twenty pounds in a sitting, some
17348 weeks before, from Godfrey Milner and Lord Balmoral.
17349 So much for his recent history as it came out at the inquest.
17357 \begin_layout Subsection
17361 \begin_layout Standard
17362 The examples in this section show some more special features of multiple
17366 \begin_layout Standard
17367 For more features of multiple columns, have a look at the
17368 \begin_inset CommandInset href
17370 name "documentation"
17371 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
17376 of the \SpecialChar LaTeX
17378 \begin_inset Flex Code
17381 \begin_layout Plain Layout
17390 \begin_layout Subsubsection
17394 \begin_layout Standard
17395 To add a preface text for multiple columns, set the cursor into the multicolumn
17396 inset and use the menu
17398 Insert\SpecialChar menuseparator
17402 Write your preface text into that inset.
17403 \begin_inset Newline newline
17406 This is an example with some preface text:
17409 \begin_layout Standard
17410 \begin_inset VSpace bigskip
17416 \begin_layout Standard
17417 \begin_inset Flex Multiple Columns
17420 \begin_layout Plain Layout
17421 \begin_inset Argument 2
17424 \begin_layout Plain Layout
17425 And the story continues and continues and continues and continues\SpecialChar ldots
17433 On the evening of the crime, he returned from the club exactly at ten.
17434 His mother and sister were out spending the evening with a relation.
17435 The servant deposed that she heard him enter the front room on the second
17436 floor, generally used as his sitting-room.
17437 She had lit a fire there, and as it smoked she had opened the window.
17438 No sound was heard from the room until eleven-twenty, the hour of the return
17439 of Lady Maynooth and her daughter.
17440 Desiring to say good-night, she attempted to enter her son's room.
17441 The door was locked on the inside, and no answer could be got to their
17442 cries and knocking.
17443 Help was obtained, and the door forced.
17444 The unfortunate young man was found lying near the table.
17445 His head had been horribly mutilated by an expanding revolver bullet, but
17446 no weapon of any sort was to be found in the room.
17454 \begin_layout Standard
17455 You can also use a section heading as the preface if you use a section command
17456 as \SpecialChar TeX
17458 For example the command
17461 \begin_layout LyX-Code
17464 subsection{subsection title}
17467 \begin_layout Standard
17468 creates a subsection.
17469 In this example the preface is a subsubsection:
17472 \begin_layout Standard
17473 \begin_inset Flex Multiple Columns
17476 \begin_layout Plain Layout
17477 \begin_inset Argument 2
17480 \begin_layout Plain Layout
17484 \begin_layout Plain Layout
17493 This is a subsubsection heading as a preface
17497 \begin_layout Plain Layout
17511 A minute examination of the circumstances served only to make the case more
17513 In the first place, no reason could be given why the young man should have
17514 fastened the door upon the inside.
17515 There was the possibility that the murderer had done this, and had afterwards
17516 escaped by the window.
17517 The drop was at least twenty feet, however, and a bed of crocuses in full
17519 Neither the flowers nor the earth showed any sign of having been disturbed,
17520 nor were there any marks upon the narrow strip of grass which separated
17521 the house from the road.
17522 Apparently, therefore, it was the young man himself who had fastened the
17524 But how did he come by his death? No one could have climbed up to the window
17525 without leaving traces.
17526 Suppose a man had fired through the window, he would indeed be a remarkable
17527 shot who could with a revolver inflict so deadly a wound.
17528 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
17529 a hundred yards of the house.
17530 No one had heard a shot.
17538 \begin_layout Standard
17539 If there is less vertical space than 6
17540 \begin_inset space ~
17543 text lines is left on the page at the beginning of the multiple columns,
17544 a page break will be inserted before the multiple columns.
17545 Depending on the number of lines of the preface text, you might want to
17547 This is done by setting the cursor into the mulitcolumn inset behind the
17548 preface (if there is any) and using the menu
17550 Insert\SpecialChar menuseparator
17552 \begin_inset space ~
17556 \begin_inset space ~
17560 \begin_inset space ~
17566 Insert into that inset the amount of space like e.
17567 \begin_inset space \thinspace{}
17571 \begin_inset space \space{}
17575 \begin_inset Quotes eld
17579 \begin_inset Quotes erd
17583 \begin_inset Newline newline
17586 In this example the space is set to 7
17587 \begin_inset space ~
17590 text lines by using
17591 \begin_inset Flex Code
17594 \begin_layout Plain Layout
17603 \begin_inset Flex Code
17606 \begin_layout Plain Layout
17614 needs to be inserted as \SpecialChar TeX
17618 \begin_layout Standard
17619 \begin_inset Flex Multiple Columns
17622 \begin_layout Plain Layout
17623 \begin_inset Argument 3
17626 \begin_layout Plain Layout
17631 \begin_layout Plain Layout
17647 On the evening of the crime, he returned from the club exactly at ten.
17648 His mother and sister were out spending the evening with a relation.
17649 The servant deposed that she heard him enter the front room on the second
17650 floor, generally used as his sitting-room.
17651 She had lit a fire there, and as it smoked she had opened the window.
17652 No sound was heard from the room until eleven-twenty, the hour of the return
17653 of Lady Maynooth and her daughter.
17654 Desiring to say good-night, she attempted to enter her son's room.
17655 The door was locked on the inside, and no answer could be got to their
17656 cries and knocking.
17657 Help was obtained, and the door forced.
17658 The unfortunate young man was found lying near the table.
17659 His head had been horribly mutilated by an expanding revolver bullet, but
17660 no weapon of any sort was to be found in the room.
17668 \begin_layout Subsubsection
17672 \begin_layout Standard
17673 The amount of space before and after multiple columns can be changed by
17674 changing the length
17675 \begin_inset Flex Code
17678 \begin_layout Plain Layout
17687 For example the command
17690 \begin_layout LyX-Code
17698 \begin_layout Standard
17699 in \SpecialChar TeX
17700 Code changes its value to 3
17701 \begin_inset space \thinspace{}
17705 The change must be made before the multiple columns' start.
17706 The predefined value is 13
17707 \begin_inset space \thinspace{}
17713 \begin_layout Standard
17715 \begin_inset Flex Code
17718 \begin_layout Plain Layout
17727 \begin_inset space \thinspace{}
17733 \begin_layout Standard
17737 \begin_layout Plain Layout
17743 multicolsep}{2.5cm}
17751 \begin_layout Standard
17752 \begin_inset Flex Multiple Columns
17755 \begin_layout Plain Layout
17758 All day I turned these facts over in my mind, endeavouring to hit upon some
17759 theory which could reconcile them all, and to find that line of least resistanc
17760 e which my poor friend had declared to be the starting-point of every investigat
17762 I confess that I made little progress.
17763 In the evening I strolled across the Park, and found myself about six o'clock
17764 at the Oxford Street end of Park Lane.
17765 A group of loafers upon the pavements, all staring up at a particular window,
17766 directed me to the house which I had come to see.
17767 A tall, thin man with coloured glasses, whom I strongly suspected of being
17768 a plain-clothes detective, was pointing out some theory of his own, while
17769 the others crowded round to listen to what he said.
17770 I got as near him as I could, but his observations seemed to me to be absurd,
17771 so I withdrew again in some disgust.
17772 As I did so I struck against an elderly, deformed man, who had been behind
17773 me, and I knocked down several books which he was carrying.
17781 \begin_layout Standard
17782 \begin_inset Note Greyedout
17785 \begin_layout Plain Layout
17790 The values you set with
17791 \begin_inset Flex Code
17794 \begin_layout Plain Layout
17802 will be used for all following multiple columns until you change them again.
17810 \begin_layout Standard
17814 \begin_layout Plain Layout
17826 \begin_inset Note Note
17829 \begin_layout Plain Layout
17830 go back to the default
17838 \begin_layout Standard
17839 \begin_inset Newpage newpage
17845 \begin_layout Subsubsection
17849 \begin_layout Standard
17850 A column break can be forced by inserting the command
17851 \begin_inset Flex Code
17854 \begin_layout Plain Layout
17862 as \SpecialChar TeX
17863 Code to that position in the text where the column should be broken.
17864 Note that this leads in most cases to whitespace in the text.
17865 \begin_inset Newline newline
17868 Here is an example:
17871 \begin_layout Standard
17872 \begin_inset Flex Multiple Columns
17875 \begin_layout Plain Layout
17878 \begin_inset Quotes eld
17881 You're surprised to see me, sir,
17882 \begin_inset Quotes erd
17885 said he, in a strange, croaking voice.
17888 \begin_layout Plain Layout
17891 I acknowledged that I was.
17894 \begin_layout Plain Layout
17897 \begin_inset Quotes eld
17900 Well, I've a conscience, sir, and when I chanced to see you go into this
17901 house, as I came hobbling after you, I thought to myself, I'll just step
17902 in and see that kind gentleman, and tell him that if I was a bit gruff
17903 in my manner there was not any harm meant, and that I am much obliged to
17904 him for picking up my books.
17905 \begin_inset Quotes erd
17911 \begin_layout Plain Layout
17914 \begin_inset Quotes eld
17917 You make too much of a trifle,
17918 \begin_inset Quotes erd
17923 \begin_inset Quotes eld
17926 May I ask how you knew who I was?
17927 \begin_inset Quotes erd
17930 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
17934 \begin_layout Plain Layout
17946 \begin_layout Plain Layout
17949 \begin_inset Quotes eld
17952 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
17953 you'll find my little bookshop at the corner of Church Street, and very
17954 happy to see you, I am sure.
17955 Maybe you collect yourself, sir.
17959 \begin_inset space ~
17973 \begin_inset space ~
17976 – a bargain, every one of them.
17977 With five volumes you could just fill that gap on that second shelf.
17978 It looks untidy, does it not, sir?
17979 \begin_inset Quotes erd
17990 \begin_layout Subsubsection
17994 \begin_layout Standard
17995 The width of the columns is automatically calculated, but you can modify
17996 the space between the columns.
17997 This is done by changing the length
17998 \begin_inset Flex Code
18001 \begin_layout Plain Layout
18010 Its predefined value is 10
18011 \begin_inset space \thinspace{}
18015 Here is an example where
18016 \begin_inset Flex Code
18019 \begin_layout Plain Layout
18028 \begin_inset space \thinspace{}
18034 \begin_layout Standard
18038 \begin_layout Plain Layout
18052 \begin_layout Standard
18053 \begin_inset Flex Multiple Columns
18056 \begin_layout Plain Layout
18059 My observations of No.
18060 \begin_inset space \space{}
18063 427 Park Lane did little to clear up the problem in which I was interested.
18064 The house was separated from the street by a low wall and railing, the
18065 whole not more than five feet high.
18066 It was perfectly easy, therefore, for anyone to get into the garden, but
18067 the window was entirely inaccessible, since there was no water pipe or
18068 anything which could help the most active man to climb it.
18069 More puzzled than ever, I retraced my steps to Kensington.
18070 I had not been in my study five minutes when the maid entered to say that
18071 a person desired to see me.
18072 To my astonishment it was none other than my strange old book collector,
18073 his sharp, wizened face peering out from a frame of white hair, and his
18074 precious volumes, a dozen of them at least, wedged under his right arm.
18082 \begin_layout Standard
18086 \begin_layout Plain Layout
18098 \begin_inset Note Note
18101 \begin_layout Plain Layout
18102 go back to the default
18110 \begin_layout Subsubsection
18114 \begin_layout Standard
18115 Between the columns a rule with a width of the length
18116 \begin_inset Flex Code
18119 \begin_layout Plain Layout
18128 If this rule width is set to 0
18129 \begin_inset space \thinspace{}
18132 pt (this is the default), the rule is suppressed.
18133 In the following example the rule is 2
18134 \begin_inset space \thinspace{}
18140 \begin_layout Standard
18144 \begin_layout Plain Layout
18150 columnseprule}{2pt}
18158 \begin_layout Standard
18159 \begin_inset Flex Multiple Columns
18162 \begin_layout Plain Layout
18165 \begin_inset Quotes eld
18168 You're surprised to see me, sir,
18169 \begin_inset Quotes erd
18172 said he, in a strange, croaking voice.
18175 \begin_layout Plain Layout
18178 I acknowledged that I was.
18181 \begin_layout Plain Layout
18184 \begin_inset Quotes eld
18187 Well, I've a conscience, sir, and when I chanced to see you go into this
18188 house, as I came hobbling after you, I thought to myself, I'll just step
18189 in and see that kind gentleman, and tell him that if I was a bit gruff
18190 in my manner there was not any harm meant, and that I am much obliged to
18191 him for picking up my books.
18192 \begin_inset Quotes erd
18198 \begin_layout Plain Layout
18201 \begin_inset Quotes eld
18204 You make too much of a trifle,
18205 \begin_inset Quotes erd
18210 \begin_inset Quotes eld
18213 May I ask how you knew who I was?
18214 \begin_inset Quotes erd
18220 \begin_layout Plain Layout
18223 \begin_inset Quotes eld
18226 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
18227 you'll find my little bookshop at the corner of Church Street, and very
18228 happy to see you, I am sure.
18229 Maybe you collect yourself, sir.
18233 \begin_inset space ~
18247 \begin_inset space ~
18250 – a bargain, every one of them.
18251 With five volumes you could just fill that gap on that second shelf.
18252 It looks untidy, does it not, sir?
18253 \begin_inset Quotes erd
18264 \begin_layout Standard
18265 \begin_inset VSpace defskip
18271 \begin_layout Standard
18272 The rule can be colored by redefining the command
18273 \begin_inset Flex Code
18276 \begin_layout Plain Layout
18285 This is done by inserting the command
18288 \begin_layout LyX-Code
18293 columnseprulecolor}{
18298 \begin_layout Standard
18299 as \SpecialChar TeX
18300 Code before the multicolumn inset.
18302 \begin_inset Flex Code
18305 \begin_layout Plain Layout
18311 in this command by a color of your choice.
18312 You can use all pre- and self-defined colors.
18320 \begin_inset space ~
18325 for more information about pre- and self-defined colors.
18326 To go back to the default color insert the command
18329 \begin_layout LyX-Code
18334 columnseprulecolor}{
18339 \begin_layout Standard
18340 Here is the example with a cyan rule and 1
18341 \begin_inset space \thinspace{}
18344 cm column separation:
18347 \begin_layout Standard
18351 \begin_layout Plain Layout
18360 \begin_layout Plain Layout
18366 columnseprulecolor}{
18376 \begin_layout Standard
18377 \begin_inset Flex Multiple Columns
18380 \begin_layout Plain Layout
18383 \begin_inset Quotes eld
18386 You're surprised to see me, sir,
18387 \begin_inset Quotes erd
18390 said he, in a strange, croaking voice.
18393 \begin_layout Plain Layout
18396 I acknowledged that I was.
18399 \begin_layout Plain Layout
18402 \begin_inset Quotes eld
18405 Well, I've a conscience, sir, and when I chanced to see you go into this
18406 house, as I came hobbling after you, I thought to myself, I'll just step
18407 in and see that kind gentleman, and tell him that if I was a bit gruff
18408 in my manner there was not any harm meant, and that I am much obliged to
18409 him for picking up my books.
18410 \begin_inset Quotes erd
18416 \begin_layout Plain Layout
18419 \begin_inset Quotes eld
18422 You make too much of a trifle,
18423 \begin_inset Quotes erd
18428 \begin_inset Quotes eld
18431 May I ask how you knew who I was?
18432 \begin_inset Quotes erd
18438 \begin_layout Plain Layout
18441 \begin_inset Quotes eld
18444 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
18445 you'll find my little bookshop at the corner of Church Street, and very
18446 happy to see you, I am sure.
18447 Maybe you collect yourself, sir.
18451 \begin_inset space ~
18465 \begin_inset space ~
18468 – a bargain, every one of them.
18469 With five volumes you could just fill that gap on that second shelf.
18470 It looks untidy, does it not, sir?
18471 \begin_inset Quotes erd
18482 \begin_layout Standard
18486 \begin_layout Plain Layout
18492 columnseprule}{0pt}
18495 \begin_layout Plain Layout
18501 columnseprulecolor}{
18509 \begin_inset Note Note
18512 \begin_layout Plain Layout
18513 go back to the default
18521 \begin_layout Section
18523 \change_inserted 564990737 1671270380
18527 \begin_layout Subsection
18529 \change_inserted 564990737 1671270398
18531 \change_deleted 564990737 1671270396
18537 \begin_layout Standard
18540 as well as any other text processor uses by default rectangular paragraphs.
18541 For special cases like for example posters, invitation cards or poems you
18542 can modify the paragraph shape to one of your choice.
18543 This can be done by using the \SpecialChar LaTeX
18545 \begin_inset Flex Code
18548 \begin_layout Plain Layout
18554 which is loaded by using in the document settings the module
18556 Custom paragraph shapes
18561 \begin_layout Subsubsection
18565 \begin_layout Standard
18570 provides the following shapes:
18573 \begin_layout Standard
18574 \begin_inset Tabular
18575 <lyxtabular version="3" rows="13" columns="3">
18576 <features booktabs="true" islongtable="true" longtabularalignment="center">
18577 <column alignment="left" valignment="middle" width="16col%">
18578 <column alignment="left" valignment="middle" width="40col%">
18579 <column alignment="left" valignment="middle" width="35col%">
18580 <row endhead="true">
18581 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
18584 \begin_layout Plain Layout
18593 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
18596 \begin_layout Plain Layout
18605 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
18608 \begin_layout Plain Layout
18618 <row interlinespace="default">
18619 <cell alignment="left" valignment="top" usebox="none">
18622 \begin_layout Plain Layout
18630 <cell alignment="left" valignment="top" usebox="none">
18633 \begin_layout Plain Layout
18636 Circle with circular hole (in the size of a CD/DVD)
18641 <cell alignment="left" valignment="top" usebox="none">
18644 \begin_layout Plain Layout
18647 Cannot be scaled, take care there is not too much text
18653 <row interlinespace="default">
18654 <cell alignment="left" valignment="top" usebox="none">
18657 \begin_layout Plain Layout
18665 <cell alignment="left" valignment="top" usebox="none">
18668 \begin_layout Plain Layout
18676 <cell alignment="left" valignment="top" usebox="none">
18679 \begin_layout Plain Layout
18682 Fragile, calculation might fail
18688 <row interlinespace="default">
18689 <cell alignment="left" valignment="top" usebox="none">
18692 \begin_layout Plain Layout
18700 <cell alignment="left" valignment="top" usebox="none">
18703 \begin_layout Plain Layout
18706 Rhomboid (symbolizing a
18707 \begin_inset Quotes eld
18711 \begin_inset Quotes erd
18719 <cell alignment="left" valignment="top" usebox="none">
18722 \begin_layout Plain Layout
18731 <row interlinespace="default">
18732 <cell alignment="left" valignment="top" usebox="none">
18735 \begin_layout Plain Layout
18743 <cell alignment="left" valignment="top" usebox="none">
18746 \begin_layout Plain Layout
18754 <cell alignment="left" valignment="top" usebox="none">
18757 \begin_layout Plain Layout
18766 <row interlinespace="default">
18767 <cell alignment="left" valignment="top" usebox="none">
18770 \begin_layout Plain Layout
18778 <cell alignment="left" valignment="top" usebox="none">
18781 \begin_layout Plain Layout
18789 <cell alignment="left" valignment="top" usebox="none">
18792 \begin_layout Plain Layout
18801 <row interlinespace="default">
18802 <cell alignment="left" valignment="top" usebox="none">
18805 \begin_layout Plain Layout
18813 <cell alignment="left" valignment="top" usebox="none">
18816 \begin_layout Plain Layout
18819 Nut for bolt (hexagon with circular hole)
18824 <cell alignment="left" valignment="top" usebox="none">
18827 \begin_layout Plain Layout
18836 <row interlinespace="default">
18837 <cell alignment="left" valignment="top" usebox="none">
18840 \begin_layout Plain Layout
18848 <cell alignment="left" valignment="top" usebox="none">
18851 \begin_layout Plain Layout
18859 <cell alignment="left" valignment="top" usebox="none">
18862 \begin_layout Plain Layout
18871 <row interlinespace="default">
18872 <cell alignment="left" valignment="top" usebox="none">
18875 \begin_layout Plain Layout
18883 <cell alignment="left" valignment="top" usebox="none">
18886 \begin_layout Plain Layout
18894 <cell alignment="left" valignment="top" usebox="none">
18897 \begin_layout Plain Layout
18906 <row interlinespace="default">
18907 <cell alignment="left" valignment="top" usebox="none">
18910 \begin_layout Plain Layout
18918 <cell alignment="left" valignment="top" usebox="none">
18921 \begin_layout Plain Layout
18929 <cell alignment="left" valignment="top" usebox="none">
18932 \begin_layout Plain Layout
18941 <row interlinespace="default">
18942 <cell alignment="left" valignment="top" usebox="none">
18945 \begin_layout Plain Layout
18953 <cell alignment="left" valignment="top" usebox="none">
18956 \begin_layout Plain Layout
18959 Normal/reversed rain drop
18964 <cell alignment="left" valignment="top" usebox="none">
18967 \begin_layout Plain Layout
18970 Fragile, calculation might fail
18976 <row interlinespace="default">
18977 <cell alignment="left" valignment="top" usebox="none">
18980 \begin_layout Plain Layout
18989 <cell alignment="left" valignment="top" usebox="none">
18992 \begin_layout Plain Layout
18995 The \SpecialChar TeX
19001 <cell alignment="left" valignment="top" usebox="none">
19004 \begin_layout Plain Layout
19013 <row interlinespace="default">
19014 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
19017 \begin_layout Plain Layout
19021 \begin_inset Newline newline
19029 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
19032 \begin_layout Plain Layout
19035 Triangles in different orientations
19040 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
19043 \begin_layout Plain Layout
19059 \begin_layout Standard
19060 To use a shape for your paragraph, simply select it in \SpecialChar LyX
19062 for environments in the toolbar.
19065 \begin_layout Standard
19066 \begin_inset Newpage newpage
19072 \begin_layout Standard
19073 Here is an example paragraph in the shape of a nut:
19076 \begin_layout Standard
19077 \begin_inset VSpace bigskip
19086 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
19087 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
19089 At vero eos et accusam et justo duo dolores et ea rebum.
19090 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
19092 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
19093 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
19097 \begin_layout Standard
19098 \begin_inset VSpace bigskip
19104 \begin_layout Standard
19105 \begin_inset Note Greyedout
19108 \begin_layout Plain Layout
19117 paragraphs cannot run over a page break.
19125 \begin_layout Standard
19126 \begin_inset VSpace bigskip
19132 \begin_layout Standard
19134 \begin_inset Flex Code
19137 \begin_layout Plain Layout
19143 takes care that the shape will always be preserved, no matter how much
19144 text is in the paragraph.
19145 Therefore the paragraph size changes with the amount of contained text.
19146 This can lead to paragraph sizes exceeding the page margins.
19147 To demonstrate the size scaling, here is the same example paragraph but
19148 with twice as much text:
19151 \begin_layout Standard
19152 \begin_inset Newpage newpage
19161 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
19162 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
19164 At vero eos et accusam et justo duo dolores et ea rebum.
19165 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
19167 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
19168 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
19170 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
19171 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
19173 At vero eos et accusam et justo duo dolores et ea rebum.
19174 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
19176 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
19177 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
19181 \begin_layout Standard
19182 \begin_inset VSpace bigskip
19188 \begin_layout Standard
19189 An exception is the shape
19194 It cannot be scaled because it must fit the size of a CD/DVD.
19195 Therefore the amount of text that fits into the shape is limited.
19196 \begin_inset Newline newline
19207 shape are fragile, meaning that the calculation of their size can fail,
19208 depending on the amount of text.
19209 You will then get the \SpecialChar LaTeX
19211 \begin_inset Quotes eld
19214 Arithmetic overflow
19215 \begin_inset Quotes erd
19219 In this case one can try to remove or add some text; if nothing works one
19220 has to use another shape.
19223 \begin_layout Standard
19224 \begin_inset VSpace bigskip
19230 \begin_layout Standard
19231 For shapes with tips you will maybe see that \SpecialChar LaTeX
19232 's hyphenation routine fails
19233 for text in the tips.
19234 Therefore it is often necessary to add hyphenation points
19239 arg "specialchar-insert hyphenation"
19244 ) to the corresponding text parts.
19247 \begin_layout Standard
19248 \begin_inset VSpace bigskip
19254 \begin_layout Standard
19255 Shapepar paragraphs are either always centered or placed on the page so
19256 that their left border touches the left page margin.
19257 You can therefore not use the paragraph dialog to align such paragraphs.
19258 A solution is to put the paragraph into a minipage or parbox and align
19260 The problem is hereby to find the right width for the box.
19261 Because if it is too wide and you center the box, the paragraph is not
19262 centered too because it sticks at the left side of the box.
19263 So you might have to play a bit with the width until it fits.
19264 Here are two heart-shaped paragraphs, the first one is not aligned, the
19265 second one is right-aligned:
19268 \begin_layout Standard
19269 \begin_inset Newpage newpage
19275 \begin_layout Heart
19279 Lo\SpecialChar softhyphen
19280 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
19281 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
19283 At vero eos et accusam et justo duo dolores et ea rebum.
19284 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
19288 \begin_layout Standard
19289 \begin_inset VSpace bigskip
19295 \begin_layout Standard
19298 \begin_inset Box Frameless
19308 height_special "totalheight"
19313 backgroundcolor "none"
19316 \begin_layout Heart
19320 Lo\SpecialChar softhyphen
19321 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
19322 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
19324 At vero eos et accusam et justo duo dolores et ea rebum.
19325 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
19334 \begin_layout Subsubsection
19338 \begin_layout Standard
19339 You can define any shape you want.
19340 Doing this manually is a lot of work because every coordinate must be specified.
19341 But there is a way to let the computer calculate the coordinates:
19344 \begin_layout Enumerate
19345 Install the program
19346 \begin_inset CommandInset href
19349 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
19357 \begin_layout Enumerate
19364 TeX/LaTeX\SpecialChar menuseparator
19365 Settings\SpecialChar menuseparator
19368 and select the font size you are using in your document.
19369 For example this document uses the size 12
19370 \begin_inset space \thinspace{}
19376 \begin_layout Enumerate
19380 \begin_layout Enumerate
19383 TeX/LaTeX\SpecialChar menuseparator
19386 to export the shape to coordinates.
19387 In the appearing dialog use either the outline of your shape for the coordinate
19388 s or the path itself.
19392 \begin_layout Plain Layout
19393 For more information see
19394 \begin_inset CommandInset href
19396 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
19409 \begin_layout Standard
19410 The coordinates are written into a \SpecialChar TeX
19412 To use it for your \SpecialChar LyX
19416 \begin_layout Enumerate
19417 Place the cursor before the first character of your paragraph (or into a
19421 \begin_layout Enumerate
19422 Open in \SpecialChar LyX
19425 Insert\SpecialChar menuseparator
19426 File\SpecialChar menuseparator
19428 \begin_inset space ~
19433 , select the file and use
19442 \begin_layout Standard
19443 \begin_inset VSpace defskip
19449 \begin_layout Standard
19450 \begin_inset Note Greyedout
19453 \begin_layout Plain Layout
19458 : The changed shape only applies to the current paragraph; everything is
19459 reset to normal for the next paragraph.
19460 Therefore the shape definition file must be input into every paragraph
19461 with the desired shape.
19469 \begin_layout Standard
19470 \begin_inset VSpace bigskip
19476 \begin_layout Standard
19477 Here is an example:
19480 \begin_layout Standard
19481 \begin_inset VSpace bigskip
19487 \begin_layout Standard
19488 \begin_inset CommandInset include
19490 filename "SpecialParagraphShape.tex"
19497 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
19498 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
19500 At vero eos et accusam et justo duo dolores et ea rebum.
19501 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
19503 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
19504 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
19508 \begin_layout Standard
19509 \begin_inset VSpace bigskip
19515 \begin_layout Standard
19520 to draw complexer shapes in
19524 you can draw the shape in a program of your choice and import the resulting
19530 Then you only need to draw a line or spline along the outline of the image.
19533 \begin_layout Standard
19534 \begin_inset VSpace bigskip
19540 \begin_layout Standard
19543 Custom paragraph shapes
19545 also provides the two commands
19553 which can be used to define custom shapes coordinate by coordinate.
19557 \begin_layout Plain Layout
19558 These commands are internally used for all shapes described here.
19563 For information how these styles are used and about further customization
19564 possibilities, have a look at the
19565 \begin_inset CommandInset href
19567 name "documentation"
19568 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
19574 \begin_inset Flex Code
19577 \begin_layout Plain Layout
19586 \begin_layout Chapter
19588 \change_deleted 564990737 1671304317
19592 \change_inserted 564990737 1671304322
19594 \change_deleted 564990737 1671304331
19595 ies with Bib\SpecialChar TeX
19601 \begin_layout Standard
19602 The most basic information about how to use Bib\SpecialChar TeX
19607 with \SpecialChar LyX
19608 is contained in the section
19610 Bibliography databases
19617 The following subsections explain special bibliography features supported
19618 by \SpecialChar LyX
19622 \begin_layout Section
19623 Alternative Citation Styles
19626 \begin_layout Standard
19627 Standard Bib\SpecialChar TeX
19629 \begin_inset space \thinspace{}
19633 \begin_inset space \space{}
19637 \begin_inset Quotes eld
19641 \begin_inset Quotes erd
19644 ) to refer to a cited work.
19645 However, in many scientific disciplines, other citation styles are in use.
19646 The most common one is the author-year style (e.
19647 \begin_inset space \thinspace{}
19651 \begin_inset space \space{}
19655 \begin_inset Quotes eld
19659 \begin_inset Quotes erd
19664 supports three packages that provide this style,
19665 \begin_inset Flex Code
19668 \begin_layout Plain Layout
19675 \begin_inset Flex Code
19678 \begin_layout Plain Layout
19685 \begin_inset Flex Code
19688 \begin_layout Plain Layout
19695 Each of these packages has their pros and cons, which cannot be listed
19697 If you only want to have simple author-year (or author-numerical) style,
19698 or if you want to use one of the countless style files for
19699 \begin_inset Flex Code
19702 \begin_layout Plain Layout
19708 , then the established
19709 \begin_inset Flex Code
19712 \begin_layout Plain Layout
19718 package is probably your choice.
19719 If you look for specific citation styles common in law studies, you might
19721 \begin_inset Flex Code
19724 \begin_layout Plain Layout
19731 If you want to have full control over the formatting or look for advanced
19732 features such as ibidem, footnote citations, full title citations, advanced
19733 date formats (such as 400 BC) or full localization to other languages than
19734 English, you should definitely consider
19735 \begin_inset Flex Code
19738 \begin_layout Plain Layout
19744 , which exceeds all other packages in terms of features, but is also quite
19745 heavy and more resource-hungry.
19748 \begin_layout Standard
19749 The handling of these packages in \SpecialChar LyX
19750 is basically the same.
19752 \begin_inset Flex Noun
19755 \begin_layout Plain Layout
19756 Document\SpecialChar menuseparator
19763 \begin_inset Flex Noun
19766 \begin_layout Plain Layout
19773 \begin_inset Flex Noun
19776 \begin_layout Plain Layout
19783 \begin_inset Flex Noun
19786 \begin_layout Plain Layout
19793 \begin_inset Flex Noun
19796 \begin_layout Plain Layout
19803 \begin_inset Flex Noun
19806 \begin_layout Plain Layout
19807 Biblatex (Natbib mode)
19813 \begin_inset Flex Noun
19816 \begin_layout Plain Layout
19823 \begin_inset Flex Noun
19826 \begin_layout Plain Layout
19833 \begin_inset space ~
19836 6.5.3 in the User's Guide for more information on these choices).
19837 With all these packages, you will get some extra features in the citation
19838 dialog and you can select the style of the reference (
19839 \begin_inset Quotes eld
19843 \begin_inset Quotes erd
19847 \begin_inset Quotes eld
19851 \begin_inset Quotes erd
19855 \begin_inset Quotes eld
19859 \begin_inset Quotes erd
19863 \begin_inset Quotes eld
19867 \begin_inset Quotes erd
19871 Note that either package needs specifically designed style files.
19872 They all ship their own, but there are lots of additional style files,
19873 and there is even an interactive style file builder
19877 \begin_layout Plain Layout
19879 \begin_inset Flex URL
19882 \begin_layout Plain Layout
19884 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
19895 \begin_inset Flex Code
19898 \begin_layout Plain Layout
19907 \begin_layout Section
19908 Subdivided Bibliographies
19911 \begin_layout Standard
19912 Sometimes you might need to divide your bibliography into several sections.
19913 If you are for instance a historian, the possibility to separate sources
19914 and scientific works is most likely a
19915 \begin_inset Quotes eld
19919 \begin_inset Quotes erd
19923 Unfortunately, Bib\SpecialChar TeX
19924 itself does not allow you to do this.
19925 But with the help of some \SpecialChar LaTeX
19926 packages, Bib\SpecialChar TeX
19927 can be extended to fit your needs.
19930 \begin_layout Standard
19932 provides native support for one of these packages,
19940 \begin_layout Plain Layout
19942 \begin_inset Flex URL
19945 \begin_layout Plain Layout
19947 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
19957 The advantage of this package (compared to other packages such as
19961 ) is that you don't need to define new citation commands.
19962 Instead, you need to prepare different bibliographic databases which include
19963 the entries for the different sections of the bibliography.
19964 For example: If you want to divide your bibliography into the sections
19966 \begin_inset Quotes eld
19970 \begin_inset Quotes erd
19974 \begin_inset Quotes eld
19978 \begin_inset Quotes erd
19981 , you first need to create two bibliographic databases, e.
19982 \begin_inset space \thinspace{}
19986 \begin_inset space \space{}
19990 \begin_inset Flex Code
19993 \begin_layout Plain Layout
20000 \begin_inset Flex Code
20003 \begin_layout Plain Layout
20013 \begin_layout Standard
20015 \begin_inset Flex Noun
20018 \begin_layout Plain Layout
20019 Document\SpecialChar menuseparator
20026 \begin_inset Flex Noun
20029 \begin_layout Plain Layout
20036 \begin_inset Flex Noun
20039 \begin_layout Plain Layout
20040 Subdivided bibliography
20046 Now you can insert multiple Bib\SpecialChar TeX
20047 bibliographies, one for each section of
20049 Returning to our example: Insert the Bib\SpecialChar TeX
20051 \begin_inset Flex Code
20054 \begin_layout Plain Layout
20060 and a second one for the database
20061 \begin_inset Flex Code
20064 \begin_layout Plain Layout
20071 You are free to use the same or different styles for each section.
20072 Additionally, you can choose if the bibliography section should contain
20074 \begin_inset Quotes eld
20077 all cited references
20078 \begin_inset Quotes erd
20081 of the specified database(s) (which is the default),
20082 \begin_inset Quotes eld
20085 all uncited references
20086 \begin_inset Quotes erd
20090 \begin_inset Quotes eld
20094 \begin_inset Quotes erd
20098 This might be useful if you would like to separate your bibliography into
20100 \begin_inset Quotes eld
20104 \begin_inset Quotes erd
20108 \begin_inset Quotes eld
20112 \begin_inset Quotes erd
20116 \begin_inset Quotes eld
20120 \begin_inset Quotes erd
20124 The titles for the sections can be added as ordinary sections or subsections.
20126 \begin_inset Flex Code
20129 \begin_layout Plain Layout
20135 removes the bibliography title, you have to manually re-add that, too (as
20136 a chapter* or section*, for instance).
20139 \begin_layout Standard
20144 , the procedure is a bit different.
20153 , the aforementioned
20154 \begin_inset Flex Noun
20157 \begin_layout Plain Layout
20158 Subdivided bibliography
20163 option is disabled if you use
20172 provides its own means to generate subdivided bibliographies.
20173 You can either add keywords to bibliography entries via the
20174 \begin_inset Flex Code
20177 \begin_layout Plain Layout
20183 entry option and then filter bibliography sections by keyword (by adding
20185 \begin_inset Flex Code
20188 \begin_layout Plain Layout
20195 \begin_inset Flex Noun
20198 \begin_layout Plain Layout
20204 field of the dialog that opens if you left-click on the
20205 \begin_inset Flex Noun
20208 \begin_layout Plain Layout
20209 Biblatex Generated Bibliography
20214 button), or you can filter by entry types (such as
20223 \begin_inset space \thinspace{}
20228 \begin_inset Flex Code
20231 \begin_layout Plain Layout
20238 \begin_inset Flex Code
20241 \begin_layout Plain Layout
20248 \begin_inset Flex Noun
20251 \begin_layout Plain Layout
20257 field, or you can create so-called
20258 \begin_inset Quotes eld
20261 Bibliography Categories
20262 \begin_inset Quotes erd
20265 to which you can assign individual entries.
20266 Please refer to the Biblatex manual, section
20268 Subdivided Bibliographies
20273 \begin_layout Section
20274 Multiple Bibliographies
20275 \begin_inset CommandInset label
20277 name "subsec:Multiple-Bibliographies"
20284 \begin_layout Standard
20285 Multiple bibliographies, e.
20286 \begin_inset space \thinspace{}
20290 \begin_inset space \space{}
20293 a bibliography for each part, chapter, section, subsection or child (sub-documen
20294 t) of the document, are also supported by \SpecialChar LyX
20296 In order to enable it, go to
20297 \begin_inset Flex Noun
20300 \begin_layout Plain Layout
20301 Document\SpecialChar menuseparator
20302 Settings\SpecialChar menuseparator
20308 and select the relevant unit (e.
20309 \begin_inset space \thinspace{}
20313 \begin_inset Quotes eld
20317 \begin_inset Quotes erd
20321 \begin_inset Flex Noun
20324 \begin_layout Plain Layout
20325 Multiple Bibliographies
20331 Then add a Bib(la)\SpecialChar TeX
20332 bibliography to each unit (e.
20333 \begin_inset space \thinspace{}
20336 g., section) of your document.
20337 In the output, a separate bibliography, containing only the references
20338 done in the current unit is generated.
20341 \begin_layout Standard
20342 If you use Bib\SpecialChar TeX
20344 \begin_inset Flex Code
20347 \begin_layout Plain Layout
20354 \begin_inset Flex Code
20357 \begin_layout Plain Layout
20363 package is used to create multiple bibliographies.
20364 The former package is used if you select
20365 \begin_inset Quotes eld
20369 \begin_inset Quotes erd
20377 \begin_inset Flex Noun
20380 \begin_layout Plain Layout
20381 Sectioned Bibliography
20387 In all other cases,
20388 \begin_inset Flex Code
20391 \begin_layout Plain Layout
20401 \begin_layout Plain Layout
20402 An alternative approach, if you are willing to use some
20403 \begin_inset Flex Noun
20406 \begin_layout Plain Layout
20414 \begin_inset space ~
20418 \begin_inset CommandInset ref
20420 reference "sec:Inserting-TeX-Code"
20425 \begin_inset Flex Code
20428 \begin_layout Plain Layout
20440 \begin_inset Flex Code
20443 \begin_layout Plain Layout
20449 is used, \SpecialChar LyX
20450 encloses the specified units in
20451 \begin_inset Flex Code
20454 \begin_layout Plain Layout
20461 \begin_inset Flex Code
20464 \begin_layout Plain Layout
20473 \begin_inset Flex Code
20476 \begin_layout Plain Layout
20484 in order to create the units.
20485 Note that this approach has some limitations.
20486 First, every citation reference has to be inside some
20487 \begin_inset Flex Code
20490 \begin_layout Plain Layout
20497 So citations outside a defined unit (e.
20498 \begin_inset space \thinspace{}
20501 g., before the first section if you use
20502 \begin_inset Quotes eld
20506 \begin_inset Quotes erd
20510 \begin_inset Quotes eld
20514 \begin_inset Quotes erd
20518 You can also create your own units by entering
20519 \begin_inset Flex Code
20522 \begin_layout Plain Layout
20531 \begin_inset Flex Code
20534 \begin_layout Plain Layout
20542 as \SpecialChar TeX
20543 code (for instance to work around the mentioned limitation).
20545 \begin_inset Flex Code
20548 \begin_layout Plain Layout
20554 s cannot be nested.
20555 A second limitation is that
20556 \begin_inset Flex Code
20559 \begin_layout Plain Layout
20565 always processes all references of a bibliography database, even if they
20567 This can result in odd labels (e.
20568 \begin_inset space \thinspace{}
20573 \begin_inset Quotes eld
20577 \begin_inset Quotes erd
20580 if two works of this author from 2014 are in the database, even if only
20584 \begin_layout Standard
20590 \begin_inset Flex Code
20593 \begin_layout Plain Layout
20599 option is used instead.
20600 If you need specific units, you can start them with the \SpecialChar TeX
20602 \begin_inset Flex Code
20605 \begin_layout Plain Layout
20614 \begin_inset Flex Code
20617 \begin_layout Plain Layout
20626 If you also want to control the end of the unit, use the environment
20627 \begin_inset Flex Code
20630 \begin_layout Plain Layout
20640 \begin_inset Flex Code
20643 \begin_layout Plain Layout
20653 \begin_inset Flex Code
20656 \begin_layout Plain Layout
20662 s cannot be nested.
20663 In addition to the individual bibliography of the current unit,
20667 also provides an easy way to output all bibliographies, subsequently, at
20669 \begin_inset space \thinspace{}
20672 g., at the end of the document).
20674 \begin_inset Quotes eld
20677 all reference units
20678 \begin_inset Quotes erd
20681 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
20683 Please refer to the
20687 manual for more information on this topic.
20690 \begin_layout Chapter
20692 \change_deleted 564990737 1671355654
20696 \change_inserted 564990737 1671355667
20698 \change_deleted 564990737 1671355661
20700 \change_inserted 564990737 1671355684
20702 \begin_inset CommandInset label
20704 name "chap:bullets"
20709 \change_deleted 564990737 1671355684
20711 \begin_inset CommandInset label
20722 \begin_layout Standard
20728 \begin_layout Section
20732 \begin_layout Standard
20734 provides 216 bullet shapes that can be accessed from a simple dialog.
20735 Using this dialog you can easily specify what bullet shape to use at each
20736 level of an itemized list.
20737 These settings are document-wide so you won't be able to specify different
20738 sets of bullets for different paragraphs.
20742 \begin_layout Plain Layout
20743 Well, actually you can but you'll have to do it by hand.
20751 \begin_layout Section
20755 \begin_layout Standard
20756 Open the dialog by selecting the
20757 \begin_inset Flex Noun
20760 \begin_layout Plain Layout
20761 Document\SpecialChar menuseparator
20767 menu item and then select the
20768 \begin_inset Flex Noun
20771 \begin_layout Plain Layout
20780 \begin_layout Standard
20781 The dialog provides you with a table of bullet shapes.
20782 A column of buttons on the left of the table provides access to the six
20783 different panels of bullet shapes.
20784 The row of buttons across the top is used to select which bullet depth
20787 \change_deleted 244031559 1603875981
20788 A text entry under the table shows the currently selected bullet shape's
20790 equivalent and this can be edited if desired.
20791 If you do modify the text you will also need to specify any needed packages
20792 in the \SpecialChar LaTeX
20798 \begin_layout Standard
20799 The six panels are divided up by the packages they require.
20800 The following table shows the mappings from button name to \SpecialChar LaTeX
20804 \begin_layout Standard
20806 \begin_inset Tabular
20807 <lyxtabular version="3" rows="7" columns="2">
20808 <features tabularvalignment="middle">
20809 <column alignment="center" valignment="top" width="0pt">
20810 <column alignment="center" valignment="top" width="0pt">
20812 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
20815 \begin_layout Plain Layout
20830 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
20833 \begin_layout Plain Layout
20850 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20853 \begin_layout Plain Layout
20868 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20871 \begin_layout Plain Layout
20880 base \SpecialChar LaTeX
20888 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20891 \begin_layout Plain Layout
20906 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20909 \begin_layout Plain Layout
20926 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20929 \begin_layout Plain Layout
20944 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20947 \begin_layout Plain Layout
20964 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20967 \begin_layout Plain Layout
20982 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20985 \begin_layout Plain Layout
21002 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21005 \begin_layout Plain Layout
21020 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21023 \begin_layout Plain Layout
21040 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21043 \begin_layout Plain Layout
21058 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21061 \begin_layout Plain Layout
21084 \begin_layout Standard
21086 doesn't stop you using bullets from packages you don't have.
21087 If you get errors from \SpecialChar LaTeX
21088 when you try to view or print the file, then it
21089 is likely you are missing a package.
21093 \begin_layout Plain Layout
21095 doesn't restrict your use since you may be editing locally and exporting
21104 \begin_layout Section
21108 \begin_layout Standard
21109 Select which bullet depth you want to change then select the bullet shape
21111 Any changes will not be visible in \SpecialChar LyX
21112 , but are visible when viewing the document.
21115 \begin_layout Standard
21116 You can reset a bullet shape to the default simply by clicking your right
21117 mouse button on the appropriate bullet depth button.
21121 \begin_layout Plain Layout
21123 \change_inserted 564990737 1672138075
21124 \begin_inset CommandInset label
21126 name "fn:If-you-really"
21136 want to have multiple sets of paragraphs with different sets of bullets
21137 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
21139 The bullet selection dialog can help though because it provides you with
21140 the \SpecialChar LaTeX
21141 code for a wide range of bullet shapes.
21142 To make your own custom paragraphs you have the following options:
21145 \begin_layout Plain Layout
21149 \begin_layout Plain Layout
21165 \begin_layout Plain Layout
21169 \begin_layout Plain Layout
21191 \begin_layout Itemize
21192 Use the \SpecialChar LaTeX
21194 \begin_inset Flex Code
21197 \begin_layout Plain Layout
21205 to specify a new bullet shape for a given depth.
21206 You'll also need to save the current bullet shape so you can restore it
21208 In this itemized list the following \SpecialChar LaTeX
21209 code was used to change the bullet
21210 used for the first depth.
21214 \begin_layout LyX-Code
21224 \begin_layout LyX-Code
21241 \begin_layout Itemize
21242 Note that the itemize depth is specified in Roman numerals as part of the
21252 \begin_layout Itemize
21253 \begin_inset Argument item:1
21256 \begin_layout Plain Layout
21260 \begin_layout Plain Layout
21278 Specify each individual entry by starting each item with the bullet shape
21280 \begin_inset Quotes eld
21284 \begin_inset Quotes erd
21287 inset (available at
21289 Insert\SpecialChar menuseparator
21293 \begin_inset Flex Noun
21296 \begin_layout Plain Layout
21304 For example, this item was started with
21305 \begin_inset Flex Code
21308 \begin_layout Plain Layout
21323 \begin_layout Plain Layout
21327 \begin_layout Plain Layout
21343 \begin_layout Plain Layout
21344 You'll also need to revert the labelitem back to its previous setting for
21345 the global bullet shape settings to remain in effect.
21346 The way used here was:
21349 \begin_layout LyX-Code
21364 \begin_layout Chapter
21368 \begin_layout Section
21369 Multipart Documents
21372 \begin_layout Subsection
21376 \begin_layout Standard
21377 When you are working on a large file with many sections, it is often convenient
21378 to break up the document into several files, or perhaps you have something
21379 where a table may change from time to time, but the preceding text does
21381 In these cases, you should seriously consider using multipart documents.
21382 For example, scientific papers often have five major sections: the introduction
21383 , observations, results, discussion, and conclusion.
21384 Each of these could be its own separate \SpecialChar LyX
21386 \begin_inset Quotes eld
21390 \begin_inset Quotes erd
21393 file which contains the title, authors, abstract, references, etc., plus
21394 the five included files.
21395 It is important to note that each of these files is a full \SpecialChar LyX
21397 can be formatted and printed on its own, as well as included in a master
21399 Each of these files must have the same document class, however—don't attempt
21400 to mix book classes with article classes.
21401 You may also include \SpecialChar LaTeX
21402 files; however, these files must not have their own
21404 \begin_inset space \thinspace{}
21408 \begin_inset space \space{}
21411 everything up to and including the
21412 \begin_inset Flex Code
21415 \begin_layout Plain Layout
21423 line as well as the
21424 \begin_inset Flex Code
21427 \begin_layout Plain Layout
21435 line must be deleted) or else errors will be generated when you try to
21439 \begin_layout Standard
21441 allows you to include files quite easily with
21442 \begin_inset Flex Noun
21445 \begin_layout Plain Layout
21446 Insert\SpecialChar menuseparator
21448 \begin_inset space ~
21457 When you click on this selection a small box is inserted into the file
21458 at the current cursor location.
21459 Clicking on the box raises a dialog which allows you to select the file
21460 to be included, and the method of its inclusion.
21464 \begin_layout Standard
21465 The file selection box should by now be obvious.
21466 The three inclusion methods are
21467 \begin_inset Quotes eld
21471 \begin_inset Quotes erd
21475 \begin_inset Quotes eld
21479 \begin_inset Quotes erd
21483 \begin_inset Quotes eld
21487 \begin_inset Quotes erd
21492 \begin_inset Quotes eld
21496 \begin_inset Quotes erd
21500 \begin_inset Quotes eld
21504 \begin_inset Quotes erd
21507 are similar in many ways, but there are also some notable differences:
21510 \begin_layout Enumerate
21512 \begin_inset Quotes eld
21516 \begin_inset Quotes erd
21519 are typeset beginning on a new page, while files that are
21520 \begin_inset Quotes eld
21524 \begin_inset Quotes erd
21527 are typeset starting on the current page.
21530 \begin_layout Enumerate
21531 \begin_inset Quotes eld
21535 \begin_inset Quotes erd
21538 files cannot themselves
21539 \begin_inset Quotes eld
21543 \begin_inset Quotes erd
21547 \begin_inset Quotes eld
21551 \begin_inset Quotes erd
21556 \begin_inset Quotes eld
21560 \begin_inset Quotes erd
21563 , on the other hand, infinite sub-inputting is possible.
21566 \begin_layout Enumerate
21567 \begin_inset Quotes eld
21571 \begin_inset Quotes erd
21574 allow for the output of only selected
21575 \begin_inset Quotes eld
21579 \begin_inset Quotes erd
21582 files, while maintaining the actual counters (pagination etc.) and references
21583 (please refer to the section
21586 \begin_inset space ~
21594 \begin_inset space ~
21599 manual for details).
21602 \begin_layout Standard
21604 \begin_inset Quotes eld
21608 \begin_inset Quotes erd
21611 is the preferred method for chapters that are outsourced to child documents,
21613 \begin_inset Quotes eld
21617 \begin_inset Quotes erd
21620 is more suitable for arbitrary file inheritance.
21623 \begin_layout Standard
21625 \begin_inset Quotes eld
21629 \begin_inset Quotes erd
21632 included file allows you to include a file typeset exactly as it appears
21634 \begin_inset space \thinspace{}
21638 \begin_inset space \space{}
21642 \begin_inset Flex Code
21645 \begin_layout Plain Layout
21651 mode, with the characters set in a fixed-width typewriter font.
21652 Normally, spaces in this file are invisible, though two consecutive spaces
21653 are conserved, unlike \SpecialChar LyX
21654 's normal treatment of spaces.
21655 However, setting the
21656 \begin_inset Flex Noun
21659 \begin_layout Plain Layout
21661 \begin_inset space ~
21665 \begin_inset space ~
21669 \begin_inset space ~
21677 checkbox typesets a mark to unambiguously define the presence of a space.
21681 \begin_layout Standard
21682 Generally, the master file is converted into a full \SpecialChar LaTeX
21683 file before typesetting,
21684 while the included files are converted to \SpecialChar LaTeX
21685 files that do not have all the
21686 preamble information.
21689 \begin_layout Subsection
21690 Cross-References Between Files
21693 \begin_layout Standard
21694 \begin_inset Box Shadowbox
21704 height_special "totalheight"
21709 backgroundcolor "none"
21712 \begin_layout Plain Layout
21713 This section is somewhat out of date.
21714 Need to describe default master documents and how children are opened when
21724 \begin_layout Standard
21725 It is possible to set up cross-references between the different files.
21726 First, open all the files in question: let's call them A and B in a two
21727 file example, where B is included in A.
21728 Let's say you insert a label in A, then want to reference it in B.
21729 Open the cross-reference dialog whilst in document B, and you can select
21731 \begin_inset Quotes eld
21735 \begin_inset Quotes erd
21741 \begin_layout Subsection
21742 Bibliography Lists in all Subdocuments
21745 \begin_layout Standard
21746 If you work with child documents, you might want to have only one main bibliogra
21747 phy at the end, but still be able to have a selected bibliography for the
21748 child if you output it on its own.
21749 Here is how to achieve this.
21752 \begin_layout Standard
21753 For the main document, you just insert a bibliography inset at the place
21754 where the main bibliography has to appear (within the master file or within
21756 If the bibliography inset is in the master file, the references will be
21757 inherited by all children, so they are available in the citation dialog
21761 \begin_layout Standard
21762 For child-specific bibliographies, insert bibliography insets within the
21763 child documents, at the place where the bibliography should appear when
21764 the child is compiled separately.
21765 However, the trick is to insert them into a branch (
21767 Insert\SpecialChar menuseparator
21768 Branch\SpecialChar menuseparator
21769 Insert New Branch...
21772 \begin_inset space \thinspace{}
21777 \begin_inset Quotes eld
21781 \begin_inset Quotes erd
21785 Within the children, activate the branch (
21787 Document\SpecialChar menuseparator
21788 Settings...\SpecialChar menuseparator
21792 Within the master, deactivate the branch (
21794 Document\SpecialChar menuseparator
21795 Settings...\SpecialChar menuseparator
21799 Now the child's bibliography will be ignored by the master, but considered
21803 \begin_layout Standard
21804 If you need multiple bibliographies (e.
21805 \begin_inset space \thinspace{}
21808 g., one per child in the
21812 ), please refer to sec.
21813 \begin_inset space ~
21817 \begin_inset CommandInset ref
21819 reference "subsec:Multiple-Bibliographies"
21826 \begin_layout Section
21831 \begin_layout Standard
21832 Users sometimes need to be able to
21833 \begin_inset Quotes eld
21837 \begin_inset Quotes erd
21841 file together with all the images (and other files) on which it depends,
21842 either for sending to a publisher or for sharing with a co-author.
21844 includes a Python script (
21845 \begin_inset Flex Code
21848 \begin_layout Plain Layout
21854 ) that automates this process.
21855 To use it, you must have either the
21856 \begin_inset Flex Code
21859 \begin_layout Plain Layout
21866 \begin_inset Flex Code
21869 \begin_layout Plain Layout
21875 python modules installed on your system.
21876 By default, the script prefers the
21877 \begin_inset Flex Code
21880 \begin_layout Plain Layout
21887 \begin_inset Flex Code
21890 \begin_layout Plain Layout
21896 format on Unix-like systems and the
21897 \begin_inset Flex Code
21900 \begin_layout Plain Layout
21909 \begin_layout Standard
21911 's configuration process will set the script up to export a `\SpecialChar LyX
21913 and this format will then be available under
21914 \begin_inset Flex Code
21917 \begin_layout Plain Layout
21918 File\SpecialChar menuseparator
21927 \begin_layout Standard
21928 Independently of the platform, the generation of a particular archive format
21929 can be forced by adding either the
21930 \begin_inset Flex Code
21933 \begin_layout Plain Layout
21940 \begin_inset Flex Code
21943 \begin_layout Plain Layout
21950 \begin_inset Flex Code
21953 \begin_layout Plain Layout
21960 \begin_inset Flex Code
21963 \begin_layout Plain Layout
21969 format) switch to the
21970 \begin_inset Flex Code
21973 \begin_layout Plain Layout
21975 \SpecialChar menuseparator
21983 \begin_inset Flex Code
21986 \begin_layout Plain Layout
21987 Tools\SpecialChar menuseparator
21988 Preferences\SpecialChar menuseparator
21989 File Handling\SpecialChar menuseparator
21996 (Make sure you add the switch after the script name, not before it.)
21999 \begin_layout Section
22000 Fancy Headers and Footers
22003 \begin_layout Standard
22004 The default page layout is rather plain; for an
22005 \begin_inset Flex Code
22008 \begin_layout Plain Layout
22014 document class, all you get is a centered page number at the bottom of
22016 This document uses KOMA-script's book class, so it appears to be a bit
22018 But to really put on a show, you need to set the document page style to
22020 \begin_inset Quotes eld
22024 \begin_inset Quotes erd
22027 , as mentioned in the
22032 This section describes the \SpecialChar LaTeX
22033 code you need to insert in your \SpecialChar LaTeX
22035 order to get the desired effects.
22038 \begin_layout Standard
22039 For more information on fancy headers, see the
22040 \begin_inset Flex Code
22043 \begin_layout Plain Layout
22049 package documentation.
22051 \begin_inset Flex URL
22054 \begin_layout Plain Layout
22056 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
22064 \begin_layout Standard
22065 The page header is divided into three fields, not surprisingly labeled
22066 \begin_inset Quotes eld
22070 \begin_inset Quotes erd
22074 \begin_inset Quotes eld
22078 \begin_inset Quotes erd
22082 \begin_inset Quotes eld
22086 \begin_inset Quotes erd
22090 The footer is also divided into these three fields.
22091 The \SpecialChar LaTeX
22092 commands to set these fields in the simplest manner are
22093 \begin_inset Flex Code
22096 \begin_layout Plain Layout
22105 \begin_inset Flex Code
22108 \begin_layout Plain Layout
22117 \begin_inset Flex Code
22120 \begin_layout Plain Layout
22129 \begin_inset Flex Code
22132 \begin_layout Plain Layout
22141 Suppose you wish to put your name in the upper left hand corner of each
22143 Simply insert the following command in the preamble:
22146 \begin_layout Standard
22155 \begin_layout Standard
22156 You will now see your name in the upper left.
22157 If a field has a default entry that you would like to get rid of (often
22158 the page number appears in the central footer) simply include a command
22159 with a blank argument, e.
22160 \begin_inset space \thinspace{}
22166 \begin_layout Standard
22174 \begin_layout Standard
22175 Let's get really fancy: lets put the section number with the word
22176 \begin_inset Quotes eld
22180 \begin_inset Quotes erd
22184 \begin_inset space \thinspace{}
22188 \begin_inset space \space{}
22191 Section 3) in the upper left, the page number (e.
22192 \begin_inset space \thinspace{}
22196 \begin_inset space \space{}
22199 Page 4) in the upper right, your name in the lower left, and the date in
22201 The following commands should now appear in the preamble:
22204 \begin_layout Standard
22214 \begin_layout Standard
22222 \begin_layout Standard
22232 \begin_layout Standard
22241 \begin_layout Standard
22249 \begin_layout Standard
22259 \begin_layout Standard
22261 \begin_inset Flex Code
22264 \begin_layout Plain Layout
22273 \begin_inset Flex Code
22276 \begin_layout Plain Layout
22284 access \SpecialChar LaTeX
22285 's section and page counters, and so print out the current section
22288 \begin_inset Flex Code
22291 \begin_layout Plain Layout
22299 simply prints out today's date.
22302 \begin_layout Standard
22303 The thicknesses of the horizontal rules drawn beneath the header and above
22304 the footer can also be modified.
22305 If you don't want one of the rules, set its thickness to 0.
22306 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
22312 \begin_inset Flex Code
22315 \begin_layout Plain Layout
22320 headrulewidth}{0.4pt}
22326 \begin_inset Flex Code
22329 \begin_layout Plain Layout
22334 footrulewidth}{0.4pt}
22339 to set the thicknesses.
22342 \begin_layout Standard
22343 You can switch the header/footer settings on and off for individual pages
22344 using commands like
22345 \begin_inset Flex Code
22348 \begin_layout Plain Layout
22351 thispagestyle{empty}
22357 \begin_inset Flex Code
22360 \begin_layout Plain Layout
22363 thispagestyle{plain}
22369 \begin_inset Flex Code
22372 \begin_layout Plain Layout
22375 thispagestyle{fancy}
22381 Simply insert them in the text on the page you want changed and mark them
22382 as \SpecialChar TeX
22384 In fact, title pages are marked as plain by default, while following pages
22385 are marked fancy when using the global fancy setting.
22388 \begin_layout Standard
22389 As a final example, it is possible to include an image in the header or
22391 Suppose you want to put a company logo in the upper lefthand corner.
22392 You might try something like
22395 \begin_layout Standard
22404 includegraphics{logo.eps}}}
22407 \begin_layout Standard
22409 (you may need to preface this with
22410 \begin_inset Flex Code
22413 \begin_layout Plain Layout
22416 usepackage{graphics}
22421 if you don't include graphics elsewhere in your document).
22424 \begin_layout Chapter
22426 and the World Wide Web
22429 \begin_layout Standard
22431 has long supported the export of documents to various web-friendly formats,
22433 Before version 2.0, however, HTML export was always accomplished by the
22434 use of external converters.
22438 \begin_layout Plain Layout
22439 For details on the use of external converters with \SpecialChar LyX
22444 section of the Customization manual.
22449 These fall into two large groups: there are converters that use \SpecialChar LaTeX
22451 intermediate format, such as
22452 \begin_inset Flex Code
22455 \begin_layout Plain Layout
22462 \begin_inset Flex Code
22465 \begin_layout Plain Layout
22472 \begin_inset Flex Code
22475 \begin_layout Plain Layout
22481 , relying upon \SpecialChar LyX
22482 to produce the \SpecialChar LaTeX
22483 ; and there is a converter that works directly
22484 on \SpecialChar LyX
22486 \begin_inset Flex Code
22489 \begin_layout Plain Layout
22497 All of these have different advantages and disadvantages.
22501 \begin_layout Standard
22502 The \SpecialChar LaTeX
22503 -based converters have the advantage that, in principle, they know everythin
22504 g about the exported document that \SpecialChar LaTeX
22506 Such converters do not care, for example, if a certain block of code was
22507 produced by \SpecialChar LyX
22508 or was Evil Red Text.
22509 These converters know about
22510 \begin_inset Flex Code
22513 \begin_layout Plain Layout
22519 files, counters, and references, and can often make use of the
22520 \begin_inset Flex Code
22523 \begin_layout Plain Layout
22529 files generated by Bib\SpecialChar TeX
22531 On the other hand, \SpecialChar LaTeX
22532 is a very hard language to parse—it is sometimes said
22533 that only \SpecialChar TeX
22534 itself understands \SpecialChar TeX
22535 —and \SpecialChar LaTeX
22536 -based converters will often choke on
22537 what seem to be quite simple constructs; complex ones can throw them completely
22538 , and as of this writing, for example, the
22542 manual will not export with
22543 \begin_inset Flex Code
22546 \begin_layout Plain Layout
22552 , though the others will.
22553 The other issue concerns how math is handled.
22554 These converters typically convert the formulae into little pictures that
22555 are then linked from the HTML document.
22556 Since these are actually generated by \SpecialChar LaTeX
22557 , they are accurate.
22558 But they do not scale well, and just getting them to look as if they are
22559 actually meant to be in your document—so that the font sizes seem to be
22560 roughly the same—can be a challenge.
22563 \begin_layout Standard
22565 \begin_inset Flex Code
22568 \begin_layout Plain Layout
22576 \begin_inset CommandInset href
22578 name "http://pinchito.es/elyxer/"
22579 target "http://pinchito.es/elyxer/"
22584 ) solves some of these problems.
22585 In particular, the formulae it produces scale perfectly, since it renders
22586 math using a combination of HTML and CSS rather than converting the formulae
22588 But even moderately complex formula are rendered less well than with
22589 \begin_inset Flex Code
22592 \begin_layout Plain Layout
22598 ; this reflects the limitations of HTML.
22602 \begin_layout Plain Layout
22604 \begin_inset Flex Code
22607 \begin_layout Plain Layout
22614 can also use jsMath and MathJax for equations, but this setting is only
22615 available globally and requires one to have access to a server that runs
22621 More importantly (as of version 1.1.1, at least),
22622 \begin_inset Flex Code
22625 \begin_layout Plain Layout
22632 has limited support for math macros and no support for user-defined paragraph
22633 or character styles.
22634 These limitations make
22635 \begin_inset Flex Code
22638 \begin_layout Plain Layout
22645 unsuitable for many of the documents \SpecialChar LyX
22647 In principle, of course, these problems could be solved, but the \SpecialChar LyX
22649 have decided to follow a different path and have made \SpecialChar LyX
22651 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
22652 , DocBook, and plaintext.
22655 \begin_layout Standard
22656 As of this writing, XHTML output remains under development and should probably
22658 \begin_inset Quotes eld
22662 \begin_inset Quotes erd
22669 \begin_layout Plain Layout
22671 \begin_inset Flex Code
22674 \begin_layout Plain Layout
22675 development/HTML/HTML.notes
22680 , which can be found in the \SpecialChar LyX
22682 \begin_inset CommandInset href
22684 name "accessed online"
22685 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
22690 , usually contains up-to-date information about the state of XHTML output.
22691 See also the list of XHTML bugs on
22692 \begin_inset CommandInset href
22694 name "the bug tracker"
22695 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"
22705 Still, the developers have chosen this approach because it has several
22706 potential advantages over the other two.
22709 \begin_layout Standard
22710 These advantages are primarily due to the fact that the XHTML output routines,
22711 since they are part of \SpecialChar LyX
22712 , know everything \SpecialChar LyX
22713 knows about the document being
22718 \begin_layout Plain Layout
22719 Another advantage is that, since these routines are internal to \SpecialChar LyX
22721 immune to changes in \SpecialChar LyX
22722 's file format, or to changes in the semantics of
22728 So they know about the table of contents (as displayed in the outline),
22729 about the counters associated with different paragraph styles, and about
22730 user-defined styles.
22731 The XHTML output routines know what \SpecialChar LyX
22732 knows about internationalization,
22733 too, so they will output
22734 \begin_inset Quotes eld
22738 \begin_inset Quotes erd
22742 \begin_inset Quotes eld
22750 \begin_inset Quotes erd
22753 , depending upon the language in effect at the time.
22757 \begin_layout Standard
22758 Quite generally, the output routines know what \SpecialChar LyX
22759 knows about document layout,
22760 that is, about how the document is to be rendered on screen.
22761 We use this information when we output the document as XHTML.
22762 In particular, \SpecialChar LyX
22767 generates CSS style information corresponding to the layout information
22768 it uses to render the document on screen: if section headings are supposed
22769 to be sans-serif and bold as seen in \SpecialChar LyX
22770 , then (by default) they will be sans-seri
22771 f and bold when viewed in a web browser, too.
22772 And this is true not just for pre-defined styles, like Section, but for
22773 any style, including user-defined styles.
22774 Indeed, the XHTML output routines make no distinction between user-defined
22776 \change_deleted 244031559 1603876931
22778 \change_inserted 244031559 1603876940
22781 styles and \SpecialChar LyX
22782 's own pre-defined styles: in each case, everything \SpecialChar LyX
22784 the styles is contained in the layout files.
22785 And much the same is true as regards pre-defined textual insets, such as
22786 footnotes, and various custom insets.
22790 \begin_layout Standard
22791 The result is that XHTML output can be customized and extended in exactly
22792 the same way \SpecialChar LaTeX
22793 output can be customized and extended: through layout files
22795 See chapter five of the
22799 manual for the details.
22802 \begin_layout Standard
22803 The remainder of this chapter contains more detailed information on XHTML
22804 output, its limitations, and ways to work around those limitations.
22807 \begin_layout Section
22808 Math Output in XHTML
22811 \begin_layout Standard
22813 offers four choices for how math is rendered.
22814 These have various advantages and disadvantages:
22817 \begin_layout Itemize
22819 \begin_inset Newline newline
22822 MathML is a dialect of XML designed specifically for mathematics on the
22823 web, and it typically renders very well in browsers that support it.
22824 The disadvantage is that not all browsers support MathML, and support is
22825 not complete even in the Gecko-based browsers, such as Firefox.
22826 \begin_inset Newline newline
22829 If \SpecialChar LyX
22830 is unable to render a formula as MathML—for example, if the formula
22832 \begin_inset Flex Code
22835 \begin_layout Plain Layout
22841 package or ERT—then it will instead output the formula as an image.
22845 \begin_layout Itemize
22847 \begin_inset Newline newline
22850 As mentioned above,
22851 \begin_inset Flex Code
22854 \begin_layout Plain Layout
22860 outputs math as HTML, styled by CSS.
22864 \begin_layout Plain Layout
22866 has borrowed some of the CSS for its HTML output from
22867 \begin_inset Flex Code
22870 \begin_layout Plain Layout
22881 For simple formulae, this can work quite well, though with more complicated
22882 formulae it tends to break down.
22883 Still, this method has the advantage that it is very widely supported and
22884 so it may be appropriate for documents that contain only a little, fairly
22886 \begin_inset Newline newline
22889 If Lyx is unable to render a formula as HTML—for example, if the formula
22891 \begin_inset Flex Code
22894 \begin_layout Plain Layout
22900 package or ERT—then it will instead output the formula as an image.
22904 \begin_layout Itemize
22906 \begin_inset Newline newline
22910 \begin_inset Flex Code
22913 \begin_layout Plain Layout
22920 will output formulae as images, the very same images, in fact, that are
22921 used for instant preview.
22925 \begin_layout Plain Layout
22926 Instant preview does
22930 have to be on for images to be output, however.
22935 The advantage to this method is that the images are simply generated by
22937 , so they are very accurate.
22938 The disadvantage, as mentioned earlier, is that these are bitmapped images,
22939 so they do not scale terribly well, and one cannot copy them, etc.
22940 \begin_inset Newline newline
22943 The size of the images can be controlled by setting the
22944 \begin_inset Quotes eld
22947 Math Images Scaling
22948 \begin_inset Quotes erd
22952 \begin_inset Flex Noun
22955 \begin_layout Plain Layout
22956 Document\SpecialChar menuseparator
22957 Settings\SpecialChar menuseparator
22967 \begin_layout Plain Layout
22968 For those who want to know, this controls the resolution of the image in
22969 dots per inch and is based upon a default of 75 dpi.
22975 \begin_inset Newline newline
22978 If \SpecialChar LyX
22979 for some reason fails to create an image for a formula (e.g., if a required
22981 package is not installed), then it will fall back to outputing the raw
22986 \begin_layout Itemize
22989 \begin_inset Newline newline
22992 Finally, \SpecialChar LyX
22993 will happily output math as \SpecialChar LaTeX
22995 As well as being the output of last resort, this method can be used with
22997 \begin_inset CommandInset href
23000 target "http://www.math.union.edu/~dpvc/jsMath/"
23005 , which uses JavaScript to render \SpecialChar LaTeX
23006 embedded in HTML documents.
23008 wraps the \SpecialChar LaTeX
23010 \begin_inset Flex Code
23013 \begin_layout Plain Layout
23019 (for inline formulas) or
23020 \begin_inset Flex Code
23023 \begin_layout Plain Layout
23029 (for displayed formulas) with
23030 \begin_inset Flex Code
23033 \begin_layout Plain Layout
23039 , as is required for jsMath.
23042 \begin_layout Standard
23043 One of these output methods must be selected under
23044 \begin_inset Flex Noun
23047 \begin_layout Plain Layout
23048 Document\SpecialChar menuseparator
23049 Settings\SpecialChar menuseparator
23056 By default, \SpecialChar LyX
23058 This is a document-wide setting, therefore.
23061 \begin_layout Standard
23062 Eventually, \SpecialChar LyX
23063 will offer the user the option to select an alternate output
23064 method for a particular inset, say, one that isn't being rendered very
23069 \begin_layout Plain Layout
23070 That said, since \SpecialChar LyX
23071 falls back to images if the inset contains ERT, then one
23072 can force output as an image by putting some harmless ERT into the math,
23074 \begin_inset Formula $a=b\relax$
23085 \begin_layout Section
23086 Bibliography and Citations
23089 \begin_layout Standard
23090 XHTML output fully supports bibliographies and citations.
23094 \begin_layout Standard
23095 Citation labels are generated by the same machinery that generates \SpecialChar LyX
23097 labels, so the labels will look in the output much as they do in \SpecialChar LyX
23100 If you are using numerical citations, then \SpecialChar LyX
23101 will output numerical labels,
23102 such as [1] or [17], rather than simply showing the citation key in square
23103 brackets, as it does on-screen.
23104 If you are using author-year citations, then \SpecialChar LyX
23105 will add lowercase letters
23106 to the years, just as Bib\SpecialChar TeX
23107 does, if it finds more than one citation for
23108 a given author-year combination.
23109 The labels will be printed with the bibliography entries.
23110 Note that there is, at present, no way to customize the appearance of the
23111 labels, for example, to choose between square brackets and parentheses.
23114 \begin_layout Standard
23115 Bibliography output is handled by the same machinery that handles the presentati
23116 on of reference information in the citation dialog, so you will see in the
23117 XHTML output pretty much what you would see if you were to look at a given
23118 entry in the citation dialog.
23119 The formatting can be customized in your layout file or, preferably, in
23125 manual for the details.
23128 \begin_layout Standard
23129 The main defect at present is that cross-referenced information is printed
23130 with every entry with which it is associated.
23131 So you can see things like this:
23134 \begin_layout Quote
23136 \begin_inset Quotes eld
23139 Context and Logical Form
23140 \begin_inset Quotes erd
23145 Language in Context: Selected Essays
23147 (Oxford: Oxford University Press, 2007), pp.
23151 \begin_layout Quote
23153 \begin_inset Quotes eld
23156 Semantics in Context
23157 \begin_inset Quotes erd
23162 Language in Context: Selected Essays
23164 (Oxford: Oxford University Press, 2007), pp.
23168 \begin_layout Standard
23169 This should be fixed before long.
23172 \begin_layout Standard
23173 There is no support at present for sectioned bibliographies.
23174 If you have multiple bibliographies, then \SpecialChar LyX
23175 will print the same bibliography
23179 \begin_layout Section
23183 \begin_layout Standard
23185 will happily export indexes as XHTML, but with certain limitations at the
23189 \begin_layout Standard
23190 Index export will be most reliable when you do not attempt to use the fancy
23191 constructs that are described in the section on indexes in the
23199 \begin_layout Plain Layout
23200 The main issue here is that \SpecialChar LyX
23201 itself does not really handle these.
23202 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
23208 We'll describe how they are handled using the subsection headings from
23212 \begin_layout Itemize
23213 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
23214 makes an effort to support these,
23215 but the entries must be separated by
23216 \begin_inset Quotes eld
23220 \begin_inset Quotes erd
23223 , that is, there must be spaces around the exclamation point.
23224 This is because it is otherwise too difficult to check for escaped exclamation
23225 points, ones in math, and so forth.
23228 \begin_layout Itemize
23229 Page Ranges: There is no support at all for page ranges, since these make
23230 no sense with XHMTL.
23231 Instead, you will just get two index entries, one at either end.
23234 \begin_layout Itemize
23235 Cross-referencing: There is no support for cross-referencing.
23236 If \SpecialChar LyX
23237 finds an entry containing the
23238 \begin_inset Quotes eld
23241 |see\SpecialChar ldots
23243 \begin_inset Quotes erd
23246 construct, it is just dropped, and the rest is treated as an ordinary index
23250 \begin_layout Itemize
23251 Index Entry Order: \SpecialChar LyX
23252 does support attempts to fix the sorting order.
23253 It will take what is before the first `@' it finds and use that for sorting,
23254 taking what follows the first `@' to be the actual entry.
23255 At present, \SpecialChar LyX
23256 does not check for escaped `@', so do not try to index email
23260 \begin_layout Itemize
23261 Index Entry Layout: You can format entries by using the text style dialog,
23262 or by using any other method available within \SpecialChar LyX
23264 There is no support for constructs like:
23265 \begin_inset Quotes eld
23269 \begin_inset Quotes erd
23273 Indeed, if \SpecialChar LyX
23274 finds a pipe symbol, `|', in an entry, it will delete it and
23275 everything that follows it.
23278 \begin_layout Itemize
23279 Multiple Indexes: There is no support for multiple indexes.
23280 Rather, all index entries will be printed as one large index.
23281 To avoid our printing several versions of the index, we print only the
23282 main index, so make sure you have one.
23285 \begin_layout Section
23286 Nomenclature and Glossary
23289 \begin_layout Standard
23290 There is at present no support for glossaries.
23291 Adding it would be fairly trivial, and welcome.
23294 \begin_layout Chapter
23296 \change_inserted 1075283030 1616534180
23300 \begin_layout Standard
23302 \change_inserted 1075283030 1616534386
23303 Apart from HTML, \SpecialChar LyX
23304 can generate documents in the DocBook XML vocabulary.
23305 With versions 2.3 and before, only select templates could be used to generate
23306 DocBook documents (only version 4).
23307 Starting with \SpecialChar LyX
23308 2.4, most \SpecialChar LyX
23309 layouts can generate valid DocBook documents (only
23311 This feature is built into \SpecialChar LyX
23312 and does not require the use of external tools.
23315 \begin_layout Standard
23317 \change_inserted 1075283030 1616534437
23318 The result is that the DocBook output can be customized and extended in
23319 exactly the same way \SpecialChar LaTeX
23320 output can be customized and extended: through layout
23322 See chapter five of the
23326 manual for the details.
23329 \begin_layout Standard
23331 \change_inserted 1075283030 1616534475
23332 Most \SpecialChar LyX
23333 features are supported with DocBook, like math output.
23336 \begin_layout Itemize
23338 \change_inserted 1075283030 1616534741
23339 Math output is performed mostly in MathML (the major exception being constructio
23340 ns not supported by \SpecialChar LyX
23343 All formulae are also available in raw \SpecialChar TeX
23344 in the DocBook output for further
23348 \begin_layout Itemize
23350 \change_inserted 1075283030 1616534852
23351 Bibliographies and citations are implemented, including with an external
23353 Bibliography entries are not prerendered when the detailed information
23354 are available, but rather output with the standard DocBook constructs.
23355 The external DocBook processor is expected to handle the rendering of entries.
23358 \begin_layout Itemize
23360 \change_inserted 1075283030 1616534863
23361 Indexes are supported, including multiple indices.
23366 ), page ranges, and cross-references (
23370 ) are supported, with the exception of the same symbols escaped.
23379 ) are not supported.
23380 There is no support for escaping of index entries.
23383 \begin_layout Itemize
23385 \change_inserted 1075283030 1616534884
23386 Glossaries are implemented.
23389 \begin_layout Standard
23391 \change_inserted 1075283030 1616534894
23392 Two major parameters can be set at the document level.
23395 \begin_layout Itemize
23397 \change_inserted 1075283030 1616534948
23398 Format for tables: \SpecialChar LyX
23399 can generate tables either as HTML (default value) or
23400 CALS, depending on the user's requirements.
23401 Most DocBook processors accept both formats.
23404 \begin_layout Itemize
23406 \change_inserted 1075283030 1616535006
23407 MathML prefix: in DocBook, MathML is included within its own name space,
23409 The implication is that there must be an indication of the tags belonging
23410 to the MathML standard.
23411 Three choices are offered:
23415 \begin_layout Itemize
23417 \change_inserted 1075283030 1616535044
23418 Inline: the MathML name space is defined for each formula (using the
23422 attribute on each formula)
23425 \begin_layout Itemize
23427 \change_inserted 1075283030 1616535090
23432 prefix (default): the MathML name space is defined at the document level
23437 attribute on the root element).
23438 Each MathML is prefixed with
23447 \begin_layout Itemize
23449 \change_inserted 1075283030 1616620405
23454 prefix: similar to the
23463 \begin_layout Standard
23465 \change_inserted 1075283030 1616620470
23466 This option is especially useful if you want \SpecialChar LyX
23467 to match your personal style
23468 or to work with buggy software that only accepts one prefix for MathML.
23474 \begin_layout Chapter
23475 The \SpecialChar LyX
23479 \begin_layout Section
23483 \begin_layout Standard
23484 The `\SpecialChar LyX
23485 server' allows other programs to talk to \SpecialChar LyX
23486 , invoke \SpecialChar LyX
23487 commands, and retrieve
23488 information about the \SpecialChar LyX
23490 This is only intended for advanced users, but they should find it useful.
23491 It is by writing to the \SpecialChar LyX
23492 server, for example, that bibliography managers,
23493 such as JabRef, are able to
23494 \begin_inset Quotes eld
23498 \begin_inset Quotes erd
23501 citations to \SpecialChar LyX
23505 \begin_layout Section
23506 Starting the \SpecialChar LyX
23508 \begin_inset CommandInset label
23510 name "sec:Starting-the-Server"
23517 \begin_layout Standard
23518 The \SpecialChar LyX
23519 server works through the use of a pair of named pipes.
23520 These are usually located in
23521 \begin_inset Flex Code
23524 \begin_layout Plain Layout
23530 , (except on Windows, where
23534 named pipes are special objects located in
23535 \begin_inset Flex Code
23538 \begin_layout Plain Layout
23550 ) and have the names
23551 \begin_inset Quotes eld
23555 \begin_inset Flex Code
23558 \begin_layout Plain Layout
23565 \begin_inset Quotes erd
23569 \begin_inset Quotes eld
23573 \begin_inset Flex Code
23576 \begin_layout Plain Layout
23583 \begin_inset Quotes erd
23587 External programs write into
23588 \begin_inset Flex Code
23591 \begin_layout Plain Layout
23597 and read back data from
23598 \begin_inset Flex Code
23601 \begin_layout Plain Layout
23608 The stem of the pipe names can be defined in the
23609 \begin_inset Flex Noun
23612 \begin_layout Plain Layout
23613 Tools\SpecialChar menuseparator
23619 dialog, for example
23620 \begin_inset Flex Code
23623 \begin_layout Plain Layout
23624 "/home/myhome/lyxpipe"
23630 \begin_inset Flex Code
23633 \begin_layout Plain Layout
23647 on Windows (where any working path instead of lyxpipe can be used, for
23649 \begin_inset Flex Code
23652 \begin_layout Plain Layout
23675 configure this manually in order for the server to start.
23678 \begin_layout Standard
23681 \begin_inset Flex Code
23684 \begin_layout Plain Layout
23691 \begin_inset Flex Code
23694 \begin_layout Plain Layout
23700 ' to create the pipes.
23701 If one of the pipes already exists, \SpecialChar LyX
23702 will assume that another \SpecialChar LyX
23704 is already running and will not start the server.
23705 On POSIX (Unix like) systems, if for some other reason, an unused
23706 \begin_inset Quotes eld
23710 \begin_inset Quotes erd
23713 pipe is left in existence when \SpecialChar LyX
23714 closes, then \SpecialChar LyX
23715 will try to delete it.
23716 If this fails for some reason, you will need to delete the pipes manually
23717 and then restart \SpecialChar LyX
23719 On Windows, pipes are deleted by the OS on program termination or crash,
23721 \begin_inset Quotes eld
23725 \begin_inset Quotes erd
23728 pipes should not be possible.
23731 \begin_layout Standard
23732 To have several \SpecialChar LyX
23733 processes with servers at the same time, you have to use
23734 different configurations, perhaps by using separate user directories, each
23736 \begin_inset Flex Code
23739 \begin_layout Plain Layout
23745 file, for each process.
23748 \begin_layout Standard
23749 If you are developing a client program, you might find it useful to enable
23750 debugging information from the \SpecialChar LyX
23752 Do this by starting \SpecialChar LyX
23754 \begin_inset Flex Code
23757 \begin_layout Plain Layout
23766 \begin_layout Standard
23767 You can find a complete example client written in C++ in the source distribution
23769 \begin_inset Flex Code
23772 \begin_layout Plain Layout
23773 development/lyxserver/server_monitor.cpp
23781 \begin_layout Standard
23782 Another useful tool is the command-line based client found in
23783 \begin_inset Flex Code
23786 \begin_layout Plain Layout
23787 src/client/lyxclient
23795 \begin_layout Section
23796 Normal communication
23799 \begin_layout Standard
23800 To issue a \SpecialChar LyX
23801 call, the client writes a line of ASCII text into the input
23803 This line has the following format:
23806 \begin_layout Quote
23820 \begin_layout Description
23821 clientname is a name that the client can choose arbitrarily.
23822 Its only use is that \SpecialChar LyX
23823 will echo it if it sends an answer—so a client can
23824 dispatch results from different requesters.
23827 \begin_layout Description
23828 function is the function you want \SpecialChar LyX
23830 It is the same as the commands you'd use in the minibuffer.
23833 \begin_layout Description
23834 argument is an optional argument which is meaningful only to some functions
23836 \begin_inset Quotes eld
23840 \begin_inset Quotes erd
23843 LFUN will insert the argument as text at the cursor position).
23846 \begin_layout Standard
23847 The answer from \SpecialChar LyX
23848 will arrive in the output pipe and be of the form
23851 \begin_layout Quote
23865 \begin_layout Standard
23874 are just echoed from the command request, while
23878 is more or less useful information filled according to how the command
23879 execution worked out.
23880 Some commands, such as
23881 \begin_inset Quotes eld
23885 \begin_inset Quotes erd
23888 , will return information about the internal state of \SpecialChar LyX
23890 return an empty data-response.
23891 This means that the command execution went fine.
23894 \begin_layout Standard
23895 In case of errors, the response from \SpecialChar LyX
23896 will have this form
23899 \begin_layout Quote
23913 \begin_layout Standard
23918 should contain an explanation of why the command failed.
23921 \begin_layout Standard
23925 \begin_layout LyX-Code
23926 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
23927 \begin_inset Newline newline
23930 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
23931 \begin_inset Newline newline
23934 read a <~/.lyxpipe.out
23935 \begin_inset Newline newline
23941 \begin_layout Subsection
23942 AppleScript (Mac OS X)
23945 \begin_layout Standard
23946 Since \SpecialChar LyX
23947 2.1, \SpecialChar LyX
23948 supports basic interactions with AppleScript for normal communicatio
23949 n through the command run.
23950 This command takes a direct argument (the
23954 to perform) and an optional argument.
23955 It either returns the output of the function or triggers an error with
23956 the error message and code.
23959 \begin_layout Standard
23963 \begin_layout LyX-Code
23964 tell application "\SpecialChar LyX
23968 \begin_layout LyX-Code
23972 \begin_layout LyX-Code
23973 -- Stores the current file name into f
23976 \begin_layout LyX-Code
23977 set f to (run "server-get-filename" with argument "")
23980 \begin_layout LyX-Code
23981 on error the error_message number the error_number
23984 \begin_layout LyX-Code
23985 display dialog "Error: " & the error_number & ".
23989 \begin_layout LyX-Code
23990 & the error_message buttons {"OK"} default button 1
23993 \begin_layout LyX-Code
23997 \begin_layout LyX-Code
24001 \begin_layout Section
24005 \begin_layout Standard
24007 can notify clients of events going on asynchronously.
24008 Currently it will only do this if the user binds a key sequence with the
24010 \begin_inset Quotes eld
24014 \begin_inset Quotes erd
24018 The format of the string \SpecialChar LyX
24019 sends is as follows:
24022 \begin_layout Quote
24023 \begin_inset Flex Code
24026 \begin_layout Plain Layout
24037 \begin_layout Standard
24042 is the printed representation of the key sequence that was actually typed
24046 \begin_layout Standard
24047 This mechanism can be used to extend \SpecialChar LyX
24048 's command set and implement macros.
24049 Bind some key sequence to
24050 \begin_inset Quotes eld
24054 \begin_inset Quotes erd
24058 Then start a client that listens on the output pipe, dispatches the command
24059 according to the sequence, and starts a function that may use \SpecialChar LyX
24062 requests to issue a command or a series of commands to \SpecialChar LyX
24066 \begin_layout Section
24067 The simple \SpecialChar LyX
24071 \begin_layout Standard
24073 implements a simple protocol that can be used for session management.
24074 All messages are of the form
24077 \begin_layout Quote
24087 \begin_layout Standard
24093 \begin_inset Quotes eld
24097 \begin_inset Quotes erd
24101 \begin_inset Quotes eld
24105 \begin_inset Quotes erd
24110 \begin_inset Quotes eld
24114 \begin_inset Quotes erd
24117 is received from a client, \SpecialChar LyX
24118 will report back to inform the client that
24119 it's listening to it's messages, while
24120 \begin_inset Quotes eld
24124 \begin_inset Quotes erd
24127 sent from \SpecialChar LyX
24128 will inform clients that \SpecialChar LyX
24132 \begin_layout Section
24133 Reverse DVI/PDF search
24136 \begin_layout Standard
24137 Some DVI/PDF viewers
24141 \begin_layout Plain Layout
24142 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
24143 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
24152 facility (also called
24157 This means that you can tell \SpecialChar LyX
24158 to put the cursor to a specific line in the
24159 document by clicking at the respective position in the DVI/PDF output.
24160 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
24162 This is done via the \SpecialChar LyX
24163 server either by using the named pipe (
24167 ), or the UNIX domain socket (
24171 ) that \SpecialChar LyX
24172 creates in its temporary directory (this is the way the
24173 \begin_inset Flex Code
24176 \begin_layout Plain Layout
24182 program communicates with \SpecialChar LyX
24184 In some cases, you need a helper script that mediates between the viewer
24185 and \SpecialChar LyX
24186 , in others, the viewer can communicate with \SpecialChar LyX
24188 This depends on the selected viewer and on your operating system.
24189 The same applies to the way viewers need to be configured and the way the
24190 reverse search is actually performed.
24191 In what follows, we will thus describe how to setup reverse search for
24193 Before we turn to this, though, we will explain what needs to be done generally
24194 to enable reverse search in the DVI/PDF output.
24197 \begin_layout Subsection
24199 \begin_inset CommandInset label
24201 name "subsec:rev-search"
24208 \begin_layout Standard
24209 In most cases \SpecialChar LyX
24210 will do the work for you by pressing the following button
24214 arg "buffer-toggle-output-sync"
24218 Alternatively, you can also enable the feature by checking
24220 Synchronize with Output
24223 \begin_inset Flex Noun
24226 \begin_layout Plain Layout
24227 Document\SpecialChar menuseparator
24228 Settings\SpecialChar menuseparator
24235 In such a case \SpecialChar LyX
24236 will automatically insert the necessary Sync\SpecialChar TeX
24238 PDF) or load the srcltx package (for DVI) respectively.
24239 This option can be easily reached also on
24240 \begin_inset Flex Code
24243 \begin_layout Plain Layout
24252 \begin_layout Standard
24253 If you need a different setting, you can select or input a custom macro
24254 from the drop down box just below
24255 \begin_inset Flex Noun
24258 \begin_layout Plain Layout
24259 Document\SpecialChar menuseparator
24260 Settings\SpecialChar menuseparator
24261 Output\SpecialChar menuseparator
24262 Synchronize with Output
24270 \begin_layout Standard
24271 Note that the method
24272 \begin_inset Flex Code
24275 \begin_layout Plain Layout
24283 enables gzip compression.
24284 If your viewer does not support it, you should instead use
24285 \begin_inset Flex Code
24288 \begin_layout Plain Layout
24299 \begin_layout Standard
24300 Please also note that including the
24301 \begin_inset Flex Code
24304 \begin_layout Plain Layout
24311 \begin_inset Flex Code
24314 \begin_layout Plain Layout
24320 sometimes has an undesired impact on the typesetting.
24321 Thus, you should switch output synchronization off for the final typesetting
24323 \begin_inset Flex Code
24326 \begin_layout Plain Layout
24333 \begin_inset Flex Code
24336 \begin_layout Plain Layout
24346 \begin_layout Standard
24347 In case you need some more special settings that are not covered by the
24348 automatic settings, read the next section about how to set up output synchroniz
24350 If the automatic setup suits your needs, you can readily jump to section
24351 \begin_inset space ~
24355 \begin_inset CommandInset ref
24357 reference "subsec:configuring-viewers"
24361 , where the necessary configuration steps in your viewer – needed both with
24362 the automatic and the manual setup – are described.
24365 \begin_layout Subsection
24369 \begin_layout Standard
24371 provides several different methods for reverse search.
24372 Some are built-in in the
24373 \begin_inset Flex Code
24376 \begin_layout Plain Layout
24382 program, some are provided by external packages.
24383 Your choice depends on whether your \SpecialChar LaTeX
24384 distribution already provides a given
24385 method (the built-in methods are rather new) and whether your viewer can
24387 The available methods are described in the following.
24390 \begin_layout Subsubsection*
24391 Built-in DVI-search via src-specials (DVI only)
24394 \begin_layout Standard
24395 This method provides the DVI file with the necessary information for reverse
24397 It is available in \SpecialChar LaTeX
24398 since quite some time (any somewhat recent \SpecialChar LaTeX
24400 should include it), and it works reliably.
24401 To enable it, change the
24402 \begin_inset Flex Noun
24405 \begin_layout Plain Layout
24416 \begin_inset Flex Noun
24419 \begin_layout Plain Layout
24430 \begin_inset Flex Noun
24433 \begin_layout Plain Layout
24434 Preferences\SpecialChar menuseparator
24435 File Handling\SpecialChar menuseparator
24442 \begin_inset Flex Code
24445 \begin_layout Plain Layout
24446 latex -src-specials $$i
24452 If this doesn't work, check if your \SpecialChar TeX
24453 engine needs different options (the
24454 syntax might differ in some distributions).
24457 \begin_layout Subsubsection*
24458 External Packages (PDFSync and scrltx)
24461 \begin_layout Standard
24470 provide reverse search facility for PDF output (via pdflatex) and DVI output,
24472 In order to enable it, load the packages in the \SpecialChar LyX
24476 \begin_layout Itemize
24477 \begin_inset Flex Code
24480 \begin_layout Plain Layout
24483 usepackage{pdfsync}
24488 for reverse PDF search,
24491 \begin_layout Itemize
24492 \begin_inset Flex Code
24495 \begin_layout Plain Layout
24498 usepackage[active]{srcltx}
24503 for reverse DVI search.
24506 \begin_layout Standard
24507 If you want to be able to perform both DVI and PDF reverse searches, you
24508 can also insert in the preamble the following lines
24511 \begin_layout LyX-Code
24515 \begin_inset Newline newline
24521 \begin_inset Newline newline
24526 usepackage{pdfsync}
24527 \begin_inset Newline newline
24533 \begin_inset Newline newline
24538 usepackage[active]{srcltx}
24539 \begin_inset Newline newline
24547 \begin_layout Standard
24548 This way, you can preview the file as either DVI or PDF (pdflatex) and the
24549 right package will be used.
24552 \begin_layout Standard
24553 Note that PDFSync might affect the output layout of your document.
24554 It is therefore advised to disable PDFsync for final documents.
24557 \begin_layout Subsubsection*
24558 Built-in reverse search via Sync\SpecialChar TeX
24562 \begin_layout Standard
24564 \begin_inset Flex Code
24567 \begin_layout Plain Layout
24573 have built-in support for both PDF and DVI reverse search.
24576 Sync\SpecialChar TeX
24579 facility is basically the result of the integration of the PDFSync package
24580 to the pdftex program and its merge with the
24585 You need at least \SpecialChar TeX
24586 Live 2008 or a recent Mik\SpecialChar TeX
24587 distribution in order to use
24592 \begin_layout Plain Layout
24593 For some reason, Mik\SpecialChar TeX
24594 does not understand/obey the command \SpecialChar LyX
24596 the preamble when you check the "Enable Forward/Reverse Search" button
24597 in the toolbar and does not generate the necessary info.
24600 \begin_layout Plain Layout
24601 The generation of the required info can be forced by changing the converter
24602 "\SpecialChar LaTeX
24603 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
24604 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
24605 the -synctex=1 switch).
24610 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
24611 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
24612 already provide Sync\SpecialChar TeX
24616 \begin_layout Standard
24617 To enable Sync\SpecialChar TeX
24618 for DVI output, change the
24619 \begin_inset Flex Noun
24622 \begin_layout Plain Layout
24633 \begin_inset Flex Noun
24636 \begin_layout Plain Layout
24641 (plain) -> DraftDVI
24647 \begin_inset Flex Noun
24650 \begin_layout Plain Layout
24651 Preferences\SpecialChar menuseparator
24652 File Handling\SpecialChar menuseparator
24659 \begin_inset Flex Code
24662 \begin_layout Plain Layout
24663 latex -synctex=1 $$i
24668 , and for PDF output, change the
24669 \begin_inset Flex Noun
24672 \begin_layout Plain Layout
24677 (pdflatex) -> PDF (pdflatex)
24683 \begin_inset Flex Code
24686 \begin_layout Plain Layout
24687 pdflatex -synctex=1 $$i
24693 Should your viewer not be considered in the following description, or in
24694 case of missing success, please check the documentation of your viewer
24695 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
24700 \begin_layout Plain Layout
24701 Note that the option
24702 \begin_inset Flex Code
24705 \begin_layout Plain Layout
24711 option enables gzip compression.
24712 If your viewer does not support it, you should instead use
24713 \begin_inset Flex Code
24716 \begin_layout Plain Layout
24730 \begin_layout Subsection
24731 Configuring and using specific viewers
24732 \begin_inset CommandInset label
24734 name "subsec:configuring-viewers"
24741 \begin_layout Subsubsection*
24742 Xdvi (all platforms)
24745 \begin_layout Standard
24747 \begin_inset Flex Code
24750 \begin_layout Plain Layout
24756 , you don't need to do anything else for performing a reverse DVI search,
24757 as \SpecialChar LyX
24758 already provides the necessary hooks for automatically using the
24759 \begin_inset Flex Code
24762 \begin_layout Plain Layout
24769 Just setup your document as described above (reverse search is triggered
24770 by Ctrl-click or Alt-click on Mac OSX, respectively).
24773 \begin_layout Standard
24774 However, if for whatever reason you want to use the named pipe instead of
24775 the socket for communicating with \SpecialChar LyX
24776 , simply change the DVI viewer in
24777 \begin_inset Flex Noun
24780 \begin_layout Plain Layout
24781 Preferences\SpecialChar menuseparator
24782 File Handling\SpecialChar menuseparator
24792 \begin_layout Plain Layout
24793 On Mac OSX you have to use
24794 \begin_inset Flex Code
24797 \begin_layout Plain Layout
24798 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
24809 \begin_inset Flex Code
24812 \begin_layout Plain Layout
24813 xdvi -editor "lyxeditor.sh %f %l"
24819 \begin_inset Flex Code
24822 \begin_layout Plain Layout
24828 is a suitable script.
24829 For example, a minimal shell script is the following one:
24832 \begin_layout LyX-Code
24834 \begin_inset Newline newline
24837 LYXPIPE="/path/to/lyxpipe"
24838 \begin_inset Newline newline
24841 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
24842 \begin_inset Newline newline
24845 echo "$COMMAND" > "${LYXPIPE}".in || exit
24846 \begin_inset Newline newline
24849 read TMP < "${LYXPIPE}".out || exit
24852 \begin_layout Standard
24854 \begin_inset Flex Code
24857 \begin_layout Plain Layout
24863 is the LyXServer pipe path specified in
24864 \begin_inset Flex Noun
24867 \begin_layout Plain Layout
24868 Preferences\SpecialChar menuseparator
24878 \begin_layout Plain Layout
24880 \begin_inset Flex Code
24883 \begin_layout Plain Layout
24889 folder of a source distribution you can find a
24890 \begin_inset Flex Code
24893 \begin_layout Plain Layout
24899 script which is able to locate the
24903 based on your preferences.
24911 \begin_layout Subsubsection*
24915 \begin_layout Standard
24917 \begin_inset Flex Code
24920 \begin_layout Plain Layout
24921 /Applications/MacDviX_Folder/calleditor.script
24926 , add the following lines:
24929 \begin_layout LyX-Code
24930 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
24931 \begin_inset Newline newline
24937 \begin_layout Standard
24938 Modify the lines accordingly if you install \SpecialChar LyX
24939 somewhere else than in the
24940 Applications folder.
24943 \begin_layout Standard
24944 Reverse search is triggered by Alt-click (OPTION-click).
24947 \begin_layout Subsubsection*
24951 \begin_layout Standard
24953 \begin_inset Flex Code
24956 \begin_layout Plain Layout
24957 open -a Skim.app $$i
24962 to the viewer setting in
24963 \begin_inset Flex Noun
24966 \begin_layout Plain Layout
24967 Preferences\SpecialChar menuseparator
24968 File Handling\SpecialChar menuseparator
24969 File formats\SpecialChar menuseparator
24976 \begin_inset Flex Noun
24979 \begin_layout Plain Layout
24980 Skim\SpecialChar menuseparator
24981 Preferences\SpecialChar menuseparator
24988 \begin_inset Flex Noun
24991 \begin_layout Plain Layout
24997 preset and enter command
24998 \begin_inset Flex Noun
25001 \begin_layout Plain Layout
25002 /Applications/\SpecialChar LyX
25003 .app/Contents/MacOS/lyxeditor
25011 \begin_layout Standard
25012 Reverse search is triggered by COMMAND-SHIFT-click
25015 \begin_layout Subsubsection*
25019 \begin_layout Standard
25020 Reverse search with evince does not work out of the box, but it can be achieved
25021 by means of some third party helper scripts.
25023 \begin_inset CommandInset href
25025 target "https://wiki.lyx.org/LyX/SyncTeX"
25033 \begin_layout Subsubsection*
25037 \begin_layout Standard
25039 \begin_inset Flex Noun
25042 \begin_layout Plain Layout
25043 Settings\SpecialChar menuseparator
25044 Configure Okular\SpecialChar menuseparator
25051 \begin_inset Quotes erd
25055 This inserts the appropriate command (
25056 \begin_inset Flex Code
25059 \begin_layout Plain Layout
25068 \begin_layout Standard
25069 Reverse search is triggered by SHIFT-click.
25071 \change_inserted -712698321 1578211026
25072 Note that this only works if Okular is in
25073 \begin_inset Quotes eld
25077 \begin_inset Quotes erd
25081 \begin_inset space \thinspace{}
25084 e., the hand symbol is clicked).
25089 \begin_layout Subsubsection*
25093 \begin_layout Standard
25094 Qpdfview supports Sync\SpecialChar TeX
25095 since version 0.3.5.
25097 \begin_inset Flex Noun
25100 \begin_layout Plain Layout
25101 Edit\SpecialChar menuseparator
25102 Settings\SpecialChar menuseparator
25108 , click on the input field of the
25109 \begin_inset Quotes eld
25113 \begin_inset Quotes erd
25116 item and add the command
25117 \begin_inset Flex Code
25120 \begin_layout Plain Layout
25129 \begin_layout Standard
25130 Reverse search is triggered by double-click or, in more recent versions,
25134 \begin_layout Subsubsection*
25138 \begin_layout Standard
25139 Launch yap, choose its
25140 \begin_inset Flex Noun
25143 \begin_layout Plain Layout
25144 View\SpecialChar menuseparator
25150 menu and select the
25151 \begin_inset Quotes eld
25155 \begin_inset Quotes erd
25160 \begin_inset Quotes eld
25163 New\SpecialChar ldots
25165 \begin_inset Quotes erd
25168 button and, in the window that opens, enter
25169 \begin_inset Quotes eld
25174 \begin_inset Quotes erd
25177 (or any other name you like) in the
25178 \begin_inset Quotes eld
25182 \begin_inset Quotes erd
25186 Now click on the button labeled
25187 \begin_inset Quotes eld
25192 \begin_inset Quotes erd
25195 to open a file dialog and navigate to the directory containing the batch
25197 \begin_inset Flex Code
25200 \begin_layout Plain Layout
25208 \begin_inset Flex Code
25211 \begin_layout Plain Layout
25217 and then specify the program arguments as
25218 \begin_inset Flex Code
25221 \begin_layout Plain Layout
25229 \begin_inset Flex Code
25232 \begin_layout Plain Layout
25238 wrapper is used for communicating with \SpecialChar LyX
25246 \begin_layout LyX-Code
25248 \begin_inset Newline newline
25251 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
25260 \begin_inset Newline newline
25274 \begin_layout Standard
25275 Make sure that the \SpecialChar LyX
25276 Server pipe path you specified in \SpecialChar LyX
25278 \begin_inset Flex Code
25281 \begin_layout Plain Layout
25295 , otherwise change the
25296 \begin_inset Flex Code
25299 \begin_layout Plain Layout
25305 wrapper accordingly.
25308 \begin_layout Standard
25309 In yap, reverse search is triggered by double-click.
25312 \begin_layout Subsubsection*
25313 SumatraPDF (Windows)
25316 \begin_layout Standard
25317 In order to use SumatraPDF for inverse search, enter
25318 \begin_inset Flex Code
25321 \begin_layout Plain Layout
25322 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
25327 in the viewer setting in
25328 \begin_inset Flex Noun
25331 \begin_layout Plain Layout
25332 Preferences\SpecialChar menuseparator
25333 File Handling\SpecialChar menuseparator
25334 File formats\SpecialChar menuseparator
25341 \begin_inset Flex Code
25344 \begin_layout Plain Layout
25350 is the previous wrapper.
25351 If SumatraPDF.exe is not in your command PATH, use its full file name.
25354 \begin_layout Standard
25355 Reverse search is triggered by double-click.
25358 \begin_layout Subsubsection*
25362 \begin_layout Standard
25363 First of all, make sure that yap is your default DVI viewer in the Windows
25364 environment, then launch it, choose its
25365 \begin_inset Flex Noun
25368 \begin_layout Plain Layout
25369 View\SpecialChar menuseparator
25375 menu and select the
25376 \begin_inset Quotes eld
25380 \begin_inset Quotes erd
25385 \begin_inset Quotes eld
25388 New\SpecialChar ldots
25390 \begin_inset Quotes erd
25393 button and, in the window that opens, enter
25394 \begin_inset Quotes eld
25399 \begin_inset Quotes erd
25402 (or any other name you like) in the
25403 \begin_inset Quotes eld
25407 \begin_inset Quotes erd
25411 Now click on the button labeled
25412 \begin_inset Quotes eld
25417 \begin_inset Quotes erd
25420 to open a file dialog and navigate to the directory containing the
25421 \begin_inset Flex Code
25424 \begin_layout Plain Layout
25430 program (which is installed by default on Cygwin along with the \SpecialChar LyX
25433 \begin_inset Flex Code
25436 \begin_layout Plain Layout
25442 and then specify the program arguments as
25443 \begin_inset Flex Code
25446 \begin_layout Plain Layout
25453 In this way, you will be using the
25457 for communicating with \SpecialChar LyX
25459 If, for whatever reason, you want to use the
25464 \begin_inset Flex Code
25467 \begin_layout Plain Layout
25473 option and be sure to specify the \SpecialChar LyX
25474 Server pipe path in the \SpecialChar LyX
25478 \begin_layout Standard
25479 In yap, reverse search is triggered by double-click.
25482 \begin_layout Subsubsection*
25483 SumatraPDF (Cygwin)
25486 \begin_layout Standard
25487 In order to use SumatraPDF for inverse search, enter
25488 \begin_inset Flex Code
25491 \begin_layout Plain Layout
25492 SumatraPDF -inverse-search "lyxeditor -g %f %l"
25497 in the viewer setting in
25498 \begin_inset Flex Noun
25501 \begin_layout Plain Layout
25502 Preferences\SpecialChar menuseparator
25503 File Handling\SpecialChar menuseparator
25504 File formats\SpecialChar menuseparator
25511 If SumatraPDF.exe is not in your command PATH, use its full posix path.
25513 \begin_inset Flex Code
25516 \begin_layout Plain Layout
25522 enables communication via the
25528 \begin_inset Flex Code
25531 \begin_layout Plain Layout
25537 option if you want to use the
25541 , and be sure to specify the \SpecialChar LyX
25542 Server pipe path in the \SpecialChar LyX
25546 \begin_layout Standard
25547 Reverse search is triggered by double-click.
25550 \begin_layout Section
25554 \begin_layout Standard
25555 Forward search is, as the name implies, in a sense the
25556 \begin_inset Quotes eld
25560 \begin_inset Quotes erd
25564 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
25566 If forward search is set up (as described in what follows), you can put
25567 the cursor anywhere in your \SpecialChar LyX
25569 \begin_inset Flex Noun
25572 \begin_layout Plain Layout
25573 Navigate\SpecialChar menuseparator
25580 \begin_inset Flex Noun
25583 \begin_layout Plain Layout
25589 in the context menu via right mouse click), and then the viewer will jump
25590 to that position as well.
25591 This implies, of course, that your viewer supports this function.
25594 \begin_layout Standard
25595 To make forward search possible, you first need to provide the generated
25596 output PDF/DVI file with additional information about the \SpecialChar TeX
25598 This can be done via the methods described in the section
25599 \begin_inset CommandInset ref
25601 reference "subsec:rev-search"
25608 \begin_layout Standard
25609 Additionally, you need to configure \SpecialChar LyX
25610 for using your viewers in
25611 \begin_inset Flex Noun
25614 \begin_layout Plain Layout
25615 Tools\SpecialChar menuseparator
25616 Preferences\SpecialChar menuseparator
25617 Output\SpecialChar menuseparator
25624 We provide a range of tested configurations for some viewers, which you
25625 can select from the drop down list.
25626 If none of these configurations suits you, you have to find out and enter
25627 a suitable configuration yourself.
25628 The definition syntax uses the following placeholders:
25631 \begin_layout Itemize
25633 \begin_inset Flex Code
25636 \begin_layout Plain Layout
25645 \begin_layout Itemize
25647 \begin_inset Flex Code
25650 \begin_layout Plain Layout
25656 : name of the (temporary) exported .tex file (without path)
25659 \begin_layout Itemize
25661 \begin_inset Flex Code
25664 \begin_layout Plain Layout
25670 : name of the (temporary) exported .tex file (including path)
25673 \begin_layout Itemize
25675 \begin_inset Flex Code
25678 \begin_layout Plain Layout
25684 : name of the exported output file (either dvi or pdf, depending on which
25685 one exists in the temporary directory)
25688 \begin_layout Standard
25689 Note that only some of the viewers provide full and usable forward search
25690 functionality out of the box, among them yap, xdvi, okular
25694 \begin_layout Plain Layout
25695 You might want to set
25696 \begin_inset Flex Code
25699 \begin_layout Plain Layout
25706 \begin_inset Flex Noun
25709 \begin_layout Plain Layout
25710 Tools\SpecialChar menuseparator
25711 Preferences\SpecialChar menuseparator
25712 File Handling\SpecialChar menuseparator
25714 \begin_inset space ~
25727 , qpdfview, and SumatraPDF
25731 \begin_layout Plain Layout
25732 SumatraPDF can also use DDE commands through the external program CMCDDE
25733 — downloadable from
25734 \begin_inset CommandInset href
25736 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
25747 Others, such as evince
25751 \begin_layout Plain Layout
25752 Forward search with evince can be achieved by means of third party helper
25755 \begin_inset CommandInset href
25757 target "https://wiki.lyx.org/LyX/SyncTeX"
25767 , require some extra tools in order to use forward search.
25768 While many of the widespread PDF viewers (most notably Adobe Reader) do
25769 not support forward search at all, some other viewers – e.
25770 \begin_inset space \thinspace{}
25774 xpdf – allow at least to reload the document and jump to a specific page
25775 of the file, so you can at least navigate
25776 \begin_inset Quotes eld
25780 \begin_inset Quotes erd
25784 This latter functionality is provided by an external call of synctex (see
25785 the predefined example configurations).
25789 \begin_layout Standard
25790 Forward search works both with DVI and PDF output.
25792 simply checks which preview format you have used before (i.
25793 \begin_inset space \thinspace{}
25796 e., which format is already there in the temporary directory) and chooses
25797 the appropriate configuration for the respective format.
25800 \begin_layout Chapter
25802 \change_deleted 564990737 1671097409
25803 Special Document Classes
25808 \begin_layout Section
25810 \change_deleted 564990737 1669742044
25814 \begin_layout Standard
25816 \change_deleted 564990737 1669742044
25822 \begin_layout Subsection
25824 \change_deleted 564990737 1669742044
25828 \begin_layout Standard
25830 \change_deleted 564990737 1669742044
25831 This section describes how \SpecialChar LyX
25832 can be used to write articles for submission
25833 to the scientific journal
25835 Astronomy and Astrophysics
25838 \begin_inset Flex URL
25841 \begin_layout Plain Layout
25843 https://www.aanda.org/
25848 ) using Version 5.01 of the document class
25853 This package can be downloaded from the ftp site
25856 \begin_layout Standard
25858 \change_deleted 564990737 1669742044
25859 \begin_inset VSpace medskip
25865 \begin_layout Standard
25868 \change_deleted 564990737 1669742044
25869 \begin_inset Flex URL
25872 \begin_layout Plain Layout
25874 ftp://ftp.edpsciences.org/pub/aa/readme.html
25882 \begin_layout Standard
25884 \change_deleted 564990737 1669742044
25885 \begin_inset VSpace medskip
25891 \begin_layout Standard
25893 \change_deleted 564990737 1669742044
25894 A manual comes together with that package, and this text is not meant to
25895 replace the original manual but is merely a short guide in how to realize
25896 the correct form of your paper.
25900 \begin_layout Standard
25902 \change_deleted 564990737 1669742044
25903 Please note that the publisher of the journal was changed from Springer
25904 to EDP Sciences starting January 1, 2001.
25905 That change involved also some slight changes to the style files, namely
25906 the removal of the thesaurus command.
25907 The \SpecialChar LyX
25908 class aa supports the newest version of these style files, V 5.01.
25909 If you have an older version installed, please upgrade.
25910 For compatibility, the old (version 4) layout has been kept as
25915 Please refer to the comments in
25918 Dir/layouts/aapaper.layout
25923 \begin_layout Subsection
25925 \change_deleted 564990737 1669742044
25929 \begin_layout Standard
25931 \change_deleted 564990737 1669742044
25932 It is recommended you start from the example template distributed with \SpecialChar LyX
25934 If you are not using a template, note the following settings:
25937 \begin_layout Itemize
25939 \change_deleted 564990737 1669742044
25946 Document\SpecialChar menuseparator
25949 dialog (OK, that one was obvious).
25952 \begin_layout Itemize
25954 \change_deleted 564990737 1669742044
25955 Don't change the option
25958 \begin_inset space ~
25968 The whole layout is done by the macros, you shouldn't change anything.
25971 \begin_layout Subsection
25973 \change_deleted 564990737 1669742044
25977 \begin_layout Standard
25979 \change_deleted 564990737 1669742044
25980 First thing to enter is the header information.
25981 It consists of seven entries, of which some are optional.
25985 \begin_layout Itemize
25987 \change_deleted 564990737 1669742044
25995 \begin_layout Itemize
25997 \change_deleted 564990737 1669742044
26005 \begin_layout Itemize
26007 \change_deleted 564990737 1669742044
26015 \begin_layout Itemize
26017 \change_deleted 564990737 1669742044
26025 \begin_layout Itemize
26027 \change_deleted 564990737 1669742044
26032 : [optional] if more than one author: whom to contact for offprint requests.
26035 \begin_layout Itemize
26037 \change_deleted 564990737 1669742044
26042 : [optional] mail address for contacts.
26045 \begin_layout Itemize
26047 \change_deleted 564990737 1669742044
26053 Suggested format is
26055 Received: <date>; Accepted <date>
26058 \begin_layout Standard
26060 \change_deleted 564990737 1669742044
26061 There is no need to issue the
26067 command, this is done automatically by \SpecialChar LyX
26068 when the header is finished.
26069 Although the order of the single header entries doesn't matter it is advised
26070 to keep the above sequence, just to get the best optics and meets the layout
26071 of the real document.
26074 \begin_layout Standard
26076 \change_deleted 564990737 1669742044
26077 If you want to place footnotes in the header block, e.
26078 \begin_inset space \thinspace{}
26082 \begin_inset space \space{}
26085 to state your present address, just use the standard footnote via the menu
26088 Insert\SpecialChar menuseparator
26093 will automagically use the term
26102 \begin_layout Standard
26104 \change_deleted 564990737 1669742044
26107 Edit\SpecialChar menuseparator
26110 , you'll find two insets which are relevant for the titling:
26113 \begin_layout Itemize
26115 \change_deleted 564990737 1669742044
26122 to mark corresponding author\SpecialChar breakableslash
26124 The institutes are numbered sequentially as they appear in the
26128 field, so you have to put a marker to each author.
26131 \begin_layout Itemize
26133 \change_deleted 564990737 1669742044
26138 to supply an email address for fast contact.
26141 \begin_layout Standard
26143 \change_deleted 564990737 1669742044
26144 In addition to these topics, the macros use one additional \SpecialChar LaTeX
26146 has no counterpart in \SpecialChar LyX
26150 \begin_layout Itemize
26152 \change_deleted 564990737 1669742044
26159 to separate different names for more than one author and institute, respectivel
26163 \begin_layout Standard
26165 \change_deleted 564990737 1669742044
26166 The appropriate command has to be entered in \SpecialChar LyX
26167 and marked as \SpecialChar LaTeX
26173 \begin_layout Subsection
26175 \change_deleted 564990737 1669742044
26179 \begin_layout Standard
26181 \change_deleted 564990737 1669742044
26182 The abstract should immediately follow the header block.
26183 With version 5 the abstract environment was changed to a command, and there
26184 is now a restriction to only one paragraph.
26185 In addition, it should contain an entry with the keywords.
26186 This is done via the paragraph style
26191 Refer to the example paper.
26194 \begin_layout Subsection
26196 \change_deleted 564990737 1669742044
26197 Supported environments
26200 \begin_layout Standard
26202 \change_deleted 564990737 1669742044
26203 The A&A paper layout supports the following environments for structuring
26207 \begin_layout Itemize
26209 \change_deleted 564990737 1669742044
26215 \begin_layout Itemize
26217 \change_deleted 564990737 1669742044
26223 \begin_layout Itemize
26225 \change_deleted 564990737 1669742044
26231 \begin_layout Itemize
26233 \change_deleted 564990737 1669742044
26239 \begin_layout Itemize
26241 \change_deleted 564990737 1669742044
26247 \begin_layout Itemize
26249 \change_deleted 564990737 1669742044
26255 \begin_layout Itemize
26257 \change_deleted 564990737 1669742044
26263 \begin_layout Itemize
26265 \change_deleted 564990737 1669742044
26271 \begin_layout Itemize
26273 \change_deleted 564990737 1669742044
26279 \begin_layout Itemize
26281 \change_deleted 564990737 1669742044
26287 \begin_layout Itemize
26289 \change_deleted 564990737 1669742044
26295 \begin_layout Itemize
26297 \change_deleted 564990737 1669742044
26304 \begin_layout Subsection
26306 \change_deleted 564990737 1669742044
26307 Commands not supported by \SpecialChar LyX
26311 \begin_layout Standard
26313 \change_deleted 564990737 1669742044
26314 Some commands are not yet supported by the
26318 layout for \SpecialChar LyX
26320 Some have already been mentioned.
26321 For the sake of completeness, they are listed all together here:
26324 \begin_layout Itemize
26326 \change_deleted 564990737 1669742044
26334 \begin_layout Itemize
26336 \change_deleted 564990737 1669742044
26344 \begin_layout Itemize
26346 \change_deleted 564990737 1669742044
26354 \begin_layout Itemize
26356 \change_deleted 564990737 1669742044
26364 \begin_layout Standard
26366 \change_deleted 564990737 1669742044
26367 If you want to use any of these commands, you have to enter them yourself.
26370 Do not forget to mark them as \SpecialChar LaTeX
26374 \begin_layout Subsection
26376 \change_deleted 564990737 1669742044
26377 Figure and Table Floats
26380 \begin_layout Standard
26382 \change_deleted 564990737 1669742044
26384 provides support for the necessary float environments
26386 figure, figure*, table
26392 , therefore we won't tell much about it here.
26396 \begin_inset space ~
26402 Just remember that tables should be left-aligned.
26403 For that, select the table and change the alignment in
26405 Edit\SpecialChar menuseparator
26407 \begin_inset space ~
26413 \begin_layout Standard
26415 \change_deleted 564990737 1669742044
26416 There is only one special thing: the figures with caption besides the figure.
26417 To create such a figure, you have to do the following:
26420 \begin_layout Enumerate
26422 \change_deleted 564990737 1669742044
26423 Create a wide figure float:
26425 Insert\SpecialChar menuseparator
26426 Float\SpecialChar menuseparator
26429 , then right click in the figure and select
26432 \begin_inset space ~
26440 \begin_layout Enumerate
26442 \change_deleted 564990737 1669742044
26443 Enter your caption text.
26446 \begin_layout Enumerate
26448 \change_deleted 564990737 1669742044
26453 to move the cursor above the caption.
26456 \begin_layout Enumerate
26458 \change_deleted 564990737 1669742044
26462 \begin_layout Enumerate
26464 \change_deleted 564990737 1669742044
26465 Position the cursor behind the figure and insert a horizontal fill:
26467 Insert\SpecialChar menuseparator
26469 \begin_inset space ~
26472 Character\SpecialChar menuseparator
26474 \begin_inset space ~
26482 \begin_layout Enumerate
26484 \change_deleted 564990737 1669742044
26485 Switch to \SpecialChar LaTeX
26489 \begin_inset space ~
26497 \begin_layout Enumerate
26499 \change_deleted 564990737 1669742044
26509 Do not close the brace!
26512 \begin_layout Enumerate
26514 \change_deleted 564990737 1669742044
26515 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
26520 \begin_inset space ~
26532 \begin_layout Standard
26534 \change_deleted 564990737 1669742044
26535 Also, refer to the figures in the example paper.
26538 \begin_layout Subsection
26540 \change_deleted 564990737 1669742044
26544 \begin_layout Standard
26546 \change_deleted 564990737 1669742044
26547 For submission, the paper has to be formated in a special double-spacing
26549 For this purpose, you have to give the option
26553 to the document class.
26554 This must be done using the custom class options field in the
26556 Document\SpecialChar menuseparator
26560 Just enter the string
26567 \begin_layout Subsection
26569 \change_deleted 564990737 1669742044
26573 \begin_layout Standard
26575 \change_deleted 564990737 1669742044
26580 directory contains an example paper written with \SpecialChar LyX
26582 It is the example paper from the original macro package, translated to
26585 Use it for inspiration, and compare the original \SpecialChar LaTeX
26586 code with \SpecialChar LyX
26590 \begin_layout Section
26592 \change_deleted 564990737 1671097429
26596 \begin_layout Standard
26598 \change_deleted 564990737 1671097429
26603 can be used to type letters according to German conventions.
26604 A template file is included in
26606 .../lyx/share/templates
26608 for you to use as a starting point.
26611 \begin_layout Section
26613 \change_deleted 564990737 1671097429
26617 \begin_layout Standard
26619 \change_deleted 564990737 1671097429
26620 See the \SpecialChar LyX
26626 It contains all infos you need.
26629 \begin_layout Section
26631 \change_deleted 564990737 1669755802
26635 \begin_layout Standard
26637 \change_deleted 564990737 1669755802
26640 Panayotis Papasotiriou
26643 \begin_layout Subsection
26645 \change_deleted 564990737 1669755802
26649 \begin_layout Standard
26651 \change_deleted 564990737 1669755802
26652 The ijmpc package is a set of macros that facilitates electronic manuscript
26655 International Journal of Modern Physics C
26658 Similarly, the ijmpd package is for creating manuscripts to be submitted
26661 International Journal of Modern Physics D
26664 Both journals are published by World Scientific.
26665 The corresponding document classes are named
26674 These files, together with instructions for the authors, can be downloaded
26676 \begin_inset Flex URL
26679 \begin_layout Plain Layout
26681 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
26687 \begin_inset Flex URL
26690 \begin_layout Plain Layout
26692 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
26698 Both packages are modified versions of the standard
26699 \begin_inset Quotes eld
26703 \begin_inset Quotes erd
26706 package, and they are almost (but not exactly) identical.
26707 Most of their features are supported by \SpecialChar LyX
26709 I have used \SpecialChar LyX
26710 successfully to write articles submitted to both journals
26711 without any problem.
26714 \begin_layout Subsection
26716 \change_deleted 564990737 1669755802
26720 \begin_layout Standard
26722 \change_deleted 564990737 1669755802
26723 As usual, the easiest way to write a paper is to start with a template.
26726 File\SpecialChar menuseparator
26742 This will give an (almost) empty document that includes the most common
26743 fields found in a manuscript.
26744 Simply overwrite the existing text (including the brackets,
26749 You should keep in mind the following remarks.
26752 \begin_layout Enumerate
26754 \change_deleted 564990737 1669755802
26756 won't let you change the font size and the page style of the document,
26757 because such modifications are not allowed by both packages.
26760 \begin_layout Enumerate
26762 \change_deleted 564990737 1669755802
26763 The language of the document should not be changed.
26764 Before previewing your paper, be sure that the babel package is not used.
26765 To do this, click on
26768 arg "dialog-show document"
26773 \SpecialChar menuseparator
26777 \begin_inset Quotes eld
26781 \begin_inset Quotes erd
26791 \begin_layout Enumerate
26793 \change_deleted 564990737 1669755802
26795 \begin_inset Quotes eld
26799 \begin_inset Quotes erd
26802 style must be used to define keywords.
26805 \begin_layout Enumerate
26807 \change_deleted 564990737 1669755802
26808 The ijmpc package provides a style named
26809 \begin_inset Quotes eld
26812 Classification Codes
26813 \begin_inset Quotes erd
26816 , which can be used to define classification codes, such as PACS numbers.
26817 Note that this facility is not supported by the ijmpd package.
26820 \begin_layout Enumerate
26822 \change_deleted 564990737 1669755802
26823 Several new environments are available:
26824 \begin_inset Quotes eld
26828 \begin_inset Quotes erd
26832 \begin_inset Quotes eld
26836 \begin_inset Quotes erd
26840 \begin_inset Quotes eld
26844 \begin_inset Quotes erd
26848 \begin_inset Quotes eld
26852 \begin_inset Quotes erd
26856 \begin_inset Quotes eld
26860 \begin_inset Quotes erd
26864 \begin_inset Quotes eld
26868 \begin_inset Quotes erd
26872 \begin_inset Quotes eld
26876 \begin_inset Quotes erd
26880 \begin_inset Quotes eld
26884 \begin_inset Quotes erd
26888 \begin_inset Quotes eld
26892 \begin_inset Quotes erd
26896 \begin_inset Quotes eld
26900 \begin_inset Quotes erd
26904 \begin_inset Quotes eld
26908 \begin_inset Quotes erd
26912 \begin_inset Quotes eld
26916 \begin_inset Quotes erd
26920 \begin_inset Quotes eld
26924 \begin_inset Quotes erd
26928 \begin_inset Quotes eld
26932 \begin_inset Quotes erd
26936 Their use is more or less obvious.
26938 supports all these environments; it will use the proper label, text style,
26939 and numbering scheme for each of them.
26942 \begin_layout Enumerate
26944 \change_deleted 564990737 1669755802
26945 Both packages use basic citations; the natbib package should not be used.
26946 In \SpecialChar LyX
26947 , citation references are shown as usual; in the output, citations are
26948 shown as superscripts.
26949 If you want to use a citation as normal text, you should use the
26954 \begin_inset space \thinspace{}
26958 \begin_inset space \space{}
26962 \begin_inset Quotes eld
26966 \begin_inset space \space{}
26976 \begin_inset Quotes erd
26982 \begin_layout Enumerate
26984 \change_deleted 564990737 1669755802
26986 \begin_inset Quotes eld
26990 \begin_inset Quotes erd
26993 section in both packages.
26994 To put acknowledgments, just use the
26995 \begin_inset Quotes eld
26999 \begin_inset Quotes erd
27005 \begin_layout Enumerate
27007 \change_deleted 564990737 1669755802
27008 Appendices may be added to the paper,
27012 the Acknowledgments and
27018 provides a special environment, called
27019 \begin_inset Quotes eld
27023 \begin_inset Quotes erd
27026 which marks the beginning of the appendices.
27027 This environment should be left blank; it just sends a \SpecialChar LaTeX
27028 command, but nothing
27030 In \SpecialChar LyX
27032 \begin_inset Quotes eld
27036 \begin_inset Quotes erd
27039 is printed with blue letters, as a signal that all sections after that
27040 point are appendices.
27041 To write an appendix, use the
27042 \begin_inset Quotes eld
27046 \begin_inset Quotes erd
27051 will number each appendix with capital letters, as required by both journals.
27053 \begin_inset Quotes eld
27057 \begin_inset Quotes erd
27064 be present before the first appendix; if not, all appendices will be numbered
27065 as normal sections in the output.
27068 \begin_layout Enumerate
27070 \change_deleted 564990737 1669755802
27071 The ijmpc and the ijmpd packages use the
27075 command to implement table captions.
27076 As a result, a table created by \SpecialChar LyX
27077 is printed correctly, but its caption
27079 However, you can use some \SpecialChar TeX
27080 code to overcome this problem, so that captions
27081 are printed as expected.
27082 To do so, create a float table as usual, remove the caption, and replace
27083 it with the \SpecialChar TeX
27094 (sic); you must also the \SpecialChar TeX
27099 immediately after the tabular material.
27100 Study the example table included in the template files to see how this
27101 trick is implemented.
27102 Alternatively, If you need table captions, you should implement the whole
27107 file, then include this file to the \SpecialChar LyX
27110 Insert\SpecialChar menuseparator
27111 File\SpecialChar menuseparator
27113 \begin_inset space ~
27119 Details on how to create a table float can be found in the files
27127 , included in the corresponding packages.
27130 \begin_layout Subsection
27132 \change_deleted 564990737 1669755802
27133 Preparing a paper for submission
27136 \begin_layout Standard
27138 \change_deleted 564990737 1669755802
27139 Before you submit your paper you must export the \SpecialChar LyX
27140 document as a \SpecialChar LaTeX
27143 File\SpecialChar menuseparator
27144 Export\SpecialChar menuseparator
27152 \begin_layout Plain Layout
27153 Actually you have the choice between \SpecialChar LaTeX
27154 (plain) and pdflatex.
27155 If you intend to use pdflatex to prepare the paper, you should use the
27156 pdflatex option so that included graphics are converted to PDF format,
27157 ready for use by pdflatex.
27162 , then make the following changes to the resulting
27169 \begin_layout Enumerate
27171 \change_deleted 564990737 1669755802
27172 Remove the comment lines before the
27181 \begin_layout Enumerate
27183 \change_deleted 564990737 1669755802
27184 Remove everything between (and including) the
27196 commands, except for any commands you specifically put into the \SpecialChar LaTeX
27200 \begin_layout Standard
27202 \change_deleted 564990737 1669755802
27207 file should be saved and processed through \SpecialChar LaTeX
27208 as many times as necessary.
27209 You may also want to check the resulting
27218 \begin_layout Section
27220 \change_deleted 564990737 1669801478
27224 \begin_layout Standard
27226 \change_deleted 564990737 1669801478
27232 \begin_layout Subsection
27234 \change_deleted 564990737 1669801478
27238 \begin_layout Standard
27240 \change_deleted 564990737 1669801478
27241 The iopart package provides a document class to create electronic manuscript
27242 submission to the journals published by the Institute of Physics.
27243 Instructions for the authors how to create a paper using the iopart class
27244 can be downloaded together with the iopart package from the site
27245 \begin_inset Flex URL
27248 \begin_layout Plain Layout
27250 ftp://ftp.iop.org/pub/journals/latex2e
27258 \begin_layout Subsection
27260 \change_deleted 564990737 1669801478
27264 \begin_layout Standard
27266 \change_deleted 564990737 1669801478
27267 The easiest way to write a paper is to start with the template
27271 that is available via
27273 File\SpecialChar menuseparator
27276 The template explains how to use the special text environments.
27277 Here are the most important advices:
27280 \begin_layout Itemize
27282 \change_deleted 564990737 1669801478
27283 To be able to compile your document to a PDF, PS, or DVI, ensure that the
27284 no AMS packages are loaded in
27286 Document\SpecialChar menuseparator
27287 Settings\SpecialChar menuseparator
27293 \begin_layout Itemize
27295 \change_deleted 564990737 1669801478
27298 The title environment defines the kind of your paper.
27299 So use one of the following environments for the title:
27303 \begin_layout Itemize
27305 \change_deleted 564990737 1669801478
27314 \begin_layout Itemize
27316 \change_deleted 564990737 1669801478
27325 \begin_layout Itemize
27327 \change_deleted 564990737 1669801478
27333 for a Topical review
27336 \begin_layout Itemize
27338 \change_deleted 564990737 1669801478
27347 \begin_layout Itemize
27349 \change_deleted 564990737 1669801478
27358 \begin_layout Itemize
27360 \change_deleted 564990737 1669801478
27366 for a Paper (same as Title)
27369 \begin_layout Itemize
27371 \change_deleted 564990737 1669801478
27377 for a Preliminary communication
27380 \begin_layout Itemize
27382 \change_deleted 564990737 1669801478
27388 for a Rapid communication
27391 \begin_layout Itemize
27393 \change_deleted 564990737 1669801478
27399 for a Letter to the editor
27403 \begin_layout Itemize
27405 \change_deleted 564990737 1669801478
27408 All title environments except of
27412 can have an optional short title.
27415 \begin_layout Itemize
27417 \change_deleted 564990737 1669801478
27418 There is a general title environment
27422 which is not directly supported by \SpecialChar LyX
27424 This can be used as \SpecialChar TeX
27425 code when your document doesn't fit into one of the
27429 \begin_layout Standard
27431 \change_deleted 564990737 1669801478
27432 For more informations like hints for special table and formula formatting,
27433 look at the IOP author guidelines.
27438 \begin_layout Section
27440 \change_deleted 564990737 1670317155
27444 \begin_layout Standard
27446 \change_deleted 564990737 1670317155
27449 Panayotis Papasotiriou
27452 \begin_layout Subsection
27454 \change_deleted 564990737 1670317155
27458 \begin_layout Standard
27460 \change_deleted 564990737 1670317155
27461 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
27462 that facilitates electronic manuscript submission to the journals they
27464 Most known of them (at least in my domain of interest) are
27466 Astrophysics and Space Science
27472 , but there are many others (see a complete list at
27473 \begin_inset Flex URL
27476 \begin_layout Plain Layout
27478 http://www.wkap.nl/jrnllist.htm/JRNLHOME
27484 The Kluwer package may be downloaded from the site
27485 \begin_inset Flex URL
27488 \begin_layout Plain Layout
27490 http://www.wkap.nl/kaphtml.htm/STYLEFILES
27496 A complete user guide is contained in that package (but it can also be
27497 downloaded separately).
27500 \begin_layout Standard
27502 \change_deleted 564990737 1670317155
27504 supports many features of the package but not everything.
27505 However, the \SpecialChar TeX
27506 code needed is reduced to some
27507 \begin_inset Quotes eld
27511 \begin_inset Quotes erd
27514 commands of the package (see
27515 \begin_inset space ~
27519 \begin_inset CommandInset ref
27521 reference "subsec:kluwer_peculiarities"
27526 I have recently used \SpecialChar LyX
27527 to write an article submitted to the
27529 Astrophysics and Space Science
27531 without any problem.
27534 \begin_layout Subsection
27536 \change_deleted 564990737 1670317155
27540 \begin_layout Standard
27542 \change_deleted 564990737 1670317155
27543 The easiest way to write a paper is to start with the Kluwer template file.
27546 File\SpecialChar menuseparator
27558 This will give an (almost) empty document that includes the most common
27559 fields found in a manuscript and a short description of their use.
27560 As in most templates, simply overwrite the existing text (including the
27565 ) with the correct information.
27568 \begin_layout Subsection
27570 \change_deleted 564990737 1670317155
27571 Preparing a paper for submission
27574 \begin_layout Standard
27576 \change_deleted 564990737 1670317155
27577 As in the AAS\SpecialChar TeX
27578 package, before you submit your paper to a journal you must
27580 \begin_inset Quotes eld
27584 \begin_inset Quotes erd
27590 \begin_layout Enumerate
27592 \change_deleted 564990737 1670317155
27593 Export your paper as a \SpecialChar LaTeX
27595 To do this, click on
27597 File\SpecialChar menuseparator
27598 Export\SpecialChar menuseparator
27606 \begin_layout Enumerate
27608 \change_deleted 564990737 1670317155
27613 file with a text editor and make the following changes
27617 \begin_layout Enumerate
27619 \change_deleted 564990737 1670317155
27620 remove the comment lines before the
27629 \begin_layout Enumerate
27631 \change_deleted 564990737 1670317155
27632 remove everything between (and including) the
27644 commands, except for any commands you specifically put into the \SpecialChar LaTeX
27648 \begin_layout Standard
27650 \change_deleted 564990737 1670317155
27659 \begin_layout Enumerate
27661 \change_deleted 564990737 1670317155
27666 file through \SpecialChar LaTeX
27667 as many times as necessary (usually up to three).
27670 \begin_layout Enumerate
27672 \change_deleted 564990737 1670317155
27678 \begin_inset space \thinspace{}
27682 \begin_inset space \space{}
27689 , and check if everything is OK (it should, if you didn't make any mistake).
27692 \begin_layout Subsection
27694 \change_deleted 564990737 1670317155
27695 \begin_inset Quotes eld
27699 \begin_inset Quotes erd
27702 of the Kluwer package
27703 \begin_inset CommandInset label
27705 name "subsec:kluwer_peculiarities"
27712 \begin_layout Standard
27714 \change_deleted 564990737 1670317155
27715 The Kluwer package has the following
27716 \begin_inset Quotes eld
27720 \begin_inset Quotes erd
27726 \begin_layout Enumerate
27728 \change_deleted 564990737 1670317155
27729 It is possible to write multiple articles in the same \SpecialChar LaTeX
27734 \begin_layout Plain Layout
27735 I can't imagine any good reason to do this.
27741 Each article must be included in the environment
27742 \begin_inset Quotes eld
27746 \begin_inset Quotes erd
27750 Unfortunately, this environment cannot be omitted, even if you write just
27752 Therefore, each article starts with the command
27758 and, obviously, ends with the command
27765 Although this can be implemented in \SpecialChar LyX
27766 , I didn't included it, since it looks
27767 ugly and can confuse the novice user.
27768 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
27771 \begin_inset Quotes eld
27776 \begin_inset Quotes erd
27782 \begin_layout Enumerate
27784 \change_deleted 564990737 1670317155
27785 Information given at the beginning of the article (i.
27786 \begin_inset space \thinspace{}
27790 \begin_inset space \space{}
27793 title, subtitle, author, institution, running title, running author, abstract
27794 and keywords) must be included in an environment called
27795 \begin_inset Quotes eld
27799 \begin_inset Quotes erd
27803 This is not implemented in \SpecialChar LyX
27804 , so you must enter title, subtitle etc.
27805 \begin_inset space ~
27808 between two \SpecialChar TeX
27824 \begin_layout Enumerate
27826 \change_deleted 564990737 1670317155
27827 According to the user manual, the label of each bibliography item must be
27851 \begin_layout Standard
27853 \change_deleted 564990737 1670317155
27858 template takes care of all these
27859 \begin_inset Quotes eld
27863 \begin_inset Quotes erd
27867 If you start a new paper using this template you don't need to do anything
27872 \begin_layout Enumerate
27874 \change_deleted 564990737 1670317155
27875 don't delete the \SpecialChar TeX
27876 code included in the template, and
27879 \begin_layout Enumerate
27881 \change_deleted 564990737 1670317155
27882 copy the example bibliography item included in the template and modify it
27883 as necessary to enter new bibliography items.
27886 \begin_layout Section
27888 \change_deleted 564990737 1671097446
27892 \begin_layout Standard
27894 \change_deleted 564990737 1671097446
27899 provides an alternative to the standard
27904 It provides similar functionality, but you might prefer this layout with
27905 sans serif sections, headings, and more.
27908 \begin_layout Section
27910 \change_deleted 564990737 1671097446
27911 Springer Journals (
27918 \begin_layout Standard
27920 \change_deleted 564990737 1671097446
27926 \begin_layout Subsection
27928 \change_deleted 564990737 1671097446
27932 \begin_layout Standard
27934 \change_deleted 564990737 1671097446
27935 These are the layout files for some of the journal formats used by Springer
27936 Verlag and listed on
27937 \begin_inset Flex URL
27940 \begin_layout Plain Layout
27942 http://www.springer.de/author/tex/help-journals.html
27947 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
27949 It is a modular system: the things common to all journals are implemented
27954 , which journal-specific layout files (such as, e.
27955 \begin_inset space \thinspace{}
27959 \begin_inset space \space{}
27966 for Journal of Geodesy) can include.
27969 \begin_layout Standard
27971 \change_deleted 564990737 1671097446
27972 This means that implementing support for any other Springer journal on this
27973 list is as simple as writing your own
27981 file following the outline given in
27989 \begin_layout Standard
27991 \change_deleted 564990737 1671097446
27992 It is reasonably well tested only for the Journal of Geodesy.
28001 come with the standard \SpecialChar LyX
28003 Install the relevant class file (downloaded from Springer) in a proper
28004 directory, reconfigure \SpecialChar LaTeX
28005 (in the te\SpecialChar TeX
28010 , as root if necessary — doesn't \SpecialChar LyX
28011 take care of this?), reconfigure \SpecialChar LyX
28016 \begin_layout Subsection
28018 \change_deleted 564990737 1671097446
28022 \begin_layout Standard
28024 \change_deleted 564990737 1671097446
28025 A large number of theorem-like styles —
28037 \begin_layout Standard
28039 \change_deleted 564990737 1671097446
28042 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
28043 _Title, Author_Running, Institute,
28044 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
28047 See the Springer class file documentation for details.
28050 \begin_layout Subsection
28052 \change_deleted 564990737 1671097446
28056 \begin_layout Itemize
28058 \change_deleted 564990737 1671097446
28070 \begin_layout Itemize
28072 \change_deleted 564990737 1671097446
28075 Probability Theory and Related Fields
28081 — Jean-Marc Lasgouttes
28084 \begin_layout Standard
28086 \change_deleted 564990737 1671097446
28087 Add your own, it isn't so hard!
28090 \begin_layout Subsection
28092 \change_deleted 564990737 1671097446
28096 \begin_layout Standard
28098 \change_deleted 564990737 1671097446
28099 These files are partly based on the older
28103 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
28105 file from Springer.
28110 layout, are now defunct.
28111 Jean-Marc Lasgouttes helped out big in making me find my way around the
28113 layout file mechanism.
28116 \begin_layout Subsection
28118 \change_deleted 564990737 1671097446
28122 \begin_layout Standard
28124 \change_deleted 564990737 1671097446
28126 But probably less than in the old hacked-\SpecialChar LaTeX
28134 \begin_layout Chapter
28136 Features needing Extra Software
28139 \begin_layout Section
28140 Checking \SpecialChar TeX
28144 \begin_layout Standard
28150 \begin_layout Subsection
28154 \begin_layout Standard
28163 \begin_layout Plain Layout
28168 is not yet available when you are using the \SpecialChar LaTeX
28169 distribution MiK\SpecialChar TeX
28175 , you'll find in the
28182 \begin_inset space ~
28193 \begin_inset Newline newline
28197 \begin_inset CommandInset href
28199 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
28207 \begin_layout Standard
28210 Chk\SpecialChar TeX
28213 package is a program that was written by
28214 \begin_inset Flex Noun
28217 \begin_layout Plain Layout
28219 \begin_inset space ~
28227 in frustration because some constructs in \SpecialChar LaTeX
28228 are sometimes non-intuitive,
28229 and easy to forget.
28230 The program runs over your \SpecialChar LaTeX
28231 file, checks the integrity of the file, and
28232 flags some common errors.
28233 In other technical words, it is
28237 for \SpecialChar LaTeX
28241 \begin_layout Standard
28242 Well, what is a syntax checker doing in \SpecialChar LyX
28243 which is supposed to produce correct
28245 anyways? The answer is simple: Just as
28249 not only checks the
28253 of C programs, but also does
28257 checks for type-errors,
28259 Chk\SpecialChar TeX
28262 catches some common
28266 errors, in addition to the syntactical ones.
28269 Chk\SpecialChar TeX
28272 is capable of detecting several common errors, such as
28275 \begin_layout Itemize
28276 Ellipsis detection:
28277 \begin_inset Newline newline
28280 Use \SpecialChar ldots
28284 \begin_layout Itemize
28285 No space in front of/after parenthesis:
28286 \begin_inset Newline newline
28292 \begin_layout Itemize
28293 Enforcement of normal space after common abbreviations:
28294 \begin_inset Newline newline
28298 \begin_inset space \thinspace{}
28302 \begin_inset space \space{}
28305 is too wide spacing.
28308 \begin_layout Itemize
28309 Enforcement of end-of-sentence space when the last sentence ends with a
28311 \begin_inset Newline newline
28315 And this is wrong spacing.
28318 \begin_layout Itemize
28319 Space in front of labels and similar commands:
28320 \begin_inset Newline newline
28323 The label should stick right up to the text to avoid falling to a wrong
28326 \begin_inset CommandInset label
28336 \begin_layout Plain Layout
28337 This footnote is in danger of falling off to a wrong page
28342 The label is separated too much.
28345 \begin_layout Itemize
28346 Space in front of references, instead of hard spaces:
28347 \begin_inset Newline newline
28350 If you have bad luck, the text will break right between the referenced text
28351 and reference number, and that's a pity.
28353 \begin_inset CommandInset ref
28355 reference "sec:chktex"
28362 \begin_layout Itemize
28364 \begin_inset Quotes eld
28368 \begin_inset Quotes erd
28372 \begin_inset Formula $\times$
28376 \begin_inset Newline newline
28379 2x2 looks cheap compared to
28380 \begin_inset Formula $2\times2$
28386 \begin_layout Standard
28387 and more \SpecialChar ldots
28388 It is an invaluable tool when you are
28389 \begin_inset Quotes eld
28393 \begin_inset Quotes erd
28396 your document before printing, and you should run it right after the obligatory
28397 spelling check, and before you go fine tuning the typesetting.
28400 \begin_layout Subsection
28404 \begin_layout Standard
28405 If you have the program installed, usage is as simple as choosing
28407 Tools\SpecialChar menuseparator
28409 \begin_inset space ~
28415 This will make \SpecialChar LyX
28416 generate a \SpecialChar LaTeX
28417 file of your document, start
28419 Chk\SpecialChar TeX
28422 to check it, and then make \SpecialChar LyX
28424 \begin_inset Quotes eld
28428 \begin_inset Quotes erd
28431 with the warnings from
28433 Chk\SpecialChar TeX
28436 , if there were any.
28437 The warnings will be placed close to the point of the mistake, and you
28438 can quickly find them by using the
28440 Navigate\SpecialChar menuseparator
28443 menu item, or the shortcut key
28452 Open the error boxes by clicking on them with the mouse, or use the shortcut
28461 bindings, or the corresponding
28470 Read the warning and correct the mistake, if it is a mistake.
28471 If you have trouble understanding what the warning is about, you can safely
28473 Remember that there is a hidden layer between the document on screen and
28474 the technical details in invoking
28476 Chk\SpecialChar TeX
28479 , and this gap can make some warnings seem arcane or just plain silly.
28482 \begin_layout Standard
28483 This document is an excellent testing bed for the feature, and it should
28484 provide quite a few warnings for you to fiddle with.
28485 Since computers are only so smart, expect most of the warnings to be false
28489 \begin_layout Subsection
28490 How to fine tune it
28493 \begin_layout Standard
28494 Sometimes, you'll find that
28496 Chk\SpecialChar TeX
28499 makes more noise than suits your mood.
28500 Then you can choose not to use it, wait until your mood changes, or try
28503 Chk\SpecialChar TeX
28506 to get better along with you.
28509 \begin_layout Standard
28512 Chk\SpecialChar TeX
28519 very configurable and extensible, you should not expect to solve all problems
28522 Chk\SpecialChar TeX
28525 in \SpecialChar LyX
28527 Since \SpecialChar LyX
28528 has to generate a somewhat special \SpecialChar LaTeX
28529 file to be able to match the
28530 line numbers from the
28532 Chk\SpecialChar TeX
28539 \begin_layout Plain Layout
28540 You can inspect the specific output from
28546 Document\SpecialChar menuseparator
28549 \begin_inset space ~
28563 to the internal document structure, some of the warnings will not appear
28565 There are two things you can do about this:
28568 \begin_layout Itemize
28571 Chk\SpecialChar TeX
28574 invocation command line in
28575 \begin_inset Flex Noun
28578 \begin_layout Plain Layout
28579 Tools\SpecialChar menuseparator
28580 Preferences\SpecialChar menuseparator
28581 Output\SpecialChar menuseparator
28582 LaTeX\SpecialChar menuseparator
28590 Chk\SpecialChar TeX
28593 installation configuration file (usually with the file
28598 See below to learn what warnings can be enabled and disabled on the command
28602 \begin_layout Itemize
28603 Export your document as a raw \SpecialChar LaTeX
28606 File\SpecialChar menuseparator
28607 Export\SpecialChar menuseparator
28616 Invoked in this way, it can be a hassle to find the corresponding place
28617 in the document inside \SpecialChar LyX
28618 , but with a little patience, you should be able
28622 \begin_layout Standard
28623 Here follows the warning messages that can be enabled and disabled in
28632 to disable a warning, and
28636 to enable a warning.
28637 The emphasized entries are disabled by default, because the default is
28640 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
28645 \begin_layout Standard
28646 Notice that you should only use the options that enable and disable warnings,
28647 because \SpecialChar LyX
28648 relies on some of the other command line parameters to be set
28649 in a specific way to have a chance to communicate with
28656 \begin_layout Enumerate
28660 Command terminated with space.
28663 \begin_layout Enumerate
28666 Non-breaking space (
28667 \begin_inset Quotes eld
28675 \begin_inset Quotes erd
28678 ) should have been used.
28681 \begin_layout Enumerate
28685 You should enclose the previous parenthesis with
28686 \begin_inset Quotes eld
28694 \begin_inset Quotes erd
28700 \begin_layout Enumerate
28703 Italic correction (
28704 \begin_inset Quotes eld
28714 \begin_inset Quotes erd
28717 ) found in non-italic buffer.
28720 \begin_layout Enumerate
28723 Italic correction (
28724 \begin_inset Quotes eld
28734 \begin_inset Quotes erd
28737 ) found more than once.
28740 \begin_layout Enumerate
28744 No italic correction (
28745 \begin_inset Quotes eld
28755 \begin_inset Quotes erd
28761 \begin_layout Enumerate
28765 \begin_inset Quotes eld
28773 \begin_inset Quotes erd
28777 \begin_inset Quotes eld
28785 \begin_inset Quotes erd
28791 \begin_layout Enumerate
28794 Wrong length of dash may have been used.
28797 \begin_layout Enumerate
28801 \begin_inset Quotes eld
28809 \begin_inset Quotes erd
28813 \begin_inset Quotes eld
28821 \begin_inset Quotes erd
28827 \begin_layout Enumerate
28831 \begin_inset Quotes eld
28839 \begin_inset Quotes erd
28845 \begin_layout Enumerate
28849 \begin_inset Quotes eld
28857 \begin_inset Quotes erd
28860 to achieve an ellipsis.
28863 \begin_layout Enumerate
28866 Inter-word spacing (
28867 \begin_inset Quotes eld
28877 \begin_inset Quotes eld
28880 ) should perhaps be used.
28883 \begin_layout Enumerate
28886 Inter-sentence spacing (
28887 \begin_inset Quotes eld
28897 \begin_inset Quotes erd
28900 ) should perhaps be used.
28903 \begin_layout Enumerate
28906 Could not find argument for command.
28909 \begin_layout Enumerate
28913 \begin_inset Quotes eld
28921 \begin_inset Quotes erd
28927 \begin_layout Enumerate
28930 Math mode still on at end of \SpecialChar LaTeX
28934 \begin_layout Enumerate
28938 \begin_inset Quotes eld
28946 \begin_inset Quotes erd
28949 doesn't match the number of
28950 \begin_inset Quotes eld
28958 \begin_inset Quotes erd
28964 \begin_layout Enumerate
28967 You should use either
28970 \begin_inset Quotes eld
28978 \begin_inset Quotes erd
28983 as an alternative to
28984 \begin_inset Quotes eld
28992 \begin_inset Quotes erd
28998 \begin_layout Enumerate
29005 " (ASCII 39) instead of "
29012 \begin_layout Enumerate
29015 User-specified pattern found.
29018 \begin_layout Enumerate
29021 This command might not be intended.
29024 \begin_layout Enumerate
29031 \begin_layout Enumerate
29049 \begin_layout Enumerate
29052 Delete this space to maintain correct page references.
29055 \begin_layout Enumerate
29059 You might wish to put this between a pair of
29060 \begin_inset Quotes eld
29068 \begin_inset Quotes erd
29074 \begin_layout Enumerate
29077 You ought to remove spaces in front of punctuation.
29080 \begin_layout Enumerate
29083 Could not execute \SpecialChar LaTeX
29087 \begin_layout Enumerate
29096 in front of small punctuation.
29099 \begin_layout Enumerate
29107 may look prettier here.
29110 \begin_layout Enumerate
29114 Multiple spaces detected in output.
29117 \begin_layout Enumerate
29120 This text may be ignored.
29123 \begin_layout Enumerate
29129 \begin_inset Quotes eld
29134 to begin quotation, not
29141 \begin_layout Enumerate
29148 to end quotation, not
29151 \begin_inset Quotes eld
29159 \begin_layout Enumerate
29165 \begin_layout Enumerate
29168 You should perhaps use
29169 \begin_inset Quotes eld
29177 \begin_inset Quotes erd
29183 \begin_layout Enumerate
29186 You should put a space in front of/after parenthesis.
29189 \begin_layout Enumerate
29192 You should avoid spaces in front of/after parenthesis.
29195 \begin_layout Enumerate
29199 You should not use punctuation in front of/after quotes.
29202 \begin_layout Enumerate
29205 Double space found.
29208 \begin_layout Enumerate
29211 You should put punctuation outside inner/inside display math mode.
29214 \begin_layout Enumerate
29217 You ought to not use primitive \SpecialChar TeX
29218 in \SpecialChar LaTeX
29222 \begin_layout Enumerate
29225 You should remove spaces in front of
29226 \begin_inset Quotes eld
29234 \begin_inset Quotes erd
29240 \begin_layout Enumerate
29243 \begin_inset Quotes eld
29251 \begin_inset Quotes erd
29254 is normally not followed by
29255 \begin_inset Quotes eld
29263 \begin_inset Quotes erd
29269 \begin_layout Standard
29270 In later versions of \SpecialChar LyX
29271 , we hope to provide a more complete interface to this
29272 tool (and it's smaller cousin
29276 ) to exploit the full power of it.
29277 But it's not exactly useless as it is now: go try it on one of your existing
29278 documents of a certain length and be surprised.
29281 \begin_layout Section
29282 Version Control in \SpecialChar LyX
29286 \begin_layout Standard
29289 Lars Gullik Bjønnes
29296 \begin_layout Subsection
29300 \begin_layout Standard
29302 supports some of the most basic RCS/CVS/SVN/GIT commands.
29303 If you need something a bit more sophisticated you will have to do that
29304 manually in a terminal.
29307 \begin_layout Standard
29308 Also note that CVS support is not as good as subversion support, so we advise
29310 A good place to start learning Subversion is the SVN Book
29314 \begin_layout Plain Layout
29315 \begin_inset CommandInset href
29317 target "http://svnbook.red-bean.com/"
29328 In the case of RCS you should read
29329 \begin_inset Quotes eld
29333 \begin_inset Quotes erd
29336 (a man file, read it with
29341 This file describes all the basic features of RCS.
29342 You should especially notice the comment about a RCS directory, and the
29343 notion of a master RCS file (the file ending in
29350 \begin_layout Standard
29351 Before you begin to use the version control features in \SpecialChar LyX
29353 familiar with RCS/CVS/SVN/GIT usage.
29354 The implementation in \SpecialChar LyX
29355 assumes a recent version of the GNU RCS or CVS/SVN
29356 package — no guarantees are made for older versions.
29357 Most of the log messages are not currently displayed after operations —
29358 you can check them in the Messages pane if you are unsure.
29359 Regular users of version control will appreciate the VC toolbar, which
29362 View\SpecialChar menuseparator
29363 Toolbars\SpecialChar menuseparator
29365 \begin_inset space ~
29373 \begin_layout Standard
29374 For introducing your own external commands consult
29375 \begin_inset Flex Code
29378 \begin_layout Plain Layout
29392 \begin_layout Standard
29393 It is strongly recommended to store documents in uncompressed format if
29394 using version control (uncheck
29396 Document\SpecialChar menuseparator
29399 if it is checked): Uncompressed LyX documents are text files and therefore
29400 for merging two different versions by version control systems.
29401 Compressed LyX documents are binary files, which cannot be merged by version
29405 \begin_layout Subsection
29406 RCS commands in \SpecialChar LyX
29410 \begin_layout Standard
29411 The following sections describe the RCS commands supported by \SpecialChar LyX
29413 You can find them in the
29415 File\SpecialChar menuseparator
29417 \begin_inset space ~
29424 was tested against RCS 5.7/5.8.
29427 \begin_layout Subsubsection
29433 \begin_layout Standard
29434 If your document is not under revision control, this is the only item shown
29436 And if it is under revision control, the
29440 item is not visible.
29444 \begin_layout Standard
29445 This command registers your document with RCS (unless you are under the
29446 directory managed by CVS)\SpecialChar endofsentence
29447 You are asked interactively to supply an initial
29448 description of the document.
29449 The document is now set in Read-Only mode and you have to
29452 \begin_inset space ~
29456 \begin_inset space ~
29460 \begin_inset space ~
29465 , before making any changes to it.
29466 A document under revision control has a
29467 \begin_inset Quotes eld
29470 [RCS:<version> <locker>]
29471 \begin_inset Quotes erd
29474 item tagged to the filename in the minibuffer.
29477 \begin_layout Standard
29478 RCS command that is run:
29481 \begin_layout LyX-Code
29484 ci -q -u -i -t-"<initial description>" <file-name>
29487 \begin_layout Standard
29492 to understand the switches.
29496 \begin_layout Subsubsection
29502 \begin_layout Standard
29503 When you are finished editing a file, you check in your changes.
29504 When you do this, you are asked for a description of the changes.
29505 This is stored in the history log.
29506 The version number is bumped, your changes are applied to the master RCS
29507 file, the document is unlocked and set to Read-Only mode.
29510 \begin_layout Itemize
29513 ci -q -u -m"<description>" <file-name>
29516 \begin_layout Subsubsection
29522 \begin_layout Standard
29523 By doing this you lock the document so that only you can edit it.
29524 This will also make the document Read-Write only for you.
29525 You will usually continue editing for a while and when you are finished
29526 you check in your changes.
29527 The status line is changed to reflect that you have locked the file.
29530 \begin_layout Itemize
29533 co -q -l <file-name>
29536 \begin_layout Subsubsection
29539 Revert To Repository Version
29542 \begin_layout Standard
29543 This will discard all changes made to the document since the last check
29545 You get a warning before changes are discarded.
29548 \begin_layout Itemize
29551 co -f -u<version> <file-name>
29554 \begin_layout Subsubsection
29560 \begin_layout Standard
29561 This will create a copy of the current document.
29562 Since RCS does not support copy operations natively, the version history
29563 is not preserved, and the copy is added as a new file.
29564 It requires a clean document without any changes since the last checkin.
29565 You are asked for a file name and a description of the copy operation.
29566 After that the copy is created, both locally and in the repository.
29567 If the parent directories of the copied and original document differ, all
29568 relative paths of included files of the copy are adjusted (like in
29570 File\SpecialChar menuseparator
29575 Finally, the copy is loaded instead of the original document.
29578 \begin_layout Labeling
29579 \labelwidthstring 00.00.0000
29581 \begin_inset space ~
29585 \begin_inset space ~
29589 \begin_inset Newline newline
29593 \begin_inset Flex Code
29596 \begin_layout Plain Layout
29599 \begin_inset Quotes qld
29603 \begin_inset Quotes qld
29612 \begin_inset Flex Code
29615 \begin_layout Plain Layout
29618 \begin_inset Quotes qld
29622 \begin_inset Quotes qld
29631 \begin_inset Newline newline
29635 \begin_inset Flex Code
29638 \begin_layout Plain Layout
29642 \begin_inset Quotes qld
29646 \begin_inset Quotes qld
29657 \begin_layout Subsubsection
29663 \begin_layout Standard
29664 This makes as if the last check in never happened.
29665 No changes are made to the document loaded into \SpecialChar LyX
29666 , but the last version
29667 is removed from the master RCS file.
29670 \begin_layout Itemize
29673 rcs -o<version> <file-name>
29676 \begin_layout Subsubsection
29682 \begin_layout Standard
29683 This shows the complete history of the RCS document.
29688 is shown in a browser.
29696 \begin_layout Subsubsection
29700 \begin_layout Standard
29702 supports RCS version number, author name, date and time of last commit.
29703 All those are extracted from
29705 rlog -r <file-name>
29709 \begin_inset CommandInset ref
29711 reference "subsec:VCS-Revision-Information"
29718 \begin_layout Subsection
29719 CVS commands in \SpecialChar LyX
29723 \begin_layout Standard
29724 A subset of CVS operations is supported by \SpecialChar LyX
29726 You can find the commands in the
29728 File\SpecialChar menuseparator
29730 \begin_inset space ~
29736 The version control system SVN is more powerful, so please use it instead
29737 of CVS if possible.
29740 \begin_layout Subsubsection
29746 \begin_layout Standard
29747 If you start from scratch with CVS you have to create your repository and
29748 checkout the working copy with external tools.
29749 If you're using a client-server setup you may need to login before doing
29750 the first repository checkout.
29753 \begin_layout Standard
29754 If your documents are under revision control and others are using the same
29755 repository problems arise when different changes to the same document at
29756 the same location happen.
29757 Standard CVS repositories don't operate with a file locking mechanism.
29758 This may be surprising, but conflicts only occur if people disagree on
29759 the proper content of the same part of a document.
29760 So, if co-workers are used to communicate regularly, these conflicts occur
29762 If they don't communicate they have a fundamental problem anyway.
29763 Nevertheless some people like to work with so called
29764 \begin_inset Quotes eld
29768 \begin_inset Quotes erd
29772 If they do so the working copy of all files is readonly when checked out
29773 first and the user starts editing after using a special command to make
29774 the working copy writable.
29775 When the changes are checked in the working copy returns to readonly state.
29776 With \SpecialChar LyX
29777 one has to edit the
29778 \begin_inset Flex Code
29781 \begin_layout Plain Layout
29787 file and add the line
29788 \begin_inset Flex Code
29791 \begin_layout Plain Layout
29797 to work with reserved checkouts.
29798 The benefit is the possibility to see who is using a writable copy of some
29800 It's not guaranteed only one user makes a copy writable.
29803 \begin_layout Standard
29805 tries to guess if you're using reserved or non-reserved checkouts.
29806 If your working copy is readonly or it is writable and an additional copy
29807 of your document exists in the CVS/Base sub-directory a reserved otherwise
29808 a non-reserved checkout is assumed.
29809 When a reserved checkout is detected you have to use
29810 \begin_inset Flex Noun
29813 \begin_layout Plain Layout
29819 to make your working copy writable if it's readonly.
29821 \begin_inset Flex Noun
29824 \begin_layout Plain Layout
29830 operation is possible and that makes your working copy readonly again after
29831 transferring your changes to the repository.
29834 \begin_layout Standard
29835 More information about CVS can be found here
29836 \begin_inset Flex URL
29839 \begin_layout Plain Layout
29841 http://www.nongnu.org/cvs
29847 \begin_inset Flex URL
29850 \begin_layout Plain Layout
29852 http://ximbiot.com/cvs
29860 \begin_layout Standard
29865 to understand the sub-commands and the switches mentioned below.
29868 \begin_layout Subsubsection
29874 \begin_layout Standard
29875 If your document is not under revision control, this is the only item shown
29877 And if it is under revision control, the
29881 item is not visible.
29885 \begin_layout Standard
29886 This command registers in CVS your document
29887 \begin_inset Flex Strong
29890 \begin_layout Plain Layout
29898 in the case you have already the documents directory under CVS control
29904 This means you have to create or checkout the archive by yourself using
29906 (In case you forget that step \SpecialChar LyX
29907 registers the document with RCS.)
29910 \begin_layout Standard
29911 Then you are asked interactively to supply an initial description of the
29913 Don't forget that registered file is not yet checked in.
29916 \begin_layout Standard
29917 CVS command that is run:
29919 cvs -q add -m"<entered message>" "<file-name>"
29922 \begin_layout Standard
29927 above and for all other CVS commands is an abbreviation for
29928 \begin_inset Quotes eld
29931 change the current working directory to file location and use the file name
29932 without path component as argument
29933 \begin_inset Quotes erd
29939 \begin_layout Subsubsection
29945 \begin_layout Standard
29946 When you are finished editing a file, you commit your changes.
29947 When you do this and you had changed the document, you are asked for a
29948 description of the changes.
29949 After that changes are written to the repository.
29950 In case you didn't change the document and a reserved checkout is detected
29951 the reservation made on
29952 \begin_inset Flex Noun
29955 \begin_layout Plain Layout
29964 \begin_layout Labeling
29965 \labelwidthstring 00.00.0000
29967 \begin_inset space ~
29971 \begin_inset space ~
29975 \begin_inset Newline newline
29979 \begin_inset Flex Code
29982 \begin_layout Plain Layout
29985 -q commit -m"<description>" "<file-name>"
29991 \begin_inset Newline newline
29995 \begin_inset Flex Code
29998 \begin_layout Plain Layout
30009 \begin_layout Subsubsection
30015 \begin_layout Standard
30016 When you are sharing a repository with others, you may have to incorporate
30017 their changes into your working copy.
30020 \begin_layout Standard
30023 cvs -q update "<file-name>"
30026 \begin_layout Standard
30027 If a readonly checkout is detected the working copy is made writable and
30031 \begin_layout Standard
30034 cvs -q edit "<file-name>"
30037 \begin_layout Subsubsection
30040 Revert To Repository Version
30043 \begin_layout Standard
30044 This will discard all changes made to the document since the last check
30046 You get a warning before changes are discarded.
30047 Firstly the file is deleted, secondly CVS update command is run.
30050 \begin_layout Standard
30053 cvs -q update "<file-name>"
30056 \begin_layout Standard
30057 If a reserved checkout is detected and the working copy has no changes only
30058 the reservation is undone.
30061 \begin_layout Standard
30064 cvs -q unedit "<file-name>"
30067 \begin_layout Subsubsection
30073 \begin_layout Standard
30074 This will create a copy of the current document.
30075 Since CVS does not support copy operations natively, the version history
30076 is not preserved, and the copy is added as a new file.
30077 It requires a clean document without any changes since the last checkin.
30078 You are asked for a file name and a description of the copy operation.
30079 After that the copy is created, both locally and in the repository.
30080 If the parent directories of the copied and original document differ, all
30081 relative paths of included files of the copy are adjusted (like in
30083 File\SpecialChar menuseparator
30088 Finally, the copy is loaded instead of the original document.
30091 \begin_layout Labeling
30092 \labelwidthstring 00.00.0000
30094 \begin_inset space ~
30098 \begin_inset space ~
30102 \begin_inset Newline newline
30106 \begin_inset Flex Code
30109 \begin_layout Plain Layout
30116 \begin_inset Flex Code
30119 \begin_layout Plain Layout
30126 \begin_inset Newline newline
30130 \begin_inset Flex Code
30133 \begin_layout Plain Layout
30134 cvs -q add "<new-file-name>"
30142 \begin_layout Subsubsection
30148 \begin_layout Standard
30149 This will rename the current document.
30150 Since CVS does not support rename operations natively, the version history
30151 is not preserved, the renamed document is added as a new file, and the
30152 original document is deleted.
30153 It requires a clean document without any changes since the last checkin.
30154 You are asked for a file name and a description of the rename operation.
30155 After that the document is renamed, both locally and in the repository.
30156 If the parent directories of the new and old file names differ, all relative
30157 paths of included files are adjusted (like in
30159 File\SpecialChar menuseparator
30164 Finally, the document is reloaded using the new name.
30167 \begin_layout Labeling
30168 \labelwidthstring 00.00.0000
30170 \begin_inset space ~
30174 \begin_inset space ~
30178 \begin_inset Newline newline
30182 \begin_inset Flex Code
30185 \begin_layout Plain Layout
30192 \begin_inset Flex Code
30195 \begin_layout Plain Layout
30202 \begin_inset Newline newline
30206 \begin_inset Flex Code
30209 \begin_layout Plain Layout
30210 cvs -q add "<new-file-name>"
30216 \begin_inset Newline newline
30220 \begin_inset Flex Code
30223 \begin_layout Plain Layout
30224 cvs -q remove "<file-name>"
30232 \begin_layout Subsubsection
30233 Update of the local directory checkout from repository
30236 \begin_layout Standard
30237 Once your documents gets more complex, containing sub-documents and pictures,
30239 \begin_inset Flex Code
30242 \begin_layout Plain Layout
30248 files and so on using version control becomes more complicated.
30250 supports updating the whole tree in which resides the document.
30251 This become especially useful once you cooperate with people which neither
30252 have detailed knowledge about CVS usage nor they have ambition to commit
30253 additional material to the repository.
30254 You have to organize the files structure so that all external files are
30255 in the same directory or subdirectories of the document.
30256 It's good practice anyway to store multipart documents in an extra directory.
30259 \begin_layout Standard
30261 \begin_inset Flex Code
30264 \begin_layout Plain Layout
30265 Update local directory from repository
30270 command updates the whole directory.
30271 If local changes are detected user is warned before update starts.
30272 In case of merge conflicts both versions of the conflicting document parts
30273 are placed in the final document.
30274 You have to review and correct the result of the merge.
30275 You'll find the conflicts enclosed in pairs of
30276 \begin_inset Flex Code
30279 \begin_layout Plain Layout
30286 \begin_inset Flex Code
30289 \begin_layout Plain Layout
30296 \begin_inset Flex Code
30299 \begin_layout Plain Layout
30306 The first part is your version as before the update operation with the
30307 document name prepended.
30308 The second one is the repository version with the version number after
30310 \begin_inset Flex Code
30313 \begin_layout Plain Layout
30322 \begin_layout Labeling
30323 \labelwidthstring 00.00.0000
30325 \begin_inset space ~
30329 \begin_inset space ~
30333 \begin_inset Newline newline
30337 \begin_inset Flex Code
30340 \begin_layout Plain Layout
30348 (Ask if changes are detected.)
30349 \begin_inset Newline newline
30353 \begin_inset Flex Code
30356 \begin_layout Plain Layout
30357 cd $path; cvs -q update
30367 \begin_layout Standard
30369 \begin_inset Flex Code
30372 \begin_layout Plain Layout
30378 stands for the path to the document.
30381 \begin_layout Subsubsection
30387 \begin_layout Standard
30388 This shows the complete history of the CVS document.
30391 cvs log "<file-name>"
30393 is shown in a browser.
30396 \begin_layout Subsubsection
30400 \begin_layout Standard
30402 supports CVS version number, author name, date and time of last commit.
30403 All those are extracted from
30405 cvs log -r <file-name>
30409 \begin_inset CommandInset ref
30411 reference "subsec:VCS-Revision-Information"
30418 \begin_layout Subsection
30419 SVN commands in \SpecialChar LyX
30423 \begin_layout Standard
30424 SVN is now partially supported by \SpecialChar LyX
30426 You can find the commands in the
30428 File\SpecialChar menuseparator
30430 \begin_inset space ~
30436 Please note that if you use password protected access to repository via
30437 ssh, you will be asked in terminal window.
30439 was tested against SVN 1.5, 1.6, 1.7 and 1.8
30443 \begin_layout Plain Layout
30444 Most of the commands will work with 1.4 too, see
30445 \begin_inset CommandInset ref
30447 reference "subsec:SVN-Repo-Update"
30452 There seems to be currently unresolved permissions problem under SVN 1.8
30453 with reverting changes when file is locked.
30461 \begin_layout Subsubsection
30467 \begin_layout Standard
30468 If your document is not under revision control, this is the only item shown
30470 And if it is under revision control, the
30474 item is not visible.
30477 \begin_layout Standard
30478 This command registers in SVN your document ONLY in case you have already
30479 the documents directory under SVN control (in particular
30484 This means you have to checkout the archive by yourself.
30487 \begin_layout Standard
30488 Then you are asked interactively to supply an initial description of the
30490 Don't forget that registered file is not yet commited.
30493 \begin_layout Standard
30494 SVN command that is run:
30497 \begin_inset Quotes qld
30501 \begin_inset Quotes qld
30507 \begin_layout Standard
30512 to understand the switches.
30515 \begin_layout Subsubsection
30521 \begin_layout Standard
30522 When you are finished editing a file, you commit your changes.
30523 When you do this, you are asked for a description of the changes.
30524 After that changes are commited.
30527 \begin_layout Standard
30532 \begin_layout Plain Layout
30533 In case locking is not enabled.
30535 \begin_inset CommandInset ref
30537 reference "subsec:SVN-File-Locking"
30548 svn commit -q -m"<description>" <file-name>
30551 \begin_layout Subsubsection
30557 \begin_layout Standard
30558 Updates the changes of this file from the repository.
30559 Be sure you understand SVN merging and conflicts resolving before using
30560 this function, because all conflicts has to be resolved manually by you!
30563 \begin_layout Standard
30568 \begin_layout Plain Layout
30576 svn update --non-interactive
30577 \begin_inset Quotes qld
30581 \begin_inset Quotes qld
30587 \begin_layout Subsubsection
30590 Revert To Repository Version
30593 \begin_layout Standard
30594 This will discard all changes made to the document since the last check
30596 You get a warning before changes are discarded.
30599 \begin_layout Standard
30603 \begin_inset Quotes qld
30607 \begin_inset Quotes qld
30613 \begin_layout Subsubsection
30619 \begin_layout Standard
30620 This will create a copy of the current document including the version history.
30621 It requires a clean document without any changes since the last checkin.
30622 You are asked for a file name and a description of the copy operation.
30623 After that the copy is created, both locally and in the repository.
30624 If the parent directories of the copied and original document differ, all
30625 relative paths of included files of the copy are adjusted (like in
30627 File\SpecialChar menuseparator
30632 Finally, the copy is loaded instead of the original document.
30635 \begin_layout Labeling
30636 \labelwidthstring 00.00.0000
30638 \begin_inset space ~
30642 \begin_inset space ~
30646 \begin_inset Newline newline
30650 \begin_inset Flex Code
30653 \begin_layout Plain Layout
30657 \begin_inset Quotes qld
30661 \begin_inset Quotes qld
30665 \begin_inset Quotes qld
30669 \begin_inset Quotes qld
30678 \begin_inset Newline newline
30682 \begin_inset Flex Code
30685 \begin_layout Plain Layout
30694 \begin_layout Subsubsection
30700 \begin_layout Standard
30701 This will rename the current document including the version history.
30702 It requires a clean document without any changes since the last checkin.
30703 You are asked for a file name and a description of the rename operation.
30704 After that the document is renamed, both locally and in the repository.
30705 If the parent directories of the new and old file names differ, all relative
30706 paths of included files are adjusted (like in
30708 File\SpecialChar menuseparator
30713 Finally, the document is reloaded using the new name.
30716 \begin_layout Labeling
30717 \labelwidthstring 00.00.0000
30719 \begin_inset space ~
30723 \begin_inset space ~
30727 \begin_inset Newline newline
30731 \begin_inset Flex Code
30734 \begin_layout Plain Layout
30738 \begin_inset Quotes qld
30742 \begin_inset Quotes qld
30746 \begin_inset Quotes qld
30750 \begin_inset Quotes qld
30759 \begin_inset Newline newline
30763 \begin_inset Flex Code
30766 \begin_layout Plain Layout
30775 \begin_layout Subsubsection
30776 \begin_inset CommandInset label
30778 name "subsec:SVN-Repo-Update"
30782 Update of the local directory checkout from repository
30786 \begin_layout Plain Layout
30787 Note that this command will work only with subversion
30788 \begin_inset Formula $\geqq1.5$
30799 \begin_layout Standard
30800 All the commands above have one shortcoming – they deal with the current
30802 Once your document contains pictures, includes external
30803 \begin_inset Flex Code
30806 \begin_layout Plain Layout
30812 files and so on administration becomes more complicated.
30814 now supports updating the whole tree in which resides the document
30818 \begin_layout Plain Layout
30819 One need to organize the files structure so that all external files are
30820 in the same directory or subdirectories of the document.
30827 This become especially useful once you cooperate with people which neither
30828 know about subversion management nor they have ambition to commit additional
30829 material to the repository.
30833 \begin_layout Standard
30834 \begin_inset Flex Code
30837 \begin_layout Plain Layout
30838 Update local directory from repository
30843 command updates the whole directory and in case of merge conflicts local
30844 version of the files are left, so no unintended data loss occurs.
30845 If local changes are detected user is warned before update starts.
30848 \begin_layout Labeling
30849 \labelwidthstring 00.00.0000
30851 \begin_inset space ~
30855 \begin_inset space ~
30859 \begin_inset Newline newline
30863 \begin_inset Flex Code
30866 \begin_layout Plain Layout
30872 (Ask if changes are detected.)
30873 \begin_inset Newline newline
30877 \begin_inset Flex Code
30880 \begin_layout Plain Layout
30881 svn update --accept mine-full $path
30889 \begin_layout Standard
30891 \begin_inset Flex Code
30894 \begin_layout Plain Layout
30900 stands for the path to the document.
30903 \begin_layout Subsubsection
30909 \begin_layout Standard
30910 This shows the complete history of the SVN document.
30914 \begin_inset Quotes qld
30918 \begin_inset Quotes qld
30923 is shown in a browser.
30926 \begin_layout Subsubsection
30928 \begin_inset CommandInset label
30930 name "subsec:SVN-File-Locking"
30937 \begin_layout Standard
30938 The file exchange through various revision control systems brings the problem
30939 of merge conflicts in case two different users try to edit the same (parts
30941 When such a conflict happens it needs manual resolving and one reasonable
30942 alternative is to provide some kind of locking mechanism, which guarantees
30943 that only one user is allowed to edit file at the given time.
30946 \begin_layout Standard
30947 SVN has two such mechanisms to provide mutual exclusivity for file access
30948 – locks and automatic setting of write permissions (see sec.
30950 \begin_inset CommandInset ref
30952 reference "subsec:Automatical-Locking-Property"
30957 \begin_inset Flex Code
30960 \begin_layout Plain Layout
30970 \begin_layout Plain Layout
30971 \begin_inset Flex URL
30974 \begin_layout Plain Layout
30976 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
30987 If this property is detected for a given document \SpecialChar LyX
30988 starts to use SVN locks
30989 for document editing automatically and the whole check-in/out mechanism
30990 switches to the same regimen as for RCS.
30991 This in particular means there are two different modes of file use in \SpecialChar LyX
30995 \begin_layout Itemize
30997 The loaded file is in the read-only mode.
30998 For editing on needs to check-out.
31003 consists of updating from the repository and gaining write lock.
31004 If the lock is not possible to obtain, we remain in unlocked state.
31007 \begin_layout Itemize
31009 The loaded file is in the
31010 \begin_inset Quotes els
31014 \begin_inset Quotes ers
31018 No other user is allowed to edit the file.
31023 consists of commiting changes and releasing write-lock.
31024 If no changes have been made to the document, no commit will be produced
31028 \begin_layout Plain Layout
31029 Don't be puzzled by the fact that you will be asked for commit message anyway.
31034 and only the write-lock will be released.
31037 \begin_layout Standard
31041 \begin_layout Labeling
31042 \labelwidthstring 00.00.0000
31045 svn commit -q -m"<description>" "<file-name>"
31046 \begin_inset Newline newline
31049 svn unlock "<file-name>"
31052 \begin_layout Labeling
31053 \labelwidthstring 00.00.0000
31056 svn update "<file-name>"
31057 \begin_inset Newline newline
31060 svn lock "<file-name>"
31063 \begin_layout Subsubsection
31066 \begin_inset CommandInset label
31068 name "subsec:Automatical-Locking-Property"
31074 Automatic Locking Property
31077 \begin_layout Standard
31078 The above mentioned automatic setting of write permissions of the .lyx file
31081 File\SpecialChar menuseparator
31083 \begin_inset space ~
31086 Control\SpecialChar menuseparator
31087 Use Locking Property
31090 This command is active only when the file is not locked on the svn server
31092 you need to check-out before proceeding).
31095 \begin_layout Labeling
31096 \labelwidthstring 00.00.0000
31098 \begin_inset space ~
31104 \begin_layout Labeling
31105 \labelwidthstring 00.00.0000
31108 svn propset svn:needs-lock ON "<file-name>"
31111 \begin_layout Labeling
31112 \labelwidthstring 00.00.0000
31115 svn propdel svn:needs-lock "<file-name>"
31118 \begin_layout Subsubsection
31119 \begin_inset CommandInset label
31121 name "subsec:VCS-Revision-Information"
31125 Revision Information in Documents
31128 \begin_layout Standard
31129 There are more possibilities how to activate revision information in our
31133 \begin_layout Itemize
31139 \begin_layout Itemize
31140 tree revision information (
31141 \begin_inset Flex Code
31144 \begin_layout Plain Layout
31151 The result is the output of the
31152 \begin_inset Flex Code
31155 \begin_layout Plain Layout
31161 command, the following table gives you an idea, how to read the results.
31164 \begin_layout Standard
31166 \begin_inset Tabular
31167 <lyxtabular version="3" rows="6" columns="2">
31168 <features tabularvalignment="middle">
31169 <column alignment="left" valignment="top">
31170 <column alignment="left" valignment="top">
31172 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
31175 \begin_layout Plain Layout
31183 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
31186 \begin_layout Plain Layout
31196 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
31199 \begin_layout Plain Layout
31205 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
31208 \begin_layout Plain Layout
31209 mixed revision working copy
31216 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
31219 \begin_layout Plain Layout
31225 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
31228 \begin_layout Plain Layout
31229 modified working copy
31236 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
31239 \begin_layout Plain Layout
31245 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
31248 \begin_layout Plain Layout
31249 switched working copy
31256 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
31259 \begin_layout Plain Layout
31265 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
31268 \begin_layout Plain Layout
31269 partial working copy, from a sparse checkout
31276 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
31279 \begin_layout Plain Layout
31285 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
31288 \begin_layout Plain Layout
31289 mixed revision, modified, switched working copy
31302 \begin_layout Itemize
31303 file revision information.
31304 The result comes from parsing the output of
31305 \begin_inset Flex Code
31308 \begin_layout Plain Layout
31310 \begin_inset space ~
31314 \begin_inset space ~
31318 \begin_inset space ~
31327 Supported flags are:
31331 \begin_layout Itemize
31332 version number of the last commit (
31333 \begin_inset Flex Code
31336 \begin_layout Plain Layout
31345 \begin_layout Itemize
31346 author of the last commit (
31347 \begin_inset Flex Code
31350 \begin_layout Plain Layout
31359 \begin_layout Itemize
31360 date of the last commit (
31361 \begin_inset Flex Code
31364 \begin_layout Plain Layout
31373 \begin_layout Itemize
31374 time of the last commit (
31375 \begin_inset Flex Code
31378 \begin_layout Plain Layout
31388 \begin_layout Standard
31389 You can obtain this info via InsetInfo (
31390 \change_inserted 5863208 1564400022
31393 Insert\SpecialChar menuseparator
31394 Field\SpecialChar menuseparator
31395 Version Control Revision
31396 \change_deleted 5863208 1564399852
31401 \begin_inset Flex Code
31404 \begin_layout Plain Layout
31405 info-insert buffer vcs-date
31413 The information will be available only when you have the file stored under
31414 svn managment (i.e.
31416 \begin_inset Flex Code
31419 \begin_layout Plain Layout
31425 directory is available with your document).
31429 \begin_layout Itemize
31430 Another—a hacking one—possibility is to use svn keywords
31434 \begin_layout Plain Layout
31435 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
31441 In short – you set file keywords property (e.g.
31444 svn propset svn:keywords 'Rev' file.lyx
31446 ) and then paste keyword \SpecialChar TeX
31451 \begin_layout Plain Layout
31452 This is an easy way how to ensure that \SpecialChar LyX
31453 won't break the line in the middle
31459 tag in your document (e.g.
31461 \begin_inset Flex Code
31464 \begin_layout Plain Layout
31471 This way svn client will automatically substitute revision number (e.g.
31473 \begin_inset Flex Code
31476 \begin_layout Plain Layout
31482 ) after each update and commit.
31483 There are more problems with this approach.
31484 Firstly, the '$' character is used in \SpecialChar TeX
31485 world for math equations, so any
31486 occurence of math formula
31487 \begin_inset Formula $Rev$
31491 \begin_inset Formula $Rev:59$
31494 in your \SpecialChar LyX
31496 Similarly for other keywords like Id, Date, Author, etc.
31497 Secondly svn output is dependent on your locales, so its very easy that
31498 svn would produce some problematic strings once Date is used.
31499 Thirdly you get the whole 'Rev: 59' string in your document instead of
31501 Until subversion implements user's custom keywords it will be hard to use
31502 this approach reliably or let \SpecialChar LyX
31503 to support it directly.
31506 \begin_layout Subsection
31507 SVN and Windows Environment
31510 \begin_layout Quote
31511 My inclination is to say that if the user cannot figure out the command
31512 line operations on their own fairly quickly, they would be well advised
31513 to use TortoiseSVN.
31519 \begin_layout Subsubsection
31523 \begin_layout Standard
31524 In addition to installing \SpecialChar LyX
31525 , and having access to a Subversion repository,
31526 the user will need to install the Subversion client program.
31527 A Windows installer for the client program is available from
31528 \begin_inset CommandInset href
31531 target "http://www.collab.net/nonav/downloads/subversion/"
31537 The user may also want to install
31538 \begin_inset CommandInset href
31541 target "http://tortoisesvn.tigris.org/"
31546 , which integrates Subversion operations into the context (rightclick) menu
31547 of Windows Explorer.
31548 Operations done outside \SpecialChar LyX
31549 will typically be more convenient using the Explorer
31551 Note that TortoiseSVN is not a replacement for the client program, which
31552 is what \SpecialChar LyX
31556 \begin_layout Subsubsection
31557 Bringing a document under Subversion control
31560 \begin_layout Standard
31561 Before a \SpecialChar LyX
31562 document can be brought under version control in Subversion, its
31563 parent directory needs to be under version control.
31564 If the document is being added to a project already in the repository,
31565 this is accomplished by checking the project out to the directory where
31566 the new document will be placed.
31567 If the project itself is not yet under version control (for instance, if
31568 this document starts a new project), the directory must be imported into
31570 This is done outside \SpecialChar LyX
31572 Both import and checkout are easily accomplished from the Explorer context
31573 menu using TortoiseSVN, or alternatively can be done using the command
31574 line client at a DOS prompt.
31575 The procedure for importing the project using TortoiseSVN is described
31576 below, assuming an existing repository and a new project being started
31584 For information on using the Subversion client program, run
31591 \begin_layout Enumerate
31598 in Windows Explorer, right click it, and select
31600 TortoiseSVN\SpecialChar menuseparator
31604 If necessary, adjust the URL for the repository, then click OK.
31607 \begin_layout Enumerate
31608 Right click the level of the repository under which you want to place the
31609 new project folder (typically the top level) and click
31613 Supply a name for the project folder and click OK.
31614 Add a message for the log file if desired, then click OK again.
31615 The new project folder should appear in the repository.
31616 Finally, click OK again to exit the repository browser.
31619 \begin_layout Enumerate
31620 Once again right click
31626 , this time selecting SVN Checkout\SpecialChar ldots
31627 Select the URL of the project folder
31628 you just created in the repository, and set the checkout directory to
31636 You will be warned about a non-empty folder; click OK to proceed.
31637 You should now have a
31648 \begin_layout Enumerate
31649 Create or open your document in \SpecialChar LyX
31652 File\SpecialChar menuseparator
31654 \begin_inset space ~
31657 Control\SpecialChar menuseparator
31661 Add a log message and click OK to commit the document to version control.
31664 \begin_layout Standard
31665 From this point onward, you should have full functionality in the
31667 File\SpecialChar menuseparator
31669 \begin_inset space ~
31675 You also have the option of checking the document in and out, viewing its
31677 using the TortoiseSVN context menu in Windows Explorer or the Subversion
31678 client program from a command prompt.
31681 \begin_layout Subsubsection
31682 SSH tunnel used with SVN under Windows
31685 \begin_layout Standard
31686 Compared with Linux setting up an svn client to communicate over ssh under
31687 Windows is a rather troublesome task.
31688 We will at least offer some hints how to setup the client side but prior
31689 knowledge about ssh and the Windows command line is needed, also be prepared
31690 for a great deal of frustration\SpecialChar ldots
31694 \begin_layout Enumerate
31695 Get an svn client for windows, as described in the previous sections.
31696 When it is a fresh install run some svn command (e.g.
31698 \begin_inset Flex Code
31701 \begin_layout Plain Layout
31707 ) to create config files, which you will need to change later on.
31710 \begin_layout Enumerate
31711 Choose an ssh client for Windows.
31712 There are several possibilities, we will use the one from Putty tools
31716 \begin_layout Plain Layout
31717 \begin_inset Flex URL
31720 \begin_layout Plain Layout
31722 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
31733 You will need to set the connection up so that the client doesn't ask for
31734 any password from you.
31735 To keep things easy we will use only keys without any additional password
31740 \begin_layout Enumerate
31742 \begin_inset Flex Code
31745 \begin_layout Plain Layout
31752 Save your private .ppk key file and put the public one on the server side.
31753 If the SVN server runs on Linux, note that the format of the public key
31754 is not compatible with Linux openssh and you will need to direcly copy-paste
31756 \begin_inset Quotes eld
31761 Public key for pasting into OpenSSH authorized_keys file
31764 \begin_inset Quotes erd
31767 edit field into the server's
31768 \begin_inset Flex Code
31771 \begin_layout Plain Layout
31772 ~/.ssh/authorized_keys
31778 \begin_inset Flex Code
31781 \begin_layout Plain Layout
31790 \begin_layout Enumerate
31792 \begin_inset Flex Code
31795 \begin_layout Plain Layout
31802 In the SVN config file
31806 \begin_layout Plain Layout
31807 Exact path depends on Windows version, usually somewhere around
31808 \begin_inset Flex Code
31811 \begin_layout Plain Layout
31814 Documents and Settings
31828 \begin_inset Flex Code
31831 \begin_layout Plain Layout
31846 , section [tunnels], setup ssh command, e.g.
31848 \begin_inset Flex Code
31851 \begin_layout Plain Layout
31852 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
31861 \begin_layout Plain Layout
31862 It will usually take a lot of time to get exact command right and it depends
31864 For example do not have some remote server saved as a default session in
31866 If things fail, try to connect via plink without SVN first.
31875 \begin_layout Enumerate
31876 Checkout the SVN archive, e.
31877 \begin_inset space \thinspace{}
31881 \begin_inset Newline newline
31885 \begin_inset Flex Code
31888 \begin_layout Plain Layout
31889 svn co svn+ssh://user@server/repository_path
31897 \begin_layout Subsubsection
31898 End-of-Line Conversions
31901 \begin_layout Standard
31902 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
31904 use different line endings inside the .lyx files.
31905 This is not a problem as far as \SpecialChar LyX
31906 functionality is concerned, but the commit
31907 diffs will be huge and merge-conflicts prone.
31908 Fortunately SVN itself knows
31912 \begin_layout Plain Layout
31913 \begin_inset Flex URL
31916 \begin_layout Plain Layout
31918 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
31928 how to deal with CR/LF problems when switching .lyx files to the
31929 \begin_inset Flex Code
31932 \begin_layout Plain Layout
31942 \begin_layout Plain Layout
31944 \begin_inset Flex Code
31947 \begin_layout Plain Layout
31948 svn propset svn:eol-style native FILE_NAME
31961 \begin_layout Subsection
31962 GIT commands in \SpecialChar LyX
31966 \begin_layout Standard
31967 A minimal subset of GIT commands is now supported by \SpecialChar LyX
31969 You can find the commands in the
31971 File\SpecialChar menuseparator
31973 \begin_inset space ~
31979 Please note that if you use password protected access to repository via
31980 ssh, you will be asked in terminal window.
31982 was tested against GIT 1.7.
31986 \begin_layout Plain Layout
31987 Windows users please note that you need to ensure that git is on the path.
31988 This can be set from within \SpecialChar LyX
31991 Tools\SpecialChar menuseparator
31992 Preferences\SpecialChar menuseparator
31993 Paths\SpecialChar menuseparator
32004 \begin_layout Standard
32005 One big difference of GIT and the other supported version control systems
32006 is the distributed nature of GIT: With traditional version control systems
32007 there is one central server which hosts the repository.
32008 Users commit their changes to the server, and get updates made by other
32010 With GIT, users commit to a local repository.
32011 The local repository can be synchronized with one or more remote repositories
32013 \begin_inset Flex Code
32016 \begin_layout Plain Layout
32023 \begin_inset Flex Code
32026 \begin_layout Plain Layout
32034 does not interact in any way with remote GIT repositories.
32035 It works exclusively with the local repository in a very similar way as
32036 with a central CVS or SVN repository.
32037 If you use remote GIT repositories you need to do the
32038 \begin_inset Flex Code
32041 \begin_layout Plain Layout
32048 \begin_inset Flex Code
32051 \begin_layout Plain Layout
32057 operations with your favourite GIT client.
32060 \begin_layout Subsubsection
32066 \begin_layout Standard
32067 If your document is not under revision control, this is the only item shown
32069 And if it is under revision control, the
32073 item is not visible.
32076 \begin_layout Standard
32077 This command registers in GIT your document ONLY in case you have already
32078 the documents directory under GIT control (in particular
32083 This means you have to checkout the archive by yourself.
32086 \begin_layout Standard
32087 Then you are asked interactively to supply an initial description of the
32089 Don't forget that registered file is not yet committed.
32092 \begin_layout Standard
32093 GIT command that is run:
32096 \begin_inset Quotes qld
32100 \begin_inset Quotes qld
32106 \begin_layout Standard
32111 to understand the switches.
32114 \begin_layout Subsubsection
32120 \begin_layout Standard
32121 When you are finished editing a file, you commit your changes.
32122 When you do this, you are asked for a description of the changes.
32123 After that changes are committed.
32126 \begin_layout Standard
32129 git commit -q -m"<description>" <file-name>
32132 \begin_layout Subsubsection
32135 Revert To Repository Version
32138 \begin_layout Standard
32139 This will discard all changes made to the document since the last check
32141 You get a warning before changes are discarded.
32144 \begin_layout Standard
32148 \begin_inset Quotes qld
32152 \begin_inset Quotes qld
32158 \begin_layout Subsubsection
32164 \begin_layout Standard
32165 This will rename the current document including the version history.
32166 It requires a clean document without any changes since the last checkin.
32167 You are asked for a file name and a description of the rename operation.
32168 After that the document is renamed, both locally and in the repository.
32169 If the parent directories of the new and old file names differ, all relative
32170 paths of included files are adjusted (like in
32172 File\SpecialChar menuseparator
32177 Finally, the document is reloaded using the new name.
32180 \begin_layout Labeling
32181 \labelwidthstring 00.00.0000
32183 \begin_inset space ~
32187 \begin_inset space ~
32191 \begin_inset Newline newline
32195 \begin_inset Flex Code
32198 \begin_layout Plain Layout
32202 \begin_inset Quotes qld
32206 \begin_inset Quotes qld
32210 \begin_inset Quotes qld
32214 \begin_inset Quotes qld
32223 \begin_inset Newline newline
32227 \begin_inset Flex Code
32230 \begin_layout Plain Layout
32239 \begin_layout Subsubsection
32245 \begin_layout Standard
32246 This shows the complete history of the GIT document.
32250 \begin_inset Quotes qld
32254 \begin_inset Quotes qld
32259 is shown in a browser.
32262 \begin_layout Subsubsection
32266 \begin_layout Standard
32268 supports GIT hash number of the last commit to the file,
32269 \change_inserted 1119979965 1564297456
32270 its abbreviated form,
32272 author name, date and time of last commit.
32273 All those are extracted from
32275 git log -n 1 --pretty=format:%H%n
32276 \change_inserted 1119979965 1564297427
32282 Tree version information is obtained via
32284 git describe --abbrev --dirty --long
32288 \begin_inset CommandInset ref
32290 reference "subsec:VCS-Revision-Information"
32297 \begin_layout Subsection
32301 \begin_layout Standard
32302 With the recent addition of the
32303 \begin_inset Flex Code
32306 \begin_layout Plain Layout
32312 function \SpecialChar LyX
32313 power users are allowed to create their own commands for revision
32317 \begin_layout Standard
32318 As an example you can see how two TortoiseSVN commands could be integrated
32322 \begin_layout Description
32324 \begin_inset Flex Code
32327 \begin_layout Plain Layout
32328 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
32336 \begin_layout Description
32338 \begin_inset Flex Code
32341 \begin_layout Plain Layout
32342 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
32350 \begin_layout Subsection
32351 Version control and Document comparison
32354 \begin_layout Standard
32355 One of the typical uses of version control is to inspect the changes between
32356 revisions, usually by creating
32357 \begin_inset Flex Code
32360 \begin_layout Plain Layout
32367 While this is useful for plain text files, it is much less useful in the
32368 case of \SpecialChar LyX
32369 files, which have more a complicated structure.
32370 Hence we provide binding to the Document comparison feature.
32371 There are two ways of calling this feature – either by direct call of
32372 \begin_inset Flex Code
32375 \begin_layout Plain Layout
32382 function (for details see \SpecialChar LyX
32383 functions manual) or by the toolbar icon
32396 One can either compare two chosen revisions of the document or he can simply
32397 compare the current version of edited text with older revisions (where
32399 \begin_inset Flex Noun
32402 \begin_layout Plain Layout
32408 ' revisions back means comparison of the edited file with last commited
32413 \begin_layout Standard
32414 This feature is supported for SVN and RCS though due to the more complicated
32415 versioning scheme of RCS there is a constraint – when addressing the revisions
32416 in dialog, numbers always point to the last number in RCS revision number,
32419 We don't currently support GIT addressing of revisions, one can just compare
32420 edited document with its revision X steps backs, where X is addressed as
32422 \begin_inset Flex Code
32425 \begin_layout Plain Layout
32434 \begin_layout Section
32436 \change_inserted 564990737 1672161575
32437 \begin_inset CommandInset label
32439 name "sec:Literate-Programming"
32445 Literate Programming
32448 \begin_layout Standard
32453 (kayvan@sylvan.com)
32457 original documentation written by
32459 Edmar Wienskoski Jr.
32462 (edmar-w-jr@technologist.com)
32465 \begin_layout Subsection
32469 \begin_layout Standard
32470 The main purpose of this documentation is to show you how to use \SpecialChar LyX
32472 programming, where it is assumed that you are familiar with this programming
32473 technique, and know what
32474 \begin_inset Quotes eld
32478 \begin_inset Quotes erd
32482 \begin_inset Quotes eld
32486 \begin_inset Quotes erd
32490 If that is not the case, please follow the web links provided in the following
32492 There is a lot of good documentation out there covering old development
32493 history to the latest tools tips.
32496 \begin_layout Standard
32497 It is also assumed that you are familiar with \SpecialChar LyX
32498 itself to a point that you
32499 are comfortable changing your \SpecialChar LyX
32500 preferences, and X resources file.
32501 If that is not the case please refer to other \SpecialChar LyX
32502 documentation to cover your
32506 \begin_layout Subsection
32507 Literate Programming
32510 \begin_layout Standard
32511 From the Literate Programming FAQ:
32514 \begin_layout Quotation
32515 Literate programming is the combination of documentation and source together
32516 in a fashion suited for reading by human beings.
32517 In fact, literate programs should be enjoyable reading, even inviting!
32518 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
32519 and documentation in a single file.
32520 Literate programming tools then parse the file to produce either readable
32521 documentation or compilable source.
32522 The WEB style of literate programming was created by D.
32523 \begin_inset space \thinspace{}
32527 Knuth during the development of his \SpecialChar TeX
32528 typesetting software.
32532 \begin_layout Standard
32533 Another excerpt says:
32536 \begin_layout Quotation
32539 How is literate programming different from verbose commenting?
32542 \begin_layout Quotation
32543 There are three distinguishing characteristics.
32544 In order of importance, they are:
32548 \begin_layout Itemize
32549 flexible order of elaboration
32552 \begin_layout Itemize
32553 automatic support for browsing
32556 \begin_layout Itemize
32557 typeset documentation, especially diagrams and mathematics
32561 \begin_layout Standard
32562 Now that I sparked your curiosity, take a look in the references.
32565 \begin_layout Subsubsection
32569 \begin_layout Standard
32570 The complete Literate Programming FAQ can be found at:
32573 \begin_layout Quote
32574 Literate Programming FAQ
32575 \begin_inset Flex URL
32578 \begin_layout Plain Layout
32580 http://www.literateprogramming.com/lpfaq.pdf
32588 \begin_layout Standard
32589 The FAQ lists 23 (twenty three!) different literate programming tools.
32590 Where some are specialized or
32591 \begin_inset Quotes eld
32595 \begin_inset Quotes erd
32598 for particular programming languages, while other have general scope.
32603 for my own use for several reasons:
32606 \begin_layout Itemize
32607 It can generate the documentation either in \SpecialChar LaTeX
32611 \begin_layout Itemize
32612 It has a open architecture, i.
32613 \begin_inset space \thinspace{}
32617 \begin_inset space \space{}
32620 it is easy to plug in new filters
32624 \begin_layout Plain Layout
32629 are programs that read a given data stream and output a manipulated data
32631 That way, a WEB file (consisting of literate code) can be turned into a
32632 file consisting only of C program code or \SpecialChar LaTeX
32638 and to perform special processing that you may need.
32642 \begin_layout Itemize
32643 There is a good selection of filters available already (the HTML is one
32647 \begin_layout Itemize
32651 \begin_layout Standard
32652 The Noweb web page can be found at:
32655 \begin_layout Quote
32657 \begin_inset Flex URL
32660 \begin_layout Plain Layout
32662 https://www.cs.tufts.edu/~nr/noweb/
32670 \begin_layout Standard
32671 Starting from there you can reach many other interesting links and even
32672 some literate program examples.
32675 \begin_layout Subsection
32677 and Literate Programming with Noweb
32680 \begin_layout Standard
32681 The \SpecialChar LyX
32682 support for Literate Programming is provided by using the generic \SpecialChar LyX
32684 converters mechanism.
32685 This support is provided in a
32686 \begin_inset Quotes eld
32690 \begin_inset Quotes erd
32694 \begin_inset space \thinspace{}
32698 \begin_inset space \space{}
32701 you will be able to use this new \SpecialChar LyX
32702 feature with some other literate programming
32703 tool of your choice by just changing your \SpecialChar LyX
32707 \begin_layout Subsubsection
32708 Generating documents and code (weaving and tangling)
32711 \begin_layout Paragraph
32712 Using the noweb module
32715 \begin_layout Standard
32716 If you have installed Noweb and \SpecialChar LyX
32717 successfully, whenever you open a new document,
32718 after you have chosen its document class, use the
32720 Document\SpecialChar menuseparator
32724 \begin_inset Quotes eld
32728 \begin_inset Quotes erd
32732 If Noweb is correctly installed, when you click on the
32733 \begin_inset Quotes eld
32737 \begin_inset Quotes erd
32740 link, you will see the
32741 \begin_inset Quotes eld
32745 \begin_inset Quotes erd
32748 module in the available list and you can add it to your document.
32751 \begin_layout Paragraph
32755 \begin_layout Standard
32757 enables you to write code with a custom inset named
32758 \begin_inset Flex Noun
32761 \begin_layout Plain Layout
32768 Noweb delimits chunks like this:
32771 \begin_layout LyX-Code
32775 \begin_layout LyX-Code
32779 \begin_layout LyX-Code
32783 \begin_layout LyX-Code
32787 \begin_layout LyX-Code
32791 \begin_layout Standard
32792 The problem is that whatever is written in between the << and the
32796 must be taken literally, i.
32797 \begin_inset space \thinspace{}
32801 \begin_inset space \space{}
32805 should be prevented from making any special interpretation of what has
32807 This is also handled by
32808 \begin_inset Flex Noun
32811 \begin_layout Plain Layout
32817 , that works like a normal text inset but has a free spacing capability.
32820 \begin_layout Standard
32821 As a special note, you can also use the
32822 \begin_inset Quotes eld
32826 \begin_inset Quotes erd
32829 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
32833 \begin_layout LyX-Code
32837 \begin_layout LyX-Code
32838 def some_function(args):
32841 \begin_layout LyX-Code
32842 "This is the doc string for this function."
32845 \begin_layout LyX-Code
32846 print "My args: ", args
32849 \begin_layout LyX-Code
32850 @ %def some_function
32853 \begin_layout Standard
32854 For an example of this usage and the resulting cross-reference output, look
32855 at the Literate python program in
32857 LIBDIR/examples/listerrors.lyx
32859 which should make this all clear.
32862 \begin_layout Paragraph
32863 Generating the documentation
32866 \begin_layout Standard
32867 At this point you already have a new document file with a proper document
32868 class, and with some code and text on it.
32869 How do I print it? The answer is simple, you select
32871 View\SpecialChar menuseparator
32875 Just like you would do for a plain document.
32876 No special procedure is required.
32879 \begin_layout Standard
32880 To help orientate you, I will now explain what happens inside \SpecialChar LyX
32884 \begin_layout Enumerate
32887 Update\SpecialChar menuseparator
32890 menu option is chosen, a \SpecialChar LaTeX
32896 \begin_layout Standard
32897 If the document is of any literate class the generated file will be named
32898 with an extension name defined by the
32899 \begin_inset Quotes eld
32903 \begin_inset Quotes erd
32906 format (defined in the Preferences panel), otherwise the file will have
32915 \begin_layout Enumerate
32916 Note that the only difference so far is in the name of the file, no special
32917 processing is required by \SpecialChar LyX
32919 Given that you formatted the code using the
32920 \begin_inset Flex Noun
32923 \begin_layout Plain Layout
32929 inset that, by itself, takes care of the business.
32932 \begin_layout Enumerate
32933 If the document is of any literate class \SpecialChar LyX
32934 will then use the internal \SpecialChar LyX
32936 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
32941 \begin_layout Plain Layout
32942 The converters are defined in the
32944 Tools\SpecialChar menuseparator
32948 \begin_inset Quotes eld
32952 \begin_inset Quotes erd
32964 manual for general information about converters.
32969 to generate the \SpecialChar LaTeX
32974 \begin_layout Standard
32975 Otherwise it will just skip this step.
32979 \begin_layout Enumerate
32980 Finally, \SpecialChar LaTeX
32981 is invoked and the regular post processing continues as in a plain
32985 \begin_layout Standard
32986 Independence from a particular
32987 \begin_inset Quotes eld
32991 \begin_inset Quotes erd
32994 is easily achieved by changing the commands that are run by the various
32998 \begin_layout Paragraph
32999 Generating the code
33002 \begin_layout Standard
33003 When the build menu option is chosen or the corresponding button in the
33004 toolbar is pressed, a \SpecialChar LaTeX
33005 file is generated just like step 1 above.
33006 Next, \SpecialChar LyX
33012 This converter needs to be defined by the user and is not installed by
33013 default, though the Program format is.
33014 This converter (like any other converter) will have two parts:
33017 \begin_layout Enumerate
33018 The converter program itself.
33019 This program performs the conversion from the one format to the other (in
33020 this case, from the Noweb format to the Program pseudo-format).
33023 \begin_layout Enumerate
33024 The error log parser.
33025 This is a program whose sole purpose is to rewrite error messages in a
33026 format that \SpecialChar LyX
33028 This makes it possible for \SpecialChar LyX
33029 to place error boxes in the right places in
33033 \begin_layout Standard
33034 The first part, the
33035 \begin_inset Quotes eld
33039 \begin_inset Quotes erd
33042 setting, should be set to
33045 \begin_layout LyX-Code
33053 \begin_layout Standard
33054 This basically means that \SpecialChar LyX
33056 \begin_inset Quotes eld
33060 \begin_inset Quotes erd
33063 (a program or script) with the name of the Noweb file (normally a file
33064 in the \SpecialChar LyX
33065 temp directory) and the directory path of the original \SpecialChar LyX
33070 \begin_layout Standard
33071 This is an implementation of
33072 \begin_inset Quotes eld
33076 \begin_inset Quotes erd
33079 that you can place in a directory on your path:
33082 \begin_layout LyX-Code
33088 \begin_layout LyX-Code
33094 \begin_layout LyX-Code
33097 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
33100 \begin_layout Standard
33101 The next part of the converter setting is the
33102 \begin_inset Quotes eld
33106 \begin_inset Quotes erd
33109 which is to be set to
33112 \begin_layout LyX-Code
33115 parselog=$$s/scripts/listerrors
33118 \begin_layout Standard
33119 This will run any errors that are generated by the
33120 \begin_inset Quotes eld
33124 \begin_inset Quotes erd
33127 process through the
33128 \begin_inset Quotes eld
33132 \begin_inset Quotes erd
33138 \begin_layout Standard
33139 The build will normally take place in \SpecialChar LyX
33140 's temporary directory, so the files
33141 produced by the conversion will be in that directory.
33143 will copy out what it regards as the `main' file, but the
33147 conversion may produce several files, and so most of these would then be
33148 deleted when \SpecialChar LyX
33150 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
33151 the build-script chunk can place the generated files in that location.
33154 \begin_layout Paragraph
33155 Build instructions in the document
33158 \begin_layout Standard
33159 The last piece of the integration between \SpecialChar LyX
33161 \begin_inset Quotes eld
33165 \begin_inset Quotes erd
33169 Generally, the instructions for building your program should be embedded
33170 in a chunk of its own.
33172 \begin_inset Quotes eld
33176 \begin_inset Quotes erd
33179 above uses the notangle command to look for this chunk (called
33180 \begin_inset Quotes eld
33184 \begin_inset Quotes erd
33187 ) and runs its contents through
33188 \begin_inset Quotes eld
33192 \begin_inset Quotes erd
33198 \begin_layout Standard
33199 Typically, such a chunk would look something like this:
33202 \begin_layout LyX-Code
33206 \begin_layout LyX-Code
33208 \begin_inset Newline newline
33211 if [ -z "${NOWEB_SOURCE}" ]
33212 \begin_inset Newline newline
33218 \begin_layout LyX-Code
33219 NOWEB_SOURCE=myfile.nw
33220 \begin_inset Newline newline
33224 \begin_inset Newline newline
33228 code to extract files ...
33229 use NOWEB_OUTPUT_DIR here ...]
33230 \begin_inset Newline newline
33234 code to compile files ...]
33235 \begin_inset Newline newline
33241 \begin_layout Standard
33243 \change_deleted 564990737 1672161716
33246 LIBDIR/examples/listerrors.lyx
33250 LIBDIR/examples/Literate.lyx
33251 \change_inserted 564990737 1672161716
33256 File\SpecialChar menuseparator
33257 Open Example\SpecialChar menuseparator
33258 Modules\SpecialChar menuseparator
33265 \change_deleted 564990737 1672161729
33269 \begin_inset Quotes eld
33273 \begin_inset Quotes erd
33276 program for some illustrations of how all of these pieces go together or
33278 \change_deleted 564990737 1672161756
33281 LIBDIR/examples/noweb2lyx.lyx
33282 \change_inserted 564990737 1672161756
33287 File\SpecialChar menuseparator
33288 Open Example\SpecialChar menuseparator
33289 Modules\SpecialChar menuseparator
33290 Noweb2\SpecialChar LyX
33300 Interestingly, these
33301 \change_deleted 564990737 1672161767
33304 files show off the language-indepence of the \SpecialChar LyX
33305 literate programming support
33306 since they are written in Python
33307 \change_deleted 564990737 1672161782
33310 and Perl respectively.
33313 \begin_layout Subsubsection
33314 Configuring \SpecialChar LyX
33318 \begin_layout Standard
33319 All the Literate Programming support is configured by the
33321 Tools\SpecialChar menuseparator
33325 \begin_inset Quotes eld
33329 \begin_inset Quotes erd
33333 The important parts are:
33336 \begin_layout Description
33338 \begin_inset space ~
33342 \begin_inset Quotes eld
33346 \begin_inset Quotes erd
33350 \begin_inset space ~
33353 format Set up via the File Formats tab, this is where the Noweb-specific
33363 , the file extension is set to
33368 This tells \SpecialChar LyX
33369 to create a file with a
33373 extension in the first step of the conversion process.
33376 \begin_layout Description
33378 \begin_inset space ~
33386 \begin_inset space ~
33389 format This is an empty format whose sole purpose is to be the endpoint
33390 of a conversion (which then allows us to set up a converter for it).
33393 \begin_layout Description
33403 This converter performs the
33404 \begin_inset Quotes eld
33408 \begin_inset Quotes erd
33411 of the literate document.
33412 For Noweb, it is set to
33413 \begin_inset Quotes eld
33418 noweave -delay -index $$i > $$o
33421 \begin_inset Quotes erd
33427 \begin_layout Description
33437 \begin_inset Quotes eld
33441 \begin_inset Quotes erd
33445 As stated above, the Converter is set to
33446 \begin_inset Quotes eld
33454 \begin_inset Quotes erd
33457 , with Flags set to
33458 \begin_inset Newline newline
33462 \begin_inset Quotes eld
33467 parselog=$$s/scripts/listerrors
33470 \begin_inset Quotes erd
33476 \begin_layout Subsubsection
33480 \begin_layout Standard
33481 There is also a new function implemented in the \SpecialChar LyX
33483 \begin_inset Quotes eld
33486 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
33490 \begin_layout Standard
33491 When debugging code with ddd/gdb, it is possible to invoke a text editor
33492 at the current execution position with a single key stroke.
33493 The default ddd configuration for that is shift-ctrl-V.
33494 It happens that you can define the editor command line invocation in ddd
33497 Edit\SpecialChar menuseparator
33498 Preferences\SpecialChar menuseparator
33501 dialog and changing the "Edit Sources" entry.
33504 \begin_layout Standard
33505 I take advantage of the newly created \SpecialChar LyX
33506 server function and this ddd feature,
33508 \begin_inset Quotes eld
33512 \begin_inset Quotes erd
33518 \begin_layout LyX-Code
33519 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
33522 \begin_layout Standard
33523 With this, whenever you are using ddd and find a point in the program that
33524 you want to edit, you just press shift-ctrl-V (in the ddd window), and
33525 ddd will forward this information to \SpecialChar LyX
33526 through the \SpecialChar LyX
33527 server and then the
33529 window will show the same file with the cursor at the same position ddd
33531 No more guessing or long scrolling to locate a point in the program back
33535 \begin_layout Standard
33536 Note however that you must enable the \SpecialChar LyX
33537 server to get this feature working
33538 (it is disabled by default).
33540 \begin_inset space ~
33544 \begin_inset CommandInset ref
33546 reference "sec:Starting-the-Server"
33550 explains how to do that.
33553 \begin_layout Subsubsection
33557 \begin_layout Standard
33558 There are six new buttons that can be added to your \SpecialChar LyX
33560 Four of these buttons are short cuts to layout styles:
33578 , one for the custom inset
33583 The last one is a short cut to the
33584 \begin_inset Quotes eld
33588 \begin_inset Quotes erd
33595 \begin_layout Standard
33597 has a range of buttons that are available for tool bar customization.
33598 In my toolbar I like to combine the six short cuts above with two more:
33603 \SpecialChar menuseparator
33608 \SpecialChar menuseparator
33615 Document\SpecialChar menuseparator
33616 View\SpecialChar menuseparator
33620 Here is how it looks like:
33623 \begin_layout LyX-Code
33627 \begin_layout LyX-Code
33631 \begin_layout LyX-Code
33632 Icon "layout Standard"
33635 \begin_layout LyX-Code
33636 Icon "layout Section"
33639 \begin_layout LyX-Code
33640 Icon "layout \SpecialChar LaTeX
33644 \begin_layout LyX-Code
33645 Icon "layout \SpecialChar LyX
33649 \begin_layout LyX-Code
33650 Icon "flex.insert Chunk"
33653 \begin_layout LyX-Code
33657 \begin_layout LyX-Code
33661 \begin_layout LyX-Code
33662 Icon "buffer-typeset"
33665 \begin_layout LyX-Code
33666 Icon "build-program"
33669 \begin_layout LyX-Code
33673 \begin_layout LyX-Code
33677 \begin_layout LyX-Code
33681 \begin_layout LyX-Code
33685 \begin_layout LyX-Code
33689 \begin_layout Subsubsection
33690 Colors customization
33693 \begin_layout Standard
33694 There are a number of colors in \SpecialChar LyX
33695 that can be customized in
33700 One of the things that bothers people is the \SpecialChar LaTeX
33702 The default color is red, since the chunks uses \SpecialChar LaTeX
33703 font, and there is a lot
33704 of chunks in literate documents, you may get tired of seeing everything
33706 You can change it by going to the tabs
33715 \begin_layout Standard
33716 The next thing is the visible presence of the newline character in the screen.
33717 You can choose the color of this particular character and make it blend
33719 I recommend you choosing a color that is close to the background but not
33720 equal, that way you still can see it is there, but it is not bothering
33724 \begin_layout Subsection
33729 \begin_layout Standard
33739 \change_inserted 564990737 1672161863
33743 Help\SpecialChar menuseparator
33744 Specific Manuals\SpecialChar menuseparator
33752 \change_deleted 564990737 1671643409
33758 \change_inserted 564990737 1672161856
33762 File\SpecialChar menuseparator
33763 Open Example\SpecialChar menuseparator
33764 Modules\SpecialChar menuseparator
33771 \change_deleted 564990737 1671643461
33772 the Sweave manual (menu
33774 Help\SpecialChar menuseparator
33778 \change_inserted 564990737 1672161856
33782 Help\SpecialChar menuseparator
33783 Specific Manuals\SpecialChar menuseparator
33785 \change_deleted 564990737 1672161921
33791 \change_inserted 564990737 1672161917
33795 File\SpecialChar menuseparator
33796 Open Example\SpecialChar menuseparator
33797 Modules\SpecialChar menuseparator
33805 \begin_layout Chapter
33807 \change_deleted 564990737 1671355343
33811 \begin_layout Standard
33813 \change_deleted 564990737 1671355343
33814 You can do everything with \SpecialChar LyX
33815 that you can do with \SpecialChar LaTeX
33817 However, \SpecialChar LyX
33818 cannot support every \SpecialChar LaTeX
33820 But you can always use \SpecialChar TeX
33822 This chapter shows you some more special things you might want to use.
33823 For other special things you can do with figures, tables, floats, boxes
33824 and notes, have a look at the
33827 \begin_inset space ~