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
15071 \begin_inset Separator latexpar
15078 \begin_layout Enumerate
15080 \change_inserted 564990737 1672138150
15083 \begin_inset Argument 1
15086 \begin_layout Plain Layout
15088 \change_inserted 564990737 1672138150
15094 \begin_layout Plain Layout
15096 \change_inserted 564990737 1672138150
15115 \begin_layout Enumerate
15117 \change_inserted 564990737 1672138150
15121 \begin_inset Separator latexpar
15128 \begin_layout Enumerate
15130 \change_inserted 564990737 1672138150
15133 \begin_inset Argument 1
15136 \begin_layout Plain Layout
15138 \change_inserted 564990737 1672138150
15144 \begin_layout Plain Layout
15146 \change_inserted 564990737 1672138150
15163 \begin_inset Separator latexpar
15170 \begin_layout Enumerate
15172 \change_inserted 564990737 1672138150
15175 \begin_inset Argument 1
15178 \begin_layout Plain Layout
15180 \change_inserted 564990737 1672138150
15186 \begin_layout Plain Layout
15188 \change_inserted 564990737 1672138150
15210 \begin_layout Standard
15212 \change_inserted 564990737 1672138150
15215 For this list these commands were used:
15218 \begin_layout Standard
15221 \change_inserted 564990737 1672138150
15232 \begin_inset Newline newline
15240 \begin_inset Newline newline
15248 \begin_inset Newline newline
15258 \begin_layout Standard
15260 \change_inserted 564990737 1672138150
15269 makes the label emphasized and
15278 \begin_layout Standard
15280 \change_inserted 564990737 1672138150
15283 \begin_inset Note Greyedout
15286 \begin_layout Plain Layout
15288 \change_inserted 564990737 1672138150
15294 When you change the label of a list level, it will be used for all following
15295 lists until you change the definition.
15303 \begin_layout Standard
15305 \change_inserted 564990737 1672138150
15311 \begin_layout Plain Layout
15313 \change_inserted 564990737 1672138150
15331 \begin_layout Subsubsection
15333 \change_inserted 564990737 1672138150
15336 Numbered Paragraphs in Reports
15339 \begin_layout Enumerate
15341 \change_inserted 564990737 1672138213
15344 Official reports often include numbered paragraphs; you can achieve this
15345 with a variation on the approach outlined in the footnote
15346 \begin_inset space ~
15350 \begin_inset CommandInset ref
15352 reference "fn:If-you-really"
15364 in each command with
15371 \begin_layout Enumerate
15373 \change_inserted 564990737 1672138150
15376 These numbered paragraphs were generated by inserting the \SpecialChar TeX
15378 \begin_inset Separator latexpar
15385 \begin_layout Standard
15387 \change_inserted 564990737 1672138150
15402 \begin_layout Standard
15404 \change_inserted 564990737 1672138150
15407 before the start of the section;
15413 uses the \SpecialChar LaTeX
15414 section counter to generate the first part of the number.
15418 \begin_layout Enumerate
15420 \change_inserted 564990737 1672138150
15423 I have ignored the subsection heading in this example because, with paragraphs
15424 numbered in this way, subsections are less likely to be used.
15427 \begin_layout Subsubsection
15429 \change_inserted 564990737 1672138150
15432 Resumed Enumeration
15435 \begin_layout Standard
15437 \change_inserted 564990737 1672138150
15443 \begin_layout Plain Layout
15445 \change_inserted 564990737 1672138150
15461 \begin_layout Standard
15463 \change_inserted 564990737 1672138150
15466 Enumerations can be resumed after intermediate paragraphs:
15469 \begin_layout Enumerate
15471 \change_inserted 564990737 1672138150
15474 \begin_inset Argument 1
15477 \begin_layout Plain Layout
15479 \change_inserted 564990737 1672138150
15485 \begin_layout Plain Layout
15487 \change_inserted 564990737 1672138150
15502 \begin_inset Note Note
15505 \begin_layout Plain Layout
15507 \change_inserted 564990737 1672138150
15510 goes back to default numbering
15518 \begin_layout Enumerate
15520 \change_inserted 564990737 1672138150
15526 \begin_layout Standard
15528 \change_inserted 564990737 1672138150
15534 \begin_layout Enumerate-Resume
15536 \change_inserted 564990737 1672138150
15542 \begin_layout Standard
15544 \change_inserted 564990737 1672138150
15547 To resume an enumeration, use the style
15552 Its numbering appears in blue within \SpecialChar LyX
15553 to indicate that it is a resumed
15554 list and that the numbering will not be correct in \SpecialChar LyX
15555 , but in the output.
15558 \begin_layout Standard
15560 \change_inserted 564990737 1672138150
15563 \begin_inset Note Greyedout
15566 \begin_layout Plain Layout
15568 \change_inserted 564990737 1672138150
15574 If there is no previous enumeration to resume, you will get a \SpecialChar LaTeX
15583 \begin_layout Standard
15585 \change_inserted 564990737 1672138150
15588 Perhaps you might want to resume the list with a different number from the
15590 Or you want to start a new enumeration with a defined number.
15591 This is possible by adding an optional argument to the first list item
15592 of a normal enumeration.
15593 There, insert the command
15596 \begin_layout Standard
15598 \change_inserted 564990737 1672138150
15605 \begin_layout Standard
15607 \change_inserted 564990737 1672138150
15614 is the number with which you want to resume the list.
15618 \begin_layout Enumerate
15620 \change_inserted 564990737 1672138150
15626 \begin_layout Enumerate
15628 \change_inserted 564990737 1672138150
15634 \begin_layout Standard
15636 \change_inserted 564990737 1672138150
15639 Enumeration starting at a given value:
15642 \begin_layout Enumerate
15644 \change_inserted 564990737 1672138150
15647 \begin_inset Argument 1
15650 \begin_layout Plain Layout
15652 \change_inserted 564990737 1672138150
15658 \begin_layout Plain Layout
15660 \change_inserted 564990737 1672138150
15672 This enumeration starts at 4
15675 \begin_layout Subsubsection
15677 \change_inserted 564990737 1672138150
15681 \begin_inset Index idx
15686 \begin_layout Plain Layout
15688 \change_inserted 564990737 1672138150
15699 \begin_layout Standard
15701 \change_inserted 564990737 1672138150
15704 In some cases you might want less or more vertical space between the items
15706 For example if the default space is too much in your opinion in this case:
15709 \begin_layout Itemize
15711 \change_inserted 564990737 1672138150
15717 \begin_layout Itemize
15719 \change_inserted 564990737 1672138150
15722 with standard spacing
15725 \begin_layout Standard
15727 \change_inserted 564990737 1672138150
15730 You can decrease the space by adding an optional argument to the first item
15732 Add there the command
15736 to get no additional list space like in this example:
15739 \begin_layout Itemize
15741 \change_inserted 564990737 1672138150
15744 \begin_inset Argument 1
15747 \begin_layout Plain Layout
15749 \change_inserted 564990737 1672138150
15755 \begin_layout Plain Layout
15757 \change_inserted 564990737 1672138150
15772 \begin_layout Itemize
15774 \change_inserted 564990737 1672138150
15780 \begin_layout Itemize
15782 \change_inserted 564990737 1672138150
15788 \begin_layout Standard
15790 \change_inserted 564990737 1672138150
15793 To add space you can use several other commands provided by the
15798 \begin_inset Index idx
15803 \begin_layout Plain Layout
15805 \change_inserted 564990737 1672138150
15809 -packages ! enumitem
15815 For more information see the
15816 \begin_inset CommandInset href
15818 name "enumitem documentation"
15819 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
15827 \begin_layout Standard
15829 \change_inserted 564990737 1672138150
15832 There are also many commands available to change the horizontal spacing
15834 Here is an example where the indentation was changed to that of the paragraphs
15835 in the document and the label separation was set to 2
15836 \begin_inset space \thinspace{}
15839 cm so that the number is in the page margin:
15842 \begin_layout Enumerate
15844 \change_inserted 564990737 1672138150
15847 \begin_inset Argument 1
15850 \begin_layout Plain Layout
15852 \change_inserted 564990737 1672138150
15858 \begin_layout Plain Layout
15860 \change_inserted 564990737 1672138150
15864 parindent, labelsep=2cm
15877 \begin_layout Enumerate
15879 \change_inserted 564990737 1672138150
15882 with negative indentation
15885 \begin_layout Subsubsection
15887 \change_inserted 564990737 1672138150
15890 Further Customization
15891 \begin_inset Index idx
15896 \begin_layout Plain Layout
15898 \change_inserted 564990737 1672138150
15901 Lists ! Customization
15909 \begin_layout Standard
15911 \change_inserted 564990737 1672138150
15914 You can also change the style of description lists.
15918 \begin_layout Standard
15920 \change_inserted 564990737 1672138150
15927 \begin_layout Standard
15929 \change_inserted 564990737 1672138150
15932 changes the description label font, the command
15935 \begin_layout Standard
15937 \change_inserted 564990737 1672138150
15947 \begin_layout Standard
15949 \change_inserted 564990737 1672138150
15952 sets the list style.
15955 \begin_layout Standard
15957 \change_inserted 564990737 1672138150
15960 An example where the command
15963 \begin_layout Standard
15965 \change_inserted 564990737 1672138150
15971 itshape, style=nextline
15974 \begin_layout Standard
15976 \change_inserted 564990737 1672138150
15982 \begin_layout Description
15984 \change_inserted 564990737 1672138150
15988 \begin_inset space ~
15992 \begin_inset Argument 1
15995 \begin_layout Plain Layout
15997 \change_inserted 564990737 1672138150
16003 \begin_layout Plain Layout
16005 \change_inserted 564990737 1672138150
16007 labelindent=0pt, labelsep=1cm, font=
16009 itshape, style=nextline
16019 Ionizing radiation consists of particles or electromagnetic waves that are
16020 energetic enough to detach electrons from atoms or molecules, therefore
16024 \begin_layout Description
16026 \change_inserted 564990737 1672138150
16030 \begin_inset space ~
16033 counting: In computer science, reference counting is a technique of storing
16034 the number of references, pointers, or handles to a resource such as an
16035 object, block of memory, disk space or other resource.
16038 \begin_layout Standard
16040 \change_inserted 564990737 1672138150
16043 There are many more commands and features provided by the
16048 \begin_inset Index idx
16053 \begin_layout Plain Layout
16055 \change_inserted 564990737 1672138150
16059 -packages ! enumitem
16065 For more information see the
16066 \begin_inset CommandInset href
16068 name "enumitem documentation"
16069 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
16077 \begin_layout Subsection
16079 \change_inserted 564990737 1672138150
16086 \begin_layout Standard
16088 \change_inserted 564990737 1672138150
16091 This module uses the package
16095 to provide nine new list environments.
16096 Itemized and enumerated lists can be typeset within paragraphs, as paragraphs
16097 and in a compact version.
16098 Most environments have optional arguments to format the labels.
16099 Additionally, the \SpecialChar LaTeX
16100 list environments itemize and enumerate are extended
16101 to use a similar optional argument.
16102 For further details see
16104 File\SpecialChar menuseparator
16105 Open Example\SpecialChar menuseparator
16106 Modules\SpecialChar menuseparator
16107 Paragraph Lists (paralist)
16111 Help\SpecialChar menuseparator
16112 Specific Manuals\SpecialChar menuseparator
16116 \begin_inset CommandInset href
16118 name "paralist documentation"
16119 target "http://mirrors.ctan.org/macros/latex/contrib/paralist/paralist.pdf"
16127 \begin_layout Section
16128 Multiple Text Columns
16131 \begin_layout Standard
16132 This feature is independent of the option
16134 Two-column document
16136 in the document settings under
16141 If you want to have 2
16142 \begin_inset space ~
16145 columns for the whole document, it is recommended to use the
16147 Two-column document
16150 For all other cases use this feature.
16153 \begin_layout Standard
16154 To use multiple text columns in your document, you have to load the module
16161 Document\SpecialChar menuseparator
16162 Settings\SpecialChar menuseparator
16165 ) and must have the \SpecialChar LaTeX
16167 \begin_inset Flex Code
16170 \begin_layout Plain Layout
16179 \begin_layout Standard
16180 Footnotes within multiple columns will be placed at the bottom of the page
16181 and not under each column.
16182 Within the different columns you can use everything, with the limitation
16183 that for floats you need to use the float option
16190 \begin_layout Subsection
16194 \begin_layout Standard
16195 If you want to have 2
16196 \begin_inset space ~
16199 columns in your text, insert a multicolumn inset via the menu
16201 Insert\SpecialChar menuseparator
16203 \begin_inset space ~
16206 Insets\SpecialChar menuseparator
16208 \begin_inset space ~
16213 where the columns should start.
16214 Write all text that should be printed in 2
16215 \begin_inset space ~
16218 columns into this inset.
16221 \begin_layout Standard
16222 Here is an example:
16225 \begin_layout Standard
16227 \begin_inset Flex Multiple Columns
16230 \begin_layout Plain Layout
16235 The Adventure of the Empty House
16238 \begin_inset Newline newline
16241 by Sir Arthur Conan Doyle
16244 \begin_layout Plain Layout
16247 It was in the spring of the year 1894 that all London was interested, and
16248 the fashionable world dismayed, by the murder of the Honourable Ronald
16249 Adair under most unusual and inexplicable circumstances.
16250 The public has already learned those particulars of the crime which came
16251 out in the police investigation, but a good deal was suppressed upon that
16252 occasion, since the case for the prosecution was so overwhelmingly strong
16253 that it was not necessary to bring forward all the facts.
16254 Only now, at the end of nearly ten years, am I allowed to supply those
16255 missing links which make up the whole of that remarkable chain.
16256 The crime was of interest in itself, but that interest was as nothing to
16257 me compared to the inconceivable sequel, which afforded me the greatest
16258 shock and surprise of any event in my adventurous life.
16259 Even now, after this long interval, I find myself thrilling as I think
16260 of it, and feeling once more that sudden flood of joy, amazement, and increduli
16261 ty which utterly submerged my mind.
16262 Let me say to that public, which has shown some interest in those glimpses
16263 which I have occasionally given them of the thoughts and actions of a very
16264 remarkable man, that they are not to blame me if I have not shared my knowledge
16265 with them, for I should have considered it my first duty to do so, had
16266 I not been barred by a positive prohibition from his own lips, which was
16267 only withdrawn upon the third of last month.
16275 \begin_layout Standard
16276 To get 3 or more columns, set the cursor into the multicolumn inset and
16279 Insert\SpecialChar menuseparator
16281 \begin_inset space ~
16285 \begin_inset space ~
16291 The number of the desired columns is written into that inset (for 3
16292 \begin_inset space ~
16296 \begin_inset Quotes eld
16300 \begin_inset Quotes erd
16304 \begin_inset Newline newline
16307 Here is an example with 3
16308 \begin_inset space ~
16314 \begin_layout Standard
16315 \begin_inset Flex Multiple Columns
16318 \begin_layout Plain Layout
16321 \begin_inset Argument 1
16324 \begin_layout Plain Layout
16331 It can be imagined that my close intimacy with Sherlock Holmes had interested
16332 me deeply in crime, and that after his disappearance I never failed to
16333 read with care the various problems which came before the public.
16334 And I even attempted, more than once, for my own private satisfaction,
16335 to employ his methods in their solution, though with indifferent success.
16336 There was none, however, which appealed to me like this tragedy of Ronald
16338 As I read the evidence at the inquest, which led up to a verdict of willful
16339 murder against some person or persons unknown, I realized more clearly
16340 than I had ever done the loss which the community had sustained by the
16341 death of Sherlock Holmes.
16342 There were points about this strange business which would, I was sure,
16343 have specially appealed to him, and the efforts of the police would have
16344 been supplemented, or more probably anticipated, by the trained observation
16345 and the alert mind of the first criminal agent in Europe.
16346 All day, as I drove upon my round, I turned over the case in my mind and
16347 found no explanation which appeared to me to be adequate.
16348 At the risk of telling a twice-told tale, I will recapitulate the facts
16349 as they were known to the public at the conclusion of the inquest.
16357 \begin_layout Standard
16358 You can have up to 10
16359 \begin_inset space ~
16362 columns if you want to, but that might not be very pleasant for the readers
16366 \begin_layout Standard
16367 \begin_inset Newpage newpage
16373 \begin_layout Subsection
16374 Columns inside Columns
16377 \begin_layout Standard
16378 You can also have columns inside columns:
16381 \begin_layout Standard
16382 \begin_inset Flex Multiple Columns
16385 \begin_layout Plain Layout
16388 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
16389 at that time governor of one of the Australian colonies.
16390 Adair's mother had returned from Australia to undergo the operation for
16391 cataract, and she, her son Ronald, and her daughter Hilda were living together
16395 \begin_layout Plain Layout
16396 \begin_inset Flex Multiple Columns
16399 \begin_layout Plain Layout
16402 The youth moved in the best society
16403 \begin_inset space ~
16406 – had, so far as was known, no enemies and no particular vices.
16407 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
16408 had been broken off by mutual consent some months before, and there was
16409 no sign that it had left any very profound feeling behind it.
16410 For the rest {sic} the man's life moved in a narrow and conventional circle,
16411 for his habits were quiet and his nature unemotional.
16412 Yet it was upon this easy-going young aristocrat that death came, in most
16413 strange and unexpected form, between the hours of ten and eleven-twenty
16414 on the night of March 30, 1894.
16422 \begin_layout Plain Layout
16425 Ronald Adair was fond of cards
16426 \begin_inset space ~
16429 – playing continually, but never for such stakes as would hurt him.
16430 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
16431 It was shown that, after dinner on the day of his death, he had played
16432 a rubber of whist at the latter club.
16433 He had also played there in the afternoon.
16438 The evidence of those who had played with him
16439 \begin_inset space ~
16443 Murray, Sir John Hardy, and Colonel Moran
16444 \begin_inset space ~
16447 – showed that the game was whist, and that there was a fairly equal fall
16449 Adair might have lost five pounds, but not more.
16450 His fortune was a considerable one, and such a loss could not in any way
16452 He had played nearly every day at one club or other, but he was a cautious
16453 player, and usually rose a winner.
16454 It came out in evidence that, in partnership with Colonel Moran, he had
16455 actually won as much as four hundred and twenty pounds in a sitting, some
16456 weeks before, from Godfrey Milner and Lord Balmoral.
16457 So much for his recent history as it came out at the inquest.
16465 \begin_layout Subsection
16469 \begin_layout Standard
16470 The examples in this section show some more special features of multiple
16474 \begin_layout Standard
16475 For more features of multiple columns, have a look at the
16476 \begin_inset CommandInset href
16478 name "documentation"
16479 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
16484 of the \SpecialChar LaTeX
16486 \begin_inset Flex Code
16489 \begin_layout Plain Layout
16498 \begin_layout Subsubsection
16502 \begin_layout Standard
16503 To add a preface text for multiple columns, set the cursor into the multicolumn
16504 inset and use the menu
16506 Insert\SpecialChar menuseparator
16510 Write your preface text into that inset.
16511 \begin_inset Newline newline
16514 This is an example with some preface text:
16517 \begin_layout Standard
16518 \begin_inset VSpace bigskip
16524 \begin_layout Standard
16525 \begin_inset Flex Multiple Columns
16528 \begin_layout Plain Layout
16529 \begin_inset Argument 2
16532 \begin_layout Plain Layout
16533 And the story continues and continues and continues and continues\SpecialChar ldots
16541 On the evening of the crime, he returned from the club exactly at ten.
16542 His mother and sister were out spending the evening with a relation.
16543 The servant deposed that she heard him enter the front room on the second
16544 floor, generally used as his sitting-room.
16545 She had lit a fire there, and as it smoked she had opened the window.
16546 No sound was heard from the room until eleven-twenty, the hour of the return
16547 of Lady Maynooth and her daughter.
16548 Desiring to say good-night, she attempted to enter her son's room.
16549 The door was locked on the inside, and no answer could be got to their
16550 cries and knocking.
16551 Help was obtained, and the door forced.
16552 The unfortunate young man was found lying near the table.
16553 His head had been horribly mutilated by an expanding revolver bullet, but
16554 no weapon of any sort was to be found in the room.
16562 \begin_layout Standard
16563 You can also use a section heading as the preface if you use a section command
16564 as \SpecialChar TeX
16566 For example the command
16569 \begin_layout LyX-Code
16572 subsection{subsection title}
16575 \begin_layout Standard
16576 creates a subsection.
16577 In this example the preface is a subsubsection:
16580 \begin_layout Standard
16581 \begin_inset Flex Multiple Columns
16584 \begin_layout Plain Layout
16585 \begin_inset Argument 2
16588 \begin_layout Plain Layout
16592 \begin_layout Plain Layout
16601 This is a subsubsection heading as a preface
16605 \begin_layout Plain Layout
16619 A minute examination of the circumstances served only to make the case more
16621 In the first place, no reason could be given why the young man should have
16622 fastened the door upon the inside.
16623 There was the possibility that the murderer had done this, and had afterwards
16624 escaped by the window.
16625 The drop was at least twenty feet, however, and a bed of crocuses in full
16627 Neither the flowers nor the earth showed any sign of having been disturbed,
16628 nor were there any marks upon the narrow strip of grass which separated
16629 the house from the road.
16630 Apparently, therefore, it was the young man himself who had fastened the
16632 But how did he come by his death? No one could have climbed up to the window
16633 without leaving traces.
16634 Suppose a man had fired through the window, he would indeed be a remarkable
16635 shot who could with a revolver inflict so deadly a wound.
16636 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
16637 a hundred yards of the house.
16638 No one had heard a shot.
16646 \begin_layout Standard
16647 If there is less vertical space than 6
16648 \begin_inset space ~
16651 text lines is left on the page at the beginning of the multiple columns,
16652 a page break will be inserted before the multiple columns.
16653 Depending on the number of lines of the preface text, you might want to
16655 This is done by setting the cursor into the mulitcolumn inset behind the
16656 preface (if there is any) and using the menu
16658 Insert\SpecialChar menuseparator
16660 \begin_inset space ~
16664 \begin_inset space ~
16668 \begin_inset space ~
16674 Insert into that inset the amount of space like e.
16675 \begin_inset space \thinspace{}
16679 \begin_inset space \space{}
16683 \begin_inset Quotes eld
16687 \begin_inset Quotes erd
16691 \begin_inset Newline newline
16694 In this example the space is set to 7
16695 \begin_inset space ~
16698 text lines by using
16699 \begin_inset Flex Code
16702 \begin_layout Plain Layout
16711 \begin_inset Flex Code
16714 \begin_layout Plain Layout
16722 needs to be inserted as \SpecialChar TeX
16726 \begin_layout Standard
16727 \begin_inset Flex Multiple Columns
16730 \begin_layout Plain Layout
16731 \begin_inset Argument 3
16734 \begin_layout Plain Layout
16739 \begin_layout Plain Layout
16755 On the evening of the crime, he returned from the club exactly at ten.
16756 His mother and sister were out spending the evening with a relation.
16757 The servant deposed that she heard him enter the front room on the second
16758 floor, generally used as his sitting-room.
16759 She had lit a fire there, and as it smoked she had opened the window.
16760 No sound was heard from the room until eleven-twenty, the hour of the return
16761 of Lady Maynooth and her daughter.
16762 Desiring to say good-night, she attempted to enter her son's room.
16763 The door was locked on the inside, and no answer could be got to their
16764 cries and knocking.
16765 Help was obtained, and the door forced.
16766 The unfortunate young man was found lying near the table.
16767 His head had been horribly mutilated by an expanding revolver bullet, but
16768 no weapon of any sort was to be found in the room.
16776 \begin_layout Subsubsection
16780 \begin_layout Standard
16781 The amount of space before and after multiple columns can be changed by
16782 changing the length
16783 \begin_inset Flex Code
16786 \begin_layout Plain Layout
16795 For example the command
16798 \begin_layout LyX-Code
16806 \begin_layout Standard
16807 in \SpecialChar TeX
16808 Code changes its value to 3
16809 \begin_inset space \thinspace{}
16813 The change must be made before the multiple columns' start.
16814 The predefined value is 13
16815 \begin_inset space \thinspace{}
16821 \begin_layout Standard
16823 \begin_inset Flex Code
16826 \begin_layout Plain Layout
16835 \begin_inset space \thinspace{}
16841 \begin_layout Standard
16845 \begin_layout Plain Layout
16851 multicolsep}{2.5cm}
16859 \begin_layout Standard
16860 \begin_inset Flex Multiple Columns
16863 \begin_layout Plain Layout
16866 All day I turned these facts over in my mind, endeavouring to hit upon some
16867 theory which could reconcile them all, and to find that line of least resistanc
16868 e which my poor friend had declared to be the starting-point of every investigat
16870 I confess that I made little progress.
16871 In the evening I strolled across the Park, and found myself about six o'clock
16872 at the Oxford Street end of Park Lane.
16873 A group of loafers upon the pavements, all staring up at a particular window,
16874 directed me to the house which I had come to see.
16875 A tall, thin man with coloured glasses, whom I strongly suspected of being
16876 a plain-clothes detective, was pointing out some theory of his own, while
16877 the others crowded round to listen to what he said.
16878 I got as near him as I could, but his observations seemed to me to be absurd,
16879 so I withdrew again in some disgust.
16880 As I did so I struck against an elderly, deformed man, who had been behind
16881 me, and I knocked down several books which he was carrying.
16889 \begin_layout Standard
16890 \begin_inset Note Greyedout
16893 \begin_layout Plain Layout
16898 The values you set with
16899 \begin_inset Flex Code
16902 \begin_layout Plain Layout
16910 will be used for all following multiple columns until you change them again.
16918 \begin_layout Standard
16922 \begin_layout Plain Layout
16934 \begin_inset Note Note
16937 \begin_layout Plain Layout
16938 go back to the default
16946 \begin_layout Standard
16947 \begin_inset Newpage newpage
16953 \begin_layout Subsubsection
16957 \begin_layout Standard
16958 A column break can be forced by inserting the command
16959 \begin_inset Flex Code
16962 \begin_layout Plain Layout
16970 as \SpecialChar TeX
16971 Code to that position in the text where the column should be broken.
16972 Note that this leads in most cases to whitespace in the text.
16973 \begin_inset Newline newline
16976 Here is an example:
16979 \begin_layout Standard
16980 \begin_inset Flex Multiple Columns
16983 \begin_layout Plain Layout
16986 \begin_inset Quotes eld
16989 You're surprised to see me, sir,
16990 \begin_inset Quotes erd
16993 said he, in a strange, croaking voice.
16996 \begin_layout Plain Layout
16999 I acknowledged that I was.
17002 \begin_layout Plain Layout
17005 \begin_inset Quotes eld
17008 Well, I've a conscience, sir, and when I chanced to see you go into this
17009 house, as I came hobbling after you, I thought to myself, I'll just step
17010 in and see that kind gentleman, and tell him that if I was a bit gruff
17011 in my manner there was not any harm meant, and that I am much obliged to
17012 him for picking up my books.
17013 \begin_inset Quotes erd
17019 \begin_layout Plain Layout
17022 \begin_inset Quotes eld
17025 You make too much of a trifle,
17026 \begin_inset Quotes erd
17031 \begin_inset Quotes eld
17034 May I ask how you knew who I was?
17035 \begin_inset Quotes erd
17038 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
17042 \begin_layout Plain Layout
17054 \begin_layout Plain Layout
17057 \begin_inset Quotes eld
17060 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
17061 you'll find my little bookshop at the corner of Church Street, and very
17062 happy to see you, I am sure.
17063 Maybe you collect yourself, sir.
17067 \begin_inset space ~
17081 \begin_inset space ~
17084 – a bargain, every one of them.
17085 With five volumes you could just fill that gap on that second shelf.
17086 It looks untidy, does it not, sir?
17087 \begin_inset Quotes erd
17098 \begin_layout Subsubsection
17102 \begin_layout Standard
17103 The width of the columns is automatically calculated, but you can modify
17104 the space between the columns.
17105 This is done by changing the length
17106 \begin_inset Flex Code
17109 \begin_layout Plain Layout
17118 Its predefined value is 10
17119 \begin_inset space \thinspace{}
17123 Here is an example where
17124 \begin_inset Flex Code
17127 \begin_layout Plain Layout
17136 \begin_inset space \thinspace{}
17142 \begin_layout Standard
17146 \begin_layout Plain Layout
17160 \begin_layout Standard
17161 \begin_inset Flex Multiple Columns
17164 \begin_layout Plain Layout
17167 My observations of No.
17168 \begin_inset space \space{}
17171 427 Park Lane did little to clear up the problem in which I was interested.
17172 The house was separated from the street by a low wall and railing, the
17173 whole not more than five feet high.
17174 It was perfectly easy, therefore, for anyone to get into the garden, but
17175 the window was entirely inaccessible, since there was no water pipe or
17176 anything which could help the most active man to climb it.
17177 More puzzled than ever, I retraced my steps to Kensington.
17178 I had not been in my study five minutes when the maid entered to say that
17179 a person desired to see me.
17180 To my astonishment it was none other than my strange old book collector,
17181 his sharp, wizened face peering out from a frame of white hair, and his
17182 precious volumes, a dozen of them at least, wedged under his right arm.
17190 \begin_layout Standard
17194 \begin_layout Plain Layout
17206 \begin_inset Note Note
17209 \begin_layout Plain Layout
17210 go back to the default
17218 \begin_layout Subsubsection
17222 \begin_layout Standard
17223 Between the columns a rule with a width of the length
17224 \begin_inset Flex Code
17227 \begin_layout Plain Layout
17236 If this rule width is set to 0
17237 \begin_inset space \thinspace{}
17240 pt (this is the default), the rule is suppressed.
17241 In the following example the rule is 2
17242 \begin_inset space \thinspace{}
17248 \begin_layout Standard
17252 \begin_layout Plain Layout
17258 columnseprule}{2pt}
17266 \begin_layout Standard
17267 \begin_inset Flex Multiple Columns
17270 \begin_layout Plain Layout
17273 \begin_inset Quotes eld
17276 You're surprised to see me, sir,
17277 \begin_inset Quotes erd
17280 said he, in a strange, croaking voice.
17283 \begin_layout Plain Layout
17286 I acknowledged that I was.
17289 \begin_layout Plain Layout
17292 \begin_inset Quotes eld
17295 Well, I've a conscience, sir, and when I chanced to see you go into this
17296 house, as I came hobbling after you, I thought to myself, I'll just step
17297 in and see that kind gentleman, and tell him that if I was a bit gruff
17298 in my manner there was not any harm meant, and that I am much obliged to
17299 him for picking up my books.
17300 \begin_inset Quotes erd
17306 \begin_layout Plain Layout
17309 \begin_inset Quotes eld
17312 You make too much of a trifle,
17313 \begin_inset Quotes erd
17318 \begin_inset Quotes eld
17321 May I ask how you knew who I was?
17322 \begin_inset Quotes erd
17328 \begin_layout Plain Layout
17331 \begin_inset Quotes eld
17334 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
17335 you'll find my little bookshop at the corner of Church Street, and very
17336 happy to see you, I am sure.
17337 Maybe you collect yourself, sir.
17341 \begin_inset space ~
17355 \begin_inset space ~
17358 – a bargain, every one of them.
17359 With five volumes you could just fill that gap on that second shelf.
17360 It looks untidy, does it not, sir?
17361 \begin_inset Quotes erd
17372 \begin_layout Standard
17373 \begin_inset VSpace defskip
17379 \begin_layout Standard
17380 The rule can be colored by redefining the command
17381 \begin_inset Flex Code
17384 \begin_layout Plain Layout
17393 This is done by inserting the command
17396 \begin_layout LyX-Code
17401 columnseprulecolor}{
17406 \begin_layout Standard
17407 as \SpecialChar TeX
17408 Code before the multicolumn inset.
17410 \begin_inset Flex Code
17413 \begin_layout Plain Layout
17419 in this command by a color of your choice.
17420 You can use all pre- and self-defined colors.
17428 \begin_inset space ~
17433 for more information about pre- and self-defined colors.
17434 To go back to the default color insert the command
17437 \begin_layout LyX-Code
17442 columnseprulecolor}{
17447 \begin_layout Standard
17448 Here is the example with a cyan rule and 1
17449 \begin_inset space \thinspace{}
17452 cm column separation:
17455 \begin_layout Standard
17459 \begin_layout Plain Layout
17468 \begin_layout Plain Layout
17474 columnseprulecolor}{
17484 \begin_layout Standard
17485 \begin_inset Flex Multiple Columns
17488 \begin_layout Plain Layout
17491 \begin_inset Quotes eld
17494 You're surprised to see me, sir,
17495 \begin_inset Quotes erd
17498 said he, in a strange, croaking voice.
17501 \begin_layout Plain Layout
17504 I acknowledged that I was.
17507 \begin_layout Plain Layout
17510 \begin_inset Quotes eld
17513 Well, I've a conscience, sir, and when I chanced to see you go into this
17514 house, as I came hobbling after you, I thought to myself, I'll just step
17515 in and see that kind gentleman, and tell him that if I was a bit gruff
17516 in my manner there was not any harm meant, and that I am much obliged to
17517 him for picking up my books.
17518 \begin_inset Quotes erd
17524 \begin_layout Plain Layout
17527 \begin_inset Quotes eld
17530 You make too much of a trifle,
17531 \begin_inset Quotes erd
17536 \begin_inset Quotes eld
17539 May I ask how you knew who I was?
17540 \begin_inset Quotes erd
17546 \begin_layout Plain Layout
17549 \begin_inset Quotes eld
17552 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
17553 you'll find my little bookshop at the corner of Church Street, and very
17554 happy to see you, I am sure.
17555 Maybe you collect yourself, sir.
17559 \begin_inset space ~
17573 \begin_inset space ~
17576 – a bargain, every one of them.
17577 With five volumes you could just fill that gap on that second shelf.
17578 It looks untidy, does it not, sir?
17579 \begin_inset Quotes erd
17590 \begin_layout Standard
17594 \begin_layout Plain Layout
17600 columnseprule}{0pt}
17603 \begin_layout Plain Layout
17609 columnseprulecolor}{
17617 \begin_inset Note Note
17620 \begin_layout Plain Layout
17621 go back to the default
17629 \begin_layout Section
17631 \change_inserted 564990737 1671270380
17635 \begin_layout Subsection
17637 \change_inserted 564990737 1671270398
17639 \change_deleted 564990737 1671270396
17645 \begin_layout Standard
17648 as well as any other text processor uses by default rectangular paragraphs.
17649 For special cases like for example posters, invitation cards or poems you
17650 can modify the paragraph shape to one of your choice.
17651 This can be done by using the \SpecialChar LaTeX
17653 \begin_inset Flex Code
17656 \begin_layout Plain Layout
17662 which is loaded by using in the document settings the module
17664 Custom paragraph shapes
17669 \begin_layout Subsubsection
17673 \begin_layout Standard
17678 provides the following shapes:
17681 \begin_layout Standard
17682 \begin_inset Tabular
17683 <lyxtabular version="3" rows="13" columns="3">
17684 <features booktabs="true" islongtable="true" longtabularalignment="center">
17685 <column alignment="left" valignment="middle" width="16col%">
17686 <column alignment="left" valignment="middle" width="40col%">
17687 <column alignment="left" valignment="middle" width="35col%">
17688 <row endhead="true">
17689 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
17692 \begin_layout Plain Layout
17701 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
17704 \begin_layout Plain Layout
17713 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
17716 \begin_layout Plain Layout
17726 <row interlinespace="default">
17727 <cell alignment="left" valignment="top" usebox="none">
17730 \begin_layout Plain Layout
17738 <cell alignment="left" valignment="top" usebox="none">
17741 \begin_layout Plain Layout
17744 Circle with circular hole (in the size of a CD/DVD)
17749 <cell alignment="left" valignment="top" usebox="none">
17752 \begin_layout Plain Layout
17755 Cannot be scaled, take care there is not too much text
17761 <row interlinespace="default">
17762 <cell alignment="left" valignment="top" usebox="none">
17765 \begin_layout Plain Layout
17773 <cell alignment="left" valignment="top" usebox="none">
17776 \begin_layout Plain Layout
17784 <cell alignment="left" valignment="top" usebox="none">
17787 \begin_layout Plain Layout
17790 Fragile, calculation might fail
17796 <row interlinespace="default">
17797 <cell alignment="left" valignment="top" usebox="none">
17800 \begin_layout Plain Layout
17808 <cell alignment="left" valignment="top" usebox="none">
17811 \begin_layout Plain Layout
17814 Rhomboid (symbolizing a
17815 \begin_inset Quotes eld
17819 \begin_inset Quotes erd
17827 <cell alignment="left" valignment="top" usebox="none">
17830 \begin_layout Plain Layout
17839 <row interlinespace="default">
17840 <cell alignment="left" valignment="top" usebox="none">
17843 \begin_layout Plain Layout
17851 <cell alignment="left" valignment="top" usebox="none">
17854 \begin_layout Plain Layout
17862 <cell alignment="left" valignment="top" usebox="none">
17865 \begin_layout Plain Layout
17874 <row interlinespace="default">
17875 <cell alignment="left" valignment="top" usebox="none">
17878 \begin_layout Plain Layout
17886 <cell alignment="left" valignment="top" usebox="none">
17889 \begin_layout Plain Layout
17897 <cell alignment="left" valignment="top" usebox="none">
17900 \begin_layout Plain Layout
17909 <row interlinespace="default">
17910 <cell alignment="left" valignment="top" usebox="none">
17913 \begin_layout Plain Layout
17921 <cell alignment="left" valignment="top" usebox="none">
17924 \begin_layout Plain Layout
17927 Nut for bolt (hexagon with circular hole)
17932 <cell alignment="left" valignment="top" usebox="none">
17935 \begin_layout Plain Layout
17944 <row interlinespace="default">
17945 <cell alignment="left" valignment="top" usebox="none">
17948 \begin_layout Plain Layout
17956 <cell alignment="left" valignment="top" usebox="none">
17959 \begin_layout Plain Layout
17967 <cell alignment="left" valignment="top" usebox="none">
17970 \begin_layout Plain Layout
17979 <row interlinespace="default">
17980 <cell alignment="left" valignment="top" usebox="none">
17983 \begin_layout Plain Layout
17991 <cell alignment="left" valignment="top" usebox="none">
17994 \begin_layout Plain Layout
18002 <cell alignment="left" valignment="top" usebox="none">
18005 \begin_layout Plain Layout
18014 <row interlinespace="default">
18015 <cell alignment="left" valignment="top" usebox="none">
18018 \begin_layout Plain Layout
18026 <cell alignment="left" valignment="top" usebox="none">
18029 \begin_layout Plain Layout
18037 <cell alignment="left" valignment="top" usebox="none">
18040 \begin_layout Plain Layout
18049 <row interlinespace="default">
18050 <cell alignment="left" valignment="top" usebox="none">
18053 \begin_layout Plain Layout
18061 <cell alignment="left" valignment="top" usebox="none">
18064 \begin_layout Plain Layout
18067 Normal/reversed rain drop
18072 <cell alignment="left" valignment="top" usebox="none">
18075 \begin_layout Plain Layout
18078 Fragile, calculation might fail
18084 <row interlinespace="default">
18085 <cell alignment="left" valignment="top" usebox="none">
18088 \begin_layout Plain Layout
18097 <cell alignment="left" valignment="top" usebox="none">
18100 \begin_layout Plain Layout
18103 The \SpecialChar TeX
18109 <cell alignment="left" valignment="top" usebox="none">
18112 \begin_layout Plain Layout
18121 <row interlinespace="default">
18122 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
18125 \begin_layout Plain Layout
18129 \begin_inset Newline newline
18137 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
18140 \begin_layout Plain Layout
18143 Triangles in different orientations
18148 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
18151 \begin_layout Plain Layout
18167 \begin_layout Standard
18168 To use a shape for your paragraph, simply select it in \SpecialChar LyX
18170 for environments in the toolbar.
18173 \begin_layout Standard
18174 \begin_inset Newpage newpage
18180 \begin_layout Standard
18181 Here is an example paragraph in the shape of a nut:
18184 \begin_layout Standard
18185 \begin_inset VSpace bigskip
18194 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
18195 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
18197 At vero eos et accusam et justo duo dolores et ea rebum.
18198 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
18200 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
18201 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
18205 \begin_layout Standard
18206 \begin_inset VSpace bigskip
18212 \begin_layout Standard
18213 \begin_inset Note Greyedout
18216 \begin_layout Plain Layout
18225 paragraphs cannot run over a page break.
18233 \begin_layout Standard
18234 \begin_inset VSpace bigskip
18240 \begin_layout Standard
18242 \begin_inset Flex Code
18245 \begin_layout Plain Layout
18251 takes care that the shape will always be preserved, no matter how much
18252 text is in the paragraph.
18253 Therefore the paragraph size changes with the amount of contained text.
18254 This can lead to paragraph sizes exceeding the page margins.
18255 To demonstrate the size scaling, here is the same example paragraph but
18256 with twice as much text:
18259 \begin_layout Standard
18260 \begin_inset Newpage newpage
18269 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
18270 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
18272 At vero eos et accusam et justo duo dolores et ea rebum.
18273 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
18275 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
18276 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
18278 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
18279 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
18281 At vero eos et accusam et justo duo dolores et ea rebum.
18282 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
18284 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
18285 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
18289 \begin_layout Standard
18290 \begin_inset VSpace bigskip
18296 \begin_layout Standard
18297 An exception is the shape
18302 It cannot be scaled because it must fit the size of a CD/DVD.
18303 Therefore the amount of text that fits into the shape is limited.
18304 \begin_inset Newline newline
18315 shape are fragile, meaning that the calculation of their size can fail,
18316 depending on the amount of text.
18317 You will then get the \SpecialChar LaTeX
18319 \begin_inset Quotes eld
18322 Arithmetic overflow
18323 \begin_inset Quotes erd
18327 In this case one can try to remove or add some text; if nothing works one
18328 has to use another shape.
18331 \begin_layout Standard
18332 \begin_inset VSpace bigskip
18338 \begin_layout Standard
18339 For shapes with tips you will maybe see that \SpecialChar LaTeX
18340 's hyphenation routine fails
18341 for text in the tips.
18342 Therefore it is often necessary to add hyphenation points
18347 arg "specialchar-insert hyphenation"
18352 ) to the corresponding text parts.
18355 \begin_layout Standard
18356 \begin_inset VSpace bigskip
18362 \begin_layout Standard
18363 Shapepar paragraphs are either always centered or placed on the page so
18364 that their left border touches the left page margin.
18365 You can therefore not use the paragraph dialog to align such paragraphs.
18366 A solution is to put the paragraph into a minipage or parbox and align
18368 The problem is hereby to find the right width for the box.
18369 Because if it is too wide and you center the box, the paragraph is not
18370 centered too because it sticks at the left side of the box.
18371 So you might have to play a bit with the width until it fits.
18372 Here are two heart-shaped paragraphs, the first one is not aligned, the
18373 second one is right-aligned:
18376 \begin_layout Standard
18377 \begin_inset Newpage newpage
18383 \begin_layout Heart
18387 Lo\SpecialChar softhyphen
18388 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
18389 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
18391 At vero eos et accusam et justo duo dolores et ea rebum.
18392 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
18396 \begin_layout Standard
18397 \begin_inset VSpace bigskip
18403 \begin_layout Standard
18406 \begin_inset Box Frameless
18416 height_special "totalheight"
18421 backgroundcolor "none"
18424 \begin_layout Heart
18428 Lo\SpecialChar softhyphen
18429 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
18430 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
18432 At vero eos et accusam et justo duo dolores et ea rebum.
18433 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
18442 \begin_layout Subsubsection
18446 \begin_layout Standard
18447 You can define any shape you want.
18448 Doing this manually is a lot of work because every coordinate must be specified.
18449 But there is a way to let the computer calculate the coordinates:
18452 \begin_layout Enumerate
18453 Install the program
18454 \begin_inset CommandInset href
18457 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
18465 \begin_layout Enumerate
18472 TeX/LaTeX\SpecialChar menuseparator
18473 Settings\SpecialChar menuseparator
18476 and select the font size you are using in your document.
18477 For example this document uses the size 12
18478 \begin_inset space \thinspace{}
18484 \begin_layout Enumerate
18488 \begin_layout Enumerate
18491 TeX/LaTeX\SpecialChar menuseparator
18494 to export the shape to coordinates.
18495 In the appearing dialog use either the outline of your shape for the coordinate
18496 s or the path itself.
18500 \begin_layout Plain Layout
18501 For more information see
18502 \begin_inset CommandInset href
18504 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
18517 \begin_layout Standard
18518 The coordinates are written into a \SpecialChar TeX
18520 To use it for your \SpecialChar LyX
18524 \begin_layout Enumerate
18525 Place the cursor before the first character of your paragraph (or into a
18529 \begin_layout Enumerate
18530 Open in \SpecialChar LyX
18533 Insert\SpecialChar menuseparator
18534 File\SpecialChar menuseparator
18536 \begin_inset space ~
18541 , select the file and use
18550 \begin_layout Standard
18551 \begin_inset VSpace defskip
18557 \begin_layout Standard
18558 \begin_inset Note Greyedout
18561 \begin_layout Plain Layout
18566 : The changed shape only applies to the current paragraph; everything is
18567 reset to normal for the next paragraph.
18568 Therefore the shape definition file must be input into every paragraph
18569 with the desired shape.
18577 \begin_layout Standard
18578 \begin_inset VSpace bigskip
18584 \begin_layout Standard
18585 Here is an example:
18588 \begin_layout Standard
18589 \begin_inset VSpace bigskip
18595 \begin_layout Standard
18596 \begin_inset CommandInset include
18598 filename "SpecialParagraphShape.tex"
18605 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
18606 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
18608 At vero eos et accusam et justo duo dolores et ea rebum.
18609 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
18611 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
18612 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
18616 \begin_layout Standard
18617 \begin_inset VSpace bigskip
18623 \begin_layout Standard
18628 to draw complexer shapes in
18632 you can draw the shape in a program of your choice and import the resulting
18638 Then you only need to draw a line or spline along the outline of the image.
18641 \begin_layout Standard
18642 \begin_inset VSpace bigskip
18648 \begin_layout Standard
18651 Custom paragraph shapes
18653 also provides the two commands
18661 which can be used to define custom shapes coordinate by coordinate.
18665 \begin_layout Plain Layout
18666 These commands are internally used for all shapes described here.
18671 For information how these styles are used and about further customization
18672 possibilities, have a look at the
18673 \begin_inset CommandInset href
18675 name "documentation"
18676 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
18682 \begin_inset Flex Code
18685 \begin_layout Plain Layout
18694 \begin_layout Chapter
18696 \change_deleted 564990737 1671304317
18700 \change_inserted 564990737 1671304322
18702 \change_deleted 564990737 1671304331
18703 ies with Bib\SpecialChar TeX
18709 \begin_layout Standard
18710 The most basic information about how to use Bib\SpecialChar TeX
18715 with \SpecialChar LyX
18716 is contained in the section
18718 Bibliography databases
18725 The following subsections explain special bibliography features supported
18726 by \SpecialChar LyX
18730 \begin_layout Section
18731 Alternative Citation Styles
18734 \begin_layout Standard
18735 Standard Bib\SpecialChar TeX
18737 \begin_inset space \thinspace{}
18741 \begin_inset space \space{}
18745 \begin_inset Quotes eld
18749 \begin_inset Quotes erd
18752 ) to refer to a cited work.
18753 However, in many scientific disciplines, other citation styles are in use.
18754 The most common one is the author-year style (e.
18755 \begin_inset space \thinspace{}
18759 \begin_inset space \space{}
18763 \begin_inset Quotes eld
18767 \begin_inset Quotes erd
18772 supports three packages that provide this style,
18773 \begin_inset Flex Code
18776 \begin_layout Plain Layout
18783 \begin_inset Flex Code
18786 \begin_layout Plain Layout
18793 \begin_inset Flex Code
18796 \begin_layout Plain Layout
18803 Each of these packages has their pros and cons, which cannot be listed
18805 If you only want to have simple author-year (or author-numerical) style,
18806 or if you want to use one of the countless style files for
18807 \begin_inset Flex Code
18810 \begin_layout Plain Layout
18816 , then the established
18817 \begin_inset Flex Code
18820 \begin_layout Plain Layout
18826 package is probably your choice.
18827 If you look for specific citation styles common in law studies, you might
18829 \begin_inset Flex Code
18832 \begin_layout Plain Layout
18839 If you want to have full control over the formatting or look for advanced
18840 features such as ibidem, footnote citations, full title citations, advanced
18841 date formats (such as 400 BC) or full localization to other languages than
18842 English, you should definitely consider
18843 \begin_inset Flex Code
18846 \begin_layout Plain Layout
18852 , which exceeds all other packages in terms of features, but is also quite
18853 heavy and more resource-hungry.
18856 \begin_layout Standard
18857 The handling of these packages in \SpecialChar LyX
18858 is basically the same.
18860 \begin_inset Flex Noun
18863 \begin_layout Plain Layout
18864 Document\SpecialChar menuseparator
18871 \begin_inset Flex Noun
18874 \begin_layout Plain Layout
18881 \begin_inset Flex Noun
18884 \begin_layout Plain Layout
18891 \begin_inset Flex Noun
18894 \begin_layout Plain Layout
18901 \begin_inset Flex Noun
18904 \begin_layout Plain Layout
18911 \begin_inset Flex Noun
18914 \begin_layout Plain Layout
18915 Biblatex (Natbib mode)
18921 \begin_inset Flex Noun
18924 \begin_layout Plain Layout
18931 \begin_inset Flex Noun
18934 \begin_layout Plain Layout
18941 \begin_inset space ~
18944 6.5.3 in the User's Guide for more information on these choices).
18945 With all these packages, you will get some extra features in the citation
18946 dialog and you can select the style of the reference (
18947 \begin_inset Quotes eld
18951 \begin_inset Quotes erd
18955 \begin_inset Quotes eld
18959 \begin_inset Quotes erd
18963 \begin_inset Quotes eld
18967 \begin_inset Quotes erd
18971 \begin_inset Quotes eld
18975 \begin_inset Quotes erd
18979 Note that either package needs specifically designed style files.
18980 They all ship their own, but there are lots of additional style files,
18981 and there is even an interactive style file builder
18985 \begin_layout Plain Layout
18987 \begin_inset Flex URL
18990 \begin_layout Plain Layout
18992 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
19003 \begin_inset Flex Code
19006 \begin_layout Plain Layout
19015 \begin_layout Section
19016 Subdivided Bibliographies
19019 \begin_layout Standard
19020 Sometimes you might need to divide your bibliography into several sections.
19021 If you are for instance a historian, the possibility to separate sources
19022 and scientific works is most likely a
19023 \begin_inset Quotes eld
19027 \begin_inset Quotes erd
19031 Unfortunately, Bib\SpecialChar TeX
19032 itself does not allow you to do this.
19033 But with the help of some \SpecialChar LaTeX
19034 packages, Bib\SpecialChar TeX
19035 can be extended to fit your needs.
19038 \begin_layout Standard
19040 provides native support for one of these packages,
19048 \begin_layout Plain Layout
19050 \begin_inset Flex URL
19053 \begin_layout Plain Layout
19055 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
19065 The advantage of this package (compared to other packages such as
19069 ) is that you don't need to define new citation commands.
19070 Instead, you need to prepare different bibliographic databases which include
19071 the entries for the different sections of the bibliography.
19072 For example: If you want to divide your bibliography into the sections
19074 \begin_inset Quotes eld
19078 \begin_inset Quotes erd
19082 \begin_inset Quotes eld
19086 \begin_inset Quotes erd
19089 , you first need to create two bibliographic databases, e.
19090 \begin_inset space \thinspace{}
19094 \begin_inset space \space{}
19098 \begin_inset Flex Code
19101 \begin_layout Plain Layout
19108 \begin_inset Flex Code
19111 \begin_layout Plain Layout
19121 \begin_layout Standard
19123 \begin_inset Flex Noun
19126 \begin_layout Plain Layout
19127 Document\SpecialChar menuseparator
19134 \begin_inset Flex Noun
19137 \begin_layout Plain Layout
19144 \begin_inset Flex Noun
19147 \begin_layout Plain Layout
19148 Subdivided bibliography
19154 Now you can insert multiple Bib\SpecialChar TeX
19155 bibliographies, one for each section of
19157 Returning to our example: Insert the Bib\SpecialChar TeX
19159 \begin_inset Flex Code
19162 \begin_layout Plain Layout
19168 and a second one for the database
19169 \begin_inset Flex Code
19172 \begin_layout Plain Layout
19179 You are free to use the same or different styles for each section.
19180 Additionally, you can choose if the bibliography section should contain
19182 \begin_inset Quotes eld
19185 all cited references
19186 \begin_inset Quotes erd
19189 of the specified database(s) (which is the default),
19190 \begin_inset Quotes eld
19193 all uncited references
19194 \begin_inset Quotes erd
19198 \begin_inset Quotes eld
19202 \begin_inset Quotes erd
19206 This might be useful if you would like to separate your bibliography into
19208 \begin_inset Quotes eld
19212 \begin_inset Quotes erd
19216 \begin_inset Quotes eld
19220 \begin_inset Quotes erd
19224 \begin_inset Quotes eld
19228 \begin_inset Quotes erd
19232 The titles for the sections can be added as ordinary sections or subsections.
19234 \begin_inset Flex Code
19237 \begin_layout Plain Layout
19243 removes the bibliography title, you have to manually re-add that, too (as
19244 a chapter* or section*, for instance).
19247 \begin_layout Standard
19252 , the procedure is a bit different.
19261 , the aforementioned
19262 \begin_inset Flex Noun
19265 \begin_layout Plain Layout
19266 Subdivided bibliography
19271 option is disabled if you use
19280 provides its own means to generate subdivided bibliographies.
19281 You can either add keywords to bibliography entries via the
19282 \begin_inset Flex Code
19285 \begin_layout Plain Layout
19291 entry option and then filter bibliography sections by keyword (by adding
19293 \begin_inset Flex Code
19296 \begin_layout Plain Layout
19303 \begin_inset Flex Noun
19306 \begin_layout Plain Layout
19312 field of the dialog that opens if you left-click on the
19313 \begin_inset Flex Noun
19316 \begin_layout Plain Layout
19317 Biblatex Generated Bibliography
19322 button), or you can filter by entry types (such as
19331 \begin_inset space \thinspace{}
19336 \begin_inset Flex Code
19339 \begin_layout Plain Layout
19346 \begin_inset Flex Code
19349 \begin_layout Plain Layout
19356 \begin_inset Flex Noun
19359 \begin_layout Plain Layout
19365 field, or you can create so-called
19366 \begin_inset Quotes eld
19369 Bibliography Categories
19370 \begin_inset Quotes erd
19373 to which you can assign individual entries.
19374 Please refer to the Biblatex manual, section
19376 Subdivided Bibliographies
19381 \begin_layout Section
19382 Multiple Bibliographies
19383 \begin_inset CommandInset label
19385 name "subsec:Multiple-Bibliographies"
19392 \begin_layout Standard
19393 Multiple bibliographies, e.
19394 \begin_inset space \thinspace{}
19398 \begin_inset space \space{}
19401 a bibliography for each part, chapter, section, subsection or child (sub-documen
19402 t) of the document, are also supported by \SpecialChar LyX
19404 In order to enable it, go to
19405 \begin_inset Flex Noun
19408 \begin_layout Plain Layout
19409 Document\SpecialChar menuseparator
19410 Settings\SpecialChar menuseparator
19416 and select the relevant unit (e.
19417 \begin_inset space \thinspace{}
19421 \begin_inset Quotes eld
19425 \begin_inset Quotes erd
19429 \begin_inset Flex Noun
19432 \begin_layout Plain Layout
19433 Multiple Bibliographies
19439 Then add a Bib(la)\SpecialChar TeX
19440 bibliography to each unit (e.
19441 \begin_inset space \thinspace{}
19444 g., section) of your document.
19445 In the output, a separate bibliography, containing only the references
19446 done in the current unit is generated.
19449 \begin_layout Standard
19450 If you use Bib\SpecialChar TeX
19452 \begin_inset Flex Code
19455 \begin_layout Plain Layout
19462 \begin_inset Flex Code
19465 \begin_layout Plain Layout
19471 package is used to create multiple bibliographies.
19472 The former package is used if you select
19473 \begin_inset Quotes eld
19477 \begin_inset Quotes erd
19485 \begin_inset Flex Noun
19488 \begin_layout Plain Layout
19489 Sectioned Bibliography
19495 In all other cases,
19496 \begin_inset Flex Code
19499 \begin_layout Plain Layout
19509 \begin_layout Plain Layout
19510 An alternative approach, if you are willing to use some
19511 \begin_inset Flex Noun
19514 \begin_layout Plain Layout
19522 \begin_inset space ~
19526 \begin_inset CommandInset ref
19528 reference "sec:Inserting-TeX-Code"
19533 \begin_inset Flex Code
19536 \begin_layout Plain Layout
19548 \begin_inset Flex Code
19551 \begin_layout Plain Layout
19557 is used, \SpecialChar LyX
19558 encloses the specified units in
19559 \begin_inset Flex Code
19562 \begin_layout Plain Layout
19569 \begin_inset Flex Code
19572 \begin_layout Plain Layout
19581 \begin_inset Flex Code
19584 \begin_layout Plain Layout
19592 in order to create the units.
19593 Note that this approach has some limitations.
19594 First, every citation reference has to be inside some
19595 \begin_inset Flex Code
19598 \begin_layout Plain Layout
19605 So citations outside a defined unit (e.
19606 \begin_inset space \thinspace{}
19609 g., before the first section if you use
19610 \begin_inset Quotes eld
19614 \begin_inset Quotes erd
19618 \begin_inset Quotes eld
19622 \begin_inset Quotes erd
19626 You can also create your own units by entering
19627 \begin_inset Flex Code
19630 \begin_layout Plain Layout
19639 \begin_inset Flex Code
19642 \begin_layout Plain Layout
19650 as \SpecialChar TeX
19651 code (for instance to work around the mentioned limitation).
19653 \begin_inset Flex Code
19656 \begin_layout Plain Layout
19662 s cannot be nested.
19663 A second limitation is that
19664 \begin_inset Flex Code
19667 \begin_layout Plain Layout
19673 always processes all references of a bibliography database, even if they
19675 This can result in odd labels (e.
19676 \begin_inset space \thinspace{}
19681 \begin_inset Quotes eld
19685 \begin_inset Quotes erd
19688 if two works of this author from 2014 are in the database, even if only
19692 \begin_layout Standard
19698 \begin_inset Flex Code
19701 \begin_layout Plain Layout
19707 option is used instead.
19708 If you need specific units, you can start them with the \SpecialChar TeX
19710 \begin_inset Flex Code
19713 \begin_layout Plain Layout
19722 \begin_inset Flex Code
19725 \begin_layout Plain Layout
19734 If you also want to control the end of the unit, use the environment
19735 \begin_inset Flex Code
19738 \begin_layout Plain Layout
19748 \begin_inset Flex Code
19751 \begin_layout Plain Layout
19761 \begin_inset Flex Code
19764 \begin_layout Plain Layout
19770 s cannot be nested.
19771 In addition to the individual bibliography of the current unit,
19775 also provides an easy way to output all bibliographies, subsequently, at
19777 \begin_inset space \thinspace{}
19780 g., at the end of the document).
19782 \begin_inset Quotes eld
19785 all reference units
19786 \begin_inset Quotes erd
19789 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
19791 Please refer to the
19795 manual for more information on this topic.
19798 \begin_layout Chapter
19800 \change_deleted 564990737 1671355654
19804 \change_inserted 564990737 1671355667
19806 \change_deleted 564990737 1671355661
19808 \change_inserted 564990737 1671355684
19810 \begin_inset CommandInset label
19812 name "chap:bullets"
19817 \change_deleted 564990737 1671355684
19819 \begin_inset CommandInset label
19830 \begin_layout Standard
19836 \begin_layout Section
19840 \begin_layout Standard
19842 provides 216 bullet shapes that can be accessed from a simple dialog.
19843 Using this dialog you can easily specify what bullet shape to use at each
19844 level of an itemized list.
19845 These settings are document-wide so you won't be able to specify different
19846 sets of bullets for different paragraphs.
19850 \begin_layout Plain Layout
19851 Well, actually you can but you'll have to do it by hand.
19859 \begin_layout Section
19863 \begin_layout Standard
19864 Open the dialog by selecting the
19865 \begin_inset Flex Noun
19868 \begin_layout Plain Layout
19869 Document\SpecialChar menuseparator
19875 menu item and then select the
19876 \begin_inset Flex Noun
19879 \begin_layout Plain Layout
19888 \begin_layout Standard
19889 The dialog provides you with a table of bullet shapes.
19890 A column of buttons on the left of the table provides access to the six
19891 different panels of bullet shapes.
19892 The row of buttons across the top is used to select which bullet depth
19895 \change_deleted 244031559 1603875981
19896 A text entry under the table shows the currently selected bullet shape's
19898 equivalent and this can be edited if desired.
19899 If you do modify the text you will also need to specify any needed packages
19900 in the \SpecialChar LaTeX
19906 \begin_layout Standard
19907 The six panels are divided up by the packages they require.
19908 The following table shows the mappings from button name to \SpecialChar LaTeX
19912 \begin_layout Standard
19914 \begin_inset Tabular
19915 <lyxtabular version="3" rows="7" columns="2">
19916 <features tabularvalignment="middle">
19917 <column alignment="center" valignment="top" width="0pt">
19918 <column alignment="center" valignment="top" width="0pt">
19920 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
19923 \begin_layout Plain Layout
19938 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
19941 \begin_layout Plain Layout
19958 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
19961 \begin_layout Plain Layout
19976 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
19979 \begin_layout Plain Layout
19988 base \SpecialChar LaTeX
19996 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
19999 \begin_layout Plain Layout
20014 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20017 \begin_layout Plain Layout
20034 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20037 \begin_layout Plain Layout
20052 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20055 \begin_layout Plain Layout
20072 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20075 \begin_layout Plain Layout
20090 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20093 \begin_layout Plain Layout
20110 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20113 \begin_layout Plain Layout
20128 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20131 \begin_layout Plain Layout
20148 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
20151 \begin_layout Plain Layout
20166 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
20169 \begin_layout Plain Layout
20192 \begin_layout Standard
20194 doesn't stop you using bullets from packages you don't have.
20195 If you get errors from \SpecialChar LaTeX
20196 when you try to view or print the file, then it
20197 is likely you are missing a package.
20201 \begin_layout Plain Layout
20203 doesn't restrict your use since you may be editing locally and exporting
20212 \begin_layout Section
20216 \begin_layout Standard
20217 Select which bullet depth you want to change then select the bullet shape
20219 Any changes will not be visible in \SpecialChar LyX
20220 , but are visible when viewing the document.
20223 \begin_layout Standard
20224 You can reset a bullet shape to the default simply by clicking your right
20225 mouse button on the appropriate bullet depth button.
20229 \begin_layout Plain Layout
20231 \change_inserted 564990737 1672138075
20232 \begin_inset CommandInset label
20234 name "fn:If-you-really"
20244 want to have multiple sets of paragraphs with different sets of bullets
20245 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
20247 The bullet selection dialog can help though because it provides you with
20248 the \SpecialChar LaTeX
20249 code for a wide range of bullet shapes.
20250 To make your own custom paragraphs you have the following options:
20253 \begin_layout Plain Layout
20257 \begin_layout Plain Layout
20273 \begin_layout Plain Layout
20277 \begin_layout Plain Layout
20299 \begin_layout Itemize
20300 Use the \SpecialChar LaTeX
20302 \begin_inset Flex Code
20305 \begin_layout Plain Layout
20313 to specify a new bullet shape for a given depth.
20314 You'll also need to save the current bullet shape so you can restore it
20316 In this itemized list the following \SpecialChar LaTeX
20317 code was used to change the bullet
20318 used for the first depth.
20322 \begin_layout LyX-Code
20332 \begin_layout LyX-Code
20349 \begin_layout Itemize
20350 Note that the itemize depth is specified in Roman numerals as part of the
20360 \begin_layout Itemize
20361 \begin_inset Argument item:1
20364 \begin_layout Plain Layout
20368 \begin_layout Plain Layout
20386 Specify each individual entry by starting each item with the bullet shape
20388 \begin_inset Quotes eld
20392 \begin_inset Quotes erd
20395 inset (available at
20397 Insert\SpecialChar menuseparator
20401 \begin_inset Flex Noun
20404 \begin_layout Plain Layout
20412 For example, this item was started with
20413 \begin_inset Flex Code
20416 \begin_layout Plain Layout
20431 \begin_layout Plain Layout
20435 \begin_layout Plain Layout
20451 \begin_layout Plain Layout
20452 You'll also need to revert the labelitem back to its previous setting for
20453 the global bullet shape settings to remain in effect.
20454 The way used here was:
20457 \begin_layout LyX-Code
20472 \begin_layout Chapter
20476 \begin_layout Section
20477 Multipart Documents
20480 \begin_layout Subsection
20484 \begin_layout Standard
20485 When you are working on a large file with many sections, it is often convenient
20486 to break up the document into several files, or perhaps you have something
20487 where a table may change from time to time, but the preceding text does
20489 In these cases, you should seriously consider using multipart documents.
20490 For example, scientific papers often have five major sections: the introduction
20491 , observations, results, discussion, and conclusion.
20492 Each of these could be its own separate \SpecialChar LyX
20494 \begin_inset Quotes eld
20498 \begin_inset Quotes erd
20501 file which contains the title, authors, abstract, references, etc., plus
20502 the five included files.
20503 It is important to note that each of these files is a full \SpecialChar LyX
20505 can be formatted and printed on its own, as well as included in a master
20507 Each of these files must have the same document class, however—don't attempt
20508 to mix book classes with article classes.
20509 You may also include \SpecialChar LaTeX
20510 files; however, these files must not have their own
20512 \begin_inset space \thinspace{}
20516 \begin_inset space \space{}
20519 everything up to and including the
20520 \begin_inset Flex Code
20523 \begin_layout Plain Layout
20531 line as well as the
20532 \begin_inset Flex Code
20535 \begin_layout Plain Layout
20543 line must be deleted) or else errors will be generated when you try to
20547 \begin_layout Standard
20549 allows you to include files quite easily with
20550 \begin_inset Flex Noun
20553 \begin_layout Plain Layout
20554 Insert\SpecialChar menuseparator
20556 \begin_inset space ~
20565 When you click on this selection a small box is inserted into the file
20566 at the current cursor location.
20567 Clicking on the box raises a dialog which allows you to select the file
20568 to be included, and the method of its inclusion.
20572 \begin_layout Standard
20573 The file selection box should by now be obvious.
20574 The three inclusion methods are
20575 \begin_inset Quotes eld
20579 \begin_inset Quotes erd
20583 \begin_inset Quotes eld
20587 \begin_inset Quotes erd
20591 \begin_inset Quotes eld
20595 \begin_inset Quotes erd
20600 \begin_inset Quotes eld
20604 \begin_inset Quotes erd
20608 \begin_inset Quotes eld
20612 \begin_inset Quotes erd
20615 are similar in many ways, but there are also some notable differences:
20618 \begin_layout Enumerate
20620 \begin_inset Quotes eld
20624 \begin_inset Quotes erd
20627 are typeset beginning on a new page, while files that are
20628 \begin_inset Quotes eld
20632 \begin_inset Quotes erd
20635 are typeset starting on the current page.
20638 \begin_layout Enumerate
20639 \begin_inset Quotes eld
20643 \begin_inset Quotes erd
20646 files cannot themselves
20647 \begin_inset Quotes eld
20651 \begin_inset Quotes erd
20655 \begin_inset Quotes eld
20659 \begin_inset Quotes erd
20664 \begin_inset Quotes eld
20668 \begin_inset Quotes erd
20671 , on the other hand, infinite sub-inputting is possible.
20674 \begin_layout Enumerate
20675 \begin_inset Quotes eld
20679 \begin_inset Quotes erd
20682 allow for the output of only selected
20683 \begin_inset Quotes eld
20687 \begin_inset Quotes erd
20690 files, while maintaining the actual counters (pagination etc.) and references
20691 (please refer to the section
20694 \begin_inset space ~
20702 \begin_inset space ~
20707 manual for details).
20710 \begin_layout Standard
20712 \begin_inset Quotes eld
20716 \begin_inset Quotes erd
20719 is the preferred method for chapters that are outsourced to child documents,
20721 \begin_inset Quotes eld
20725 \begin_inset Quotes erd
20728 is more suitable for arbitrary file inheritance.
20731 \begin_layout Standard
20733 \begin_inset Quotes eld
20737 \begin_inset Quotes erd
20740 included file allows you to include a file typeset exactly as it appears
20742 \begin_inset space \thinspace{}
20746 \begin_inset space \space{}
20750 \begin_inset Flex Code
20753 \begin_layout Plain Layout
20759 mode, with the characters set in a fixed-width typewriter font.
20760 Normally, spaces in this file are invisible, though two consecutive spaces
20761 are conserved, unlike \SpecialChar LyX
20762 's normal treatment of spaces.
20763 However, setting the
20764 \begin_inset Flex Noun
20767 \begin_layout Plain Layout
20769 \begin_inset space ~
20773 \begin_inset space ~
20777 \begin_inset space ~
20785 checkbox typesets a mark to unambiguously define the presence of a space.
20789 \begin_layout Standard
20790 Generally, the master file is converted into a full \SpecialChar LaTeX
20791 file before typesetting,
20792 while the included files are converted to \SpecialChar LaTeX
20793 files that do not have all the
20794 preamble information.
20797 \begin_layout Subsection
20798 Cross-References Between Files
20801 \begin_layout Standard
20802 \begin_inset Box Shadowbox
20812 height_special "totalheight"
20817 backgroundcolor "none"
20820 \begin_layout Plain Layout
20821 This section is somewhat out of date.
20822 Need to describe default master documents and how children are opened when
20832 \begin_layout Standard
20833 It is possible to set up cross-references between the different files.
20834 First, open all the files in question: let's call them A and B in a two
20835 file example, where B is included in A.
20836 Let's say you insert a label in A, then want to reference it in B.
20837 Open the cross-reference dialog whilst in document B, and you can select
20839 \begin_inset Quotes eld
20843 \begin_inset Quotes erd
20849 \begin_layout Subsection
20850 Bibliography Lists in all Subdocuments
20853 \begin_layout Standard
20854 If you work with child documents, you might want to have only one main bibliogra
20855 phy at the end, but still be able to have a selected bibliography for the
20856 child if you output it on its own.
20857 Here is how to achieve this.
20860 \begin_layout Standard
20861 For the main document, you just insert a bibliography inset at the place
20862 where the main bibliography has to appear (within the master file or within
20864 If the bibliography inset is in the master file, the references will be
20865 inherited by all children, so they are available in the citation dialog
20869 \begin_layout Standard
20870 For child-specific bibliographies, insert bibliography insets within the
20871 child documents, at the place where the bibliography should appear when
20872 the child is compiled separately.
20873 However, the trick is to insert them into a branch (
20875 Insert\SpecialChar menuseparator
20876 Branch\SpecialChar menuseparator
20877 Insert New Branch...
20880 \begin_inset space \thinspace{}
20885 \begin_inset Quotes eld
20889 \begin_inset Quotes erd
20893 Within the children, activate the branch (
20895 Document\SpecialChar menuseparator
20896 Settings...\SpecialChar menuseparator
20900 Within the master, deactivate the branch (
20902 Document\SpecialChar menuseparator
20903 Settings...\SpecialChar menuseparator
20907 Now the child's bibliography will be ignored by the master, but considered
20911 \begin_layout Standard
20912 If you need multiple bibliographies (e.
20913 \begin_inset space \thinspace{}
20916 g., one per child in the
20920 ), please refer to sec.
20921 \begin_inset space ~
20925 \begin_inset CommandInset ref
20927 reference "subsec:Multiple-Bibliographies"
20934 \begin_layout Section
20939 \begin_layout Standard
20940 Users sometimes need to be able to
20941 \begin_inset Quotes eld
20945 \begin_inset Quotes erd
20949 file together with all the images (and other files) on which it depends,
20950 either for sending to a publisher or for sharing with a co-author.
20952 includes a Python script (
20953 \begin_inset Flex Code
20956 \begin_layout Plain Layout
20962 ) that automates this process.
20963 To use it, you must have either the
20964 \begin_inset Flex Code
20967 \begin_layout Plain Layout
20974 \begin_inset Flex Code
20977 \begin_layout Plain Layout
20983 python modules installed on your system.
20984 By default, the script prefers the
20985 \begin_inset Flex Code
20988 \begin_layout Plain Layout
20995 \begin_inset Flex Code
20998 \begin_layout Plain Layout
21004 format on Unix-like systems and the
21005 \begin_inset Flex Code
21008 \begin_layout Plain Layout
21017 \begin_layout Standard
21019 's configuration process will set the script up to export a `\SpecialChar LyX
21021 and this format will then be available under
21022 \begin_inset Flex Code
21025 \begin_layout Plain Layout
21026 File\SpecialChar menuseparator
21035 \begin_layout Standard
21036 Independently of the platform, the generation of a particular archive format
21037 can be forced by adding either the
21038 \begin_inset Flex Code
21041 \begin_layout Plain Layout
21048 \begin_inset Flex Code
21051 \begin_layout Plain Layout
21058 \begin_inset Flex Code
21061 \begin_layout Plain Layout
21068 \begin_inset Flex Code
21071 \begin_layout Plain Layout
21077 format) switch to the
21078 \begin_inset Flex Code
21081 \begin_layout Plain Layout
21083 \SpecialChar menuseparator
21091 \begin_inset Flex Code
21094 \begin_layout Plain Layout
21095 Tools\SpecialChar menuseparator
21096 Preferences\SpecialChar menuseparator
21097 File Handling\SpecialChar menuseparator
21104 (Make sure you add the switch after the script name, not before it.)
21107 \begin_layout Section
21108 Fancy Headers and Footers
21111 \begin_layout Standard
21112 The default page layout is rather plain; for an
21113 \begin_inset Flex Code
21116 \begin_layout Plain Layout
21122 document class, all you get is a centered page number at the bottom of
21124 This document uses KOMA-script's book class, so it appears to be a bit
21126 But to really put on a show, you need to set the document page style to
21128 \begin_inset Quotes eld
21132 \begin_inset Quotes erd
21135 , as mentioned in the
21140 This section describes the \SpecialChar LaTeX
21141 code you need to insert in your \SpecialChar LaTeX
21143 order to get the desired effects.
21146 \begin_layout Standard
21147 For more information on fancy headers, see the
21148 \begin_inset Flex Code
21151 \begin_layout Plain Layout
21157 package documentation.
21159 \begin_inset Flex URL
21162 \begin_layout Plain Layout
21164 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
21172 \begin_layout Standard
21173 The page header is divided into three fields, not surprisingly labeled
21174 \begin_inset Quotes eld
21178 \begin_inset Quotes erd
21182 \begin_inset Quotes eld
21186 \begin_inset Quotes erd
21190 \begin_inset Quotes eld
21194 \begin_inset Quotes erd
21198 The footer is also divided into these three fields.
21199 The \SpecialChar LaTeX
21200 commands to set these fields in the simplest manner are
21201 \begin_inset Flex Code
21204 \begin_layout Plain Layout
21213 \begin_inset Flex Code
21216 \begin_layout Plain Layout
21225 \begin_inset Flex Code
21228 \begin_layout Plain Layout
21237 \begin_inset Flex Code
21240 \begin_layout Plain Layout
21249 Suppose you wish to put your name in the upper left hand corner of each
21251 Simply insert the following command in the preamble:
21254 \begin_layout Standard
21263 \begin_layout Standard
21264 You will now see your name in the upper left.
21265 If a field has a default entry that you would like to get rid of (often
21266 the page number appears in the central footer) simply include a command
21267 with a blank argument, e.
21268 \begin_inset space \thinspace{}
21274 \begin_layout Standard
21282 \begin_layout Standard
21283 Let's get really fancy: lets put the section number with the word
21284 \begin_inset Quotes eld
21288 \begin_inset Quotes erd
21292 \begin_inset space \thinspace{}
21296 \begin_inset space \space{}
21299 Section 3) in the upper left, the page number (e.
21300 \begin_inset space \thinspace{}
21304 \begin_inset space \space{}
21307 Page 4) in the upper right, your name in the lower left, and the date in
21309 The following commands should now appear in the preamble:
21312 \begin_layout Standard
21322 \begin_layout Standard
21330 \begin_layout Standard
21340 \begin_layout Standard
21349 \begin_layout Standard
21357 \begin_layout Standard
21367 \begin_layout Standard
21369 \begin_inset Flex Code
21372 \begin_layout Plain Layout
21381 \begin_inset Flex Code
21384 \begin_layout Plain Layout
21392 access \SpecialChar LaTeX
21393 's section and page counters, and so print out the current section
21396 \begin_inset Flex Code
21399 \begin_layout Plain Layout
21407 simply prints out today's date.
21410 \begin_layout Standard
21411 The thicknesses of the horizontal rules drawn beneath the header and above
21412 the footer can also be modified.
21413 If you don't want one of the rules, set its thickness to 0.
21414 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
21420 \begin_inset Flex Code
21423 \begin_layout Plain Layout
21428 headrulewidth}{0.4pt}
21434 \begin_inset Flex Code
21437 \begin_layout Plain Layout
21442 footrulewidth}{0.4pt}
21447 to set the thicknesses.
21450 \begin_layout Standard
21451 You can switch the header/footer settings on and off for individual pages
21452 using commands like
21453 \begin_inset Flex Code
21456 \begin_layout Plain Layout
21459 thispagestyle{empty}
21465 \begin_inset Flex Code
21468 \begin_layout Plain Layout
21471 thispagestyle{plain}
21477 \begin_inset Flex Code
21480 \begin_layout Plain Layout
21483 thispagestyle{fancy}
21489 Simply insert them in the text on the page you want changed and mark them
21490 as \SpecialChar TeX
21492 In fact, title pages are marked as plain by default, while following pages
21493 are marked fancy when using the global fancy setting.
21496 \begin_layout Standard
21497 As a final example, it is possible to include an image in the header or
21499 Suppose you want to put a company logo in the upper lefthand corner.
21500 You might try something like
21503 \begin_layout Standard
21512 includegraphics{logo.eps}}}
21515 \begin_layout Standard
21517 (you may need to preface this with
21518 \begin_inset Flex Code
21521 \begin_layout Plain Layout
21524 usepackage{graphics}
21529 if you don't include graphics elsewhere in your document).
21532 \begin_layout Chapter
21534 and the World Wide Web
21537 \begin_layout Standard
21539 has long supported the export of documents to various web-friendly formats,
21541 Before version 2.0, however, HTML export was always accomplished by the
21542 use of external converters.
21546 \begin_layout Plain Layout
21547 For details on the use of external converters with \SpecialChar LyX
21552 section of the Customization manual.
21557 These fall into two large groups: there are converters that use \SpecialChar LaTeX
21559 intermediate format, such as
21560 \begin_inset Flex Code
21563 \begin_layout Plain Layout
21570 \begin_inset Flex Code
21573 \begin_layout Plain Layout
21580 \begin_inset Flex Code
21583 \begin_layout Plain Layout
21589 , relying upon \SpecialChar LyX
21590 to produce the \SpecialChar LaTeX
21591 ; and there is a converter that works directly
21592 on \SpecialChar LyX
21594 \begin_inset Flex Code
21597 \begin_layout Plain Layout
21605 All of these have different advantages and disadvantages.
21609 \begin_layout Standard
21610 The \SpecialChar LaTeX
21611 -based converters have the advantage that, in principle, they know everythin
21612 g about the exported document that \SpecialChar LaTeX
21614 Such converters do not care, for example, if a certain block of code was
21615 produced by \SpecialChar LyX
21616 or was Evil Red Text.
21617 These converters know about
21618 \begin_inset Flex Code
21621 \begin_layout Plain Layout
21627 files, counters, and references, and can often make use of the
21628 \begin_inset Flex Code
21631 \begin_layout Plain Layout
21637 files generated by Bib\SpecialChar TeX
21639 On the other hand, \SpecialChar LaTeX
21640 is a very hard language to parse—it is sometimes said
21641 that only \SpecialChar TeX
21642 itself understands \SpecialChar TeX
21643 —and \SpecialChar LaTeX
21644 -based converters will often choke on
21645 what seem to be quite simple constructs; complex ones can throw them completely
21646 , and as of this writing, for example, the
21650 manual will not export with
21651 \begin_inset Flex Code
21654 \begin_layout Plain Layout
21660 , though the others will.
21661 The other issue concerns how math is handled.
21662 These converters typically convert the formulae into little pictures that
21663 are then linked from the HTML document.
21664 Since these are actually generated by \SpecialChar LaTeX
21665 , they are accurate.
21666 But they do not scale well, and just getting them to look as if they are
21667 actually meant to be in your document—so that the font sizes seem to be
21668 roughly the same—can be a challenge.
21671 \begin_layout Standard
21673 \begin_inset Flex Code
21676 \begin_layout Plain Layout
21684 \begin_inset CommandInset href
21686 name "http://pinchito.es/elyxer/"
21687 target "http://pinchito.es/elyxer/"
21692 ) solves some of these problems.
21693 In particular, the formulae it produces scale perfectly, since it renders
21694 math using a combination of HTML and CSS rather than converting the formulae
21696 But even moderately complex formula are rendered less well than with
21697 \begin_inset Flex Code
21700 \begin_layout Plain Layout
21706 ; this reflects the limitations of HTML.
21710 \begin_layout Plain Layout
21712 \begin_inset Flex Code
21715 \begin_layout Plain Layout
21722 can also use jsMath and MathJax for equations, but this setting is only
21723 available globally and requires one to have access to a server that runs
21729 More importantly (as of version 1.1.1, at least),
21730 \begin_inset Flex Code
21733 \begin_layout Plain Layout
21740 has limited support for math macros and no support for user-defined paragraph
21741 or character styles.
21742 These limitations make
21743 \begin_inset Flex Code
21746 \begin_layout Plain Layout
21753 unsuitable for many of the documents \SpecialChar LyX
21755 In principle, of course, these problems could be solved, but the \SpecialChar LyX
21757 have decided to follow a different path and have made \SpecialChar LyX
21759 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
21760 , DocBook, and plaintext.
21763 \begin_layout Standard
21764 As of this writing, XHTML output remains under development and should probably
21766 \begin_inset Quotes eld
21770 \begin_inset Quotes erd
21777 \begin_layout Plain Layout
21779 \begin_inset Flex Code
21782 \begin_layout Plain Layout
21783 development/HTML/HTML.notes
21788 , which can be found in the \SpecialChar LyX
21790 \begin_inset CommandInset href
21792 name "accessed online"
21793 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
21798 , usually contains up-to-date information about the state of XHTML output.
21799 See also the list of XHTML bugs on
21800 \begin_inset CommandInset href
21802 name "the bug tracker"
21803 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"
21813 Still, the developers have chosen this approach because it has several
21814 potential advantages over the other two.
21817 \begin_layout Standard
21818 These advantages are primarily due to the fact that the XHTML output routines,
21819 since they are part of \SpecialChar LyX
21820 , know everything \SpecialChar LyX
21821 knows about the document being
21826 \begin_layout Plain Layout
21827 Another advantage is that, since these routines are internal to \SpecialChar LyX
21829 immune to changes in \SpecialChar LyX
21830 's file format, or to changes in the semantics of
21836 So they know about the table of contents (as displayed in the outline),
21837 about the counters associated with different paragraph styles, and about
21838 user-defined styles.
21839 The XHTML output routines know what \SpecialChar LyX
21840 knows about internationalization,
21841 too, so they will output
21842 \begin_inset Quotes eld
21846 \begin_inset Quotes erd
21850 \begin_inset Quotes eld
21858 \begin_inset Quotes erd
21861 , depending upon the language in effect at the time.
21865 \begin_layout Standard
21866 Quite generally, the output routines know what \SpecialChar LyX
21867 knows about document layout,
21868 that is, about how the document is to be rendered on screen.
21869 We use this information when we output the document as XHTML.
21870 In particular, \SpecialChar LyX
21875 generates CSS style information corresponding to the layout information
21876 it uses to render the document on screen: if section headings are supposed
21877 to be sans-serif and bold as seen in \SpecialChar LyX
21878 , then (by default) they will be sans-seri
21879 f and bold when viewed in a web browser, too.
21880 And this is true not just for pre-defined styles, like Section, but for
21881 any style, including user-defined styles.
21882 Indeed, the XHTML output routines make no distinction between user-defined
21884 \change_deleted 244031559 1603876931
21886 \change_inserted 244031559 1603876940
21889 styles and \SpecialChar LyX
21890 's own pre-defined styles: in each case, everything \SpecialChar LyX
21892 the styles is contained in the layout files.
21893 And much the same is true as regards pre-defined textual insets, such as
21894 footnotes, and various custom insets.
21898 \begin_layout Standard
21899 The result is that XHTML output can be customized and extended in exactly
21900 the same way \SpecialChar LaTeX
21901 output can be customized and extended: through layout files
21903 See chapter five of the
21907 manual for the details.
21910 \begin_layout Standard
21911 The remainder of this chapter contains more detailed information on XHTML
21912 output, its limitations, and ways to work around those limitations.
21915 \begin_layout Section
21916 Math Output in XHTML
21919 \begin_layout Standard
21921 offers four choices for how math is rendered.
21922 These have various advantages and disadvantages:
21925 \begin_layout Itemize
21927 \begin_inset Newline newline
21930 MathML is a dialect of XML designed specifically for mathematics on the
21931 web, and it typically renders very well in browsers that support it.
21932 The disadvantage is that not all browsers support MathML, and support is
21933 not complete even in the Gecko-based browsers, such as Firefox.
21934 \begin_inset Newline newline
21937 If \SpecialChar LyX
21938 is unable to render a formula as MathML—for example, if the formula
21940 \begin_inset Flex Code
21943 \begin_layout Plain Layout
21949 package or ERT—then it will instead output the formula as an image.
21953 \begin_layout Itemize
21955 \begin_inset Newline newline
21958 As mentioned above,
21959 \begin_inset Flex Code
21962 \begin_layout Plain Layout
21968 outputs math as HTML, styled by CSS.
21972 \begin_layout Plain Layout
21974 has borrowed some of the CSS for its HTML output from
21975 \begin_inset Flex Code
21978 \begin_layout Plain Layout
21989 For simple formulae, this can work quite well, though with more complicated
21990 formulae it tends to break down.
21991 Still, this method has the advantage that it is very widely supported and
21992 so it may be appropriate for documents that contain only a little, fairly
21994 \begin_inset Newline newline
21997 If Lyx is unable to render a formula as HTML—for example, if the formula
21999 \begin_inset Flex Code
22002 \begin_layout Plain Layout
22008 package or ERT—then it will instead output the formula as an image.
22012 \begin_layout Itemize
22014 \begin_inset Newline newline
22018 \begin_inset Flex Code
22021 \begin_layout Plain Layout
22028 will output formulae as images, the very same images, in fact, that are
22029 used for instant preview.
22033 \begin_layout Plain Layout
22034 Instant preview does
22038 have to be on for images to be output, however.
22043 The advantage to this method is that the images are simply generated by
22045 , so they are very accurate.
22046 The disadvantage, as mentioned earlier, is that these are bitmapped images,
22047 so they do not scale terribly well, and one cannot copy them, etc.
22048 \begin_inset Newline newline
22051 The size of the images can be controlled by setting the
22052 \begin_inset Quotes eld
22055 Math Images Scaling
22056 \begin_inset Quotes erd
22060 \begin_inset Flex Noun
22063 \begin_layout Plain Layout
22064 Document\SpecialChar menuseparator
22065 Settings\SpecialChar menuseparator
22075 \begin_layout Plain Layout
22076 For those who want to know, this controls the resolution of the image in
22077 dots per inch and is based upon a default of 75 dpi.
22083 \begin_inset Newline newline
22086 If \SpecialChar LyX
22087 for some reason fails to create an image for a formula (e.g., if a required
22089 package is not installed), then it will fall back to outputing the raw
22094 \begin_layout Itemize
22097 \begin_inset Newline newline
22100 Finally, \SpecialChar LyX
22101 will happily output math as \SpecialChar LaTeX
22103 As well as being the output of last resort, this method can be used with
22105 \begin_inset CommandInset href
22108 target "http://www.math.union.edu/~dpvc/jsMath/"
22113 , which uses JavaScript to render \SpecialChar LaTeX
22114 embedded in HTML documents.
22116 wraps the \SpecialChar LaTeX
22118 \begin_inset Flex Code
22121 \begin_layout Plain Layout
22127 (for inline formulas) or
22128 \begin_inset Flex Code
22131 \begin_layout Plain Layout
22137 (for displayed formulas) with
22138 \begin_inset Flex Code
22141 \begin_layout Plain Layout
22147 , as is required for jsMath.
22150 \begin_layout Standard
22151 One of these output methods must be selected under
22152 \begin_inset Flex Noun
22155 \begin_layout Plain Layout
22156 Document\SpecialChar menuseparator
22157 Settings\SpecialChar menuseparator
22164 By default, \SpecialChar LyX
22166 This is a document-wide setting, therefore.
22169 \begin_layout Standard
22170 Eventually, \SpecialChar LyX
22171 will offer the user the option to select an alternate output
22172 method for a particular inset, say, one that isn't being rendered very
22177 \begin_layout Plain Layout
22178 That said, since \SpecialChar LyX
22179 falls back to images if the inset contains ERT, then one
22180 can force output as an image by putting some harmless ERT into the math,
22182 \begin_inset Formula $a=b\relax$
22193 \begin_layout Section
22194 Bibliography and Citations
22197 \begin_layout Standard
22198 XHTML output fully supports bibliographies and citations.
22202 \begin_layout Standard
22203 Citation labels are generated by the same machinery that generates \SpecialChar LyX
22205 labels, so the labels will look in the output much as they do in \SpecialChar LyX
22208 If you are using numerical citations, then \SpecialChar LyX
22209 will output numerical labels,
22210 such as [1] or [17], rather than simply showing the citation key in square
22211 brackets, as it does on-screen.
22212 If you are using author-year citations, then \SpecialChar LyX
22213 will add lowercase letters
22214 to the years, just as Bib\SpecialChar TeX
22215 does, if it finds more than one citation for
22216 a given author-year combination.
22217 The labels will be printed with the bibliography entries.
22218 Note that there is, at present, no way to customize the appearance of the
22219 labels, for example, to choose between square brackets and parentheses.
22222 \begin_layout Standard
22223 Bibliography output is handled by the same machinery that handles the presentati
22224 on of reference information in the citation dialog, so you will see in the
22225 XHTML output pretty much what you would see if you were to look at a given
22226 entry in the citation dialog.
22227 The formatting can be customized in your layout file or, preferably, in
22233 manual for the details.
22236 \begin_layout Standard
22237 The main defect at present is that cross-referenced information is printed
22238 with every entry with which it is associated.
22239 So you can see things like this:
22242 \begin_layout Quote
22244 \begin_inset Quotes eld
22247 Context and Logical Form
22248 \begin_inset Quotes erd
22253 Language in Context: Selected Essays
22255 (Oxford: Oxford University Press, 2007), pp.
22259 \begin_layout Quote
22261 \begin_inset Quotes eld
22264 Semantics in Context
22265 \begin_inset Quotes erd
22270 Language in Context: Selected Essays
22272 (Oxford: Oxford University Press, 2007), pp.
22276 \begin_layout Standard
22277 This should be fixed before long.
22280 \begin_layout Standard
22281 There is no support at present for sectioned bibliographies.
22282 If you have multiple bibliographies, then \SpecialChar LyX
22283 will print the same bibliography
22287 \begin_layout Section
22291 \begin_layout Standard
22293 will happily export indexes as XHTML, but with certain limitations at the
22297 \begin_layout Standard
22298 Index export will be most reliable when you do not attempt to use the fancy
22299 constructs that are described in the section on indexes in the
22307 \begin_layout Plain Layout
22308 The main issue here is that \SpecialChar LyX
22309 itself does not really handle these.
22310 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
22316 We'll describe how they are handled using the subsection headings from
22320 \begin_layout Itemize
22321 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
22322 makes an effort to support these,
22323 but the entries must be separated by
22324 \begin_inset Quotes eld
22328 \begin_inset Quotes erd
22331 , that is, there must be spaces around the exclamation point.
22332 This is because it is otherwise too difficult to check for escaped exclamation
22333 points, ones in math, and so forth.
22336 \begin_layout Itemize
22337 Page Ranges: There is no support at all for page ranges, since these make
22338 no sense with XHMTL.
22339 Instead, you will just get two index entries, one at either end.
22342 \begin_layout Itemize
22343 Cross-referencing: There is no support for cross-referencing.
22344 If \SpecialChar LyX
22345 finds an entry containing the
22346 \begin_inset Quotes eld
22349 |see\SpecialChar ldots
22351 \begin_inset Quotes erd
22354 construct, it is just dropped, and the rest is treated as an ordinary index
22358 \begin_layout Itemize
22359 Index Entry Order: \SpecialChar LyX
22360 does support attempts to fix the sorting order.
22361 It will take what is before the first `@' it finds and use that for sorting,
22362 taking what follows the first `@' to be the actual entry.
22363 At present, \SpecialChar LyX
22364 does not check for escaped `@', so do not try to index email
22368 \begin_layout Itemize
22369 Index Entry Layout: You can format entries by using the text style dialog,
22370 or by using any other method available within \SpecialChar LyX
22372 There is no support for constructs like:
22373 \begin_inset Quotes eld
22377 \begin_inset Quotes erd
22381 Indeed, if \SpecialChar LyX
22382 finds a pipe symbol, `|', in an entry, it will delete it and
22383 everything that follows it.
22386 \begin_layout Itemize
22387 Multiple Indexes: There is no support for multiple indexes.
22388 Rather, all index entries will be printed as one large index.
22389 To avoid our printing several versions of the index, we print only the
22390 main index, so make sure you have one.
22393 \begin_layout Section
22394 Nomenclature and Glossary
22397 \begin_layout Standard
22398 There is at present no support for glossaries.
22399 Adding it would be fairly trivial, and welcome.
22402 \begin_layout Chapter
22404 \change_inserted 1075283030 1616534180
22408 \begin_layout Standard
22410 \change_inserted 1075283030 1616534386
22411 Apart from HTML, \SpecialChar LyX
22412 can generate documents in the DocBook XML vocabulary.
22413 With versions 2.3 and before, only select templates could be used to generate
22414 DocBook documents (only version 4).
22415 Starting with \SpecialChar LyX
22416 2.4, most \SpecialChar LyX
22417 layouts can generate valid DocBook documents (only
22419 This feature is built into \SpecialChar LyX
22420 and does not require the use of external tools.
22423 \begin_layout Standard
22425 \change_inserted 1075283030 1616534437
22426 The result is that the DocBook output can be customized and extended in
22427 exactly the same way \SpecialChar LaTeX
22428 output can be customized and extended: through layout
22430 See chapter five of the
22434 manual for the details.
22437 \begin_layout Standard
22439 \change_inserted 1075283030 1616534475
22440 Most \SpecialChar LyX
22441 features are supported with DocBook, like math output.
22444 \begin_layout Itemize
22446 \change_inserted 1075283030 1616534741
22447 Math output is performed mostly in MathML (the major exception being constructio
22448 ns not supported by \SpecialChar LyX
22451 All formulae are also available in raw \SpecialChar TeX
22452 in the DocBook output for further
22456 \begin_layout Itemize
22458 \change_inserted 1075283030 1616534852
22459 Bibliographies and citations are implemented, including with an external
22461 Bibliography entries are not prerendered when the detailed information
22462 are available, but rather output with the standard DocBook constructs.
22463 The external DocBook processor is expected to handle the rendering of entries.
22466 \begin_layout Itemize
22468 \change_inserted 1075283030 1616534863
22469 Indexes are supported, including multiple indices.
22474 ), page ranges, and cross-references (
22478 ) are supported, with the exception of the same symbols escaped.
22487 ) are not supported.
22488 There is no support for escaping of index entries.
22491 \begin_layout Itemize
22493 \change_inserted 1075283030 1616534884
22494 Glossaries are implemented.
22497 \begin_layout Standard
22499 \change_inserted 1075283030 1616534894
22500 Two major parameters can be set at the document level.
22503 \begin_layout Itemize
22505 \change_inserted 1075283030 1616534948
22506 Format for tables: \SpecialChar LyX
22507 can generate tables either as HTML (default value) or
22508 CALS, depending on the user's requirements.
22509 Most DocBook processors accept both formats.
22512 \begin_layout Itemize
22514 \change_inserted 1075283030 1616535006
22515 MathML prefix: in DocBook, MathML is included within its own name space,
22517 The implication is that there must be an indication of the tags belonging
22518 to the MathML standard.
22519 Three choices are offered:
22523 \begin_layout Itemize
22525 \change_inserted 1075283030 1616535044
22526 Inline: the MathML name space is defined for each formula (using the
22530 attribute on each formula)
22533 \begin_layout Itemize
22535 \change_inserted 1075283030 1616535090
22540 prefix (default): the MathML name space is defined at the document level
22545 attribute on the root element).
22546 Each MathML is prefixed with
22555 \begin_layout Itemize
22557 \change_inserted 1075283030 1616620405
22562 prefix: similar to the
22571 \begin_layout Standard
22573 \change_inserted 1075283030 1616620470
22574 This option is especially useful if you want \SpecialChar LyX
22575 to match your personal style
22576 or to work with buggy software that only accepts one prefix for MathML.
22582 \begin_layout Chapter
22583 The \SpecialChar LyX
22587 \begin_layout Section
22591 \begin_layout Standard
22592 The `\SpecialChar LyX
22593 server' allows other programs to talk to \SpecialChar LyX
22594 , invoke \SpecialChar LyX
22595 commands, and retrieve
22596 information about the \SpecialChar LyX
22598 This is only intended for advanced users, but they should find it useful.
22599 It is by writing to the \SpecialChar LyX
22600 server, for example, that bibliography managers,
22601 such as JabRef, are able to
22602 \begin_inset Quotes eld
22606 \begin_inset Quotes erd
22609 citations to \SpecialChar LyX
22613 \begin_layout Section
22614 Starting the \SpecialChar LyX
22616 \begin_inset CommandInset label
22618 name "sec:Starting-the-Server"
22625 \begin_layout Standard
22626 The \SpecialChar LyX
22627 server works through the use of a pair of named pipes.
22628 These are usually located in
22629 \begin_inset Flex Code
22632 \begin_layout Plain Layout
22638 , (except on Windows, where
22642 named pipes are special objects located in
22643 \begin_inset Flex Code
22646 \begin_layout Plain Layout
22658 ) and have the names
22659 \begin_inset Quotes eld
22663 \begin_inset Flex Code
22666 \begin_layout Plain Layout
22673 \begin_inset Quotes erd
22677 \begin_inset Quotes eld
22681 \begin_inset Flex Code
22684 \begin_layout Plain Layout
22691 \begin_inset Quotes erd
22695 External programs write into
22696 \begin_inset Flex Code
22699 \begin_layout Plain Layout
22705 and read back data from
22706 \begin_inset Flex Code
22709 \begin_layout Plain Layout
22716 The stem of the pipe names can be defined in the
22717 \begin_inset Flex Noun
22720 \begin_layout Plain Layout
22721 Tools\SpecialChar menuseparator
22727 dialog, for example
22728 \begin_inset Flex Code
22731 \begin_layout Plain Layout
22732 "/home/myhome/lyxpipe"
22738 \begin_inset Flex Code
22741 \begin_layout Plain Layout
22755 on Windows (where any working path instead of lyxpipe can be used, for
22757 \begin_inset Flex Code
22760 \begin_layout Plain Layout
22783 configure this manually in order for the server to start.
22786 \begin_layout Standard
22789 \begin_inset Flex Code
22792 \begin_layout Plain Layout
22799 \begin_inset Flex Code
22802 \begin_layout Plain Layout
22808 ' to create the pipes.
22809 If one of the pipes already exists, \SpecialChar LyX
22810 will assume that another \SpecialChar LyX
22812 is already running and will not start the server.
22813 On POSIX (Unix like) systems, if for some other reason, an unused
22814 \begin_inset Quotes eld
22818 \begin_inset Quotes erd
22821 pipe is left in existence when \SpecialChar LyX
22822 closes, then \SpecialChar LyX
22823 will try to delete it.
22824 If this fails for some reason, you will need to delete the pipes manually
22825 and then restart \SpecialChar LyX
22827 On Windows, pipes are deleted by the OS on program termination or crash,
22829 \begin_inset Quotes eld
22833 \begin_inset Quotes erd
22836 pipes should not be possible.
22839 \begin_layout Standard
22840 To have several \SpecialChar LyX
22841 processes with servers at the same time, you have to use
22842 different configurations, perhaps by using separate user directories, each
22844 \begin_inset Flex Code
22847 \begin_layout Plain Layout
22853 file, for each process.
22856 \begin_layout Standard
22857 If you are developing a client program, you might find it useful to enable
22858 debugging information from the \SpecialChar LyX
22860 Do this by starting \SpecialChar LyX
22862 \begin_inset Flex Code
22865 \begin_layout Plain Layout
22874 \begin_layout Standard
22875 You can find a complete example client written in C++ in the source distribution
22877 \begin_inset Flex Code
22880 \begin_layout Plain Layout
22881 development/lyxserver/server_monitor.cpp
22889 \begin_layout Standard
22890 Another useful tool is the command-line based client found in
22891 \begin_inset Flex Code
22894 \begin_layout Plain Layout
22895 src/client/lyxclient
22903 \begin_layout Section
22904 Normal communication
22907 \begin_layout Standard
22908 To issue a \SpecialChar LyX
22909 call, the client writes a line of ASCII text into the input
22911 This line has the following format:
22914 \begin_layout Quote
22928 \begin_layout Description
22929 clientname is a name that the client can choose arbitrarily.
22930 Its only use is that \SpecialChar LyX
22931 will echo it if it sends an answer—so a client can
22932 dispatch results from different requesters.
22935 \begin_layout Description
22936 function is the function you want \SpecialChar LyX
22938 It is the same as the commands you'd use in the minibuffer.
22941 \begin_layout Description
22942 argument is an optional argument which is meaningful only to some functions
22944 \begin_inset Quotes eld
22948 \begin_inset Quotes erd
22951 LFUN will insert the argument as text at the cursor position).
22954 \begin_layout Standard
22955 The answer from \SpecialChar LyX
22956 will arrive in the output pipe and be of the form
22959 \begin_layout Quote
22973 \begin_layout Standard
22982 are just echoed from the command request, while
22986 is more or less useful information filled according to how the command
22987 execution worked out.
22988 Some commands, such as
22989 \begin_inset Quotes eld
22993 \begin_inset Quotes erd
22996 , will return information about the internal state of \SpecialChar LyX
22998 return an empty data-response.
22999 This means that the command execution went fine.
23002 \begin_layout Standard
23003 In case of errors, the response from \SpecialChar LyX
23004 will have this form
23007 \begin_layout Quote
23021 \begin_layout Standard
23026 should contain an explanation of why the command failed.
23029 \begin_layout Standard
23033 \begin_layout LyX-Code
23034 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
23035 \begin_inset Newline newline
23038 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
23039 \begin_inset Newline newline
23042 read a <~/.lyxpipe.out
23043 \begin_inset Newline newline
23049 \begin_layout Subsection
23050 AppleScript (Mac OS X)
23053 \begin_layout Standard
23054 Since \SpecialChar LyX
23055 2.1, \SpecialChar LyX
23056 supports basic interactions with AppleScript for normal communicatio
23057 n through the command run.
23058 This command takes a direct argument (the
23062 to perform) and an optional argument.
23063 It either returns the output of the function or triggers an error with
23064 the error message and code.
23067 \begin_layout Standard
23071 \begin_layout LyX-Code
23072 tell application "\SpecialChar LyX
23076 \begin_layout LyX-Code
23080 \begin_layout LyX-Code
23081 -- Stores the current file name into f
23084 \begin_layout LyX-Code
23085 set f to (run "server-get-filename" with argument "")
23088 \begin_layout LyX-Code
23089 on error the error_message number the error_number
23092 \begin_layout LyX-Code
23093 display dialog "Error: " & the error_number & ".
23097 \begin_layout LyX-Code
23098 & the error_message buttons {"OK"} default button 1
23101 \begin_layout LyX-Code
23105 \begin_layout LyX-Code
23109 \begin_layout Section
23113 \begin_layout Standard
23115 can notify clients of events going on asynchronously.
23116 Currently it will only do this if the user binds a key sequence with the
23118 \begin_inset Quotes eld
23122 \begin_inset Quotes erd
23126 The format of the string \SpecialChar LyX
23127 sends is as follows:
23130 \begin_layout Quote
23131 \begin_inset Flex Code
23134 \begin_layout Plain Layout
23145 \begin_layout Standard
23150 is the printed representation of the key sequence that was actually typed
23154 \begin_layout Standard
23155 This mechanism can be used to extend \SpecialChar LyX
23156 's command set and implement macros.
23157 Bind some key sequence to
23158 \begin_inset Quotes eld
23162 \begin_inset Quotes erd
23166 Then start a client that listens on the output pipe, dispatches the command
23167 according to the sequence, and starts a function that may use \SpecialChar LyX
23170 requests to issue a command or a series of commands to \SpecialChar LyX
23174 \begin_layout Section
23175 The simple \SpecialChar LyX
23179 \begin_layout Standard
23181 implements a simple protocol that can be used for session management.
23182 All messages are of the form
23185 \begin_layout Quote
23195 \begin_layout Standard
23201 \begin_inset Quotes eld
23205 \begin_inset Quotes erd
23209 \begin_inset Quotes eld
23213 \begin_inset Quotes erd
23218 \begin_inset Quotes eld
23222 \begin_inset Quotes erd
23225 is received from a client, \SpecialChar LyX
23226 will report back to inform the client that
23227 it's listening to it's messages, while
23228 \begin_inset Quotes eld
23232 \begin_inset Quotes erd
23235 sent from \SpecialChar LyX
23236 will inform clients that \SpecialChar LyX
23240 \begin_layout Section
23241 Reverse DVI/PDF search
23244 \begin_layout Standard
23245 Some DVI/PDF viewers
23249 \begin_layout Plain Layout
23250 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
23251 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
23260 facility (also called
23265 This means that you can tell \SpecialChar LyX
23266 to put the cursor to a specific line in the
23267 document by clicking at the respective position in the DVI/PDF output.
23268 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
23270 This is done via the \SpecialChar LyX
23271 server either by using the named pipe (
23275 ), or the UNIX domain socket (
23279 ) that \SpecialChar LyX
23280 creates in its temporary directory (this is the way the
23281 \begin_inset Flex Code
23284 \begin_layout Plain Layout
23290 program communicates with \SpecialChar LyX
23292 In some cases, you need a helper script that mediates between the viewer
23293 and \SpecialChar LyX
23294 , in others, the viewer can communicate with \SpecialChar LyX
23296 This depends on the selected viewer and on your operating system.
23297 The same applies to the way viewers need to be configured and the way the
23298 reverse search is actually performed.
23299 In what follows, we will thus describe how to setup reverse search for
23301 Before we turn to this, though, we will explain what needs to be done generally
23302 to enable reverse search in the DVI/PDF output.
23305 \begin_layout Subsection
23307 \begin_inset CommandInset label
23309 name "subsec:rev-search"
23316 \begin_layout Standard
23317 In most cases \SpecialChar LyX
23318 will do the work for you by pressing the following button
23322 arg "buffer-toggle-output-sync"
23326 Alternatively, you can also enable the feature by checking
23328 Synchronize with Output
23331 \begin_inset Flex Noun
23334 \begin_layout Plain Layout
23335 Document\SpecialChar menuseparator
23336 Settings\SpecialChar menuseparator
23343 In such a case \SpecialChar LyX
23344 will automatically insert the necessary Sync\SpecialChar TeX
23346 PDF) or load the srcltx package (for DVI) respectively.
23347 This option can be easily reached also on
23348 \begin_inset Flex Code
23351 \begin_layout Plain Layout
23360 \begin_layout Standard
23361 If you need a different setting, you can select or input a custom macro
23362 from the drop down box just below
23363 \begin_inset Flex Noun
23366 \begin_layout Plain Layout
23367 Document\SpecialChar menuseparator
23368 Settings\SpecialChar menuseparator
23369 Output\SpecialChar menuseparator
23370 Synchronize with Output
23378 \begin_layout Standard
23379 Note that the method
23380 \begin_inset Flex Code
23383 \begin_layout Plain Layout
23391 enables gzip compression.
23392 If your viewer does not support it, you should instead use
23393 \begin_inset Flex Code
23396 \begin_layout Plain Layout
23407 \begin_layout Standard
23408 Please also note that including the
23409 \begin_inset Flex Code
23412 \begin_layout Plain Layout
23419 \begin_inset Flex Code
23422 \begin_layout Plain Layout
23428 sometimes has an undesired impact on the typesetting.
23429 Thus, you should switch output synchronization off for the final typesetting
23431 \begin_inset Flex Code
23434 \begin_layout Plain Layout
23441 \begin_inset Flex Code
23444 \begin_layout Plain Layout
23454 \begin_layout Standard
23455 In case you need some more special settings that are not covered by the
23456 automatic settings, read the next section about how to set up output synchroniz
23458 If the automatic setup suits your needs, you can readily jump to section
23459 \begin_inset space ~
23463 \begin_inset CommandInset ref
23465 reference "subsec:configuring-viewers"
23469 , where the necessary configuration steps in your viewer – needed both with
23470 the automatic and the manual setup – are described.
23473 \begin_layout Subsection
23477 \begin_layout Standard
23479 provides several different methods for reverse search.
23480 Some are built-in in the
23481 \begin_inset Flex Code
23484 \begin_layout Plain Layout
23490 program, some are provided by external packages.
23491 Your choice depends on whether your \SpecialChar LaTeX
23492 distribution already provides a given
23493 method (the built-in methods are rather new) and whether your viewer can
23495 The available methods are described in the following.
23498 \begin_layout Subsubsection*
23499 Built-in DVI-search via src-specials (DVI only)
23502 \begin_layout Standard
23503 This method provides the DVI file with the necessary information for reverse
23505 It is available in \SpecialChar LaTeX
23506 since quite some time (any somewhat recent \SpecialChar LaTeX
23508 should include it), and it works reliably.
23509 To enable it, change the
23510 \begin_inset Flex Noun
23513 \begin_layout Plain Layout
23524 \begin_inset Flex Noun
23527 \begin_layout Plain Layout
23538 \begin_inset Flex Noun
23541 \begin_layout Plain Layout
23542 Preferences\SpecialChar menuseparator
23543 File Handling\SpecialChar menuseparator
23550 \begin_inset Flex Code
23553 \begin_layout Plain Layout
23554 latex -src-specials $$i
23560 If this doesn't work, check if your \SpecialChar TeX
23561 engine needs different options (the
23562 syntax might differ in some distributions).
23565 \begin_layout Subsubsection*
23566 External Packages (PDFSync and scrltx)
23569 \begin_layout Standard
23578 provide reverse search facility for PDF output (via pdflatex) and DVI output,
23580 In order to enable it, load the packages in the \SpecialChar LyX
23584 \begin_layout Itemize
23585 \begin_inset Flex Code
23588 \begin_layout Plain Layout
23591 usepackage{pdfsync}
23596 for reverse PDF search,
23599 \begin_layout Itemize
23600 \begin_inset Flex Code
23603 \begin_layout Plain Layout
23606 usepackage[active]{srcltx}
23611 for reverse DVI search.
23614 \begin_layout Standard
23615 If you want to be able to perform both DVI and PDF reverse searches, you
23616 can also insert in the preamble the following lines
23619 \begin_layout LyX-Code
23623 \begin_inset Newline newline
23629 \begin_inset Newline newline
23634 usepackage{pdfsync}
23635 \begin_inset Newline newline
23641 \begin_inset Newline newline
23646 usepackage[active]{srcltx}
23647 \begin_inset Newline newline
23655 \begin_layout Standard
23656 This way, you can preview the file as either DVI or PDF (pdflatex) and the
23657 right package will be used.
23660 \begin_layout Standard
23661 Note that PDFSync might affect the output layout of your document.
23662 It is therefore advised to disable PDFsync for final documents.
23665 \begin_layout Subsubsection*
23666 Built-in reverse search via Sync\SpecialChar TeX
23670 \begin_layout Standard
23672 \begin_inset Flex Code
23675 \begin_layout Plain Layout
23681 have built-in support for both PDF and DVI reverse search.
23684 Sync\SpecialChar TeX
23687 facility is basically the result of the integration of the PDFSync package
23688 to the pdftex program and its merge with the
23693 You need at least \SpecialChar TeX
23694 Live 2008 or a recent Mik\SpecialChar TeX
23695 distribution in order to use
23700 \begin_layout Plain Layout
23701 For some reason, Mik\SpecialChar TeX
23702 does not understand/obey the command \SpecialChar LyX
23704 the preamble when you check the "Enable Forward/Reverse Search" button
23705 in the toolbar and does not generate the necessary info.
23708 \begin_layout Plain Layout
23709 The generation of the required info can be forced by changing the converter
23710 "\SpecialChar LaTeX
23711 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
23712 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
23713 the -synctex=1 switch).
23718 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
23719 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
23720 already provide Sync\SpecialChar TeX
23724 \begin_layout Standard
23725 To enable Sync\SpecialChar TeX
23726 for DVI output, change the
23727 \begin_inset Flex Noun
23730 \begin_layout Plain Layout
23741 \begin_inset Flex Noun
23744 \begin_layout Plain Layout
23749 (plain) -> DraftDVI
23755 \begin_inset Flex Noun
23758 \begin_layout Plain Layout
23759 Preferences\SpecialChar menuseparator
23760 File Handling\SpecialChar menuseparator
23767 \begin_inset Flex Code
23770 \begin_layout Plain Layout
23771 latex -synctex=1 $$i
23776 , and for PDF output, change the
23777 \begin_inset Flex Noun
23780 \begin_layout Plain Layout
23785 (pdflatex) -> PDF (pdflatex)
23791 \begin_inset Flex Code
23794 \begin_layout Plain Layout
23795 pdflatex -synctex=1 $$i
23801 Should your viewer not be considered in the following description, or in
23802 case of missing success, please check the documentation of your viewer
23803 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
23808 \begin_layout Plain Layout
23809 Note that the option
23810 \begin_inset Flex Code
23813 \begin_layout Plain Layout
23819 option enables gzip compression.
23820 If your viewer does not support it, you should instead use
23821 \begin_inset Flex Code
23824 \begin_layout Plain Layout
23838 \begin_layout Subsection
23839 Configuring and using specific viewers
23840 \begin_inset CommandInset label
23842 name "subsec:configuring-viewers"
23849 \begin_layout Subsubsection*
23850 Xdvi (all platforms)
23853 \begin_layout Standard
23855 \begin_inset Flex Code
23858 \begin_layout Plain Layout
23864 , you don't need to do anything else for performing a reverse DVI search,
23865 as \SpecialChar LyX
23866 already provides the necessary hooks for automatically using the
23867 \begin_inset Flex Code
23870 \begin_layout Plain Layout
23877 Just setup your document as described above (reverse search is triggered
23878 by Ctrl-click or Alt-click on Mac OSX, respectively).
23881 \begin_layout Standard
23882 However, if for whatever reason you want to use the named pipe instead of
23883 the socket for communicating with \SpecialChar LyX
23884 , simply change the DVI viewer in
23885 \begin_inset Flex Noun
23888 \begin_layout Plain Layout
23889 Preferences\SpecialChar menuseparator
23890 File Handling\SpecialChar menuseparator
23900 \begin_layout Plain Layout
23901 On Mac OSX you have to use
23902 \begin_inset Flex Code
23905 \begin_layout Plain Layout
23906 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
23917 \begin_inset Flex Code
23920 \begin_layout Plain Layout
23921 xdvi -editor "lyxeditor.sh %f %l"
23927 \begin_inset Flex Code
23930 \begin_layout Plain Layout
23936 is a suitable script.
23937 For example, a minimal shell script is the following one:
23940 \begin_layout LyX-Code
23942 \begin_inset Newline newline
23945 LYXPIPE="/path/to/lyxpipe"
23946 \begin_inset Newline newline
23949 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
23950 \begin_inset Newline newline
23953 echo "$COMMAND" > "${LYXPIPE}".in || exit
23954 \begin_inset Newline newline
23957 read TMP < "${LYXPIPE}".out || exit
23960 \begin_layout Standard
23962 \begin_inset Flex Code
23965 \begin_layout Plain Layout
23971 is the LyXServer pipe path specified in
23972 \begin_inset Flex Noun
23975 \begin_layout Plain Layout
23976 Preferences\SpecialChar menuseparator
23986 \begin_layout Plain Layout
23988 \begin_inset Flex Code
23991 \begin_layout Plain Layout
23997 folder of a source distribution you can find a
23998 \begin_inset Flex Code
24001 \begin_layout Plain Layout
24007 script which is able to locate the
24011 based on your preferences.
24019 \begin_layout Subsubsection*
24023 \begin_layout Standard
24025 \begin_inset Flex Code
24028 \begin_layout Plain Layout
24029 /Applications/MacDviX_Folder/calleditor.script
24034 , add the following lines:
24037 \begin_layout LyX-Code
24038 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
24039 \begin_inset Newline newline
24045 \begin_layout Standard
24046 Modify the lines accordingly if you install \SpecialChar LyX
24047 somewhere else than in the
24048 Applications folder.
24051 \begin_layout Standard
24052 Reverse search is triggered by Alt-click (OPTION-click).
24055 \begin_layout Subsubsection*
24059 \begin_layout Standard
24061 \begin_inset Flex Code
24064 \begin_layout Plain Layout
24065 open -a Skim.app $$i
24070 to the viewer setting in
24071 \begin_inset Flex Noun
24074 \begin_layout Plain Layout
24075 Preferences\SpecialChar menuseparator
24076 File Handling\SpecialChar menuseparator
24077 File formats\SpecialChar menuseparator
24084 \begin_inset Flex Noun
24087 \begin_layout Plain Layout
24088 Skim\SpecialChar menuseparator
24089 Preferences\SpecialChar menuseparator
24096 \begin_inset Flex Noun
24099 \begin_layout Plain Layout
24105 preset and enter command
24106 \begin_inset Flex Noun
24109 \begin_layout Plain Layout
24110 /Applications/\SpecialChar LyX
24111 .app/Contents/MacOS/lyxeditor
24119 \begin_layout Standard
24120 Reverse search is triggered by COMMAND-SHIFT-click
24123 \begin_layout Subsubsection*
24127 \begin_layout Standard
24128 Reverse search with evince does not work out of the box, but it can be achieved
24129 by means of some third party helper scripts.
24131 \begin_inset CommandInset href
24133 target "https://wiki.lyx.org/LyX/SyncTeX"
24141 \begin_layout Subsubsection*
24145 \begin_layout Standard
24147 \begin_inset Flex Noun
24150 \begin_layout Plain Layout
24151 Settings\SpecialChar menuseparator
24152 Configure Okular\SpecialChar menuseparator
24159 \begin_inset Quotes erd
24163 This inserts the appropriate command (
24164 \begin_inset Flex Code
24167 \begin_layout Plain Layout
24176 \begin_layout Standard
24177 Reverse search is triggered by SHIFT-click.
24179 \change_inserted -712698321 1578211026
24180 Note that this only works if Okular is in
24181 \begin_inset Quotes eld
24185 \begin_inset Quotes erd
24189 \begin_inset space \thinspace{}
24192 e., the hand symbol is clicked).
24197 \begin_layout Subsubsection*
24201 \begin_layout Standard
24202 Qpdfview supports Sync\SpecialChar TeX
24203 since version 0.3.5.
24205 \begin_inset Flex Noun
24208 \begin_layout Plain Layout
24209 Edit\SpecialChar menuseparator
24210 Settings\SpecialChar menuseparator
24216 , click on the input field of the
24217 \begin_inset Quotes eld
24221 \begin_inset Quotes erd
24224 item and add the command
24225 \begin_inset Flex Code
24228 \begin_layout Plain Layout
24237 \begin_layout Standard
24238 Reverse search is triggered by double-click or, in more recent versions,
24242 \begin_layout Subsubsection*
24246 \begin_layout Standard
24247 Launch yap, choose its
24248 \begin_inset Flex Noun
24251 \begin_layout Plain Layout
24252 View\SpecialChar menuseparator
24258 menu and select the
24259 \begin_inset Quotes eld
24263 \begin_inset Quotes erd
24268 \begin_inset Quotes eld
24271 New\SpecialChar ldots
24273 \begin_inset Quotes erd
24276 button and, in the window that opens, enter
24277 \begin_inset Quotes eld
24282 \begin_inset Quotes erd
24285 (or any other name you like) in the
24286 \begin_inset Quotes eld
24290 \begin_inset Quotes erd
24294 Now click on the button labeled
24295 \begin_inset Quotes eld
24300 \begin_inset Quotes erd
24303 to open a file dialog and navigate to the directory containing the batch
24305 \begin_inset Flex Code
24308 \begin_layout Plain Layout
24316 \begin_inset Flex Code
24319 \begin_layout Plain Layout
24325 and then specify the program arguments as
24326 \begin_inset Flex Code
24329 \begin_layout Plain Layout
24337 \begin_inset Flex Code
24340 \begin_layout Plain Layout
24346 wrapper is used for communicating with \SpecialChar LyX
24354 \begin_layout LyX-Code
24356 \begin_inset Newline newline
24359 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
24368 \begin_inset Newline newline
24382 \begin_layout Standard
24383 Make sure that the \SpecialChar LyX
24384 Server pipe path you specified in \SpecialChar LyX
24386 \begin_inset Flex Code
24389 \begin_layout Plain Layout
24403 , otherwise change the
24404 \begin_inset Flex Code
24407 \begin_layout Plain Layout
24413 wrapper accordingly.
24416 \begin_layout Standard
24417 In yap, reverse search is triggered by double-click.
24420 \begin_layout Subsubsection*
24421 SumatraPDF (Windows)
24424 \begin_layout Standard
24425 In order to use SumatraPDF for inverse search, enter
24426 \begin_inset Flex Code
24429 \begin_layout Plain Layout
24430 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
24435 in the viewer setting in
24436 \begin_inset Flex Noun
24439 \begin_layout Plain Layout
24440 Preferences\SpecialChar menuseparator
24441 File Handling\SpecialChar menuseparator
24442 File formats\SpecialChar menuseparator
24449 \begin_inset Flex Code
24452 \begin_layout Plain Layout
24458 is the previous wrapper.
24459 If SumatraPDF.exe is not in your command PATH, use its full file name.
24462 \begin_layout Standard
24463 Reverse search is triggered by double-click.
24466 \begin_layout Subsubsection*
24470 \begin_layout Standard
24471 First of all, make sure that yap is your default DVI viewer in the Windows
24472 environment, then launch it, choose its
24473 \begin_inset Flex Noun
24476 \begin_layout Plain Layout
24477 View\SpecialChar menuseparator
24483 menu and select the
24484 \begin_inset Quotes eld
24488 \begin_inset Quotes erd
24493 \begin_inset Quotes eld
24496 New\SpecialChar ldots
24498 \begin_inset Quotes erd
24501 button and, in the window that opens, enter
24502 \begin_inset Quotes eld
24507 \begin_inset Quotes erd
24510 (or any other name you like) in the
24511 \begin_inset Quotes eld
24515 \begin_inset Quotes erd
24519 Now click on the button labeled
24520 \begin_inset Quotes eld
24525 \begin_inset Quotes erd
24528 to open a file dialog and navigate to the directory containing the
24529 \begin_inset Flex Code
24532 \begin_layout Plain Layout
24538 program (which is installed by default on Cygwin along with the \SpecialChar LyX
24541 \begin_inset Flex Code
24544 \begin_layout Plain Layout
24550 and then specify the program arguments as
24551 \begin_inset Flex Code
24554 \begin_layout Plain Layout
24561 In this way, you will be using the
24565 for communicating with \SpecialChar LyX
24567 If, for whatever reason, you want to use the
24572 \begin_inset Flex Code
24575 \begin_layout Plain Layout
24581 option and be sure to specify the \SpecialChar LyX
24582 Server pipe path in the \SpecialChar LyX
24586 \begin_layout Standard
24587 In yap, reverse search is triggered by double-click.
24590 \begin_layout Subsubsection*
24591 SumatraPDF (Cygwin)
24594 \begin_layout Standard
24595 In order to use SumatraPDF for inverse search, enter
24596 \begin_inset Flex Code
24599 \begin_layout Plain Layout
24600 SumatraPDF -inverse-search "lyxeditor -g %f %l"
24605 in the viewer setting in
24606 \begin_inset Flex Noun
24609 \begin_layout Plain Layout
24610 Preferences\SpecialChar menuseparator
24611 File Handling\SpecialChar menuseparator
24612 File formats\SpecialChar menuseparator
24619 If SumatraPDF.exe is not in your command PATH, use its full posix path.
24621 \begin_inset Flex Code
24624 \begin_layout Plain Layout
24630 enables communication via the
24636 \begin_inset Flex Code
24639 \begin_layout Plain Layout
24645 option if you want to use the
24649 , and be sure to specify the \SpecialChar LyX
24650 Server pipe path in the \SpecialChar LyX
24654 \begin_layout Standard
24655 Reverse search is triggered by double-click.
24658 \begin_layout Section
24662 \begin_layout Standard
24663 Forward search is, as the name implies, in a sense the
24664 \begin_inset Quotes eld
24668 \begin_inset Quotes erd
24672 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
24674 If forward search is set up (as described in what follows), you can put
24675 the cursor anywhere in your \SpecialChar LyX
24677 \begin_inset Flex Noun
24680 \begin_layout Plain Layout
24681 Navigate\SpecialChar menuseparator
24688 \begin_inset Flex Noun
24691 \begin_layout Plain Layout
24697 in the context menu via right mouse click), and then the viewer will jump
24698 to that position as well.
24699 This implies, of course, that your viewer supports this function.
24702 \begin_layout Standard
24703 To make forward search possible, you first need to provide the generated
24704 output PDF/DVI file with additional information about the \SpecialChar TeX
24706 This can be done via the methods described in the section
24707 \begin_inset CommandInset ref
24709 reference "subsec:rev-search"
24716 \begin_layout Standard
24717 Additionally, you need to configure \SpecialChar LyX
24718 for using your viewers in
24719 \begin_inset Flex Noun
24722 \begin_layout Plain Layout
24723 Tools\SpecialChar menuseparator
24724 Preferences\SpecialChar menuseparator
24725 Output\SpecialChar menuseparator
24732 We provide a range of tested configurations for some viewers, which you
24733 can select from the drop down list.
24734 If none of these configurations suits you, you have to find out and enter
24735 a suitable configuration yourself.
24736 The definition syntax uses the following placeholders:
24739 \begin_layout Itemize
24741 \begin_inset Flex Code
24744 \begin_layout Plain Layout
24753 \begin_layout Itemize
24755 \begin_inset Flex Code
24758 \begin_layout Plain Layout
24764 : name of the (temporary) exported .tex file (without path)
24767 \begin_layout Itemize
24769 \begin_inset Flex Code
24772 \begin_layout Plain Layout
24778 : name of the (temporary) exported .tex file (including path)
24781 \begin_layout Itemize
24783 \begin_inset Flex Code
24786 \begin_layout Plain Layout
24792 : name of the exported output file (either dvi or pdf, depending on which
24793 one exists in the temporary directory)
24796 \begin_layout Standard
24797 Note that only some of the viewers provide full and usable forward search
24798 functionality out of the box, among them yap, xdvi, okular
24802 \begin_layout Plain Layout
24803 You might want to set
24804 \begin_inset Flex Code
24807 \begin_layout Plain Layout
24814 \begin_inset Flex Noun
24817 \begin_layout Plain Layout
24818 Tools\SpecialChar menuseparator
24819 Preferences\SpecialChar menuseparator
24820 File Handling\SpecialChar menuseparator
24822 \begin_inset space ~
24835 , qpdfview, and SumatraPDF
24839 \begin_layout Plain Layout
24840 SumatraPDF can also use DDE commands through the external program CMCDDE
24841 — downloadable from
24842 \begin_inset CommandInset href
24844 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
24855 Others, such as evince
24859 \begin_layout Plain Layout
24860 Forward search with evince can be achieved by means of third party helper
24863 \begin_inset CommandInset href
24865 target "https://wiki.lyx.org/LyX/SyncTeX"
24875 , require some extra tools in order to use forward search.
24876 While many of the widespread PDF viewers (most notably Adobe Reader) do
24877 not support forward search at all, some other viewers – e.
24878 \begin_inset space \thinspace{}
24882 xpdf – allow at least to reload the document and jump to a specific page
24883 of the file, so you can at least navigate
24884 \begin_inset Quotes eld
24888 \begin_inset Quotes erd
24892 This latter functionality is provided by an external call of synctex (see
24893 the predefined example configurations).
24897 \begin_layout Standard
24898 Forward search works both with DVI and PDF output.
24900 simply checks which preview format you have used before (i.
24901 \begin_inset space \thinspace{}
24904 e., which format is already there in the temporary directory) and chooses
24905 the appropriate configuration for the respective format.
24908 \begin_layout Chapter
24910 \change_deleted 564990737 1671097409
24911 Special Document Classes
24916 \begin_layout Section
24918 \change_deleted 564990737 1669742044
24922 \begin_layout Standard
24924 \change_deleted 564990737 1669742044
24930 \begin_layout Subsection
24932 \change_deleted 564990737 1669742044
24936 \begin_layout Standard
24938 \change_deleted 564990737 1669742044
24939 This section describes how \SpecialChar LyX
24940 can be used to write articles for submission
24941 to the scientific journal
24943 Astronomy and Astrophysics
24946 \begin_inset Flex URL
24949 \begin_layout Plain Layout
24951 https://www.aanda.org/
24956 ) using Version 5.01 of the document class
24961 This package can be downloaded from the ftp site
24964 \begin_layout Standard
24966 \change_deleted 564990737 1669742044
24967 \begin_inset VSpace medskip
24973 \begin_layout Standard
24976 \change_deleted 564990737 1669742044
24977 \begin_inset Flex URL
24980 \begin_layout Plain Layout
24982 ftp://ftp.edpsciences.org/pub/aa/readme.html
24990 \begin_layout Standard
24992 \change_deleted 564990737 1669742044
24993 \begin_inset VSpace medskip
24999 \begin_layout Standard
25001 \change_deleted 564990737 1669742044
25002 A manual comes together with that package, and this text is not meant to
25003 replace the original manual but is merely a short guide in how to realize
25004 the correct form of your paper.
25008 \begin_layout Standard
25010 \change_deleted 564990737 1669742044
25011 Please note that the publisher of the journal was changed from Springer
25012 to EDP Sciences starting January 1, 2001.
25013 That change involved also some slight changes to the style files, namely
25014 the removal of the thesaurus command.
25015 The \SpecialChar LyX
25016 class aa supports the newest version of these style files, V 5.01.
25017 If you have an older version installed, please upgrade.
25018 For compatibility, the old (version 4) layout has been kept as
25023 Please refer to the comments in
25026 Dir/layouts/aapaper.layout
25031 \begin_layout Subsection
25033 \change_deleted 564990737 1669742044
25037 \begin_layout Standard
25039 \change_deleted 564990737 1669742044
25040 It is recommended you start from the example template distributed with \SpecialChar LyX
25042 If you are not using a template, note the following settings:
25045 \begin_layout Itemize
25047 \change_deleted 564990737 1669742044
25054 Document\SpecialChar menuseparator
25057 dialog (OK, that one was obvious).
25060 \begin_layout Itemize
25062 \change_deleted 564990737 1669742044
25063 Don't change the option
25066 \begin_inset space ~
25076 The whole layout is done by the macros, you shouldn't change anything.
25079 \begin_layout Subsection
25081 \change_deleted 564990737 1669742044
25085 \begin_layout Standard
25087 \change_deleted 564990737 1669742044
25088 First thing to enter is the header information.
25089 It consists of seven entries, of which some are optional.
25093 \begin_layout Itemize
25095 \change_deleted 564990737 1669742044
25103 \begin_layout Itemize
25105 \change_deleted 564990737 1669742044
25113 \begin_layout Itemize
25115 \change_deleted 564990737 1669742044
25123 \begin_layout Itemize
25125 \change_deleted 564990737 1669742044
25133 \begin_layout Itemize
25135 \change_deleted 564990737 1669742044
25140 : [optional] if more than one author: whom to contact for offprint requests.
25143 \begin_layout Itemize
25145 \change_deleted 564990737 1669742044
25150 : [optional] mail address for contacts.
25153 \begin_layout Itemize
25155 \change_deleted 564990737 1669742044
25161 Suggested format is
25163 Received: <date>; Accepted <date>
25166 \begin_layout Standard
25168 \change_deleted 564990737 1669742044
25169 There is no need to issue the
25175 command, this is done automatically by \SpecialChar LyX
25176 when the header is finished.
25177 Although the order of the single header entries doesn't matter it is advised
25178 to keep the above sequence, just to get the best optics and meets the layout
25179 of the real document.
25182 \begin_layout Standard
25184 \change_deleted 564990737 1669742044
25185 If you want to place footnotes in the header block, e.
25186 \begin_inset space \thinspace{}
25190 \begin_inset space \space{}
25193 to state your present address, just use the standard footnote via the menu
25196 Insert\SpecialChar menuseparator
25201 will automagically use the term
25210 \begin_layout Standard
25212 \change_deleted 564990737 1669742044
25215 Edit\SpecialChar menuseparator
25218 , you'll find two insets which are relevant for the titling:
25221 \begin_layout Itemize
25223 \change_deleted 564990737 1669742044
25230 to mark corresponding author\SpecialChar breakableslash
25232 The institutes are numbered sequentially as they appear in the
25236 field, so you have to put a marker to each author.
25239 \begin_layout Itemize
25241 \change_deleted 564990737 1669742044
25246 to supply an email address for fast contact.
25249 \begin_layout Standard
25251 \change_deleted 564990737 1669742044
25252 In addition to these topics, the macros use one additional \SpecialChar LaTeX
25254 has no counterpart in \SpecialChar LyX
25258 \begin_layout Itemize
25260 \change_deleted 564990737 1669742044
25267 to separate different names for more than one author and institute, respectivel
25271 \begin_layout Standard
25273 \change_deleted 564990737 1669742044
25274 The appropriate command has to be entered in \SpecialChar LyX
25275 and marked as \SpecialChar LaTeX
25281 \begin_layout Subsection
25283 \change_deleted 564990737 1669742044
25287 \begin_layout Standard
25289 \change_deleted 564990737 1669742044
25290 The abstract should immediately follow the header block.
25291 With version 5 the abstract environment was changed to a command, and there
25292 is now a restriction to only one paragraph.
25293 In addition, it should contain an entry with the keywords.
25294 This is done via the paragraph style
25299 Refer to the example paper.
25302 \begin_layout Subsection
25304 \change_deleted 564990737 1669742044
25305 Supported environments
25308 \begin_layout Standard
25310 \change_deleted 564990737 1669742044
25311 The A&A paper layout supports the following environments for structuring
25315 \begin_layout Itemize
25317 \change_deleted 564990737 1669742044
25323 \begin_layout Itemize
25325 \change_deleted 564990737 1669742044
25331 \begin_layout Itemize
25333 \change_deleted 564990737 1669742044
25339 \begin_layout Itemize
25341 \change_deleted 564990737 1669742044
25347 \begin_layout Itemize
25349 \change_deleted 564990737 1669742044
25355 \begin_layout Itemize
25357 \change_deleted 564990737 1669742044
25363 \begin_layout Itemize
25365 \change_deleted 564990737 1669742044
25371 \begin_layout Itemize
25373 \change_deleted 564990737 1669742044
25379 \begin_layout Itemize
25381 \change_deleted 564990737 1669742044
25387 \begin_layout Itemize
25389 \change_deleted 564990737 1669742044
25395 \begin_layout Itemize
25397 \change_deleted 564990737 1669742044
25403 \begin_layout Itemize
25405 \change_deleted 564990737 1669742044
25412 \begin_layout Subsection
25414 \change_deleted 564990737 1669742044
25415 Commands not supported by \SpecialChar LyX
25419 \begin_layout Standard
25421 \change_deleted 564990737 1669742044
25422 Some commands are not yet supported by the
25426 layout for \SpecialChar LyX
25428 Some have already been mentioned.
25429 For the sake of completeness, they are listed all together here:
25432 \begin_layout Itemize
25434 \change_deleted 564990737 1669742044
25442 \begin_layout Itemize
25444 \change_deleted 564990737 1669742044
25452 \begin_layout Itemize
25454 \change_deleted 564990737 1669742044
25462 \begin_layout Itemize
25464 \change_deleted 564990737 1669742044
25472 \begin_layout Standard
25474 \change_deleted 564990737 1669742044
25475 If you want to use any of these commands, you have to enter them yourself.
25478 Do not forget to mark them as \SpecialChar LaTeX
25482 \begin_layout Subsection
25484 \change_deleted 564990737 1669742044
25485 Figure and Table Floats
25488 \begin_layout Standard
25490 \change_deleted 564990737 1669742044
25492 provides support for the necessary float environments
25494 figure, figure*, table
25500 , therefore we won't tell much about it here.
25504 \begin_inset space ~
25510 Just remember that tables should be left-aligned.
25511 For that, select the table and change the alignment in
25513 Edit\SpecialChar menuseparator
25515 \begin_inset space ~
25521 \begin_layout Standard
25523 \change_deleted 564990737 1669742044
25524 There is only one special thing: the figures with caption besides the figure.
25525 To create such a figure, you have to do the following:
25528 \begin_layout Enumerate
25530 \change_deleted 564990737 1669742044
25531 Create a wide figure float:
25533 Insert\SpecialChar menuseparator
25534 Float\SpecialChar menuseparator
25537 , then right click in the figure and select
25540 \begin_inset space ~
25548 \begin_layout Enumerate
25550 \change_deleted 564990737 1669742044
25551 Enter your caption text.
25554 \begin_layout Enumerate
25556 \change_deleted 564990737 1669742044
25561 to move the cursor above the caption.
25564 \begin_layout Enumerate
25566 \change_deleted 564990737 1669742044
25570 \begin_layout Enumerate
25572 \change_deleted 564990737 1669742044
25573 Position the cursor behind the figure and insert a horizontal fill:
25575 Insert\SpecialChar menuseparator
25577 \begin_inset space ~
25580 Character\SpecialChar menuseparator
25582 \begin_inset space ~
25590 \begin_layout Enumerate
25592 \change_deleted 564990737 1669742044
25593 Switch to \SpecialChar LaTeX
25597 \begin_inset space ~
25605 \begin_layout Enumerate
25607 \change_deleted 564990737 1669742044
25617 Do not close the brace!
25620 \begin_layout Enumerate
25622 \change_deleted 564990737 1669742044
25623 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
25628 \begin_inset space ~
25640 \begin_layout Standard
25642 \change_deleted 564990737 1669742044
25643 Also, refer to the figures in the example paper.
25646 \begin_layout Subsection
25648 \change_deleted 564990737 1669742044
25652 \begin_layout Standard
25654 \change_deleted 564990737 1669742044
25655 For submission, the paper has to be formated in a special double-spacing
25657 For this purpose, you have to give the option
25661 to the document class.
25662 This must be done using the custom class options field in the
25664 Document\SpecialChar menuseparator
25668 Just enter the string
25675 \begin_layout Subsection
25677 \change_deleted 564990737 1669742044
25681 \begin_layout Standard
25683 \change_deleted 564990737 1669742044
25688 directory contains an example paper written with \SpecialChar LyX
25690 It is the example paper from the original macro package, translated to
25693 Use it for inspiration, and compare the original \SpecialChar LaTeX
25694 code with \SpecialChar LyX
25698 \begin_layout Section
25700 \change_deleted 564990737 1671097429
25704 \begin_layout Standard
25706 \change_deleted 564990737 1671097429
25711 can be used to type letters according to German conventions.
25712 A template file is included in
25714 .../lyx/share/templates
25716 for you to use as a starting point.
25719 \begin_layout Section
25721 \change_deleted 564990737 1671097429
25725 \begin_layout Standard
25727 \change_deleted 564990737 1671097429
25728 See the \SpecialChar LyX
25734 It contains all infos you need.
25737 \begin_layout Section
25739 \change_deleted 564990737 1669755802
25743 \begin_layout Standard
25745 \change_deleted 564990737 1669755802
25748 Panayotis Papasotiriou
25751 \begin_layout Subsection
25753 \change_deleted 564990737 1669755802
25757 \begin_layout Standard
25759 \change_deleted 564990737 1669755802
25760 The ijmpc package is a set of macros that facilitates electronic manuscript
25763 International Journal of Modern Physics C
25766 Similarly, the ijmpd package is for creating manuscripts to be submitted
25769 International Journal of Modern Physics D
25772 Both journals are published by World Scientific.
25773 The corresponding document classes are named
25782 These files, together with instructions for the authors, can be downloaded
25784 \begin_inset Flex URL
25787 \begin_layout Plain Layout
25789 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
25795 \begin_inset Flex URL
25798 \begin_layout Plain Layout
25800 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
25806 Both packages are modified versions of the standard
25807 \begin_inset Quotes eld
25811 \begin_inset Quotes erd
25814 package, and they are almost (but not exactly) identical.
25815 Most of their features are supported by \SpecialChar LyX
25817 I have used \SpecialChar LyX
25818 successfully to write articles submitted to both journals
25819 without any problem.
25822 \begin_layout Subsection
25824 \change_deleted 564990737 1669755802
25828 \begin_layout Standard
25830 \change_deleted 564990737 1669755802
25831 As usual, the easiest way to write a paper is to start with a template.
25834 File\SpecialChar menuseparator
25850 This will give an (almost) empty document that includes the most common
25851 fields found in a manuscript.
25852 Simply overwrite the existing text (including the brackets,
25857 You should keep in mind the following remarks.
25860 \begin_layout Enumerate
25862 \change_deleted 564990737 1669755802
25864 won't let you change the font size and the page style of the document,
25865 because such modifications are not allowed by both packages.
25868 \begin_layout Enumerate
25870 \change_deleted 564990737 1669755802
25871 The language of the document should not be changed.
25872 Before previewing your paper, be sure that the babel package is not used.
25873 To do this, click on
25876 arg "dialog-show document"
25881 \SpecialChar menuseparator
25885 \begin_inset Quotes eld
25889 \begin_inset Quotes erd
25899 \begin_layout Enumerate
25901 \change_deleted 564990737 1669755802
25903 \begin_inset Quotes eld
25907 \begin_inset Quotes erd
25910 style must be used to define keywords.
25913 \begin_layout Enumerate
25915 \change_deleted 564990737 1669755802
25916 The ijmpc package provides a style named
25917 \begin_inset Quotes eld
25920 Classification Codes
25921 \begin_inset Quotes erd
25924 , which can be used to define classification codes, such as PACS numbers.
25925 Note that this facility is not supported by the ijmpd package.
25928 \begin_layout Enumerate
25930 \change_deleted 564990737 1669755802
25931 Several new environments are available:
25932 \begin_inset Quotes eld
25936 \begin_inset Quotes erd
25940 \begin_inset Quotes eld
25944 \begin_inset Quotes erd
25948 \begin_inset Quotes eld
25952 \begin_inset Quotes erd
25956 \begin_inset Quotes eld
25960 \begin_inset Quotes erd
25964 \begin_inset Quotes eld
25968 \begin_inset Quotes erd
25972 \begin_inset Quotes eld
25976 \begin_inset Quotes erd
25980 \begin_inset Quotes eld
25984 \begin_inset Quotes erd
25988 \begin_inset Quotes eld
25992 \begin_inset Quotes erd
25996 \begin_inset Quotes eld
26000 \begin_inset Quotes erd
26004 \begin_inset Quotes eld
26008 \begin_inset Quotes erd
26012 \begin_inset Quotes eld
26016 \begin_inset Quotes erd
26020 \begin_inset Quotes eld
26024 \begin_inset Quotes erd
26028 \begin_inset Quotes eld
26032 \begin_inset Quotes erd
26036 \begin_inset Quotes eld
26040 \begin_inset Quotes erd
26044 Their use is more or less obvious.
26046 supports all these environments; it will use the proper label, text style,
26047 and numbering scheme for each of them.
26050 \begin_layout Enumerate
26052 \change_deleted 564990737 1669755802
26053 Both packages use basic citations; the natbib package should not be used.
26054 In \SpecialChar LyX
26055 , citation references are shown as usual; in the output, citations are
26056 shown as superscripts.
26057 If you want to use a citation as normal text, you should use the
26062 \begin_inset space \thinspace{}
26066 \begin_inset space \space{}
26070 \begin_inset Quotes eld
26074 \begin_inset space \space{}
26084 \begin_inset Quotes erd
26090 \begin_layout Enumerate
26092 \change_deleted 564990737 1669755802
26094 \begin_inset Quotes eld
26098 \begin_inset Quotes erd
26101 section in both packages.
26102 To put acknowledgments, just use the
26103 \begin_inset Quotes eld
26107 \begin_inset Quotes erd
26113 \begin_layout Enumerate
26115 \change_deleted 564990737 1669755802
26116 Appendices may be added to the paper,
26120 the Acknowledgments and
26126 provides a special environment, called
26127 \begin_inset Quotes eld
26131 \begin_inset Quotes erd
26134 which marks the beginning of the appendices.
26135 This environment should be left blank; it just sends a \SpecialChar LaTeX
26136 command, but nothing
26138 In \SpecialChar LyX
26140 \begin_inset Quotes eld
26144 \begin_inset Quotes erd
26147 is printed with blue letters, as a signal that all sections after that
26148 point are appendices.
26149 To write an appendix, use the
26150 \begin_inset Quotes eld
26154 \begin_inset Quotes erd
26159 will number each appendix with capital letters, as required by both journals.
26161 \begin_inset Quotes eld
26165 \begin_inset Quotes erd
26172 be present before the first appendix; if not, all appendices will be numbered
26173 as normal sections in the output.
26176 \begin_layout Enumerate
26178 \change_deleted 564990737 1669755802
26179 The ijmpc and the ijmpd packages use the
26183 command to implement table captions.
26184 As a result, a table created by \SpecialChar LyX
26185 is printed correctly, but its caption
26187 However, you can use some \SpecialChar TeX
26188 code to overcome this problem, so that captions
26189 are printed as expected.
26190 To do so, create a float table as usual, remove the caption, and replace
26191 it with the \SpecialChar TeX
26202 (sic); you must also the \SpecialChar TeX
26207 immediately after the tabular material.
26208 Study the example table included in the template files to see how this
26209 trick is implemented.
26210 Alternatively, If you need table captions, you should implement the whole
26215 file, then include this file to the \SpecialChar LyX
26218 Insert\SpecialChar menuseparator
26219 File\SpecialChar menuseparator
26221 \begin_inset space ~
26227 Details on how to create a table float can be found in the files
26235 , included in the corresponding packages.
26238 \begin_layout Subsection
26240 \change_deleted 564990737 1669755802
26241 Preparing a paper for submission
26244 \begin_layout Standard
26246 \change_deleted 564990737 1669755802
26247 Before you submit your paper you must export the \SpecialChar LyX
26248 document as a \SpecialChar LaTeX
26251 File\SpecialChar menuseparator
26252 Export\SpecialChar menuseparator
26260 \begin_layout Plain Layout
26261 Actually you have the choice between \SpecialChar LaTeX
26262 (plain) and pdflatex.
26263 If you intend to use pdflatex to prepare the paper, you should use the
26264 pdflatex option so that included graphics are converted to PDF format,
26265 ready for use by pdflatex.
26270 , then make the following changes to the resulting
26277 \begin_layout Enumerate
26279 \change_deleted 564990737 1669755802
26280 Remove the comment lines before the
26289 \begin_layout Enumerate
26291 \change_deleted 564990737 1669755802
26292 Remove everything between (and including) the
26304 commands, except for any commands you specifically put into the \SpecialChar LaTeX
26308 \begin_layout Standard
26310 \change_deleted 564990737 1669755802
26315 file should be saved and processed through \SpecialChar LaTeX
26316 as many times as necessary.
26317 You may also want to check the resulting
26326 \begin_layout Section
26328 \change_deleted 564990737 1669801478
26332 \begin_layout Standard
26334 \change_deleted 564990737 1669801478
26340 \begin_layout Subsection
26342 \change_deleted 564990737 1669801478
26346 \begin_layout Standard
26348 \change_deleted 564990737 1669801478
26349 The iopart package provides a document class to create electronic manuscript
26350 submission to the journals published by the Institute of Physics.
26351 Instructions for the authors how to create a paper using the iopart class
26352 can be downloaded together with the iopart package from the site
26353 \begin_inset Flex URL
26356 \begin_layout Plain Layout
26358 ftp://ftp.iop.org/pub/journals/latex2e
26366 \begin_layout Subsection
26368 \change_deleted 564990737 1669801478
26372 \begin_layout Standard
26374 \change_deleted 564990737 1669801478
26375 The easiest way to write a paper is to start with the template
26379 that is available via
26381 File\SpecialChar menuseparator
26384 The template explains how to use the special text environments.
26385 Here are the most important advices:
26388 \begin_layout Itemize
26390 \change_deleted 564990737 1669801478
26391 To be able to compile your document to a PDF, PS, or DVI, ensure that the
26392 no AMS packages are loaded in
26394 Document\SpecialChar menuseparator
26395 Settings\SpecialChar menuseparator
26401 \begin_layout Itemize
26403 \change_deleted 564990737 1669801478
26406 The title environment defines the kind of your paper.
26407 So use one of the following environments for the title:
26411 \begin_layout Itemize
26413 \change_deleted 564990737 1669801478
26422 \begin_layout Itemize
26424 \change_deleted 564990737 1669801478
26433 \begin_layout Itemize
26435 \change_deleted 564990737 1669801478
26441 for a Topical review
26444 \begin_layout Itemize
26446 \change_deleted 564990737 1669801478
26455 \begin_layout Itemize
26457 \change_deleted 564990737 1669801478
26466 \begin_layout Itemize
26468 \change_deleted 564990737 1669801478
26474 for a Paper (same as Title)
26477 \begin_layout Itemize
26479 \change_deleted 564990737 1669801478
26485 for a Preliminary communication
26488 \begin_layout Itemize
26490 \change_deleted 564990737 1669801478
26496 for a Rapid communication
26499 \begin_layout Itemize
26501 \change_deleted 564990737 1669801478
26507 for a Letter to the editor
26511 \begin_layout Itemize
26513 \change_deleted 564990737 1669801478
26516 All title environments except of
26520 can have an optional short title.
26523 \begin_layout Itemize
26525 \change_deleted 564990737 1669801478
26526 There is a general title environment
26530 which is not directly supported by \SpecialChar LyX
26532 This can be used as \SpecialChar TeX
26533 code when your document doesn't fit into one of the
26537 \begin_layout Standard
26539 \change_deleted 564990737 1669801478
26540 For more informations like hints for special table and formula formatting,
26541 look at the IOP author guidelines.
26546 \begin_layout Section
26548 \change_deleted 564990737 1670317155
26552 \begin_layout Standard
26554 \change_deleted 564990737 1670317155
26557 Panayotis Papasotiriou
26560 \begin_layout Subsection
26562 \change_deleted 564990737 1670317155
26566 \begin_layout Standard
26568 \change_deleted 564990737 1670317155
26569 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
26570 that facilitates electronic manuscript submission to the journals they
26572 Most known of them (at least in my domain of interest) are
26574 Astrophysics and Space Science
26580 , but there are many others (see a complete list at
26581 \begin_inset Flex URL
26584 \begin_layout Plain Layout
26586 http://www.wkap.nl/jrnllist.htm/JRNLHOME
26592 The Kluwer package may be downloaded from the site
26593 \begin_inset Flex URL
26596 \begin_layout Plain Layout
26598 http://www.wkap.nl/kaphtml.htm/STYLEFILES
26604 A complete user guide is contained in that package (but it can also be
26605 downloaded separately).
26608 \begin_layout Standard
26610 \change_deleted 564990737 1670317155
26612 supports many features of the package but not everything.
26613 However, the \SpecialChar TeX
26614 code needed is reduced to some
26615 \begin_inset Quotes eld
26619 \begin_inset Quotes erd
26622 commands of the package (see
26623 \begin_inset space ~
26627 \begin_inset CommandInset ref
26629 reference "subsec:kluwer_peculiarities"
26634 I have recently used \SpecialChar LyX
26635 to write an article submitted to the
26637 Astrophysics and Space Science
26639 without any problem.
26642 \begin_layout Subsection
26644 \change_deleted 564990737 1670317155
26648 \begin_layout Standard
26650 \change_deleted 564990737 1670317155
26651 The easiest way to write a paper is to start with the Kluwer template file.
26654 File\SpecialChar menuseparator
26666 This will give an (almost) empty document that includes the most common
26667 fields found in a manuscript and a short description of their use.
26668 As in most templates, simply overwrite the existing text (including the
26673 ) with the correct information.
26676 \begin_layout Subsection
26678 \change_deleted 564990737 1670317155
26679 Preparing a paper for submission
26682 \begin_layout Standard
26684 \change_deleted 564990737 1670317155
26685 As in the AAS\SpecialChar TeX
26686 package, before you submit your paper to a journal you must
26688 \begin_inset Quotes eld
26692 \begin_inset Quotes erd
26698 \begin_layout Enumerate
26700 \change_deleted 564990737 1670317155
26701 Export your paper as a \SpecialChar LaTeX
26703 To do this, click on
26705 File\SpecialChar menuseparator
26706 Export\SpecialChar menuseparator
26714 \begin_layout Enumerate
26716 \change_deleted 564990737 1670317155
26721 file with a text editor and make the following changes
26725 \begin_layout Enumerate
26727 \change_deleted 564990737 1670317155
26728 remove the comment lines before the
26737 \begin_layout Enumerate
26739 \change_deleted 564990737 1670317155
26740 remove everything between (and including) the
26752 commands, except for any commands you specifically put into the \SpecialChar LaTeX
26756 \begin_layout Standard
26758 \change_deleted 564990737 1670317155
26767 \begin_layout Enumerate
26769 \change_deleted 564990737 1670317155
26774 file through \SpecialChar LaTeX
26775 as many times as necessary (usually up to three).
26778 \begin_layout Enumerate
26780 \change_deleted 564990737 1670317155
26786 \begin_inset space \thinspace{}
26790 \begin_inset space \space{}
26797 , and check if everything is OK (it should, if you didn't make any mistake).
26800 \begin_layout Subsection
26802 \change_deleted 564990737 1670317155
26803 \begin_inset Quotes eld
26807 \begin_inset Quotes erd
26810 of the Kluwer package
26811 \begin_inset CommandInset label
26813 name "subsec:kluwer_peculiarities"
26820 \begin_layout Standard
26822 \change_deleted 564990737 1670317155
26823 The Kluwer package has the following
26824 \begin_inset Quotes eld
26828 \begin_inset Quotes erd
26834 \begin_layout Enumerate
26836 \change_deleted 564990737 1670317155
26837 It is possible to write multiple articles in the same \SpecialChar LaTeX
26842 \begin_layout Plain Layout
26843 I can't imagine any good reason to do this.
26849 Each article must be included in the environment
26850 \begin_inset Quotes eld
26854 \begin_inset Quotes erd
26858 Unfortunately, this environment cannot be omitted, even if you write just
26860 Therefore, each article starts with the command
26866 and, obviously, ends with the command
26873 Although this can be implemented in \SpecialChar LyX
26874 , I didn't included it, since it looks
26875 ugly and can confuse the novice user.
26876 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
26879 \begin_inset Quotes eld
26884 \begin_inset Quotes erd
26890 \begin_layout Enumerate
26892 \change_deleted 564990737 1670317155
26893 Information given at the beginning of the article (i.
26894 \begin_inset space \thinspace{}
26898 \begin_inset space \space{}
26901 title, subtitle, author, institution, running title, running author, abstract
26902 and keywords) must be included in an environment called
26903 \begin_inset Quotes eld
26907 \begin_inset Quotes erd
26911 This is not implemented in \SpecialChar LyX
26912 , so you must enter title, subtitle etc.
26913 \begin_inset space ~
26916 between two \SpecialChar TeX
26932 \begin_layout Enumerate
26934 \change_deleted 564990737 1670317155
26935 According to the user manual, the label of each bibliography item must be
26959 \begin_layout Standard
26961 \change_deleted 564990737 1670317155
26966 template takes care of all these
26967 \begin_inset Quotes eld
26971 \begin_inset Quotes erd
26975 If you start a new paper using this template you don't need to do anything
26980 \begin_layout Enumerate
26982 \change_deleted 564990737 1670317155
26983 don't delete the \SpecialChar TeX
26984 code included in the template, and
26987 \begin_layout Enumerate
26989 \change_deleted 564990737 1670317155
26990 copy the example bibliography item included in the template and modify it
26991 as necessary to enter new bibliography items.
26994 \begin_layout Section
26996 \change_deleted 564990737 1671097446
27000 \begin_layout Standard
27002 \change_deleted 564990737 1671097446
27007 provides an alternative to the standard
27012 It provides similar functionality, but you might prefer this layout with
27013 sans serif sections, headings, and more.
27016 \begin_layout Section
27018 \change_deleted 564990737 1671097446
27019 Springer Journals (
27026 \begin_layout Standard
27028 \change_deleted 564990737 1671097446
27034 \begin_layout Subsection
27036 \change_deleted 564990737 1671097446
27040 \begin_layout Standard
27042 \change_deleted 564990737 1671097446
27043 These are the layout files for some of the journal formats used by Springer
27044 Verlag and listed on
27045 \begin_inset Flex URL
27048 \begin_layout Plain Layout
27050 http://www.springer.de/author/tex/help-journals.html
27055 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
27057 It is a modular system: the things common to all journals are implemented
27062 , which journal-specific layout files (such as, e.
27063 \begin_inset space \thinspace{}
27067 \begin_inset space \space{}
27074 for Journal of Geodesy) can include.
27077 \begin_layout Standard
27079 \change_deleted 564990737 1671097446
27080 This means that implementing support for any other Springer journal on this
27081 list is as simple as writing your own
27089 file following the outline given in
27097 \begin_layout Standard
27099 \change_deleted 564990737 1671097446
27100 It is reasonably well tested only for the Journal of Geodesy.
27109 come with the standard \SpecialChar LyX
27111 Install the relevant class file (downloaded from Springer) in a proper
27112 directory, reconfigure \SpecialChar LaTeX
27113 (in the te\SpecialChar TeX
27118 , as root if necessary — doesn't \SpecialChar LyX
27119 take care of this?), reconfigure \SpecialChar LyX
27124 \begin_layout Subsection
27126 \change_deleted 564990737 1671097446
27130 \begin_layout Standard
27132 \change_deleted 564990737 1671097446
27133 A large number of theorem-like styles —
27145 \begin_layout Standard
27147 \change_deleted 564990737 1671097446
27150 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
27151 _Title, Author_Running, Institute,
27152 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
27155 See the Springer class file documentation for details.
27158 \begin_layout Subsection
27160 \change_deleted 564990737 1671097446
27164 \begin_layout Itemize
27166 \change_deleted 564990737 1671097446
27178 \begin_layout Itemize
27180 \change_deleted 564990737 1671097446
27183 Probability Theory and Related Fields
27189 — Jean-Marc Lasgouttes
27192 \begin_layout Standard
27194 \change_deleted 564990737 1671097446
27195 Add your own, it isn't so hard!
27198 \begin_layout Subsection
27200 \change_deleted 564990737 1671097446
27204 \begin_layout Standard
27206 \change_deleted 564990737 1671097446
27207 These files are partly based on the older
27211 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
27213 file from Springer.
27218 layout, are now defunct.
27219 Jean-Marc Lasgouttes helped out big in making me find my way around the
27221 layout file mechanism.
27224 \begin_layout Subsection
27226 \change_deleted 564990737 1671097446
27230 \begin_layout Standard
27232 \change_deleted 564990737 1671097446
27234 But probably less than in the old hacked-\SpecialChar LaTeX
27242 \begin_layout Chapter
27244 Features needing Extra Software
27247 \begin_layout Section
27248 Checking \SpecialChar TeX
27252 \begin_layout Standard
27258 \begin_layout Subsection
27262 \begin_layout Standard
27271 \begin_layout Plain Layout
27276 is not yet available when you are using the \SpecialChar LaTeX
27277 distribution MiK\SpecialChar TeX
27283 , you'll find in the
27290 \begin_inset space ~
27301 \begin_inset Newline newline
27305 \begin_inset CommandInset href
27307 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
27315 \begin_layout Standard
27318 Chk\SpecialChar TeX
27321 package is a program that was written by
27322 \begin_inset Flex Noun
27325 \begin_layout Plain Layout
27327 \begin_inset space ~
27335 in frustration because some constructs in \SpecialChar LaTeX
27336 are sometimes non-intuitive,
27337 and easy to forget.
27338 The program runs over your \SpecialChar LaTeX
27339 file, checks the integrity of the file, and
27340 flags some common errors.
27341 In other technical words, it is
27345 for \SpecialChar LaTeX
27349 \begin_layout Standard
27350 Well, what is a syntax checker doing in \SpecialChar LyX
27351 which is supposed to produce correct
27353 anyways? The answer is simple: Just as
27357 not only checks the
27361 of C programs, but also does
27365 checks for type-errors,
27367 Chk\SpecialChar TeX
27370 catches some common
27374 errors, in addition to the syntactical ones.
27377 Chk\SpecialChar TeX
27380 is capable of detecting several common errors, such as
27383 \begin_layout Itemize
27384 Ellipsis detection:
27385 \begin_inset Newline newline
27388 Use \SpecialChar ldots
27392 \begin_layout Itemize
27393 No space in front of/after parenthesis:
27394 \begin_inset Newline newline
27400 \begin_layout Itemize
27401 Enforcement of normal space after common abbreviations:
27402 \begin_inset Newline newline
27406 \begin_inset space \thinspace{}
27410 \begin_inset space \space{}
27413 is too wide spacing.
27416 \begin_layout Itemize
27417 Enforcement of end-of-sentence space when the last sentence ends with a
27419 \begin_inset Newline newline
27423 And this is wrong spacing.
27426 \begin_layout Itemize
27427 Space in front of labels and similar commands:
27428 \begin_inset Newline newline
27431 The label should stick right up to the text to avoid falling to a wrong
27434 \begin_inset CommandInset label
27444 \begin_layout Plain Layout
27445 This footnote is in danger of falling off to a wrong page
27450 The label is separated too much.
27453 \begin_layout Itemize
27454 Space in front of references, instead of hard spaces:
27455 \begin_inset Newline newline
27458 If you have bad luck, the text will break right between the referenced text
27459 and reference number, and that's a pity.
27461 \begin_inset CommandInset ref
27463 reference "sec:chktex"
27470 \begin_layout Itemize
27472 \begin_inset Quotes eld
27476 \begin_inset Quotes erd
27480 \begin_inset Formula $\times$
27484 \begin_inset Newline newline
27487 2x2 looks cheap compared to
27488 \begin_inset Formula $2\times2$
27494 \begin_layout Standard
27495 and more \SpecialChar ldots
27496 It is an invaluable tool when you are
27497 \begin_inset Quotes eld
27501 \begin_inset Quotes erd
27504 your document before printing, and you should run it right after the obligatory
27505 spelling check, and before you go fine tuning the typesetting.
27508 \begin_layout Subsection
27512 \begin_layout Standard
27513 If you have the program installed, usage is as simple as choosing
27515 Tools\SpecialChar menuseparator
27517 \begin_inset space ~
27523 This will make \SpecialChar LyX
27524 generate a \SpecialChar LaTeX
27525 file of your document, start
27527 Chk\SpecialChar TeX
27530 to check it, and then make \SpecialChar LyX
27532 \begin_inset Quotes eld
27536 \begin_inset Quotes erd
27539 with the warnings from
27541 Chk\SpecialChar TeX
27544 , if there were any.
27545 The warnings will be placed close to the point of the mistake, and you
27546 can quickly find them by using the
27548 Navigate\SpecialChar menuseparator
27551 menu item, or the shortcut key
27560 Open the error boxes by clicking on them with the mouse, or use the shortcut
27569 bindings, or the corresponding
27578 Read the warning and correct the mistake, if it is a mistake.
27579 If you have trouble understanding what the warning is about, you can safely
27581 Remember that there is a hidden layer between the document on screen and
27582 the technical details in invoking
27584 Chk\SpecialChar TeX
27587 , and this gap can make some warnings seem arcane or just plain silly.
27590 \begin_layout Standard
27591 This document is an excellent testing bed for the feature, and it should
27592 provide quite a few warnings for you to fiddle with.
27593 Since computers are only so smart, expect most of the warnings to be false
27597 \begin_layout Subsection
27598 How to fine tune it
27601 \begin_layout Standard
27602 Sometimes, you'll find that
27604 Chk\SpecialChar TeX
27607 makes more noise than suits your mood.
27608 Then you can choose not to use it, wait until your mood changes, or try
27611 Chk\SpecialChar TeX
27614 to get better along with you.
27617 \begin_layout Standard
27620 Chk\SpecialChar TeX
27627 very configurable and extensible, you should not expect to solve all problems
27630 Chk\SpecialChar TeX
27633 in \SpecialChar LyX
27635 Since \SpecialChar LyX
27636 has to generate a somewhat special \SpecialChar LaTeX
27637 file to be able to match the
27638 line numbers from the
27640 Chk\SpecialChar TeX
27647 \begin_layout Plain Layout
27648 You can inspect the specific output from
27654 Document\SpecialChar menuseparator
27657 \begin_inset space ~
27671 to the internal document structure, some of the warnings will not appear
27673 There are two things you can do about this:
27676 \begin_layout Itemize
27679 Chk\SpecialChar TeX
27682 invocation command line in
27683 \begin_inset Flex Noun
27686 \begin_layout Plain Layout
27687 Tools\SpecialChar menuseparator
27688 Preferences\SpecialChar menuseparator
27689 Output\SpecialChar menuseparator
27690 LaTeX\SpecialChar menuseparator
27698 Chk\SpecialChar TeX
27701 installation configuration file (usually with the file
27706 See below to learn what warnings can be enabled and disabled on the command
27710 \begin_layout Itemize
27711 Export your document as a raw \SpecialChar LaTeX
27714 File\SpecialChar menuseparator
27715 Export\SpecialChar menuseparator
27724 Invoked in this way, it can be a hassle to find the corresponding place
27725 in the document inside \SpecialChar LyX
27726 , but with a little patience, you should be able
27730 \begin_layout Standard
27731 Here follows the warning messages that can be enabled and disabled in
27740 to disable a warning, and
27744 to enable a warning.
27745 The emphasized entries are disabled by default, because the default is
27748 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
27753 \begin_layout Standard
27754 Notice that you should only use the options that enable and disable warnings,
27755 because \SpecialChar LyX
27756 relies on some of the other command line parameters to be set
27757 in a specific way to have a chance to communicate with
27764 \begin_layout Enumerate
27768 Command terminated with space.
27771 \begin_layout Enumerate
27774 Non-breaking space (
27775 \begin_inset Quotes eld
27783 \begin_inset Quotes erd
27786 ) should have been used.
27789 \begin_layout Enumerate
27793 You should enclose the previous parenthesis with
27794 \begin_inset Quotes eld
27802 \begin_inset Quotes erd
27808 \begin_layout Enumerate
27811 Italic correction (
27812 \begin_inset Quotes eld
27822 \begin_inset Quotes erd
27825 ) found in non-italic buffer.
27828 \begin_layout Enumerate
27831 Italic correction (
27832 \begin_inset Quotes eld
27842 \begin_inset Quotes erd
27845 ) found more than once.
27848 \begin_layout Enumerate
27852 No italic correction (
27853 \begin_inset Quotes eld
27863 \begin_inset Quotes erd
27869 \begin_layout Enumerate
27873 \begin_inset Quotes eld
27881 \begin_inset Quotes erd
27885 \begin_inset Quotes eld
27893 \begin_inset Quotes erd
27899 \begin_layout Enumerate
27902 Wrong length of dash may have been used.
27905 \begin_layout Enumerate
27909 \begin_inset Quotes eld
27917 \begin_inset Quotes erd
27921 \begin_inset Quotes eld
27929 \begin_inset Quotes erd
27935 \begin_layout Enumerate
27939 \begin_inset Quotes eld
27947 \begin_inset Quotes erd
27953 \begin_layout Enumerate
27957 \begin_inset Quotes eld
27965 \begin_inset Quotes erd
27968 to achieve an ellipsis.
27971 \begin_layout Enumerate
27974 Inter-word spacing (
27975 \begin_inset Quotes eld
27985 \begin_inset Quotes eld
27988 ) should perhaps be used.
27991 \begin_layout Enumerate
27994 Inter-sentence spacing (
27995 \begin_inset Quotes eld
28005 \begin_inset Quotes erd
28008 ) should perhaps be used.
28011 \begin_layout Enumerate
28014 Could not find argument for command.
28017 \begin_layout Enumerate
28021 \begin_inset Quotes eld
28029 \begin_inset Quotes erd
28035 \begin_layout Enumerate
28038 Math mode still on at end of \SpecialChar LaTeX
28042 \begin_layout Enumerate
28046 \begin_inset Quotes eld
28054 \begin_inset Quotes erd
28057 doesn't match the number of
28058 \begin_inset Quotes eld
28066 \begin_inset Quotes erd
28072 \begin_layout Enumerate
28075 You should use either
28078 \begin_inset Quotes eld
28086 \begin_inset Quotes erd
28091 as an alternative to
28092 \begin_inset Quotes eld
28100 \begin_inset Quotes erd
28106 \begin_layout Enumerate
28113 " (ASCII 39) instead of "
28120 \begin_layout Enumerate
28123 User-specified pattern found.
28126 \begin_layout Enumerate
28129 This command might not be intended.
28132 \begin_layout Enumerate
28139 \begin_layout Enumerate
28157 \begin_layout Enumerate
28160 Delete this space to maintain correct page references.
28163 \begin_layout Enumerate
28167 You might wish to put this between a pair of
28168 \begin_inset Quotes eld
28176 \begin_inset Quotes erd
28182 \begin_layout Enumerate
28185 You ought to remove spaces in front of punctuation.
28188 \begin_layout Enumerate
28191 Could not execute \SpecialChar LaTeX
28195 \begin_layout Enumerate
28204 in front of small punctuation.
28207 \begin_layout Enumerate
28215 may look prettier here.
28218 \begin_layout Enumerate
28222 Multiple spaces detected in output.
28225 \begin_layout Enumerate
28228 This text may be ignored.
28231 \begin_layout Enumerate
28237 \begin_inset Quotes eld
28242 to begin quotation, not
28249 \begin_layout Enumerate
28256 to end quotation, not
28259 \begin_inset Quotes eld
28267 \begin_layout Enumerate
28273 \begin_layout Enumerate
28276 You should perhaps use
28277 \begin_inset Quotes eld
28285 \begin_inset Quotes erd
28291 \begin_layout Enumerate
28294 You should put a space in front of/after parenthesis.
28297 \begin_layout Enumerate
28300 You should avoid spaces in front of/after parenthesis.
28303 \begin_layout Enumerate
28307 You should not use punctuation in front of/after quotes.
28310 \begin_layout Enumerate
28313 Double space found.
28316 \begin_layout Enumerate
28319 You should put punctuation outside inner/inside display math mode.
28322 \begin_layout Enumerate
28325 You ought to not use primitive \SpecialChar TeX
28326 in \SpecialChar LaTeX
28330 \begin_layout Enumerate
28333 You should remove spaces in front of
28334 \begin_inset Quotes eld
28342 \begin_inset Quotes erd
28348 \begin_layout Enumerate
28351 \begin_inset Quotes eld
28359 \begin_inset Quotes erd
28362 is normally not followed by
28363 \begin_inset Quotes eld
28371 \begin_inset Quotes erd
28377 \begin_layout Standard
28378 In later versions of \SpecialChar LyX
28379 , we hope to provide a more complete interface to this
28380 tool (and it's smaller cousin
28384 ) to exploit the full power of it.
28385 But it's not exactly useless as it is now: go try it on one of your existing
28386 documents of a certain length and be surprised.
28389 \begin_layout Section
28390 Version Control in \SpecialChar LyX
28394 \begin_layout Standard
28397 Lars Gullik Bjønnes
28404 \begin_layout Subsection
28408 \begin_layout Standard
28410 supports some of the most basic RCS/CVS/SVN/GIT commands.
28411 If you need something a bit more sophisticated you will have to do that
28412 manually in a terminal.
28415 \begin_layout Standard
28416 Also note that CVS support is not as good as subversion support, so we advise
28418 A good place to start learning Subversion is the SVN Book
28422 \begin_layout Plain Layout
28423 \begin_inset CommandInset href
28425 target "http://svnbook.red-bean.com/"
28436 In the case of RCS you should read
28437 \begin_inset Quotes eld
28441 \begin_inset Quotes erd
28444 (a man file, read it with
28449 This file describes all the basic features of RCS.
28450 You should especially notice the comment about a RCS directory, and the
28451 notion of a master RCS file (the file ending in
28458 \begin_layout Standard
28459 Before you begin to use the version control features in \SpecialChar LyX
28461 familiar with RCS/CVS/SVN/GIT usage.
28462 The implementation in \SpecialChar LyX
28463 assumes a recent version of the GNU RCS or CVS/SVN
28464 package — no guarantees are made for older versions.
28465 Most of the log messages are not currently displayed after operations —
28466 you can check them in the Messages pane if you are unsure.
28467 Regular users of version control will appreciate the VC toolbar, which
28470 View\SpecialChar menuseparator
28471 Toolbars\SpecialChar menuseparator
28473 \begin_inset space ~
28481 \begin_layout Standard
28482 For introducing your own external commands consult
28483 \begin_inset Flex Code
28486 \begin_layout Plain Layout
28500 \begin_layout Standard
28501 It is strongly recommended to store documents in uncompressed format if
28502 using version control (uncheck
28504 Document\SpecialChar menuseparator
28507 if it is checked): Uncompressed LyX documents are text files and therefore
28508 for merging two different versions by version control systems.
28509 Compressed LyX documents are binary files, which cannot be merged by version
28513 \begin_layout Subsection
28514 RCS commands in \SpecialChar LyX
28518 \begin_layout Standard
28519 The following sections describe the RCS commands supported by \SpecialChar LyX
28521 You can find them in the
28523 File\SpecialChar menuseparator
28525 \begin_inset space ~
28532 was tested against RCS 5.7/5.8.
28535 \begin_layout Subsubsection
28541 \begin_layout Standard
28542 If your document is not under revision control, this is the only item shown
28544 And if it is under revision control, the
28548 item is not visible.
28552 \begin_layout Standard
28553 This command registers your document with RCS (unless you are under the
28554 directory managed by CVS)\SpecialChar endofsentence
28555 You are asked interactively to supply an initial
28556 description of the document.
28557 The document is now set in Read-Only mode and you have to
28560 \begin_inset space ~
28564 \begin_inset space ~
28568 \begin_inset space ~
28573 , before making any changes to it.
28574 A document under revision control has a
28575 \begin_inset Quotes eld
28578 [RCS:<version> <locker>]
28579 \begin_inset Quotes erd
28582 item tagged to the filename in the minibuffer.
28585 \begin_layout Standard
28586 RCS command that is run:
28589 \begin_layout LyX-Code
28592 ci -q -u -i -t-"<initial description>" <file-name>
28595 \begin_layout Standard
28600 to understand the switches.
28604 \begin_layout Subsubsection
28610 \begin_layout Standard
28611 When you are finished editing a file, you check in your changes.
28612 When you do this, you are asked for a description of the changes.
28613 This is stored in the history log.
28614 The version number is bumped, your changes are applied to the master RCS
28615 file, the document is unlocked and set to Read-Only mode.
28618 \begin_layout Itemize
28621 ci -q -u -m"<description>" <file-name>
28624 \begin_layout Subsubsection
28630 \begin_layout Standard
28631 By doing this you lock the document so that only you can edit it.
28632 This will also make the document Read-Write only for you.
28633 You will usually continue editing for a while and when you are finished
28634 you check in your changes.
28635 The status line is changed to reflect that you have locked the file.
28638 \begin_layout Itemize
28641 co -q -l <file-name>
28644 \begin_layout Subsubsection
28647 Revert To Repository Version
28650 \begin_layout Standard
28651 This will discard all changes made to the document since the last check
28653 You get a warning before changes are discarded.
28656 \begin_layout Itemize
28659 co -f -u<version> <file-name>
28662 \begin_layout Subsubsection
28668 \begin_layout Standard
28669 This will create a copy of the current document.
28670 Since RCS does not support copy operations natively, the version history
28671 is not preserved, and the copy is added as a new file.
28672 It requires a clean document without any changes since the last checkin.
28673 You are asked for a file name and a description of the copy operation.
28674 After that the copy is created, both locally and in the repository.
28675 If the parent directories of the copied and original document differ, all
28676 relative paths of included files of the copy are adjusted (like in
28678 File\SpecialChar menuseparator
28683 Finally, the copy is loaded instead of the original document.
28686 \begin_layout Labeling
28687 \labelwidthstring 00.00.0000
28689 \begin_inset space ~
28693 \begin_inset space ~
28697 \begin_inset Newline newline
28701 \begin_inset Flex Code
28704 \begin_layout Plain Layout
28707 \begin_inset Quotes qld
28711 \begin_inset Quotes qld
28720 \begin_inset Flex Code
28723 \begin_layout Plain Layout
28726 \begin_inset Quotes qld
28730 \begin_inset Quotes qld
28739 \begin_inset Newline newline
28743 \begin_inset Flex Code
28746 \begin_layout Plain Layout
28750 \begin_inset Quotes qld
28754 \begin_inset Quotes qld
28765 \begin_layout Subsubsection
28771 \begin_layout Standard
28772 This makes as if the last check in never happened.
28773 No changes are made to the document loaded into \SpecialChar LyX
28774 , but the last version
28775 is removed from the master RCS file.
28778 \begin_layout Itemize
28781 rcs -o<version> <file-name>
28784 \begin_layout Subsubsection
28790 \begin_layout Standard
28791 This shows the complete history of the RCS document.
28796 is shown in a browser.
28804 \begin_layout Subsubsection
28808 \begin_layout Standard
28810 supports RCS version number, author name, date and time of last commit.
28811 All those are extracted from
28813 rlog -r <file-name>
28817 \begin_inset CommandInset ref
28819 reference "subsec:VCS-Revision-Information"
28826 \begin_layout Subsection
28827 CVS commands in \SpecialChar LyX
28831 \begin_layout Standard
28832 A subset of CVS operations is supported by \SpecialChar LyX
28834 You can find the commands in the
28836 File\SpecialChar menuseparator
28838 \begin_inset space ~
28844 The version control system SVN is more powerful, so please use it instead
28845 of CVS if possible.
28848 \begin_layout Subsubsection
28854 \begin_layout Standard
28855 If you start from scratch with CVS you have to create your repository and
28856 checkout the working copy with external tools.
28857 If you're using a client-server setup you may need to login before doing
28858 the first repository checkout.
28861 \begin_layout Standard
28862 If your documents are under revision control and others are using the same
28863 repository problems arise when different changes to the same document at
28864 the same location happen.
28865 Standard CVS repositories don't operate with a file locking mechanism.
28866 This may be surprising, but conflicts only occur if people disagree on
28867 the proper content of the same part of a document.
28868 So, if co-workers are used to communicate regularly, these conflicts occur
28870 If they don't communicate they have a fundamental problem anyway.
28871 Nevertheless some people like to work with so called
28872 \begin_inset Quotes eld
28876 \begin_inset Quotes erd
28880 If they do so the working copy of all files is readonly when checked out
28881 first and the user starts editing after using a special command to make
28882 the working copy writable.
28883 When the changes are checked in the working copy returns to readonly state.
28884 With \SpecialChar LyX
28885 one has to edit the
28886 \begin_inset Flex Code
28889 \begin_layout Plain Layout
28895 file and add the line
28896 \begin_inset Flex Code
28899 \begin_layout Plain Layout
28905 to work with reserved checkouts.
28906 The benefit is the possibility to see who is using a writable copy of some
28908 It's not guaranteed only one user makes a copy writable.
28911 \begin_layout Standard
28913 tries to guess if you're using reserved or non-reserved checkouts.
28914 If your working copy is readonly or it is writable and an additional copy
28915 of your document exists in the CVS/Base sub-directory a reserved otherwise
28916 a non-reserved checkout is assumed.
28917 When a reserved checkout is detected you have to use
28918 \begin_inset Flex Noun
28921 \begin_layout Plain Layout
28927 to make your working copy writable if it's readonly.
28929 \begin_inset Flex Noun
28932 \begin_layout Plain Layout
28938 operation is possible and that makes your working copy readonly again after
28939 transferring your changes to the repository.
28942 \begin_layout Standard
28943 More information about CVS can be found here
28944 \begin_inset Flex URL
28947 \begin_layout Plain Layout
28949 http://www.nongnu.org/cvs
28955 \begin_inset Flex URL
28958 \begin_layout Plain Layout
28960 http://ximbiot.com/cvs
28968 \begin_layout Standard
28973 to understand the sub-commands and the switches mentioned below.
28976 \begin_layout Subsubsection
28982 \begin_layout Standard
28983 If your document is not under revision control, this is the only item shown
28985 And if it is under revision control, the
28989 item is not visible.
28993 \begin_layout Standard
28994 This command registers in CVS your document
28995 \begin_inset Flex Strong
28998 \begin_layout Plain Layout
29006 in the case you have already the documents directory under CVS control
29012 This means you have to create or checkout the archive by yourself using
29014 (In case you forget that step \SpecialChar LyX
29015 registers the document with RCS.)
29018 \begin_layout Standard
29019 Then you are asked interactively to supply an initial description of the
29021 Don't forget that registered file is not yet checked in.
29024 \begin_layout Standard
29025 CVS command that is run:
29027 cvs -q add -m"<entered message>" "<file-name>"
29030 \begin_layout Standard
29035 above and for all other CVS commands is an abbreviation for
29036 \begin_inset Quotes eld
29039 change the current working directory to file location and use the file name
29040 without path component as argument
29041 \begin_inset Quotes erd
29047 \begin_layout Subsubsection
29053 \begin_layout Standard
29054 When you are finished editing a file, you commit your changes.
29055 When you do this and you had changed the document, you are asked for a
29056 description of the changes.
29057 After that changes are written to the repository.
29058 In case you didn't change the document and a reserved checkout is detected
29059 the reservation made on
29060 \begin_inset Flex Noun
29063 \begin_layout Plain Layout
29072 \begin_layout Labeling
29073 \labelwidthstring 00.00.0000
29075 \begin_inset space ~
29079 \begin_inset space ~
29083 \begin_inset Newline newline
29087 \begin_inset Flex Code
29090 \begin_layout Plain Layout
29093 -q commit -m"<description>" "<file-name>"
29099 \begin_inset Newline newline
29103 \begin_inset Flex Code
29106 \begin_layout Plain Layout
29117 \begin_layout Subsubsection
29123 \begin_layout Standard
29124 When you are sharing a repository with others, you may have to incorporate
29125 their changes into your working copy.
29128 \begin_layout Standard
29131 cvs -q update "<file-name>"
29134 \begin_layout Standard
29135 If a readonly checkout is detected the working copy is made writable and
29139 \begin_layout Standard
29142 cvs -q edit "<file-name>"
29145 \begin_layout Subsubsection
29148 Revert To Repository Version
29151 \begin_layout Standard
29152 This will discard all changes made to the document since the last check
29154 You get a warning before changes are discarded.
29155 Firstly the file is deleted, secondly CVS update command is run.
29158 \begin_layout Standard
29161 cvs -q update "<file-name>"
29164 \begin_layout Standard
29165 If a reserved checkout is detected and the working copy has no changes only
29166 the reservation is undone.
29169 \begin_layout Standard
29172 cvs -q unedit "<file-name>"
29175 \begin_layout Subsubsection
29181 \begin_layout Standard
29182 This will create a copy of the current document.
29183 Since CVS does not support copy operations natively, the version history
29184 is not preserved, and the copy is added as a new file.
29185 It requires a clean document without any changes since the last checkin.
29186 You are asked for a file name and a description of the copy operation.
29187 After that the copy is created, both locally and in the repository.
29188 If the parent directories of the copied and original document differ, all
29189 relative paths of included files of the copy are adjusted (like in
29191 File\SpecialChar menuseparator
29196 Finally, the copy is loaded instead of the original document.
29199 \begin_layout Labeling
29200 \labelwidthstring 00.00.0000
29202 \begin_inset space ~
29206 \begin_inset space ~
29210 \begin_inset Newline newline
29214 \begin_inset Flex Code
29217 \begin_layout Plain Layout
29224 \begin_inset Flex Code
29227 \begin_layout Plain Layout
29234 \begin_inset Newline newline
29238 \begin_inset Flex Code
29241 \begin_layout Plain Layout
29242 cvs -q add "<new-file-name>"
29250 \begin_layout Subsubsection
29256 \begin_layout Standard
29257 This will rename the current document.
29258 Since CVS does not support rename operations natively, the version history
29259 is not preserved, the renamed document is added as a new file, and the
29260 original document is deleted.
29261 It requires a clean document without any changes since the last checkin.
29262 You are asked for a file name and a description of the rename operation.
29263 After that the document is renamed, both locally and in the repository.
29264 If the parent directories of the new and old file names differ, all relative
29265 paths of included files are adjusted (like in
29267 File\SpecialChar menuseparator
29272 Finally, the document is reloaded using the new name.
29275 \begin_layout Labeling
29276 \labelwidthstring 00.00.0000
29278 \begin_inset space ~
29282 \begin_inset space ~
29286 \begin_inset Newline newline
29290 \begin_inset Flex Code
29293 \begin_layout Plain Layout
29300 \begin_inset Flex Code
29303 \begin_layout Plain Layout
29310 \begin_inset Newline newline
29314 \begin_inset Flex Code
29317 \begin_layout Plain Layout
29318 cvs -q add "<new-file-name>"
29324 \begin_inset Newline newline
29328 \begin_inset Flex Code
29331 \begin_layout Plain Layout
29332 cvs -q remove "<file-name>"
29340 \begin_layout Subsubsection
29341 Update of the local directory checkout from repository
29344 \begin_layout Standard
29345 Once your documents gets more complex, containing sub-documents and pictures,
29347 \begin_inset Flex Code
29350 \begin_layout Plain Layout
29356 files and so on using version control becomes more complicated.
29358 supports updating the whole tree in which resides the document.
29359 This become especially useful once you cooperate with people which neither
29360 have detailed knowledge about CVS usage nor they have ambition to commit
29361 additional material to the repository.
29362 You have to organize the files structure so that all external files are
29363 in the same directory or subdirectories of the document.
29364 It's good practice anyway to store multipart documents in an extra directory.
29367 \begin_layout Standard
29369 \begin_inset Flex Code
29372 \begin_layout Plain Layout
29373 Update local directory from repository
29378 command updates the whole directory.
29379 If local changes are detected user is warned before update starts.
29380 In case of merge conflicts both versions of the conflicting document parts
29381 are placed in the final document.
29382 You have to review and correct the result of the merge.
29383 You'll find the conflicts enclosed in pairs of
29384 \begin_inset Flex Code
29387 \begin_layout Plain Layout
29394 \begin_inset Flex Code
29397 \begin_layout Plain Layout
29404 \begin_inset Flex Code
29407 \begin_layout Plain Layout
29414 The first part is your version as before the update operation with the
29415 document name prepended.
29416 The second one is the repository version with the version number after
29418 \begin_inset Flex Code
29421 \begin_layout Plain Layout
29430 \begin_layout Labeling
29431 \labelwidthstring 00.00.0000
29433 \begin_inset space ~
29437 \begin_inset space ~
29441 \begin_inset Newline newline
29445 \begin_inset Flex Code
29448 \begin_layout Plain Layout
29456 (Ask if changes are detected.)
29457 \begin_inset Newline newline
29461 \begin_inset Flex Code
29464 \begin_layout Plain Layout
29465 cd $path; cvs -q update
29475 \begin_layout Standard
29477 \begin_inset Flex Code
29480 \begin_layout Plain Layout
29486 stands for the path to the document.
29489 \begin_layout Subsubsection
29495 \begin_layout Standard
29496 This shows the complete history of the CVS document.
29499 cvs log "<file-name>"
29501 is shown in a browser.
29504 \begin_layout Subsubsection
29508 \begin_layout Standard
29510 supports CVS version number, author name, date and time of last commit.
29511 All those are extracted from
29513 cvs log -r <file-name>
29517 \begin_inset CommandInset ref
29519 reference "subsec:VCS-Revision-Information"
29526 \begin_layout Subsection
29527 SVN commands in \SpecialChar LyX
29531 \begin_layout Standard
29532 SVN is now partially supported by \SpecialChar LyX
29534 You can find the commands in the
29536 File\SpecialChar menuseparator
29538 \begin_inset space ~
29544 Please note that if you use password protected access to repository via
29545 ssh, you will be asked in terminal window.
29547 was tested against SVN 1.5, 1.6, 1.7 and 1.8
29551 \begin_layout Plain Layout
29552 Most of the commands will work with 1.4 too, see
29553 \begin_inset CommandInset ref
29555 reference "subsec:SVN-Repo-Update"
29560 There seems to be currently unresolved permissions problem under SVN 1.8
29561 with reverting changes when file is locked.
29569 \begin_layout Subsubsection
29575 \begin_layout Standard
29576 If your document is not under revision control, this is the only item shown
29578 And if it is under revision control, the
29582 item is not visible.
29585 \begin_layout Standard
29586 This command registers in SVN your document ONLY in case you have already
29587 the documents directory under SVN control (in particular
29592 This means you have to checkout the archive by yourself.
29595 \begin_layout Standard
29596 Then you are asked interactively to supply an initial description of the
29598 Don't forget that registered file is not yet commited.
29601 \begin_layout Standard
29602 SVN command that is run:
29605 \begin_inset Quotes qld
29609 \begin_inset Quotes qld
29615 \begin_layout Standard
29620 to understand the switches.
29623 \begin_layout Subsubsection
29629 \begin_layout Standard
29630 When you are finished editing a file, you commit your changes.
29631 When you do this, you are asked for a description of the changes.
29632 After that changes are commited.
29635 \begin_layout Standard
29640 \begin_layout Plain Layout
29641 In case locking is not enabled.
29643 \begin_inset CommandInset ref
29645 reference "subsec:SVN-File-Locking"
29656 svn commit -q -m"<description>" <file-name>
29659 \begin_layout Subsubsection
29665 \begin_layout Standard
29666 Updates the changes of this file from the repository.
29667 Be sure you understand SVN merging and conflicts resolving before using
29668 this function, because all conflicts has to be resolved manually by you!
29671 \begin_layout Standard
29676 \begin_layout Plain Layout
29684 svn update --non-interactive
29685 \begin_inset Quotes qld
29689 \begin_inset Quotes qld
29695 \begin_layout Subsubsection
29698 Revert To Repository Version
29701 \begin_layout Standard
29702 This will discard all changes made to the document since the last check
29704 You get a warning before changes are discarded.
29707 \begin_layout Standard
29711 \begin_inset Quotes qld
29715 \begin_inset Quotes qld
29721 \begin_layout Subsubsection
29727 \begin_layout Standard
29728 This will create a copy of the current document including the version history.
29729 It requires a clean document without any changes since the last checkin.
29730 You are asked for a file name and a description of the copy operation.
29731 After that the copy is created, both locally and in the repository.
29732 If the parent directories of the copied and original document differ, all
29733 relative paths of included files of the copy are adjusted (like in
29735 File\SpecialChar menuseparator
29740 Finally, the copy is loaded instead of the original document.
29743 \begin_layout Labeling
29744 \labelwidthstring 00.00.0000
29746 \begin_inset space ~
29750 \begin_inset space ~
29754 \begin_inset Newline newline
29758 \begin_inset Flex Code
29761 \begin_layout Plain Layout
29765 \begin_inset Quotes qld
29769 \begin_inset Quotes qld
29773 \begin_inset Quotes qld
29777 \begin_inset Quotes qld
29786 \begin_inset Newline newline
29790 \begin_inset Flex Code
29793 \begin_layout Plain Layout
29802 \begin_layout Subsubsection
29808 \begin_layout Standard
29809 This will rename the current document including the version history.
29810 It requires a clean document without any changes since the last checkin.
29811 You are asked for a file name and a description of the rename operation.
29812 After that the document is renamed, both locally and in the repository.
29813 If the parent directories of the new and old file names differ, all relative
29814 paths of included files are adjusted (like in
29816 File\SpecialChar menuseparator
29821 Finally, the document is reloaded using the new name.
29824 \begin_layout Labeling
29825 \labelwidthstring 00.00.0000
29827 \begin_inset space ~
29831 \begin_inset space ~
29835 \begin_inset Newline newline
29839 \begin_inset Flex Code
29842 \begin_layout Plain Layout
29846 \begin_inset Quotes qld
29850 \begin_inset Quotes qld
29854 \begin_inset Quotes qld
29858 \begin_inset Quotes qld
29867 \begin_inset Newline newline
29871 \begin_inset Flex Code
29874 \begin_layout Plain Layout
29883 \begin_layout Subsubsection
29884 \begin_inset CommandInset label
29886 name "subsec:SVN-Repo-Update"
29890 Update of the local directory checkout from repository
29894 \begin_layout Plain Layout
29895 Note that this command will work only with subversion
29896 \begin_inset Formula $\geqq1.5$
29907 \begin_layout Standard
29908 All the commands above have one shortcoming – they deal with the current
29910 Once your document contains pictures, includes external
29911 \begin_inset Flex Code
29914 \begin_layout Plain Layout
29920 files and so on administration becomes more complicated.
29922 now supports updating the whole tree in which resides the document
29926 \begin_layout Plain Layout
29927 One need to organize the files structure so that all external files are
29928 in the same directory or subdirectories of the document.
29935 This become especially useful once you cooperate with people which neither
29936 know about subversion management nor they have ambition to commit additional
29937 material to the repository.
29941 \begin_layout Standard
29942 \begin_inset Flex Code
29945 \begin_layout Plain Layout
29946 Update local directory from repository
29951 command updates the whole directory and in case of merge conflicts local
29952 version of the files are left, so no unintended data loss occurs.
29953 If local changes are detected user is warned before update starts.
29956 \begin_layout Labeling
29957 \labelwidthstring 00.00.0000
29959 \begin_inset space ~
29963 \begin_inset space ~
29967 \begin_inset Newline newline
29971 \begin_inset Flex Code
29974 \begin_layout Plain Layout
29980 (Ask if changes are detected.)
29981 \begin_inset Newline newline
29985 \begin_inset Flex Code
29988 \begin_layout Plain Layout
29989 svn update --accept mine-full $path
29997 \begin_layout Standard
29999 \begin_inset Flex Code
30002 \begin_layout Plain Layout
30008 stands for the path to the document.
30011 \begin_layout Subsubsection
30017 \begin_layout Standard
30018 This shows the complete history of the SVN document.
30022 \begin_inset Quotes qld
30026 \begin_inset Quotes qld
30031 is shown in a browser.
30034 \begin_layout Subsubsection
30036 \begin_inset CommandInset label
30038 name "subsec:SVN-File-Locking"
30045 \begin_layout Standard
30046 The file exchange through various revision control systems brings the problem
30047 of merge conflicts in case two different users try to edit the same (parts
30049 When such a conflict happens it needs manual resolving and one reasonable
30050 alternative is to provide some kind of locking mechanism, which guarantees
30051 that only one user is allowed to edit file at the given time.
30054 \begin_layout Standard
30055 SVN has two such mechanisms to provide mutual exclusivity for file access
30056 – locks and automatic setting of write permissions (see sec.
30058 \begin_inset CommandInset ref
30060 reference "subsec:Automatical-Locking-Property"
30065 \begin_inset Flex Code
30068 \begin_layout Plain Layout
30078 \begin_layout Plain Layout
30079 \begin_inset Flex URL
30082 \begin_layout Plain Layout
30084 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
30095 If this property is detected for a given document \SpecialChar LyX
30096 starts to use SVN locks
30097 for document editing automatically and the whole check-in/out mechanism
30098 switches to the same regimen as for RCS.
30099 This in particular means there are two different modes of file use in \SpecialChar LyX
30103 \begin_layout Itemize
30105 The loaded file is in the read-only mode.
30106 For editing on needs to check-out.
30111 consists of updating from the repository and gaining write lock.
30112 If the lock is not possible to obtain, we remain in unlocked state.
30115 \begin_layout Itemize
30117 The loaded file is in the
30118 \begin_inset Quotes els
30122 \begin_inset Quotes ers
30126 No other user is allowed to edit the file.
30131 consists of commiting changes and releasing write-lock.
30132 If no changes have been made to the document, no commit will be produced
30136 \begin_layout Plain Layout
30137 Don't be puzzled by the fact that you will be asked for commit message anyway.
30142 and only the write-lock will be released.
30145 \begin_layout Standard
30149 \begin_layout Labeling
30150 \labelwidthstring 00.00.0000
30153 svn commit -q -m"<description>" "<file-name>"
30154 \begin_inset Newline newline
30157 svn unlock "<file-name>"
30160 \begin_layout Labeling
30161 \labelwidthstring 00.00.0000
30164 svn update "<file-name>"
30165 \begin_inset Newline newline
30168 svn lock "<file-name>"
30171 \begin_layout Subsubsection
30174 \begin_inset CommandInset label
30176 name "subsec:Automatical-Locking-Property"
30182 Automatic Locking Property
30185 \begin_layout Standard
30186 The above mentioned automatic setting of write permissions of the .lyx file
30189 File\SpecialChar menuseparator
30191 \begin_inset space ~
30194 Control\SpecialChar menuseparator
30195 Use Locking Property
30198 This command is active only when the file is not locked on the svn server
30200 you need to check-out before proceeding).
30203 \begin_layout Labeling
30204 \labelwidthstring 00.00.0000
30206 \begin_inset space ~
30212 \begin_layout Labeling
30213 \labelwidthstring 00.00.0000
30216 svn propset svn:needs-lock ON "<file-name>"
30219 \begin_layout Labeling
30220 \labelwidthstring 00.00.0000
30223 svn propdel svn:needs-lock "<file-name>"
30226 \begin_layout Subsubsection
30227 \begin_inset CommandInset label
30229 name "subsec:VCS-Revision-Information"
30233 Revision Information in Documents
30236 \begin_layout Standard
30237 There are more possibilities how to activate revision information in our
30241 \begin_layout Itemize
30247 \begin_layout Itemize
30248 tree revision information (
30249 \begin_inset Flex Code
30252 \begin_layout Plain Layout
30259 The result is the output of the
30260 \begin_inset Flex Code
30263 \begin_layout Plain Layout
30269 command, the following table gives you an idea, how to read the results.
30272 \begin_layout Standard
30274 \begin_inset Tabular
30275 <lyxtabular version="3" rows="6" columns="2">
30276 <features tabularvalignment="middle">
30277 <column alignment="left" valignment="top">
30278 <column alignment="left" valignment="top">
30280 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
30283 \begin_layout Plain Layout
30291 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
30294 \begin_layout Plain Layout
30304 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
30307 \begin_layout Plain Layout
30313 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
30316 \begin_layout Plain Layout
30317 mixed revision working copy
30324 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
30327 \begin_layout Plain Layout
30333 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
30336 \begin_layout Plain Layout
30337 modified working copy
30344 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
30347 \begin_layout Plain Layout
30353 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
30356 \begin_layout Plain Layout
30357 switched working copy
30364 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
30367 \begin_layout Plain Layout
30373 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
30376 \begin_layout Plain Layout
30377 partial working copy, from a sparse checkout
30384 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
30387 \begin_layout Plain Layout
30393 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
30396 \begin_layout Plain Layout
30397 mixed revision, modified, switched working copy
30410 \begin_layout Itemize
30411 file revision information.
30412 The result comes from parsing the output of
30413 \begin_inset Flex Code
30416 \begin_layout Plain Layout
30418 \begin_inset space ~
30422 \begin_inset space ~
30426 \begin_inset space ~
30435 Supported flags are:
30439 \begin_layout Itemize
30440 version number of the last commit (
30441 \begin_inset Flex Code
30444 \begin_layout Plain Layout
30453 \begin_layout Itemize
30454 author of the last commit (
30455 \begin_inset Flex Code
30458 \begin_layout Plain Layout
30467 \begin_layout Itemize
30468 date of the last commit (
30469 \begin_inset Flex Code
30472 \begin_layout Plain Layout
30481 \begin_layout Itemize
30482 time of the last commit (
30483 \begin_inset Flex Code
30486 \begin_layout Plain Layout
30496 \begin_layout Standard
30497 You can obtain this info via InsetInfo (
30498 \change_inserted 5863208 1564400022
30501 Insert\SpecialChar menuseparator
30502 Field\SpecialChar menuseparator
30503 Version Control Revision
30504 \change_deleted 5863208 1564399852
30509 \begin_inset Flex Code
30512 \begin_layout Plain Layout
30513 info-insert buffer vcs-date
30521 The information will be available only when you have the file stored under
30522 svn managment (i.e.
30524 \begin_inset Flex Code
30527 \begin_layout Plain Layout
30533 directory is available with your document).
30537 \begin_layout Itemize
30538 Another—a hacking one—possibility is to use svn keywords
30542 \begin_layout Plain Layout
30543 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
30549 In short – you set file keywords property (e.g.
30552 svn propset svn:keywords 'Rev' file.lyx
30554 ) and then paste keyword \SpecialChar TeX
30559 \begin_layout Plain Layout
30560 This is an easy way how to ensure that \SpecialChar LyX
30561 won't break the line in the middle
30567 tag in your document (e.g.
30569 \begin_inset Flex Code
30572 \begin_layout Plain Layout
30579 This way svn client will automatically substitute revision number (e.g.
30581 \begin_inset Flex Code
30584 \begin_layout Plain Layout
30590 ) after each update and commit.
30591 There are more problems with this approach.
30592 Firstly, the '$' character is used in \SpecialChar TeX
30593 world for math equations, so any
30594 occurence of math formula
30595 \begin_inset Formula $Rev$
30599 \begin_inset Formula $Rev:59$
30602 in your \SpecialChar LyX
30604 Similarly for other keywords like Id, Date, Author, etc.
30605 Secondly svn output is dependent on your locales, so its very easy that
30606 svn would produce some problematic strings once Date is used.
30607 Thirdly you get the whole 'Rev: 59' string in your document instead of
30609 Until subversion implements user's custom keywords it will be hard to use
30610 this approach reliably or let \SpecialChar LyX
30611 to support it directly.
30614 \begin_layout Subsection
30615 SVN and Windows Environment
30618 \begin_layout Quote
30619 My inclination is to say that if the user cannot figure out the command
30620 line operations on their own fairly quickly, they would be well advised
30621 to use TortoiseSVN.
30627 \begin_layout Subsubsection
30631 \begin_layout Standard
30632 In addition to installing \SpecialChar LyX
30633 , and having access to a Subversion repository,
30634 the user will need to install the Subversion client program.
30635 A Windows installer for the client program is available from
30636 \begin_inset CommandInset href
30639 target "http://www.collab.net/nonav/downloads/subversion/"
30645 The user may also want to install
30646 \begin_inset CommandInset href
30649 target "http://tortoisesvn.tigris.org/"
30654 , which integrates Subversion operations into the context (rightclick) menu
30655 of Windows Explorer.
30656 Operations done outside \SpecialChar LyX
30657 will typically be more convenient using the Explorer
30659 Note that TortoiseSVN is not a replacement for the client program, which
30660 is what \SpecialChar LyX
30664 \begin_layout Subsubsection
30665 Bringing a document under Subversion control
30668 \begin_layout Standard
30669 Before a \SpecialChar LyX
30670 document can be brought under version control in Subversion, its
30671 parent directory needs to be under version control.
30672 If the document is being added to a project already in the repository,
30673 this is accomplished by checking the project out to the directory where
30674 the new document will be placed.
30675 If the project itself is not yet under version control (for instance, if
30676 this document starts a new project), the directory must be imported into
30678 This is done outside \SpecialChar LyX
30680 Both import and checkout are easily accomplished from the Explorer context
30681 menu using TortoiseSVN, or alternatively can be done using the command
30682 line client at a DOS prompt.
30683 The procedure for importing the project using TortoiseSVN is described
30684 below, assuming an existing repository and a new project being started
30692 For information on using the Subversion client program, run
30699 \begin_layout Enumerate
30706 in Windows Explorer, right click it, and select
30708 TortoiseSVN\SpecialChar menuseparator
30712 If necessary, adjust the URL for the repository, then click OK.
30715 \begin_layout Enumerate
30716 Right click the level of the repository under which you want to place the
30717 new project folder (typically the top level) and click
30721 Supply a name for the project folder and click OK.
30722 Add a message for the log file if desired, then click OK again.
30723 The new project folder should appear in the repository.
30724 Finally, click OK again to exit the repository browser.
30727 \begin_layout Enumerate
30728 Once again right click
30734 , this time selecting SVN Checkout\SpecialChar ldots
30735 Select the URL of the project folder
30736 you just created in the repository, and set the checkout directory to
30744 You will be warned about a non-empty folder; click OK to proceed.
30745 You should now have a
30756 \begin_layout Enumerate
30757 Create or open your document in \SpecialChar LyX
30760 File\SpecialChar menuseparator
30762 \begin_inset space ~
30765 Control\SpecialChar menuseparator
30769 Add a log message and click OK to commit the document to version control.
30772 \begin_layout Standard
30773 From this point onward, you should have full functionality in the
30775 File\SpecialChar menuseparator
30777 \begin_inset space ~
30783 You also have the option of checking the document in and out, viewing its
30785 using the TortoiseSVN context menu in Windows Explorer or the Subversion
30786 client program from a command prompt.
30789 \begin_layout Subsubsection
30790 SSH tunnel used with SVN under Windows
30793 \begin_layout Standard
30794 Compared with Linux setting up an svn client to communicate over ssh under
30795 Windows is a rather troublesome task.
30796 We will at least offer some hints how to setup the client side but prior
30797 knowledge about ssh and the Windows command line is needed, also be prepared
30798 for a great deal of frustration\SpecialChar ldots
30802 \begin_layout Enumerate
30803 Get an svn client for windows, as described in the previous sections.
30804 When it is a fresh install run some svn command (e.g.
30806 \begin_inset Flex Code
30809 \begin_layout Plain Layout
30815 ) to create config files, which you will need to change later on.
30818 \begin_layout Enumerate
30819 Choose an ssh client for Windows.
30820 There are several possibilities, we will use the one from Putty tools
30824 \begin_layout Plain Layout
30825 \begin_inset Flex URL
30828 \begin_layout Plain Layout
30830 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
30841 You will need to set the connection up so that the client doesn't ask for
30842 any password from you.
30843 To keep things easy we will use only keys without any additional password
30848 \begin_layout Enumerate
30850 \begin_inset Flex Code
30853 \begin_layout Plain Layout
30860 Save your private .ppk key file and put the public one on the server side.
30861 If the SVN server runs on Linux, note that the format of the public key
30862 is not compatible with Linux openssh and you will need to direcly copy-paste
30864 \begin_inset Quotes eld
30869 Public key for pasting into OpenSSH authorized_keys file
30872 \begin_inset Quotes erd
30875 edit field into the server's
30876 \begin_inset Flex Code
30879 \begin_layout Plain Layout
30880 ~/.ssh/authorized_keys
30886 \begin_inset Flex Code
30889 \begin_layout Plain Layout
30898 \begin_layout Enumerate
30900 \begin_inset Flex Code
30903 \begin_layout Plain Layout
30910 In the SVN config file
30914 \begin_layout Plain Layout
30915 Exact path depends on Windows version, usually somewhere around
30916 \begin_inset Flex Code
30919 \begin_layout Plain Layout
30922 Documents and Settings
30936 \begin_inset Flex Code
30939 \begin_layout Plain Layout
30954 , section [tunnels], setup ssh command, e.g.
30956 \begin_inset Flex Code
30959 \begin_layout Plain Layout
30960 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
30969 \begin_layout Plain Layout
30970 It will usually take a lot of time to get exact command right and it depends
30972 For example do not have some remote server saved as a default session in
30974 If things fail, try to connect via plink without SVN first.
30983 \begin_layout Enumerate
30984 Checkout the SVN archive, e.
30985 \begin_inset space \thinspace{}
30989 \begin_inset Newline newline
30993 \begin_inset Flex Code
30996 \begin_layout Plain Layout
30997 svn co svn+ssh://user@server/repository_path
31005 \begin_layout Subsubsection
31006 End-of-Line Conversions
31009 \begin_layout Standard
31010 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
31012 use different line endings inside the .lyx files.
31013 This is not a problem as far as \SpecialChar LyX
31014 functionality is concerned, but the commit
31015 diffs will be huge and merge-conflicts prone.
31016 Fortunately SVN itself knows
31020 \begin_layout Plain Layout
31021 \begin_inset Flex URL
31024 \begin_layout Plain Layout
31026 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
31036 how to deal with CR/LF problems when switching .lyx files to the
31037 \begin_inset Flex Code
31040 \begin_layout Plain Layout
31050 \begin_layout Plain Layout
31052 \begin_inset Flex Code
31055 \begin_layout Plain Layout
31056 svn propset svn:eol-style native FILE_NAME
31069 \begin_layout Subsection
31070 GIT commands in \SpecialChar LyX
31074 \begin_layout Standard
31075 A minimal subset of GIT commands is now supported by \SpecialChar LyX
31077 You can find the commands in the
31079 File\SpecialChar menuseparator
31081 \begin_inset space ~
31087 Please note that if you use password protected access to repository via
31088 ssh, you will be asked in terminal window.
31090 was tested against GIT 1.7.
31094 \begin_layout Plain Layout
31095 Windows users please note that you need to ensure that git is on the path.
31096 This can be set from within \SpecialChar LyX
31099 Tools\SpecialChar menuseparator
31100 Preferences\SpecialChar menuseparator
31101 Paths\SpecialChar menuseparator
31112 \begin_layout Standard
31113 One big difference of GIT and the other supported version control systems
31114 is the distributed nature of GIT: With traditional version control systems
31115 there is one central server which hosts the repository.
31116 Users commit their changes to the server, and get updates made by other
31118 With GIT, users commit to a local repository.
31119 The local repository can be synchronized with one or more remote repositories
31121 \begin_inset Flex Code
31124 \begin_layout Plain Layout
31131 \begin_inset Flex Code
31134 \begin_layout Plain Layout
31142 does not interact in any way with remote GIT repositories.
31143 It works exclusively with the local repository in a very similar way as
31144 with a central CVS or SVN repository.
31145 If you use remote GIT repositories you need to do the
31146 \begin_inset Flex Code
31149 \begin_layout Plain Layout
31156 \begin_inset Flex Code
31159 \begin_layout Plain Layout
31165 operations with your favourite GIT client.
31168 \begin_layout Subsubsection
31174 \begin_layout Standard
31175 If your document is not under revision control, this is the only item shown
31177 And if it is under revision control, the
31181 item is not visible.
31184 \begin_layout Standard
31185 This command registers in GIT your document ONLY in case you have already
31186 the documents directory under GIT control (in particular
31191 This means you have to checkout the archive by yourself.
31194 \begin_layout Standard
31195 Then you are asked interactively to supply an initial description of the
31197 Don't forget that registered file is not yet committed.
31200 \begin_layout Standard
31201 GIT command that is run:
31204 \begin_inset Quotes qld
31208 \begin_inset Quotes qld
31214 \begin_layout Standard
31219 to understand the switches.
31222 \begin_layout Subsubsection
31228 \begin_layout Standard
31229 When you are finished editing a file, you commit your changes.
31230 When you do this, you are asked for a description of the changes.
31231 After that changes are committed.
31234 \begin_layout Standard
31237 git commit -q -m"<description>" <file-name>
31240 \begin_layout Subsubsection
31243 Revert To Repository Version
31246 \begin_layout Standard
31247 This will discard all changes made to the document since the last check
31249 You get a warning before changes are discarded.
31252 \begin_layout Standard
31256 \begin_inset Quotes qld
31260 \begin_inset Quotes qld
31266 \begin_layout Subsubsection
31272 \begin_layout Standard
31273 This will rename the current document including the version history.
31274 It requires a clean document without any changes since the last checkin.
31275 You are asked for a file name and a description of the rename operation.
31276 After that the document is renamed, both locally and in the repository.
31277 If the parent directories of the new and old file names differ, all relative
31278 paths of included files are adjusted (like in
31280 File\SpecialChar menuseparator
31285 Finally, the document is reloaded using the new name.
31288 \begin_layout Labeling
31289 \labelwidthstring 00.00.0000
31291 \begin_inset space ~
31295 \begin_inset space ~
31299 \begin_inset Newline newline
31303 \begin_inset Flex Code
31306 \begin_layout Plain Layout
31310 \begin_inset Quotes qld
31314 \begin_inset Quotes qld
31318 \begin_inset Quotes qld
31322 \begin_inset Quotes qld
31331 \begin_inset Newline newline
31335 \begin_inset Flex Code
31338 \begin_layout Plain Layout
31347 \begin_layout Subsubsection
31353 \begin_layout Standard
31354 This shows the complete history of the GIT document.
31358 \begin_inset Quotes qld
31362 \begin_inset Quotes qld
31367 is shown in a browser.
31370 \begin_layout Subsubsection
31374 \begin_layout Standard
31376 supports GIT hash number of the last commit to the file,
31377 \change_inserted 1119979965 1564297456
31378 its abbreviated form,
31380 author name, date and time of last commit.
31381 All those are extracted from
31383 git log -n 1 --pretty=format:%H%n
31384 \change_inserted 1119979965 1564297427
31390 Tree version information is obtained via
31392 git describe --abbrev --dirty --long
31396 \begin_inset CommandInset ref
31398 reference "subsec:VCS-Revision-Information"
31405 \begin_layout Subsection
31409 \begin_layout Standard
31410 With the recent addition of the
31411 \begin_inset Flex Code
31414 \begin_layout Plain Layout
31420 function \SpecialChar LyX
31421 power users are allowed to create their own commands for revision
31425 \begin_layout Standard
31426 As an example you can see how two TortoiseSVN commands could be integrated
31430 \begin_layout Description
31432 \begin_inset Flex Code
31435 \begin_layout Plain Layout
31436 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
31444 \begin_layout Description
31446 \begin_inset Flex Code
31449 \begin_layout Plain Layout
31450 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
31458 \begin_layout Subsection
31459 Version control and Document comparison
31462 \begin_layout Standard
31463 One of the typical uses of version control is to inspect the changes between
31464 revisions, usually by creating
31465 \begin_inset Flex Code
31468 \begin_layout Plain Layout
31475 While this is useful for plain text files, it is much less useful in the
31476 case of \SpecialChar LyX
31477 files, which have more a complicated structure.
31478 Hence we provide binding to the Document comparison feature.
31479 There are two ways of calling this feature – either by direct call of
31480 \begin_inset Flex Code
31483 \begin_layout Plain Layout
31490 function (for details see \SpecialChar LyX
31491 functions manual) or by the toolbar icon
31504 One can either compare two chosen revisions of the document or he can simply
31505 compare the current version of edited text with older revisions (where
31507 \begin_inset Flex Noun
31510 \begin_layout Plain Layout
31516 ' revisions back means comparison of the edited file with last commited
31521 \begin_layout Standard
31522 This feature is supported for SVN and RCS though due to the more complicated
31523 versioning scheme of RCS there is a constraint – when addressing the revisions
31524 in dialog, numbers always point to the last number in RCS revision number,
31527 We don't currently support GIT addressing of revisions, one can just compare
31528 edited document with its revision X steps backs, where X is addressed as
31530 \begin_inset Flex Code
31533 \begin_layout Plain Layout
31542 \begin_layout Section
31543 Literate Programming
31546 \begin_layout Standard
31551 (kayvan@sylvan.com)
31555 original documentation written by
31557 Edmar Wienskoski Jr.
31560 (edmar-w-jr@technologist.com)
31563 \begin_layout Subsection
31567 \begin_layout Standard
31568 The main purpose of this documentation is to show you how to use \SpecialChar LyX
31570 programming, where it is assumed that you are familiar with this programming
31571 technique, and know what
31572 \begin_inset Quotes eld
31576 \begin_inset Quotes erd
31580 \begin_inset Quotes eld
31584 \begin_inset Quotes erd
31588 If that is not the case, please follow the web links provided in the following
31590 There is a lot of good documentation out there covering old development
31591 history to the latest tools tips.
31594 \begin_layout Standard
31595 It is also assumed that you are familiar with \SpecialChar LyX
31596 itself to a point that you
31597 are comfortable changing your \SpecialChar LyX
31598 preferences, and X resources file.
31599 If that is not the case please refer to other \SpecialChar LyX
31600 documentation to cover your
31604 \begin_layout Subsection
31605 Literate Programming
31608 \begin_layout Standard
31609 From the Literate Programming FAQ:
31612 \begin_layout Quotation
31613 Literate programming is the combination of documentation and source together
31614 in a fashion suited for reading by human beings.
31615 In fact, literate programs should be enjoyable reading, even inviting!
31616 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
31617 and documentation in a single file.
31618 Literate programming tools then parse the file to produce either readable
31619 documentation or compilable source.
31620 The WEB style of literate programming was created by D.
31621 \begin_inset space \thinspace{}
31625 Knuth during the development of his \SpecialChar TeX
31626 typesetting software.
31630 \begin_layout Standard
31631 Another excerpt says:
31634 \begin_layout Quotation
31637 How is literate programming different from verbose commenting?
31640 \begin_layout Quotation
31641 There are three distinguishing characteristics.
31642 In order of importance, they are:
31646 \begin_layout Itemize
31647 flexible order of elaboration
31650 \begin_layout Itemize
31651 automatic support for browsing
31654 \begin_layout Itemize
31655 typeset documentation, especially diagrams and mathematics
31659 \begin_layout Standard
31660 Now that I sparked your curiosity, take a look in the references.
31663 \begin_layout Subsubsection
31667 \begin_layout Standard
31668 The complete Literate Programming FAQ can be found at:
31671 \begin_layout Quote
31672 Literate Programming FAQ
31673 \begin_inset Flex URL
31676 \begin_layout Plain Layout
31678 http://www.literateprogramming.com/lpfaq.pdf
31686 \begin_layout Standard
31687 The FAQ lists 23 (twenty three!) different literate programming tools.
31688 Where some are specialized or
31689 \begin_inset Quotes eld
31693 \begin_inset Quotes erd
31696 for particular programming languages, while other have general scope.
31701 for my own use for several reasons:
31704 \begin_layout Itemize
31705 It can generate the documentation either in \SpecialChar LaTeX
31709 \begin_layout Itemize
31710 It has a open architecture, i.
31711 \begin_inset space \thinspace{}
31715 \begin_inset space \space{}
31718 it is easy to plug in new filters
31722 \begin_layout Plain Layout
31727 are programs that read a given data stream and output a manipulated data
31729 That way, a WEB file (consisting of literate code) can be turned into a
31730 file consisting only of C program code or \SpecialChar LaTeX
31736 and to perform special processing that you may need.
31740 \begin_layout Itemize
31741 There is a good selection of filters available already (the HTML is one
31745 \begin_layout Itemize
31749 \begin_layout Standard
31750 The Noweb web page can be found at:
31753 \begin_layout Quote
31755 \begin_inset Flex URL
31758 \begin_layout Plain Layout
31760 https://www.cs.tufts.edu/~nr/noweb/
31768 \begin_layout Standard
31769 Starting from there you can reach many other interesting links and even
31770 some literate program examples.
31773 \begin_layout Subsection
31775 and Literate Programming with Noweb
31778 \begin_layout Standard
31779 The \SpecialChar LyX
31780 support for Literate Programming is provided by using the generic \SpecialChar LyX
31782 converters mechanism.
31783 This support is provided in a
31784 \begin_inset Quotes eld
31788 \begin_inset Quotes erd
31792 \begin_inset space \thinspace{}
31796 \begin_inset space \space{}
31799 you will be able to use this new \SpecialChar LyX
31800 feature with some other literate programming
31801 tool of your choice by just changing your \SpecialChar LyX
31805 \begin_layout Subsubsection
31806 Generating documents and code (weaving and tangling)
31809 \begin_layout Paragraph
31810 Using the noweb module
31813 \begin_layout Standard
31814 If you have installed Noweb and \SpecialChar LyX
31815 successfully, whenever you open a new document,
31816 after you have chosen its document class, use the
31818 Document\SpecialChar menuseparator
31822 \begin_inset Quotes eld
31826 \begin_inset Quotes erd
31830 If Noweb is correctly installed, when you click on the
31831 \begin_inset Quotes eld
31835 \begin_inset Quotes erd
31838 link, you will see the
31839 \begin_inset Quotes eld
31843 \begin_inset Quotes erd
31846 module in the available list and you can add it to your document.
31849 \begin_layout Paragraph
31853 \begin_layout Standard
31855 enables you to write code with a custom inset named
31856 \begin_inset Flex Noun
31859 \begin_layout Plain Layout
31866 Noweb delimits chunks like this:
31869 \begin_layout LyX-Code
31873 \begin_layout LyX-Code
31877 \begin_layout LyX-Code
31881 \begin_layout LyX-Code
31885 \begin_layout LyX-Code
31889 \begin_layout Standard
31890 The problem is that whatever is written in between the << and the
31894 must be taken literally, i.
31895 \begin_inset space \thinspace{}
31899 \begin_inset space \space{}
31903 should be prevented from making any special interpretation of what has
31905 This is also handled by
31906 \begin_inset Flex Noun
31909 \begin_layout Plain Layout
31915 , that works like a normal text inset but has a free spacing capability.
31918 \begin_layout Standard
31919 As a special note, you can also use the
31920 \begin_inset Quotes eld
31924 \begin_inset Quotes erd
31927 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
31931 \begin_layout LyX-Code
31935 \begin_layout LyX-Code
31936 def some_function(args):
31939 \begin_layout LyX-Code
31940 "This is the doc string for this function."
31943 \begin_layout LyX-Code
31944 print "My args: ", args
31947 \begin_layout LyX-Code
31948 @ %def some_function
31951 \begin_layout Standard
31952 For an example of this usage and the resulting cross-reference output, look
31953 at the Literate python program in
31955 LIBDIR/examples/listerrors.lyx
31957 which should make this all clear.
31960 \begin_layout Paragraph
31961 Generating the documentation
31964 \begin_layout Standard
31965 At this point you already have a new document file with a proper document
31966 class, and with some code and text on it.
31967 How do I print it? The answer is simple, you select
31969 View\SpecialChar menuseparator
31973 Just like you would do for a plain document.
31974 No special procedure is required.
31977 \begin_layout Standard
31978 To help orientate you, I will now explain what happens inside \SpecialChar LyX
31982 \begin_layout Enumerate
31985 Update\SpecialChar menuseparator
31988 menu option is chosen, a \SpecialChar LaTeX
31994 \begin_layout Standard
31995 If the document is of any literate class the generated file will be named
31996 with an extension name defined by the
31997 \begin_inset Quotes eld
32001 \begin_inset Quotes erd
32004 format (defined in the Preferences panel), otherwise the file will have
32013 \begin_layout Enumerate
32014 Note that the only difference so far is in the name of the file, no special
32015 processing is required by \SpecialChar LyX
32017 Given that you formatted the code using the
32018 \begin_inset Flex Noun
32021 \begin_layout Plain Layout
32027 inset that, by itself, takes care of the business.
32030 \begin_layout Enumerate
32031 If the document is of any literate class \SpecialChar LyX
32032 will then use the internal \SpecialChar LyX
32034 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
32039 \begin_layout Plain Layout
32040 The converters are defined in the
32042 Tools\SpecialChar menuseparator
32046 \begin_inset Quotes eld
32050 \begin_inset Quotes erd
32062 manual for general information about converters.
32067 to generate the \SpecialChar LaTeX
32072 \begin_layout Standard
32073 Otherwise it will just skip this step.
32077 \begin_layout Enumerate
32078 Finally, \SpecialChar LaTeX
32079 is invoked and the regular post processing continues as in a plain
32083 \begin_layout Standard
32084 Independence from a particular
32085 \begin_inset Quotes eld
32089 \begin_inset Quotes erd
32092 is easily achieved by changing the commands that are run by the various
32096 \begin_layout Paragraph
32097 Generating the code
32100 \begin_layout Standard
32101 When the build menu option is chosen or the corresponding button in the
32102 toolbar is pressed, a \SpecialChar LaTeX
32103 file is generated just like step 1 above.
32104 Next, \SpecialChar LyX
32110 This converter needs to be defined by the user and is not installed by
32111 default, though the Program format is.
32112 This converter (like any other converter) will have two parts:
32115 \begin_layout Enumerate
32116 The converter program itself.
32117 This program performs the conversion from the one format to the other (in
32118 this case, from the Noweb format to the Program pseudo-format).
32121 \begin_layout Enumerate
32122 The error log parser.
32123 This is a program whose sole purpose is to rewrite error messages in a
32124 format that \SpecialChar LyX
32126 This makes it possible for \SpecialChar LyX
32127 to place error boxes in the right places in
32131 \begin_layout Standard
32132 The first part, the
32133 \begin_inset Quotes eld
32137 \begin_inset Quotes erd
32140 setting, should be set to
32143 \begin_layout LyX-Code
32151 \begin_layout Standard
32152 This basically means that \SpecialChar LyX
32154 \begin_inset Quotes eld
32158 \begin_inset Quotes erd
32161 (a program or script) with the name of the Noweb file (normally a file
32162 in the \SpecialChar LyX
32163 temp directory) and the directory path of the original \SpecialChar LyX
32168 \begin_layout Standard
32169 This is an implementation of
32170 \begin_inset Quotes eld
32174 \begin_inset Quotes erd
32177 that you can place in a directory on your path:
32180 \begin_layout LyX-Code
32186 \begin_layout LyX-Code
32192 \begin_layout LyX-Code
32195 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
32198 \begin_layout Standard
32199 The next part of the converter setting is the
32200 \begin_inset Quotes eld
32204 \begin_inset Quotes erd
32207 which is to be set to
32210 \begin_layout LyX-Code
32213 parselog=$$s/scripts/listerrors
32216 \begin_layout Standard
32217 This will run any errors that are generated by the
32218 \begin_inset Quotes eld
32222 \begin_inset Quotes erd
32225 process through the
32226 \begin_inset Quotes eld
32230 \begin_inset Quotes erd
32236 \begin_layout Standard
32237 The build will normally take place in \SpecialChar LyX
32238 's temporary directory, so the files
32239 produced by the conversion will be in that directory.
32241 will copy out what it regards as the `main' file, but the
32245 conversion may produce several files, and so most of these would then be
32246 deleted when \SpecialChar LyX
32248 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
32249 the build-script chunk can place the generated files in that location.
32252 \begin_layout Paragraph
32253 Build instructions in the document
32256 \begin_layout Standard
32257 The last piece of the integration between \SpecialChar LyX
32259 \begin_inset Quotes eld
32263 \begin_inset Quotes erd
32267 Generally, the instructions for building your program should be embedded
32268 in a chunk of its own.
32270 \begin_inset Quotes eld
32274 \begin_inset Quotes erd
32277 above uses the notangle command to look for this chunk (called
32278 \begin_inset Quotes eld
32282 \begin_inset Quotes erd
32285 ) and runs its contents through
32286 \begin_inset Quotes eld
32290 \begin_inset Quotes erd
32296 \begin_layout Standard
32297 Typically, such a chunk would look something like this:
32300 \begin_layout LyX-Code
32304 \begin_layout LyX-Code
32306 \begin_inset Newline newline
32309 if [ -z "${NOWEB_SOURCE}" ]
32310 \begin_inset Newline newline
32316 \begin_layout LyX-Code
32317 NOWEB_SOURCE=myfile.nw
32318 \begin_inset Newline newline
32322 \begin_inset Newline newline
32326 code to extract files ...
32327 use NOWEB_OUTPUT_DIR here ...]
32328 \begin_inset Newline newline
32332 code to compile files ...]
32333 \begin_inset Newline newline
32339 \begin_layout Standard
32342 LIBDIR/examples/listerrors.lyx
32346 LIBDIR/examples/Literate.lyx
32348 which implement two versions of the
32349 \begin_inset Quotes eld
32353 \begin_inset Quotes erd
32356 program for some illustrations of how all of these pieces go together or
32359 LIBDIR/examples/noweb2lyx.lyx.
32362 Interestingly, these three files show off the language-indepence of the
32364 literate programming support since they are written in Python, C and Perl
32368 \begin_layout Subsubsection
32369 Configuring \SpecialChar LyX
32373 \begin_layout Standard
32374 All the Literate Programming support is configured by the
32376 Tools\SpecialChar menuseparator
32380 \begin_inset Quotes eld
32384 \begin_inset Quotes erd
32388 The important parts are:
32391 \begin_layout Description
32393 \begin_inset space ~
32397 \begin_inset Quotes eld
32401 \begin_inset Quotes erd
32405 \begin_inset space ~
32408 format Set up via the File Formats tab, this is where the Noweb-specific
32418 , the file extension is set to
32423 This tells \SpecialChar LyX
32424 to create a file with a
32428 extension in the first step of the conversion process.
32431 \begin_layout Description
32433 \begin_inset space ~
32441 \begin_inset space ~
32444 format This is an empty format whose sole purpose is to be the endpoint
32445 of a conversion (which then allows us to set up a converter for it).
32448 \begin_layout Description
32458 This converter performs the
32459 \begin_inset Quotes eld
32463 \begin_inset Quotes erd
32466 of the literate document.
32467 For Noweb, it is set to
32468 \begin_inset Quotes eld
32473 noweave -delay -index $$i > $$o
32476 \begin_inset Quotes erd
32482 \begin_layout Description
32492 \begin_inset Quotes eld
32496 \begin_inset Quotes erd
32500 As stated above, the Converter is set to
32501 \begin_inset Quotes eld
32509 \begin_inset Quotes erd
32512 , with Flags set to
32513 \begin_inset Newline newline
32517 \begin_inset Quotes eld
32522 parselog=$$s/scripts/listerrors
32525 \begin_inset Quotes erd
32531 \begin_layout Subsubsection
32535 \begin_layout Standard
32536 There is also a new function implemented in the \SpecialChar LyX
32538 \begin_inset Quotes eld
32541 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
32545 \begin_layout Standard
32546 When debugging code with ddd/gdb, it is possible to invoke a text editor
32547 at the current execution position with a single key stroke.
32548 The default ddd configuration for that is shift-ctrl-V.
32549 It happens that you can define the editor command line invocation in ddd
32552 Edit\SpecialChar menuseparator
32553 Preferences\SpecialChar menuseparator
32556 dialog and changing the "Edit Sources" entry.
32559 \begin_layout Standard
32560 I take advantage of the newly created \SpecialChar LyX
32561 server function and this ddd feature,
32563 \begin_inset Quotes eld
32567 \begin_inset Quotes erd
32573 \begin_layout LyX-Code
32574 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
32577 \begin_layout Standard
32578 With this, whenever you are using ddd and find a point in the program that
32579 you want to edit, you just press shift-ctrl-V (in the ddd window), and
32580 ddd will forward this information to \SpecialChar LyX
32581 through the \SpecialChar LyX
32582 server and then the
32584 window will show the same file with the cursor at the same position ddd
32586 No more guessing or long scrolling to locate a point in the program back
32590 \begin_layout Standard
32591 Note however that you must enable the \SpecialChar LyX
32592 server to get this feature working
32593 (it is disabled by default).
32595 \begin_inset space ~
32599 \begin_inset CommandInset ref
32601 reference "sec:Starting-the-Server"
32605 explains how to do that.
32608 \begin_layout Subsubsection
32612 \begin_layout Standard
32613 There are six new buttons that can be added to your \SpecialChar LyX
32615 Four of these buttons are short cuts to layout styles:
32633 , one for the custom inset
32638 The last one is a short cut to the
32639 \begin_inset Quotes eld
32643 \begin_inset Quotes erd
32650 \begin_layout Standard
32652 has a range of buttons that are available for tool bar customization.
32653 In my toolbar I like to combine the six short cuts above with two more:
32658 \SpecialChar menuseparator
32663 \SpecialChar menuseparator
32670 Document\SpecialChar menuseparator
32671 View\SpecialChar menuseparator
32675 Here is how it looks like:
32678 \begin_layout LyX-Code
32682 \begin_layout LyX-Code
32686 \begin_layout LyX-Code
32687 Icon "layout Standard"
32690 \begin_layout LyX-Code
32691 Icon "layout Section"
32694 \begin_layout LyX-Code
32695 Icon "layout \SpecialChar LaTeX
32699 \begin_layout LyX-Code
32700 Icon "layout \SpecialChar LyX
32704 \begin_layout LyX-Code
32705 Icon "flex.insert Chunk"
32708 \begin_layout LyX-Code
32712 \begin_layout LyX-Code
32716 \begin_layout LyX-Code
32717 Icon "buffer-typeset"
32720 \begin_layout LyX-Code
32721 Icon "build-program"
32724 \begin_layout LyX-Code
32728 \begin_layout LyX-Code
32732 \begin_layout LyX-Code
32736 \begin_layout LyX-Code
32740 \begin_layout LyX-Code
32744 \begin_layout Subsubsection
32745 Colors customization
32748 \begin_layout Standard
32749 There are a number of colors in \SpecialChar LyX
32750 that can be customized in
32755 One of the things that bothers people is the \SpecialChar LaTeX
32757 The default color is red, since the chunks uses \SpecialChar LaTeX
32758 font, and there is a lot
32759 of chunks in literate documents, you may get tired of seeing everything
32761 You can change it by going to the tabs
32770 \begin_layout Standard
32771 The next thing is the visible presence of the newline character in the screen.
32772 You can choose the color of this particular character and make it blend
32774 I recommend you choosing a color that is close to the background but not
32775 equal, that way you still can see it is there, but it is not bothering
32779 \begin_layout Subsection
32784 \begin_layout Standard
32794 \change_deleted 564990737 1671643409
32800 \change_inserted 564990737 1671643443
32804 File\SpecialChar menuseparator
32805 Open Example\SpecialChar menuseparator
32806 Modules\SpecialChar menuseparator
32813 \change_deleted 564990737 1671643461
32814 the Sweave manual (menu
32816 Help\SpecialChar menuseparator
32820 \change_inserted 564990737 1671643461
32824 Help\SpecialChar menuseparator
32825 Specific Manuals\SpecialChar menuseparator
32834 \begin_layout Chapter
32836 \change_deleted 564990737 1671355343
32840 \begin_layout Standard
32842 \change_deleted 564990737 1671355343
32843 You can do everything with \SpecialChar LyX
32844 that you can do with \SpecialChar LaTeX
32846 However, \SpecialChar LyX
32847 cannot support every \SpecialChar LaTeX
32849 But you can always use \SpecialChar TeX
32851 This chapter shows you some more special things you might want to use.
32852 For other special things you can do with figures, tables, floats, boxes
32853 and notes, have a look at the
32856 \begin_inset space ~