1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that the manual prints
12 % out as advertised. If you mess with this preamble,
13 % parts of the manual may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC are numbered roman
19 % and a PDF-bookmark for the TOC is added
21 \let\myTOC\tableofcontents
22 \renewcommand{\tableofcontents}{%
23 \pdfbookmark[1]{\contentsname}{}
26 \pagenumbering{arabic}}
28 % extra space for tables
29 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
31 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
32 \use_default_options false
42 \maintain_unincluded_children no
44 \language_package default
47 \font_roman "lmodern" "default"
48 \font_sans "lmss" "default"
49 \font_typewriter "lmtt" "default"
50 \font_math "auto" "auto"
51 \font_default_family default
52 \use_non_tex_fonts false
56 \font_typewriter_osf false
57 \font_sf_scale 100 100
58 \font_tt_scale 100 100
60 \use_dash_ligatures true
62 \default_output_format pdf2
64 \bibtex_command default
65 \index_command default
66 \float_placement class
67 \float_alignment class
71 \pdf_title "LyX's Additional Features manual"
72 \pdf_author "LyX Team"
73 \pdf_subject "LyX's additional features documentation"
74 \pdf_keywords "LyX, Documentation, Additional"
76 \pdf_bookmarksnumbered true
77 \pdf_bookmarksopen false
78 \pdf_bookmarksopenlevel 1
83 \pdf_pdfusetitle false
84 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
87 \use_package amsmath 1
88 \use_package amssymb 1
91 \use_package mathdots 1
92 \use_package mathtools 1
94 \use_package stackrel 1
95 \use_package stmaryrd 1
96 \use_package undertilde 1
98 \cite_engine_type default
102 \paperorientation portrait
108 \notefontcolor #0000ff
115 \paragraph_separation indent
116 \paragraph_indentation default
118 \math_indentation default
119 \math_numbering_side default
120 \quotes_style english
124 \paperpagestyle headings
126 \tracking_changes true
127 \output_changes false
129 \postpone_fragile_content false
133 \docbook_table_output 0
134 \docbook_mathml_prefix 1
135 \author -712698321 "Jürgen Spitzmüller"
138 \author 244031559 "Yuriy"
139 \author 564990737 "John Lyx"
140 \author 630872221 "Jean-Pierre Chrétien" jeanpierre.chretien@free.fr
141 \author 1075283030 "Thibaut"
142 \author 1119979965 "Joel A. Kulesza"
148 Additional \SpecialChar LyX
152 \begin_layout Subtitle
154 \change_deleted 630872221 1622909155
156 \change_inserted 630872221 1622909155
163 by the \SpecialChar LyX
168 \begin_layout Plain Layout
170 Principal maintainer of this file is
172 Richard Kimberly Heck
175 If you have comments or error corrections, please send them to the \SpecialChar LyX
178 \begin_inset Flex Code
181 \begin_layout Plain Layout
182 <lyx-docs@lists.lyx.org>
195 \begin_layout Standard
196 \begin_inset CommandInset toc
197 LatexCommand tableofcontents
204 \begin_layout Chapter
208 \begin_layout Standard
209 This manual is essentially Part II of the
211 User's Guide\SpecialChar endofsentence
214 The reason for separating the two documents is simple: the
218 is already quite lengthy, and it contains information on all of the basic
219 features one needs to know in order to prepare most documents.
220 However, the \SpecialChar LyX
221 Team has worked to make \SpecialChar LyX
222 extensible through various configuration
223 files and external packages.
224 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
226 create a layout file (or module) for it without having to alter \SpecialChar LyX
228 We've already had contributions of several new features this way, and some
229 of them are documented here.
230 There are also some more `advanced' features, such as how to control the
231 presentation of bibliographies and how to work with multi-part documents,
232 that are not covered in the
236 and are discussed here.
239 \begin_layout Standard
240 This manual also documents some special features, like fax support
241 \change_deleted 244031559 1603802929
243 \change_inserted 244031559 1603802931
247 \change_deleted 244031559 1603802954
250 , which require additional software to work properly.
251 There is also a chapter on \SpecialChar LyX
253 And lastly, there's a chapter of \SpecialChar LaTeX
254 tools and tips, things you can use to
255 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
257 After all, \SpecialChar LyX
262 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
266 \begin_layout Standard
267 If you haven't read the
271 yet, you are definitely in the wrong manual.
276 is the first place to go, since it describes the notation and format of
278 You should also be thoroughly familiar with the
282 and all of the basic features of \SpecialChar LyX
283 before attempting to read this one.
286 \begin_layout Standard
287 Since many of the topics in this manual depend heavily on \SpecialChar LyX
289 with \SpecialChar LaTeX
290 , this first chapter covers the inner workings of \SpecialChar LyX
293 to generate exactly the \SpecialChar LaTeX
295 It is obviously for more seasoned \SpecialChar LyX
299 \begin_layout Chapter
301 and \SpecialChar LaTeX
305 \begin_layout Section
307 Uses \SpecialChar LaTeX
311 \begin_layout Standard
312 This chapter is for both \SpecialChar TeX
313 -nicians and the \SpecialChar LaTeX
315 In it, we'll explain how \SpecialChar LyX
316 and \SpecialChar LaTeX
317 work together to produce printable output.
318 This is the only place in any of the manuals where we assume you know something
319 about \SpecialChar LaTeX
323 \begin_layout Standard
324 At one time, \SpecialChar LyX
326 \begin_inset Quotes eld
329 WYSIWYM frontend to \SpecialChar LaTeX
331 \begin_inset Quotes erd
334 but that's no longer true.
335 There are frontends to \SpecialChar LaTeX
340 \begin_layout Plain Layout
341 Some familar ones are \SpecialChar TeX
342 maker and kile, on Linux, and \SpecialChar TeX
344 There are also the \SpecialChar LaTeX
345 modes for vi and emacs, of course.
350 These are basically text editors with the ability to run \SpecialChar LaTeX
352 errors in the file you're editing.
353 Although \SpecialChar LyX
362 run \SpecialChar LaTeX
363 , and it also indicates errors in the file, it also does much, much
365 For one thing, you don't need to know \SpecialChar LaTeX
366 to use \SpecialChar LyX
369 has added its own extensions to \SpecialChar LaTeX
371 Try the following sometime: select
372 \begin_inset Flex Noun
375 \begin_layout Plain Layout
376 Export\SpecialChar menuseparator
383 \begin_inset Flex Noun
386 \begin_layout Plain Layout
393 \begin_inset Flex Noun
396 \begin_layout Plain Layout
397 View\SpecialChar menuseparator
407 ), then look at the preamble of the resulting
408 \begin_inset Flex Code
411 \begin_layout Plain Layout
418 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
420 These macros are defined automatically, according to the features you use
424 \begin_layout Standard
425 There are several commands that automatically invoke \SpecialChar LaTeX
430 \begin_layout Itemize
431 \begin_inset Flex Noun
434 \begin_layout Plain Layout
435 Document\SpecialChar menuseparator
444 \begin_layout Itemize
445 \begin_inset Flex Noun
448 \begin_layout Plain Layout
449 Document\SpecialChar menuseparator
458 \begin_layout Standard
459 They will only invoke \SpecialChar LaTeX
460 if the file has changed since the last time \SpecialChar LaTeX
466 \begin_layout Standard
467 When \SpecialChar LyX
468 runs \SpecialChar LaTeX
469 on the file you're editing, it performs these steps:
472 \begin_layout Enumerate
473 Convert the document to \SpecialChar LaTeX
474 and save to a file with the extension
475 \begin_inset Flex Code
478 \begin_layout Plain Layout
485 \begin_inset Flex Code
488 \begin_layout Plain Layout
497 \begin_layout Enumerate
498 Run \SpecialChar LaTeX
500 \begin_inset Flex Code
503 \begin_layout Plain Layout
509 file (maybe several times), and run any other commands (such as
510 \begin_inset Flex Code
513 \begin_layout Plain Layout
520 \begin_inset Flex Code
523 \begin_layout Plain Layout
529 ) needed to compile the \SpecialChar LaTeX
533 \begin_layout Enumerate
534 If there are any errors, show the error log.
537 \begin_layout Standard
538 If you have run \SpecialChar LaTeX
540 \begin_inset Flex Noun
543 \begin_layout Plain Layout
544 View\SpecialChar menuseparator
551 then runs a DVI viewer to display the DVI-file.
553 \begin_inset Flex Noun
556 \begin_layout Plain Layout
557 View\SpecialChar menuseparator
564 performs further steps:
567 \begin_layout Enumerate
569 \begin_inset Flex Code
572 \begin_layout Plain Layout
578 to convert the DVI file to PostScript.
581 \begin_layout Enumerate
582 Run a PostScript viewer, such as
583 \begin_inset Flex Code
586 \begin_layout Plain Layout
592 , to display the PostScript file.
595 \begin_layout Standard
597 does similar things when viewing, or exporting, other formats.
600 \begin_layout Section
601 Translating \SpecialChar LaTeX
602 files into \SpecialChar LyX
606 \begin_layout Standard
607 You can import a \SpecialChar LaTeX
608 file into \SpecialChar LyX
610 \begin_inset Flex Noun
613 \begin_layout Plain Layout
614 File\SpecialChar menuseparator
615 Import\SpecialChar menuseparator
621 command in \SpecialChar LyX
623 This will call a program named
624 \begin_inset Flex Code
627 \begin_layout Plain Layout
633 which will create a file
634 \begin_inset Flex Code
637 \begin_layout Plain Layout
644 \begin_inset Flex Code
647 \begin_layout Plain Layout
655 will then open that file.
659 \begin_layout Plain Layout
660 \begin_inset Flex Code
663 \begin_layout Plain Layout
669 can also be run from the command line, of course.
677 \begin_layout Standard
678 \begin_inset Flex Code
681 \begin_layout Plain Layout
687 will translate most legal \SpecialChar LaTeX
688 , but not everything.
689 It will put things it doesn't understand into \SpecialChar TeX
690 code, so after translating
692 \begin_inset Flex Code
695 \begin_layout Plain Layout
701 , you can look for \SpecialChar TeX
702 code and hand-edit it until it looks right.
705 \begin_layout Standard
706 If you don't know what \SpecialChar TeX
707 code is, read the next section.
710 \begin_layout Section
711 \begin_inset CommandInset label
713 name "sec:Inserting-TeX-Code"
717 Inserting \SpecialChar TeX
718 Code into \SpecialChar LyX
722 \begin_layout Standard
723 Anything you can do in \SpecialChar LaTeX
724 you can do in \SpecialChar LyX
725 , for a very simple reason: You can
726 always insert \SpecialChar TeX
727 code into any \SpecialChar LyX
730 cannot, and will never be able to, display every possible \SpecialChar LaTeX
732 If ever you need to insert \SpecialChar LaTeX
733 commands into your \SpecialChar LyX
734 document, you can use the
736 \begin_inset Flex Code
739 \begin_layout Plain Layout
746 box, which you can insert into your document with
747 \begin_inset Flex Noun
750 \begin_layout Plain Layout
751 Insert\SpecialChar menuseparator
761 or the keyboard shortcut
770 \begin_layout Standard
771 Here's an example of inserting \SpecialChar LaTeX
772 commands in a \SpecialChar LyX
774 The code looks like this:
777 \begin_layout LyX-Code
781 \begin_inset Newline newline
787 \begin_inset Newline newline
790 This is an example of a minipage environment.
792 \begin_inset Newline newline
795 can put nearly everything in it, even (non-floating)
796 \begin_inset Newline newline
801 \begin_inset Newline newline
807 \begin_inset Newline newline
811 \begin_inset Newline newline
817 \begin_inset Newline newline
823 \begin_inset Newline newline
829 \begin_inset Newline newline
834 \begin_inset Newline newline
840 \begin_inset Newline newline
846 \begin_inset Newline newline
852 \begin_inset Newline newline
860 \begin_layout LyX-Code
864 \begin_layout Standard
866 \begin_inset Flex Code
869 \begin_layout Plain Layout
876 box containing this text is directly after this paragraph.
877 Those of you reading the manual in \SpecialChar LyX
878 will only see the \SpecialChar TeX
880 Those reading a printed version of the manuals will see the actual results:
881 \begin_inset VSpace bigskip
887 \begin_layout Standard
891 \begin_layout Plain Layout
898 \begin_layout Plain Layout
905 \begin_layout Plain Layout
907 This is an example of a minipage environment.
908 You can put nearly everything in it, even (non-floating) figures and tables.
912 \begin_layout Plain Layout
919 \begin_layout Plain Layout
924 \begin_layout Plain Layout
931 \begin_layout Plain Layout
938 \begin_layout Plain Layout
945 \begin_layout Plain Layout
951 \begin_layout Plain Layout
958 \begin_layout Plain Layout
965 \begin_layout Plain Layout
972 \begin_layout Plain Layout
982 \begin_inset VSpace bigskip
988 \begin_layout Standard
989 In addition to using \SpecialChar TeX
990 code, you can also create a separate file containing
991 some complex \SpecialChar LaTeX
992 structure and then use
993 \begin_inset Flex Noun
996 \begin_layout Plain Layout
997 Insert\SpecialChar menuseparator
1007 to include your file (you should select the type
1008 \begin_inset Flex Code
1011 \begin_layout Plain Layout
1018 We recommend that you only do this if you have a
1019 \begin_inset Flex Code
1022 \begin_layout Plain Layout
1033 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1037 \begin_layout Standard
1038 There are a few last points to emphasize:
1041 \begin_layout Itemize
1047 check if your \SpecialChar LaTeX
1051 \begin_layout Itemize
1052 Beware of reinventing the wheel.
1055 \begin_layout Standard
1056 On that last point, \SpecialChar LyX
1057 does have quite a few features tucked into it, and
1059 Be sure to check the manuals to make sure that \SpecialChar LyX
1060 doesn't have such-and-such
1061 feature before you decide you have to do it by hand.
1062 Moreover, there are numerous \SpecialChar LaTeX
1063 packages out there to do all sorts of things,
1064 from labels to envelopes to fancy multipage tables.
1066 \change_inserted 244031559 1603815732
1068 \begin_inset CommandInset href
1071 target "https://www.ctan.org/"
1077 \change_deleted 244031559 1603815732
1079 \begin_inset CommandInset href
1082 target "http://www.ctan.org/"
1092 \begin_layout Standard
1093 If you do need to do some wild and fancy things within your document, be
1094 sure to check out a good \SpecialChar LaTeX
1095 book for assistance.
1096 There are a number of them listed in the bibliography of the
1103 \begin_layout Section
1105 and the \SpecialChar LaTeX
1109 \begin_layout Subsection
1110 About the \SpecialChar LaTeX
1114 \begin_layout Standard
1115 If you already know \SpecialChar LaTeX
1116 , there is no need to explain here what the preamble
1118 If you don't, the following will give you some ideas—we recommend again
1119 that you consult a \SpecialChar LaTeX
1120 book for further information.
1121 In any case, you should read the points below, because they explain what
1122 you can do and what you don't need to do in the \SpecialChar LaTeX
1123 preamble of a \SpecialChar LyX
1127 \begin_layout Standard
1128 The \SpecialChar LaTeX
1129 preamble comes at the very beginning of a document,
1137 \begin_layout Itemize
1138 Declare the document class.
1140 \begin_inset Newline newline
1144 already does this for you.
1145 If you're a seasoned \SpecialChar LaTeX
1146 -nician, and you have a custom document class you
1147 want to use, check out the
1149 Customization Manual
1151 for information on how to make \SpecialChar LyX
1155 \begin_layout Itemize
1156 Declare the usage of packages.
1158 \begin_inset Newline newline
1162 packages provide special commands, which are only available within a document
1163 when the package has been declared in the preamble.
1164 In addition to providing special commands, the inclusion of a package can
1165 change the document.
1166 For example, the package
1167 \begin_inset Flex Code
1170 \begin_layout Plain Layout
1176 forces all paragraphs to be indented.
1177 There are other packages for labels, envelopes, margins, etc.
1181 \begin_layout Itemize
1182 Set counters, variables, lengths and widths.
1184 \begin_inset Newline newline
1187 There are several \SpecialChar LaTeX
1188 counters and variables that
1192 be set globally from within the preamble in order to have the desired effect.
1193 (There are variables that you can set and reset inside the document, too.)
1194 Margins are a good example of something that must be set in the preamble.
1195 Another example is the label format for lists.
1196 You can actually set these just about anywhere, but it's best to do it
1197 just once, inside the preamble.
1200 \begin_layout Itemize
1201 Declare user defined commands (with
1202 \begin_inset Flex Code
1205 \begin_layout Plain Layout
1214 \begin_inset Flex Code
1217 \begin_layout Plain Layout
1226 \begin_inset Newline newline
1229 These are abbreviations for \SpecialChar LaTeX
1230 commands which appear very often inside a document.
1231 Although the preamble is a good place to declare such commands, they
1235 be declared anywhere (before they are used for the first time, of course).
1236 This can be useful if there is a lot of raw \SpecialChar LaTeX
1237 code in your document, which
1238 normally should not be the case.
1241 \begin_layout Standard
1243 adds its own set of definitions to the preamble of the
1244 \begin_inset Flex Code
1247 \begin_layout Plain Layout
1254 This makes \SpecialChar LaTeX
1255 files generated by \SpecialChar LyX
1259 \begin_layout Subsection
1260 Changing the Preamble
1263 \begin_layout Standard
1264 The commands which \SpecialChar LyX
1265 adds to the preamble of a \SpecialChar LaTeX
1266 file are fixed; you can't
1267 change them without patching \SpecialChar LyX
1269 You can, however, add your own stuff to the preamble by selecting
1270 \begin_inset Flex Noun
1273 \begin_layout Plain Layout
1276 \begin_inset space ~
1285 \begin_inset Flex Noun
1288 \begin_layout Plain Layout
1289 Document\SpecialChar menuseparator
1297 adds anything in the
1298 \begin_inset Flex Noun
1301 \begin_layout Plain Layout
1307 dialog to its own built-in preamble.
1308 Before adding your own declarations in the preamble, you should make sure
1309 that \SpecialChar LyX
1310 doesn't already support what you want to do.
1311 (Remember what we said about reinventing the wheel?) Also,
1313 make sure your preamble code is correct
1317 doesn't check it for you.
1318 If there is an error, you're likely to get an error like
1319 \begin_inset Quotes eld
1323 \begin_inset Flex Code
1326 \begin_layout Plain Layout
1335 \begin_inset Quotes erd
1339 If you see this error, check your preamble.
1342 \begin_layout Subsection
1346 \begin_layout Standard
1347 Here are some examples of what you can add to a preamble, and what they
1351 \begin_layout Subsubsection
1355 \begin_layout Standard
1356 There are two variables under \SpecialChar LaTeX
1357 that control page position:
1358 \begin_inset Flex Code
1361 \begin_layout Plain Layout
1370 \begin_inset Flex Code
1373 \begin_layout Plain Layout
1382 Their names should be self-explanatory.
1383 These variables are useful if you think for a moment about computer labels.
1384 Sometimes, the size of a print medium and the area of the medium that you
1385 can actually print on aren't the same.
1387 \begin_inset Flex Code
1390 \begin_layout Plain Layout
1399 \begin_inset Flex Code
1402 \begin_layout Plain Layout
1413 \begin_layout Standard
1414 The default values for
1415 \begin_inset Flex Code
1418 \begin_layout Plain Layout
1427 \begin_inset Flex Code
1430 \begin_layout Plain Layout
1439 \begin_inset space \thinspace{}
1443 \begin_inset space \thinspace{}
1447 \begin_inset space \space{}
1450 the page isn't shifted.
1451 Unfortunately, some DVI drivers always seem to shift the page.
1452 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1453 If you're using \SpecialChar LyX
1454 on a system that you don't personally maintain, and your
1455 sysadmin is a doofus,
1456 \begin_inset Flex Code
1459 \begin_layout Plain Layout
1468 \begin_inset Flex Code
1471 \begin_layout Plain Layout
1480 Suppose your left and top margins are always 0.5
1481 \begin_inset space \thinspace{}
1485 You can add this to the preamble:
1488 \begin_layout LyX-Code
1496 \begin_layout LyX-Code
1504 \begin_layout Standard
1505 and your margins should now be correct.
1508 \begin_layout Subsubsection
1512 \begin_layout Standard
1513 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1514 There's a rather nice package, available at your nearest CTAN archive,
1515 for printing sheets of labels:
1516 \begin_inset Flex Code
1519 \begin_layout Plain Layout
1526 Now, your system may not have this package installed by default.
1527 We leave that up to you to check.
1528 You'll also want to read the documentation for it; we're not going to do
1530 Since this is an example, however, we'll give you an example of how you
1534 \begin_layout Standard
1535 First, make sure you're using the
1536 \begin_inset Flex Code
1539 \begin_layout Plain Layout
1546 Next, you need to put the following in your preamble:
1549 \begin_layout LyX-Code
1555 \begin_layout LyX-Code
1561 \begin_layout LyX-Code
1567 \begin_layout LyX-Code
1573 \begin_layout LyX-Code
1579 \begin_layout LyX-Code
1585 \begin_layout LyX-Code
1591 \begin_layout Standard
1592 This sets things up for Avery label sheets, stock #5360.
1593 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1596 \begin_inset Flex Code
1599 \begin_layout Plain Layout
1608 \begin_inset Flex Code
1611 \begin_layout Plain Layout
1619 around each label text.
1620 This and other special features of
1621 \begin_inset Flex Code
1624 \begin_layout Plain Layout
1630 are explained in its documentation.
1633 \begin_layout Standard
1634 Someday, someone may write a \SpecialChar LyX
1635 layout file to support this package directly.
1636 Maybe that someone is you.
1639 \begin_layout Subsubsection
1640 Example #3: Paragraph Indentation
1643 \begin_layout Standard
1644 Americans are trained to indent the first line of
1649 As with all of their other weird quirks, most Americans will whine and
1650 moan until they can have their way and indent the first line of all paragraphs.
1659 \begin_layout Standard
1660 Of course, this behavior isn't standard typography.
1661 In books, you typically only indent the first line of a paragraph
1665 it follows another one.
1666 The idea behind indenting the first line of a paragraph is to distinguish
1667 neighboring paragraphs from one another.
1668 If there is no previous paragraph—for example, if it follows a figure or
1669 is the first paragraph in a section—then there is no need for indentation.
1673 \begin_layout Standard
1674 If you're a typical American (we're still joking!), though, you don't care
1675 about such esoteric things; you want your indentation! Add this to the
1679 \begin_layout LyX-Code
1682 usepackage{indentfirst}
1685 \begin_layout Standard
1686 If your \SpecialChar TeX
1687 distribution isn't braindead, you'll have this package, and all
1688 of your paragraphs will get the indentation the Founding Fathers intended
1692 \begin_layout Subsubsection
1693 Example #4: This Document
1696 \begin_layout Standard
1697 You can also check out the preamble of this document to get an idea of some
1698 of the advanced things you can do.
1701 \begin_layout Section
1703 and \SpecialChar LaTeX
1707 \begin_layout Standard
1708 When \SpecialChar LyX
1709 calls \SpecialChar LaTeX
1710 , it tells \SpecialChar LaTeX
1711 to blithely ignore any errors and keep going.
1712 It then uses the logfile from the \SpecialChar LaTeX
1713 run to do a post-mortem.
1714 After analyzing the logfile, \SpecialChar LyX
1715 displays a dialog listing the errors.
1716 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1718 where the error occurred.
1722 \begin_layout Plain Layout
1724 Analyzing the logfile is a tough job, and \SpecialChar LyX
1725 doesn't always go to the right
1727 There are also cases where \SpecialChar LaTeX
1728 reports the error on one line, but the actual
1730 This is not unlike forgetting a closing brace in a program: You'll get
1731 an error, but only later.
1739 \begin_layout Standard
1740 Some folks also like to look at the log file directly: It is available from
1742 \begin_inset Flex Noun
1745 \begin_layout Plain Layout
1746 Document\SpecialChar menuseparator
1748 \begin_inset space ~
1757 There are some fairly common error messages and warnings.
1758 We'll cover those here.
1759 You should look at a good \SpecialChar LaTeX
1760 book for a complete listing.
1763 \begin_layout Itemize
1764 \begin_inset Flex Code
1767 \begin_layout Plain Layout
1774 \begin_inset Newline newline
1777 Anything beginning with these words is a warning message for the purpose
1779 \begin_inset Quotes eld
1783 \begin_inset Quotes erd
1786 the \SpecialChar LaTeX
1788 You'll get messages like this if you added or changed cross-references
1789 or bibliography entries, in which case, \SpecialChar LaTeX
1790 is trying to tell you that you
1791 need to make another run.
1792 You can by-and-large ignore these.
1795 \begin_layout Itemize
1796 \begin_inset Flex Code
1799 \begin_layout Plain Layout
1806 \begin_inset Newline newline
1809 Another warning message, this time about fonts which \SpecialChar LaTeX
1811 The rest of the message will often say something about a replacement font
1812 that \SpecialChar LaTeX
1814 You can safely ignore these, too.
1817 \begin_layout Itemize
1818 \begin_inset Flex Code
1821 \begin_layout Plain Layout
1830 \begin_inset Newline newline
1839 It seems to generate at least one of these messages for just about any
1841 They are warnings about lines that were too long and run past the right
1843 This happens if \SpecialChar LaTeX
1844 does not find a reasonable way to break the lines (notoriously
1845 often with typewriter font, since this does not allow for automatic break
1847 In many cases, this is unnoticeable in the final output.
1848 (It can be just a point or two.) Sometimes, however, the lines run rather
1849 visibly into the margin; something you will not want to have in your final
1852 \begin_inset Newline newline
1855 There are several global ways to try to minimize the overfull lines.
1858 Enable micro-typographic extensions
1862 Document\SpecialChar menuseparator
1863 Settings\SpecialChar menuseparator
1866 might already improve things a lot.
1867 Furthermore, \SpecialChar LaTeX
1868 code such as the following in
1870 Document\SpecialChar menuseparator
1871 Settings\SpecialChar menuseparator
1874 usually reduces the overfull lines drastically (we use this in the preamble
1879 \begin_layout LyX-Code
1883 \begin_inset Newline newline
1889 \begin_inset Newline newline
1894 emergencystretch 1.5em
1895 \begin_inset Newline newline
1903 \begin_layout Standard
1904 In some cases, however, you eventually have to rewrite the text to get the
1905 line breaking right.
1909 \begin_layout Plain Layout
1910 For more information, see
1911 \begin_inset Flex URL
1914 \begin_layout Plain Layout
1916 http://www.tex.ac.uk/FAQ-overfull.html
1929 \begin_layout Standard
1930 In any case, you should check the respective lines, at least for the final
1931 version of your document.
1932 Your eyes will tell you if there's a problem with something that's too
1937 \begin_layout Plain Layout
1938 You can also enable the `draft' option in
1939 \begin_inset Flex Noun
1942 \begin_layout Plain Layout
1943 Document\SpecialChar menuseparator
1949 , and then \SpecialChar LaTeX
1950 will draw a black box in the margin of lines that are overfull.
1959 \begin_layout Itemize
1960 \begin_inset Flex Code
1963 \begin_layout Plain Layout
1972 \begin_inset Newline newline
1975 Not quite as common as its cousin.
1976 This happens again if \SpecialChar LaTeX
1977 does not find a reasonable break point and consequently
1978 generates too loose lines.
1979 As with the overfull lines, you should check if this is a visible problem.
1982 \begin_layout Itemize
1983 \begin_inset Flex Code
1986 \begin_layout Plain Layout
1995 \begin_inset Flex Code
1998 \begin_layout Plain Layout
2007 \begin_inset Newline newline
2010 Warnings about troubles breaking the page.
2011 Once again, just look at the output.
2012 Your eyes will tell you where something has gone wrong.
2015 \begin_layout Itemize
2016 \begin_inset Flex Code
2019 \begin_layout Plain Layout
2021 \begin_inset Quotes els
2025 \begin_inset Quotes ers
2034 \begin_inset Newline newline
2038 \begin_inset Quotes eld
2042 \begin_inset Quotes erd
2045 isn't installed on this system.
2046 This usually appears because some package your document needs isn't installed.
2047 If you didn't touch the preamble or didn't use the
2048 \begin_inset Flex Code
2051 \begin_layout Plain Layout
2059 command, then one of the packages \SpecialChar LyX
2060 tried to load is missing.
2062 \begin_inset Flex Noun
2065 \begin_layout Plain Layout
2066 Help\SpecialChar menuseparator
2073 to get a list of packages that \SpecialChar LyX
2075 This file is updated whenever you reconfigure \SpecialChar LyX
2077 \begin_inset Flex Noun
2080 \begin_layout Plain Layout
2081 Tools\SpecialChar menuseparator
2087 ) and tells you which packages have been detected and what they do.
2088 \begin_inset Newline newline
2092 \begin_inset Flex Code
2095 \begin_layout Plain Layout
2103 command and the package in question isn't installed, then you'll need to
2104 install it yourself.
2107 \begin_layout Itemize
2108 \begin_inset Flex Code
2111 \begin_layout Plain Layout
2112 LaTeX Error: Unknown option
2118 \begin_inset Newline newline
2121 Error messages beginning with this are trying to tell you that you specified
2122 a bad or undefined option to a package.
2123 Check the package's documentation.
2126 \begin_layout Itemize
2127 \begin_inset Flex Code
2130 \begin_layout Plain Layout
2131 Undefined control sequence
2137 \begin_inset Newline newline
2140 If you've inserted \SpecialChar LaTeX
2141 code into your document, but made a typo, you'll get
2143 You may have forgotten to load a package.
2144 In any case, this error message usually means that you used an undefined
2149 \begin_layout Standard
2150 There are other error and warning messages.
2151 Some are self-explanatory.
2152 These are usually \SpecialChar LaTeX
2154 Others are downright cryptic.
2155 These are usually \SpecialChar TeX
2156 error messages, and we really have
2160 what they mean or how to decipher them.
2164 \begin_layout Standard
2165 There's a general sequence you should follow if you get error messages:
2168 \begin_layout Enumerate
2169 Look at the \SpecialChar LaTeX
2170 code you inserted for typos.
2173 \begin_layout Enumerate
2174 If there are no typos, check that you used the command(s) correctly.
2177 \begin_layout Enumerate
2178 If you get a bunch of error boxes piled up at the very top of the document—and
2179 especially if you see a
2180 \begin_inset Quotes eld
2184 \begin_inset Flex Code
2187 \begin_layout Plain Layout
2196 \begin_inset Quotes erd
2199 error—it means that there are errors in the preamble.
2200 Start debugging your preamble.
2203 \begin_layout Enumerate
2204 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2206 document, the first suspect is your \SpecialChar LaTeX
2207 distribution itself.
2208 Check for missing packages and install them.
2211 \begin_layout Enumerate
2212 Okay, so there are no missing packages.
2213 Did you use any of the fine-tuning options in \SpecialChar LyX
2214 ? Specifically, did you
2218 any of them, like trying to manually insert lots of
2219 \begin_inset Flex Code
2222 \begin_layout Plain Layout
2224 \change_deleted 177693 1654669036
2226 \change_inserted 177693 1654669038
2230 \begin_inset space ~
2234 \change_deleted 177693 1654669040
2236 \change_inserted 177693 1654669041
2245 \begin_inset Flex Code
2248 \begin_layout Plain Layout
2255 \begin_inset Flex Code
2258 \begin_layout Plain Layout
2264 ? Did you try to kludge something together with these instead of using the
2265 appropriate paragraph environment?
2268 \begin_layout Enumerate
2269 All right, you didn't use any of the fine-tuning options, you played by
2271 Did you try to pull a fancy maneuver? Did you do something funky inside
2272 a table or an equation, like inserting a graphic into a table cell?
2275 \begin_layout Enumerate
2276 Do you have long sections of text where \SpecialChar LaTeX
2277 cannot find a place to break a
2278 line? By default, \SpecialChar LaTeX
2279 is rather strict about how much extra inter-word spacing
2280 it will add in order to break a line.
2281 Preferably, you should rework the paragraph to avoid the problem.
2284 \begin_layout Enumerate
2285 Did you go overboard with the nesting? \SpecialChar LyX
2286 (currently) doesn't check to make
2287 sure you're in the limits for nesting environments.
2288 If you nested a bunch of environments to the
2289 \begin_inset Formula $17^{\mathrm{th}}$
2292 level, that's the problem.
2293 (The limit in \SpecialChar LaTeX
2297 \begin_layout Enumerate
2298 Okay, you didn't get any error messages, but your output looks awful.
2299 If you have a table or figure that's too wide or long for the page, you
2304 \begin_layout Enumerate
2305 rescale the figure so it fits.
2308 \begin_layout Enumerate
2309 trim down the table so it fits.
2313 \begin_layout Enumerate
2314 If something else is wrong with the output, and you didn't try to pull anything
2315 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2318 \begin_layout Standard
2319 If all this doesn't help—well, then
2323 you might have found a bug in \SpecialChar LyX
2328 \begin_layout Chapter
2330 \change_inserted 564990737 1670439508
2334 \begin_layout Section
2336 \change_inserted 564990737 1670439533
2337 \begin_inset CommandInset label
2339 name "sec:Collections"
2346 \begin_layout Subsection
2347 AMS \SpecialChar LaTeX
2351 \begin_layout Standard
2358 Richard Kimberly Heck
2361 \begin_layout Standard
2362 \begin_inset VSpace bigskip
2368 \begin_layout Standard
2370 The AMS \SpecialChar LaTeX
2371 layouts are set up to conform to suggested styles for mathematical
2372 papers to be submitted to American Mathematical Society publications.
2373 The layouts are not tailored to a specific journal, but easily can be.
2374 You should refer to the AMS documentation for specific instructions for
2375 each journal (usually it will entail only changing a single line in the
2378 That documentation is available on the Web at
2379 \begin_inset Flex URL
2382 \begin_layout Plain Layout
2390 \begin_inset Flex URL
2393 \begin_layout Plain Layout
2395 ftp://ftp.ams.org/pub/tex/amslatex/
2401 These layouts are appropriate, and useful, for any mathematical writing.
2405 \begin_layout Standard
2406 There are two basic AMS \SpecialChar LaTeX
2410 \begin_layout Itemize
2411 amsart: The standard AMS article format.
2414 \begin_layout Itemize
2415 amsbook: the standard AMS book (really, monograph) format.
2419 \begin_layout Standard
2420 The layouts themselves contain only the minimum necessary to use the AMS
2422 They do not, in particular, contain any of the `theorem' environments used
2423 for setting theorems, lemmas, and the like.
2424 These are contained, instead, in the
2425 \begin_inset Flex Code
2428 \begin_layout Plain Layout
2434 module, which is loaded by default when you select one of the AMS classes.
2435 (It can also be used with other classes and can be removed, if you would
2436 rather use something else.) Less commonly used environments are in the
2437 \begin_inset Flex Code
2440 \begin_layout Plain Layout
2441 Theorems (AMS-Extended)
2446 module, which must be loaded manually.
2449 \begin_layout Standard
2450 By default, theorems and the like are numbered consecutively throughout
2451 the document, but this may be modified by loading the module
2452 \begin_inset Flex Code
2455 \begin_layout Plain Layout
2456 Theorems (Order by Section)
2461 or, if you are using
2462 \begin_inset Flex Code
2465 \begin_layout Plain Layout
2472 \begin_inset Flex Code
2475 \begin_layout Plain Layout
2476 Theorems (Order by Chapter)
2482 These will number the results as
2483 \begin_inset Formula $n.m$
2486 , where the first number refers to the section (or chapter) and the second
2487 refers to the total number of results so far in that section (or chapter).
2488 Many environments are also available unnumbered.
2489 These are indicated by an asterisk at the end.
2490 If you happen to want
2494 unnumbered results, the module
2495 \begin_inset Flex Code
2498 \begin_layout Plain Layout
2504 provides that option.
2507 \begin_layout Standard
2508 Note that these modules do not
2512 to be used with the AMS classes.
2513 It is perfectly possible to use the
2514 \begin_inset Flex Code
2517 \begin_layout Plain Layout
2523 module, and the others mentioned, with other classes, such as
2524 \begin_inset Flex Code
2527 \begin_layout Plain Layout
2534 \begin_inset Flex Code
2537 \begin_layout Plain Layout
2544 \begin_inset Flex Code
2547 \begin_layout Plain Layout
2556 \begin_layout Subsubsection
2557 What these layouts provide
2560 \begin_layout Standard
2561 There is a long list of included environments provided by these layouts.
2562 In AMS-\SpecialChar LaTeX
2563 , there is, in fact, an opportunity to define an unlimited variety
2564 of `theorem' environments.
2565 However, the AMS recommends the environments that are available in \SpecialChar LyX
2570 \begin_layout Standard
2571 The following environments—as well as the standard environments, such as
2573 \begin_inset Flex Noun
2576 \begin_layout Plain Layout
2583 \begin_inset Flex Noun
2586 \begin_layout Plain Layout
2593 \begin_inset Flex Noun
2596 \begin_layout Plain Layout
2603 \begin_inset Flex Noun
2606 \begin_layout Plain Layout
2613 \begin_inset Flex Noun
2616 \begin_layout Plain Layout
2623 \begin_inset Flex Code
2626 \begin_layout Plain Layout
2633 \begin_inset Flex Code
2636 \begin_layout Plain Layout
2645 \begin_layout Description
2646 Address This should be the author's permanent address.
2649 \begin_layout Description
2651 \begin_inset space ~
2654 Address This should be the author's temporary address at the time of submission,
2655 if different from the Address.
2658 \begin_layout Description
2659 Email Author's e-mail address
2662 \begin_layout Description
2663 URL Author's Web address, if desired.
2666 \begin_layout Description
2667 Keywords Key words or phrases used to identify specific topics discussed
2671 \begin_layout Description
2672 Subjectclass These refer to the AMS Subject Classifications, published and
2675 Mathematical Reviews
2678 These are also available online at the AMS cites listed above.
2681 \begin_layout Description
2685 \begin_layout Description
2689 \begin_layout Description
2693 \begin_layout Standard
2694 The following environments are provided by both the
2695 \begin_inset Flex Code
2698 \begin_layout Plain Layout
2705 \begin_inset Flex Code
2708 \begin_layout Plain Layout
2714 modules, in the latter case in both starred (unnumbered) and unstarred
2715 (numbered) versions.
2716 These same environments are provided only in the starred versions by the
2718 \begin_inset Flex Code
2721 \begin_layout Plain Layout
2730 \begin_layout Theorem
2731 This is typically used for the statements of major results.
2735 \begin_layout Corollary*
2736 This is used for statements which follow fairly directly from previous statement
2738 Again, these can be major results.
2743 These are smaller results needed to prove other statements.
2746 \begin_layout Proposition
2747 These are less major results which (hopefully) add to the general theory
2751 \begin_layout Conjecture
2752 These are statements provided without justification, which the author does
2753 not know how to prove, but which seem to be true (to the author, at least).
2756 \begin_layout Definition*
2757 Guess what this is for.
2758 The font is different for this environment than for the previous ones.
2762 \begin_layout Example*
2763 Used for examples illustrating proven results.
2766 \begin_layout Problem
2767 It's not really known what this is for.
2768 You should figure it out.
2771 \begin_layout Exercise*
2772 Write a description for this one.
2775 \begin_layout Remark
2776 This environment is also a type of theorem, usually a lesser sort of observation.
2779 \begin_layout Claim*
2780 Often used in the course of giving a proof of a larger result.
2784 Generally, these are used to break up long arguments, using specific instances
2790 The numbering scheme for cases is on its own, not together with other numbered
2796 At the end of this environment, a QED symbol (usually a square, but it can
2797 vary with different styles) is placed.
2798 If you want to have other environments within this one—for example, Case
2799 environments—and have the QED symbol appear only after them, then the other
2800 environments need to be nested within the proof environment.
2803 Nesting Environments
2809 for information on nesting.
2812 \begin_layout Standard
2813 And these environments are provided by
2814 \begin_inset Flex Code
2817 \begin_layout Plain Layout
2818 Theorems (AMS-Extended)
2826 \begin_layout Criterion*
2827 A required condition.
2830 \begin_layout Algorithm*
2831 A general procedure to be used.
2834 \begin_layout Axiom*
2835 This is a property or statement taken as true within the system being discussed.
2838 \begin_layout Condition*
2839 Sometimes used to state a condition assumed within the present context of
2844 Similar to a Remark.
2847 \begin_layout Notation*
2848 Used for the explanation of, yes, notation.
2851 \begin_layout Summary
2852 Do we really need to tell you?
2855 \begin_layout Acknowledgement*
2859 \begin_layout Conclusion*
2860 Sometimes used at the end of a long train of argument.
2864 Used in a way similar to Proposition, though perhaps lower on the scale.
2867 \begin_layout Standard
2868 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
2871 They need to be available on your system in order to use these environments.
2874 \begin_layout Subsection
2876 \change_inserted 564990737 1671383236
2879 \begin_inset CommandInset label
2881 name "subsec:Extra-font-sizes"
2888 \begin_layout Standard
2890 \change_inserted 564990737 1671383236
2893 The “Extra font sizes” collection provides the document classes
2896 \begin_inset space \thinspace{}
2899 (with extra font sizes)
2904 \begin_inset space \thinspace{}
2907 (with extra font sizes)
2912 \begin_inset space \thinspace{}
2915 (with extra font sizes)
2920 \begin_inset space \thinspace{}
2923 (with extra font sizes)
2941 document classes respectively but offer the additional
2947 \begin_inset space ~
2952 options 8, 9, 14, 17 and 20 in the
2957 ocument\SpecialChar menuseparator
2962 ettings\SpecialChar menuseparator
2968 \begin_layout Subsection
2970 \change_inserted 564990737 1671383236
2976 \begin_layout Standard
2978 \change_inserted 564990737 1671383236
2981 The document classes
2984 \begin_inset space \thinspace{}
2992 \begin_inset space \thinspace{}
3007 document classes to facilitate the use of Hebrew in \SpecialChar LyX
3011 \begin_layout Subsection
3013 \change_inserted 564990737 1671383236
3016 \begin_inset CommandInset label
3018 name "subsec:Japanese"
3025 \begin_layout Standard
3027 \change_inserted 564990737 1671383236
3030 The document classes
3033 \begin_inset space \thinspace{}
3041 \begin_inset space \thinspace{}
3044 (Japanese Standard Class Vertical Writing)
3049 \begin_inset space \thinspace{}
3052 (Japanese Standard Class)
3057 \begin_inset space \thinspace{}
3065 \begin_inset space \thinspace{}
3068 (Japanese Standard Class Vertical Writing)
3073 \begin_inset space \thinspace{}
3076 (Japanese Standard Class)
3081 \begin_inset space \thinspace{}
3084 (Japanese Vertical Writing)
3089 \begin_inset space \thinspace{}
3092 (Japanese Standard Class)
3094 provide document classes for the Japanese language.
3097 \begin_layout Subsection
3101 \begin_layout Standard
3107 \begin_layout Subsubsection
3111 \begin_layout Standard
3112 The \SpecialChar LyX
3115 article (koma-script)
3119 report (koma-script)
3137 correspond to the \SpecialChar LaTeX
3155 \begin_inset space ~
3158 of the Koma-Script family.
3159 They are replacements for the standard document classes
3175 , resp., and fit better to European typography conventions in a number of
3179 \begin_layout Itemize
3180 Standard character size is 11pt in
3182 article (koma-script)
3186 report (koma-script)
3194 letter (koma-script)
3199 \begin_layout Itemize
3200 Headings, labels of the description environment, and a number of elements
3203 letter (koma-script)
3205 document class are set in a bold sans serif font.
3209 \begin_layout Plain Layout
3210 There is a big difference between the bold sans serif old cm fonts and new
3211 ec fonts, especially in the appearance of headings.
3212 In comparison, the ec bold sans serif fonts look a bit thin.
3213 Here the \SpecialChar LaTeX
3222 helps to produce the
3223 \begin_inset Quotes eld
3227 \begin_inset Quotes erd
3230 appearance when using the ec fonts.
3235 The numbering of chapter headings is made in the same way as the numbering
3236 of section headings, that is without the extra line
3237 \begin_inset Quotes eld
3240 Chapter\SpecialChar ldots
3242 \begin_inset Quotes erd
3246 In addition, the appearance of the headings can be modified by using a
3247 number of options (in \SpecialChar LyX
3248 to be entered in the field
3251 \begin_inset space ~
3258 Layout\SpecialChar menuseparator
3265 \begin_layout Itemize
3266 The main means in the Koma-Script document classes to design the type area
3275 (in \SpecialChar LyX
3276 to be entered in the extra class options field in the dialog
3278 Document\SpecialChar menuseparator
3282 They make a clearer modification of page margins possible as do the options
3285 Document\SpecialChar menuseparator
3292 \begin_layout Itemize
3293 The \SpecialChar LaTeX
3294 document classes of the Koma-Script family define a number of additional
3296 Those part of it which makes sense in \SpecialChar LyX
3297 is implemented in corresponding
3301 \begin_layout Standard
3302 Detailed descriptions of the \SpecialChar LaTeX
3303 document classes of the Koma-Script family
3304 can be found in the Koma-Script documentation
3315 \begin_layout Subsubsection
3316 article (koma-script), report (koma-script), and book (koma-script)
3319 \begin_layout Standard
3320 The document classes
3322 article (koma-script)
3326 report (koma-script)
3336 are implemented in the layout files
3349 They contain all the paragraph types of the corresponding standard document
3362 , resp., partly modified, with the exception of the \SpecialChar LyX
3367 -type, which is replaced by the new
3371 -type having the same functionality.
3376 -Type there is a number of new paragraph types added.
3383 letter (koma-script)
3388 \begin_layout Itemize
3397 : are equivalents to
3405 , resp., additionally inserting an entry in the table of contents.
3414 are not contained in
3416 article (koma-script)
3421 \begin_layout Itemize
3438 , resp., additionally clearing running heads.
3445 article (koma-script)
3451 \begin_layout Plain Layout
3464 report (koma-script)
3466 , but since this is identical to
3470 , is has not been implemented in \SpecialChar LyX
3479 \begin_layout Itemize
3484 : generates a heading directly above the following paragraph in the standard
3485 character size without affecting the structure of the document.
3488 \begin_layout Itemize
3497 are special captions which respect the different space settings needed
3498 for captions placed above or below an element (if you follow strict typographic
3499 rules, you might want to place table captions always above the table).
3500 You can also use the class option
3517 You need at least Koma-Script version 2.8q to use this.
3520 \begin_layout Itemize
3525 : can be used to set a bonmot, e.
3526 \begin_inset space \thinspace{}
3530 \begin_inset space \space{}
3533 at the beginning of a chapter.
3534 If you use the optional argument (
3536 Insert\SpecialChar menuseparator
3538 \begin_inset space ~
3543 ), you can insert the dictum's author there.
3544 Dictum and author are separated by a line.
3545 You need at least Koma-Script version 2.8q to use this.
3552 article (koma-script)
3557 \begin_layout Standard
3558 The following types, together with the standard types
3570 , form the title area of the document.
3571 They must be entered ahead of the first
3572 \begin_inset Quotes eld
3576 \begin_inset Quotes erd
3583 \begin_layout Plain Layout
3584 The corresponding \SpecialChar LaTeX
3585 commands must appear before the
3596 When such a type is used more than once, the latter usage overwrites the
3597 former one, that means, for every type only the latest usage is valid.
3598 The order of the different types however has, like
3610 , no effect on the appearance of the produced document.
3613 \begin_layout Itemize
3618 : produces a centered paragraph above the ordinary title (
3630 ) for the subject of the document.
3633 \begin_layout Itemize
3638 : produces a centered paragraph below the ordinary title (
3650 ) for the publishers' name.
3653 \begin_layout Itemize
3660 report (koma-script)
3666 produces a centered paragraph on its own page behind the title page, or
3669 article (koma-script)
3671 produces a centered paragraph below the ordinary title (
3690 \begin_layout Itemize
3695 : produces a left aligned paragraph above the ordinary title (
3711 ) for a document`s head.
3714 \begin_layout Itemize
3719 : produces in a double-sided print in
3721 report (koma-script)
3727 a left-aligned paragraph at the top of the title page`s back or has no
3728 effect in a single-sided print or in
3730 article (koma-script)
3735 \begin_layout Itemize
3740 : produces in a double-sided print in
3742 report (koma-script)
3748 a left-aligned paragraph at the bottom of the title page`s back or has
3749 no effect in a single-sided print or in
3751 article (koma-script)
3756 \begin_layout Itemize
3761 : produces a special
3762 \begin_inset Quotes eld
3766 \begin_inset Quotes erd
3769 page ahead of the actual document containing a paragraph without special
3773 \begin_layout Standard
3774 The layout files for the document classes
3776 article (koma-script)
3780 report (koma-script)
3791 This is thought of as a place to define your own types.
3796 in your personal layout directory and edit the file!
3799 \begin_layout Subsubsection
3800 letter (koma-script)
3803 \begin_layout Description
3804 Note: This section discusses the obsolete
3806 KOMA-Script-Letter (v.
3807 \begin_inset space ~
3812 , which is not even included anymore in recent KOMA releases.
3813 Please refer to the next section for the current KOMA-Script-Letter class
3815 \begin_inset space ~
3821 \begin_layout Standard
3825 letter (koma-script)
3827 is implemented in the layout file
3832 It contains all the paragraph types of the corresponding standard document
3837 , partly modified, with the exception of the \SpecialChar LyX
3851 type, which is replaced by the new
3856 In addition, it contains, in contrast to the standard document class, the
3875 Furthermore, there are a number of new letter specific types.
3878 \begin_layout Standard
3879 The appearance of the letter produced by this document class can be controlled
3880 by a number of \SpecialChar LaTeX
3881 commands, which you can put in the \SpecialChar LaTeX
3886 \begin_layout Plain Layout
3887 For example, the standard appearance of the letter`s heading, consisting
3888 of name and address, is quite self-willed.
3890 \begin_inset Quotes eld
3894 \begin_inset Quotes erd
3897 heading is produced by the following \SpecialChar LaTeX
3898 commands in the preamble:
3901 \begin_layout LyX-Code
3911 \begin_layout LyX-Code
3927 \begin_layout LyX-Code
3937 \begin_layout LyX-Code
3957 A detailed German description of such \SpecialChar LaTeX
3958 commands can be found in the Koma-Script
3964 With it, the letter's author can produce his personal letter layout.
3967 \begin_layout Standard
3976 define the beginning of the letter and must be used in every letter.
3977 To emphasize them in the \SpecialChar LyX
3978 document class, they are marked with the letter
3988 \begin_inset space ~
3992 It is possible to write any number of letters in one file.
3997 type produces a new letter using the same addressee and a
4001 type produces a new addressee.
4018 are ordinary paragraph types and can also be used several times in one
4019 and the same letter.
4022 \begin_layout Itemize
4027 : produces a paragraph for the addressee and implicitly defines the beginning
4031 \begin_layout Itemize
4036 : produces a paragraph for the form of address and implicitly produces a
4040 \begin_layout Itemize
4045 : produces a paragraph for a close.
4048 \begin_layout Itemize
4053 : produces a paragraph for a postscript.
4056 \begin_layout Itemize
4061 : produces a paragraph for a distribution list.
4064 \begin_layout Itemize
4069 : produces a paragraph for enclosures.
4072 \begin_layout Standard
4113 are input types provided with a label to enter information, which will
4114 be processed by the document class.
4118 \begin_layout Plain Layout
4119 It could be seen as a matter of inconsequence, that the types
4127 described above are not such input types as well.
4128 Because of the special meaning of those types, however, I have implemented
4129 them as ordinary paragraph types with a one letter mark in the left margin.
4130 Moreover, it would affect my feeling of symmetry, if the
4138 type had such a serious different appearance.
4143 The types must be used ahead of the corresponding
4150 \begin_layout Standard
4151 An implementation of these types in a WYSIWYG fashion does not seem to make
4152 sense, because the real appearance of the produced letter does not only
4153 depend on the usage of the particular type, but also on other factors.
4154 For example, a signature entered in the
4158 type will in the standard behavior appear in the produced letter only,
4159 when in the same letter also a
4164 The entered value of the
4168 type will in the standard behavior not appear in the produced letter at
4170 The possibility to design the letter`s heading freely is already indicated
4171 in a footnote above.
4174 \begin_layout Standard
4175 The input types can also be used as empty paragraphs.
4177 \begin_inset space \thinspace{}
4181 \begin_inset space \space{}
4193 type is not used at all, in the standard behavior the value of the
4197 type is used as signature, whereas if an empty
4201 type is used, no signature value is defined.
4204 \begin_layout Standard
4205 By using the input types it is possible to write a letter template, containing
4206 filled input types with your personal dates (name, address, etc.) and empty
4207 input types for other dates you want to enter.
4210 \begin_layout Itemize
4215 : sender's name, in the standard behavior appears as a centered paragraph
4216 in small caps in the letter`s heading.
4219 \begin_layout Itemize
4224 : sender's signature, in the standard behavior appears below the
4233 type is used, the value of the
4237 type appears instead.
4240 \begin_layout Itemize
4245 : sender's address, in the standard behavior appears in a centered paragraph
4246 in the letter`s heading below the sender's name.
4249 \begin_layout Itemize
4254 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
4265 \begin_layout Itemize
4270 : place of the letter`s making.
4273 \begin_layout Itemize
4278 : date of the letter`s making.
4287 , in the standard behavior, produce the place and the date in a right-aligned
4288 line below the addressee's field.
4293 type is used, neither place nor date appear, independent of the value of
4303 type is used, the date of the letter `s production is used.
4306 \begin_layout Itemize
4311 : sender`s back address, in the standard behavior appears above the addressee's
4312 field in a small sans serif font.
4315 \begin_layout Itemize
4320 : special mail information, in the standard behavior appears underlined
4321 above the addressee's field below the back address.
4324 \begin_layout Itemize
4329 : additional information, in the standard behavior appears on right side
4330 below the addressee`s field.
4333 \begin_layout Itemize
4338 : the letter's title, in the standard behavior appears in a big, bold, sans
4339 serif font above the subject.
4342 \begin_layout Itemize
4347 : the letter's subject, in the standard behavior appears in a bold font
4355 \begin_layout Standard
4376 produce a business letter like line above the
4380 line containing the fields
4381 \begin_inset Quotes eld
4385 \begin_inset Quotes erd
4389 \begin_inset Quotes eld
4393 \begin_inset Quotes erd
4397 \begin_inset Quotes eld
4401 \begin_inset Quotes erd
4405 \begin_inset Quotes eld
4409 \begin_inset Quotes erd
4413 \begin_inset Quotes eld
4417 \begin_inset Quotes erd
4421 \begin_inset Quotes eld
4425 \begin_inset Quotes erd
4429 For the date field, the value of the
4435 \begin_inset Quotes eld
4438 business letter types
4439 \begin_inset Quotes erd
4442 is used, the value of the
4446 type however does not appear, but only the \SpecialChar LaTeX
4454 The ordinary output of place and date in a right-aligned line below the
4455 addressee`s field is suppressed.
4456 The types are implemented as input types provided with a label and must
4457 be used ahead of the corresponding
4464 \begin_layout Itemize
4472 \begin_layout Itemize
4480 \begin_layout Itemize
4488 \begin_layout Itemize
4496 \begin_layout Itemize
4504 \begin_layout Subsubsection
4505 The new letter class: letter (koma-script v.2)
4508 \begin_layout Standard
4514 \begin_layout Standard
4515 \begin_inset VSpace medskip
4521 \begin_layout Standard
4523 Koma-Script version 2.8 has introduced a new letter class
4527 which supersedes the now unsupported
4532 It has — on the \SpecialChar LaTeX
4533 side — a completely new interface and is not compatible
4535 Therefore, \SpecialChar LyX
4536 supports both, though it is recommended you use the new class.
4539 \begin_layout Standard
4540 This class covers the same functionality as
4542 letter (koma-script),
4549 (receiver's address, same as
4566 will start a new letter (i.
4567 \begin_inset space \thinspace{}
4571 \begin_inset space \space{}
4574 you can write several letters per document).
4575 New elements are sender's
4591 and the possibility to use a
4597 Insert\SpecialChar menuseparator
4603 \begin_layout Standard
4604 The biggest improvement is, though, that the letter's layout is configurable
4605 to meet almost any needs.
4606 This can be done via the preamble or with a special style file (Letter
4607 Class Option, extension
4611 ), that will be read in as a class option.
4615 \begin_layout Plain Layout
4616 The KOMA package comes with some default
4621 There is, for instance, a
4625 file that follows german typesetting rules, or a
4629 that provides the default layout of the old
4634 The latter can be loaded with the class option
4640 Layout\SpecialChar menuseparator
4641 Document\SpecialChar menuseparator
4650 \change_deleted 564990737 1671617922
4658 \change_deleted 564990737 1671617938
4659 that is included in \SpecialChar LyX
4661 \change_inserted 564990737 1671617997
4668 ile\SpecialChar menuseparator
4670 \begin_inset space ~
4678 \begin_inset space ~
4681 Template\SpecialChar menuseparator
4684 \SpecialChar menuseparator
4685 KOMA-Script Letter (V.2)
4690 A detailed description is to be found in the Koma-Script documentation
4698 \begin_layout Subsubsection
4702 \begin_layout Standard
4703 Visualizing the Koma-Script document classes in \SpecialChar LyX
4704 , the \SpecialChar LyX
4705 internals cause some
4709 \begin_layout Itemize
4710 The chapter number of a
4714 type appears on a line of its own above the chapter heading instead of
4715 appearing in the same line ahead of it.
4716 The cause for that is the \SpecialChar LyX
4717 internal behavior for the labeltype
4724 \begin_layout Itemize
4725 The headings of the types
4734 \begin_inset Quotes eld
4738 \begin_inset Quotes erd
4742 table of contents, but not in the \SpecialChar LyX
4745 Document\SpecialChar menuseparator
4747 \begin_inset space ~
4751 \begin_inset space ~
4759 \begin_layout Itemize
4764 document class appear in a skip separation mode, not indented.
4765 This is the standard behavior, no special \SpecialChar LaTeX
4766 commands are needed for that.
4769 Document\SpecialChar menuseparator
4772 dialog the corresponding radio button indicates
4781 value always has the effect that extra \SpecialChar LaTeX
4782 commands are inserted in the document
4783 to produce the gap, which is not what is wanted in this case.
4786 \begin_layout Subsection
4788 \change_inserted 564990737 1670924924
4790 \begin_inset space \thinspace{}
4794 \begin_inset space \space{}
4798 \change_deleted 564990737 1670924933
4799 Article (mwart), book (mwbk) and report (mwrep)
4800 \begin_inset Argument status
4803 \begin_layout Plain Layout
4818 \begin_layout Standard
4824 \begin_layout Standard
4825 The \SpecialChar LyX
4842 correspond to the \SpecialChar LaTeX
4856 They are replacements for the standard document classes
4868 , resp., and fit better to Polish typography conventions in a number of points.
4872 \begin_layout Standard
4876 \begin_layout Itemize
4877 Unnumbered titles (with star, e.
4878 \begin_inset space \thinspace{}
4882 \begin_inset space \space{}
4889 ) are added into table of contents,
4892 \begin_layout Itemize
4893 Additional page styles:
4897 \begin_layout Description
4898 uheadings header with separated lines,
4901 \begin_layout Description
4902 myheadings custom header, contents headers via commands:
4917 \begin_layout Description
4918 myuheadings custom header with separated lines,
4921 \begin_layout Description
4922 outer page number is placed on outer side of page
4926 \begin_layout Itemize
4931 \begin_layout Description
4932 rmheadings serif titles — default,
4935 \begin_layout Description
4936 sfheadings sansserif titles,
4939 \begin_layout Description
4940 authortitle on title page first placed is author next title — default,
4943 \begin_layout Description
4944 titleauthor on title page first placed is title next author,
4947 \begin_layout Description
4948 withmarginpar reserve place on page for margins.
4952 \begin_layout Section
4954 \change_inserted 564990737 1670439534
4958 \begin_layout Standard
4960 \change_inserted 564990737 1670794710
4961 See also the document classes in the Collections (section
4962 \begin_inset space ~
4966 \begin_inset CommandInset ref
4968 reference "sec:Collections"
4975 \begin_layout Subsection
4977 \change_inserted 564990737 1670794716
4983 \begin_layout Standard
4985 \change_inserted 564990737 1670794716
4992 ; updated by the \SpecialChar LyX
4996 \begin_layout Subsubsection
4998 \change_inserted 564990737 1670794716
5004 \begin_layout Standard
5006 \change_inserted 564990737 1670794716
5009 This section describes how \SpecialChar LyX
5010 can be used to write articles for submission
5011 to the scientific journal
5013 Astronomy and Astrophysics
5016 \begin_inset CommandInset href
5019 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
5024 ) using Version 9.1 of the document class
5028 ; information about it is available at
5029 \begin_inset Flex URL
5032 \begin_layout Plain Layout
5034 \change_inserted 564990737 1670794716
5036 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
5046 \begin_layout Standard
5048 \change_inserted 564990737 1670794716
5051 A manual comes together with the package and should be consulted before
5052 installing this document class as described in the
5054 Installing New Document Classe
5064 \begin_layout Standard
5066 \change_inserted 564990737 1670794716
5069 \begin_inset Note Greyedout
5072 \begin_layout Plain Layout
5074 \change_inserted 564990737 1670794716
5077 Please note that the publisher of the journal was changed from Springer
5078 to EDP Sciences starting January 1, 2001.
5079 That change also involved some slight changes to the style files, namely
5080 the removal of the thesaurus command.
5081 If you have an older version installed, please upgrade.
5082 For information about compatibility with the old (version 4) layout, please
5083 refer to the comments in
5086 Dir/layouts/aapaper.layout
5096 \begin_layout Subsubsection
5098 \change_inserted 564990737 1670794716
5104 \begin_layout Standard
5106 \change_inserted 564990737 1671617129
5109 It is recommended you start from the template in the menu
5114 ile\SpecialChar menuseparator
5116 \begin_inset space ~
5124 \begin_inset space ~
5129 \SpecialChar menuseparator
5130 Articles\SpecialChar menuseparator
5131 Astronomy & Astrophysics
5135 If you are not using the template, note the following settings:
5138 \begin_layout Itemize
5140 \change_inserted 564990737 1670794716
5152 ocument\SpecialChar menuseparator
5157 ettings\SpecialChar menuseparator
5159 \begin_inset space ~
5164 dialog (OK, that one was obvious).
5167 \begin_layout Itemize
5169 \change_inserted 564990737 1670794716
5175 \begin_inset space ~
5187 \begin_inset space ~
5192 dialog: leave it set to
5197 The whole layout is done by the macros, you shouldn't change anything.
5200 \begin_layout Subsubsection
5202 \change_inserted 564990737 1670794716
5208 \begin_layout Standard
5210 \change_inserted 564990737 1670794716
5213 First thing to enter is the header information.
5214 It consists of five entries, of which one is optional.
5218 \begin_layout Itemize
5220 \change_inserted 564990737 1670794716
5229 \begin_layout Itemize
5231 \change_inserted 564990737 1670794716
5240 \begin_layout Itemize
5242 \change_inserted 564990737 1670794716
5251 \begin_layout Itemize
5253 \change_inserted 564990737 1670794716
5262 \begin_layout Itemize
5264 \change_inserted 564990737 1670794716
5273 Received: <date>; Accepted <date>
5276 \begin_layout Standard
5278 \change_inserted 564990737 1670794716
5281 Although the order of the single header entries doesn't matter it is advised
5282 to keep the above sequence, just to get the best optics and meets the layout
5283 of the real document.
5286 \begin_layout Standard
5288 \change_inserted 564990737 1670794716
5291 If you want to place footnotes in the header block, e.
5292 \begin_inset space \thinspace{}
5296 \begin_inset space \space{}
5299 to state your present address, just use the standard footnote via the menu
5305 nsert\SpecialChar menuseparator
5314 will automagically use the term
5323 \begin_layout Standard
5325 \change_inserted 564990737 1670794716
5328 In addition to these topics, the macros use three additional \SpecialChar LaTeX
5330 have no counterpart in \SpecialChar LyX
5334 \begin_layout Itemize
5336 \change_inserted 564990737 1670794716
5344 to separate different names for more than one author and institute, respectivel
5348 \begin_layout Itemize
5350 \change_inserted 564990737 1670794716
5358 to mark corresponding author/institute pairs.
5359 The institutes are numbered sequentially as they appear in the
5363 field, so you have to put a marker to each author.
5366 \begin_layout Itemize
5368 \change_inserted 564990737 1670794716
5376 to supply an email address for fast contact.
5379 \begin_layout Standard
5381 \change_inserted 564990737 1671642374
5384 In all cases, the appropriate command has to be entered as \SpecialChar TeX
5385 code in \SpecialChar LyX
5387 See the examples in the template and in
5390 File\SpecialChar menuseparator
5391 Open Example\SpecialChar menuseparator
5392 Articles\SpecialChar menuseparator
5393 Astronomy & Astrophysics
5401 \begin_layout Subsubsection
5403 \change_inserted 564990737 1670794716
5409 \begin_layout Standard
5411 \change_inserted 564990737 1670794716
5414 The abstract should immediately follow the header block and must contain
5424 \begin_layout Enumerate
5426 \change_inserted 564990737 1670794716
5432 (optional) {} leave it empty if necessary
5435 \begin_layout Enumerate
5437 \change_inserted 564990737 1670794716
5446 \begin_layout Enumerate
5448 \change_inserted 564990737 1670794716
5457 \begin_layout Enumerate
5459 \change_inserted 564990737 1670794716
5468 \begin_layout Enumerate
5470 \change_inserted 564990737 1670794716
5476 (optional) {} leave it empty if necessary
5479 \begin_layout Standard
5481 \change_inserted 564990737 1670794716
5485 This structure not shown in
5492 \begin_layout Subsubsection
5494 \change_inserted 564990737 1670794716
5497 Supported environments
5500 \begin_layout Standard
5502 \change_inserted 564990737 1670794716
5505 The A&A paper layout supports the following environments for structuring
5509 \begin_layout Itemize
5511 \change_inserted 564990737 1670794716
5518 \begin_layout Itemize
5520 \change_inserted 564990737 1670794716
5527 \begin_layout Itemize
5529 \change_inserted 564990737 1670794716
5536 \begin_layout Itemize
5538 \change_inserted 564990737 1670794716
5545 \begin_layout Itemize
5547 \change_inserted 564990737 1670794716
5554 \begin_layout Itemize
5556 \change_inserted 564990737 1670794716
5563 \begin_layout Itemize
5565 \change_inserted 564990737 1670794716
5572 \begin_layout Itemize
5574 \change_inserted 564990737 1670794716
5581 \begin_layout Itemize
5583 \change_inserted 564990737 1670794716
5590 \begin_layout Itemize
5592 \change_inserted 564990737 1670794716
5599 \begin_layout Itemize
5601 \change_inserted 564990737 1670794716
5608 \begin_layout Itemize
5610 \change_inserted 564990737 1670794716
5618 \begin_layout Subsubsection
5620 \change_inserted 564990737 1670794716
5623 Commands not supported by \SpecialChar LyX
5627 \begin_layout Standard
5629 \change_inserted 564990737 1670794716
5632 Some commands are not yet supported by the
5636 layout for \SpecialChar LyX
5638 Some have already been mentioned.
5639 For the sake of completeness, they are listed all together here:
5642 \begin_layout Itemize
5644 \change_inserted 564990737 1670794716
5653 \begin_layout Itemize
5655 \change_inserted 564990737 1670794716
5664 \begin_layout Itemize
5666 \change_inserted 564990737 1670794716
5675 \begin_layout Itemize
5677 \change_inserted 564990737 1670794716
5686 \begin_layout Itemize
5688 \change_inserted 564990737 1670794716
5697 \begin_layout Standard
5699 \change_inserted 564990737 1670794716
5702 If you want to use any of these commands, you have to enter them yourself.
5705 Do not forget to use
5711 nsert\SpecialChar menuseparator
5714 \begin_inset space ~
5723 \begin_layout Subsubsection
5725 \change_inserted 564990737 1670794716
5728 Figure and Table Floats
5731 \begin_layout Standard
5733 \change_inserted 564990737 1670794716
5737 provides support for the necessary float environments
5739 figure, figure*, table
5745 , therefore we won't tell much about it here.
5749 \begin_inset space ~
5755 Just remember that tables should be left-aligned.
5756 For that, select the table and change the alignment in
5761 dit\SpecialChar menuseparator
5767 \begin_inset space ~
5773 \begin_layout Standard
5775 \change_inserted 564990737 1670794716
5778 There is only one special thing: the figures with a caption beside the figure.
5779 To create such a figure, you have to do the following:
5782 \begin_layout Enumerate
5784 \change_inserted 564990737 1670794716
5787 Create a wide figure float:
5792 nsert\SpecialChar menuseparator
5797 t\SpecialChar menuseparator
5800 , then, from within the float, use the menu
5805 dit\SpecialChar menuseparator
5811 \begin_inset space ~
5822 \begin_inset space ~
5834 \begin_layout Enumerate
5836 \change_inserted 564990737 1670794716
5839 Enter your caption text.
5842 \begin_layout Enumerate
5844 \change_inserted 564990737 1670794716
5851 to move the cursor above the caption.
5854 \begin_layout Enumerate
5856 \change_inserted 564990737 1670794716
5862 \begin_layout Enumerate
5864 \change_inserted 564990737 1670794716
5867 Position the cursor after the figure and insert a horizontal fill by using
5873 nsert\SpecialChar menuseparator
5878 rmatting\SpecialChar menuseparator
5884 \begin_inset space ~
5893 dialog and select the
5907 \begin_layout Enumerate
5909 \change_inserted 564990737 1670794716
5912 Switch to \SpecialChar LaTeX
5916 \begin_inset space ~
5924 \begin_layout Enumerate
5926 \change_inserted 564990737 1670794716
5937 Do not close the brace!
5940 \begin_layout Enumerate
5942 \change_inserted 564990737 1670794716
5945 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
5950 \begin_inset space ~
5962 \begin_layout Standard
5964 \change_inserted 564990737 1671642458
5967 Also, refer to the figures in the file in
5970 File\SpecialChar menuseparator
5971 Open Example\SpecialChar menuseparator
5972 Articles\SpecialChar menuseparator
5973 Astronomy & Astrophysics
5979 \begin_layout Subsubsection
5981 \change_inserted 564990737 1670794716
5987 \begin_layout Standard
5989 \change_inserted 564990737 1670794716
5992 For submission, the paper has to be formatted in a special double-spacing
5994 For this purpose, you have to add the option
6005 \begin_inset space ~
6015 ocument\SpecialChar menuseparator
6020 ettings\SpecialChar menuseparator
6022 \begin_inset space ~
6031 \begin_layout Subsubsection
6033 \change_inserted 564990737 1670794716
6039 \begin_layout Standard
6041 \change_inserted 564990737 1671642520
6047 File\SpecialChar menuseparator
6048 Open Example\SpecialChar menuseparator
6049 Articles\SpecialChar menuseparator
6050 Astronomy & Astrophysics
6053 was written with \SpecialChar LyX
6055 It is the example paper from the original macro package,
6060 \begin_inset CommandInset href
6063 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
6068 , but translated to \SpecialChar LyX
6069 using the older unstructured abstract type.
6070 Use it for inspiration, and compare the \SpecialChar LaTeX
6075 with the \SpecialChar LyX
6079 \begin_layout Subsection
6084 \begin_layout Standard
6090 \begin_layout Subsubsection
6094 \begin_layout Standard
6096 is a set of macros produced by the American Astronomical Society to
6097 facilitate electronic manuscript submission to the three journals they
6098 publish: the Astrophysical Journal (including the Letters and Supplement),
6099 the Astronomical Journal, and the Publications of the Astronomical Society
6102 has proven to be an excellent tool for generating these documents, especially
6103 given its equation, citation, and figure handling capabilities.
6105 requires version 5.0 (or higher) of these macros; preferably 6.0, which
6106 is the version described here, or higher.
6107 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
6108 2.09 and are fundamentally
6109 incompatible with \SpecialChar LyX
6111 The AAS\SpecialChar TeX
6112 package may be downloaded from the AAS\SpecialChar TeX
6116 \begin_layout Standard
6117 \begin_inset VSpace medskip
6123 \begin_layout Standard
6125 \begin_inset Flex URL
6128 \begin_layout Plain Layout
6130 https://aas.org/aastex/aastex-downloads
6138 \begin_layout Standard
6139 \begin_inset VSpace medskip
6145 \begin_layout Standard
6146 A complete user guide is contained in that package and you should familiarize
6147 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
6150 will not reduce the need to figure out all the AAS\SpecialChar TeX
6151 commands, it will only
6152 reduce the drudgery of typing everything in.
6153 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
6155 completely to the requirements of the journal to which you are submitting
6159 \begin_layout Subsubsection
6160 Starting a New Paper
6163 \begin_layout Standard
6164 I strongly suggest that you start with the AAS\SpecialChar TeX
6168 File\SpecialChar menuseparator
6174 \change_inserted 564990737 1671617265
6175 \SpecialChar menuseparator
6176 Articles\SpecialChar menuseparator
6177 American Astronomical Society
6178 \change_deleted 564990737 1671617310
6181 , enter the new file name, then choose the
6188 This will show the most common fields found in a manuscript.
6189 Simply overwrite the existing text (including the brackets,
6193 ) with the correct information.
6194 Many of the AAS\SpecialChar TeX
6195 commands and environments can be implemented directly in
6198 For commands such as these, the \SpecialChar LaTeX
6199 code must be entered directly and marked
6201 Such commands are referred to as \SpecialChar TeX
6202 code, or Evil Red Text.
6203 I tried to minimize the amount of \SpecialChar TeX
6204 code needed in an AAS\SpecialChar TeX
6208 \begin_layout Subsubsection
6209 Finishing Your Paper
6212 \begin_layout Standard
6213 When the paper is finished to your satisfaction and previews/prints correctly,
6215 \begin_inset Quotes eld
6219 \begin_inset Quotes erd
6222 actions which need to be done before you submit it to the journals.
6226 \begin_layout Enumerate
6227 Export your paper as a \SpecialChar LaTeX
6230 File\SpecialChar menuseparator
6231 Export\SpecialChar menuseparator
6239 \begin_layout Enumerate
6244 file with your favorite text editor
6248 \begin_layout Enumerate
6249 remove the comment lines before the
6258 \begin_layout Enumerate
6263 usepackage...{fontenc}
6265 line if it appears (usually just after
6280 \begin_layout Enumerate
6281 remove everything between (and including) the
6293 commands, except for any commands you specifically put into the \SpecialChar LaTeX
6295 (which should appear immediately after the
6296 \begin_inset Quotes eld
6299 User specified \SpecialChar LaTeX
6301 \begin_inset Quotes erd
6312 \begin_layout Enumerate
6313 Run the resulting file through \SpecialChar LaTeX
6314 to make sure it still processes correctly.
6317 \begin_layout Enumerate
6318 Reread the journal requirements to make sure your filenames and formats
6322 \begin_layout Enumerate
6326 \begin_layout Subsubsection
6327 Comments On Specific Commands
6330 \begin_layout Standard
6331 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
6338 ) gives a good description of each.
6339 Thus it's probably easiest for me to go down the list as found in the guide
6340 and offer comments where necessary.
6341 So let's begin \SpecialChar ldots
6345 \begin_layout Paragraph
6346 Things that work as expected
6349 \begin_layout Standard
6350 Because they work as you might expect, I simply list them and the section
6451 begin{thebibliography}
6459 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6460 graphicx figure commands (2.14.1),
6484 (2.15.4, amongst other places),
6511 \begin_layout Standard
6512 The following style options also work correctly:
6533 Simply put them in the
6539 Layout\SpecialChar menuseparator
6545 \begin_layout Paragraph
6546 Things that work, but require more comment
6549 \begin_layout Standard
6550 The following items work, but require a little more discussion:
6553 \begin_layout Itemize
6554 These items are reserved for use by the journal editors, but you can put
6555 them into the \SpecialChar LaTeX
6556 preamble if you feel compelled to do so:
6589 \begin_layout Itemize
6590 These items may be placed in the \SpecialChar LaTeX
6591 preamble, and are included as blanks in
6613 \begin_layout Itemize
6620 (2.3) – can only be used
6621 \begin_inset Quotes eld
6625 \begin_inset Quotes erd
6628 , not in the middle of a paragraph.
6629 Use \SpecialChar TeX
6630 code if you need to embed it.
6633 \begin_layout Itemize
6640 (2.3) – will have extra {} after it.
6641 This should not cause an error.
6644 \begin_layout Itemize
6651 (2.6) – can only be used
6652 \begin_inset Quotes eld
6656 \begin_inset Quotes erd
6659 , not in the middle of a paragraph.
6660 Use \SpecialChar TeX
6661 code if you need to embed it.
6664 \begin_layout Itemize
6671 (2.8) – can't insert a cross-reference tag, you must type the tag name by
6675 \begin_layout Itemize
6689 \begin_layout Itemize
6696 (2.9) – will have extra {} after it.
6697 This should not cause an error.
6700 \begin_layout Itemize
6707 (2.11) – will have extra {} after it.
6708 This should not cause an error.
6711 \begin_layout Itemize
6718 (2.14.2) – you can insert an optional filename argument by placing the cursor
6719 at the beginning of the text and selecting
6721 Insert\SpecialChar menuseparator
6726 \begin_inset Quotes eld
6730 \begin_inset Quotes erd
6733 inserts an optional argument of the type needed by
6740 Hopefully it will be renamed someday.
6743 \begin_layout Itemize
6756 for the catalog ID optional parameter
6759 \begin_layout Itemize
6772 for the catalog ID optional parameter
6775 \begin_layout Paragraph
6776 Things not implemented, use \SpecialChar TeX
6780 \begin_layout Standard
6791 setcounter{equation}
6793 (2.12), Journal name abbreviations (2.13.4),
6829 (2.15.4, insert it as the first element in the lefthand cell after where
6831 Don't use any of \SpecialChar LyX
6832 's rules in the table),
6844 (2.15.5), much of Misc (2.17, except
6895 \begin_layout Paragraph
6896 Things that cannot be implemented
6899 \begin_layout Standard
6901 at least in any meaningful sort of way, so I suggest ignoring them.
6902 They are the references environment (2.13.3), and the deluxetable environment
6904 If you really, really need to use deluxetable, I suggest editing it in
6905 a separate file with a text editor, then using
6907 Insert\SpecialChar menuseparator
6909 \begin_inset space ~
6914 to include it in your \SpecialChar LyX
6917 \change_deleted 564990737 1671642564
6923 \change_inserted 564990737 1671642618
6927 File\SpecialChar menuseparator
6928 Open Example\SpecialChar menuseparator
6929 Articles\SpecialChar menuseparator
6930 American Astronomical Society
6936 \change_inserted 564990737 1671642621
6942 \begin_layout Subsubsection
6943 FAQs, Tips, Tricks, and Other Ruminations
6946 \begin_layout Paragraph
6947 Getting \SpecialChar LyX
6948 and AAS\SpecialChar TeX
6952 \begin_layout Standard
6953 It can be a bit tricky to get \SpecialChar LyX
6954 to recognize a new layout and document class.
6955 When all else fails, do this:
6958 \begin_layout Enumerate
6959 Make certain that \SpecialChar LaTeX
6960 can find AAS\SpecialChar TeX
6962 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
6964 directory completely unrelated to \SpecialChar LaTeX
6965 or AAS\SpecialChar TeX
6966 and run \SpecialChar LaTeX
6974 \begin_layout Enumerate
6979 appears in \SpecialChar LyX
6987 \begin_layout Enumerate
6990 Tools\SpecialChar menuseparator
6994 , then restart \SpecialChar LyX
6998 \begin_layout Enumerate
6999 Open a regular new file, not from a template.
7000 Does AAS\SpecialChar TeX
7001 appear in the class list in
7003 Document\SpecialChar menuseparator
7009 \begin_layout Standard
7010 If you get a warning from an existing AAS\SpecialChar TeX
7011 document about not being able
7012 to find the AAS\SpecialChar TeX
7013 layout or a message about
7014 \begin_inset Quotes eld
7017 You should not mix title layouts with normal ones
7018 \begin_inset Quotes erd
7021 , things haven't been installed correctly.
7024 \begin_layout Paragraph
7026 error processing a table
7029 \begin_layout Standard
7031 , by default, attempts to center the table caption/title.
7032 This seems to produce a bad interaction in AAS\SpecialChar TeX
7033 so you should click somewhere
7034 in the caption/title, then select
7036 Edit\SpecialChar menuseparator
7038 \begin_inset space ~
7052 This took care of it for me.
7055 \begin_layout Paragraph
7059 \begin_layout Standard
7060 A couple of things: 1) I have noticed some funny spacing in the reference
7061 entries in the text.
7062 When you enter the bibliography item data, make sure their is
7066 space between the last author and the parenthesis setting off the year;
7070 \begin_inset space \thinspace{}
7074 \begin_inset space \space{}
7088 2) Entering the references at all is not obvious.
7089 The easiest thing is to start typing your first reference at the end of
7090 the document, then mark it as type
7095 That will put a small gray box in front of what you just typed.
7096 Click on the box to fill in the rest of the information.
7097 For new references, go to the end of an existing reference and press return.
7098 That will create a new line with its own box, etc.
7101 \begin_layout Paragraph
7105 \begin_layout Standard
7106 Even though AAS\SpecialChar TeX
7107 provides its own figure commands (
7113 , for example), I much prefer \SpecialChar LaTeX
7114 's standard figure commands (with the default
7123 \begin_inset space ~
7126 commands as \SpecialChar TeX
7127 code into a Figure Float box if you desire, but I never have
7128 much luck getting the layout right.
7129 With the standard graphics, \SpecialChar LyX
7134 usepackage{graphicx}
7136 command into the \SpecialChar LaTeX
7137 preamble and handle the figures in the standard \SpecialChar LaTeX2e
7139 interspersing the figures in the text.
7140 I believe ApJ accepts figures exactly this way now; AJ might still use
7142 \begin_inset Quotes eld
7145 stack everything at the end
7146 \begin_inset Quotes erd
7152 \begin_layout Paragraph
7153 Things I could have done, but didn't
7156 \begin_layout Standard
7158 \begin_inset Quotes eld
7162 \begin_inset Quotes erd
7165 things I could have implemented, but chose not to.
7166 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
7168 even though it is double-spaced in the paper manuscript.
7169 Also, I chose not to make separate layouts for the preprint and preprint2
7171 Since I assume you will spend most of your time in the plain manuscript
7172 mode anyway, I decided not to chew up more disk space with this.
7176 \begin_layout Subsubsection
7180 \begin_layout Standard
7181 Your mileage may vary.
7182 I've now had papers published by both ApJ and AJ that have had 98% of the
7183 effort done in \SpecialChar LyX
7184 ; the last 2% was the \SpecialChar LaTeX
7185 post-processing and a few cleanups.
7186 I have had no trouble with the submission process, and I'm sure the journals
7187 were never aware that there might be a difference.
7188 So, go forth and publish!
7191 \begin_layout Subsection
7193 \change_inserted 564990737 1671442131
7199 \begin_layout Standard
7201 \change_inserted 564990737 1671642768
7207 \begin_inset space \thinspace{}
7216 document class together with the style
7220 to facilitate the description of chess games.
7224 File\SpecialChar menuseparator
7227 \SpecialChar menuseparator
7228 Articles\SpecialChar menuseparator
7247 \begin_layout Subsection
7249 \change_inserted 564990737 1671042028
7255 \begin_layout Standard
7257 \change_inserted 564990737 1671617396
7263 \begin_inset space \thinspace{}
7273 This provides the following additional environments:
7276 \begin_inset space ~
7284 \begin_inset space ~
7292 \begin_inset space ~
7310 A template is available in the menu
7315 ile\SpecialChar menuseparator
7317 \begin_inset space ~
7325 \begin_inset space ~
7330 \SpecialChar menuseparator
7331 Articles\SpecialChar menuseparator
7336 It has been customized with further environments and contains all the informati
7338 However, the documentation is also available from
7339 \begin_inset CommandInset href
7342 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
7350 \begin_layout Subsection
7352 \change_inserted 564990737 1671042046
7358 \begin_layout Standard
7360 \change_inserted 564990737 1671042046
7366 \begin_inset space \thinspace{}
7371 provides an alternative to the
7376 It provides similar functionality, but you might prefer this layout with
7377 sans serif sections, headings, and more.
7380 \begin_layout Subsection
7385 \begin_layout Standard
7391 \begin_layout Standard
7392 \begin_inset VSpace bigskip
7398 \begin_layout Standard
7403 \begin_inset space ~
7408 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
7410 \begin_inset Formula $\beta$
7413 release of May, 1999) class.
7416 \begin_layout Standard
7422 textclass, which works with Rev\SpecialChar TeX
7424 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
7426 That means that it doesn't interact very well with \SpecialChar LyX
7427 , which requires \SpecialChar LaTeX2e
7429 it has been kludged to work.
7430 Since Rev\SpecialChar TeX
7431 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
7438 \begin_inset space ~
7443 textclass should also be pretty easy to use.
7446 \begin_layout Standard
7447 These documents are supposed to be used in
7451 to the Rev\SpecialChar TeX
7452 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
7454 and assume you'll know what to put in the preamble if necessary.
7457 \begin_layout Subsubsection
7461 \begin_layout Standard
7462 All you need to do is install Rev\SpecialChar TeX
7463 4, as described in the package's README
7465 The package can be found at The Rev\SpecialChar TeX
7467 \begin_inset Flex URL
7470 \begin_layout Plain Layout
7472 http://publish.aps.org/revtex4/
7478 Install it somewhere that \SpecialChar LaTeX
7480 Test it by trying to \SpecialChar LaTeX
7481 a short Rev\SpecialChar TeX
7482 4 document in some random directory (i.
7483 \begin_inset space \thinspace{}
7487 \begin_inset space \space{}
7490 not the directory where you installed the class file.) Then, if you reconfigure
7492 , it will find the class file and let you use the Rev\SpecialChar TeX
7496 \begin_layout Standard
7497 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
7506 \begin_inset space ~
7511 template, found in the templates directory.
7514 \begin_layout Subsubsection
7518 \begin_layout Standard
7519 Optional arguments to
7526 \begin_inset Quotes eld
7530 \begin_inset Quotes erd
7534 \begin_inset Quotes eld
7538 \begin_inset Quotes erd
7544 \begin_inset space ~
7552 \begin_inset space ~
7558 Remember that in Rev\SpecialChar TeX
7559 , at least one optional argument is required!
7562 \begin_layout Standard
7563 Other preamble matter, like
7570 \begin_inset space ~
7577 \begin_inset space ~
7582 dialog, also as usual.
7585 \begin_layout Subsubsection
7589 \begin_layout Standard
7590 The layouts basically correspond to the commands in Rev\SpecialChar TeX
7592 For example, the Email layout corresponds to
7599 Note that (at least as of Rev\SpecialChar TeX
7608 layouts are exactly equivalent, so you shouldn't need to use both.
7612 \begin_layout Plain Layout
7613 In case you're curious, both were included so that
7617 would be able to translate both
7637 \begin_layout Subsubsection
7641 \begin_layout Standard
7642 There are a couple of important unique aspects of Rev\SpecialChar TeX
7644 bugs that will be even more confusing in \SpecialChar LyX
7648 \begin_layout Standard
7649 In Rev\SpecialChar TeX
7667 The \SpecialChar LyX
7668 equivalent is that there is a separate Thanks layout.
7673 write footnotes in the
7677 layout, or weird things may happen.
7678 See the Rev\SpecialChar TeX
7679 4 documentation for more details.
7682 \begin_layout Standard
7686 \begin_inset space ~
7694 \begin_inset space ~
7703 layouts must be placed
7711 layout and the corresponding
7728 , the \SpecialChar LaTeX
7732 \begin_layout Subsection
7734 \change_inserted 564990737 1671042072
7740 \begin_layout Standard
7742 \change_inserted 564990737 1671042072
7749 classes were replaced in 2013 with a completely new
7754 This package provides a \SpecialChar LaTeX
7755 class and templates for books to be published
7756 at Springer Gabler Research, Springer Vieweg Research, Springer Spektrum
7757 Research, Springer VS Research, or Springer VS Forschung.
7758 The documentation is available in German from
7759 \begin_inset CommandInset href
7762 target "http://mirrors.ctan.org/macros/latex/contrib/springer/sr-vorl/sr-vorl.pdf"
7770 \begin_layout Section
7772 \change_inserted 564990737 1670439560
7776 \begin_layout Standard
7778 \change_inserted 564990737 1670439581
7779 See also the document classes in the Collections (section
7780 \begin_inset space ~
7784 \begin_inset CommandInset ref
7786 reference "sec:Collections"
7793 \begin_layout Subsection
7797 \begin_layout Standard
7803 \begin_layout Subsubsection
7807 \begin_layout Standard
7808 Memoir is a very powerful and constantly evolving class.
7809 It has been designed with regard to fictional and non-fictional literature.
7810 Its aim is to let the user have maximum control over the typesetting of
7812 Memoir is based on the standard book class, but it can also emulate the
7813 article class (see below).
7816 \begin_layout Standard
7817 Peter Wilson, the developer of Memoir, is known as the author of lots of
7818 useful packages in the \SpecialChar LaTeX
7820 Most of them have been merged with Memoir.
7821 Therefore, it is much easier to layout the table of contents, appendices,
7822 chapter designs and such.
7824 , though, does not support all of these goodies natively.
7825 Some of them might be added to forthcoming releases
7829 \begin_layout Plain Layout
7830 You are invited to send suggestions to
7831 \begin_inset Flex URL
7834 \begin_layout Plain Layout
7836 lyx-devel@lists.lyx.org
7846 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
7848 Of course you can still use all features with the help of some native \SpecialChar LaTeX
7850 commands (\SpecialChar TeX
7855 \begin_layout Plain Layout
7860 \begin_layout Plain Layout
7870 \begin_inset space ~
7874 \begin_inset CommandInset ref
7876 reference "sec:Inserting-TeX-Code"
7886 In this section, we can only list those features that are natively supported
7889 For detailed descriptions (and for the rest of features) we recommend you
7890 have a look at the detailed manual of the Memoir class
7894 \begin_layout Plain Layout
7899 \begin_layout Plain Layout
7909 \begin_inset Flex URL
7912 \begin_layout Plain Layout
7914 CTAN:/macros/latex/memoir/memman.pdf
7924 , which is not only a user guide for the class, but also both a comprehensive
7925 description on good typesetting and a superb example for good typesetting
7929 \begin_layout Subsubsection
7930 Basic features and restrictions
7933 \begin_layout Standard
7934 Memoir supports basically all features of the standard book classes.
7935 There are, however, some differences, as follows:
7938 \begin_layout Description
7940 \begin_inset space ~
7943 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
7946 \begin_layout Description
7948 \begin_inset space ~
7951 style: The fancy page style is not supported, due to a command clash between
7952 Memoir and the fancyhdr package (they both define a command with the same
7953 name, which confuses \SpecialChar LaTeX
7955 Instead, Memoir comes with a number of its own page styles (see
7957 Document\SpecialChar menuseparator
7958 Settings\SpecialChar menuseparator
7960 \begin_inset space ~
7966 If you want to use these for the chapter pages, you have to use the command
7973 in the main text or in preamble (e.
7974 \begin_inset space \thinspace{}
7978 \begin_inset space \space{}
7985 chapterstyle{companion}
7990 \begin_layout Description
7991 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
7992 optional argument in the standard classes.
7993 With this, you can specify an alternative version of the title for the
7994 table of contents and the headers (for instance, if the title is too long).
7996 , you can do this via
7998 Insert\SpecialChar menuseparator
8000 \begin_inset space ~
8005 at the beginning of a chapter/section.
8006 Memoir features a second optional argument and thus separates the table
8007 of contents from the header.
8008 You can define three variants of a title with this: one for the main text,
8009 one for the table of contents, and one for the headers.
8011 makes these available in form of specific
8022 \begin_layout Description
8023 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
8024 of contents, the list of figures and the list of table start a new page
8026 Memoir does not follow this route.
8027 You have to insert a page break yourself, if you want to have one.
8030 \begin_layout Description
8031 Titlepage: For some unknown reason, Memoir uses pagination on the title
8032 page (in the standard classes, title pages are
8033 \begin_inset Quotes eld
8037 \begin_inset Quotes erd
8041 If you want an empty title page, type
8045 aliaspagestyle{title}{empty}
8050 \begin_layout Description
8051 Article: With the class option
8057 Document\SpecialChar menuseparator
8058 Settings\SpecialChar menuseparator
8059 Class Settings\SpecialChar menuseparator
8061 \begin_inset space ~
8066 ), you can emulate article style.
8067 That is, counters (footnotes, figures, tables etc.) will not be reset on
8068 new chapters, chapters don't start a new page (but are—in contrary to
8069 \begin_inset Quotes eld
8073 \begin_inset Quotes erd
8076 article classes—still allowed), parts, though, use their own page, as in
8080 \begin_layout Description
8081 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
8082 font commands, which have been used in the old \SpecialChar LaTeX
8084 \begin_inset space \thinspace{}
8088 \begin_inset space \space{}
8104 It produces an error and stops \SpecialChar LaTeX
8105 whenever such a command appears.
8110 reallows the commands and spits out warnings instead (which does at least
8111 not stop \SpecialChar LaTeX
8113 Since a lot of packages and particularly Bib\SpecialChar TeX
8114 style files are still using
8115 those commands, we have decided to use this option by default.
8118 \begin_layout Subsubsection
8122 \begin_layout Standard
8123 We will only describe the features supported by \SpecialChar LyX
8124 (which is not much currently).
8125 Please consult the Memoir manual
8129 \begin_layout Plain Layout
8134 \begin_layout Plain Layout
8144 \begin_inset Flex URL
8147 \begin_layout Plain Layout
8149 CTAN:/macros/latex/memoir/memman.pdf
8162 \begin_layout Description
8163 Abstract: You may wonder why an abstract is an extra feature.
8164 Well, it is in book class.
8165 Usually books don't have abstracts.
8166 Memoir, however, has.
8167 You can use it wherever and how often you like.
8170 \begin_layout Description
8171 Chapterprecis: You may know this older typesetting style: The contents of
8172 a chapter are summarized below the title and also in the table of contents
8174 \begin_inset space \thinspace{}
8178 \begin_inset space \space{}
8183 Our hero arrives in Troia; he loses some friends; he finds others
8186 Chapterprecis does exactly this.
8187 It is therefore only sensible below a chapter.
8190 \begin_layout Description
8191 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
8192 The epigraph environment provides an elegant way of typesetting such a
8194 The motto itself (text) and its (optional) author (source) are divided
8196 The author (source) can be inserted via
8198 Insert\SpecialChar menuseparator
8205 \begin_layout Description
8206 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
8207 complex figurative poems).
8209 can only support a few of them.
8210 One is poemtitle, which is a centered title for poems, which will also
8211 be added to the table of contents (verse is the standard environment for
8213 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
8215 because they have to be nested inside regular verse environments, which
8216 is not possible with \SpecialChar LyX
8220 \begin_layout Description
8221 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
8224 \begin_layout Subsection
8226 \change_inserted 564990737 1671442175
8232 \begin_layout Standard
8234 \change_inserted 564990737 1671442175
8244 \begin_inset space \thinspace{}
8249 document class but adds two environments:
8252 \begin_layout Description
8254 \change_inserted 564990737 1671442175
8257 Recipe a numbered section environment at the
8261 level which generates a bold centered heading above a double horizontal
8265 \begin_layout Description
8267 \change_inserted 564990737 1671442175
8280 are what are being described and the environment ends with a horizontal
8284 \begin_layout Standard
8286 \change_inserted 564990737 1671642866
8290 File\SpecialChar menuseparator
8291 Open Example\SpecialChar menuseparator
8292 Books\SpecialChar menuseparator
8296 illustrates its use.
8299 \begin_layout Standard
8301 \change_inserted 564990737 1671442175
8304 It is designed for typesetting one or two recipes per page, with dimensions
8306 \begin_inset Quotes qrd
8310 \begin_inset Quotes qrd
8314 The hyperlinked table of contents (ToC) and page numbers make browsing
8315 recipes convenient, and the pages can be joined together or printed 2 per
8316 page to normal letterpaper easily.
8317 The size was chosen to work in half-page 3-ring binder cover sheets, because
8318 un-laminated paper just doesn't last in the kitchen.
8321 \begin_layout Standard
8323 \change_inserted 564990737 1671442175
8326 The half-letter pages can be printed two per page using your printer driver,
8327 or bound together using
8329 pdfjam --nup 2x1 --papersize '{11in,8.5in}'
8339 is the compiled version of your recipes.
8342 \begin_layout Section
8344 \change_inserted 564990737 1671442207
8348 \begin_layout Subsection
8350 \change_inserted 564990737 1671442208
8356 \begin_layout Standard
8358 \change_inserted 564990737 1671642942
8364 \begin_inset space \space{}
8368 \begin_inset space \thinspace{}
8377 document class, an unofficial implementation of the ‘Europass CV’ recommended
8378 by the European Commission in 2013.
8382 File\SpecialChar menuseparator
8383 Open Example\SpecialChar menuseparator
8384 Curricula Vitae\SpecialChar menuseparator
8388 offers guidance on its use.
8389 Its documentation is available from
8390 \begin_inset CommandInset href
8393 target "http://mirrors.ctan.org/macros/latex/contrib/europasscv/europasscv.pdf"
8401 \begin_layout Subsection
8403 \change_inserted 564990737 1671442208
8409 \begin_layout Standard
8411 \change_inserted 564990737 1671642984
8417 \begin_inset space \space{}
8421 \begin_inset space \thinspace{}
8430 document class, an unofficial implementation of the “Europass CV” recommended
8431 by the European Commission in 2002.
8435 File\SpecialChar menuseparator
8436 Open Example\SpecialChar menuseparator
8437 Curricula Vitae\SpecialChar menuseparator
8441 offers guidance on its use.
8442 Its documentation is available from
8443 \begin_inset CommandInset href
8446 target "http://mirrors.ctan.org/macros/latex/contrib/europecv/europecv.pdf"
8454 \begin_layout Subsection
8456 \change_inserted 564990737 1671442208
8462 \begin_layout Standard
8464 \change_inserted 564990737 1671643003
8470 \begin_inset space \space{}
8474 \begin_inset space \thinspace{}
8484 This allows the creation of customizable CVs.
8488 File\SpecialChar menuseparator
8489 Open Example\SpecialChar menuseparator
8490 Curricula Vitae\SpecialChar menuseparator
8494 offers guidance on its use.
8495 Its documentation is available from
8496 \begin_inset CommandInset href
8499 target "http://mirrors.ctan.org/macros/latex/contrib/moderncv/manual/moderncv_userguide.pdf"
8507 \begin_layout Subsection
8509 \change_inserted 564990737 1671442208
8515 \begin_layout Standard
8517 \change_inserted 564990737 1671643024
8523 \begin_inset space \space{}
8527 \begin_inset space \thinspace{}
8536 document class, originally developed for use with \SpecialChar LyX
8541 File\SpecialChar menuseparator
8542 Open Example\SpecialChar menuseparator
8543 Curricula Vitae\SpecialChar menuseparator
8547 offers guidance on its use.
8548 Its documentation is available from
8549 \begin_inset CommandInset href
8552 target "http://mirrors.ctan.org/macros/latex/contrib/simplecv/simplecv.pdf"
8560 \begin_layout Section
8562 \change_inserted 564990737 1671041968
8566 \begin_layout Subsection
8568 \change_inserted 564990737 1671041970
8574 \begin_layout Standard
8576 \change_inserted 564990737 1671617528
8587 document class for writing letters according to the
8589 Deutsches Institut für Normung
8592 The file in the menu
8597 ile\SpecialChar menuseparator
8599 \begin_inset space ~
8607 \begin_inset space ~
8610 Template\SpecialChar menuseparator
8611 Letters\SpecialChar menuseparator
8614 offers guidance on its use.
8615 The documentation is available from
8616 \begin_inset CommandInset href
8619 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
8627 \begin_layout Subsection
8629 \change_inserted 564990737 1671458835
8635 \begin_layout Standard
8637 \change_inserted 564990737 1671617591
8648 document class for English letters and to create mailing labels.
8649 The file in the menu
8654 ile\SpecialChar menuseparator
8656 \begin_inset space ~
8664 \begin_inset space ~
8667 Template\SpecialChar menuseparator
8668 Letters\SpecialChar menuseparator
8669 Letter (Standard Class)
8671 offers guidance on its use.
8674 \begin_layout Section
8676 \change_inserted 564990737 1670439660
8680 \begin_layout Subsection
8682 \change_inserted 564990737 1671458922
8688 \begin_layout Standard
8690 \change_inserted 564990737 1671617655
8696 \begin_inset space \thinspace{}
8705 document class for creating presentations.
8706 The file in the menu
8711 ile\SpecialChar menuseparator
8713 \begin_inset space ~
8721 \begin_inset space ~
8724 Template\SpecialChar menuseparator
8725 Presentations\SpecialChar menuseparator
8728 offers guidance on its use.
8729 The documentation is available from
8730 \begin_inset CommandInset href
8733 target "http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf"
8741 \begin_layout Subsection
8744 Foil\SpecialChar TeX
8748 \begin_inset CommandInset label
8757 \begin_layout Standard
8763 \begin_layout Subsubsection
8767 \begin_layout Standard
8768 This section describes how to use \SpecialChar LyX
8769 to make slides for overhead projectors.
8770 There are two document classes that can do this: the default slides class
8773 Foil\SpecialChar TeX
8777 This section documents the latter.
8780 \begin_layout Standard
8781 I'm going to say this again, nice and clear, so that there's no misunderstanding
8785 \begin_layout Standard
8786 \begin_inset VSpace bigskip
8792 \begin_layout Standard
8796 This section documents the class
8797 \begin_inset Quotes eld
8805 \begin_inset Quotes erd
8813 \begin_layout Standard
8814 \begin_inset VSpace bigskip
8820 \begin_layout Standard
8821 If you're looking for the documentation for
8822 \begin_inset Quotes eld
8830 \begin_inset Quotes erd
8834 \begin_inset space ~
8838 \begin_inset CommandInset ref
8840 reference "sec:slitex"
8845 If your machine doesn't have the
8853 installed, you'll probably have to use the default
8857 class, which isn't quite as good as
8862 \begin_layout Standard
8867 class is designed for use with version
8868 \begin_inset space ~
8876 class file which is now an integral part of \SpecialChar LaTeX2e
8880 \begin_layout Subsubsection
8884 \begin_layout Standard
8885 Obviously, to use this document class, you need to select
8896 \begin_inset space ~
8902 There are some settings in the
8905 \begin_inset space ~
8910 dialog that you should know about that are specific to this class:
8913 \begin_layout Itemize
8914 Don't change the options
8925 \begin_inset space ~
8931 They're ignored by the
8938 \begin_layout Itemize
8939 The default font size is 20
8940 \begin_inset space \thinspace{}
8943 pt with the other options being 17
8944 \begin_inset space \thinspace{}
8948 \begin_inset space \thinspace{}
8952 \begin_inset space \thinspace{}
8958 \begin_layout Itemize
8967 but all math equations are still typeset in the usual roman font.
8970 \begin_layout Itemize
8973 Foil\SpecialChar TeX
8976 supports A4 and Letter paper sizes as well as a special size for working
8978 \begin_inset space \thinspace{}
8982 It doesn't support A5, B5, legal or executive paper sizes.
8985 \begin_layout Itemize
8986 Don't bother changing the
8990 settings because they are ignored anyway.
8991 All floats appear where they are defined in the text.
8994 \begin_layout Itemize
8999 setting behaves a bit differently for this class.
9002 Foil\SpecialChar TeX
9005 provides extensive footer and header capabilities including a user-defined
9008 \begin_inset space ~
9012 \begin_inset CommandInset ref
9014 reference "sec:foilfoot"
9019 The title page is treated differently to all other pages in the document
9028 has the logo centered at the bottom of the page (if one is defined).
9029 The possible page style choices and what they do are as follows:
9033 \begin_layout Labeling
9034 \labelwidthstring MMMMMMM
9041 The final output contains no page numbers, or other headers or footers
9042 (except footnotes of course).
9046 \begin_layout Labeling
9047 \labelwidthstring MMMMMMM
9054 The final output contains page numbers centered at the bottom of the page.
9055 No other headings or footers (other than footnotes).
9058 \begin_layout Labeling
9059 \labelwidthstring MMMMMMM
9064 Page numbers in lower right corner.
9065 Additional headers and footers are also shown.
9066 This is also the default.
9069 \begin_layout Labeling
9070 \labelwidthstring MMMMMMM
9075 Gives you access to the
9079 package although its use with
9081 Foil\SpecialChar TeX
9084 is discouraged by the writer of the
9086 Foil\SpecialChar TeX
9089 package because of some potential page layout clashes.
9093 \begin_layout Paragraph
9097 \begin_layout Standard
9098 The following options may be used in the extra class options in the
9100 Document\SpecialChar menuseparator
9106 \begin_layout Labeling
9107 \labelwidthstring MMMMMMx
9112 This sets up the page layout for 7.33
9113 \begin_inset space \thinspace{}
9117 \begin_inset space \thinspace{}
9120 in paper, which is about the same aspect ratio as a 35
9121 \begin_inset space \thinspace{}
9124 mm slide, making it a bit easier to work with this medium.
9127 \begin_layout Labeling
9128 \labelwidthstring MMMMMMx
9133 Places a rule across the page below the header on every page except the
9137 \begin_layout Labeling
9138 \labelwidthstring MMMMMMx
9143 Places a rule across the page above the footer on every page except the
9147 \begin_layout Labeling
9148 \labelwidthstring MMMMMMx
9153 This is automatically set each time you create a new
9160 Foil\SpecialChar TeX
9163 to use the dvips driver to rotate those pages that are set as landscape
9167 \begin_layout Labeling
9168 \labelwidthstring MMMMMMx
9173 Simply changes the page dimensions to those of a landscape page but doesn't
9175 Thus if you use this option you need to use an external program to rotate
9176 each page or feed your paper through your printer as landscape.
9177 Note that this option effectively reverses the roles of the
9185 environments (don't worry these are described in the next section).
9188 \begin_layout Labeling
9189 \labelwidthstring MMMMMMx
9194 Equation numbers on the left.
9197 \begin_layout Labeling
9198 \labelwidthstring MMMMMMx
9203 Flush-left equations.
9206 \begin_layout Subsubsection
9207 Supported Environments
9210 \begin_layout Standard
9211 Most of the environments commonly supported in other classes are also supported
9217 There are several additional environments provided by
9219 Foil\SpecialChar TeX
9222 as well as a couple added by \SpecialChar LyX
9224 The following environments are shared with other classes:
9227 \begin_layout Standard
9228 \begin_inset Flex Multiple Columns
9231 \begin_layout Itemize
9237 \begin_layout Itemize
9243 \begin_layout Itemize
9249 \begin_layout Itemize
9255 \begin_layout Itemize
9261 \begin_layout Itemize
9268 \begin_layout Itemize
9274 \begin_layout Itemize
9280 \begin_layout Itemize
9286 \begin_layout Itemize
9292 \begin_layout Itemize
9298 \begin_layout Itemize
9304 \begin_layout Itemize
9310 \begin_layout Itemize
9316 \begin_layout Itemize
9327 \begin_layout Standard
9328 That is, all the major environments apart from the sectioning environments.
9329 Since foils are essentially self-contained sections, with a title and body,
9332 Foil\SpecialChar TeX
9335 provides specific commands for starting new foils and these are:
9338 \begin_layout Itemize
9344 \begin_layout Itemize
9350 \begin_layout Standard
9352 also provides slightly modified versions of these two environments called:
9355 \begin_layout Itemize
9361 \begin_layout Itemize
9367 \begin_layout Standard
9368 and the differences will be explained in the next section.
9371 \begin_layout Standard
9372 Since foils are often used in presenting ideas or new theorems and such
9375 Foil\SpecialChar TeX
9378 also provides a comprehensive box of goodies for presenting them:
9381 \begin_layout Standard
9382 \begin_inset Flex Multiple Columns
9385 \begin_layout Itemize
9391 \begin_layout Itemize
9397 \begin_layout Itemize
9403 \begin_layout Itemize
9409 \begin_layout Itemize
9415 \begin_layout Itemize
9421 \begin_layout Itemize
9427 \begin_layout Itemize
9433 \begin_layout Itemize
9439 \begin_layout Itemize
9445 \begin_layout Itemize
9456 \begin_layout Standard
9457 The starred versions are unnumbered while the unstarred versions are numbered.
9458 There are also two list environments added by \SpecialChar LyX
9462 \begin_layout Itemize
9468 \begin_layout Itemize
9474 \begin_layout Standard
9477 Foil\SpecialChar TeX
9480 provides some powerful header and footer capabilities that are best set
9481 in the preamble although they may be set at any point in a document.
9482 If you want to change these settings in your document the best place to
9483 do so is at the very top of a foil, i.
9484 \begin_inset space \thinspace{}
9490 \begin_inset space \space{}
9495 straight after the foilhead.
9498 \begin_layout Standard
9499 For this purpose, the following command styles are provided [
9506 \begin_layout Standard
9507 \begin_inset Flex Multiple Columns
9510 \begin_layout Itemize
9514 \begin_inset space ~
9520 \begin_layout Itemize
9526 \begin_layout Itemize
9530 \begin_inset space ~
9536 \begin_layout Itemize
9540 \begin_inset space ~
9546 \begin_layout Itemize
9550 \begin_inset space ~
9557 \begin_layout Plain Layout
9558 \begin_inset space ~
9570 \begin_layout Standard
9571 There are also a few commands provided by
9573 Foil\SpecialChar TeX
9576 that aren't directly supported by \SpecialChar LyX
9577 but I'll tell you what they do and how
9578 to use them in section
9579 \begin_inset space ~
9583 \begin_inset CommandInset ref
9585 reference "sec:unsuppfoils"
9592 \begin_layout Subsubsection
9593 Building a Set of Foils
9596 \begin_layout Standard
9597 This section will give a simple introduction to using the different environments
9598 to build a set of foils.
9599 If you want to see an example set of foils, take a look at
9600 \change_deleted 564990737 1671643085
9605 file you find in \SpecialChar LyX
9611 \change_inserted 564990737 1671643099
9615 File\SpecialChar menuseparator
9618 \SpecialChar menuseparator
9619 Presentations\SpecialChar menuseparator
9627 \begin_layout Paragraph
9628 Give It a Title Page
9631 \begin_layout Standard
9632 Unlike other classes that provide
9652 creates the title on a page of its own.
9653 If you leave out the
9657 environment \SpecialChar LaTeX
9658 will substitute the current date (every time you regenerate
9662 \begin_layout Paragraph
9666 \begin_layout Standard
9667 As I mentioned earlier, there are four ways of starting a new foil.
9668 For portrait foils you should use
9677 The difference between these two environments is the amount of space between
9678 the title of the foil (the foilhead) and the body of the foil.
9681 \begin_layout Standard
9682 Landscape foils are generated using the
9691 Again the only difference is the spacing between foilhead and body.
9692 Both of the short versions have 0.5
9693 \begin_inset space ~
9696 inches less separation between the foilhead and the body.
9700 \begin_layout Standard
9701 One problem with the support for landscape foils is the requirement that
9706 driver to generate the PostScript output otherwise the foils won't be rotated.
9707 It is possible to get landscape foils even if you haven't got the
9711 driver provided you can feed your foils sideways through your printer ;-)
9714 \begin_layout Paragraph
9715 Theorems, Lemmas, Proofs and more
9718 \begin_layout Standard
9719 You can't have two of the same type of these environments directly following
9721 If you use a normal paragraph break, , you will just be extending the previous
9722 environment as if you had merged the two environments together.
9723 Rather than that, you need to insert a so-called separator.
9724 Please refer to the section entitled
9735 \begin_layout Paragraph
9739 \begin_layout Standard
9740 You get all the commonly supported list styles found in other classes as
9741 well as two new ones.
9742 I'll only describe the new ones here.
9743 If you want to find out more about the other list environments check out
9749 If you intend to use itemized lists you might also want to read about the
9753 \begin_inset space ~
9757 \begin_inset space ~
9762 dialog described above in section
9763 \begin_inset space ~
9767 \change_inserted 564990737 1671355684
9769 \begin_inset CommandInset ref
9771 reference "chap:bullets"
9776 \change_deleted 564990737 1671355684
9778 \begin_inset CommandInset ref
9780 reference "sec:bullet"
9789 \begin_layout Standard
9790 The two new list styles,
9798 , are designed to make it easier for you to create lists of do's and don'ts
9799 or right and wrong by providing dedicated environments that use a tick
9800 or a cross as the label of the list.
9801 These lists are in fact dedicated variants of the
9806 They do however require that you have the
9813 \begin_layout Paragraph
9817 \begin_layout Standard
9820 Foil\SpecialChar TeX
9823 redefines the floating tables and figures so that they appear exactly where
9824 they are in the text rather than pushing them to the top of the page or
9825 to some user specified location.
9826 In fact if you change the float placement settings they are simply ignored.
9829 \begin_layout Paragraph
9830 Page Headers and Footers
9831 \begin_inset CommandInset label
9840 \begin_layout Standard
9844 \begin_inset space ~
9853 are two commands used to control the left-footer text string.
9854 The first is meant to allow you to include a graphic logo on your foils
9856 \begin_inset Quotes eld
9861 Foil\SpecialChar TeX
9865 \begin_inset Quotes erd
9869 While the second is meant to provide a classification for the audience,
9873 \begin_inset space \thinspace{}
9879 \begin_inset space \space{}
9883 It is empty by default.
9886 \begin_layout Standard
9887 The remaining page corners can be filled by
9890 \begin_inset space ~
9895 (which defaults to page numbers),
9898 \begin_inset space ~
9906 \begin_inset space ~
9914 \begin_layout Subsubsection
9917 Foil\SpecialChar TeX
9921 \begin_inset CommandInset label
9923 name "sec:unsuppfoils"
9930 \begin_layout Standard
9931 All the commands mentioned below need to be set in a
9941 within another environment.
9944 \begin_layout Paragraph
9948 \begin_layout Standard
9949 All lengths are adjusted using the
9972 should be replaced by the name given to the length you want to change and
9977 is the length value.
9978 All lengths should be specified in units of length such as inches (
9990 ) or relative to some document or font-based length such as
10000 \begin_layout Standard
10001 It's possible to change the spacing between a foilhead and the body of the
10002 foil by adjusting the length specified by
10009 For example, to make
10014 \begin_inset space \space{}
10017 in closer to their bodies put the following in the preamble:
10023 foilheadskip}{-0.5in}
10026 \begin_layout Standard
10027 The spacings around floats can be adjusted by setting these lengths:
10030 \begin_layout Labeling
10031 \labelwidthstring MMMMMMMMMMM
10038 Separation between the text and the top of the float
10041 \begin_layout Labeling
10042 \labelwidthstring MMMMMMMMMMM
10049 Separation between the float and the caption
10052 \begin_layout Labeling
10053 \labelwidthstring MMMMMMMMMMM
10060 Separation between the caption and the following text
10063 \begin_layout Labeling
10064 \labelwidthstring MMMMMMMMMMM
10071 You can make the captions narrower than the surrounding text by adjusting
10073 Best done relative to
10082 \begin_layout Standard
10083 There are also several title page related lengths that you may find useful
10084 if you have a long title or several authors:
10087 \begin_layout Labeling
10088 \labelwidthstring MMMMMMMMMMM
10095 Separation from headers to
10100 \begin_layout Labeling
10101 \labelwidthstring MMMMMMMMMMM
10119 \begin_layout Labeling
10120 \labelwidthstring MMMMMMMMMMM
10134 \begin_layout Labeling
10135 \labelwidthstring MMMMMMMMMMM
10151 \begin_layout Labeling
10152 \labelwidthstring MMMMMMMMMMM
10168 \begin_layout Standard
10169 The last length related command affects all the list environments.
10180 a list environment then all the vertical spacing between the list items
10182 Note that this is a command not a length so it doesn't require
10188 like the stuff mentioned above.
10191 \begin_layout Paragraph
10192 Headers and Footers
10195 \begin_layout Standard
10208 commands control whether the logo in the
10212 definition appear on a given page.
10219 in the preamble then none of the foils will have the logo on them.
10220 If you don't want the logo on a particular page place the
10226 directly after the foilhead of that page and the
10232 directly after the next foilhead.
10235 \begin_layout Standard
10236 If you decide to use the
10240 page style setting in the
10243 \begin_inset space ~
10248 dialog you should probably add
10258 to your preamble so headers and footers on landscape pages are correctly
10259 placed when rotated.
10260 This is due to some clashes between the page layouts provided by the
10271 \begin_layout Subsection
10273 \change_inserted 564990737 1671459032
10279 \begin_layout Standard
10281 \change_inserted 564990737 1671643165
10287 \begin_inset space \thinspace{}
10296 document class for creating presentations.
10300 File\SpecialChar menuseparator
10301 Open Example\SpecialChar menuseparator
10302 Presentations\SpecialChar menuseparator
10306 offers guidance on its use.
10307 The documentation is available from
10308 \begin_inset CommandInset href
10311 target "http://mirrors.ctan.org/macros/latex/contrib/powerdot/doc/powerdot.pdf"
10319 \begin_layout Subsection
10321 \change_inserted 564990737 1671459032
10324 \begin_inset CommandInset label
10326 name "subsec:Seminar"
10335 \begin_layout Standard
10337 \change_inserted 564990737 1671643194
10343 \begin_inset space \thinspace{}
10352 document class for creating presentations.
10356 File\SpecialChar menuseparator
10357 Open Example\SpecialChar menuseparator
10358 Presentations\SpecialChar menuseparator
10362 offers guidance on its use.
10363 The documentation is available from
10364 \begin_inset CommandInset href
10367 target "http://mirrors.ctan.org/macros/latex/contrib/seminar/doc/seminar-doc.pdf"
10375 \begin_layout Subsection
10378 Sli\SpecialChar TeX
10382 \begin_inset CommandInset label
10391 \begin_layout Standard
10399 \begin_layout Subsubsection
10403 \begin_layout Standard
10404 This section describes how to use \SpecialChar LyX
10405 to make slides for overhead projectors.
10406 There are two document classes that can do this: the default slides class
10409 Foil\SpecialChar TeX
10413 This section documents the former.
10416 \begin_layout Standard
10417 I'm going to say this again, nice and clear, so that there's no misunderstanding
10421 \begin_layout Standard
10422 \begin_inset VSpace bigskip
10428 \begin_layout Standard
10432 This section documents the class
10433 \begin_inset Quotes eld
10441 \begin_inset Quotes erd
10449 \begin_layout Standard
10450 \begin_inset VSpace bigskip
10456 \begin_layout Standard
10457 If you're looking for the documentation for
10458 \begin_inset Quotes eld
10463 slides (Foil\SpecialChar TeX
10467 \begin_inset Quotes erd
10470 , check out section
10471 \begin_inset space ~
10475 \begin_inset CommandInset ref
10477 reference "sec:foiltex"
10487 \begin_inset Quotes eld
10492 slides (Foil\SpecialChar TeX
10496 \begin_inset Quotes erd
10499 ] is actually somewhat better than the default
10507 \begin_layout Plain Layout
10509 or so I've been told repeatedly by its advocates.
10510 Having never used it, I have no idea if this claim is true or not.
10515 which this section documents.
10518 \begin_layout Standard
10519 This class is the \SpecialChar LaTeX2e
10520 improvement of the old
10522 Sli\SpecialChar TeX
10526 Every \SpecialChar LaTeX2e
10527 distribution includes this class [which I'll just refer to as
10528 \begin_inset Quotes eld
10536 \begin_inset Quotes erd
10539 from now on], so you're bound to have it.
10540 As I noted earlier, there are other classes, such as
10544 , which also produce slides for overhead projectors and do a better job
10546 However, there are some things which
10550 can do which the others can't, such as generate overlays.
10551 Read on to learn more!
10554 \begin_layout Subsubsection
10556 \begin_inset CommandInset label
10558 name "sec:slidesetup"
10565 \begin_layout Standard
10566 Obviously, to use this document class, you need to select
10567 \begin_inset Quotes eld
10575 \begin_inset Quotes erd
10578 from the class list in the
10580 Document\SpecialChar menuseparator
10584 There are some other special things you should know about this class:
10587 \begin_layout Itemize
10588 Don't bother changing the options
10593 They're not supported by the
10600 \begin_layout Itemize
10604 \begin_inset space ~
10609 behaves a bit differently for this class.
10610 The possible choices and what they do are as follows:
10614 \begin_layout Description
10619 The final output contains page numbers in the lower right corner.
10622 \begin_layout Description
10631 , but also prints out any time markers you've put in.
10632 This is the default.
10635 \begin_layout Description
10640 The final output contains no page numbers, time markers, or alignment markers.
10644 \begin_layout Itemize
10649 class has an extra option:
10655 \begin_inset Quotes eld
10663 \begin_inset Quotes erd
10666 in the extra class options.
10670 \begin_layout Standard
10671 Using this options allows you to add time markers to
10677 \begin_inset space ~
10681 \begin_inset CommandInset ref
10683 reference "sec:slideNote"
10691 \begin_layout Standard
10692 You can also use the template file
10693 \change_deleted 564990737 1671617694
10695 \begin_inset Quotes eld
10703 \begin_inset Quotes erd
10708 to automatically set up a document to use the
10713 \change_deleted 564990737 1671617699
10718 File\SpecialChar menuseparator
10720 \begin_inset space ~
10724 \begin_inset space ~
10728 \change_inserted 564990737 1671617723
10729 \SpecialChar menuseparator
10730 Presentations\SpecialChar menuseparator
10735 to open your new document
10736 \change_deleted 564990737 1671617728
10740 The template file also contains some examples of the special paragraph
10741 environments used by this class.
10742 I'll describe those next.
10745 \begin_layout Subsubsection
10746 Paragraph Environments
10749 \begin_layout Paragraph
10750 Supported Environments
10753 \begin_layout Standard
10754 The first thing you'll notice when you start up a new
10758 document is the font size and type: it's the equivalent of the size
10759 \begin_inset Quotes eld
10767 \begin_inset Quotes erd
10773 \begin_inset space ~
10779 This is also what's used in the output.
10781 \begin_inset Quotes eld
10785 \begin_inset Quotes erd
10788 to remind you that this is a slide.
10789 Your final slides will use a larger font; ergo, you'll have less space.
10790 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
10793 \begin_layout Standard
10794 The next thing that becomes obvious is the changes to the paragraph environment
10795 pull-down box [at the far-left end of the toolbar].
10796 Most of the paragraph environments you're used to seeing are missing.
10797 There are also five new ones.
10802 class itself only supports certain paragraph environments:
10805 \begin_layout Itemize
10811 \begin_layout Itemize
10817 \begin_layout Itemize
10823 \begin_layout Itemize
10829 \begin_layout Itemize
10835 \begin_layout Itemize
10841 \begin_layout Itemize
10847 \begin_layout Itemize
10853 \begin_layout Itemize
10859 \begin_layout Itemize
10866 \begin_layout Standard
10867 All of the other standard environments, including the section-heading environmen
10868 ts, aren't used in the
10875 \begin_layout Standard
10876 On the other hand, you'll notice the following new environments:
10879 \begin_layout Itemize
10885 \begin_layout Itemize
10891 \begin_layout Itemize
10897 \begin_layout Itemize
10903 \begin_layout Itemize
10909 \begin_layout Standard
10910 These five are kind of quirky, due to a
10911 \begin_inset Quotes eld
10915 \begin_inset Quotes erd
10918 in \SpecialChar LyX
10920 You see, \SpecialChar LyX
10921 doesn't permit you to nest any other paragraph environment into
10922 an empty environment.
10923 Now, that's fine and dandy, but it means that you wouldn't be able to start
10924 a slide with anything except plain text.
10925 To deal with this, I've performed a little
10926 \begin_inset Quotes eld
10931 \begin_inset Quotes erd
10937 \begin_layout Paragraph
10938 Quirks of the New Environments
10939 \begin_inset CommandInset label
10941 name "sec:slideQuirk"
10948 \begin_layout Standard
10949 All five of the new paragraph environments are somewhat quirky due to inherent
10950 limitiations in the current version of \SpecialChar LyX
10952 As I just mentioned, \SpecialChar LyX
10953 forbids environments that begin with another environment.
10954 To get around this, the
10958 environment isn't a paragraph environment as described in the
10966 \begin_layout Standard
10967 You should consider
10980 \begin_inset Quotes eld
10983 pseudo-environments.
10984 \begin_inset Quotes erd
10987 They look like a section heading or a
10988 \begin_inset Quotes eld
10996 \begin_inset Quotes erd
10999 but really begin a [and, if necessary, end the previous] paragraph environment.
11009 \begin_inset Quotes eld
11013 \begin_inset Quotes erd
11016 These two perform some action.
11019 \begin_layout Standard
11020 A common feature of all five environments,
11040 , is a rather long-ish label.
11041 The text following this label — ordinarily the contents of the paragraph
11042 environment — is utterly irrelevant for
11064 completely ignores it.
11065 In fact, you can leave these five environments completely empty.
11069 \begin_layout Standard
11074 to put any text after the rather long-ish label, you might want to.
11075 This could be a short description of the contents of the
11080 In that case, enter your descriptive comment and hit
11084 as you normally would.
11087 \begin_layout Standard
11088 If, on the other hand, you don't want to enter any descriptive text, you'll
11089 hit another \SpecialChar LyX
11092 , like nature, abhors a vacuum, and will not let you start a new paragraph
11093 environment until you put something in the old one.
11097 \begin_layout Itemize
11098 Start entering the text that will
11126 \begin_layout Itemize
11127 Now move to the beginning of that paragraph.
11131 \begin_layout Itemize
11140 \begin_layout Itemize
11141 Finally, change this new, empty paragraph to a
11165 \begin_layout Standard
11166 Some future version of \SpecialChar LyX
11167 will, hopefully, resolve this quirkiness\SpecialChar ldots
11171 \begin_layout Subsubsection
11172 Making a Presentation with
11185 \begin_layout Paragraph
11193 \begin_layout Standard
11194 If you're expecting this section to teach you how to actually make a presentatio
11195 n, you'll be sorely disappointed.
11196 Naturally, I'll describe all of the ways the
11200 class can assist you in preparing the materials for a presentation.
11201 Filling in the contents, however, is up to you.
11206 the \SpecialChar LyX
11210 \begin_layout Standard
11215 environment [in the manner described in section
11216 \begin_inset space ~
11220 \begin_inset CommandInset ref
11222 reference "sec:slideQuirk"
11226 ] tells \SpecialChar LyX
11227 to begin a new slide [duh].
11228 The label for this environment/
11229 \begin_inset Quotes erd
11233 \begin_inset Quotes erd
11237 \begin_inset Quotes eld
11241 \begin_inset Quotes erd
11244 in cool blue, followed by the label,
11245 \begin_inset Quotes eld
11249 \begin_inset Quotes erd
11253 Any text or paragraph environments that follow this one go on the new slide.
11257 \begin_layout Standard
11258 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
11260 (this can be specified in the
11265 In fact, you'll want to, once you finish entering the contents of one slide.
11266 If you've entered more text than can physically fit on a slide, the extra
11267 overflows onto a new slide.
11268 I don't recommend doing this, however, since the overflow slide won't have
11269 any page number on it.
11270 Furthermore, it may interfere with any
11274 you've made to accompany the oversized
11281 \begin_layout Standard
11290 environments work the same way as the
11295 They both create an
11296 \begin_inset Quotes eld
11300 \begin_inset Quotes erd
11303 followed by a label [
11304 \begin_inset Quotes eld
11308 \begin_inset Quotes erd
11312 \begin_inset Quotes eld
11316 \begin_inset Quotes erd
11320 The color is a stunning magenta instead of blue, and the
11321 \begin_inset Quotes eld
11325 \begin_inset Quotes erd
11328 will look different, in style and in length.
11329 The label fonts of all three also differ from one another.
11332 \begin_layout Standard
11337 , if the contents of a
11345 exceed the physical size of a slide or sheet of paper, the extra will overflow
11347 Again, you should avoid this.
11348 It defeats the whole purpose of
11359 \begin_layout Paragraph
11369 \begin_layout Standard
11374 is a slide that sits atop another slide.
11375 Perhaps you wish to discuss a figure on the main
11379 before displaying the text associated with it.
11380 One way to accomplish this is tape a flap of dark paper over the part of
11385 you want to display later.
11386 This method fails, however, if you wish to overlap one graph with another,
11388 You would then have to fumble while speaking to align the two separate,
11393 s to align the two graphs.
11398 environment in both cases makes life much easier.
11401 \begin_layout Standard
11406 receives the page number of its
11407 \begin_inset Quotes eld
11411 \begin_inset Quotes erd
11419 \begin_inset Quotes eld
11427 \begin_inset Quotes erd
11434 \begin_layout Plain Layout
11435 Presumably, mutliple
11440 \begin_inset Quotes eld
11448 \begin_inset Quotes erd
11452 \begin_inset Quotes eld
11460 \begin_inset Quotes erd
11464 \begin_inset Quotes eld
11472 \begin_inset Quotes erd
11476 \begin_inset space ~
11479 appended to the page number of the parent
11489 Clearly, you want the contents of both the
11497 to each fit on a single physical slide! You should probably consider an
11503 \begin_inset Quotes eld
11507 \begin_inset Quotes erd
11515 Indeed, the \SpecialChar LyX
11520 class provides a visual cue for this: the label at the start of an
11524 is shorter than that at the start of a
11529 Lastly, when you generate printable output, you'll find alignment markers
11530 in all four corners of both the
11534 page and its parent
11539 These will assist you in lining up the two physical slides.
11542 \begin_layout Standard
11543 The major problem in overlaying two slides is aligning the contents of the
11544 two transparencies.
11545 How much space should you leave for that graph on the second slide? Worse
11546 still, what if you want a graph and a sentence on second slide, but there
11547 is text on the main transparency that goes in between them? You could try
11548 and insert vertical space of the right size.
11549 The better way is to use
11560 \begin_layout Standard
11561 As their names imply,
11569 are two command-like paragraph environments that make all subsequent text
11570 invisible and visible, respectively.
11572 \begin_inset space ~
11576 \begin_inset CommandInset ref
11578 reference "sec:slideQuirk"
11582 that you don't place anything
11586 these two environments, however.
11591 , it inserts a centered, sky-blue label into the page reading
11592 \begin_inset Quotes eld
11595 <Invisible Text Follows>
11596 \begin_inset Quotes erd
11600 For paragraphs following this label, the parts of the
11608 ; it doesn't matter which] where they would be contain instead blank space.
11612 \begin_layout Standard
11617 , the corresponding centered label is
11618 \begin_inset Quotes eld
11621 <Visible Text Follows>
11622 \begin_inset Quotes erd
11626 Paragraphs following this label behave normally.
11627 Note that the beginning of a new
11639 automatically shuts off an
11644 It's therefore not necessary to use
11655 \begin_layout Standard
11656 By now, it should be obvious how to create overlay transparencies using
11657 the proper combination of
11676 \begin_layout Enumerate
11681 , including everything that will appear on it, whether on the main slide
11689 \begin_layout Enumerate
11690 Before each figure or paragraph that will appear only on the
11699 If necessary, insert a
11703 environment after the
11710 \begin_layout Enumerate
11715 immediately following the
11722 \begin_layout Enumerate
11723 Copy the contents of this
11734 \begin_layout Enumerate
11739 , change all of the
11750 \begin_layout Standard
11752 You've just made an
11759 \begin_layout Standard
11760 There's one problem with the way I've designed the \SpecialChar LyX
11765 class: you can't make text in the middle of a paragraph invisible, nor
11766 make text in the middle of an invisible paragraph visible again.
11767 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
11772 \begin_layout Plain Layout
11773 The commands of interest are:
11776 \begin_layout Itemize
11781 invisible \SpecialChar ldots
11785 \begin_layout Itemize
11790 visible \SpecialChar ldots
11794 \begin_layout Plain Layout
11796 and need to be marked as \SpecialChar TeX
11799 \begin_inset Quotes eld
11803 \begin_inset Quotes erd
11806 you wish to change goes in between the brackets [and after the
11819 If you don't know how to mark text as \SpecialChar TeX
11820 , see the appropriate section of
11833 \begin_layout Paragraph
11843 \begin_inset CommandInset label
11845 name "sec:slideNote"
11852 \begin_layout Standard
11861 is associated with a
11862 \begin_inset Quotes eld
11866 \begin_inset Quotes erd
11874 Here, too, the \SpecialChar LyX
11879 class provides visual cues.
11884 is shorter than that of a
11888 [yet longer than that of an
11892 ] and, like the label of an
11896 is shockingly magenta.
11897 Additionally, the printed
11901 has the page number of its
11902 \begin_inset Quotes eld
11906 \begin_inset Quotes erd
11914 \begin_inset Quotes eld
11922 \begin_inset Quotes erd
11926 \begin_inset Quotes eld
11934 \begin_inset Quotes erd
11938 \begin_inset Quotes eld
11946 \begin_inset Quotes erd
11950 You can have multiple
11954 s associated with a single
11966 , you'll probably want to break up long
11970 s so that they fit on a single sheet of paper.
11973 \begin_layout Standard
11978 is obvious: it contains anything additional you might want to say about
11984 It could also be used as a sheet of reminders for a particular
11989 In the case of the latter, you might want to make use of time markers.
11990 Currently, the \SpecialChar LyX
11996 \begin_inset Quotes eld
12000 \begin_inset Quotes erd
12003 support for time markers, a
12005 Sli\SpecialChar TeX
12009 So, you'll have to resort to using the \SpecialChar LaTeX
12013 \begin_layout Standard
12014 To use time markers, you'll need to specify the extra class option
12015 \begin_inset Quotes eld
12023 \begin_inset Quotes erd
12027 \begin_inset space ~
12031 \begin_inset CommandInset ref
12033 reference "sec:slidesetup"
12038 This option turns on timing marks, which will appear in the lower-left-hand
12044 To set what appears in the time marker, you use the \SpecialChar LaTeX
12046 \begin_inset Quotes eld
12056 \begin_inset Quotes erd
12060 \begin_inset Quotes eld
12070 \begin_inset Quotes erd
12074 The arguments of both commands are time measured in seconds.
12076 \begin_inset Quotes eld
12086 \begin_inset Quotes erd
12089 sets the time marker to a given time.
12091 \begin_inset Quotes eld
12101 \begin_inset Quotes erd
12104 increments the time marker by the specified amount.
12105 Using time markers and
12109 s in this fashion, you can remind yourself how much time to spend on a particula
12117 \begin_layout Standard
12118 There's one last feature to describe.
12119 Clearly, you'd like to print out all of your
12127 s on transparencies while printing all of your
12144 with which it is associated.
12145 What's a person to do?
12148 \begin_layout Standard
12149 Luckily, there are two \SpecialChar LaTeX
12150 commands that allow you to select what to print
12152 Both must be placed into the preamble of your document.
12154 \begin_inset Quotes eld
12166 \begin_inset Quotes erd
12169 will cause the output to contain only the
12178 Correspondingly, the command
12179 \begin_inset Quotes eld
12191 \begin_inset Quotes erd
12194 prevents the output of anything but
12199 I'd advise placing both commands in the preamble and initially comment
12201 You can then preview your entire presentation as you write.
12202 When you're done writing, you can then uncomment one of the two to select
12203 what you want to print.
12204 I like to uncomment
12205 \begin_inset Quotes eld
12217 \begin_inset Quotes erd
12220 , print to a file with
12221 \begin_inset Quotes eld
12229 \begin_inset Quotes erd
12232 in its name, comment it back out, then uncomment
12233 \begin_inset Quotes eld
12245 \begin_inset Quotes erd
12249 \begin_inset Quotes eld
12257 \begin_inset Quotes erd
12261 I can then send either file to a printer, loading transparencies or plain
12262 paper as appropriate.
12265 \begin_layout Standard
12266 You can also provide other arguments to the
12267 \begin_inset Quotes eld
12277 \begin_inset Quotes erd
12281 \begin_inset Quotes eld
12291 \begin_inset Quotes erd
12295 See a good \SpecialChar LaTeX
12299 \begin_layout Subsubsection
12304 Class Template File
12307 \begin_layout Standard
12308 I have also provided a template file
12309 \change_deleted 564990737 1671617750
12311 \begin_inset Quotes eld
12319 \begin_inset Quotes erd
12329 To use it, begin your new presentation with
12331 File\SpecialChar menuseparator
12333 \begin_inset space ~
12337 \begin_inset space ~
12341 \change_inserted 564990737 1671616988
12342 \SpecialChar menuseparator
12343 Presentations\SpecialChar menuseparator
12349 Your new \SpecialChar LyX
12350 presentation file will contain an example
12371 additionally contain an example of the use of
12380 Lastly, the preamble will contain:
12383 \begin_layout LyX-Code
12384 % Uncomment to print out only slides and overlays
12387 \begin_layout LyX-Code
12391 \begin_layout LyX-Code
12397 \begin_inset Newline newline
12403 \begin_layout LyX-Code
12404 % Uncomment to print out only notes
12407 \begin_layout LyX-Code
12411 \begin_layout LyX-Code
12419 \begin_layout Standard
12420 One final thing: I created this class to support the \SpecialChar LaTeX2e
12422 \begin_inset Quotes eld
12427 Sli\SpecialChar TeX
12431 \begin_inset Quotes erd
12434 class, one of the built-in \SpecialChar LaTeX2e
12436 Neither I nor the rest of the \SpecialChar LyX
12437 Team endorse or oppose the use of this built-in
12439 It's here if you want it or need it.
12440 There exist other \SpecialChar LaTeX2e
12441 classes for creating presentations, such as the
12446 \begin_inset space ~
12450 \begin_inset CommandInset ref
12452 reference "sec:foiltex"
12457 \begin_inset Quotes eld
12465 \begin_inset Quotes erd
12468 package [present on some \SpecialChar TeX
12470 The latter is not yet supported under \SpecialChar LyX
12475 \begin_layout Plain Layout
12476 Perhaps you can take on the task\SpecialChar ldots
12482 I know nothing about these other classes.
12483 Try them out to see what sort of alternative they provide.
12486 \begin_layout Section
12488 \change_inserted 564990737 1670439661
12492 \begin_layout Subsection
12494 \change_inserted 564990737 1670439661
12498 \begin_layout Standard
12500 \change_inserted 564990737 1670439661
12509 document class for preparing reports.
12514 document class, this provides parts, chapters and sections but does not
12515 provide the paragraph styles needed for a book; like the
12519 document class, it provides the abstract paragraph style.
12520 In two-sided mode, it does not start a new chapter on the right hand page.
12523 \begin_layout Standard
12525 \change_inserted 564990737 1670439674
12530 document classes are described in the Collections (section
12531 \begin_inset space ~
12535 \begin_inset CommandInset ref
12537 reference "sec:Collections"
12544 \begin_layout Section
12546 \change_inserted 564990737 1670439674
12550 \begin_layout Subsection
12554 \begin_layout Standard
12560 \begin_layout Subsubsection
12564 \begin_layout Standard
12565 Broadway is for writing plays.
12566 The format is more decorative than Hollywood, and much less standardized.
12567 This format should be suitable for workshops.
12570 \begin_layout Subsubsection
12574 \begin_layout Standard
12575 The same as in Hollywood.
12578 \begin_layout Subsubsection
12582 \begin_layout Standard
12587 names as labels then cross-reference the label to insert the name.
12588 The cross-reference dialog will show the current cast of characters.
12591 \begin_layout Subsubsection
12592 Paper size and Margins
12595 \begin_layout Standard
12596 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12599 \begin_layout Subsubsection
12603 \begin_layout Standard
12604 The following environments are available.
12605 You can use broadway.bind to get the bind keys shown at the right.
12608 \begin_layout Itemize
12612 \begin_inset Newline newline
12617 You should not have to use this, but it is here for anything that does not
12621 \begin_layout Itemize
12625 \begin_inset space \hfill{}
12629 \begin_inset Newline newline
12634 Used to describe stage setting and the action.
12635 First use of speaker names in all CAPs.
12638 \begin_layout Itemize
12642 \begin_inset space \hfill{}
12646 \begin_inset Newline newline
12651 Automatically numbered.
12652 On screen it will be arabic, but will print as Roman.
12655 \begin_layout Itemize
12659 \begin_inset space \hfill{}
12663 \begin_inset Newline newline
12673 It is just centered text.
12676 \begin_layout Itemize
12680 \begin_inset space \hfill{}
12684 \begin_inset Newline newline
12689 Not automatically numbered.
12690 You supply the number.
12691 This is because I couldn't figure out how.
12694 \begin_layout Itemize
12698 \begin_inset space \hfill{}
12702 \begin_inset Newline newline
12707 A special case of Narrative to describe the setting and action as the curtain
12711 \begin_layout Itemize
12715 \begin_inset space \hfill{}
12719 \begin_inset Newline newline
12724 The speaker's (actor's) title, centered in all CAPS.
12727 \begin_layout Itemize
12731 \begin_inset space \hfill{}
12735 \begin_inset Newline newline
12740 Instructions to the speaker.
12741 The parentheses are automatically inserted.
12742 The ( will appear on screen, but both will be in the printed play.
12743 This environment is only used within
12750 \begin_layout Itemize
12754 \begin_inset space \hfill{}
12758 \begin_inset Newline newline
12763 What the Speaker says.
12766 \begin_layout Itemize
12770 \begin_inset space \hfill{}
12774 \begin_inset Newline newline
12779 The curtain comes down.
12782 \begin_layout Itemize
12786 \begin_inset space \hfill{}
12792 \begin_layout Itemize
12796 \begin_inset space \hfill{}
12802 \begin_layout Itemize
12806 \begin_inset space \hfill{}
12812 \begin_layout Standard
12816 \begin_layout Subsection
12817 Hollywood (Hollywood spec scripts)
12820 \begin_layout Standard
12826 \begin_layout Subsubsection
12830 \begin_layout Standard
12831 Getting the format of a Hollywood script right is a
12832 \begin_inset Quotes eld
12836 \begin_inset Quotes erd
12839 It is designed to make the readers focus on content and to be easy and
12840 familiar for the actors to read.
12841 Each page of a script should be one minute of film.
12842 Nothing goes in a script that you cannot see or hear on screen.
12843 The courier 12 pt font should be used throughout.
12847 \begin_layout Subsubsection
12851 \begin_layout Standard
12852 Speakers' lines should NEVER break in mid-sentence.
12853 If a speaker's lines continue over a page break, repeat the
12857 title followed by (Cont'd).
12860 \begin_layout Subsubsection
12864 \begin_layout Standard
12869 names as labels then cross-reference the label to insert the name.
12870 The cross-reference dialog will show the current cast of characters.
12871 You can use this to insert the speaker name in narratives also.
12874 \begin_layout Subsubsection
12875 Paper size and Margins
12878 \begin_layout Standard
12879 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12882 \begin_layout Subsubsection
12886 \begin_layout Standard
12887 The following environments are available.
12888 You can use hollywood.bind to get the bind keys shown at the right.
12891 \begin_layout Itemize
12895 \begin_inset Newline newline
12900 Used where nothing else works.
12904 \begin_layout Itemize
12910 \begin_inset space \hfill{}
12918 \begin_inset Newline newline
12921 Usually followed by something like
12922 \begin_inset Quotes eld
12925 on Sally waking up.
12926 \begin_inset Quotes erd
12932 \begin_layout Itemize
12936 \begin_inset space \hfill{}
12940 \begin_inset Newline newline
12945 Introduces a new INTERIOR camera set-up.
12946 Always followed by DAY or NIGHT, or something similar to define the lighting
12948 Everthing on this line in CAPS.
12951 \begin_layout Itemize
12955 \begin_inset space \hfill{}
12959 \begin_inset Newline newline
12964 Introduces a new EXTERIOR camera set-up.
12965 Everthing on this line in CAPS.
12968 \begin_layout Itemize
12972 \begin_inset space \hfill{}
12976 \begin_inset Newline newline
12981 The character speaking.
12984 \begin_layout Itemize
12988 \begin_inset space \hfill{}
12992 \begin_inset Newline newline
12997 Instructions to the speaker.
12998 The () are automatically inserted.
13001 \begin_layout Itemize
13005 \begin_inset space \hfill{}
13009 \begin_inset Newline newline
13021 \begin_layout Itemize
13025 \begin_inset space \hfill{}
13029 \begin_inset Newline newline
13034 Camera movement instruction.
13036 \begin_inset space \thinspace{}
13040 \begin_inset space \space{}
13046 \begin_layout Itemize
13050 \begin_inset space \hfill{}
13056 \begin_layout Itemize
13060 \begin_inset space \hfill{}
13066 \begin_layout Itemize
13070 \begin_inset space \hfill{}
13076 \begin_layout Itemize
13080 \begin_inset space \hfill{}
13086 \begin_layout Subsubsection
13090 \begin_layout Itemize
13094 \begin_layout Itemize
13098 \begin_layout Itemize
13100 \begin_inset space \thinspace{}
13107 \begin_layout Itemize
13112 \begin_layout Itemize
13113 PAN — camera movement
13116 \begin_layout Itemize
13117 INSERT — cut to close-up of
13120 \begin_layout Chapter
13122 \change_inserted 564990737 1671185876
13126 \begin_layout Section
13128 \change_inserted 564990737 1671716212
13131 Academic Field Specifics
13134 \begin_layout Subsection
13136 \change_inserted 564990737 1671716212
13139 Chemistry: Hazard and Precautionary Statements
13142 \begin_layout Standard
13144 \change_inserted 564990737 1671716212
13147 This module provides two insets to typeset numbers and phrases of chemical
13148 hazard and precautionary statements.
13149 For a description see
13152 File\SpecialChar menuseparator
13153 Open Example\SpecialChar menuseparator
13154 Modules\SpecialChar menuseparator
13155 Hazard and Precautionary Statements
13159 Help\SpecialChar menuseparator
13160 Specific Manuals\SpecialChar menuseparator
13161 Hazard and Precautionary Statements
13167 \begin_layout Subsection
13169 \change_inserted 564990737 1671716212
13173 Chemistry: Risk and Safety Statements
13176 \begin_layout Standard
13178 \change_inserted 564990737 1671716212
13181 This module provides two insets,
13189 , accessible via the menu
13194 nsert\SpecialChar menuseparator
13196 \begin_inset space ~
13201 and an environment to typeset numbers and phrases of chemical risk and
13205 \begin_layout Subsection
13207 \change_inserted 564990737 1671716212
13213 \begin_layout Standard
13215 \change_inserted 564990737 1671716212
13218 This module uses the
13222 package to add environments useful for linguistics (numbered examples,
13223 glosses, semantic markup, tableau floats).
13224 You can obtain information about this module in
13229 elp\SpecialChar menuseparator
13235 \begin_inset space ~
13238 Manuals\SpecialChar menuseparator
13248 File\SpecialChar menuseparator
13249 Open Example\SpecialChar menuseparator
13252 Modules\SpecialChar menuseparator
13258 \begin_layout Section
13260 \change_inserted 564990737 1671788778
13266 \begin_layout Subsection
13268 \change_inserted 564990737 1671788778
13274 \begin_layout Standard
13276 \change_inserted 564990737 1671788778
13279 This module supports the Braille writing system.
13280 It requires the \SpecialChar LaTeX
13286 This and its documentation can be obtained from
13287 \begin_inset CommandInset href
13290 target "https://www.ctan.org/pkg/braille"
13296 You do not have to reconfigure your system after installing it.
13302 elp\SpecialChar menuseparator
13308 \begin_inset space ~
13311 Manuals\SpecialChar menuseparator
13320 File\SpecialChar menuseparator
13321 Open Example\SpecialChar menuseparator
13322 Modules\SpecialChar menuseparator
13328 \begin_layout Section
13330 \change_inserted 564990737 1671788778
13333 Annotation & Revision
13336 \begin_layout Subsection
13338 \change_inserted 564990737 1671788778
13344 \begin_layout Standard
13346 \change_inserted 564990737 1671788778
13349 This module provides “FiXme” (marginal) annotations for document revision
13351 A list of annotations can be produced by using the “List of FIXMEs” paragraph
13353 The annotations are customizable via the LaTeX preamble.
13354 See the FiXme documentation which can be obtained from
13355 \begin_inset CommandInset href
13358 target "http://mirrors.ctan.org/macros/latex/contrib/fixme/fixme.pdf"
13367 \begin_layout Paragraph
13369 \change_inserted 564990737 1671788778
13375 \begin_layout Standard
13377 \change_inserted 564990737 1671788778
13380 by default, the notes are only displayed in “draft” mode (if the option
13381 “draft” has been inserted in
13383 Document\SpecialChar menuseparator
13384 Settings\SpecialChar menuseparator
13385 Document Class\SpecialChar menuseparator
13386 Class Options\SpecialChar menuseparator
13390 To display them always, insert
13398 Document\SpecialChar menuseparator
13399 Settings\SpecialChar menuseparator
13407 \begin_layout Subsection
13409 \change_inserted 564990737 1671788778
13415 \begin_layout Standard
13417 \change_inserted 564990737 1671788778
13420 This module provides various kinds of annotations for PDF output.
13423 Help\SpecialChar menuseparator
13424 Specific Manuals\SpecialChar menuseparator
13425 PDF comments and File\SpecialChar menuseparator
13426 Open Example\SpecialChar menuseparator
13427 Modules\SpecialChar menuseparator
13433 \begin_layout Subsection
13435 \change_inserted 564990737 1671788778
13442 \begin_layout Standard
13444 \change_inserted 564990737 1671788778
13447 This module provides fields and buttons for PDF forms.
13449 \begin_inset CommandInset href
13451 name "hyperref documentation"
13452 target "http://mirrors.ctan.org/macros/latex/contrib/hyperref/doc/hyperref-doc.pdf"
13459 Help\SpecialChar menuseparator
13460 Specific Manuals\SpecialChar menuseparator
13461 PDF forms and File\SpecialChar menuseparator
13462 Open Example\SpecialChar menuseparator
13463 Modules\SpecialChar menuseparator
13469 \begin_layout Subsection
13471 \change_inserted 564990737 1671788778
13478 \begin_layout Standard
13480 \change_inserted 564990737 1671788778
13483 This module defines an inset to typeset reading aids (ruby, furigana) to
13484 Chinese characters.
13485 It uses the “okumakro,” “luatexja-ruby” or “ruby” package (depending on
13486 the TeX engine) or a fallback definition.
13490 \begin_layout Subsection
13492 \change_inserted 564990737 1671788778
13499 \begin_layout Standard
13501 \change_inserted 564990737 1671788778
13504 This module provides custom insets to insert TODO items in your document.
13505 In order to generate a “List of TODOs,” the module provides a paragraph
13507 Inserting “final” in
13509 Document\SpecialChar menuseparator
13510 Settings\SpecialChar menuseparator
13511 Document Class\SpecialChar menuseparator
13512 Class Options\SpecialChar menuseparator
13515 ) suppresses the output of TODO notes.
13517 \begin_inset CommandInset href
13519 name "todonotes documentation"
13520 target "http://mirrors.ctan.org/macros/latex/contrib/todonotes/todonotes.pdf"
13528 \begin_layout Section
13530 \change_inserted 564990737 1671829045
13536 \begin_layout Subsection
13538 \change_inserted 564990737 1671829045
13541 APA Style with NatBib
13544 \begin_layout Standard
13546 \change_inserted 564990737 1671829045
13549 This module adds support for using natbib together with apacite (the bibliograph
13550 y style need not be apacite — it could be apacite, apacitex, or any bibliography
13551 that works with both the natbib and apacite packages.)
13554 \begin_layout Section
13556 \change_inserted 564990737 1671829045
13562 \begin_layout Subsection
13564 \change_inserted 564990737 1671829045
13567 Fancy Colored Boxes
13570 \begin_layout Standard
13572 \change_inserted 564990737 1671829045
13575 This module adds ten custom insets that support colored boxes via the tcolorbox
13579 Help\SpecialChar menuseparator
13580 Specific Manuals\SpecialChar menuseparator
13585 File\SpecialChar menuseparator
13586 Open Example\SpecialChar menuseparator
13587 Modules\SpecialChar menuseparator
13591 \begin_inset CommandInset href
13593 name "tcolorbox documentation"
13594 target "http://mirrors.ctan.org/macros/latex/contrib/tcolorbox/tcolorbox.pdf"
13603 \begin_layout Subsection
13605 \change_inserted 564990737 1671829045
13611 \begin_layout Standard
13613 \change_inserted 564990737 1671829045
13616 This provides the custom insets
13632 to scale and rotate its content.
13635 \begin_layout Standard
13637 \change_inserted 564990737 1671829045
13643 is a simple way of reversing text without any other enhancement:
13646 \begin_layout Standard
13648 \change_inserted 564990737 1671829045
13651 \begin_inset Flex Reflectbox
13654 \begin_layout Plain Layout
13656 \change_inserted 564990737 1671829045
13659 Great Western Railway
13669 \begin_layout Standard
13671 \change_inserted 564990737 1671829045
13674 (You will need to use Ctrl-R to see any of these examples.)
13677 \begin_layout Standard
13679 \change_inserted 564990737 1671829045
13685 allows you to specify the dimensions of the text or image; permissible
13686 units are em, ex, in, pt, pc, cm, mm, dd, cc, nd, nc, bp, or sp; if you
13695 it scales by the width factor:
13698 \begin_layout Standard
13700 \change_inserted 564990737 1671829045
13703 \begin_inset Flex Resizebox
13706 \begin_layout Plain Layout
13708 \change_inserted 564990737 1671829045
13711 \begin_inset Argument 1
13714 \begin_layout Plain Layout
13716 \change_inserted 564990737 1671829045
13727 \begin_inset Argument 2
13730 \begin_layout Plain Layout
13732 \change_inserted 564990737 1671829045
13742 Great Western Railway
13752 \begin_layout Standard
13754 \change_inserted 564990737 1671829045
13760 allows you to rotate text around the reference point of the box.
13761 If you wish to rotate the box around a different origin, place the cursor
13762 inside the box and select Insert\SpecialChar menuseparator
13787 or meaningful combinations of these and the counterclockwise rotation angle
13788 is expressed in degrees.
13792 \begin_layout Standard
13794 \change_inserted 564990737 1671829045
13797 \begin_inset Flex Rotatebox
13800 \begin_layout Plain Layout
13802 \change_inserted 564990737 1671829045
13805 \begin_inset Argument 1
13808 \begin_layout Plain Layout
13810 \change_inserted 564990737 1671829045
13821 \begin_inset Argument 2
13824 \begin_layout Plain Layout
13826 \change_inserted 564990737 1671829045
13836 Great Western Railway
13846 \begin_layout Standard
13848 \change_inserted 564990737 1671829045
13851 You can combine boxes as in:
13854 \begin_layout Standard
13856 \change_inserted 564990737 1671829045
13859 \begin_inset Flex Rotatebox
13862 \begin_layout Plain Layout
13864 \change_inserted 564990737 1671829045
13867 \begin_inset Argument 1
13870 \begin_layout Plain Layout
13872 \change_inserted 564990737 1671829045
13883 \begin_inset Argument 2
13886 \begin_layout Plain Layout
13888 \change_inserted 564990737 1671829045
13899 \begin_inset Flex Resizebox
13902 \begin_layout Plain Layout
13904 \change_inserted 564990737 1671829045
13907 \begin_inset Argument 1
13910 \begin_layout Plain Layout
13912 \change_inserted 564990737 1671829045
13923 \begin_inset Argument 2
13926 \begin_layout Plain Layout
13928 \change_inserted 564990737 1671829045
13939 \begin_inset Flex Reflectbox
13942 \begin_layout Plain Layout
13944 \change_inserted 564990737 1671829045
13947 Great Western Railway
13971 \begin_layout Standard
13973 \change_inserted 564990737 1671829045
13979 scales text; select Insert\SpecialChar menuseparator
13980 V-Factor to add a vertical factor.
13981 If the vertical factor is omitted, the horizontal is used.
13982 Adding different horizontal and vertical values creates distortion as in
13986 \begin_layout Standard
13988 \change_inserted 564990737 1671829045
13992 \begin_inset Flex Scalebox
13995 \begin_layout Plain Layout
13997 \change_inserted 564990737 1671829045
14000 \begin_inset Argument 1
14003 \begin_layout Plain Layout
14005 \change_inserted 564990737 1671829045
14016 \begin_inset Argument 2
14019 \begin_layout Plain Layout
14021 \change_inserted 564990737 1671829045
14033 Great Western Railway
14043 \begin_layout Standard
14045 \change_inserted 564990737 1671829045
14048 A negative horizontal value reverses the text and a negative vertical value
14049 inverts it so that you get
14052 \begin_layout Standard
14054 \change_inserted 564990737 1671829045
14057 \begin_inset Flex Scalebox
14060 \begin_layout Plain Layout
14062 \change_inserted 564990737 1671829045
14065 \begin_inset Argument 1
14068 \begin_layout Plain Layout
14070 \change_inserted 564990737 1671829045
14081 \begin_inset Argument 2
14084 \begin_layout Plain Layout
14086 \change_inserted 564990737 1671829045
14096 Great Western Railway
14104 \begin_inset Flex Scalebox
14107 \begin_layout Plain Layout
14109 \change_inserted 564990737 1671829045
14112 \begin_inset Argument 1
14115 \begin_layout Plain Layout
14117 \change_inserted 564990737 1671829045
14128 \begin_inset Argument 2
14131 \begin_layout Plain Layout
14133 \change_inserted 564990737 1671829045
14143 Great Western Railway
14153 \begin_layout Subsection
14155 \change_inserted 564990737 1671884699
14161 \begin_layout Standard
14163 \change_inserted 564990737 1671884699
14166 This module defines Boxes with section header.
14167 It is mainly intended for the SciPoster Document class.
14171 \begin_layout Subsection
14173 \change_inserted 564990737 1671884699
14176 Variable-width Minipages
14179 \begin_layout Standard
14181 \change_inserted 564990737 1671884699
14187 \begin_inset space \thinspace{}
14194 Insert\SpecialChar menuseparator
14206 package provides a variable-width minipage, whose resulting width is the
14207 width of its contents (if this does not exceed the specified maximum width).
14208 The inset has two optional arguments which can be added by placing the
14209 cursor inside the minipage and entering
14211 Insert\SpecialChar menuseparator
14213 \begin_inset space \thinspace{}
14224 Insert\SpecialChar menuseparator
14226 \begin_inset space \thinspace{}
14240 File\SpecialChar menuseparator
14241 Open Example\SpecialChar menuseparator
14242 Variable-width Minipages
14248 \begin_layout Section
14250 \change_inserted 564990737 1671884699
14256 \begin_layout Subsection
14258 \change_inserted 564990737 1671884699
14261 Fix Computer Modern Fonts
14264 \begin_layout Standard
14266 \change_inserted 564990737 1671884699
14269 This module uses the
14273 package to improve the appearance of Computer Modern fonts and make them
14274 available with arbitrary sizes.
14276 \begin_inset CommandInset href
14278 name "fix-cm documentation"
14279 target "http://mirrors.ctan.org/macros/latex/base/fix-cm.pdf"
14288 \begin_layout Subsection
14290 \change_inserted 564990737 1671884699
14294 Kernel Fixes (Obsolete)
14297 \begin_layout Standard
14299 \change_inserted 564990737 1671884699
14302 This module loads the \SpecialChar LaTeX
14307 which contains some bug fixes for \SpecialChar LaTeX
14309 If you use this module your typeset document may look different when you
14310 process it, depending on the respective version of
14318 \begin_layout Paragraph
14320 \change_inserted 564990737 1671884699
14326 \begin_layout Standard
14328 \change_inserted 564990737 1671884699
14331 recent \SpecialChar LaTeX
14332 kernels (as of 2015/01/01) include the functionality of
14340 module is obsolete with newer \SpecialChar LaTeX
14345 \begin_layout Subsection
14347 \change_inserted 564990737 1671884699
14350 Minimalistic Insets
14353 \begin_layout Standard
14355 \change_inserted 564990737 1671884699
14358 This module redefines several insets (Index, Branch, URL) as being Minimalistic.
14361 \begin_layout Subsection
14363 \change_inserted 564990737 1671884699
14366 Title and Preamble Hacks
14369 \begin_layout Standard
14371 \change_inserted 564990737 1671884699
14374 This module provides two new paragraph styles:
14377 \begin_layout Enumerate
14379 \change_inserted 564990737 1671884699
14385 which puts whatever is entered into it into the preamble.
14386 This can be used, if one wishes, to include preamble code in the body of
14391 \begin_layout Enumerate
14393 \change_inserted 564990737 1671884699
14399 which that will put its contents into the body of the LaTeX document, but
14407 This is useful for making branches and notes in title-related material.
14408 (However, if you put these in a Standard layout, this signals to LyX to
14415 , which may then come too early.)
14418 \begin_layout Section
14420 \change_inserted 564990737 1672081439
14426 \begin_layout Subsection
14428 \change_inserted 564990737 1672081439
14434 \begin_layout Standard
14436 \change_inserted 564990737 1672081439
14439 This module uses the
14443 package for algorithm floats rather than LyX’s home-brewed algorithm floats.
14444 Use the Algorithm paragraph style to enter and indent the algorithm.
14446 \begin_inset CommandInset href
14448 name "algorithm2e documentation"
14449 target "http://mirrors.ctan.org/macros/latex/contrib/algorithm2e/doc/algorithm2e.pdf"
14457 \begin_layout Subsection
14459 \change_inserted 564990737 1672081439
14462 Bilingual Captions AKA Multilingual Captions
14465 \begin_layout Standard
14467 \change_inserted 564990737 1672081439
14470 This module provides the paragraph style
14473 \begin_inset space ~
14478 with which to typeset multilingual captions.
14479 Within this paragraph style
14481 Insert\SpecialChar menuseparator
14484 allows you to enter the desired language using one of the babel names.
14487 File\SpecialChar menuseparator
14488 Open Example\SpecialChar menuseparator
14489 Multilingual Captions
14493 Help\SpecialChar menuseparator
14494 Specific Manuals\SpecialChar menuseparator
14495 Multilingual Captions
14497 further information on its use.
14500 \begin_layout Subsection
14502 \change_inserted 564990737 1672081439
14505 Number Figures by Section
14508 \begin_layout Standard
14510 \change_inserted 564990737 1672081439
14513 This module resets the figure number at section start and prepends the section
14514 number to the figure number, as in “Figure 2.1.” (By default book and report
14515 document classes number by Chapter and article document classes have a
14519 \begin_layout Subsection
14521 \change_inserted 564990737 1672081439
14524 Number Tables by Section
14527 \begin_layout Standard
14529 \change_inserted 564990737 1672081439
14532 This module resets the table number at section start and prepends the section
14533 number to the table number, as in “Table 2.1.” (By default book and report
14534 document classes number by Chapter and article document classes have a
14538 \begin_layout Section
14540 \change_inserted 564990737 1672081439
14546 \begin_layout Subsection
14548 \change_inserted 564990737 1672081439
14554 \begin_layout Standard
14556 \change_inserted 564990737 1672081439
14559 This module adds an endnote inset, in addition to footnotes.
14564 package, which has some limitations but works with older LaTeX distributions
14568 Insert\SpecialChar menuseparator
14569 Custom Inset\SpecialChar menuseparator
14572 to insert an endnote and
14574 Insert\SpecialChar menuseparator
14575 List/Contents/References\SpecialChar menuseparator
14578 to insert the endnotes list where you want the endnotes to appear.
14581 Help\SpecialChar menuseparator
14582 Embedded\SpecialChar menuseparator
14583 Objects\SpecialChar menuseparator
14584 Notes\SpecialChar menuseparator
14590 \begin_layout Subsection
14592 \change_inserted 564990737 1672081439
14595 Endnotes (Extended)
14598 \begin_layout Standard
14600 \change_inserted 564990737 1672081439
14603 This module adds an endnote inset, in addition to footnotes.
14608 package which is more powerful and customizable than the
14612 package, but requires a fairly modern LaTeX distribution (with LaTeX3).
14615 Insert\SpecialChar menuseparator
14616 Custom Inset\SpecialChar menuseparator
14619 to insert an endnote and
14621 Insert\SpecialChar menuseparator
14622 List/Contents/References\SpecialChar menuseparator
14625 to insert the endnotes list where you want the endnotes to appear.
14628 Help\SpecialChar menuseparator
14629 Embedded\SpecialChar menuseparator
14630 Objects\SpecialChar menuseparator
14631 Notes\SpecialChar menuseparator
14637 \begin_layout Subsection
14639 \change_inserted 564990737 1672081439
14642 Footnotes as Endnotes (Basic)
14645 \begin_layout Standard
14647 \change_inserted 564990737 1672081439
14650 This module sets all footnotes as endnotes.
14655 package, which has some limitations but works with older LaTeX distributions
14659 Insert\SpecialChar menuseparator
14660 List/Contents/References\SpecialChar menuseparator
14663 to insert the endnotes list where you want the endnotes to appear.
14666 Help\SpecialChar menuseparator
14667 Embedded\SpecialChar menuseparator
14668 Objects\SpecialChar menuseparator
14669 Notes\SpecialChar menuseparator
14675 \begin_layout Subsection
14677 \change_inserted 564990737 1672081439
14680 Footnotes as Endnotes (Extended)
14683 \begin_layout Standard
14685 \change_inserted 564990737 1672081439
14688 This module sets all footnotes as endnotes.
14693 package which is more powerful and customizable than then
14697 package, but requires a fairly modern LaTeX distribution (with LaTeX3).
14700 Insert\SpecialChar menuseparator
14701 List/Contents/References\SpecialChar menuseparator
14704 to insert the endnotes list where you want the endnotes to appear.
14707 Help\SpecialChar menuseparator
14708 Embedded\SpecialChar menuseparator
14709 Objects\SpecialChar menuseparator
14710 Notes\SpecialChar menuseparator
14716 \begin_layout Section
14718 \change_inserted 564990737 1672081439
14721 Leisure, Sports and Music
14724 \begin_layout Subsection
14726 \change_inserted 564990737 1672081439
14732 \begin_layout Standard
14734 \change_inserted 564990737 1672081439
14737 This module provides support for the
14741 package to print chess games.
14744 File\SpecialChar menuseparator
14745 Open Example\SpecialChar menuseparator
14746 Articles\SpecialChar menuseparator
14749 where you will find
14758 \begin_inset CommandInset href
14760 name "chessboard documentation"
14761 target "http://mirrors.ctan.org/macros/latex/contrib/chessboard/chessboard.pdf"
14769 \begin_layout Subsection
14771 \change_inserted 564990737 1672081439
14774 Lilypond Music Notation
14777 \begin_layout Standard
14779 \change_inserted 564990737 1672081439
14782 This module provides an inset via
14787 nsert\SpecialChar menuseparator
14788 Custom Inset\SpecialChar menuseparator
14791 in which to enter code for the LilyPond music editor.
14792 It will then be processed in the output.
14795 Help\SpecialChar menuseparator
14796 Specific Manuals\SpecialChar menuseparator
14801 File\SpecialChar menuseparator
14802 Open Example\SpecialChar menuseparator
14803 Modules\SpecialChar menuseparator
14807 It cannot be used if the modules
14810 \begin_inset space \thinspace{}
14818 \begin_layout Section
14820 \change_inserted 564990737 1672138150
14826 \begin_layout Subsection
14828 \change_inserted 564990737 1672138150
14832 \begin_inset CommandInset label
14834 name "subsec:Customizable-Lists"
14841 \begin_layout Standard
14843 \change_inserted 564990737 1672138150
14846 This module uses the
14850 package to enable the customization of various list environments.
14853 \begin_layout Subsubsection
14855 \change_inserted 564990737 1672138150
14858 Custom Enumerate Lists
14861 \begin_layout Standard
14864 \change_inserted 564990737 1672138150
14867 The default numbering of numbered lists can be changed by adding an optional
14873 nsert\SpecialChar menuseparator
14880 ) to the first item of each level in the list.
14881 There you add the command
14884 \begin_layout Standard
14886 \change_inserted 564990737 1672138150
14895 \begin_layout Standard
14897 \change_inserted 564990737 1672138150
14900 in \SpecialChar TeX
14910 \begin_layout Standard
14912 \change_inserted 564990737 1672138150
14918 is the first level counter of the enumeration.
14919 To change the numbering for the list sublevels, replace the “
14923 ” in the command by the small Roman numeral of the level (
14942 \begin_layout Standard
14944 \change_inserted 564990737 1672138150
14953 outputs the counter as a small Roman numeral.
14954 For capital Roman numerals replace
14966 in the command above.
14967 For Arabic numerals use
14975 \begin_inset Quotes eld
14979 \begin_inset Quotes erd
14982 items with capital or small Latin letters use
14997 \begin_layout Standard
15000 \change_inserted 564990737 1672138150
15003 \begin_inset Note Greyedout
15006 \begin_layout Plain Layout
15008 \change_inserted 564990737 1672138150
15014 You can only number 26
15015 \begin_inset space ~
15018 items with Latin letters, because this numbering is limited to single letters.
15026 \begin_layout Standard
15028 \change_inserted 564990737 1672138150
15031 Here is a list with custom numbering:
15034 \begin_layout Enumerate
15036 \change_inserted 564990737 1672138150
15039 \begin_inset Argument 1
15042 \begin_layout Plain Layout
15044 \change_inserted 564990737 1672138150
15050 \begin_layout Plain Layout
15052 \change_inserted 564990737 1672138150
15073 \begin_inset Separator latexpar
15080 \begin_layout Enumerate
15082 \change_inserted 564990737 1672138150
15085 \begin_inset Argument 1
15088 \begin_layout Plain Layout
15090 \change_inserted 564990737 1672138150
15096 \begin_layout Plain Layout
15098 \change_inserted 564990737 1672138150
15119 \begin_layout Enumerate
15121 \change_inserted 564990737 1672138150
15125 \begin_inset Separator latexpar
15132 \begin_layout Enumerate
15134 \change_inserted 564990737 1672138150
15137 \begin_inset Argument 1
15140 \begin_layout Plain Layout
15142 \change_inserted 564990737 1672138150
15148 \begin_layout Plain Layout
15150 \change_inserted 564990737 1672138150
15169 \begin_inset Separator latexpar
15176 \begin_layout Enumerate
15178 \change_inserted 564990737 1672138150
15181 \begin_inset Argument 1
15184 \begin_layout Plain Layout
15186 \change_inserted 564990737 1672138150
15192 \begin_layout Plain Layout
15194 \change_inserted 564990737 1672138150
15218 \begin_layout Standard
15220 \change_inserted 564990737 1672138150
15223 For this list these commands were used:
15226 \begin_layout Standard
15229 \change_inserted 564990737 1672138150
15240 \begin_inset Newline newline
15248 \begin_inset Newline newline
15256 \begin_inset Newline newline
15266 \begin_layout Standard
15268 \change_inserted 564990737 1672138150
15277 makes the label emphasized and
15286 \begin_layout Standard
15288 \change_inserted 564990737 1672138150
15291 \begin_inset Note Greyedout
15294 \begin_layout Plain Layout
15296 \change_inserted 564990737 1672138150
15302 When you change the label of a list level, it will be used for all following
15303 lists until you change the definition.
15311 \begin_layout Standard
15313 \change_inserted 564990737 1672138150
15319 \begin_layout Plain Layout
15321 \change_inserted 564990737 1672138150
15339 \begin_layout Subsubsection
15341 \change_inserted 564990737 1672138150
15344 Numbered Paragraphs in Reports
15347 \begin_layout Enumerate
15349 \change_inserted 564990737 1672138213
15352 Official reports often include numbered paragraphs; you can achieve this
15353 with a variation on the approach outlined in the footnote
15354 \begin_inset space ~
15358 \begin_inset CommandInset ref
15360 reference "fn:If-you-really"
15372 in each command with
15379 \begin_layout Enumerate
15381 \change_inserted 564990737 1672138150
15384 These numbered paragraphs were generated by inserting the \SpecialChar TeX
15386 \begin_inset Separator latexpar
15393 \begin_layout Standard
15395 \change_inserted 564990737 1672138150
15410 \begin_layout Standard
15412 \change_inserted 564990737 1672138150
15415 before the start of the section;
15421 uses the \SpecialChar LaTeX
15422 section counter to generate the first part of the number.
15426 \begin_layout Enumerate
15428 \change_inserted 564990737 1672138150
15431 I have ignored the subsection heading in this example because, with paragraphs
15432 numbered in this way, subsections are less likely to be used.
15435 \begin_layout Subsubsection
15437 \change_inserted 564990737 1672138150
15440 Resumed Enumeration
15443 \begin_layout Standard
15445 \change_inserted 564990737 1672138150
15451 \begin_layout Plain Layout
15453 \change_inserted 564990737 1672138150
15469 \begin_layout Standard
15471 \change_inserted 564990737 1672138150
15474 Enumerations can be resumed after intermediate paragraphs:
15477 \begin_layout Enumerate
15479 \change_inserted 564990737 1672138150
15482 \begin_inset Argument 1
15485 \begin_layout Plain Layout
15487 \change_inserted 564990737 1672138150
15493 \begin_layout Plain Layout
15495 \change_inserted 564990737 1672138150
15512 \begin_inset Note Note
15515 \begin_layout Plain Layout
15517 \change_inserted 564990737 1672138150
15520 goes back to default numbering
15528 \begin_layout Enumerate
15530 \change_inserted 564990737 1672138150
15536 \begin_layout Standard
15538 \change_inserted 564990737 1672138150
15544 \begin_layout Enumerate-Resume
15546 \change_inserted 564990737 1672138150
15552 \begin_layout Standard
15554 \change_inserted 564990737 1672138150
15557 To resume an enumeration, use the style
15562 Its numbering appears in blue within \SpecialChar LyX
15563 to indicate that it is a resumed
15564 list and that the numbering will not be correct in \SpecialChar LyX
15565 , but in the output.
15568 \begin_layout Standard
15570 \change_inserted 564990737 1672138150
15573 \begin_inset Note Greyedout
15576 \begin_layout Plain Layout
15578 \change_inserted 564990737 1672138150
15584 If there is no previous enumeration to resume, you will get a \SpecialChar LaTeX
15593 \begin_layout Standard
15595 \change_inserted 564990737 1672138150
15598 Perhaps you might want to resume the list with a different number from the
15600 Or you want to start a new enumeration with a defined number.
15601 This is possible by adding an optional argument to the first list item
15602 of a normal enumeration.
15603 There, insert the command
15606 \begin_layout Standard
15608 \change_inserted 564990737 1672138150
15615 \begin_layout Standard
15617 \change_inserted 564990737 1672138150
15624 is the number with which you want to resume the list.
15628 \begin_layout Enumerate
15630 \change_inserted 564990737 1672138150
15636 \begin_layout Enumerate
15638 \change_inserted 564990737 1672138150
15644 \begin_layout Standard
15646 \change_inserted 564990737 1672138150
15649 Enumeration starting at a given value:
15652 \begin_layout Enumerate
15654 \change_inserted 564990737 1672138150
15657 \begin_inset Argument 1
15660 \begin_layout Plain Layout
15662 \change_inserted 564990737 1672138150
15668 \begin_layout Plain Layout
15670 \change_inserted 564990737 1672138150
15684 This enumeration starts at 4
15687 \begin_layout Subsubsection
15689 \change_inserted 564990737 1672138150
15693 \begin_inset Index idx
15698 \begin_layout Plain Layout
15700 \change_inserted 564990737 1672138150
15713 \begin_layout Standard
15715 \change_inserted 564990737 1672138150
15718 In some cases you might want less or more vertical space between the items
15720 For example if the default space is too much in your opinion in this case:
15723 \begin_layout Itemize
15725 \change_inserted 564990737 1672138150
15731 \begin_layout Itemize
15733 \change_inserted 564990737 1672138150
15736 with standard spacing
15739 \begin_layout Standard
15741 \change_inserted 564990737 1672138150
15744 You can decrease the space by adding an optional argument to the first item
15746 Add there the command
15750 to get no additional list space like in this example:
15753 \begin_layout Itemize
15755 \change_inserted 564990737 1672138150
15758 \begin_inset Argument 1
15761 \begin_layout Plain Layout
15763 \change_inserted 564990737 1672138150
15769 \begin_layout Plain Layout
15771 \change_inserted 564990737 1672138150
15788 \begin_layout Itemize
15790 \change_inserted 564990737 1672138150
15796 \begin_layout Itemize
15798 \change_inserted 564990737 1672138150
15804 \begin_layout Standard
15806 \change_inserted 564990737 1672138150
15809 To add space you can use several other commands provided by the
15814 \begin_inset Index idx
15819 \begin_layout Plain Layout
15821 \change_inserted 564990737 1672138150
15825 -packages ! enumitem
15833 For more information see the
15834 \begin_inset CommandInset href
15836 name "enumitem documentation"
15837 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
15845 \begin_layout Standard
15847 \change_inserted 564990737 1672138150
15850 There are also many commands available to change the horizontal spacing
15852 Here is an example where the indentation was changed to that of the paragraphs
15853 in the document and the label separation was set to 2
15854 \begin_inset space \thinspace{}
15857 cm so that the number is in the page margin:
15860 \begin_layout Enumerate
15862 \change_inserted 564990737 1672138150
15865 \begin_inset Argument 1
15868 \begin_layout Plain Layout
15870 \change_inserted 564990737 1672138150
15876 \begin_layout Plain Layout
15878 \change_inserted 564990737 1672138150
15882 parindent, labelsep=2cm
15897 \begin_layout Enumerate
15899 \change_inserted 564990737 1672138150
15902 with negative indentation
15905 \begin_layout Subsubsection
15907 \change_inserted 564990737 1672138150
15910 Further Customization
15911 \begin_inset Index idx
15916 \begin_layout Plain Layout
15918 \change_inserted 564990737 1672138150
15921 Lists ! Customization
15931 \begin_layout Standard
15933 \change_inserted 564990737 1672138150
15936 You can also change the style of description lists.
15940 \begin_layout Standard
15942 \change_inserted 564990737 1672138150
15949 \begin_layout Standard
15951 \change_inserted 564990737 1672138150
15954 changes the description label font, the command
15957 \begin_layout Standard
15959 \change_inserted 564990737 1672138150
15969 \begin_layout Standard
15971 \change_inserted 564990737 1672138150
15974 sets the list style.
15977 \begin_layout Standard
15979 \change_inserted 564990737 1672138150
15982 An example where the command
15985 \begin_layout Standard
15987 \change_inserted 564990737 1672138150
15993 itshape, style=nextline
15996 \begin_layout Standard
15998 \change_inserted 564990737 1672138150
16004 \begin_layout Description
16006 \change_inserted 564990737 1672138150
16010 \begin_inset space ~
16014 \begin_inset Argument 1
16017 \begin_layout Plain Layout
16019 \change_inserted 564990737 1672138150
16025 \begin_layout Plain Layout
16027 \change_inserted 564990737 1672138150
16029 labelindent=0pt, labelsep=1cm, font=
16031 itshape, style=nextline
16043 Ionizing radiation consists of particles or electromagnetic waves that are
16044 energetic enough to detach electrons from atoms or molecules, therefore
16048 \begin_layout Description
16050 \change_inserted 564990737 1672138150
16054 \begin_inset space ~
16057 counting: In computer science, reference counting is a technique of storing
16058 the number of references, pointers, or handles to a resource such as an
16059 object, block of memory, disk space or other resource.
16062 \begin_layout Standard
16064 \change_inserted 564990737 1672138150
16067 There are many more commands and features provided by the
16072 \begin_inset Index idx
16077 \begin_layout Plain Layout
16079 \change_inserted 564990737 1672138150
16083 -packages ! enumitem
16091 For more information see the
16092 \begin_inset CommandInset href
16094 name "enumitem documentation"
16095 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
16103 \begin_layout Subsection
16105 \change_inserted 564990737 1672138150
16112 \begin_layout Standard
16114 \change_inserted 564990737 1672138150
16117 This module uses the package
16121 to provide nine new list environments.
16122 Itemized and enumerated lists can be typeset within paragraphs, as paragraphs
16123 and in a compact version.
16124 Most environments have optional arguments to format the labels.
16125 Additionally, the \SpecialChar LaTeX
16126 list environments itemize and enumerate are extended
16127 to use a similar optional argument.
16128 For further details see
16130 File\SpecialChar menuseparator
16131 Open Example\SpecialChar menuseparator
16132 Modules\SpecialChar menuseparator
16133 Paragraph Lists (paralist)
16137 Help\SpecialChar menuseparator
16138 Specific Manuals\SpecialChar menuseparator
16142 \begin_inset CommandInset href
16144 name "paralist documentation"
16145 target "http://mirrors.ctan.org/macros/latex/contrib/paralist/paralist.pdf"
16153 \begin_layout Section
16155 \change_inserted 564990737 1672161542
16158 Literate Programming
16161 \begin_layout Subsection
16163 \change_inserted 564990737 1672161542
16169 \begin_layout Standard
16171 \change_inserted 564990737 1672161542
16174 This module allows the use of Noweb as a literate programming tool.
16175 The files and the documentation for Noweb can be obtained from
16176 \begin_inset CommandInset href
16179 target "https://www.ctan.org/pkg/noweb"
16185 Literate programming is described in section
16186 \begin_inset space ~
16190 \begin_inset CommandInset ref
16192 reference "sec:Literate-Programming"
16196 and there are three example files:
16198 File\SpecialChar menuseparator
16199 Open Example\SpecialChar menuseparator
16200 Modules\SpecialChar menuseparator
16205 File\SpecialChar menuseparator
16206 Open Example\SpecialChar menuseparator
16207 Modules\SpecialChar menuseparator
16212 File\SpecialChar menuseparator
16213 Open Example\SpecialChar menuseparator
16214 Modules\SpecialChar menuseparator
16215 Noweb2\SpecialChar LyX
16221 \begin_layout Subsection
16223 \change_inserted 564990737 1672161542
16229 \begin_layout Standard
16231 \change_inserted 564990737 1672161542
16234 This module uses the
16244 \begin_inset Flex Code
16247 \begin_layout Plain Layout
16249 \change_inserted 564990737 1672161542
16257 package in R for dynamic report generation has to be installed for this
16259 \begin_inset Flex Code
16262 \begin_layout Plain Layout
16264 \change_inserted 564990737 1672161542
16267 install.packages(“knitr”)
16276 \begin_layout Paragraph
16278 \change_inserted 564990737 1672161542
16284 \begin_layout Standard
16286 \change_inserted 564990737 1672161542
16289 it depends on R >= 2.14.1.
16291 \begin_inset Flex URL
16294 \begin_layout Plain Layout
16296 \change_inserted 564990737 1672161542
16298 http://yihui.name/knitr
16307 \begin_layout Standard
16309 \change_inserted 564990737 1672161542
16316 also has to be installed.
16317 It cannot be used if the modules
16320 \begin_inset space ~
16332 Help\SpecialChar menuseparator
16333 Specific Manuals\SpecialChar menuseparator
16338 File\SpecialChar menuseparator
16339 Open Example\SpecialChar menuseparator
16340 Modules\SpecialChar menuseparator
16344 \begin_inset space ~
16348 \begin_inset CommandInset ref
16350 reference "sec:Literate-Programming"
16354 for information about literate programming.
16357 \begin_layout Subsection
16359 \change_inserted 564990737 1672161542
16365 \begin_layout Standard
16367 \change_inserted 564990737 1672161542
16370 This module allows the use of the statistical language S/R as a literate
16382 \begin_inset CommandInset href
16385 target "https://www.ctan.org/pkg/includernw"
16391 \begin_inset CommandInset href
16394 target "https://www.ctan.org/pkg/fancyvrb"
16399 are available from CTAN.
16400 It cannot be used if the module
16403 \begin_inset space ~
16411 Help\SpecialChar menuseparator
16412 Specific Manuals\SpecialChar menuseparator
16417 File\SpecialChar menuseparator
16418 Open Example\SpecialChar menuseparator
16419 Modules\SpecialChar menuseparator
16423 \begin_inset space ~
16427 \begin_inset CommandInset ref
16429 reference "sec:Literate-Programming"
16433 for information about literate programming.
16436 \begin_layout Section
16437 Multiple Text Columns
16440 \begin_layout Standard
16441 This feature is independent of the option
16443 Two-column document
16445 in the document settings under
16450 If you want to have 2
16451 \begin_inset space ~
16454 columns for the whole document, it is recommended to use the
16456 Two-column document
16459 For all other cases use this feature.
16462 \begin_layout Standard
16463 To use multiple text columns in your document, you have to load the module
16470 Document\SpecialChar menuseparator
16471 Settings\SpecialChar menuseparator
16474 ) and must have the \SpecialChar LaTeX
16476 \begin_inset Flex Code
16479 \begin_layout Plain Layout
16488 \begin_layout Standard
16489 Footnotes within multiple columns will be placed at the bottom of the page
16490 and not under each column.
16491 Within the different columns you can use everything, with the limitation
16492 that for floats you need to use the float option
16499 \begin_layout Subsection
16503 \begin_layout Standard
16504 If you want to have 2
16505 \begin_inset space ~
16508 columns in your text, insert a multicolumn inset via the menu
16510 Insert\SpecialChar menuseparator
16512 \begin_inset space ~
16515 Insets\SpecialChar menuseparator
16517 \begin_inset space ~
16522 where the columns should start.
16523 Write all text that should be printed in 2
16524 \begin_inset space ~
16527 columns into this inset.
16530 \begin_layout Standard
16531 Here is an example:
16534 \begin_layout Standard
16536 \begin_inset Flex Multiple Columns
16539 \begin_layout Plain Layout
16544 The Adventure of the Empty House
16547 \begin_inset Newline newline
16550 by Sir Arthur Conan Doyle
16553 \begin_layout Plain Layout
16556 It was in the spring of the year 1894 that all London was interested, and
16557 the fashionable world dismayed, by the murder of the Honourable Ronald
16558 Adair under most unusual and inexplicable circumstances.
16559 The public has already learned those particulars of the crime which came
16560 out in the police investigation, but a good deal was suppressed upon that
16561 occasion, since the case for the prosecution was so overwhelmingly strong
16562 that it was not necessary to bring forward all the facts.
16563 Only now, at the end of nearly ten years, am I allowed to supply those
16564 missing links which make up the whole of that remarkable chain.
16565 The crime was of interest in itself, but that interest was as nothing to
16566 me compared to the inconceivable sequel, which afforded me the greatest
16567 shock and surprise of any event in my adventurous life.
16568 Even now, after this long interval, I find myself thrilling as I think
16569 of it, and feeling once more that sudden flood of joy, amazement, and increduli
16570 ty which utterly submerged my mind.
16571 Let me say to that public, which has shown some interest in those glimpses
16572 which I have occasionally given them of the thoughts and actions of a very
16573 remarkable man, that they are not to blame me if I have not shared my knowledge
16574 with them, for I should have considered it my first duty to do so, had
16575 I not been barred by a positive prohibition from his own lips, which was
16576 only withdrawn upon the third of last month.
16584 \begin_layout Standard
16585 To get 3 or more columns, set the cursor into the multicolumn inset and
16588 Insert\SpecialChar menuseparator
16590 \begin_inset space ~
16594 \begin_inset space ~
16600 The number of the desired columns is written into that inset (for 3
16601 \begin_inset space ~
16605 \begin_inset Quotes eld
16609 \begin_inset Quotes erd
16613 \begin_inset Newline newline
16616 Here is an example with 3
16617 \begin_inset space ~
16623 \begin_layout Standard
16624 \begin_inset Flex Multiple Columns
16627 \begin_layout Plain Layout
16630 \begin_inset Argument 1
16633 \begin_layout Plain Layout
16640 It can be imagined that my close intimacy with Sherlock Holmes had interested
16641 me deeply in crime, and that after his disappearance I never failed to
16642 read with care the various problems which came before the public.
16643 And I even attempted, more than once, for my own private satisfaction,
16644 to employ his methods in their solution, though with indifferent success.
16645 There was none, however, which appealed to me like this tragedy of Ronald
16647 As I read the evidence at the inquest, which led up to a verdict of willful
16648 murder against some person or persons unknown, I realized more clearly
16649 than I had ever done the loss which the community had sustained by the
16650 death of Sherlock Holmes.
16651 There were points about this strange business which would, I was sure,
16652 have specially appealed to him, and the efforts of the police would have
16653 been supplemented, or more probably anticipated, by the trained observation
16654 and the alert mind of the first criminal agent in Europe.
16655 All day, as I drove upon my round, I turned over the case in my mind and
16656 found no explanation which appeared to me to be adequate.
16657 At the risk of telling a twice-told tale, I will recapitulate the facts
16658 as they were known to the public at the conclusion of the inquest.
16666 \begin_layout Standard
16667 You can have up to 10
16668 \begin_inset space ~
16671 columns if you want to, but that might not be very pleasant for the readers
16675 \begin_layout Standard
16676 \begin_inset Newpage newpage
16682 \begin_layout Subsection
16683 Columns inside Columns
16686 \begin_layout Standard
16687 You can also have columns inside columns:
16690 \begin_layout Standard
16691 \begin_inset Flex Multiple Columns
16694 \begin_layout Plain Layout
16697 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
16698 at that time governor of one of the Australian colonies.
16699 Adair's mother had returned from Australia to undergo the operation for
16700 cataract, and she, her son Ronald, and her daughter Hilda were living together
16704 \begin_layout Plain Layout
16705 \begin_inset Flex Multiple Columns
16708 \begin_layout Plain Layout
16711 The youth moved in the best society
16712 \begin_inset space ~
16715 – had, so far as was known, no enemies and no particular vices.
16716 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
16717 had been broken off by mutual consent some months before, and there was
16718 no sign that it had left any very profound feeling behind it.
16719 For the rest {sic} the man's life moved in a narrow and conventional circle,
16720 for his habits were quiet and his nature unemotional.
16721 Yet it was upon this easy-going young aristocrat that death came, in most
16722 strange and unexpected form, between the hours of ten and eleven-twenty
16723 on the night of March 30, 1894.
16731 \begin_layout Plain Layout
16734 Ronald Adair was fond of cards
16735 \begin_inset space ~
16738 – playing continually, but never for such stakes as would hurt him.
16739 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
16740 It was shown that, after dinner on the day of his death, he had played
16741 a rubber of whist at the latter club.
16742 He had also played there in the afternoon.
16747 The evidence of those who had played with him
16748 \begin_inset space ~
16752 Murray, Sir John Hardy, and Colonel Moran
16753 \begin_inset space ~
16756 – showed that the game was whist, and that there was a fairly equal fall
16758 Adair might have lost five pounds, but not more.
16759 His fortune was a considerable one, and such a loss could not in any way
16761 He had played nearly every day at one club or other, but he was a cautious
16762 player, and usually rose a winner.
16763 It came out in evidence that, in partnership with Colonel Moran, he had
16764 actually won as much as four hundred and twenty pounds in a sitting, some
16765 weeks before, from Godfrey Milner and Lord Balmoral.
16766 So much for his recent history as it came out at the inquest.
16774 \begin_layout Subsection
16778 \begin_layout Standard
16779 The examples in this section show some more special features of multiple
16783 \begin_layout Standard
16784 For more features of multiple columns, have a look at the
16785 \begin_inset CommandInset href
16787 name "documentation"
16788 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
16793 of the \SpecialChar LaTeX
16795 \begin_inset Flex Code
16798 \begin_layout Plain Layout
16807 \begin_layout Subsubsection
16811 \begin_layout Standard
16812 To add a preface text for multiple columns, set the cursor into the multicolumn
16813 inset and use the menu
16815 Insert\SpecialChar menuseparator
16819 Write your preface text into that inset.
16820 \begin_inset Newline newline
16823 This is an example with some preface text:
16826 \begin_layout Standard
16827 \begin_inset VSpace bigskip
16833 \begin_layout Standard
16834 \begin_inset Flex Multiple Columns
16837 \begin_layout Plain Layout
16838 \begin_inset Argument 2
16841 \begin_layout Plain Layout
16842 And the story continues and continues and continues and continues\SpecialChar ldots
16850 On the evening of the crime, he returned from the club exactly at ten.
16851 His mother and sister were out spending the evening with a relation.
16852 The servant deposed that she heard him enter the front room on the second
16853 floor, generally used as his sitting-room.
16854 She had lit a fire there, and as it smoked she had opened the window.
16855 No sound was heard from the room until eleven-twenty, the hour of the return
16856 of Lady Maynooth and her daughter.
16857 Desiring to say good-night, she attempted to enter her son's room.
16858 The door was locked on the inside, and no answer could be got to their
16859 cries and knocking.
16860 Help was obtained, and the door forced.
16861 The unfortunate young man was found lying near the table.
16862 His head had been horribly mutilated by an expanding revolver bullet, but
16863 no weapon of any sort was to be found in the room.
16871 \begin_layout Standard
16872 You can also use a section heading as the preface if you use a section command
16873 as \SpecialChar TeX
16875 For example the command
16878 \begin_layout LyX-Code
16881 subsection{subsection title}
16884 \begin_layout Standard
16885 creates a subsection.
16886 In this example the preface is a subsubsection:
16889 \begin_layout Standard
16890 \begin_inset Flex Multiple Columns
16893 \begin_layout Plain Layout
16894 \begin_inset Argument 2
16897 \begin_layout Plain Layout
16901 \begin_layout Plain Layout
16910 This is a subsubsection heading as a preface
16914 \begin_layout Plain Layout
16928 A minute examination of the circumstances served only to make the case more
16930 In the first place, no reason could be given why the young man should have
16931 fastened the door upon the inside.
16932 There was the possibility that the murderer had done this, and had afterwards
16933 escaped by the window.
16934 The drop was at least twenty feet, however, and a bed of crocuses in full
16936 Neither the flowers nor the earth showed any sign of having been disturbed,
16937 nor were there any marks upon the narrow strip of grass which separated
16938 the house from the road.
16939 Apparently, therefore, it was the young man himself who had fastened the
16941 But how did he come by his death? No one could have climbed up to the window
16942 without leaving traces.
16943 Suppose a man had fired through the window, he would indeed be a remarkable
16944 shot who could with a revolver inflict so deadly a wound.
16945 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
16946 a hundred yards of the house.
16947 No one had heard a shot.
16955 \begin_layout Standard
16956 If there is less vertical space than 6
16957 \begin_inset space ~
16960 text lines is left on the page at the beginning of the multiple columns,
16961 a page break will be inserted before the multiple columns.
16962 Depending on the number of lines of the preface text, you might want to
16964 This is done by setting the cursor into the mulitcolumn inset behind the
16965 preface (if there is any) and using the menu
16967 Insert\SpecialChar menuseparator
16969 \begin_inset space ~
16973 \begin_inset space ~
16977 \begin_inset space ~
16983 Insert into that inset the amount of space like e.
16984 \begin_inset space \thinspace{}
16988 \begin_inset space \space{}
16992 \begin_inset Quotes eld
16996 \begin_inset Quotes erd
17000 \begin_inset Newline newline
17003 In this example the space is set to 7
17004 \begin_inset space ~
17007 text lines by using
17008 \begin_inset Flex Code
17011 \begin_layout Plain Layout
17020 \begin_inset Flex Code
17023 \begin_layout Plain Layout
17031 needs to be inserted as \SpecialChar TeX
17035 \begin_layout Standard
17036 \begin_inset Flex Multiple Columns
17039 \begin_layout Plain Layout
17040 \begin_inset Argument 3
17043 \begin_layout Plain Layout
17048 \begin_layout Plain Layout
17064 On the evening of the crime, he returned from the club exactly at ten.
17065 His mother and sister were out spending the evening with a relation.
17066 The servant deposed that she heard him enter the front room on the second
17067 floor, generally used as his sitting-room.
17068 She had lit a fire there, and as it smoked she had opened the window.
17069 No sound was heard from the room until eleven-twenty, the hour of the return
17070 of Lady Maynooth and her daughter.
17071 Desiring to say good-night, she attempted to enter her son's room.
17072 The door was locked on the inside, and no answer could be got to their
17073 cries and knocking.
17074 Help was obtained, and the door forced.
17075 The unfortunate young man was found lying near the table.
17076 His head had been horribly mutilated by an expanding revolver bullet, but
17077 no weapon of any sort was to be found in the room.
17085 \begin_layout Subsubsection
17089 \begin_layout Standard
17090 The amount of space before and after multiple columns can be changed by
17091 changing the length
17092 \begin_inset Flex Code
17095 \begin_layout Plain Layout
17104 For example the command
17107 \begin_layout LyX-Code
17115 \begin_layout Standard
17116 in \SpecialChar TeX
17117 Code changes its value to 3
17118 \begin_inset space \thinspace{}
17122 The change must be made before the multiple columns' start.
17123 The predefined value is 13
17124 \begin_inset space \thinspace{}
17130 \begin_layout Standard
17132 \begin_inset Flex Code
17135 \begin_layout Plain Layout
17144 \begin_inset space \thinspace{}
17150 \begin_layout Standard
17154 \begin_layout Plain Layout
17160 multicolsep}{2.5cm}
17168 \begin_layout Standard
17169 \begin_inset Flex Multiple Columns
17172 \begin_layout Plain Layout
17175 All day I turned these facts over in my mind, endeavouring to hit upon some
17176 theory which could reconcile them all, and to find that line of least resistanc
17177 e which my poor friend had declared to be the starting-point of every investigat
17179 I confess that I made little progress.
17180 In the evening I strolled across the Park, and found myself about six o'clock
17181 at the Oxford Street end of Park Lane.
17182 A group of loafers upon the pavements, all staring up at a particular window,
17183 directed me to the house which I had come to see.
17184 A tall, thin man with coloured glasses, whom I strongly suspected of being
17185 a plain-clothes detective, was pointing out some theory of his own, while
17186 the others crowded round to listen to what he said.
17187 I got as near him as I could, but his observations seemed to me to be absurd,
17188 so I withdrew again in some disgust.
17189 As I did so I struck against an elderly, deformed man, who had been behind
17190 me, and I knocked down several books which he was carrying.
17198 \begin_layout Standard
17199 \begin_inset Note Greyedout
17202 \begin_layout Plain Layout
17207 The values you set with
17208 \begin_inset Flex Code
17211 \begin_layout Plain Layout
17219 will be used for all following multiple columns until you change them again.
17227 \begin_layout Standard
17231 \begin_layout Plain Layout
17243 \begin_inset Note Note
17246 \begin_layout Plain Layout
17247 go back to the default
17255 \begin_layout Standard
17256 \begin_inset Newpage newpage
17262 \begin_layout Subsubsection
17266 \begin_layout Standard
17267 A column break can be forced by inserting the command
17268 \begin_inset Flex Code
17271 \begin_layout Plain Layout
17279 as \SpecialChar TeX
17280 Code to that position in the text where the column should be broken.
17281 Note that this leads in most cases to whitespace in the text.
17282 \begin_inset Newline newline
17285 Here is an example:
17288 \begin_layout Standard
17289 \begin_inset Flex Multiple Columns
17292 \begin_layout Plain Layout
17295 \begin_inset Quotes eld
17298 You're surprised to see me, sir,
17299 \begin_inset Quotes erd
17302 said he, in a strange, croaking voice.
17305 \begin_layout Plain Layout
17308 I acknowledged that I was.
17311 \begin_layout Plain Layout
17314 \begin_inset Quotes eld
17317 Well, I've a conscience, sir, and when I chanced to see you go into this
17318 house, as I came hobbling after you, I thought to myself, I'll just step
17319 in and see that kind gentleman, and tell him that if I was a bit gruff
17320 in my manner there was not any harm meant, and that I am much obliged to
17321 him for picking up my books.
17322 \begin_inset Quotes erd
17328 \begin_layout Plain Layout
17331 \begin_inset Quotes eld
17334 You make too much of a trifle,
17335 \begin_inset Quotes erd
17340 \begin_inset Quotes eld
17343 May I ask how you knew who I was?
17344 \begin_inset Quotes erd
17347 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
17351 \begin_layout Plain Layout
17363 \begin_layout Plain Layout
17366 \begin_inset Quotes eld
17369 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
17370 you'll find my little bookshop at the corner of Church Street, and very
17371 happy to see you, I am sure.
17372 Maybe you collect yourself, sir.
17376 \begin_inset space ~
17390 \begin_inset space ~
17393 – a bargain, every one of them.
17394 With five volumes you could just fill that gap on that second shelf.
17395 It looks untidy, does it not, sir?
17396 \begin_inset Quotes erd
17407 \begin_layout Subsubsection
17411 \begin_layout Standard
17412 The width of the columns is automatically calculated, but you can modify
17413 the space between the columns.
17414 This is done by changing the length
17415 \begin_inset Flex Code
17418 \begin_layout Plain Layout
17427 Its predefined value is 10
17428 \begin_inset space \thinspace{}
17432 Here is an example where
17433 \begin_inset Flex Code
17436 \begin_layout Plain Layout
17445 \begin_inset space \thinspace{}
17451 \begin_layout Standard
17455 \begin_layout Plain Layout
17469 \begin_layout Standard
17470 \begin_inset Flex Multiple Columns
17473 \begin_layout Plain Layout
17476 My observations of No.
17477 \begin_inset space \space{}
17480 427 Park Lane did little to clear up the problem in which I was interested.
17481 The house was separated from the street by a low wall and railing, the
17482 whole not more than five feet high.
17483 It was perfectly easy, therefore, for anyone to get into the garden, but
17484 the window was entirely inaccessible, since there was no water pipe or
17485 anything which could help the most active man to climb it.
17486 More puzzled than ever, I retraced my steps to Kensington.
17487 I had not been in my study five minutes when the maid entered to say that
17488 a person desired to see me.
17489 To my astonishment it was none other than my strange old book collector,
17490 his sharp, wizened face peering out from a frame of white hair, and his
17491 precious volumes, a dozen of them at least, wedged under his right arm.
17499 \begin_layout Standard
17503 \begin_layout Plain Layout
17515 \begin_inset Note Note
17518 \begin_layout Plain Layout
17519 go back to the default
17527 \begin_layout Subsubsection
17531 \begin_layout Standard
17532 Between the columns a rule with a width of the length
17533 \begin_inset Flex Code
17536 \begin_layout Plain Layout
17545 If this rule width is set to 0
17546 \begin_inset space \thinspace{}
17549 pt (this is the default), the rule is suppressed.
17550 In the following example the rule is 2
17551 \begin_inset space \thinspace{}
17557 \begin_layout Standard
17561 \begin_layout Plain Layout
17567 columnseprule}{2pt}
17575 \begin_layout Standard
17576 \begin_inset Flex Multiple Columns
17579 \begin_layout Plain Layout
17582 \begin_inset Quotes eld
17585 You're surprised to see me, sir,
17586 \begin_inset Quotes erd
17589 said he, in a strange, croaking voice.
17592 \begin_layout Plain Layout
17595 I acknowledged that I was.
17598 \begin_layout Plain Layout
17601 \begin_inset Quotes eld
17604 Well, I've a conscience, sir, and when I chanced to see you go into this
17605 house, as I came hobbling after you, I thought to myself, I'll just step
17606 in and see that kind gentleman, and tell him that if I was a bit gruff
17607 in my manner there was not any harm meant, and that I am much obliged to
17608 him for picking up my books.
17609 \begin_inset Quotes erd
17615 \begin_layout Plain Layout
17618 \begin_inset Quotes eld
17621 You make too much of a trifle,
17622 \begin_inset Quotes erd
17627 \begin_inset Quotes eld
17630 May I ask how you knew who I was?
17631 \begin_inset Quotes erd
17637 \begin_layout Plain Layout
17640 \begin_inset Quotes eld
17643 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
17644 you'll find my little bookshop at the corner of Church Street, and very
17645 happy to see you, I am sure.
17646 Maybe you collect yourself, sir.
17650 \begin_inset space ~
17664 \begin_inset space ~
17667 – a bargain, every one of them.
17668 With five volumes you could just fill that gap on that second shelf.
17669 It looks untidy, does it not, sir?
17670 \begin_inset Quotes erd
17681 \begin_layout Standard
17682 \begin_inset VSpace defskip
17688 \begin_layout Standard
17689 The rule can be colored by redefining the command
17690 \begin_inset Flex Code
17693 \begin_layout Plain Layout
17702 This is done by inserting the command
17705 \begin_layout LyX-Code
17710 columnseprulecolor}{
17715 \begin_layout Standard
17716 as \SpecialChar TeX
17717 Code before the multicolumn inset.
17719 \begin_inset Flex Code
17722 \begin_layout Plain Layout
17728 in this command by a color of your choice.
17729 You can use all pre- and self-defined colors.
17737 \begin_inset space ~
17742 for more information about pre- and self-defined colors.
17743 To go back to the default color insert the command
17746 \begin_layout LyX-Code
17751 columnseprulecolor}{
17756 \begin_layout Standard
17757 Here is the example with a cyan rule and 1
17758 \begin_inset space \thinspace{}
17761 cm column separation:
17764 \begin_layout Standard
17768 \begin_layout Plain Layout
17777 \begin_layout Plain Layout
17783 columnseprulecolor}{
17793 \begin_layout Standard
17794 \begin_inset Flex Multiple Columns
17797 \begin_layout Plain Layout
17800 \begin_inset Quotes eld
17803 You're surprised to see me, sir,
17804 \begin_inset Quotes erd
17807 said he, in a strange, croaking voice.
17810 \begin_layout Plain Layout
17813 I acknowledged that I was.
17816 \begin_layout Plain Layout
17819 \begin_inset Quotes eld
17822 Well, I've a conscience, sir, and when I chanced to see you go into this
17823 house, as I came hobbling after you, I thought to myself, I'll just step
17824 in and see that kind gentleman, and tell him that if I was a bit gruff
17825 in my manner there was not any harm meant, and that I am much obliged to
17826 him for picking up my books.
17827 \begin_inset Quotes erd
17833 \begin_layout Plain Layout
17836 \begin_inset Quotes eld
17839 You make too much of a trifle,
17840 \begin_inset Quotes erd
17845 \begin_inset Quotes eld
17848 May I ask how you knew who I was?
17849 \begin_inset Quotes erd
17855 \begin_layout Plain Layout
17858 \begin_inset Quotes eld
17861 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
17862 you'll find my little bookshop at the corner of Church Street, and very
17863 happy to see you, I am sure.
17864 Maybe you collect yourself, sir.
17868 \begin_inset space ~
17882 \begin_inset space ~
17885 – a bargain, every one of them.
17886 With five volumes you could just fill that gap on that second shelf.
17887 It looks untidy, does it not, sir?
17888 \begin_inset Quotes erd
17899 \begin_layout Standard
17903 \begin_layout Plain Layout
17909 columnseprule}{0pt}
17912 \begin_layout Plain Layout
17918 columnseprulecolor}{
17926 \begin_inset Note Note
17929 \begin_layout Plain Layout
17930 go back to the default
17938 \begin_layout Section
17940 \change_inserted 564990737 1671270380
17944 \begin_layout Subsection
17946 \change_inserted 564990737 1671270398
17948 \change_deleted 564990737 1671270396
17954 \begin_layout Standard
17957 as well as any other text processor uses by default rectangular paragraphs.
17958 For special cases like for example posters, invitation cards or poems you
17959 can modify the paragraph shape to one of your choice.
17960 This can be done by using the \SpecialChar LaTeX
17962 \begin_inset Flex Code
17965 \begin_layout Plain Layout
17971 which is loaded by using in the document settings the module
17973 Custom paragraph shapes
17978 \begin_layout Subsubsection
17982 \begin_layout Standard
17987 provides the following shapes:
17990 \begin_layout Standard
17991 \begin_inset Tabular
17992 <lyxtabular version="3" rows="13" columns="3">
17993 <features booktabs="true" islongtable="true" longtabularalignment="center">
17994 <column alignment="left" valignment="middle" width="16col%">
17995 <column alignment="left" valignment="middle" width="40col%">
17996 <column alignment="left" valignment="middle" width="35col%">
17997 <row endhead="true">
17998 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
18001 \begin_layout Plain Layout
18010 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
18013 \begin_layout Plain Layout
18022 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
18025 \begin_layout Plain Layout
18035 <row interlinespace="default">
18036 <cell alignment="left" valignment="top" usebox="none">
18039 \begin_layout Plain Layout
18047 <cell alignment="left" valignment="top" usebox="none">
18050 \begin_layout Plain Layout
18053 Circle with circular hole (in the size of a CD/DVD)
18058 <cell alignment="left" valignment="top" usebox="none">
18061 \begin_layout Plain Layout
18064 Cannot be scaled, take care there is not too much text
18070 <row interlinespace="default">
18071 <cell alignment="left" valignment="top" usebox="none">
18074 \begin_layout Plain Layout
18082 <cell alignment="left" valignment="top" usebox="none">
18085 \begin_layout Plain Layout
18093 <cell alignment="left" valignment="top" usebox="none">
18096 \begin_layout Plain Layout
18099 Fragile, calculation might fail
18105 <row interlinespace="default">
18106 <cell alignment="left" valignment="top" usebox="none">
18109 \begin_layout Plain Layout
18117 <cell alignment="left" valignment="top" usebox="none">
18120 \begin_layout Plain Layout
18123 Rhomboid (symbolizing a
18124 \begin_inset Quotes eld
18128 \begin_inset Quotes erd
18136 <cell alignment="left" valignment="top" usebox="none">
18139 \begin_layout Plain Layout
18148 <row interlinespace="default">
18149 <cell alignment="left" valignment="top" usebox="none">
18152 \begin_layout Plain Layout
18160 <cell alignment="left" valignment="top" usebox="none">
18163 \begin_layout Plain Layout
18171 <cell alignment="left" valignment="top" usebox="none">
18174 \begin_layout Plain Layout
18183 <row interlinespace="default">
18184 <cell alignment="left" valignment="top" usebox="none">
18187 \begin_layout Plain Layout
18195 <cell alignment="left" valignment="top" usebox="none">
18198 \begin_layout Plain Layout
18206 <cell alignment="left" valignment="top" usebox="none">
18209 \begin_layout Plain Layout
18218 <row interlinespace="default">
18219 <cell alignment="left" valignment="top" usebox="none">
18222 \begin_layout Plain Layout
18230 <cell alignment="left" valignment="top" usebox="none">
18233 \begin_layout Plain Layout
18236 Nut for bolt (hexagon with circular hole)
18241 <cell alignment="left" valignment="top" usebox="none">
18244 \begin_layout Plain Layout
18253 <row interlinespace="default">
18254 <cell alignment="left" valignment="top" usebox="none">
18257 \begin_layout Plain Layout
18265 <cell alignment="left" valignment="top" usebox="none">
18268 \begin_layout Plain Layout
18276 <cell alignment="left" valignment="top" usebox="none">
18279 \begin_layout Plain Layout
18288 <row interlinespace="default">
18289 <cell alignment="left" valignment="top" usebox="none">
18292 \begin_layout Plain Layout
18300 <cell alignment="left" valignment="top" usebox="none">
18303 \begin_layout Plain Layout
18311 <cell alignment="left" valignment="top" usebox="none">
18314 \begin_layout Plain Layout
18323 <row interlinespace="default">
18324 <cell alignment="left" valignment="top" usebox="none">
18327 \begin_layout Plain Layout
18335 <cell alignment="left" valignment="top" usebox="none">
18338 \begin_layout Plain Layout
18346 <cell alignment="left" valignment="top" usebox="none">
18349 \begin_layout Plain Layout
18358 <row interlinespace="default">
18359 <cell alignment="left" valignment="top" usebox="none">
18362 \begin_layout Plain Layout
18370 <cell alignment="left" valignment="top" usebox="none">
18373 \begin_layout Plain Layout
18376 Normal/reversed rain drop
18381 <cell alignment="left" valignment="top" usebox="none">
18384 \begin_layout Plain Layout
18387 Fragile, calculation might fail
18393 <row interlinespace="default">
18394 <cell alignment="left" valignment="top" usebox="none">
18397 \begin_layout Plain Layout
18406 <cell alignment="left" valignment="top" usebox="none">
18409 \begin_layout Plain Layout
18412 The \SpecialChar TeX
18418 <cell alignment="left" valignment="top" usebox="none">
18421 \begin_layout Plain Layout
18430 <row interlinespace="default">
18431 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
18434 \begin_layout Plain Layout
18438 \begin_inset Newline newline
18446 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
18449 \begin_layout Plain Layout
18452 Triangles in different orientations
18457 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
18460 \begin_layout Plain Layout
18476 \begin_layout Standard
18477 To use a shape for your paragraph, simply select it in \SpecialChar LyX
18479 for environments in the toolbar.
18482 \begin_layout Standard
18483 \begin_inset Newpage newpage
18489 \begin_layout Standard
18490 Here is an example paragraph in the shape of a nut:
18493 \begin_layout Standard
18494 \begin_inset VSpace bigskip
18503 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
18504 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
18506 At vero eos et accusam et justo duo dolores et ea rebum.
18507 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
18509 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
18510 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
18514 \begin_layout Standard
18515 \begin_inset VSpace bigskip
18521 \begin_layout Standard
18522 \begin_inset Note Greyedout
18525 \begin_layout Plain Layout
18534 paragraphs cannot run over a page break.
18542 \begin_layout Standard
18543 \begin_inset VSpace bigskip
18549 \begin_layout Standard
18551 \begin_inset Flex Code
18554 \begin_layout Plain Layout
18560 takes care that the shape will always be preserved, no matter how much
18561 text is in the paragraph.
18562 Therefore the paragraph size changes with the amount of contained text.
18563 This can lead to paragraph sizes exceeding the page margins.
18564 To demonstrate the size scaling, here is the same example paragraph but
18565 with twice as much text:
18568 \begin_layout Standard
18569 \begin_inset Newpage newpage
18578 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
18579 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
18581 At vero eos et accusam et justo duo dolores et ea rebum.
18582 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
18584 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
18585 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
18587 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
18588 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
18590 At vero eos et accusam et justo duo dolores et ea rebum.
18591 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
18593 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
18594 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
18598 \begin_layout Standard
18599 \begin_inset VSpace bigskip
18605 \begin_layout Standard
18606 An exception is the shape
18611 It cannot be scaled because it must fit the size of a CD/DVD.
18612 Therefore the amount of text that fits into the shape is limited.
18613 \begin_inset Newline newline
18624 shape are fragile, meaning that the calculation of their size can fail,
18625 depending on the amount of text.
18626 You will then get the \SpecialChar LaTeX
18628 \begin_inset Quotes eld
18631 Arithmetic overflow
18632 \begin_inset Quotes erd
18636 In this case one can try to remove or add some text; if nothing works one
18637 has to use another shape.
18640 \begin_layout Standard
18641 \begin_inset VSpace bigskip
18647 \begin_layout Standard
18648 For shapes with tips you will maybe see that \SpecialChar LaTeX
18649 's hyphenation routine fails
18650 for text in the tips.
18651 Therefore it is often necessary to add hyphenation points
18656 arg "specialchar-insert hyphenation"
18661 ) to the corresponding text parts.
18664 \begin_layout Standard
18665 \begin_inset VSpace bigskip
18671 \begin_layout Standard
18672 Shapepar paragraphs are either always centered or placed on the page so
18673 that their left border touches the left page margin.
18674 You can therefore not use the paragraph dialog to align such paragraphs.
18675 A solution is to put the paragraph into a minipage or parbox and align
18677 The problem is hereby to find the right width for the box.
18678 Because if it is too wide and you center the box, the paragraph is not
18679 centered too because it sticks at the left side of the box.
18680 So you might have to play a bit with the width until it fits.
18681 Here are two heart-shaped paragraphs, the first one is not aligned, the
18682 second one is right-aligned:
18685 \begin_layout Standard
18686 \begin_inset Newpage newpage
18692 \begin_layout Heart
18696 Lo\SpecialChar softhyphen
18697 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
18698 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
18700 At vero eos et accusam et justo duo dolores et ea rebum.
18701 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
18705 \begin_layout Standard
18706 \begin_inset VSpace bigskip
18712 \begin_layout Standard
18715 \begin_inset Box Frameless
18725 height_special "totalheight"
18730 backgroundcolor "none"
18733 \begin_layout Heart
18737 Lo\SpecialChar softhyphen
18738 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
18739 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
18741 At vero eos et accusam et justo duo dolores et ea rebum.
18742 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
18751 \begin_layout Subsubsection
18755 \begin_layout Standard
18756 You can define any shape you want.
18757 Doing this manually is a lot of work because every coordinate must be specified.
18758 But there is a way to let the computer calculate the coordinates:
18761 \begin_layout Enumerate
18762 Install the program
18763 \begin_inset CommandInset href
18766 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
18774 \begin_layout Enumerate
18781 TeX/LaTeX\SpecialChar menuseparator
18782 Settings\SpecialChar menuseparator
18785 and select the font size you are using in your document.
18786 For example this document uses the size 12
18787 \begin_inset space \thinspace{}
18793 \begin_layout Enumerate
18797 \begin_layout Enumerate
18800 TeX/LaTeX\SpecialChar menuseparator
18803 to export the shape to coordinates.
18804 In the appearing dialog use either the outline of your shape for the coordinate
18805 s or the path itself.
18809 \begin_layout Plain Layout
18810 For more information see
18811 \begin_inset CommandInset href
18813 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
18826 \begin_layout Standard
18827 The coordinates are written into a \SpecialChar TeX
18829 To use it for your \SpecialChar LyX
18833 \begin_layout Enumerate
18834 Place the cursor before the first character of your paragraph (or into a
18838 \begin_layout Enumerate
18839 Open in \SpecialChar LyX
18842 Insert\SpecialChar menuseparator
18843 File\SpecialChar menuseparator
18845 \begin_inset space ~
18850 , select the file and use
18859 \begin_layout Standard
18860 \begin_inset VSpace defskip
18866 \begin_layout Standard
18867 \begin_inset Note Greyedout
18870 \begin_layout Plain Layout
18875 : The changed shape only applies to the current paragraph; everything is
18876 reset to normal for the next paragraph.
18877 Therefore the shape definition file must be input into every paragraph
18878 with the desired shape.
18886 \begin_layout Standard
18887 \begin_inset VSpace bigskip
18893 \begin_layout Standard
18894 Here is an example:
18897 \begin_layout Standard
18898 \begin_inset VSpace bigskip
18904 \begin_layout Standard
18905 \begin_inset CommandInset include
18907 filename "SpecialParagraphShape.tex"
18914 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
18915 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
18917 At vero eos et accusam et justo duo dolores et ea rebum.
18918 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
18920 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
18921 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
18925 \begin_layout Standard
18926 \begin_inset VSpace bigskip
18932 \begin_layout Standard
18937 to draw complexer shapes in
18941 you can draw the shape in a program of your choice and import the resulting
18947 Then you only need to draw a line or spline along the outline of the image.
18950 \begin_layout Standard
18951 \begin_inset VSpace bigskip
18957 \begin_layout Standard
18960 Custom paragraph shapes
18962 also provides the two commands
18970 which can be used to define custom shapes coordinate by coordinate.
18974 \begin_layout Plain Layout
18975 These commands are internally used for all shapes described here.
18980 For information how these styles are used and about further customization
18981 possibilities, have a look at the
18982 \begin_inset CommandInset href
18984 name "documentation"
18985 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
18991 \begin_inset Flex Code
18994 \begin_layout Plain Layout
19003 \begin_layout Chapter
19005 \change_deleted 564990737 1671304317
19009 \change_inserted 564990737 1671304322
19011 \change_deleted 564990737 1671304331
19012 ies with Bib\SpecialChar TeX
19018 \begin_layout Standard
19019 The most basic information about how to use Bib\SpecialChar TeX
19024 with \SpecialChar LyX
19025 is contained in the section
19027 Bibliography databases
19034 The following subsections explain special bibliography features supported
19035 by \SpecialChar LyX
19039 \begin_layout Section
19040 Alternative Citation Styles
19043 \begin_layout Standard
19044 Standard Bib\SpecialChar TeX
19046 \begin_inset space \thinspace{}
19050 \begin_inset space \space{}
19054 \begin_inset Quotes eld
19058 \begin_inset Quotes erd
19061 ) to refer to a cited work.
19062 However, in many scientific disciplines, other citation styles are in use.
19063 The most common one is the author-year style (e.
19064 \begin_inset space \thinspace{}
19068 \begin_inset space \space{}
19072 \begin_inset Quotes eld
19076 \begin_inset Quotes erd
19081 supports three packages that provide this style,
19082 \begin_inset Flex Code
19085 \begin_layout Plain Layout
19092 \begin_inset Flex Code
19095 \begin_layout Plain Layout
19102 \begin_inset Flex Code
19105 \begin_layout Plain Layout
19112 Each of these packages has their pros and cons, which cannot be listed
19114 If you only want to have simple author-year (or author-numerical) style,
19115 or if you want to use one of the countless style files for
19116 \begin_inset Flex Code
19119 \begin_layout Plain Layout
19125 , then the established
19126 \begin_inset Flex Code
19129 \begin_layout Plain Layout
19135 package is probably your choice.
19136 If you look for specific citation styles common in law studies, you might
19138 \begin_inset Flex Code
19141 \begin_layout Plain Layout
19148 If you want to have full control over the formatting or look for advanced
19149 features such as ibidem, footnote citations, full title citations, advanced
19150 date formats (such as 400 BC) or full localization to other languages than
19151 English, you should definitely consider
19152 \begin_inset Flex Code
19155 \begin_layout Plain Layout
19161 , which exceeds all other packages in terms of features, but is also quite
19162 heavy and more resource-hungry.
19165 \begin_layout Standard
19166 The handling of these packages in \SpecialChar LyX
19167 is basically the same.
19169 \begin_inset Flex Noun
19172 \begin_layout Plain Layout
19173 Document\SpecialChar menuseparator
19180 \begin_inset Flex Noun
19183 \begin_layout Plain Layout
19190 \begin_inset Flex Noun
19193 \begin_layout Plain Layout
19200 \begin_inset Flex Noun
19203 \begin_layout Plain Layout
19210 \begin_inset Flex Noun
19213 \begin_layout Plain Layout
19220 \begin_inset Flex Noun
19223 \begin_layout Plain Layout
19224 Biblatex (Natbib mode)
19230 \begin_inset Flex Noun
19233 \begin_layout Plain Layout
19240 \begin_inset Flex Noun
19243 \begin_layout Plain Layout
19250 \begin_inset space ~
19253 6.5.3 in the User's Guide for more information on these choices).
19254 With all these packages, you will get some extra features in the citation
19255 dialog and you can select the style of the reference (
19256 \begin_inset Quotes eld
19260 \begin_inset Quotes erd
19264 \begin_inset Quotes eld
19268 \begin_inset Quotes erd
19272 \begin_inset Quotes eld
19276 \begin_inset Quotes erd
19280 \begin_inset Quotes eld
19284 \begin_inset Quotes erd
19288 Note that either package needs specifically designed style files.
19289 They all ship their own, but there are lots of additional style files,
19290 and there is even an interactive style file builder
19294 \begin_layout Plain Layout
19296 \begin_inset Flex URL
19299 \begin_layout Plain Layout
19301 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
19312 \begin_inset Flex Code
19315 \begin_layout Plain Layout
19324 \begin_layout Section
19325 Subdivided Bibliographies
19328 \begin_layout Standard
19329 Sometimes you might need to divide your bibliography into several sections.
19330 If you are for instance a historian, the possibility to separate sources
19331 and scientific works is most likely a
19332 \begin_inset Quotes eld
19336 \begin_inset Quotes erd
19340 Unfortunately, Bib\SpecialChar TeX
19341 itself does not allow you to do this.
19342 But with the help of some \SpecialChar LaTeX
19343 packages, Bib\SpecialChar TeX
19344 can be extended to fit your needs.
19347 \begin_layout Standard
19349 provides native support for one of these packages,
19357 \begin_layout Plain Layout
19359 \begin_inset Flex URL
19362 \begin_layout Plain Layout
19364 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
19374 The advantage of this package (compared to other packages such as
19378 ) is that you don't need to define new citation commands.
19379 Instead, you need to prepare different bibliographic databases which include
19380 the entries for the different sections of the bibliography.
19381 For example: If you want to divide your bibliography into the sections
19383 \begin_inset Quotes eld
19387 \begin_inset Quotes erd
19391 \begin_inset Quotes eld
19395 \begin_inset Quotes erd
19398 , you first need to create two bibliographic databases, e.
19399 \begin_inset space \thinspace{}
19403 \begin_inset space \space{}
19407 \begin_inset Flex Code
19410 \begin_layout Plain Layout
19417 \begin_inset Flex Code
19420 \begin_layout Plain Layout
19430 \begin_layout Standard
19432 \begin_inset Flex Noun
19435 \begin_layout Plain Layout
19436 Document\SpecialChar menuseparator
19443 \begin_inset Flex Noun
19446 \begin_layout Plain Layout
19453 \begin_inset Flex Noun
19456 \begin_layout Plain Layout
19457 Subdivided bibliography
19463 Now you can insert multiple Bib\SpecialChar TeX
19464 bibliographies, one for each section of
19466 Returning to our example: Insert the Bib\SpecialChar TeX
19468 \begin_inset Flex Code
19471 \begin_layout Plain Layout
19477 and a second one for the database
19478 \begin_inset Flex Code
19481 \begin_layout Plain Layout
19488 You are free to use the same or different styles for each section.
19489 Additionally, you can choose if the bibliography section should contain
19491 \begin_inset Quotes eld
19494 all cited references
19495 \begin_inset Quotes erd
19498 of the specified database(s) (which is the default),
19499 \begin_inset Quotes eld
19502 all uncited references
19503 \begin_inset Quotes erd
19507 \begin_inset Quotes eld
19511 \begin_inset Quotes erd
19515 This might be useful if you would like to separate your bibliography into
19517 \begin_inset Quotes eld
19521 \begin_inset Quotes erd
19525 \begin_inset Quotes eld
19529 \begin_inset Quotes erd
19533 \begin_inset Quotes eld
19537 \begin_inset Quotes erd
19541 The titles for the sections can be added as ordinary sections or subsections.
19543 \begin_inset Flex Code
19546 \begin_layout Plain Layout
19552 removes the bibliography title, you have to manually re-add that, too (as
19553 a chapter* or section*, for instance).
19556 \begin_layout Standard
19561 , the procedure is a bit different.
19570 , the aforementioned
19571 \begin_inset Flex Noun
19574 \begin_layout Plain Layout
19575 Subdivided bibliography
19580 option is disabled if you use
19589 provides its own means to generate subdivided bibliographies.
19590 You can either add keywords to bibliography entries via the
19591 \begin_inset Flex Code
19594 \begin_layout Plain Layout
19600 entry option and then filter bibliography sections by keyword (by adding
19602 \begin_inset Flex Code
19605 \begin_layout Plain Layout
19612 \begin_inset Flex Noun
19615 \begin_layout Plain Layout
19621 field of the dialog that opens if you left-click on the
19622 \begin_inset Flex Noun
19625 \begin_layout Plain Layout
19626 Biblatex Generated Bibliography
19631 button), or you can filter by entry types (such as
19640 \begin_inset space \thinspace{}
19645 \begin_inset Flex Code
19648 \begin_layout Plain Layout
19655 \begin_inset Flex Code
19658 \begin_layout Plain Layout
19665 \begin_inset Flex Noun
19668 \begin_layout Plain Layout
19674 field, or you can create so-called
19675 \begin_inset Quotes eld
19678 Bibliography Categories
19679 \begin_inset Quotes erd
19682 to which you can assign individual entries.
19683 Please refer to the Biblatex manual, section
19685 Subdivided Bibliographies
19690 \begin_layout Section
19691 Multiple Bibliographies
19692 \begin_inset CommandInset label
19694 name "subsec:Multiple-Bibliographies"
19701 \begin_layout Standard
19702 Multiple bibliographies, e.
19703 \begin_inset space \thinspace{}
19707 \begin_inset space \space{}
19710 a bibliography for each part, chapter, section, subsection or child (sub-documen
19711 t) of the document, are also supported by \SpecialChar LyX
19713 In order to enable it, go to
19714 \begin_inset Flex Noun
19717 \begin_layout Plain Layout
19718 Document\SpecialChar menuseparator
19719 Settings\SpecialChar menuseparator
19725 and select the relevant unit (e.
19726 \begin_inset space \thinspace{}
19730 \begin_inset Quotes eld
19734 \begin_inset Quotes erd
19738 \begin_inset Flex Noun
19741 \begin_layout Plain Layout
19742 Multiple Bibliographies
19748 Then add a Bib(la)\SpecialChar TeX
19749 bibliography to each unit (e.
19750 \begin_inset space \thinspace{}
19753 g., section) of your document.
19754 In the output, a separate bibliography, containing only the references
19755 done in the current unit is generated.
19758 \begin_layout Standard
19759 If you use Bib\SpecialChar TeX
19761 \begin_inset Flex Code
19764 \begin_layout Plain Layout
19771 \begin_inset Flex Code
19774 \begin_layout Plain Layout
19780 package is used to create multiple bibliographies.
19781 The former package is used if you select
19782 \begin_inset Quotes eld
19786 \begin_inset Quotes erd
19794 \begin_inset Flex Noun
19797 \begin_layout Plain Layout
19798 Sectioned Bibliography
19804 In all other cases,
19805 \begin_inset Flex Code
19808 \begin_layout Plain Layout
19818 \begin_layout Plain Layout
19819 An alternative approach, if you are willing to use some
19820 \begin_inset Flex Noun
19823 \begin_layout Plain Layout
19831 \begin_inset space ~
19835 \begin_inset CommandInset ref
19837 reference "sec:Inserting-TeX-Code"
19842 \begin_inset Flex Code
19845 \begin_layout Plain Layout
19857 \begin_inset Flex Code
19860 \begin_layout Plain Layout
19866 is used, \SpecialChar LyX
19867 encloses the specified units in
19868 \begin_inset Flex Code
19871 \begin_layout Plain Layout
19878 \begin_inset Flex Code
19881 \begin_layout Plain Layout
19890 \begin_inset Flex Code
19893 \begin_layout Plain Layout
19901 in order to create the units.
19902 Note that this approach has some limitations.
19903 First, every citation reference has to be inside some
19904 \begin_inset Flex Code
19907 \begin_layout Plain Layout
19914 So citations outside a defined unit (e.
19915 \begin_inset space \thinspace{}
19918 g., before the first section if you use
19919 \begin_inset Quotes eld
19923 \begin_inset Quotes erd
19927 \begin_inset Quotes eld
19931 \begin_inset Quotes erd
19935 You can also create your own units by entering
19936 \begin_inset Flex Code
19939 \begin_layout Plain Layout
19948 \begin_inset Flex Code
19951 \begin_layout Plain Layout
19959 as \SpecialChar TeX
19960 code (for instance to work around the mentioned limitation).
19962 \begin_inset Flex Code
19965 \begin_layout Plain Layout
19971 s cannot be nested.
19972 A second limitation is that
19973 \begin_inset Flex Code
19976 \begin_layout Plain Layout
19982 always processes all references of a bibliography database, even if they
19984 This can result in odd labels (e.
19985 \begin_inset space \thinspace{}
19990 \begin_inset Quotes eld
19994 \begin_inset Quotes erd
19997 if two works of this author from 2014 are in the database, even if only
20001 \begin_layout Standard
20007 \begin_inset Flex Code
20010 \begin_layout Plain Layout
20016 option is used instead.
20017 If you need specific units, you can start them with the \SpecialChar TeX
20019 \begin_inset Flex Code
20022 \begin_layout Plain Layout
20031 \begin_inset Flex Code
20034 \begin_layout Plain Layout
20043 If you also want to control the end of the unit, use the environment
20044 \begin_inset Flex Code
20047 \begin_layout Plain Layout
20057 \begin_inset Flex Code
20060 \begin_layout Plain Layout
20070 \begin_inset Flex Code
20073 \begin_layout Plain Layout
20079 s cannot be nested.
20080 In addition to the individual bibliography of the current unit,
20084 also provides an easy way to output all bibliographies, subsequently, at
20086 \begin_inset space \thinspace{}
20089 g., at the end of the document).
20091 \begin_inset Quotes eld
20094 all reference units
20095 \begin_inset Quotes erd
20098 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
20100 Please refer to the
20104 manual for more information on this topic.
20107 \begin_layout Chapter
20109 \change_deleted 564990737 1671355654
20113 \change_inserted 564990737 1671355667
20115 \change_deleted 564990737 1671355661
20117 \change_inserted 564990737 1671355684
20119 \begin_inset CommandInset label
20121 name "chap:bullets"
20126 \change_deleted 564990737 1671355684
20128 \begin_inset CommandInset label
20139 \begin_layout Standard
20145 \begin_layout Section
20149 \begin_layout Standard
20151 provides 216 bullet shapes that can be accessed from a simple dialog.
20152 Using this dialog you can easily specify what bullet shape to use at each
20153 level of an itemized list.
20154 These settings are document-wide so you won't be able to specify different
20155 sets of bullets for different paragraphs.
20159 \begin_layout Plain Layout
20160 Well, actually you can but you'll have to do it by hand.
20168 \begin_layout Section
20172 \begin_layout Standard
20173 Open the dialog by selecting the
20174 \begin_inset Flex Noun
20177 \begin_layout Plain Layout
20178 Document\SpecialChar menuseparator
20184 menu item and then select the
20185 \begin_inset Flex Noun
20188 \begin_layout Plain Layout
20197 \begin_layout Standard
20198 The dialog provides you with a table of bullet shapes.
20199 A column of buttons on the left of the table provides access to the six
20200 different panels of bullet shapes.
20201 The row of buttons across the top is used to select which bullet depth
20204 \change_deleted 244031559 1603875981
20205 A text entry under the table shows the currently selected bullet shape's
20207 equivalent and this can be edited if desired.
20208 If you do modify the text you will also need to specify any needed packages
20209 in the \SpecialChar LaTeX
20215 \begin_layout Standard
20216 The six panels are divided up by the packages they require.
20217 The following table shows the mappings from button name to \SpecialChar LaTeX
20221 \begin_layout Standard
20223 \begin_inset Tabular
20224 <lyxtabular version="3" rows="7" columns="2">
20225 <features tabularvalignment="middle">
20226 <column alignment="center" valignment="top" width="0pt">
20227 <column alignment="center" valignment="top" width="0pt">
20229 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
20232 \begin_layout Plain Layout
20247 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
20250 \begin_layout Plain Layout
20267 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20270 \begin_layout Plain Layout
20285 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20288 \begin_layout Plain Layout
20297 base \SpecialChar LaTeX
20305 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20308 \begin_layout Plain Layout
20323 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20326 \begin_layout Plain Layout
20343 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20346 \begin_layout Plain Layout
20361 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20364 \begin_layout Plain Layout
20381 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20384 \begin_layout Plain Layout
20399 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20402 \begin_layout Plain Layout
20419 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20422 \begin_layout Plain Layout
20437 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20440 \begin_layout Plain Layout
20457 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
20460 \begin_layout Plain Layout
20475 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
20478 \begin_layout Plain Layout
20501 \begin_layout Standard
20503 doesn't stop you using bullets from packages you don't have.
20504 If you get errors from \SpecialChar LaTeX
20505 when you try to view or print the file, then it
20506 is likely you are missing a package.
20510 \begin_layout Plain Layout
20512 doesn't restrict your use since you may be editing locally and exporting
20521 \begin_layout Section
20525 \begin_layout Standard
20526 Select which bullet depth you want to change then select the bullet shape
20528 Any changes will not be visible in \SpecialChar LyX
20529 , but are visible when viewing the document.
20532 \begin_layout Standard
20533 You can reset a bullet shape to the default simply by clicking your right
20534 mouse button on the appropriate bullet depth button.
20538 \begin_layout Plain Layout
20540 \change_inserted 564990737 1672138075
20541 \begin_inset CommandInset label
20543 name "fn:If-you-really"
20553 want to have multiple sets of paragraphs with different sets of bullets
20554 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
20556 The bullet selection dialog can help though because it provides you with
20557 the \SpecialChar LaTeX
20558 code for a wide range of bullet shapes.
20559 To make your own custom paragraphs you have the following options:
20562 \begin_layout Plain Layout
20566 \begin_layout Plain Layout
20582 \begin_layout Plain Layout
20586 \begin_layout Plain Layout
20608 \begin_layout Itemize
20609 Use the \SpecialChar LaTeX
20611 \begin_inset Flex Code
20614 \begin_layout Plain Layout
20622 to specify a new bullet shape for a given depth.
20623 You'll also need to save the current bullet shape so you can restore it
20625 In this itemized list the following \SpecialChar LaTeX
20626 code was used to change the bullet
20627 used for the first depth.
20631 \begin_layout LyX-Code
20641 \begin_layout LyX-Code
20658 \begin_layout Itemize
20659 Note that the itemize depth is specified in Roman numerals as part of the
20669 \begin_layout Itemize
20670 \begin_inset Argument item:1
20673 \begin_layout Plain Layout
20677 \begin_layout Plain Layout
20695 Specify each individual entry by starting each item with the bullet shape
20697 \begin_inset Quotes eld
20701 \begin_inset Quotes erd
20704 inset (available at
20706 Insert\SpecialChar menuseparator
20710 \begin_inset Flex Noun
20713 \begin_layout Plain Layout
20721 For example, this item was started with
20722 \begin_inset Flex Code
20725 \begin_layout Plain Layout
20740 \begin_layout Plain Layout
20744 \begin_layout Plain Layout
20760 \begin_layout Plain Layout
20761 You'll also need to revert the labelitem back to its previous setting for
20762 the global bullet shape settings to remain in effect.
20763 The way used here was:
20766 \begin_layout LyX-Code
20781 \begin_layout Chapter
20785 \begin_layout Section
20786 Multipart Documents
20789 \begin_layout Subsection
20793 \begin_layout Standard
20794 When you are working on a large file with many sections, it is often convenient
20795 to break up the document into several files, or perhaps you have something
20796 where a table may change from time to time, but the preceding text does
20798 In these cases, you should seriously consider using multipart documents.
20799 For example, scientific papers often have five major sections: the introduction
20800 , observations, results, discussion, and conclusion.
20801 Each of these could be its own separate \SpecialChar LyX
20803 \begin_inset Quotes eld
20807 \begin_inset Quotes erd
20810 file which contains the title, authors, abstract, references, etc., plus
20811 the five included files.
20812 It is important to note that each of these files is a full \SpecialChar LyX
20814 can be formatted and printed on its own, as well as included in a master
20816 Each of these files must have the same document class, however—don't attempt
20817 to mix book classes with article classes.
20818 You may also include \SpecialChar LaTeX
20819 files; however, these files must not have their own
20821 \begin_inset space \thinspace{}
20825 \begin_inset space \space{}
20828 everything up to and including the
20829 \begin_inset Flex Code
20832 \begin_layout Plain Layout
20840 line as well as the
20841 \begin_inset Flex Code
20844 \begin_layout Plain Layout
20852 line must be deleted) or else errors will be generated when you try to
20856 \begin_layout Standard
20858 allows you to include files quite easily with
20859 \begin_inset Flex Noun
20862 \begin_layout Plain Layout
20863 Insert\SpecialChar menuseparator
20865 \begin_inset space ~
20874 When you click on this selection a small box is inserted into the file
20875 at the current cursor location.
20876 Clicking on the box raises a dialog which allows you to select the file
20877 to be included, and the method of its inclusion.
20881 \begin_layout Standard
20882 The file selection box should by now be obvious.
20883 The three inclusion methods are
20884 \begin_inset Quotes eld
20888 \begin_inset Quotes erd
20892 \begin_inset Quotes eld
20896 \begin_inset Quotes erd
20900 \begin_inset Quotes eld
20904 \begin_inset Quotes erd
20909 \begin_inset Quotes eld
20913 \begin_inset Quotes erd
20917 \begin_inset Quotes eld
20921 \begin_inset Quotes erd
20924 are similar in many ways, but there are also some notable differences:
20927 \begin_layout Enumerate
20929 \begin_inset Quotes eld
20933 \begin_inset Quotes erd
20936 are typeset beginning on a new page, while files that are
20937 \begin_inset Quotes eld
20941 \begin_inset Quotes erd
20944 are typeset starting on the current page.
20947 \begin_layout Enumerate
20948 \begin_inset Quotes eld
20952 \begin_inset Quotes erd
20955 files cannot themselves
20956 \begin_inset Quotes eld
20960 \begin_inset Quotes erd
20964 \begin_inset Quotes eld
20968 \begin_inset Quotes erd
20973 \begin_inset Quotes eld
20977 \begin_inset Quotes erd
20980 , on the other hand, infinite sub-inputting is possible.
20983 \begin_layout Enumerate
20984 \begin_inset Quotes eld
20988 \begin_inset Quotes erd
20991 allow for the output of only selected
20992 \begin_inset Quotes eld
20996 \begin_inset Quotes erd
20999 files, while maintaining the actual counters (pagination etc.) and references
21000 (please refer to the section
21003 \begin_inset space ~
21011 \begin_inset space ~
21016 manual for details).
21019 \begin_layout Standard
21021 \begin_inset Quotes eld
21025 \begin_inset Quotes erd
21028 is the preferred method for chapters that are outsourced to child documents,
21030 \begin_inset Quotes eld
21034 \begin_inset Quotes erd
21037 is more suitable for arbitrary file inheritance.
21040 \begin_layout Standard
21042 \begin_inset Quotes eld
21046 \begin_inset Quotes erd
21049 included file allows you to include a file typeset exactly as it appears
21051 \begin_inset space \thinspace{}
21055 \begin_inset space \space{}
21059 \begin_inset Flex Code
21062 \begin_layout Plain Layout
21068 mode, with the characters set in a fixed-width typewriter font.
21069 Normally, spaces in this file are invisible, though two consecutive spaces
21070 are conserved, unlike \SpecialChar LyX
21071 's normal treatment of spaces.
21072 However, setting the
21073 \begin_inset Flex Noun
21076 \begin_layout Plain Layout
21078 \begin_inset space ~
21082 \begin_inset space ~
21086 \begin_inset space ~
21094 checkbox typesets a mark to unambiguously define the presence of a space.
21098 \begin_layout Standard
21099 Generally, the master file is converted into a full \SpecialChar LaTeX
21100 file before typesetting,
21101 while the included files are converted to \SpecialChar LaTeX
21102 files that do not have all the
21103 preamble information.
21106 \begin_layout Subsection
21107 Cross-References Between Files
21110 \begin_layout Standard
21111 \begin_inset Box Shadowbox
21121 height_special "totalheight"
21126 backgroundcolor "none"
21129 \begin_layout Plain Layout
21130 This section is somewhat out of date.
21131 Need to describe default master documents and how children are opened when
21141 \begin_layout Standard
21142 It is possible to set up cross-references between the different files.
21143 First, open all the files in question: let's call them A and B in a two
21144 file example, where B is included in A.
21145 Let's say you insert a label in A, then want to reference it in B.
21146 Open the cross-reference dialog whilst in document B, and you can select
21148 \begin_inset Quotes eld
21152 \begin_inset Quotes erd
21158 \begin_layout Subsection
21159 Bibliography Lists in all Subdocuments
21162 \begin_layout Standard
21163 If you work with child documents, you might want to have only one main bibliogra
21164 phy at the end, but still be able to have a selected bibliography for the
21165 child if you output it on its own.
21166 Here is how to achieve this.
21169 \begin_layout Standard
21170 For the main document, you just insert a bibliography inset at the place
21171 where the main bibliography has to appear (within the master file or within
21173 If the bibliography inset is in the master file, the references will be
21174 inherited by all children, so they are available in the citation dialog
21178 \begin_layout Standard
21179 For child-specific bibliographies, insert bibliography insets within the
21180 child documents, at the place where the bibliography should appear when
21181 the child is compiled separately.
21182 However, the trick is to insert them into a branch (
21184 Insert\SpecialChar menuseparator
21185 Branch\SpecialChar menuseparator
21186 Insert New Branch...
21189 \begin_inset space \thinspace{}
21194 \begin_inset Quotes eld
21198 \begin_inset Quotes erd
21202 Within the children, activate the branch (
21204 Document\SpecialChar menuseparator
21205 Settings...\SpecialChar menuseparator
21209 Within the master, deactivate the branch (
21211 Document\SpecialChar menuseparator
21212 Settings...\SpecialChar menuseparator
21216 Now the child's bibliography will be ignored by the master, but considered
21220 \begin_layout Standard
21221 If you need multiple bibliographies (e.
21222 \begin_inset space \thinspace{}
21225 g., one per child in the
21229 ), please refer to sec.
21230 \begin_inset space ~
21234 \begin_inset CommandInset ref
21236 reference "subsec:Multiple-Bibliographies"
21243 \begin_layout Section
21248 \begin_layout Standard
21249 Users sometimes need to be able to
21250 \begin_inset Quotes eld
21254 \begin_inset Quotes erd
21258 file together with all the images (and other files) on which it depends,
21259 either for sending to a publisher or for sharing with a co-author.
21261 includes a Python script (
21262 \begin_inset Flex Code
21265 \begin_layout Plain Layout
21271 ) that automates this process.
21272 To use it, you must have either the
21273 \begin_inset Flex Code
21276 \begin_layout Plain Layout
21283 \begin_inset Flex Code
21286 \begin_layout Plain Layout
21292 python modules installed on your system.
21293 By default, the script prefers the
21294 \begin_inset Flex Code
21297 \begin_layout Plain Layout
21304 \begin_inset Flex Code
21307 \begin_layout Plain Layout
21313 format on Unix-like systems and the
21314 \begin_inset Flex Code
21317 \begin_layout Plain Layout
21326 \begin_layout Standard
21328 's configuration process will set the script up to export a `\SpecialChar LyX
21330 and this format will then be available under
21331 \begin_inset Flex Code
21334 \begin_layout Plain Layout
21335 File\SpecialChar menuseparator
21344 \begin_layout Standard
21345 Independently of the platform, the generation of a particular archive format
21346 can be forced by adding either the
21347 \begin_inset Flex Code
21350 \begin_layout Plain Layout
21357 \begin_inset Flex Code
21360 \begin_layout Plain Layout
21367 \begin_inset Flex Code
21370 \begin_layout Plain Layout
21377 \begin_inset Flex Code
21380 \begin_layout Plain Layout
21386 format) switch to the
21387 \begin_inset Flex Code
21390 \begin_layout Plain Layout
21392 \SpecialChar menuseparator
21400 \begin_inset Flex Code
21403 \begin_layout Plain Layout
21404 Tools\SpecialChar menuseparator
21405 Preferences\SpecialChar menuseparator
21406 File Handling\SpecialChar menuseparator
21413 (Make sure you add the switch after the script name, not before it.)
21416 \begin_layout Section
21417 Fancy Headers and Footers
21420 \begin_layout Standard
21421 The default page layout is rather plain; for an
21422 \begin_inset Flex Code
21425 \begin_layout Plain Layout
21431 document class, all you get is a centered page number at the bottom of
21433 This document uses KOMA-script's book class, so it appears to be a bit
21435 But to really put on a show, you need to set the document page style to
21437 \begin_inset Quotes eld
21441 \begin_inset Quotes erd
21444 , as mentioned in the
21449 This section describes the \SpecialChar LaTeX
21450 code you need to insert in your \SpecialChar LaTeX
21452 order to get the desired effects.
21455 \begin_layout Standard
21456 For more information on fancy headers, see the
21457 \begin_inset Flex Code
21460 \begin_layout Plain Layout
21466 package documentation.
21468 \begin_inset Flex URL
21471 \begin_layout Plain Layout
21473 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
21481 \begin_layout Standard
21482 The page header is divided into three fields, not surprisingly labeled
21483 \begin_inset Quotes eld
21487 \begin_inset Quotes erd
21491 \begin_inset Quotes eld
21495 \begin_inset Quotes erd
21499 \begin_inset Quotes eld
21503 \begin_inset Quotes erd
21507 The footer is also divided into these three fields.
21508 The \SpecialChar LaTeX
21509 commands to set these fields in the simplest manner are
21510 \begin_inset Flex Code
21513 \begin_layout Plain Layout
21522 \begin_inset Flex Code
21525 \begin_layout Plain Layout
21534 \begin_inset Flex Code
21537 \begin_layout Plain Layout
21546 \begin_inset Flex Code
21549 \begin_layout Plain Layout
21558 Suppose you wish to put your name in the upper left hand corner of each
21560 Simply insert the following command in the preamble:
21563 \begin_layout Standard
21572 \begin_layout Standard
21573 You will now see your name in the upper left.
21574 If a field has a default entry that you would like to get rid of (often
21575 the page number appears in the central footer) simply include a command
21576 with a blank argument, e.
21577 \begin_inset space \thinspace{}
21583 \begin_layout Standard
21591 \begin_layout Standard
21592 Let's get really fancy: lets put the section number with the word
21593 \begin_inset Quotes eld
21597 \begin_inset Quotes erd
21601 \begin_inset space \thinspace{}
21605 \begin_inset space \space{}
21608 Section 3) in the upper left, the page number (e.
21609 \begin_inset space \thinspace{}
21613 \begin_inset space \space{}
21616 Page 4) in the upper right, your name in the lower left, and the date in
21618 The following commands should now appear in the preamble:
21621 \begin_layout Standard
21631 \begin_layout Standard
21639 \begin_layout Standard
21649 \begin_layout Standard
21658 \begin_layout Standard
21666 \begin_layout Standard
21676 \begin_layout Standard
21678 \begin_inset Flex Code
21681 \begin_layout Plain Layout
21690 \begin_inset Flex Code
21693 \begin_layout Plain Layout
21701 access \SpecialChar LaTeX
21702 's section and page counters, and so print out the current section
21705 \begin_inset Flex Code
21708 \begin_layout Plain Layout
21716 simply prints out today's date.
21719 \begin_layout Standard
21720 The thicknesses of the horizontal rules drawn beneath the header and above
21721 the footer can also be modified.
21722 If you don't want one of the rules, set its thickness to 0.
21723 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
21729 \begin_inset Flex Code
21732 \begin_layout Plain Layout
21737 headrulewidth}{0.4pt}
21743 \begin_inset Flex Code
21746 \begin_layout Plain Layout
21751 footrulewidth}{0.4pt}
21756 to set the thicknesses.
21759 \begin_layout Standard
21760 You can switch the header/footer settings on and off for individual pages
21761 using commands like
21762 \begin_inset Flex Code
21765 \begin_layout Plain Layout
21768 thispagestyle{empty}
21774 \begin_inset Flex Code
21777 \begin_layout Plain Layout
21780 thispagestyle{plain}
21786 \begin_inset Flex Code
21789 \begin_layout Plain Layout
21792 thispagestyle{fancy}
21798 Simply insert them in the text on the page you want changed and mark them
21799 as \SpecialChar TeX
21801 In fact, title pages are marked as plain by default, while following pages
21802 are marked fancy when using the global fancy setting.
21805 \begin_layout Standard
21806 As a final example, it is possible to include an image in the header or
21808 Suppose you want to put a company logo in the upper lefthand corner.
21809 You might try something like
21812 \begin_layout Standard
21821 includegraphics{logo.eps}}}
21824 \begin_layout Standard
21826 (you may need to preface this with
21827 \begin_inset Flex Code
21830 \begin_layout Plain Layout
21833 usepackage{graphics}
21838 if you don't include graphics elsewhere in your document).
21841 \begin_layout Chapter
21843 and the World Wide Web
21846 \begin_layout Standard
21848 has long supported the export of documents to various web-friendly formats,
21850 Before version 2.0, however, HTML export was always accomplished by the
21851 use of external converters.
21855 \begin_layout Plain Layout
21856 For details on the use of external converters with \SpecialChar LyX
21861 section of the Customization manual.
21866 These fall into two large groups: there are converters that use \SpecialChar LaTeX
21868 intermediate format, such as
21869 \begin_inset Flex Code
21872 \begin_layout Plain Layout
21879 \begin_inset Flex Code
21882 \begin_layout Plain Layout
21889 \begin_inset Flex Code
21892 \begin_layout Plain Layout
21898 , relying upon \SpecialChar LyX
21899 to produce the \SpecialChar LaTeX
21900 ; and there is a converter that works directly
21901 on \SpecialChar LyX
21903 \begin_inset Flex Code
21906 \begin_layout Plain Layout
21914 All of these have different advantages and disadvantages.
21918 \begin_layout Standard
21919 The \SpecialChar LaTeX
21920 -based converters have the advantage that, in principle, they know everythin
21921 g about the exported document that \SpecialChar LaTeX
21923 Such converters do not care, for example, if a certain block of code was
21924 produced by \SpecialChar LyX
21925 or was Evil Red Text.
21926 These converters know about
21927 \begin_inset Flex Code
21930 \begin_layout Plain Layout
21936 files, counters, and references, and can often make use of the
21937 \begin_inset Flex Code
21940 \begin_layout Plain Layout
21946 files generated by Bib\SpecialChar TeX
21948 On the other hand, \SpecialChar LaTeX
21949 is a very hard language to parse—it is sometimes said
21950 that only \SpecialChar TeX
21951 itself understands \SpecialChar TeX
21952 —and \SpecialChar LaTeX
21953 -based converters will often choke on
21954 what seem to be quite simple constructs; complex ones can throw them completely
21955 , and as of this writing, for example, the
21959 manual will not export with
21960 \begin_inset Flex Code
21963 \begin_layout Plain Layout
21969 , though the others will.
21970 The other issue concerns how math is handled.
21971 These converters typically convert the formulae into little pictures that
21972 are then linked from the HTML document.
21973 Since these are actually generated by \SpecialChar LaTeX
21974 , they are accurate.
21975 But they do not scale well, and just getting them to look as if they are
21976 actually meant to be in your document—so that the font sizes seem to be
21977 roughly the same—can be a challenge.
21980 \begin_layout Standard
21982 \begin_inset Flex Code
21985 \begin_layout Plain Layout
21993 \begin_inset CommandInset href
21995 name "http://pinchito.es/elyxer/"
21996 target "http://pinchito.es/elyxer/"
22001 ) solves some of these problems.
22002 In particular, the formulae it produces scale perfectly, since it renders
22003 math using a combination of HTML and CSS rather than converting the formulae
22005 But even moderately complex formula are rendered less well than with
22006 \begin_inset Flex Code
22009 \begin_layout Plain Layout
22015 ; this reflects the limitations of HTML.
22019 \begin_layout Plain Layout
22021 \begin_inset Flex Code
22024 \begin_layout Plain Layout
22031 can also use jsMath and MathJax for equations, but this setting is only
22032 available globally and requires one to have access to a server that runs
22038 More importantly (as of version 1.1.1, at least),
22039 \begin_inset Flex Code
22042 \begin_layout Plain Layout
22049 has limited support for math macros and no support for user-defined paragraph
22050 or character styles.
22051 These limitations make
22052 \begin_inset Flex Code
22055 \begin_layout Plain Layout
22062 unsuitable for many of the documents \SpecialChar LyX
22064 In principle, of course, these problems could be solved, but the \SpecialChar LyX
22066 have decided to follow a different path and have made \SpecialChar LyX
22068 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
22069 , DocBook, and plaintext.
22072 \begin_layout Standard
22073 As of this writing, XHTML output remains under development and should probably
22075 \begin_inset Quotes eld
22079 \begin_inset Quotes erd
22086 \begin_layout Plain Layout
22088 \begin_inset Flex Code
22091 \begin_layout Plain Layout
22092 development/HTML/HTML.notes
22097 , which can be found in the \SpecialChar LyX
22099 \begin_inset CommandInset href
22101 name "accessed online"
22102 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
22107 , usually contains up-to-date information about the state of XHTML output.
22108 See also the list of XHTML bugs on
22109 \begin_inset CommandInset href
22111 name "the bug tracker"
22112 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"
22122 Still, the developers have chosen this approach because it has several
22123 potential advantages over the other two.
22126 \begin_layout Standard
22127 These advantages are primarily due to the fact that the XHTML output routines,
22128 since they are part of \SpecialChar LyX
22129 , know everything \SpecialChar LyX
22130 knows about the document being
22135 \begin_layout Plain Layout
22136 Another advantage is that, since these routines are internal to \SpecialChar LyX
22138 immune to changes in \SpecialChar LyX
22139 's file format, or to changes in the semantics of
22145 So they know about the table of contents (as displayed in the outline),
22146 about the counters associated with different paragraph styles, and about
22147 user-defined styles.
22148 The XHTML output routines know what \SpecialChar LyX
22149 knows about internationalization,
22150 too, so they will output
22151 \begin_inset Quotes eld
22155 \begin_inset Quotes erd
22159 \begin_inset Quotes eld
22167 \begin_inset Quotes erd
22170 , depending upon the language in effect at the time.
22174 \begin_layout Standard
22175 Quite generally, the output routines know what \SpecialChar LyX
22176 knows about document layout,
22177 that is, about how the document is to be rendered on screen.
22178 We use this information when we output the document as XHTML.
22179 In particular, \SpecialChar LyX
22184 generates CSS style information corresponding to the layout information
22185 it uses to render the document on screen: if section headings are supposed
22186 to be sans-serif and bold as seen in \SpecialChar LyX
22187 , then (by default) they will be sans-seri
22188 f and bold when viewed in a web browser, too.
22189 And this is true not just for pre-defined styles, like Section, but for
22190 any style, including user-defined styles.
22191 Indeed, the XHTML output routines make no distinction between user-defined
22193 \change_deleted 244031559 1603876931
22195 \change_inserted 244031559 1603876940
22198 styles and \SpecialChar LyX
22199 's own pre-defined styles: in each case, everything \SpecialChar LyX
22201 the styles is contained in the layout files.
22202 And much the same is true as regards pre-defined textual insets, such as
22203 footnotes, and various custom insets.
22207 \begin_layout Standard
22208 The result is that XHTML output can be customized and extended in exactly
22209 the same way \SpecialChar LaTeX
22210 output can be customized and extended: through layout files
22212 See chapter five of the
22216 manual for the details.
22219 \begin_layout Standard
22220 The remainder of this chapter contains more detailed information on XHTML
22221 output, its limitations, and ways to work around those limitations.
22224 \begin_layout Section
22225 Math Output in XHTML
22228 \begin_layout Standard
22230 offers four choices for how math is rendered.
22231 These have various advantages and disadvantages:
22234 \begin_layout Itemize
22236 \begin_inset Newline newline
22239 MathML is a dialect of XML designed specifically for mathematics on the
22240 web, and it typically renders very well in browsers that support it.
22241 The disadvantage is that not all browsers support MathML, and support is
22242 not complete even in the Gecko-based browsers, such as Firefox.
22243 \begin_inset Newline newline
22246 If \SpecialChar LyX
22247 is unable to render a formula as MathML—for example, if the formula
22249 \begin_inset Flex Code
22252 \begin_layout Plain Layout
22258 package or ERT—then it will instead output the formula as an image.
22262 \begin_layout Itemize
22264 \begin_inset Newline newline
22267 As mentioned above,
22268 \begin_inset Flex Code
22271 \begin_layout Plain Layout
22277 outputs math as HTML, styled by CSS.
22281 \begin_layout Plain Layout
22283 has borrowed some of the CSS for its HTML output from
22284 \begin_inset Flex Code
22287 \begin_layout Plain Layout
22298 For simple formulae, this can work quite well, though with more complicated
22299 formulae it tends to break down.
22300 Still, this method has the advantage that it is very widely supported and
22301 so it may be appropriate for documents that contain only a little, fairly
22303 \begin_inset Newline newline
22306 If Lyx is unable to render a formula as HTML—for example, if the formula
22308 \begin_inset Flex Code
22311 \begin_layout Plain Layout
22317 package or ERT—then it will instead output the formula as an image.
22321 \begin_layout Itemize
22323 \begin_inset Newline newline
22327 \begin_inset Flex Code
22330 \begin_layout Plain Layout
22337 will output formulae as images, the very same images, in fact, that are
22338 used for instant preview.
22342 \begin_layout Plain Layout
22343 Instant preview does
22347 have to be on for images to be output, however.
22352 The advantage to this method is that the images are simply generated by
22354 , so they are very accurate.
22355 The disadvantage, as mentioned earlier, is that these are bitmapped images,
22356 so they do not scale terribly well, and one cannot copy them, etc.
22357 \begin_inset Newline newline
22360 The size of the images can be controlled by setting the
22361 \begin_inset Quotes eld
22364 Math Images Scaling
22365 \begin_inset Quotes erd
22369 \begin_inset Flex Noun
22372 \begin_layout Plain Layout
22373 Document\SpecialChar menuseparator
22374 Settings\SpecialChar menuseparator
22384 \begin_layout Plain Layout
22385 For those who want to know, this controls the resolution of the image in
22386 dots per inch and is based upon a default of 75 dpi.
22392 \begin_inset Newline newline
22395 If \SpecialChar LyX
22396 for some reason fails to create an image for a formula (e.g., if a required
22398 package is not installed), then it will fall back to outputing the raw
22403 \begin_layout Itemize
22406 \begin_inset Newline newline
22409 Finally, \SpecialChar LyX
22410 will happily output math as \SpecialChar LaTeX
22412 As well as being the output of last resort, this method can be used with
22414 \begin_inset CommandInset href
22417 target "http://www.math.union.edu/~dpvc/jsMath/"
22422 , which uses JavaScript to render \SpecialChar LaTeX
22423 embedded in HTML documents.
22425 wraps the \SpecialChar LaTeX
22427 \begin_inset Flex Code
22430 \begin_layout Plain Layout
22436 (for inline formulas) or
22437 \begin_inset Flex Code
22440 \begin_layout Plain Layout
22446 (for displayed formulas) with
22447 \begin_inset Flex Code
22450 \begin_layout Plain Layout
22456 , as is required for jsMath.
22459 \begin_layout Standard
22460 One of these output methods must be selected under
22461 \begin_inset Flex Noun
22464 \begin_layout Plain Layout
22465 Document\SpecialChar menuseparator
22466 Settings\SpecialChar menuseparator
22473 By default, \SpecialChar LyX
22475 This is a document-wide setting, therefore.
22478 \begin_layout Standard
22479 Eventually, \SpecialChar LyX
22480 will offer the user the option to select an alternate output
22481 method for a particular inset, say, one that isn't being rendered very
22486 \begin_layout Plain Layout
22487 That said, since \SpecialChar LyX
22488 falls back to images if the inset contains ERT, then one
22489 can force output as an image by putting some harmless ERT into the math,
22491 \begin_inset Formula $a=b\relax$
22502 \begin_layout Section
22503 Bibliography and Citations
22506 \begin_layout Standard
22507 XHTML output fully supports bibliographies and citations.
22511 \begin_layout Standard
22512 Citation labels are generated by the same machinery that generates \SpecialChar LyX
22514 labels, so the labels will look in the output much as they do in \SpecialChar LyX
22517 If you are using numerical citations, then \SpecialChar LyX
22518 will output numerical labels,
22519 such as [1] or [17], rather than simply showing the citation key in square
22520 brackets, as it does on-screen.
22521 If you are using author-year citations, then \SpecialChar LyX
22522 will add lowercase letters
22523 to the years, just as Bib\SpecialChar TeX
22524 does, if it finds more than one citation for
22525 a given author-year combination.
22526 The labels will be printed with the bibliography entries.
22527 Note that there is, at present, no way to customize the appearance of the
22528 labels, for example, to choose between square brackets and parentheses.
22531 \begin_layout Standard
22532 Bibliography output is handled by the same machinery that handles the presentati
22533 on of reference information in the citation dialog, so you will see in the
22534 XHTML output pretty much what you would see if you were to look at a given
22535 entry in the citation dialog.
22536 The formatting can be customized in your layout file or, preferably, in
22542 manual for the details.
22545 \begin_layout Standard
22546 The main defect at present is that cross-referenced information is printed
22547 with every entry with which it is associated.
22548 So you can see things like this:
22551 \begin_layout Quote
22553 \begin_inset Quotes eld
22556 Context and Logical Form
22557 \begin_inset Quotes erd
22562 Language in Context: Selected Essays
22564 (Oxford: Oxford University Press, 2007), pp.
22568 \begin_layout Quote
22570 \begin_inset Quotes eld
22573 Semantics in Context
22574 \begin_inset Quotes erd
22579 Language in Context: Selected Essays
22581 (Oxford: Oxford University Press, 2007), pp.
22585 \begin_layout Standard
22586 This should be fixed before long.
22589 \begin_layout Standard
22590 There is no support at present for sectioned bibliographies.
22591 If you have multiple bibliographies, then \SpecialChar LyX
22592 will print the same bibliography
22596 \begin_layout Section
22600 \begin_layout Standard
22602 will happily export indexes as XHTML, but with certain limitations at the
22606 \begin_layout Standard
22607 Index export will be most reliable when you do not attempt to use the fancy
22608 constructs that are described in the section on indexes in the
22616 \begin_layout Plain Layout
22617 The main issue here is that \SpecialChar LyX
22618 itself does not really handle these.
22619 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
22625 We'll describe how they are handled using the subsection headings from
22629 \begin_layout Itemize
22630 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
22631 makes an effort to support these,
22632 but the entries must be separated by
22633 \begin_inset Quotes eld
22637 \begin_inset Quotes erd
22640 , that is, there must be spaces around the exclamation point.
22641 This is because it is otherwise too difficult to check for escaped exclamation
22642 points, ones in math, and so forth.
22645 \begin_layout Itemize
22646 Page Ranges: There is no support at all for page ranges, since these make
22647 no sense with XHMTL.
22648 Instead, you will just get two index entries, one at either end.
22651 \begin_layout Itemize
22652 Cross-referencing: There is no support for cross-referencing.
22653 If \SpecialChar LyX
22654 finds an entry containing the
22655 \begin_inset Quotes eld
22658 |see\SpecialChar ldots
22660 \begin_inset Quotes erd
22663 construct, it is just dropped, and the rest is treated as an ordinary index
22667 \begin_layout Itemize
22668 Index Entry Order: \SpecialChar LyX
22669 does support attempts to fix the sorting order.
22670 It will take what is before the first `@' it finds and use that for sorting,
22671 taking what follows the first `@' to be the actual entry.
22672 At present, \SpecialChar LyX
22673 does not check for escaped `@', so do not try to index email
22677 \begin_layout Itemize
22678 Index Entry Layout: You can format entries by using the text style dialog,
22679 or by using any other method available within \SpecialChar LyX
22681 There is no support for constructs like:
22682 \begin_inset Quotes eld
22686 \begin_inset Quotes erd
22690 Indeed, if \SpecialChar LyX
22691 finds a pipe symbol, `|', in an entry, it will delete it and
22692 everything that follows it.
22695 \begin_layout Itemize
22696 Multiple Indexes: There is no support for multiple indexes.
22697 Rather, all index entries will be printed as one large index.
22698 To avoid our printing several versions of the index, we print only the
22699 main index, so make sure you have one.
22702 \begin_layout Section
22703 Nomenclature and Glossary
22706 \begin_layout Standard
22707 There is at present no support for glossaries.
22708 Adding it would be fairly trivial, and welcome.
22711 \begin_layout Chapter
22713 \change_inserted 1075283030 1616534180
22717 \begin_layout Standard
22719 \change_inserted 1075283030 1616534386
22720 Apart from HTML, \SpecialChar LyX
22721 can generate documents in the DocBook XML vocabulary.
22722 With versions 2.3 and before, only select templates could be used to generate
22723 DocBook documents (only version 4).
22724 Starting with \SpecialChar LyX
22725 2.4, most \SpecialChar LyX
22726 layouts can generate valid DocBook documents (only
22728 This feature is built into \SpecialChar LyX
22729 and does not require the use of external tools.
22732 \begin_layout Standard
22734 \change_inserted 1075283030 1616534437
22735 The result is that the DocBook output can be customized and extended in
22736 exactly the same way \SpecialChar LaTeX
22737 output can be customized and extended: through layout
22739 See chapter five of the
22743 manual for the details.
22746 \begin_layout Standard
22748 \change_inserted 1075283030 1616534475
22749 Most \SpecialChar LyX
22750 features are supported with DocBook, like math output.
22753 \begin_layout Itemize
22755 \change_inserted 1075283030 1616534741
22756 Math output is performed mostly in MathML (the major exception being constructio
22757 ns not supported by \SpecialChar LyX
22760 All formulae are also available in raw \SpecialChar TeX
22761 in the DocBook output for further
22765 \begin_layout Itemize
22767 \change_inserted 1075283030 1616534852
22768 Bibliographies and citations are implemented, including with an external
22770 Bibliography entries are not prerendered when the detailed information
22771 are available, but rather output with the standard DocBook constructs.
22772 The external DocBook processor is expected to handle the rendering of entries.
22775 \begin_layout Itemize
22777 \change_inserted 1075283030 1616534863
22778 Indexes are supported, including multiple indices.
22783 ), page ranges, and cross-references (
22787 ) are supported, with the exception of the same symbols escaped.
22796 ) are not supported.
22797 There is no support for escaping of index entries.
22800 \begin_layout Itemize
22802 \change_inserted 1075283030 1616534884
22803 Glossaries are implemented.
22806 \begin_layout Standard
22808 \change_inserted 1075283030 1616534894
22809 Two major parameters can be set at the document level.
22812 \begin_layout Itemize
22814 \change_inserted 1075283030 1616534948
22815 Format for tables: \SpecialChar LyX
22816 can generate tables either as HTML (default value) or
22817 CALS, depending on the user's requirements.
22818 Most DocBook processors accept both formats.
22821 \begin_layout Itemize
22823 \change_inserted 1075283030 1616535006
22824 MathML prefix: in DocBook, MathML is included within its own name space,
22826 The implication is that there must be an indication of the tags belonging
22827 to the MathML standard.
22828 Three choices are offered:
22832 \begin_layout Itemize
22834 \change_inserted 1075283030 1616535044
22835 Inline: the MathML name space is defined for each formula (using the
22839 attribute on each formula)
22842 \begin_layout Itemize
22844 \change_inserted 1075283030 1616535090
22849 prefix (default): the MathML name space is defined at the document level
22854 attribute on the root element).
22855 Each MathML is prefixed with
22864 \begin_layout Itemize
22866 \change_inserted 1075283030 1616620405
22871 prefix: similar to the
22880 \begin_layout Standard
22882 \change_inserted 1075283030 1616620470
22883 This option is especially useful if you want \SpecialChar LyX
22884 to match your personal style
22885 or to work with buggy software that only accepts one prefix for MathML.
22891 \begin_layout Chapter
22892 The \SpecialChar LyX
22896 \begin_layout Section
22900 \begin_layout Standard
22901 The `\SpecialChar LyX
22902 server' allows other programs to talk to \SpecialChar LyX
22903 , invoke \SpecialChar LyX
22904 commands, and retrieve
22905 information about the \SpecialChar LyX
22907 This is only intended for advanced users, but they should find it useful.
22908 It is by writing to the \SpecialChar LyX
22909 server, for example, that bibliography managers,
22910 such as JabRef, are able to
22911 \begin_inset Quotes eld
22915 \begin_inset Quotes erd
22918 citations to \SpecialChar LyX
22922 \begin_layout Section
22923 Starting the \SpecialChar LyX
22925 \begin_inset CommandInset label
22927 name "sec:Starting-the-Server"
22934 \begin_layout Standard
22935 The \SpecialChar LyX
22936 server works through the use of a pair of named pipes.
22937 These are usually located in
22938 \begin_inset Flex Code
22941 \begin_layout Plain Layout
22947 , (except on Windows, where
22951 named pipes are special objects located in
22952 \begin_inset Flex Code
22955 \begin_layout Plain Layout
22967 ) and have the names
22968 \begin_inset Quotes eld
22972 \begin_inset Flex Code
22975 \begin_layout Plain Layout
22982 \begin_inset Quotes erd
22986 \begin_inset Quotes eld
22990 \begin_inset Flex Code
22993 \begin_layout Plain Layout
23000 \begin_inset Quotes erd
23004 External programs write into
23005 \begin_inset Flex Code
23008 \begin_layout Plain Layout
23014 and read back data from
23015 \begin_inset Flex Code
23018 \begin_layout Plain Layout
23025 The stem of the pipe names can be defined in the
23026 \begin_inset Flex Noun
23029 \begin_layout Plain Layout
23030 Tools\SpecialChar menuseparator
23036 dialog, for example
23037 \begin_inset Flex Code
23040 \begin_layout Plain Layout
23041 "/home/myhome/lyxpipe"
23047 \begin_inset Flex Code
23050 \begin_layout Plain Layout
23064 on Windows (where any working path instead of lyxpipe can be used, for
23066 \begin_inset Flex Code
23069 \begin_layout Plain Layout
23092 configure this manually in order for the server to start.
23095 \begin_layout Standard
23098 \begin_inset Flex Code
23101 \begin_layout Plain Layout
23108 \begin_inset Flex Code
23111 \begin_layout Plain Layout
23117 ' to create the pipes.
23118 If one of the pipes already exists, \SpecialChar LyX
23119 will assume that another \SpecialChar LyX
23121 is already running and will not start the server.
23122 On POSIX (Unix like) systems, if for some other reason, an unused
23123 \begin_inset Quotes eld
23127 \begin_inset Quotes erd
23130 pipe is left in existence when \SpecialChar LyX
23131 closes, then \SpecialChar LyX
23132 will try to delete it.
23133 If this fails for some reason, you will need to delete the pipes manually
23134 and then restart \SpecialChar LyX
23136 On Windows, pipes are deleted by the OS on program termination or crash,
23138 \begin_inset Quotes eld
23142 \begin_inset Quotes erd
23145 pipes should not be possible.
23148 \begin_layout Standard
23149 To have several \SpecialChar LyX
23150 processes with servers at the same time, you have to use
23151 different configurations, perhaps by using separate user directories, each
23153 \begin_inset Flex Code
23156 \begin_layout Plain Layout
23162 file, for each process.
23165 \begin_layout Standard
23166 If you are developing a client program, you might find it useful to enable
23167 debugging information from the \SpecialChar LyX
23169 Do this by starting \SpecialChar LyX
23171 \begin_inset Flex Code
23174 \begin_layout Plain Layout
23183 \begin_layout Standard
23184 You can find a complete example client written in C++ in the source distribution
23186 \begin_inset Flex Code
23189 \begin_layout Plain Layout
23190 development/lyxserver/server_monitor.cpp
23198 \begin_layout Standard
23199 Another useful tool is the command-line based client found in
23200 \begin_inset Flex Code
23203 \begin_layout Plain Layout
23204 src/client/lyxclient
23212 \begin_layout Section
23213 Normal communication
23216 \begin_layout Standard
23217 To issue a \SpecialChar LyX
23218 call, the client writes a line of ASCII text into the input
23220 This line has the following format:
23223 \begin_layout Quote
23237 \begin_layout Description
23238 clientname is a name that the client can choose arbitrarily.
23239 Its only use is that \SpecialChar LyX
23240 will echo it if it sends an answer—so a client can
23241 dispatch results from different requesters.
23244 \begin_layout Description
23245 function is the function you want \SpecialChar LyX
23247 It is the same as the commands you'd use in the minibuffer.
23250 \begin_layout Description
23251 argument is an optional argument which is meaningful only to some functions
23253 \begin_inset Quotes eld
23257 \begin_inset Quotes erd
23260 LFUN will insert the argument as text at the cursor position).
23263 \begin_layout Standard
23264 The answer from \SpecialChar LyX
23265 will arrive in the output pipe and be of the form
23268 \begin_layout Quote
23282 \begin_layout Standard
23291 are just echoed from the command request, while
23295 is more or less useful information filled according to how the command
23296 execution worked out.
23297 Some commands, such as
23298 \begin_inset Quotes eld
23302 \begin_inset Quotes erd
23305 , will return information about the internal state of \SpecialChar LyX
23307 return an empty data-response.
23308 This means that the command execution went fine.
23311 \begin_layout Standard
23312 In case of errors, the response from \SpecialChar LyX
23313 will have this form
23316 \begin_layout Quote
23330 \begin_layout Standard
23335 should contain an explanation of why the command failed.
23338 \begin_layout Standard
23342 \begin_layout LyX-Code
23343 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
23344 \begin_inset Newline newline
23347 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
23348 \begin_inset Newline newline
23351 read a <~/.lyxpipe.out
23352 \begin_inset Newline newline
23358 \begin_layout Subsection
23359 AppleScript (Mac OS X)
23362 \begin_layout Standard
23363 Since \SpecialChar LyX
23364 2.1, \SpecialChar LyX
23365 supports basic interactions with AppleScript for normal communicatio
23366 n through the command run.
23367 This command takes a direct argument (the
23371 to perform) and an optional argument.
23372 It either returns the output of the function or triggers an error with
23373 the error message and code.
23376 \begin_layout Standard
23380 \begin_layout LyX-Code
23381 tell application "\SpecialChar LyX
23385 \begin_layout LyX-Code
23389 \begin_layout LyX-Code
23390 -- Stores the current file name into f
23393 \begin_layout LyX-Code
23394 set f to (run "server-get-filename" with argument "")
23397 \begin_layout LyX-Code
23398 on error the error_message number the error_number
23401 \begin_layout LyX-Code
23402 display dialog "Error: " & the error_number & ".
23406 \begin_layout LyX-Code
23407 & the error_message buttons {"OK"} default button 1
23410 \begin_layout LyX-Code
23414 \begin_layout LyX-Code
23418 \begin_layout Section
23422 \begin_layout Standard
23424 can notify clients of events going on asynchronously.
23425 Currently it will only do this if the user binds a key sequence with the
23427 \begin_inset Quotes eld
23431 \begin_inset Quotes erd
23435 The format of the string \SpecialChar LyX
23436 sends is as follows:
23439 \begin_layout Quote
23440 \begin_inset Flex Code
23443 \begin_layout Plain Layout
23454 \begin_layout Standard
23459 is the printed representation of the key sequence that was actually typed
23463 \begin_layout Standard
23464 This mechanism can be used to extend \SpecialChar LyX
23465 's command set and implement macros.
23466 Bind some key sequence to
23467 \begin_inset Quotes eld
23471 \begin_inset Quotes erd
23475 Then start a client that listens on the output pipe, dispatches the command
23476 according to the sequence, and starts a function that may use \SpecialChar LyX
23479 requests to issue a command or a series of commands to \SpecialChar LyX
23483 \begin_layout Section
23484 The simple \SpecialChar LyX
23488 \begin_layout Standard
23490 implements a simple protocol that can be used for session management.
23491 All messages are of the form
23494 \begin_layout Quote
23504 \begin_layout Standard
23510 \begin_inset Quotes eld
23514 \begin_inset Quotes erd
23518 \begin_inset Quotes eld
23522 \begin_inset Quotes erd
23527 \begin_inset Quotes eld
23531 \begin_inset Quotes erd
23534 is received from a client, \SpecialChar LyX
23535 will report back to inform the client that
23536 it's listening to it's messages, while
23537 \begin_inset Quotes eld
23541 \begin_inset Quotes erd
23544 sent from \SpecialChar LyX
23545 will inform clients that \SpecialChar LyX
23549 \begin_layout Section
23550 Reverse DVI/PDF search
23553 \begin_layout Standard
23554 Some DVI/PDF viewers
23558 \begin_layout Plain Layout
23559 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
23560 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
23569 facility (also called
23574 This means that you can tell \SpecialChar LyX
23575 to put the cursor to a specific line in the
23576 document by clicking at the respective position in the DVI/PDF output.
23577 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
23579 This is done via the \SpecialChar LyX
23580 server either by using the named pipe (
23584 ), or the UNIX domain socket (
23588 ) that \SpecialChar LyX
23589 creates in its temporary directory (this is the way the
23590 \begin_inset Flex Code
23593 \begin_layout Plain Layout
23599 program communicates with \SpecialChar LyX
23601 In some cases, you need a helper script that mediates between the viewer
23602 and \SpecialChar LyX
23603 , in others, the viewer can communicate with \SpecialChar LyX
23605 This depends on the selected viewer and on your operating system.
23606 The same applies to the way viewers need to be configured and the way the
23607 reverse search is actually performed.
23608 In what follows, we will thus describe how to setup reverse search for
23610 Before we turn to this, though, we will explain what needs to be done generally
23611 to enable reverse search in the DVI/PDF output.
23614 \begin_layout Subsection
23616 \begin_inset CommandInset label
23618 name "subsec:rev-search"
23625 \begin_layout Standard
23626 In most cases \SpecialChar LyX
23627 will do the work for you by pressing the following button
23631 arg "buffer-toggle-output-sync"
23635 Alternatively, you can also enable the feature by checking
23637 Synchronize with Output
23640 \begin_inset Flex Noun
23643 \begin_layout Plain Layout
23644 Document\SpecialChar menuseparator
23645 Settings\SpecialChar menuseparator
23652 In such a case \SpecialChar LyX
23653 will automatically insert the necessary Sync\SpecialChar TeX
23655 PDF) or load the srcltx package (for DVI) respectively.
23656 This option can be easily reached also on
23657 \begin_inset Flex Code
23660 \begin_layout Plain Layout
23669 \begin_layout Standard
23670 If you need a different setting, you can select or input a custom macro
23671 from the drop down box just below
23672 \begin_inset Flex Noun
23675 \begin_layout Plain Layout
23676 Document\SpecialChar menuseparator
23677 Settings\SpecialChar menuseparator
23678 Output\SpecialChar menuseparator
23679 Synchronize with Output
23687 \begin_layout Standard
23688 Note that the method
23689 \begin_inset Flex Code
23692 \begin_layout Plain Layout
23700 enables gzip compression.
23701 If your viewer does not support it, you should instead use
23702 \begin_inset Flex Code
23705 \begin_layout Plain Layout
23716 \begin_layout Standard
23717 Please also note that including the
23718 \begin_inset Flex Code
23721 \begin_layout Plain Layout
23728 \begin_inset Flex Code
23731 \begin_layout Plain Layout
23737 sometimes has an undesired impact on the typesetting.
23738 Thus, you should switch output synchronization off for the final typesetting
23740 \begin_inset Flex Code
23743 \begin_layout Plain Layout
23750 \begin_inset Flex Code
23753 \begin_layout Plain Layout
23763 \begin_layout Standard
23764 In case you need some more special settings that are not covered by the
23765 automatic settings, read the next section about how to set up output synchroniz
23767 If the automatic setup suits your needs, you can readily jump to section
23768 \begin_inset space ~
23772 \begin_inset CommandInset ref
23774 reference "subsec:configuring-viewers"
23778 , where the necessary configuration steps in your viewer – needed both with
23779 the automatic and the manual setup – are described.
23782 \begin_layout Subsection
23786 \begin_layout Standard
23788 provides several different methods for reverse search.
23789 Some are built-in in the
23790 \begin_inset Flex Code
23793 \begin_layout Plain Layout
23799 program, some are provided by external packages.
23800 Your choice depends on whether your \SpecialChar LaTeX
23801 distribution already provides a given
23802 method (the built-in methods are rather new) and whether your viewer can
23804 The available methods are described in the following.
23807 \begin_layout Subsubsection*
23808 Built-in DVI-search via src-specials (DVI only)
23811 \begin_layout Standard
23812 This method provides the DVI file with the necessary information for reverse
23814 It is available in \SpecialChar LaTeX
23815 since quite some time (any somewhat recent \SpecialChar LaTeX
23817 should include it), and it works reliably.
23818 To enable it, change the
23819 \begin_inset Flex Noun
23822 \begin_layout Plain Layout
23833 \begin_inset Flex Noun
23836 \begin_layout Plain Layout
23847 \begin_inset Flex Noun
23850 \begin_layout Plain Layout
23851 Preferences\SpecialChar menuseparator
23852 File Handling\SpecialChar menuseparator
23859 \begin_inset Flex Code
23862 \begin_layout Plain Layout
23863 latex -src-specials $$i
23869 If this doesn't work, check if your \SpecialChar TeX
23870 engine needs different options (the
23871 syntax might differ in some distributions).
23874 \begin_layout Subsubsection*
23875 External Packages (PDFSync and scrltx)
23878 \begin_layout Standard
23887 provide reverse search facility for PDF output (via pdflatex) and DVI output,
23889 In order to enable it, load the packages in the \SpecialChar LyX
23893 \begin_layout Itemize
23894 \begin_inset Flex Code
23897 \begin_layout Plain Layout
23900 usepackage{pdfsync}
23905 for reverse PDF search,
23908 \begin_layout Itemize
23909 \begin_inset Flex Code
23912 \begin_layout Plain Layout
23915 usepackage[active]{srcltx}
23920 for reverse DVI search.
23923 \begin_layout Standard
23924 If you want to be able to perform both DVI and PDF reverse searches, you
23925 can also insert in the preamble the following lines
23928 \begin_layout LyX-Code
23932 \begin_inset Newline newline
23938 \begin_inset Newline newline
23943 usepackage{pdfsync}
23944 \begin_inset Newline newline
23950 \begin_inset Newline newline
23955 usepackage[active]{srcltx}
23956 \begin_inset Newline newline
23964 \begin_layout Standard
23965 This way, you can preview the file as either DVI or PDF (pdflatex) and the
23966 right package will be used.
23969 \begin_layout Standard
23970 Note that PDFSync might affect the output layout of your document.
23971 It is therefore advised to disable PDFsync for final documents.
23974 \begin_layout Subsubsection*
23975 Built-in reverse search via Sync\SpecialChar TeX
23979 \begin_layout Standard
23981 \begin_inset Flex Code
23984 \begin_layout Plain Layout
23990 have built-in support for both PDF and DVI reverse search.
23993 Sync\SpecialChar TeX
23996 facility is basically the result of the integration of the PDFSync package
23997 to the pdftex program and its merge with the
24002 You need at least \SpecialChar TeX
24003 Live 2008 or a recent Mik\SpecialChar TeX
24004 distribution in order to use
24009 \begin_layout Plain Layout
24010 For some reason, Mik\SpecialChar TeX
24011 does not understand/obey the command \SpecialChar LyX
24013 the preamble when you check the "Enable Forward/Reverse Search" button
24014 in the toolbar and does not generate the necessary info.
24017 \begin_layout Plain Layout
24018 The generation of the required info can be forced by changing the converter
24019 "\SpecialChar LaTeX
24020 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
24021 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
24022 the -synctex=1 switch).
24027 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
24028 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
24029 already provide Sync\SpecialChar TeX
24033 \begin_layout Standard
24034 To enable Sync\SpecialChar TeX
24035 for DVI output, change the
24036 \begin_inset Flex Noun
24039 \begin_layout Plain Layout
24050 \begin_inset Flex Noun
24053 \begin_layout Plain Layout
24058 (plain) -> DraftDVI
24064 \begin_inset Flex Noun
24067 \begin_layout Plain Layout
24068 Preferences\SpecialChar menuseparator
24069 File Handling\SpecialChar menuseparator
24076 \begin_inset Flex Code
24079 \begin_layout Plain Layout
24080 latex -synctex=1 $$i
24085 , and for PDF output, change the
24086 \begin_inset Flex Noun
24089 \begin_layout Plain Layout
24094 (pdflatex) -> PDF (pdflatex)
24100 \begin_inset Flex Code
24103 \begin_layout Plain Layout
24104 pdflatex -synctex=1 $$i
24110 Should your viewer not be considered in the following description, or in
24111 case of missing success, please check the documentation of your viewer
24112 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
24117 \begin_layout Plain Layout
24118 Note that the option
24119 \begin_inset Flex Code
24122 \begin_layout Plain Layout
24128 option enables gzip compression.
24129 If your viewer does not support it, you should instead use
24130 \begin_inset Flex Code
24133 \begin_layout Plain Layout
24147 \begin_layout Subsection
24148 Configuring and using specific viewers
24149 \begin_inset CommandInset label
24151 name "subsec:configuring-viewers"
24158 \begin_layout Subsubsection*
24159 Xdvi (all platforms)
24162 \begin_layout Standard
24164 \begin_inset Flex Code
24167 \begin_layout Plain Layout
24173 , you don't need to do anything else for performing a reverse DVI search,
24174 as \SpecialChar LyX
24175 already provides the necessary hooks for automatically using the
24176 \begin_inset Flex Code
24179 \begin_layout Plain Layout
24186 Just setup your document as described above (reverse search is triggered
24187 by Ctrl-click or Alt-click on Mac OSX, respectively).
24190 \begin_layout Standard
24191 However, if for whatever reason you want to use the named pipe instead of
24192 the socket for communicating with \SpecialChar LyX
24193 , simply change the DVI viewer in
24194 \begin_inset Flex Noun
24197 \begin_layout Plain Layout
24198 Preferences\SpecialChar menuseparator
24199 File Handling\SpecialChar menuseparator
24209 \begin_layout Plain Layout
24210 On Mac OSX you have to use
24211 \begin_inset Flex Code
24214 \begin_layout Plain Layout
24215 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
24226 \begin_inset Flex Code
24229 \begin_layout Plain Layout
24230 xdvi -editor "lyxeditor.sh %f %l"
24236 \begin_inset Flex Code
24239 \begin_layout Plain Layout
24245 is a suitable script.
24246 For example, a minimal shell script is the following one:
24249 \begin_layout LyX-Code
24251 \begin_inset Newline newline
24254 LYXPIPE="/path/to/lyxpipe"
24255 \begin_inset Newline newline
24258 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
24259 \begin_inset Newline newline
24262 echo "$COMMAND" > "${LYXPIPE}".in || exit
24263 \begin_inset Newline newline
24266 read TMP < "${LYXPIPE}".out || exit
24269 \begin_layout Standard
24271 \begin_inset Flex Code
24274 \begin_layout Plain Layout
24280 is the LyXServer pipe path specified in
24281 \begin_inset Flex Noun
24284 \begin_layout Plain Layout
24285 Preferences\SpecialChar menuseparator
24295 \begin_layout Plain Layout
24297 \begin_inset Flex Code
24300 \begin_layout Plain Layout
24306 folder of a source distribution you can find a
24307 \begin_inset Flex Code
24310 \begin_layout Plain Layout
24316 script which is able to locate the
24320 based on your preferences.
24328 \begin_layout Subsubsection*
24332 \begin_layout Standard
24334 \begin_inset Flex Code
24337 \begin_layout Plain Layout
24338 /Applications/MacDviX_Folder/calleditor.script
24343 , add the following lines:
24346 \begin_layout LyX-Code
24347 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
24348 \begin_inset Newline newline
24354 \begin_layout Standard
24355 Modify the lines accordingly if you install \SpecialChar LyX
24356 somewhere else than in the
24357 Applications folder.
24360 \begin_layout Standard
24361 Reverse search is triggered by Alt-click (OPTION-click).
24364 \begin_layout Subsubsection*
24368 \begin_layout Standard
24370 \begin_inset Flex Code
24373 \begin_layout Plain Layout
24374 open -a Skim.app $$i
24379 to the viewer setting in
24380 \begin_inset Flex Noun
24383 \begin_layout Plain Layout
24384 Preferences\SpecialChar menuseparator
24385 File Handling\SpecialChar menuseparator
24386 File formats\SpecialChar menuseparator
24393 \begin_inset Flex Noun
24396 \begin_layout Plain Layout
24397 Skim\SpecialChar menuseparator
24398 Preferences\SpecialChar menuseparator
24405 \begin_inset Flex Noun
24408 \begin_layout Plain Layout
24414 preset and enter command
24415 \begin_inset Flex Noun
24418 \begin_layout Plain Layout
24419 /Applications/\SpecialChar LyX
24420 .app/Contents/MacOS/lyxeditor
24428 \begin_layout Standard
24429 Reverse search is triggered by COMMAND-SHIFT-click
24432 \begin_layout Subsubsection*
24436 \begin_layout Standard
24437 Reverse search with evince does not work out of the box, but it can be achieved
24438 by means of some third party helper scripts.
24440 \begin_inset CommandInset href
24442 target "https://wiki.lyx.org/LyX/SyncTeX"
24450 \begin_layout Subsubsection*
24454 \begin_layout Standard
24456 \begin_inset Flex Noun
24459 \begin_layout Plain Layout
24460 Settings\SpecialChar menuseparator
24461 Configure Okular\SpecialChar menuseparator
24468 \begin_inset Quotes erd
24472 This inserts the appropriate command (
24473 \begin_inset Flex Code
24476 \begin_layout Plain Layout
24485 \begin_layout Standard
24486 Reverse search is triggered by SHIFT-click.
24488 \change_inserted -712698321 1578211026
24489 Note that this only works if Okular is in
24490 \begin_inset Quotes eld
24494 \begin_inset Quotes erd
24498 \begin_inset space \thinspace{}
24501 e., the hand symbol is clicked).
24506 \begin_layout Subsubsection*
24510 \begin_layout Standard
24511 Qpdfview supports Sync\SpecialChar TeX
24512 since version 0.3.5.
24514 \begin_inset Flex Noun
24517 \begin_layout Plain Layout
24518 Edit\SpecialChar menuseparator
24519 Settings\SpecialChar menuseparator
24525 , click on the input field of the
24526 \begin_inset Quotes eld
24530 \begin_inset Quotes erd
24533 item and add the command
24534 \begin_inset Flex Code
24537 \begin_layout Plain Layout
24546 \begin_layout Standard
24547 Reverse search is triggered by double-click or, in more recent versions,
24551 \begin_layout Subsubsection*
24555 \begin_layout Standard
24556 Launch yap, choose its
24557 \begin_inset Flex Noun
24560 \begin_layout Plain Layout
24561 View\SpecialChar menuseparator
24567 menu and select the
24568 \begin_inset Quotes eld
24572 \begin_inset Quotes erd
24577 \begin_inset Quotes eld
24580 New\SpecialChar ldots
24582 \begin_inset Quotes erd
24585 button and, in the window that opens, enter
24586 \begin_inset Quotes eld
24591 \begin_inset Quotes erd
24594 (or any other name you like) in the
24595 \begin_inset Quotes eld
24599 \begin_inset Quotes erd
24603 Now click on the button labeled
24604 \begin_inset Quotes eld
24609 \begin_inset Quotes erd
24612 to open a file dialog and navigate to the directory containing the batch
24614 \begin_inset Flex Code
24617 \begin_layout Plain Layout
24625 \begin_inset Flex Code
24628 \begin_layout Plain Layout
24634 and then specify the program arguments as
24635 \begin_inset Flex Code
24638 \begin_layout Plain Layout
24646 \begin_inset Flex Code
24649 \begin_layout Plain Layout
24655 wrapper is used for communicating with \SpecialChar LyX
24663 \begin_layout LyX-Code
24665 \begin_inset Newline newline
24668 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
24677 \begin_inset Newline newline
24691 \begin_layout Standard
24692 Make sure that the \SpecialChar LyX
24693 Server pipe path you specified in \SpecialChar LyX
24695 \begin_inset Flex Code
24698 \begin_layout Plain Layout
24712 , otherwise change the
24713 \begin_inset Flex Code
24716 \begin_layout Plain Layout
24722 wrapper accordingly.
24725 \begin_layout Standard
24726 In yap, reverse search is triggered by double-click.
24729 \begin_layout Subsubsection*
24730 SumatraPDF (Windows)
24733 \begin_layout Standard
24734 In order to use SumatraPDF for inverse search, enter
24735 \begin_inset Flex Code
24738 \begin_layout Plain Layout
24739 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
24744 in the viewer setting in
24745 \begin_inset Flex Noun
24748 \begin_layout Plain Layout
24749 Preferences\SpecialChar menuseparator
24750 File Handling\SpecialChar menuseparator
24751 File formats\SpecialChar menuseparator
24758 \begin_inset Flex Code
24761 \begin_layout Plain Layout
24767 is the previous wrapper.
24768 If SumatraPDF.exe is not in your command PATH, use its full file name.
24771 \begin_layout Standard
24772 Reverse search is triggered by double-click.
24775 \begin_layout Subsubsection*
24779 \begin_layout Standard
24780 First of all, make sure that yap is your default DVI viewer in the Windows
24781 environment, then launch it, choose its
24782 \begin_inset Flex Noun
24785 \begin_layout Plain Layout
24786 View\SpecialChar menuseparator
24792 menu and select the
24793 \begin_inset Quotes eld
24797 \begin_inset Quotes erd
24802 \begin_inset Quotes eld
24805 New\SpecialChar ldots
24807 \begin_inset Quotes erd
24810 button and, in the window that opens, enter
24811 \begin_inset Quotes eld
24816 \begin_inset Quotes erd
24819 (or any other name you like) in the
24820 \begin_inset Quotes eld
24824 \begin_inset Quotes erd
24828 Now click on the button labeled
24829 \begin_inset Quotes eld
24834 \begin_inset Quotes erd
24837 to open a file dialog and navigate to the directory containing the
24838 \begin_inset Flex Code
24841 \begin_layout Plain Layout
24847 program (which is installed by default on Cygwin along with the \SpecialChar LyX
24850 \begin_inset Flex Code
24853 \begin_layout Plain Layout
24859 and then specify the program arguments as
24860 \begin_inset Flex Code
24863 \begin_layout Plain Layout
24870 In this way, you will be using the
24874 for communicating with \SpecialChar LyX
24876 If, for whatever reason, you want to use the
24881 \begin_inset Flex Code
24884 \begin_layout Plain Layout
24890 option and be sure to specify the \SpecialChar LyX
24891 Server pipe path in the \SpecialChar LyX
24895 \begin_layout Standard
24896 In yap, reverse search is triggered by double-click.
24899 \begin_layout Subsubsection*
24900 SumatraPDF (Cygwin)
24903 \begin_layout Standard
24904 In order to use SumatraPDF for inverse search, enter
24905 \begin_inset Flex Code
24908 \begin_layout Plain Layout
24909 SumatraPDF -inverse-search "lyxeditor -g %f %l"
24914 in the viewer setting in
24915 \begin_inset Flex Noun
24918 \begin_layout Plain Layout
24919 Preferences\SpecialChar menuseparator
24920 File Handling\SpecialChar menuseparator
24921 File formats\SpecialChar menuseparator
24928 If SumatraPDF.exe is not in your command PATH, use its full posix path.
24930 \begin_inset Flex Code
24933 \begin_layout Plain Layout
24939 enables communication via the
24945 \begin_inset Flex Code
24948 \begin_layout Plain Layout
24954 option if you want to use the
24958 , and be sure to specify the \SpecialChar LyX
24959 Server pipe path in the \SpecialChar LyX
24963 \begin_layout Standard
24964 Reverse search is triggered by double-click.
24967 \begin_layout Section
24971 \begin_layout Standard
24972 Forward search is, as the name implies, in a sense the
24973 \begin_inset Quotes eld
24977 \begin_inset Quotes erd
24981 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
24983 If forward search is set up (as described in what follows), you can put
24984 the cursor anywhere in your \SpecialChar LyX
24986 \begin_inset Flex Noun
24989 \begin_layout Plain Layout
24990 Navigate\SpecialChar menuseparator
24997 \begin_inset Flex Noun
25000 \begin_layout Plain Layout
25006 in the context menu via right mouse click), and then the viewer will jump
25007 to that position as well.
25008 This implies, of course, that your viewer supports this function.
25011 \begin_layout Standard
25012 To make forward search possible, you first need to provide the generated
25013 output PDF/DVI file with additional information about the \SpecialChar TeX
25015 This can be done via the methods described in the section
25016 \begin_inset CommandInset ref
25018 reference "subsec:rev-search"
25025 \begin_layout Standard
25026 Additionally, you need to configure \SpecialChar LyX
25027 for using your viewers in
25028 \begin_inset Flex Noun
25031 \begin_layout Plain Layout
25032 Tools\SpecialChar menuseparator
25033 Preferences\SpecialChar menuseparator
25034 Output\SpecialChar menuseparator
25041 We provide a range of tested configurations for some viewers, which you
25042 can select from the drop down list.
25043 If none of these configurations suits you, you have to find out and enter
25044 a suitable configuration yourself.
25045 The definition syntax uses the following placeholders:
25048 \begin_layout Itemize
25050 \begin_inset Flex Code
25053 \begin_layout Plain Layout
25062 \begin_layout Itemize
25064 \begin_inset Flex Code
25067 \begin_layout Plain Layout
25073 : name of the (temporary) exported .tex file (without path)
25076 \begin_layout Itemize
25078 \begin_inset Flex Code
25081 \begin_layout Plain Layout
25087 : name of the (temporary) exported .tex file (including path)
25090 \begin_layout Itemize
25092 \begin_inset Flex Code
25095 \begin_layout Plain Layout
25101 : name of the exported output file (either dvi or pdf, depending on which
25102 one exists in the temporary directory)
25105 \begin_layout Standard
25106 Note that only some of the viewers provide full and usable forward search
25107 functionality out of the box, among them yap, xdvi, okular
25111 \begin_layout Plain Layout
25112 You might want to set
25113 \begin_inset Flex Code
25116 \begin_layout Plain Layout
25123 \begin_inset Flex Noun
25126 \begin_layout Plain Layout
25127 Tools\SpecialChar menuseparator
25128 Preferences\SpecialChar menuseparator
25129 File Handling\SpecialChar menuseparator
25131 \begin_inset space ~
25144 , qpdfview, and SumatraPDF
25148 \begin_layout Plain Layout
25149 SumatraPDF can also use DDE commands through the external program CMCDDE
25150 — downloadable from
25151 \begin_inset CommandInset href
25153 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
25164 Others, such as evince
25168 \begin_layout Plain Layout
25169 Forward search with evince can be achieved by means of third party helper
25172 \begin_inset CommandInset href
25174 target "https://wiki.lyx.org/LyX/SyncTeX"
25184 , require some extra tools in order to use forward search.
25185 While many of the widespread PDF viewers (most notably Adobe Reader) do
25186 not support forward search at all, some other viewers – e.
25187 \begin_inset space \thinspace{}
25191 xpdf – allow at least to reload the document and jump to a specific page
25192 of the file, so you can at least navigate
25193 \begin_inset Quotes eld
25197 \begin_inset Quotes erd
25201 This latter functionality is provided by an external call of synctex (see
25202 the predefined example configurations).
25206 \begin_layout Standard
25207 Forward search works both with DVI and PDF output.
25209 simply checks which preview format you have used before (i.
25210 \begin_inset space \thinspace{}
25213 e., which format is already there in the temporary directory) and chooses
25214 the appropriate configuration for the respective format.
25217 \begin_layout Chapter
25219 \change_deleted 564990737 1671097409
25220 Special Document Classes
25225 \begin_layout Section
25227 \change_deleted 564990737 1669742044
25231 \begin_layout Standard
25233 \change_deleted 564990737 1669742044
25239 \begin_layout Subsection
25241 \change_deleted 564990737 1669742044
25245 \begin_layout Standard
25247 \change_deleted 564990737 1669742044
25248 This section describes how \SpecialChar LyX
25249 can be used to write articles for submission
25250 to the scientific journal
25252 Astronomy and Astrophysics
25255 \begin_inset Flex URL
25258 \begin_layout Plain Layout
25260 https://www.aanda.org/
25265 ) using Version 5.01 of the document class
25270 This package can be downloaded from the ftp site
25273 \begin_layout Standard
25275 \change_deleted 564990737 1669742044
25276 \begin_inset VSpace medskip
25282 \begin_layout Standard
25285 \change_deleted 564990737 1669742044
25286 \begin_inset Flex URL
25289 \begin_layout Plain Layout
25291 ftp://ftp.edpsciences.org/pub/aa/readme.html
25299 \begin_layout Standard
25301 \change_deleted 564990737 1669742044
25302 \begin_inset VSpace medskip
25308 \begin_layout Standard
25310 \change_deleted 564990737 1669742044
25311 A manual comes together with that package, and this text is not meant to
25312 replace the original manual but is merely a short guide in how to realize
25313 the correct form of your paper.
25317 \begin_layout Standard
25319 \change_deleted 564990737 1669742044
25320 Please note that the publisher of the journal was changed from Springer
25321 to EDP Sciences starting January 1, 2001.
25322 That change involved also some slight changes to the style files, namely
25323 the removal of the thesaurus command.
25324 The \SpecialChar LyX
25325 class aa supports the newest version of these style files, V 5.01.
25326 If you have an older version installed, please upgrade.
25327 For compatibility, the old (version 4) layout has been kept as
25332 Please refer to the comments in
25335 Dir/layouts/aapaper.layout
25340 \begin_layout Subsection
25342 \change_deleted 564990737 1669742044
25346 \begin_layout Standard
25348 \change_deleted 564990737 1669742044
25349 It is recommended you start from the example template distributed with \SpecialChar LyX
25351 If you are not using a template, note the following settings:
25354 \begin_layout Itemize
25356 \change_deleted 564990737 1669742044
25363 Document\SpecialChar menuseparator
25366 dialog (OK, that one was obvious).
25369 \begin_layout Itemize
25371 \change_deleted 564990737 1669742044
25372 Don't change the option
25375 \begin_inset space ~
25385 The whole layout is done by the macros, you shouldn't change anything.
25388 \begin_layout Subsection
25390 \change_deleted 564990737 1669742044
25394 \begin_layout Standard
25396 \change_deleted 564990737 1669742044
25397 First thing to enter is the header information.
25398 It consists of seven entries, of which some are optional.
25402 \begin_layout Itemize
25404 \change_deleted 564990737 1669742044
25412 \begin_layout Itemize
25414 \change_deleted 564990737 1669742044
25422 \begin_layout Itemize
25424 \change_deleted 564990737 1669742044
25432 \begin_layout Itemize
25434 \change_deleted 564990737 1669742044
25442 \begin_layout Itemize
25444 \change_deleted 564990737 1669742044
25449 : [optional] if more than one author: whom to contact for offprint requests.
25452 \begin_layout Itemize
25454 \change_deleted 564990737 1669742044
25459 : [optional] mail address for contacts.
25462 \begin_layout Itemize
25464 \change_deleted 564990737 1669742044
25470 Suggested format is
25472 Received: <date>; Accepted <date>
25475 \begin_layout Standard
25477 \change_deleted 564990737 1669742044
25478 There is no need to issue the
25484 command, this is done automatically by \SpecialChar LyX
25485 when the header is finished.
25486 Although the order of the single header entries doesn't matter it is advised
25487 to keep the above sequence, just to get the best optics and meets the layout
25488 of the real document.
25491 \begin_layout Standard
25493 \change_deleted 564990737 1669742044
25494 If you want to place footnotes in the header block, e.
25495 \begin_inset space \thinspace{}
25499 \begin_inset space \space{}
25502 to state your present address, just use the standard footnote via the menu
25505 Insert\SpecialChar menuseparator
25510 will automagically use the term
25519 \begin_layout Standard
25521 \change_deleted 564990737 1669742044
25524 Edit\SpecialChar menuseparator
25527 , you'll find two insets which are relevant for the titling:
25530 \begin_layout Itemize
25532 \change_deleted 564990737 1669742044
25539 to mark corresponding author\SpecialChar breakableslash
25541 The institutes are numbered sequentially as they appear in the
25545 field, so you have to put a marker to each author.
25548 \begin_layout Itemize
25550 \change_deleted 564990737 1669742044
25555 to supply an email address for fast contact.
25558 \begin_layout Standard
25560 \change_deleted 564990737 1669742044
25561 In addition to these topics, the macros use one additional \SpecialChar LaTeX
25563 has no counterpart in \SpecialChar LyX
25567 \begin_layout Itemize
25569 \change_deleted 564990737 1669742044
25576 to separate different names for more than one author and institute, respectivel
25580 \begin_layout Standard
25582 \change_deleted 564990737 1669742044
25583 The appropriate command has to be entered in \SpecialChar LyX
25584 and marked as \SpecialChar LaTeX
25590 \begin_layout Subsection
25592 \change_deleted 564990737 1669742044
25596 \begin_layout Standard
25598 \change_deleted 564990737 1669742044
25599 The abstract should immediately follow the header block.
25600 With version 5 the abstract environment was changed to a command, and there
25601 is now a restriction to only one paragraph.
25602 In addition, it should contain an entry with the keywords.
25603 This is done via the paragraph style
25608 Refer to the example paper.
25611 \begin_layout Subsection
25613 \change_deleted 564990737 1669742044
25614 Supported environments
25617 \begin_layout Standard
25619 \change_deleted 564990737 1669742044
25620 The A&A paper layout supports the following environments for structuring
25624 \begin_layout Itemize
25626 \change_deleted 564990737 1669742044
25632 \begin_layout Itemize
25634 \change_deleted 564990737 1669742044
25640 \begin_layout Itemize
25642 \change_deleted 564990737 1669742044
25648 \begin_layout Itemize
25650 \change_deleted 564990737 1669742044
25656 \begin_layout Itemize
25658 \change_deleted 564990737 1669742044
25664 \begin_layout Itemize
25666 \change_deleted 564990737 1669742044
25672 \begin_layout Itemize
25674 \change_deleted 564990737 1669742044
25680 \begin_layout Itemize
25682 \change_deleted 564990737 1669742044
25688 \begin_layout Itemize
25690 \change_deleted 564990737 1669742044
25696 \begin_layout Itemize
25698 \change_deleted 564990737 1669742044
25704 \begin_layout Itemize
25706 \change_deleted 564990737 1669742044
25712 \begin_layout Itemize
25714 \change_deleted 564990737 1669742044
25721 \begin_layout Subsection
25723 \change_deleted 564990737 1669742044
25724 Commands not supported by \SpecialChar LyX
25728 \begin_layout Standard
25730 \change_deleted 564990737 1669742044
25731 Some commands are not yet supported by the
25735 layout for \SpecialChar LyX
25737 Some have already been mentioned.
25738 For the sake of completeness, they are listed all together here:
25741 \begin_layout Itemize
25743 \change_deleted 564990737 1669742044
25751 \begin_layout Itemize
25753 \change_deleted 564990737 1669742044
25761 \begin_layout Itemize
25763 \change_deleted 564990737 1669742044
25771 \begin_layout Itemize
25773 \change_deleted 564990737 1669742044
25781 \begin_layout Standard
25783 \change_deleted 564990737 1669742044
25784 If you want to use any of these commands, you have to enter them yourself.
25787 Do not forget to mark them as \SpecialChar LaTeX
25791 \begin_layout Subsection
25793 \change_deleted 564990737 1669742044
25794 Figure and Table Floats
25797 \begin_layout Standard
25799 \change_deleted 564990737 1669742044
25801 provides support for the necessary float environments
25803 figure, figure*, table
25809 , therefore we won't tell much about it here.
25813 \begin_inset space ~
25819 Just remember that tables should be left-aligned.
25820 For that, select the table and change the alignment in
25822 Edit\SpecialChar menuseparator
25824 \begin_inset space ~
25830 \begin_layout Standard
25832 \change_deleted 564990737 1669742044
25833 There is only one special thing: the figures with caption besides the figure.
25834 To create such a figure, you have to do the following:
25837 \begin_layout Enumerate
25839 \change_deleted 564990737 1669742044
25840 Create a wide figure float:
25842 Insert\SpecialChar menuseparator
25843 Float\SpecialChar menuseparator
25846 , then right click in the figure and select
25849 \begin_inset space ~
25857 \begin_layout Enumerate
25859 \change_deleted 564990737 1669742044
25860 Enter your caption text.
25863 \begin_layout Enumerate
25865 \change_deleted 564990737 1669742044
25870 to move the cursor above the caption.
25873 \begin_layout Enumerate
25875 \change_deleted 564990737 1669742044
25879 \begin_layout Enumerate
25881 \change_deleted 564990737 1669742044
25882 Position the cursor behind the figure and insert a horizontal fill:
25884 Insert\SpecialChar menuseparator
25886 \begin_inset space ~
25889 Character\SpecialChar menuseparator
25891 \begin_inset space ~
25899 \begin_layout Enumerate
25901 \change_deleted 564990737 1669742044
25902 Switch to \SpecialChar LaTeX
25906 \begin_inset space ~
25914 \begin_layout Enumerate
25916 \change_deleted 564990737 1669742044
25926 Do not close the brace!
25929 \begin_layout Enumerate
25931 \change_deleted 564990737 1669742044
25932 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
25937 \begin_inset space ~
25949 \begin_layout Standard
25951 \change_deleted 564990737 1669742044
25952 Also, refer to the figures in the example paper.
25955 \begin_layout Subsection
25957 \change_deleted 564990737 1669742044
25961 \begin_layout Standard
25963 \change_deleted 564990737 1669742044
25964 For submission, the paper has to be formated in a special double-spacing
25966 For this purpose, you have to give the option
25970 to the document class.
25971 This must be done using the custom class options field in the
25973 Document\SpecialChar menuseparator
25977 Just enter the string
25984 \begin_layout Subsection
25986 \change_deleted 564990737 1669742044
25990 \begin_layout Standard
25992 \change_deleted 564990737 1669742044
25997 directory contains an example paper written with \SpecialChar LyX
25999 It is the example paper from the original macro package, translated to
26002 Use it for inspiration, and compare the original \SpecialChar LaTeX
26003 code with \SpecialChar LyX
26007 \begin_layout Section
26009 \change_deleted 564990737 1671097429
26013 \begin_layout Standard
26015 \change_deleted 564990737 1671097429
26020 can be used to type letters according to German conventions.
26021 A template file is included in
26023 .../lyx/share/templates
26025 for you to use as a starting point.
26028 \begin_layout Section
26030 \change_deleted 564990737 1671097429
26034 \begin_layout Standard
26036 \change_deleted 564990737 1671097429
26037 See the \SpecialChar LyX
26043 It contains all infos you need.
26046 \begin_layout Section
26048 \change_deleted 564990737 1669755802
26052 \begin_layout Standard
26054 \change_deleted 564990737 1669755802
26057 Panayotis Papasotiriou
26060 \begin_layout Subsection
26062 \change_deleted 564990737 1669755802
26066 \begin_layout Standard
26068 \change_deleted 564990737 1669755802
26069 The ijmpc package is a set of macros that facilitates electronic manuscript
26072 International Journal of Modern Physics C
26075 Similarly, the ijmpd package is for creating manuscripts to be submitted
26078 International Journal of Modern Physics D
26081 Both journals are published by World Scientific.
26082 The corresponding document classes are named
26091 These files, together with instructions for the authors, can be downloaded
26093 \begin_inset Flex URL
26096 \begin_layout Plain Layout
26098 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
26104 \begin_inset Flex URL
26107 \begin_layout Plain Layout
26109 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
26115 Both packages are modified versions of the standard
26116 \begin_inset Quotes eld
26120 \begin_inset Quotes erd
26123 package, and they are almost (but not exactly) identical.
26124 Most of their features are supported by \SpecialChar LyX
26126 I have used \SpecialChar LyX
26127 successfully to write articles submitted to both journals
26128 without any problem.
26131 \begin_layout Subsection
26133 \change_deleted 564990737 1669755802
26137 \begin_layout Standard
26139 \change_deleted 564990737 1669755802
26140 As usual, the easiest way to write a paper is to start with a template.
26143 File\SpecialChar menuseparator
26159 This will give an (almost) empty document that includes the most common
26160 fields found in a manuscript.
26161 Simply overwrite the existing text (including the brackets,
26166 You should keep in mind the following remarks.
26169 \begin_layout Enumerate
26171 \change_deleted 564990737 1669755802
26173 won't let you change the font size and the page style of the document,
26174 because such modifications are not allowed by both packages.
26177 \begin_layout Enumerate
26179 \change_deleted 564990737 1669755802
26180 The language of the document should not be changed.
26181 Before previewing your paper, be sure that the babel package is not used.
26182 To do this, click on
26185 arg "dialog-show document"
26190 \SpecialChar menuseparator
26194 \begin_inset Quotes eld
26198 \begin_inset Quotes erd
26208 \begin_layout Enumerate
26210 \change_deleted 564990737 1669755802
26212 \begin_inset Quotes eld
26216 \begin_inset Quotes erd
26219 style must be used to define keywords.
26222 \begin_layout Enumerate
26224 \change_deleted 564990737 1669755802
26225 The ijmpc package provides a style named
26226 \begin_inset Quotes eld
26229 Classification Codes
26230 \begin_inset Quotes erd
26233 , which can be used to define classification codes, such as PACS numbers.
26234 Note that this facility is not supported by the ijmpd package.
26237 \begin_layout Enumerate
26239 \change_deleted 564990737 1669755802
26240 Several new environments are available:
26241 \begin_inset Quotes eld
26245 \begin_inset Quotes erd
26249 \begin_inset Quotes eld
26253 \begin_inset Quotes erd
26257 \begin_inset Quotes eld
26261 \begin_inset Quotes erd
26265 \begin_inset Quotes eld
26269 \begin_inset Quotes erd
26273 \begin_inset Quotes eld
26277 \begin_inset Quotes erd
26281 \begin_inset Quotes eld
26285 \begin_inset Quotes erd
26289 \begin_inset Quotes eld
26293 \begin_inset Quotes erd
26297 \begin_inset Quotes eld
26301 \begin_inset Quotes erd
26305 \begin_inset Quotes eld
26309 \begin_inset Quotes erd
26313 \begin_inset Quotes eld
26317 \begin_inset Quotes erd
26321 \begin_inset Quotes eld
26325 \begin_inset Quotes erd
26329 \begin_inset Quotes eld
26333 \begin_inset Quotes erd
26337 \begin_inset Quotes eld
26341 \begin_inset Quotes erd
26345 \begin_inset Quotes eld
26349 \begin_inset Quotes erd
26353 Their use is more or less obvious.
26355 supports all these environments; it will use the proper label, text style,
26356 and numbering scheme for each of them.
26359 \begin_layout Enumerate
26361 \change_deleted 564990737 1669755802
26362 Both packages use basic citations; the natbib package should not be used.
26363 In \SpecialChar LyX
26364 , citation references are shown as usual; in the output, citations are
26365 shown as superscripts.
26366 If you want to use a citation as normal text, you should use the
26371 \begin_inset space \thinspace{}
26375 \begin_inset space \space{}
26379 \begin_inset Quotes eld
26383 \begin_inset space \space{}
26393 \begin_inset Quotes erd
26399 \begin_layout Enumerate
26401 \change_deleted 564990737 1669755802
26403 \begin_inset Quotes eld
26407 \begin_inset Quotes erd
26410 section in both packages.
26411 To put acknowledgments, just use the
26412 \begin_inset Quotes eld
26416 \begin_inset Quotes erd
26422 \begin_layout Enumerate
26424 \change_deleted 564990737 1669755802
26425 Appendices may be added to the paper,
26429 the Acknowledgments and
26435 provides a special environment, called
26436 \begin_inset Quotes eld
26440 \begin_inset Quotes erd
26443 which marks the beginning of the appendices.
26444 This environment should be left blank; it just sends a \SpecialChar LaTeX
26445 command, but nothing
26447 In \SpecialChar LyX
26449 \begin_inset Quotes eld
26453 \begin_inset Quotes erd
26456 is printed with blue letters, as a signal that all sections after that
26457 point are appendices.
26458 To write an appendix, use the
26459 \begin_inset Quotes eld
26463 \begin_inset Quotes erd
26468 will number each appendix with capital letters, as required by both journals.
26470 \begin_inset Quotes eld
26474 \begin_inset Quotes erd
26481 be present before the first appendix; if not, all appendices will be numbered
26482 as normal sections in the output.
26485 \begin_layout Enumerate
26487 \change_deleted 564990737 1669755802
26488 The ijmpc and the ijmpd packages use the
26492 command to implement table captions.
26493 As a result, a table created by \SpecialChar LyX
26494 is printed correctly, but its caption
26496 However, you can use some \SpecialChar TeX
26497 code to overcome this problem, so that captions
26498 are printed as expected.
26499 To do so, create a float table as usual, remove the caption, and replace
26500 it with the \SpecialChar TeX
26511 (sic); you must also the \SpecialChar TeX
26516 immediately after the tabular material.
26517 Study the example table included in the template files to see how this
26518 trick is implemented.
26519 Alternatively, If you need table captions, you should implement the whole
26524 file, then include this file to the \SpecialChar LyX
26527 Insert\SpecialChar menuseparator
26528 File\SpecialChar menuseparator
26530 \begin_inset space ~
26536 Details on how to create a table float can be found in the files
26544 , included in the corresponding packages.
26547 \begin_layout Subsection
26549 \change_deleted 564990737 1669755802
26550 Preparing a paper for submission
26553 \begin_layout Standard
26555 \change_deleted 564990737 1669755802
26556 Before you submit your paper you must export the \SpecialChar LyX
26557 document as a \SpecialChar LaTeX
26560 File\SpecialChar menuseparator
26561 Export\SpecialChar menuseparator
26569 \begin_layout Plain Layout
26570 Actually you have the choice between \SpecialChar LaTeX
26571 (plain) and pdflatex.
26572 If you intend to use pdflatex to prepare the paper, you should use the
26573 pdflatex option so that included graphics are converted to PDF format,
26574 ready for use by pdflatex.
26579 , then make the following changes to the resulting
26586 \begin_layout Enumerate
26588 \change_deleted 564990737 1669755802
26589 Remove the comment lines before the
26598 \begin_layout Enumerate
26600 \change_deleted 564990737 1669755802
26601 Remove everything between (and including) the
26613 commands, except for any commands you specifically put into the \SpecialChar LaTeX
26617 \begin_layout Standard
26619 \change_deleted 564990737 1669755802
26624 file should be saved and processed through \SpecialChar LaTeX
26625 as many times as necessary.
26626 You may also want to check the resulting
26635 \begin_layout Section
26637 \change_deleted 564990737 1669801478
26641 \begin_layout Standard
26643 \change_deleted 564990737 1669801478
26649 \begin_layout Subsection
26651 \change_deleted 564990737 1669801478
26655 \begin_layout Standard
26657 \change_deleted 564990737 1669801478
26658 The iopart package provides a document class to create electronic manuscript
26659 submission to the journals published by the Institute of Physics.
26660 Instructions for the authors how to create a paper using the iopart class
26661 can be downloaded together with the iopart package from the site
26662 \begin_inset Flex URL
26665 \begin_layout Plain Layout
26667 ftp://ftp.iop.org/pub/journals/latex2e
26675 \begin_layout Subsection
26677 \change_deleted 564990737 1669801478
26681 \begin_layout Standard
26683 \change_deleted 564990737 1669801478
26684 The easiest way to write a paper is to start with the template
26688 that is available via
26690 File\SpecialChar menuseparator
26693 The template explains how to use the special text environments.
26694 Here are the most important advices:
26697 \begin_layout Itemize
26699 \change_deleted 564990737 1669801478
26700 To be able to compile your document to a PDF, PS, or DVI, ensure that the
26701 no AMS packages are loaded in
26703 Document\SpecialChar menuseparator
26704 Settings\SpecialChar menuseparator
26710 \begin_layout Itemize
26712 \change_deleted 564990737 1669801478
26715 The title environment defines the kind of your paper.
26716 So use one of the following environments for the title:
26720 \begin_layout Itemize
26722 \change_deleted 564990737 1669801478
26731 \begin_layout Itemize
26733 \change_deleted 564990737 1669801478
26742 \begin_layout Itemize
26744 \change_deleted 564990737 1669801478
26750 for a Topical review
26753 \begin_layout Itemize
26755 \change_deleted 564990737 1669801478
26764 \begin_layout Itemize
26766 \change_deleted 564990737 1669801478
26775 \begin_layout Itemize
26777 \change_deleted 564990737 1669801478
26783 for a Paper (same as Title)
26786 \begin_layout Itemize
26788 \change_deleted 564990737 1669801478
26794 for a Preliminary communication
26797 \begin_layout Itemize
26799 \change_deleted 564990737 1669801478
26805 for a Rapid communication
26808 \begin_layout Itemize
26810 \change_deleted 564990737 1669801478
26816 for a Letter to the editor
26820 \begin_layout Itemize
26822 \change_deleted 564990737 1669801478
26825 All title environments except of
26829 can have an optional short title.
26832 \begin_layout Itemize
26834 \change_deleted 564990737 1669801478
26835 There is a general title environment
26839 which is not directly supported by \SpecialChar LyX
26841 This can be used as \SpecialChar TeX
26842 code when your document doesn't fit into one of the
26846 \begin_layout Standard
26848 \change_deleted 564990737 1669801478
26849 For more informations like hints for special table and formula formatting,
26850 look at the IOP author guidelines.
26855 \begin_layout Section
26857 \change_deleted 564990737 1670317155
26861 \begin_layout Standard
26863 \change_deleted 564990737 1670317155
26866 Panayotis Papasotiriou
26869 \begin_layout Subsection
26871 \change_deleted 564990737 1670317155
26875 \begin_layout Standard
26877 \change_deleted 564990737 1670317155
26878 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
26879 that facilitates electronic manuscript submission to the journals they
26881 Most known of them (at least in my domain of interest) are
26883 Astrophysics and Space Science
26889 , but there are many others (see a complete list at
26890 \begin_inset Flex URL
26893 \begin_layout Plain Layout
26895 http://www.wkap.nl/jrnllist.htm/JRNLHOME
26901 The Kluwer package may be downloaded from the site
26902 \begin_inset Flex URL
26905 \begin_layout Plain Layout
26907 http://www.wkap.nl/kaphtml.htm/STYLEFILES
26913 A complete user guide is contained in that package (but it can also be
26914 downloaded separately).
26917 \begin_layout Standard
26919 \change_deleted 564990737 1670317155
26921 supports many features of the package but not everything.
26922 However, the \SpecialChar TeX
26923 code needed is reduced to some
26924 \begin_inset Quotes eld
26928 \begin_inset Quotes erd
26931 commands of the package (see
26932 \begin_inset space ~
26936 \begin_inset CommandInset ref
26938 reference "subsec:kluwer_peculiarities"
26943 I have recently used \SpecialChar LyX
26944 to write an article submitted to the
26946 Astrophysics and Space Science
26948 without any problem.
26951 \begin_layout Subsection
26953 \change_deleted 564990737 1670317155
26957 \begin_layout Standard
26959 \change_deleted 564990737 1670317155
26960 The easiest way to write a paper is to start with the Kluwer template file.
26963 File\SpecialChar menuseparator
26975 This will give an (almost) empty document that includes the most common
26976 fields found in a manuscript and a short description of their use.
26977 As in most templates, simply overwrite the existing text (including the
26982 ) with the correct information.
26985 \begin_layout Subsection
26987 \change_deleted 564990737 1670317155
26988 Preparing a paper for submission
26991 \begin_layout Standard
26993 \change_deleted 564990737 1670317155
26994 As in the AAS\SpecialChar TeX
26995 package, before you submit your paper to a journal you must
26997 \begin_inset Quotes eld
27001 \begin_inset Quotes erd
27007 \begin_layout Enumerate
27009 \change_deleted 564990737 1670317155
27010 Export your paper as a \SpecialChar LaTeX
27012 To do this, click on
27014 File\SpecialChar menuseparator
27015 Export\SpecialChar menuseparator
27023 \begin_layout Enumerate
27025 \change_deleted 564990737 1670317155
27030 file with a text editor and make the following changes
27034 \begin_layout Enumerate
27036 \change_deleted 564990737 1670317155
27037 remove the comment lines before the
27046 \begin_layout Enumerate
27048 \change_deleted 564990737 1670317155
27049 remove everything between (and including) the
27061 commands, except for any commands you specifically put into the \SpecialChar LaTeX
27065 \begin_layout Standard
27067 \change_deleted 564990737 1670317155
27076 \begin_layout Enumerate
27078 \change_deleted 564990737 1670317155
27083 file through \SpecialChar LaTeX
27084 as many times as necessary (usually up to three).
27087 \begin_layout Enumerate
27089 \change_deleted 564990737 1670317155
27095 \begin_inset space \thinspace{}
27099 \begin_inset space \space{}
27106 , and check if everything is OK (it should, if you didn't make any mistake).
27109 \begin_layout Subsection
27111 \change_deleted 564990737 1670317155
27112 \begin_inset Quotes eld
27116 \begin_inset Quotes erd
27119 of the Kluwer package
27120 \begin_inset CommandInset label
27122 name "subsec:kluwer_peculiarities"
27129 \begin_layout Standard
27131 \change_deleted 564990737 1670317155
27132 The Kluwer package has the following
27133 \begin_inset Quotes eld
27137 \begin_inset Quotes erd
27143 \begin_layout Enumerate
27145 \change_deleted 564990737 1670317155
27146 It is possible to write multiple articles in the same \SpecialChar LaTeX
27151 \begin_layout Plain Layout
27152 I can't imagine any good reason to do this.
27158 Each article must be included in the environment
27159 \begin_inset Quotes eld
27163 \begin_inset Quotes erd
27167 Unfortunately, this environment cannot be omitted, even if you write just
27169 Therefore, each article starts with the command
27175 and, obviously, ends with the command
27182 Although this can be implemented in \SpecialChar LyX
27183 , I didn't included it, since it looks
27184 ugly and can confuse the novice user.
27185 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
27188 \begin_inset Quotes eld
27193 \begin_inset Quotes erd
27199 \begin_layout Enumerate
27201 \change_deleted 564990737 1670317155
27202 Information given at the beginning of the article (i.
27203 \begin_inset space \thinspace{}
27207 \begin_inset space \space{}
27210 title, subtitle, author, institution, running title, running author, abstract
27211 and keywords) must be included in an environment called
27212 \begin_inset Quotes eld
27216 \begin_inset Quotes erd
27220 This is not implemented in \SpecialChar LyX
27221 , so you must enter title, subtitle etc.
27222 \begin_inset space ~
27225 between two \SpecialChar TeX
27241 \begin_layout Enumerate
27243 \change_deleted 564990737 1670317155
27244 According to the user manual, the label of each bibliography item must be
27268 \begin_layout Standard
27270 \change_deleted 564990737 1670317155
27275 template takes care of all these
27276 \begin_inset Quotes eld
27280 \begin_inset Quotes erd
27284 If you start a new paper using this template you don't need to do anything
27289 \begin_layout Enumerate
27291 \change_deleted 564990737 1670317155
27292 don't delete the \SpecialChar TeX
27293 code included in the template, and
27296 \begin_layout Enumerate
27298 \change_deleted 564990737 1670317155
27299 copy the example bibliography item included in the template and modify it
27300 as necessary to enter new bibliography items.
27303 \begin_layout Section
27305 \change_deleted 564990737 1671097446
27309 \begin_layout Standard
27311 \change_deleted 564990737 1671097446
27316 provides an alternative to the standard
27321 It provides similar functionality, but you might prefer this layout with
27322 sans serif sections, headings, and more.
27325 \begin_layout Section
27327 \change_deleted 564990737 1671097446
27328 Springer Journals (
27335 \begin_layout Standard
27337 \change_deleted 564990737 1671097446
27343 \begin_layout Subsection
27345 \change_deleted 564990737 1671097446
27349 \begin_layout Standard
27351 \change_deleted 564990737 1671097446
27352 These are the layout files for some of the journal formats used by Springer
27353 Verlag and listed on
27354 \begin_inset Flex URL
27357 \begin_layout Plain Layout
27359 http://www.springer.de/author/tex/help-journals.html
27364 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
27366 It is a modular system: the things common to all journals are implemented
27371 , which journal-specific layout files (such as, e.
27372 \begin_inset space \thinspace{}
27376 \begin_inset space \space{}
27383 for Journal of Geodesy) can include.
27386 \begin_layout Standard
27388 \change_deleted 564990737 1671097446
27389 This means that implementing support for any other Springer journal on this
27390 list is as simple as writing your own
27398 file following the outline given in
27406 \begin_layout Standard
27408 \change_deleted 564990737 1671097446
27409 It is reasonably well tested only for the Journal of Geodesy.
27418 come with the standard \SpecialChar LyX
27420 Install the relevant class file (downloaded from Springer) in a proper
27421 directory, reconfigure \SpecialChar LaTeX
27422 (in the te\SpecialChar TeX
27427 , as root if necessary — doesn't \SpecialChar LyX
27428 take care of this?), reconfigure \SpecialChar LyX
27433 \begin_layout Subsection
27435 \change_deleted 564990737 1671097446
27439 \begin_layout Standard
27441 \change_deleted 564990737 1671097446
27442 A large number of theorem-like styles —
27454 \begin_layout Standard
27456 \change_deleted 564990737 1671097446
27459 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
27460 _Title, Author_Running, Institute,
27461 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
27464 See the Springer class file documentation for details.
27467 \begin_layout Subsection
27469 \change_deleted 564990737 1671097446
27473 \begin_layout Itemize
27475 \change_deleted 564990737 1671097446
27487 \begin_layout Itemize
27489 \change_deleted 564990737 1671097446
27492 Probability Theory and Related Fields
27498 — Jean-Marc Lasgouttes
27501 \begin_layout Standard
27503 \change_deleted 564990737 1671097446
27504 Add your own, it isn't so hard!
27507 \begin_layout Subsection
27509 \change_deleted 564990737 1671097446
27513 \begin_layout Standard
27515 \change_deleted 564990737 1671097446
27516 These files are partly based on the older
27520 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
27522 file from Springer.
27527 layout, are now defunct.
27528 Jean-Marc Lasgouttes helped out big in making me find my way around the
27530 layout file mechanism.
27533 \begin_layout Subsection
27535 \change_deleted 564990737 1671097446
27539 \begin_layout Standard
27541 \change_deleted 564990737 1671097446
27543 But probably less than in the old hacked-\SpecialChar LaTeX
27551 \begin_layout Chapter
27553 Features needing Extra Software
27556 \begin_layout Section
27557 Checking \SpecialChar TeX
27561 \begin_layout Standard
27567 \begin_layout Subsection
27571 \begin_layout Standard
27580 \begin_layout Plain Layout
27585 is not yet available when you are using the \SpecialChar LaTeX
27586 distribution MiK\SpecialChar TeX
27592 , you'll find in the
27599 \begin_inset space ~
27610 \begin_inset Newline newline
27614 \begin_inset CommandInset href
27616 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
27624 \begin_layout Standard
27627 Chk\SpecialChar TeX
27630 package is a program that was written by
27631 \begin_inset Flex Noun
27634 \begin_layout Plain Layout
27636 \begin_inset space ~
27644 in frustration because some constructs in \SpecialChar LaTeX
27645 are sometimes non-intuitive,
27646 and easy to forget.
27647 The program runs over your \SpecialChar LaTeX
27648 file, checks the integrity of the file, and
27649 flags some common errors.
27650 In other technical words, it is
27654 for \SpecialChar LaTeX
27658 \begin_layout Standard
27659 Well, what is a syntax checker doing in \SpecialChar LyX
27660 which is supposed to produce correct
27662 anyways? The answer is simple: Just as
27666 not only checks the
27670 of C programs, but also does
27674 checks for type-errors,
27676 Chk\SpecialChar TeX
27679 catches some common
27683 errors, in addition to the syntactical ones.
27686 Chk\SpecialChar TeX
27689 is capable of detecting several common errors, such as
27692 \begin_layout Itemize
27693 Ellipsis detection:
27694 \begin_inset Newline newline
27697 Use \SpecialChar ldots
27701 \begin_layout Itemize
27702 No space in front of/after parenthesis:
27703 \begin_inset Newline newline
27709 \begin_layout Itemize
27710 Enforcement of normal space after common abbreviations:
27711 \begin_inset Newline newline
27715 \begin_inset space \thinspace{}
27719 \begin_inset space \space{}
27722 is too wide spacing.
27725 \begin_layout Itemize
27726 Enforcement of end-of-sentence space when the last sentence ends with a
27728 \begin_inset Newline newline
27732 And this is wrong spacing.
27735 \begin_layout Itemize
27736 Space in front of labels and similar commands:
27737 \begin_inset Newline newline
27740 The label should stick right up to the text to avoid falling to a wrong
27743 \begin_inset CommandInset label
27753 \begin_layout Plain Layout
27754 This footnote is in danger of falling off to a wrong page
27759 The label is separated too much.
27762 \begin_layout Itemize
27763 Space in front of references, instead of hard spaces:
27764 \begin_inset Newline newline
27767 If you have bad luck, the text will break right between the referenced text
27768 and reference number, and that's a pity.
27770 \begin_inset CommandInset ref
27772 reference "sec:chktex"
27779 \begin_layout Itemize
27781 \begin_inset Quotes eld
27785 \begin_inset Quotes erd
27789 \begin_inset Formula $\times$
27793 \begin_inset Newline newline
27796 2x2 looks cheap compared to
27797 \begin_inset Formula $2\times2$
27803 \begin_layout Standard
27804 and more \SpecialChar ldots
27805 It is an invaluable tool when you are
27806 \begin_inset Quotes eld
27810 \begin_inset Quotes erd
27813 your document before printing, and you should run it right after the obligatory
27814 spelling check, and before you go fine tuning the typesetting.
27817 \begin_layout Subsection
27821 \begin_layout Standard
27822 If you have the program installed, usage is as simple as choosing
27824 Tools\SpecialChar menuseparator
27826 \begin_inset space ~
27832 This will make \SpecialChar LyX
27833 generate a \SpecialChar LaTeX
27834 file of your document, start
27836 Chk\SpecialChar TeX
27839 to check it, and then make \SpecialChar LyX
27841 \begin_inset Quotes eld
27845 \begin_inset Quotes erd
27848 with the warnings from
27850 Chk\SpecialChar TeX
27853 , if there were any.
27854 The warnings will be placed close to the point of the mistake, and you
27855 can quickly find them by using the
27857 Navigate\SpecialChar menuseparator
27860 menu item, or the shortcut key
27869 Open the error boxes by clicking on them with the mouse, or use the shortcut
27878 bindings, or the corresponding
27887 Read the warning and correct the mistake, if it is a mistake.
27888 If you have trouble understanding what the warning is about, you can safely
27890 Remember that there is a hidden layer between the document on screen and
27891 the technical details in invoking
27893 Chk\SpecialChar TeX
27896 , and this gap can make some warnings seem arcane or just plain silly.
27899 \begin_layout Standard
27900 This document is an excellent testing bed for the feature, and it should
27901 provide quite a few warnings for you to fiddle with.
27902 Since computers are only so smart, expect most of the warnings to be false
27906 \begin_layout Subsection
27907 How to fine tune it
27910 \begin_layout Standard
27911 Sometimes, you'll find that
27913 Chk\SpecialChar TeX
27916 makes more noise than suits your mood.
27917 Then you can choose not to use it, wait until your mood changes, or try
27920 Chk\SpecialChar TeX
27923 to get better along with you.
27926 \begin_layout Standard
27929 Chk\SpecialChar TeX
27936 very configurable and extensible, you should not expect to solve all problems
27939 Chk\SpecialChar TeX
27942 in \SpecialChar LyX
27944 Since \SpecialChar LyX
27945 has to generate a somewhat special \SpecialChar LaTeX
27946 file to be able to match the
27947 line numbers from the
27949 Chk\SpecialChar TeX
27956 \begin_layout Plain Layout
27957 You can inspect the specific output from
27963 Document\SpecialChar menuseparator
27966 \begin_inset space ~
27980 to the internal document structure, some of the warnings will not appear
27982 There are two things you can do about this:
27985 \begin_layout Itemize
27988 Chk\SpecialChar TeX
27991 invocation command line in
27992 \begin_inset Flex Noun
27995 \begin_layout Plain Layout
27996 Tools\SpecialChar menuseparator
27997 Preferences\SpecialChar menuseparator
27998 Output\SpecialChar menuseparator
27999 LaTeX\SpecialChar menuseparator
28007 Chk\SpecialChar TeX
28010 installation configuration file (usually with the file
28015 See below to learn what warnings can be enabled and disabled on the command
28019 \begin_layout Itemize
28020 Export your document as a raw \SpecialChar LaTeX
28023 File\SpecialChar menuseparator
28024 Export\SpecialChar menuseparator
28033 Invoked in this way, it can be a hassle to find the corresponding place
28034 in the document inside \SpecialChar LyX
28035 , but with a little patience, you should be able
28039 \begin_layout Standard
28040 Here follows the warning messages that can be enabled and disabled in
28049 to disable a warning, and
28053 to enable a warning.
28054 The emphasized entries are disabled by default, because the default is
28057 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
28062 \begin_layout Standard
28063 Notice that you should only use the options that enable and disable warnings,
28064 because \SpecialChar LyX
28065 relies on some of the other command line parameters to be set
28066 in a specific way to have a chance to communicate with
28073 \begin_layout Enumerate
28077 Command terminated with space.
28080 \begin_layout Enumerate
28083 Non-breaking space (
28084 \begin_inset Quotes eld
28092 \begin_inset Quotes erd
28095 ) should have been used.
28098 \begin_layout Enumerate
28102 You should enclose the previous parenthesis with
28103 \begin_inset Quotes eld
28111 \begin_inset Quotes erd
28117 \begin_layout Enumerate
28120 Italic correction (
28121 \begin_inset Quotes eld
28131 \begin_inset Quotes erd
28134 ) found in non-italic buffer.
28137 \begin_layout Enumerate
28140 Italic correction (
28141 \begin_inset Quotes eld
28151 \begin_inset Quotes erd
28154 ) found more than once.
28157 \begin_layout Enumerate
28161 No italic correction (
28162 \begin_inset Quotes eld
28172 \begin_inset Quotes erd
28178 \begin_layout Enumerate
28182 \begin_inset Quotes eld
28190 \begin_inset Quotes erd
28194 \begin_inset Quotes eld
28202 \begin_inset Quotes erd
28208 \begin_layout Enumerate
28211 Wrong length of dash may have been used.
28214 \begin_layout Enumerate
28218 \begin_inset Quotes eld
28226 \begin_inset Quotes erd
28230 \begin_inset Quotes eld
28238 \begin_inset Quotes erd
28244 \begin_layout Enumerate
28248 \begin_inset Quotes eld
28256 \begin_inset Quotes erd
28262 \begin_layout Enumerate
28266 \begin_inset Quotes eld
28274 \begin_inset Quotes erd
28277 to achieve an ellipsis.
28280 \begin_layout Enumerate
28283 Inter-word spacing (
28284 \begin_inset Quotes eld
28294 \begin_inset Quotes eld
28297 ) should perhaps be used.
28300 \begin_layout Enumerate
28303 Inter-sentence spacing (
28304 \begin_inset Quotes eld
28314 \begin_inset Quotes erd
28317 ) should perhaps be used.
28320 \begin_layout Enumerate
28323 Could not find argument for command.
28326 \begin_layout Enumerate
28330 \begin_inset Quotes eld
28338 \begin_inset Quotes erd
28344 \begin_layout Enumerate
28347 Math mode still on at end of \SpecialChar LaTeX
28351 \begin_layout Enumerate
28355 \begin_inset Quotes eld
28363 \begin_inset Quotes erd
28366 doesn't match the number of
28367 \begin_inset Quotes eld
28375 \begin_inset Quotes erd
28381 \begin_layout Enumerate
28384 You should use either
28387 \begin_inset Quotes eld
28395 \begin_inset Quotes erd
28400 as an alternative to
28401 \begin_inset Quotes eld
28409 \begin_inset Quotes erd
28415 \begin_layout Enumerate
28422 " (ASCII 39) instead of "
28429 \begin_layout Enumerate
28432 User-specified pattern found.
28435 \begin_layout Enumerate
28438 This command might not be intended.
28441 \begin_layout Enumerate
28448 \begin_layout Enumerate
28466 \begin_layout Enumerate
28469 Delete this space to maintain correct page references.
28472 \begin_layout Enumerate
28476 You might wish to put this between a pair of
28477 \begin_inset Quotes eld
28485 \begin_inset Quotes erd
28491 \begin_layout Enumerate
28494 You ought to remove spaces in front of punctuation.
28497 \begin_layout Enumerate
28500 Could not execute \SpecialChar LaTeX
28504 \begin_layout Enumerate
28513 in front of small punctuation.
28516 \begin_layout Enumerate
28524 may look prettier here.
28527 \begin_layout Enumerate
28531 Multiple spaces detected in output.
28534 \begin_layout Enumerate
28537 This text may be ignored.
28540 \begin_layout Enumerate
28546 \begin_inset Quotes eld
28551 to begin quotation, not
28558 \begin_layout Enumerate
28565 to end quotation, not
28568 \begin_inset Quotes eld
28576 \begin_layout Enumerate
28582 \begin_layout Enumerate
28585 You should perhaps use
28586 \begin_inset Quotes eld
28594 \begin_inset Quotes erd
28600 \begin_layout Enumerate
28603 You should put a space in front of/after parenthesis.
28606 \begin_layout Enumerate
28609 You should avoid spaces in front of/after parenthesis.
28612 \begin_layout Enumerate
28616 You should not use punctuation in front of/after quotes.
28619 \begin_layout Enumerate
28622 Double space found.
28625 \begin_layout Enumerate
28628 You should put punctuation outside inner/inside display math mode.
28631 \begin_layout Enumerate
28634 You ought to not use primitive \SpecialChar TeX
28635 in \SpecialChar LaTeX
28639 \begin_layout Enumerate
28642 You should remove spaces in front of
28643 \begin_inset Quotes eld
28651 \begin_inset Quotes erd
28657 \begin_layout Enumerate
28660 \begin_inset Quotes eld
28668 \begin_inset Quotes erd
28671 is normally not followed by
28672 \begin_inset Quotes eld
28680 \begin_inset Quotes erd
28686 \begin_layout Standard
28687 In later versions of \SpecialChar LyX
28688 , we hope to provide a more complete interface to this
28689 tool (and it's smaller cousin
28693 ) to exploit the full power of it.
28694 But it's not exactly useless as it is now: go try it on one of your existing
28695 documents of a certain length and be surprised.
28698 \begin_layout Section
28699 Version Control in \SpecialChar LyX
28703 \begin_layout Standard
28706 Lars Gullik Bjønnes
28713 \begin_layout Subsection
28717 \begin_layout Standard
28719 supports some of the most basic RCS/CVS/SVN/GIT commands.
28720 If you need something a bit more sophisticated you will have to do that
28721 manually in a terminal.
28724 \begin_layout Standard
28725 Also note that CVS support is not as good as subversion support, so we advise
28727 A good place to start learning Subversion is the SVN Book
28731 \begin_layout Plain Layout
28732 \begin_inset CommandInset href
28734 target "http://svnbook.red-bean.com/"
28745 In the case of RCS you should read
28746 \begin_inset Quotes eld
28750 \begin_inset Quotes erd
28753 (a man file, read it with
28758 This file describes all the basic features of RCS.
28759 You should especially notice the comment about a RCS directory, and the
28760 notion of a master RCS file (the file ending in
28767 \begin_layout Standard
28768 Before you begin to use the version control features in \SpecialChar LyX
28770 familiar with RCS/CVS/SVN/GIT usage.
28771 The implementation in \SpecialChar LyX
28772 assumes a recent version of the GNU RCS or CVS/SVN
28773 package — no guarantees are made for older versions.
28774 Most of the log messages are not currently displayed after operations —
28775 you can check them in the Messages pane if you are unsure.
28776 Regular users of version control will appreciate the VC toolbar, which
28779 View\SpecialChar menuseparator
28780 Toolbars\SpecialChar menuseparator
28782 \begin_inset space ~
28790 \begin_layout Standard
28791 For introducing your own external commands consult
28792 \begin_inset Flex Code
28795 \begin_layout Plain Layout
28809 \begin_layout Standard
28810 It is strongly recommended to store documents in uncompressed format if
28811 using version control (uncheck
28813 Document\SpecialChar menuseparator
28816 if it is checked): Uncompressed LyX documents are text files and therefore
28817 for merging two different versions by version control systems.
28818 Compressed LyX documents are binary files, which cannot be merged by version
28822 \begin_layout Subsection
28823 RCS commands in \SpecialChar LyX
28827 \begin_layout Standard
28828 The following sections describe the RCS commands supported by \SpecialChar LyX
28830 You can find them in the
28832 File\SpecialChar menuseparator
28834 \begin_inset space ~
28841 was tested against RCS 5.7/5.8.
28844 \begin_layout Subsubsection
28850 \begin_layout Standard
28851 If your document is not under revision control, this is the only item shown
28853 And if it is under revision control, the
28857 item is not visible.
28861 \begin_layout Standard
28862 This command registers your document with RCS (unless you are under the
28863 directory managed by CVS)\SpecialChar endofsentence
28864 You are asked interactively to supply an initial
28865 description of the document.
28866 The document is now set in Read-Only mode and you have to
28869 \begin_inset space ~
28873 \begin_inset space ~
28877 \begin_inset space ~
28882 , before making any changes to it.
28883 A document under revision control has a
28884 \begin_inset Quotes eld
28887 [RCS:<version> <locker>]
28888 \begin_inset Quotes erd
28891 item tagged to the filename in the minibuffer.
28894 \begin_layout Standard
28895 RCS command that is run:
28898 \begin_layout LyX-Code
28901 ci -q -u -i -t-"<initial description>" <file-name>
28904 \begin_layout Standard
28909 to understand the switches.
28913 \begin_layout Subsubsection
28919 \begin_layout Standard
28920 When you are finished editing a file, you check in your changes.
28921 When you do this, you are asked for a description of the changes.
28922 This is stored in the history log.
28923 The version number is bumped, your changes are applied to the master RCS
28924 file, the document is unlocked and set to Read-Only mode.
28927 \begin_layout Itemize
28930 ci -q -u -m"<description>" <file-name>
28933 \begin_layout Subsubsection
28939 \begin_layout Standard
28940 By doing this you lock the document so that only you can edit it.
28941 This will also make the document Read-Write only for you.
28942 You will usually continue editing for a while and when you are finished
28943 you check in your changes.
28944 The status line is changed to reflect that you have locked the file.
28947 \begin_layout Itemize
28950 co -q -l <file-name>
28953 \begin_layout Subsubsection
28956 Revert To Repository Version
28959 \begin_layout Standard
28960 This will discard all changes made to the document since the last check
28962 You get a warning before changes are discarded.
28965 \begin_layout Itemize
28968 co -f -u<version> <file-name>
28971 \begin_layout Subsubsection
28977 \begin_layout Standard
28978 This will create a copy of the current document.
28979 Since RCS does not support copy operations natively, the version history
28980 is not preserved, and the copy is added as a new file.
28981 It requires a clean document without any changes since the last checkin.
28982 You are asked for a file name and a description of the copy operation.
28983 After that the copy is created, both locally and in the repository.
28984 If the parent directories of the copied and original document differ, all
28985 relative paths of included files of the copy are adjusted (like in
28987 File\SpecialChar menuseparator
28992 Finally, the copy is loaded instead of the original document.
28995 \begin_layout Labeling
28996 \labelwidthstring 00.00.0000
28998 \begin_inset space ~
29002 \begin_inset space ~
29006 \begin_inset Newline newline
29010 \begin_inset Flex Code
29013 \begin_layout Plain Layout
29016 \begin_inset Quotes qld
29020 \begin_inset Quotes qld
29029 \begin_inset Flex Code
29032 \begin_layout Plain Layout
29035 \begin_inset Quotes qld
29039 \begin_inset Quotes qld
29048 \begin_inset Newline newline
29052 \begin_inset Flex Code
29055 \begin_layout Plain Layout
29059 \begin_inset Quotes qld
29063 \begin_inset Quotes qld
29074 \begin_layout Subsubsection
29080 \begin_layout Standard
29081 This makes as if the last check in never happened.
29082 No changes are made to the document loaded into \SpecialChar LyX
29083 , but the last version
29084 is removed from the master RCS file.
29087 \begin_layout Itemize
29090 rcs -o<version> <file-name>
29093 \begin_layout Subsubsection
29099 \begin_layout Standard
29100 This shows the complete history of the RCS document.
29105 is shown in a browser.
29113 \begin_layout Subsubsection
29117 \begin_layout Standard
29119 supports RCS version number, author name, date and time of last commit.
29120 All those are extracted from
29122 rlog -r <file-name>
29126 \begin_inset CommandInset ref
29128 reference "subsec:VCS-Revision-Information"
29135 \begin_layout Subsection
29136 CVS commands in \SpecialChar LyX
29140 \begin_layout Standard
29141 A subset of CVS operations is supported by \SpecialChar LyX
29143 You can find the commands in the
29145 File\SpecialChar menuseparator
29147 \begin_inset space ~
29153 The version control system SVN is more powerful, so please use it instead
29154 of CVS if possible.
29157 \begin_layout Subsubsection
29163 \begin_layout Standard
29164 If you start from scratch with CVS you have to create your repository and
29165 checkout the working copy with external tools.
29166 If you're using a client-server setup you may need to login before doing
29167 the first repository checkout.
29170 \begin_layout Standard
29171 If your documents are under revision control and others are using the same
29172 repository problems arise when different changes to the same document at
29173 the same location happen.
29174 Standard CVS repositories don't operate with a file locking mechanism.
29175 This may be surprising, but conflicts only occur if people disagree on
29176 the proper content of the same part of a document.
29177 So, if co-workers are used to communicate regularly, these conflicts occur
29179 If they don't communicate they have a fundamental problem anyway.
29180 Nevertheless some people like to work with so called
29181 \begin_inset Quotes eld
29185 \begin_inset Quotes erd
29189 If they do so the working copy of all files is readonly when checked out
29190 first and the user starts editing after using a special command to make
29191 the working copy writable.
29192 When the changes are checked in the working copy returns to readonly state.
29193 With \SpecialChar LyX
29194 one has to edit the
29195 \begin_inset Flex Code
29198 \begin_layout Plain Layout
29204 file and add the line
29205 \begin_inset Flex Code
29208 \begin_layout Plain Layout
29214 to work with reserved checkouts.
29215 The benefit is the possibility to see who is using a writable copy of some
29217 It's not guaranteed only one user makes a copy writable.
29220 \begin_layout Standard
29222 tries to guess if you're using reserved or non-reserved checkouts.
29223 If your working copy is readonly or it is writable and an additional copy
29224 of your document exists in the CVS/Base sub-directory a reserved otherwise
29225 a non-reserved checkout is assumed.
29226 When a reserved checkout is detected you have to use
29227 \begin_inset Flex Noun
29230 \begin_layout Plain Layout
29236 to make your working copy writable if it's readonly.
29238 \begin_inset Flex Noun
29241 \begin_layout Plain Layout
29247 operation is possible and that makes your working copy readonly again after
29248 transferring your changes to the repository.
29251 \begin_layout Standard
29252 More information about CVS can be found here
29253 \begin_inset Flex URL
29256 \begin_layout Plain Layout
29258 http://www.nongnu.org/cvs
29264 \begin_inset Flex URL
29267 \begin_layout Plain Layout
29269 http://ximbiot.com/cvs
29277 \begin_layout Standard
29282 to understand the sub-commands and the switches mentioned below.
29285 \begin_layout Subsubsection
29291 \begin_layout Standard
29292 If your document is not under revision control, this is the only item shown
29294 And if it is under revision control, the
29298 item is not visible.
29302 \begin_layout Standard
29303 This command registers in CVS your document
29304 \begin_inset Flex Strong
29307 \begin_layout Plain Layout
29315 in the case you have already the documents directory under CVS control
29321 This means you have to create or checkout the archive by yourself using
29323 (In case you forget that step \SpecialChar LyX
29324 registers the document with RCS.)
29327 \begin_layout Standard
29328 Then you are asked interactively to supply an initial description of the
29330 Don't forget that registered file is not yet checked in.
29333 \begin_layout Standard
29334 CVS command that is run:
29336 cvs -q add -m"<entered message>" "<file-name>"
29339 \begin_layout Standard
29344 above and for all other CVS commands is an abbreviation for
29345 \begin_inset Quotes eld
29348 change the current working directory to file location and use the file name
29349 without path component as argument
29350 \begin_inset Quotes erd
29356 \begin_layout Subsubsection
29362 \begin_layout Standard
29363 When you are finished editing a file, you commit your changes.
29364 When you do this and you had changed the document, you are asked for a
29365 description of the changes.
29366 After that changes are written to the repository.
29367 In case you didn't change the document and a reserved checkout is detected
29368 the reservation made on
29369 \begin_inset Flex Noun
29372 \begin_layout Plain Layout
29381 \begin_layout Labeling
29382 \labelwidthstring 00.00.0000
29384 \begin_inset space ~
29388 \begin_inset space ~
29392 \begin_inset Newline newline
29396 \begin_inset Flex Code
29399 \begin_layout Plain Layout
29402 -q commit -m"<description>" "<file-name>"
29408 \begin_inset Newline newline
29412 \begin_inset Flex Code
29415 \begin_layout Plain Layout
29426 \begin_layout Subsubsection
29432 \begin_layout Standard
29433 When you are sharing a repository with others, you may have to incorporate
29434 their changes into your working copy.
29437 \begin_layout Standard
29440 cvs -q update "<file-name>"
29443 \begin_layout Standard
29444 If a readonly checkout is detected the working copy is made writable and
29448 \begin_layout Standard
29451 cvs -q edit "<file-name>"
29454 \begin_layout Subsubsection
29457 Revert To Repository Version
29460 \begin_layout Standard
29461 This will discard all changes made to the document since the last check
29463 You get a warning before changes are discarded.
29464 Firstly the file is deleted, secondly CVS update command is run.
29467 \begin_layout Standard
29470 cvs -q update "<file-name>"
29473 \begin_layout Standard
29474 If a reserved checkout is detected and the working copy has no changes only
29475 the reservation is undone.
29478 \begin_layout Standard
29481 cvs -q unedit "<file-name>"
29484 \begin_layout Subsubsection
29490 \begin_layout Standard
29491 This will create a copy of the current document.
29492 Since CVS does not support copy operations natively, the version history
29493 is not preserved, and the copy is added as a new file.
29494 It requires a clean document without any changes since the last checkin.
29495 You are asked for a file name and a description of the copy operation.
29496 After that the copy is created, both locally and in the repository.
29497 If the parent directories of the copied and original document differ, all
29498 relative paths of included files of the copy are adjusted (like in
29500 File\SpecialChar menuseparator
29505 Finally, the copy is loaded instead of the original document.
29508 \begin_layout Labeling
29509 \labelwidthstring 00.00.0000
29511 \begin_inset space ~
29515 \begin_inset space ~
29519 \begin_inset Newline newline
29523 \begin_inset Flex Code
29526 \begin_layout Plain Layout
29533 \begin_inset Flex Code
29536 \begin_layout Plain Layout
29543 \begin_inset Newline newline
29547 \begin_inset Flex Code
29550 \begin_layout Plain Layout
29551 cvs -q add "<new-file-name>"
29559 \begin_layout Subsubsection
29565 \begin_layout Standard
29566 This will rename the current document.
29567 Since CVS does not support rename operations natively, the version history
29568 is not preserved, the renamed document is added as a new file, and the
29569 original document is deleted.
29570 It requires a clean document without any changes since the last checkin.
29571 You are asked for a file name and a description of the rename operation.
29572 After that the document is renamed, both locally and in the repository.
29573 If the parent directories of the new and old file names differ, all relative
29574 paths of included files are adjusted (like in
29576 File\SpecialChar menuseparator
29581 Finally, the document is reloaded using the new name.
29584 \begin_layout Labeling
29585 \labelwidthstring 00.00.0000
29587 \begin_inset space ~
29591 \begin_inset space ~
29595 \begin_inset Newline newline
29599 \begin_inset Flex Code
29602 \begin_layout Plain Layout
29609 \begin_inset Flex Code
29612 \begin_layout Plain Layout
29619 \begin_inset Newline newline
29623 \begin_inset Flex Code
29626 \begin_layout Plain Layout
29627 cvs -q add "<new-file-name>"
29633 \begin_inset Newline newline
29637 \begin_inset Flex Code
29640 \begin_layout Plain Layout
29641 cvs -q remove "<file-name>"
29649 \begin_layout Subsubsection
29650 Update of the local directory checkout from repository
29653 \begin_layout Standard
29654 Once your documents gets more complex, containing sub-documents and pictures,
29656 \begin_inset Flex Code
29659 \begin_layout Plain Layout
29665 files and so on using version control becomes more complicated.
29667 supports updating the whole tree in which resides the document.
29668 This become especially useful once you cooperate with people which neither
29669 have detailed knowledge about CVS usage nor they have ambition to commit
29670 additional material to the repository.
29671 You have to organize the files structure so that all external files are
29672 in the same directory or subdirectories of the document.
29673 It's good practice anyway to store multipart documents in an extra directory.
29676 \begin_layout Standard
29678 \begin_inset Flex Code
29681 \begin_layout Plain Layout
29682 Update local directory from repository
29687 command updates the whole directory.
29688 If local changes are detected user is warned before update starts.
29689 In case of merge conflicts both versions of the conflicting document parts
29690 are placed in the final document.
29691 You have to review and correct the result of the merge.
29692 You'll find the conflicts enclosed in pairs of
29693 \begin_inset Flex Code
29696 \begin_layout Plain Layout
29703 \begin_inset Flex Code
29706 \begin_layout Plain Layout
29713 \begin_inset Flex Code
29716 \begin_layout Plain Layout
29723 The first part is your version as before the update operation with the
29724 document name prepended.
29725 The second one is the repository version with the version number after
29727 \begin_inset Flex Code
29730 \begin_layout Plain Layout
29739 \begin_layout Labeling
29740 \labelwidthstring 00.00.0000
29742 \begin_inset space ~
29746 \begin_inset space ~
29750 \begin_inset Newline newline
29754 \begin_inset Flex Code
29757 \begin_layout Plain Layout
29765 (Ask if changes are detected.)
29766 \begin_inset Newline newline
29770 \begin_inset Flex Code
29773 \begin_layout Plain Layout
29774 cd $path; cvs -q update
29784 \begin_layout Standard
29786 \begin_inset Flex Code
29789 \begin_layout Plain Layout
29795 stands for the path to the document.
29798 \begin_layout Subsubsection
29804 \begin_layout Standard
29805 This shows the complete history of the CVS document.
29808 cvs log "<file-name>"
29810 is shown in a browser.
29813 \begin_layout Subsubsection
29817 \begin_layout Standard
29819 supports CVS version number, author name, date and time of last commit.
29820 All those are extracted from
29822 cvs log -r <file-name>
29826 \begin_inset CommandInset ref
29828 reference "subsec:VCS-Revision-Information"
29835 \begin_layout Subsection
29836 SVN commands in \SpecialChar LyX
29840 \begin_layout Standard
29841 SVN is now partially supported by \SpecialChar LyX
29843 You can find the commands in the
29845 File\SpecialChar menuseparator
29847 \begin_inset space ~
29853 Please note that if you use password protected access to repository via
29854 ssh, you will be asked in terminal window.
29856 was tested against SVN 1.5, 1.6, 1.7 and 1.8
29860 \begin_layout Plain Layout
29861 Most of the commands will work with 1.4 too, see
29862 \begin_inset CommandInset ref
29864 reference "subsec:SVN-Repo-Update"
29869 There seems to be currently unresolved permissions problem under SVN 1.8
29870 with reverting changes when file is locked.
29878 \begin_layout Subsubsection
29884 \begin_layout Standard
29885 If your document is not under revision control, this is the only item shown
29887 And if it is under revision control, the
29891 item is not visible.
29894 \begin_layout Standard
29895 This command registers in SVN your document ONLY in case you have already
29896 the documents directory under SVN control (in particular
29901 This means you have to checkout the archive by yourself.
29904 \begin_layout Standard
29905 Then you are asked interactively to supply an initial description of the
29907 Don't forget that registered file is not yet commited.
29910 \begin_layout Standard
29911 SVN command that is run:
29914 \begin_inset Quotes qld
29918 \begin_inset Quotes qld
29924 \begin_layout Standard
29929 to understand the switches.
29932 \begin_layout Subsubsection
29938 \begin_layout Standard
29939 When you are finished editing a file, you commit your changes.
29940 When you do this, you are asked for a description of the changes.
29941 After that changes are commited.
29944 \begin_layout Standard
29949 \begin_layout Plain Layout
29950 In case locking is not enabled.
29952 \begin_inset CommandInset ref
29954 reference "subsec:SVN-File-Locking"
29965 svn commit -q -m"<description>" <file-name>
29968 \begin_layout Subsubsection
29974 \begin_layout Standard
29975 Updates the changes of this file from the repository.
29976 Be sure you understand SVN merging and conflicts resolving before using
29977 this function, because all conflicts has to be resolved manually by you!
29980 \begin_layout Standard
29985 \begin_layout Plain Layout
29993 svn update --non-interactive
29994 \begin_inset Quotes qld
29998 \begin_inset Quotes qld
30004 \begin_layout Subsubsection
30007 Revert To Repository Version
30010 \begin_layout Standard
30011 This will discard all changes made to the document since the last check
30013 You get a warning before changes are discarded.
30016 \begin_layout Standard
30020 \begin_inset Quotes qld
30024 \begin_inset Quotes qld
30030 \begin_layout Subsubsection
30036 \begin_layout Standard
30037 This will create a copy of the current document including the version history.
30038 It requires a clean document without any changes since the last checkin.
30039 You are asked for a file name and a description of the copy operation.
30040 After that the copy is created, both locally and in the repository.
30041 If the parent directories of the copied and original document differ, all
30042 relative paths of included files of the copy are adjusted (like in
30044 File\SpecialChar menuseparator
30049 Finally, the copy is loaded instead of the original document.
30052 \begin_layout Labeling
30053 \labelwidthstring 00.00.0000
30055 \begin_inset space ~
30059 \begin_inset space ~
30063 \begin_inset Newline newline
30067 \begin_inset Flex Code
30070 \begin_layout Plain Layout
30074 \begin_inset Quotes qld
30078 \begin_inset Quotes qld
30082 \begin_inset Quotes qld
30086 \begin_inset Quotes qld
30095 \begin_inset Newline newline
30099 \begin_inset Flex Code
30102 \begin_layout Plain Layout
30111 \begin_layout Subsubsection
30117 \begin_layout Standard
30118 This will rename the current document including the version history.
30119 It requires a clean document without any changes since the last checkin.
30120 You are asked for a file name and a description of the rename operation.
30121 After that the document is renamed, both locally and in the repository.
30122 If the parent directories of the new and old file names differ, all relative
30123 paths of included files are adjusted (like in
30125 File\SpecialChar menuseparator
30130 Finally, the document is reloaded using the new name.
30133 \begin_layout Labeling
30134 \labelwidthstring 00.00.0000
30136 \begin_inset space ~
30140 \begin_inset space ~
30144 \begin_inset Newline newline
30148 \begin_inset Flex Code
30151 \begin_layout Plain Layout
30155 \begin_inset Quotes qld
30159 \begin_inset Quotes qld
30163 \begin_inset Quotes qld
30167 \begin_inset Quotes qld
30176 \begin_inset Newline newline
30180 \begin_inset Flex Code
30183 \begin_layout Plain Layout
30192 \begin_layout Subsubsection
30193 \begin_inset CommandInset label
30195 name "subsec:SVN-Repo-Update"
30199 Update of the local directory checkout from repository
30203 \begin_layout Plain Layout
30204 Note that this command will work only with subversion
30205 \begin_inset Formula $\geqq1.5$
30216 \begin_layout Standard
30217 All the commands above have one shortcoming – they deal with the current
30219 Once your document contains pictures, includes external
30220 \begin_inset Flex Code
30223 \begin_layout Plain Layout
30229 files and so on administration becomes more complicated.
30231 now supports updating the whole tree in which resides the document
30235 \begin_layout Plain Layout
30236 One need to organize the files structure so that all external files are
30237 in the same directory or subdirectories of the document.
30244 This become especially useful once you cooperate with people which neither
30245 know about subversion management nor they have ambition to commit additional
30246 material to the repository.
30250 \begin_layout Standard
30251 \begin_inset Flex Code
30254 \begin_layout Plain Layout
30255 Update local directory from repository
30260 command updates the whole directory and in case of merge conflicts local
30261 version of the files are left, so no unintended data loss occurs.
30262 If local changes are detected user is warned before update starts.
30265 \begin_layout Labeling
30266 \labelwidthstring 00.00.0000
30268 \begin_inset space ~
30272 \begin_inset space ~
30276 \begin_inset Newline newline
30280 \begin_inset Flex Code
30283 \begin_layout Plain Layout
30289 (Ask if changes are detected.)
30290 \begin_inset Newline newline
30294 \begin_inset Flex Code
30297 \begin_layout Plain Layout
30298 svn update --accept mine-full $path
30306 \begin_layout Standard
30308 \begin_inset Flex Code
30311 \begin_layout Plain Layout
30317 stands for the path to the document.
30320 \begin_layout Subsubsection
30326 \begin_layout Standard
30327 This shows the complete history of the SVN document.
30331 \begin_inset Quotes qld
30335 \begin_inset Quotes qld
30340 is shown in a browser.
30343 \begin_layout Subsubsection
30345 \begin_inset CommandInset label
30347 name "subsec:SVN-File-Locking"
30354 \begin_layout Standard
30355 The file exchange through various revision control systems brings the problem
30356 of merge conflicts in case two different users try to edit the same (parts
30358 When such a conflict happens it needs manual resolving and one reasonable
30359 alternative is to provide some kind of locking mechanism, which guarantees
30360 that only one user is allowed to edit file at the given time.
30363 \begin_layout Standard
30364 SVN has two such mechanisms to provide mutual exclusivity for file access
30365 – locks and automatic setting of write permissions (see sec.
30367 \begin_inset CommandInset ref
30369 reference "subsec:Automatical-Locking-Property"
30374 \begin_inset Flex Code
30377 \begin_layout Plain Layout
30387 \begin_layout Plain Layout
30388 \begin_inset Flex URL
30391 \begin_layout Plain Layout
30393 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
30404 If this property is detected for a given document \SpecialChar LyX
30405 starts to use SVN locks
30406 for document editing automatically and the whole check-in/out mechanism
30407 switches to the same regimen as for RCS.
30408 This in particular means there are two different modes of file use in \SpecialChar LyX
30412 \begin_layout Itemize
30414 The loaded file is in the read-only mode.
30415 For editing on needs to check-out.
30420 consists of updating from the repository and gaining write lock.
30421 If the lock is not possible to obtain, we remain in unlocked state.
30424 \begin_layout Itemize
30426 The loaded file is in the
30427 \begin_inset Quotes els
30431 \begin_inset Quotes ers
30435 No other user is allowed to edit the file.
30440 consists of commiting changes and releasing write-lock.
30441 If no changes have been made to the document, no commit will be produced
30445 \begin_layout Plain Layout
30446 Don't be puzzled by the fact that you will be asked for commit message anyway.
30451 and only the write-lock will be released.
30454 \begin_layout Standard
30458 \begin_layout Labeling
30459 \labelwidthstring 00.00.0000
30462 svn commit -q -m"<description>" "<file-name>"
30463 \begin_inset Newline newline
30466 svn unlock "<file-name>"
30469 \begin_layout Labeling
30470 \labelwidthstring 00.00.0000
30473 svn update "<file-name>"
30474 \begin_inset Newline newline
30477 svn lock "<file-name>"
30480 \begin_layout Subsubsection
30483 \begin_inset CommandInset label
30485 name "subsec:Automatical-Locking-Property"
30491 Automatic Locking Property
30494 \begin_layout Standard
30495 The above mentioned automatic setting of write permissions of the .lyx file
30498 File\SpecialChar menuseparator
30500 \begin_inset space ~
30503 Control\SpecialChar menuseparator
30504 Use Locking Property
30507 This command is active only when the file is not locked on the svn server
30509 you need to check-out before proceeding).
30512 \begin_layout Labeling
30513 \labelwidthstring 00.00.0000
30515 \begin_inset space ~
30521 \begin_layout Labeling
30522 \labelwidthstring 00.00.0000
30525 svn propset svn:needs-lock ON "<file-name>"
30528 \begin_layout Labeling
30529 \labelwidthstring 00.00.0000
30532 svn propdel svn:needs-lock "<file-name>"
30535 \begin_layout Subsubsection
30536 \begin_inset CommandInset label
30538 name "subsec:VCS-Revision-Information"
30542 Revision Information in Documents
30545 \begin_layout Standard
30546 There are more possibilities how to activate revision information in our
30550 \begin_layout Itemize
30556 \begin_layout Itemize
30557 tree revision information (
30558 \begin_inset Flex Code
30561 \begin_layout Plain Layout
30568 The result is the output of the
30569 \begin_inset Flex Code
30572 \begin_layout Plain Layout
30578 command, the following table gives you an idea, how to read the results.
30581 \begin_layout Standard
30583 \begin_inset Tabular
30584 <lyxtabular version="3" rows="6" columns="2">
30585 <features tabularvalignment="middle">
30586 <column alignment="left" valignment="top">
30587 <column alignment="left" valignment="top">
30589 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
30592 \begin_layout Plain Layout
30600 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
30603 \begin_layout Plain Layout
30613 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
30616 \begin_layout Plain Layout
30622 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
30625 \begin_layout Plain Layout
30626 mixed revision working copy
30633 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
30636 \begin_layout Plain Layout
30642 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
30645 \begin_layout Plain Layout
30646 modified working copy
30653 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
30656 \begin_layout Plain Layout
30662 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
30665 \begin_layout Plain Layout
30666 switched working copy
30673 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
30676 \begin_layout Plain Layout
30682 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
30685 \begin_layout Plain Layout
30686 partial working copy, from a sparse checkout
30693 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
30696 \begin_layout Plain Layout
30702 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
30705 \begin_layout Plain Layout
30706 mixed revision, modified, switched working copy
30719 \begin_layout Itemize
30720 file revision information.
30721 The result comes from parsing the output of
30722 \begin_inset Flex Code
30725 \begin_layout Plain Layout
30727 \begin_inset space ~
30731 \begin_inset space ~
30735 \begin_inset space ~
30744 Supported flags are:
30748 \begin_layout Itemize
30749 version number of the last commit (
30750 \begin_inset Flex Code
30753 \begin_layout Plain Layout
30762 \begin_layout Itemize
30763 author of the last commit (
30764 \begin_inset Flex Code
30767 \begin_layout Plain Layout
30776 \begin_layout Itemize
30777 date of the last commit (
30778 \begin_inset Flex Code
30781 \begin_layout Plain Layout
30790 \begin_layout Itemize
30791 time of the last commit (
30792 \begin_inset Flex Code
30795 \begin_layout Plain Layout
30805 \begin_layout Standard
30806 You can obtain this info via InsetInfo (
30807 \change_inserted 5863208 1564400022
30810 Insert\SpecialChar menuseparator
30811 Field\SpecialChar menuseparator
30812 Version Control Revision
30813 \change_deleted 5863208 1564399852
30818 \begin_inset Flex Code
30821 \begin_layout Plain Layout
30822 info-insert buffer vcs-date
30830 The information will be available only when you have the file stored under
30831 svn managment (i.e.
30833 \begin_inset Flex Code
30836 \begin_layout Plain Layout
30842 directory is available with your document).
30846 \begin_layout Itemize
30847 Another—a hacking one—possibility is to use svn keywords
30851 \begin_layout Plain Layout
30852 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
30858 In short – you set file keywords property (e.g.
30861 svn propset svn:keywords 'Rev' file.lyx
30863 ) and then paste keyword \SpecialChar TeX
30868 \begin_layout Plain Layout
30869 This is an easy way how to ensure that \SpecialChar LyX
30870 won't break the line in the middle
30876 tag in your document (e.g.
30878 \begin_inset Flex Code
30881 \begin_layout Plain Layout
30888 This way svn client will automatically substitute revision number (e.g.
30890 \begin_inset Flex Code
30893 \begin_layout Plain Layout
30899 ) after each update and commit.
30900 There are more problems with this approach.
30901 Firstly, the '$' character is used in \SpecialChar TeX
30902 world for math equations, so any
30903 occurence of math formula
30904 \begin_inset Formula $Rev$
30908 \begin_inset Formula $Rev:59$
30911 in your \SpecialChar LyX
30913 Similarly for other keywords like Id, Date, Author, etc.
30914 Secondly svn output is dependent on your locales, so its very easy that
30915 svn would produce some problematic strings once Date is used.
30916 Thirdly you get the whole 'Rev: 59' string in your document instead of
30918 Until subversion implements user's custom keywords it will be hard to use
30919 this approach reliably or let \SpecialChar LyX
30920 to support it directly.
30923 \begin_layout Subsection
30924 SVN and Windows Environment
30927 \begin_layout Quote
30928 My inclination is to say that if the user cannot figure out the command
30929 line operations on their own fairly quickly, they would be well advised
30930 to use TortoiseSVN.
30936 \begin_layout Subsubsection
30940 \begin_layout Standard
30941 In addition to installing \SpecialChar LyX
30942 , and having access to a Subversion repository,
30943 the user will need to install the Subversion client program.
30944 A Windows installer for the client program is available from
30945 \begin_inset CommandInset href
30948 target "http://www.collab.net/nonav/downloads/subversion/"
30954 The user may also want to install
30955 \begin_inset CommandInset href
30958 target "http://tortoisesvn.tigris.org/"
30963 , which integrates Subversion operations into the context (rightclick) menu
30964 of Windows Explorer.
30965 Operations done outside \SpecialChar LyX
30966 will typically be more convenient using the Explorer
30968 Note that TortoiseSVN is not a replacement for the client program, which
30969 is what \SpecialChar LyX
30973 \begin_layout Subsubsection
30974 Bringing a document under Subversion control
30977 \begin_layout Standard
30978 Before a \SpecialChar LyX
30979 document can be brought under version control in Subversion, its
30980 parent directory needs to be under version control.
30981 If the document is being added to a project already in the repository,
30982 this is accomplished by checking the project out to the directory where
30983 the new document will be placed.
30984 If the project itself is not yet under version control (for instance, if
30985 this document starts a new project), the directory must be imported into
30987 This is done outside \SpecialChar LyX
30989 Both import and checkout are easily accomplished from the Explorer context
30990 menu using TortoiseSVN, or alternatively can be done using the command
30991 line client at a DOS prompt.
30992 The procedure for importing the project using TortoiseSVN is described
30993 below, assuming an existing repository and a new project being started
31001 For information on using the Subversion client program, run
31008 \begin_layout Enumerate
31015 in Windows Explorer, right click it, and select
31017 TortoiseSVN\SpecialChar menuseparator
31021 If necessary, adjust the URL for the repository, then click OK.
31024 \begin_layout Enumerate
31025 Right click the level of the repository under which you want to place the
31026 new project folder (typically the top level) and click
31030 Supply a name for the project folder and click OK.
31031 Add a message for the log file if desired, then click OK again.
31032 The new project folder should appear in the repository.
31033 Finally, click OK again to exit the repository browser.
31036 \begin_layout Enumerate
31037 Once again right click
31043 , this time selecting SVN Checkout\SpecialChar ldots
31044 Select the URL of the project folder
31045 you just created in the repository, and set the checkout directory to
31053 You will be warned about a non-empty folder; click OK to proceed.
31054 You should now have a
31065 \begin_layout Enumerate
31066 Create or open your document in \SpecialChar LyX
31069 File\SpecialChar menuseparator
31071 \begin_inset space ~
31074 Control\SpecialChar menuseparator
31078 Add a log message and click OK to commit the document to version control.
31081 \begin_layout Standard
31082 From this point onward, you should have full functionality in the
31084 File\SpecialChar menuseparator
31086 \begin_inset space ~
31092 You also have the option of checking the document in and out, viewing its
31094 using the TortoiseSVN context menu in Windows Explorer or the Subversion
31095 client program from a command prompt.
31098 \begin_layout Subsubsection
31099 SSH tunnel used with SVN under Windows
31102 \begin_layout Standard
31103 Compared with Linux setting up an svn client to communicate over ssh under
31104 Windows is a rather troublesome task.
31105 We will at least offer some hints how to setup the client side but prior
31106 knowledge about ssh and the Windows command line is needed, also be prepared
31107 for a great deal of frustration\SpecialChar ldots
31111 \begin_layout Enumerate
31112 Get an svn client for windows, as described in the previous sections.
31113 When it is a fresh install run some svn command (e.g.
31115 \begin_inset Flex Code
31118 \begin_layout Plain Layout
31124 ) to create config files, which you will need to change later on.
31127 \begin_layout Enumerate
31128 Choose an ssh client for Windows.
31129 There are several possibilities, we will use the one from Putty tools
31133 \begin_layout Plain Layout
31134 \begin_inset Flex URL
31137 \begin_layout Plain Layout
31139 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
31150 You will need to set the connection up so that the client doesn't ask for
31151 any password from you.
31152 To keep things easy we will use only keys without any additional password
31157 \begin_layout Enumerate
31159 \begin_inset Flex Code
31162 \begin_layout Plain Layout
31169 Save your private .ppk key file and put the public one on the server side.
31170 If the SVN server runs on Linux, note that the format of the public key
31171 is not compatible with Linux openssh and you will need to direcly copy-paste
31173 \begin_inset Quotes eld
31178 Public key for pasting into OpenSSH authorized_keys file
31181 \begin_inset Quotes erd
31184 edit field into the server's
31185 \begin_inset Flex Code
31188 \begin_layout Plain Layout
31189 ~/.ssh/authorized_keys
31195 \begin_inset Flex Code
31198 \begin_layout Plain Layout
31207 \begin_layout Enumerate
31209 \begin_inset Flex Code
31212 \begin_layout Plain Layout
31219 In the SVN config file
31223 \begin_layout Plain Layout
31224 Exact path depends on Windows version, usually somewhere around
31225 \begin_inset Flex Code
31228 \begin_layout Plain Layout
31231 Documents and Settings
31245 \begin_inset Flex Code
31248 \begin_layout Plain Layout
31263 , section [tunnels], setup ssh command, e.g.
31265 \begin_inset Flex Code
31268 \begin_layout Plain Layout
31269 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
31278 \begin_layout Plain Layout
31279 It will usually take a lot of time to get exact command right and it depends
31281 For example do not have some remote server saved as a default session in
31283 If things fail, try to connect via plink without SVN first.
31292 \begin_layout Enumerate
31293 Checkout the SVN archive, e.
31294 \begin_inset space \thinspace{}
31298 \begin_inset Newline newline
31302 \begin_inset Flex Code
31305 \begin_layout Plain Layout
31306 svn co svn+ssh://user@server/repository_path
31314 \begin_layout Subsubsection
31315 End-of-Line Conversions
31318 \begin_layout Standard
31319 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
31321 use different line endings inside the .lyx files.
31322 This is not a problem as far as \SpecialChar LyX
31323 functionality is concerned, but the commit
31324 diffs will be huge and merge-conflicts prone.
31325 Fortunately SVN itself knows
31329 \begin_layout Plain Layout
31330 \begin_inset Flex URL
31333 \begin_layout Plain Layout
31335 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
31345 how to deal with CR/LF problems when switching .lyx files to the
31346 \begin_inset Flex Code
31349 \begin_layout Plain Layout
31359 \begin_layout Plain Layout
31361 \begin_inset Flex Code
31364 \begin_layout Plain Layout
31365 svn propset svn:eol-style native FILE_NAME
31378 \begin_layout Subsection
31379 GIT commands in \SpecialChar LyX
31383 \begin_layout Standard
31384 A minimal subset of GIT commands is now supported by \SpecialChar LyX
31386 You can find the commands in the
31388 File\SpecialChar menuseparator
31390 \begin_inset space ~
31396 Please note that if you use password protected access to repository via
31397 ssh, you will be asked in terminal window.
31399 was tested against GIT 1.7.
31403 \begin_layout Plain Layout
31404 Windows users please note that you need to ensure that git is on the path.
31405 This can be set from within \SpecialChar LyX
31408 Tools\SpecialChar menuseparator
31409 Preferences\SpecialChar menuseparator
31410 Paths\SpecialChar menuseparator
31421 \begin_layout Standard
31422 One big difference of GIT and the other supported version control systems
31423 is the distributed nature of GIT: With traditional version control systems
31424 there is one central server which hosts the repository.
31425 Users commit their changes to the server, and get updates made by other
31427 With GIT, users commit to a local repository.
31428 The local repository can be synchronized with one or more remote repositories
31430 \begin_inset Flex Code
31433 \begin_layout Plain Layout
31440 \begin_inset Flex Code
31443 \begin_layout Plain Layout
31451 does not interact in any way with remote GIT repositories.
31452 It works exclusively with the local repository in a very similar way as
31453 with a central CVS or SVN repository.
31454 If you use remote GIT repositories you need to do the
31455 \begin_inset Flex Code
31458 \begin_layout Plain Layout
31465 \begin_inset Flex Code
31468 \begin_layout Plain Layout
31474 operations with your favourite GIT client.
31477 \begin_layout Subsubsection
31483 \begin_layout Standard
31484 If your document is not under revision control, this is the only item shown
31486 And if it is under revision control, the
31490 item is not visible.
31493 \begin_layout Standard
31494 This command registers in GIT your document ONLY in case you have already
31495 the documents directory under GIT control (in particular
31500 This means you have to checkout the archive by yourself.
31503 \begin_layout Standard
31504 Then you are asked interactively to supply an initial description of the
31506 Don't forget that registered file is not yet committed.
31509 \begin_layout Standard
31510 GIT command that is run:
31513 \begin_inset Quotes qld
31517 \begin_inset Quotes qld
31523 \begin_layout Standard
31528 to understand the switches.
31531 \begin_layout Subsubsection
31537 \begin_layout Standard
31538 When you are finished editing a file, you commit your changes.
31539 When you do this, you are asked for a description of the changes.
31540 After that changes are committed.
31543 \begin_layout Standard
31546 git commit -q -m"<description>" <file-name>
31549 \begin_layout Subsubsection
31552 Revert To Repository Version
31555 \begin_layout Standard
31556 This will discard all changes made to the document since the last check
31558 You get a warning before changes are discarded.
31561 \begin_layout Standard
31565 \begin_inset Quotes qld
31569 \begin_inset Quotes qld
31575 \begin_layout Subsubsection
31581 \begin_layout Standard
31582 This will rename the current document including the version history.
31583 It requires a clean document without any changes since the last checkin.
31584 You are asked for a file name and a description of the rename operation.
31585 After that the document is renamed, both locally and in the repository.
31586 If the parent directories of the new and old file names differ, all relative
31587 paths of included files are adjusted (like in
31589 File\SpecialChar menuseparator
31594 Finally, the document is reloaded using the new name.
31597 \begin_layout Labeling
31598 \labelwidthstring 00.00.0000
31600 \begin_inset space ~
31604 \begin_inset space ~
31608 \begin_inset Newline newline
31612 \begin_inset Flex Code
31615 \begin_layout Plain Layout
31619 \begin_inset Quotes qld
31623 \begin_inset Quotes qld
31627 \begin_inset Quotes qld
31631 \begin_inset Quotes qld
31640 \begin_inset Newline newline
31644 \begin_inset Flex Code
31647 \begin_layout Plain Layout
31656 \begin_layout Subsubsection
31662 \begin_layout Standard
31663 This shows the complete history of the GIT document.
31667 \begin_inset Quotes qld
31671 \begin_inset Quotes qld
31676 is shown in a browser.
31679 \begin_layout Subsubsection
31683 \begin_layout Standard
31685 supports GIT hash number of the last commit to the file,
31686 \change_inserted 1119979965 1564297456
31687 its abbreviated form,
31689 author name, date and time of last commit.
31690 All those are extracted from
31692 git log -n 1 --pretty=format:%H%n
31693 \change_inserted 1119979965 1564297427
31699 Tree version information is obtained via
31701 git describe --abbrev --dirty --long
31705 \begin_inset CommandInset ref
31707 reference "subsec:VCS-Revision-Information"
31714 \begin_layout Subsection
31718 \begin_layout Standard
31719 With the recent addition of the
31720 \begin_inset Flex Code
31723 \begin_layout Plain Layout
31729 function \SpecialChar LyX
31730 power users are allowed to create their own commands for revision
31734 \begin_layout Standard
31735 As an example you can see how two TortoiseSVN commands could be integrated
31739 \begin_layout Description
31741 \begin_inset Flex Code
31744 \begin_layout Plain Layout
31745 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
31753 \begin_layout Description
31755 \begin_inset Flex Code
31758 \begin_layout Plain Layout
31759 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
31767 \begin_layout Subsection
31768 Version control and Document comparison
31771 \begin_layout Standard
31772 One of the typical uses of version control is to inspect the changes between
31773 revisions, usually by creating
31774 \begin_inset Flex Code
31777 \begin_layout Plain Layout
31784 While this is useful for plain text files, it is much less useful in the
31785 case of \SpecialChar LyX
31786 files, which have more a complicated structure.
31787 Hence we provide binding to the Document comparison feature.
31788 There are two ways of calling this feature – either by direct call of
31789 \begin_inset Flex Code
31792 \begin_layout Plain Layout
31799 function (for details see \SpecialChar LyX
31800 functions manual) or by the toolbar icon
31813 One can either compare two chosen revisions of the document or he can simply
31814 compare the current version of edited text with older revisions (where
31816 \begin_inset Flex Noun
31819 \begin_layout Plain Layout
31825 ' revisions back means comparison of the edited file with last commited
31830 \begin_layout Standard
31831 This feature is supported for SVN and RCS though due to the more complicated
31832 versioning scheme of RCS there is a constraint – when addressing the revisions
31833 in dialog, numbers always point to the last number in RCS revision number,
31836 We don't currently support GIT addressing of revisions, one can just compare
31837 edited document with its revision X steps backs, where X is addressed as
31839 \begin_inset Flex Code
31842 \begin_layout Plain Layout
31851 \begin_layout Section
31853 \change_inserted 564990737 1672161575
31854 \begin_inset CommandInset label
31856 name "sec:Literate-Programming"
31862 Literate Programming
31865 \begin_layout Standard
31870 (kayvan@sylvan.com)
31874 original documentation written by
31876 Edmar Wienskoski Jr.
31879 (edmar-w-jr@technologist.com)
31882 \begin_layout Subsection
31886 \begin_layout Standard
31887 The main purpose of this documentation is to show you how to use \SpecialChar LyX
31889 programming, where it is assumed that you are familiar with this programming
31890 technique, and know what
31891 \begin_inset Quotes eld
31895 \begin_inset Quotes erd
31899 \begin_inset Quotes eld
31903 \begin_inset Quotes erd
31907 If that is not the case, please follow the web links provided in the following
31909 There is a lot of good documentation out there covering old development
31910 history to the latest tools tips.
31913 \begin_layout Standard
31914 It is also assumed that you are familiar with \SpecialChar LyX
31915 itself to a point that you
31916 are comfortable changing your \SpecialChar LyX
31917 preferences, and X resources file.
31918 If that is not the case please refer to other \SpecialChar LyX
31919 documentation to cover your
31923 \begin_layout Subsection
31924 Literate Programming
31927 \begin_layout Standard
31928 From the Literate Programming FAQ:
31931 \begin_layout Quotation
31932 Literate programming is the combination of documentation and source together
31933 in a fashion suited for reading by human beings.
31934 In fact, literate programs should be enjoyable reading, even inviting!
31935 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
31936 and documentation in a single file.
31937 Literate programming tools then parse the file to produce either readable
31938 documentation or compilable source.
31939 The WEB style of literate programming was created by D.
31940 \begin_inset space \thinspace{}
31944 Knuth during the development of his \SpecialChar TeX
31945 typesetting software.
31949 \begin_layout Standard
31950 Another excerpt says:
31953 \begin_layout Quotation
31956 How is literate programming different from verbose commenting?
31959 \begin_layout Quotation
31960 There are three distinguishing characteristics.
31961 In order of importance, they are:
31965 \begin_layout Itemize
31966 flexible order of elaboration
31969 \begin_layout Itemize
31970 automatic support for browsing
31973 \begin_layout Itemize
31974 typeset documentation, especially diagrams and mathematics
31978 \begin_layout Standard
31979 Now that I sparked your curiosity, take a look in the references.
31982 \begin_layout Subsubsection
31986 \begin_layout Standard
31987 The complete Literate Programming FAQ can be found at:
31990 \begin_layout Quote
31991 Literate Programming FAQ
31992 \begin_inset Flex URL
31995 \begin_layout Plain Layout
31997 http://www.literateprogramming.com/lpfaq.pdf
32005 \begin_layout Standard
32006 The FAQ lists 23 (twenty three!) different literate programming tools.
32007 Where some are specialized or
32008 \begin_inset Quotes eld
32012 \begin_inset Quotes erd
32015 for particular programming languages, while other have general scope.
32020 for my own use for several reasons:
32023 \begin_layout Itemize
32024 It can generate the documentation either in \SpecialChar LaTeX
32028 \begin_layout Itemize
32029 It has a open architecture, i.
32030 \begin_inset space \thinspace{}
32034 \begin_inset space \space{}
32037 it is easy to plug in new filters
32041 \begin_layout Plain Layout
32046 are programs that read a given data stream and output a manipulated data
32048 That way, a WEB file (consisting of literate code) can be turned into a
32049 file consisting only of C program code or \SpecialChar LaTeX
32055 and to perform special processing that you may need.
32059 \begin_layout Itemize
32060 There is a good selection of filters available already (the HTML is one
32064 \begin_layout Itemize
32068 \begin_layout Standard
32069 The Noweb web page can be found at:
32072 \begin_layout Quote
32074 \begin_inset Flex URL
32077 \begin_layout Plain Layout
32079 https://www.cs.tufts.edu/~nr/noweb/
32087 \begin_layout Standard
32088 Starting from there you can reach many other interesting links and even
32089 some literate program examples.
32092 \begin_layout Subsection
32094 and Literate Programming with Noweb
32097 \begin_layout Standard
32098 The \SpecialChar LyX
32099 support for Literate Programming is provided by using the generic \SpecialChar LyX
32101 converters mechanism.
32102 This support is provided in a
32103 \begin_inset Quotes eld
32107 \begin_inset Quotes erd
32111 \begin_inset space \thinspace{}
32115 \begin_inset space \space{}
32118 you will be able to use this new \SpecialChar LyX
32119 feature with some other literate programming
32120 tool of your choice by just changing your \SpecialChar LyX
32124 \begin_layout Subsubsection
32125 Generating documents and code (weaving and tangling)
32128 \begin_layout Paragraph
32129 Using the noweb module
32132 \begin_layout Standard
32133 If you have installed Noweb and \SpecialChar LyX
32134 successfully, whenever you open a new document,
32135 after you have chosen its document class, use the
32137 Document\SpecialChar menuseparator
32141 \begin_inset Quotes eld
32145 \begin_inset Quotes erd
32149 If Noweb is correctly installed, when you click on the
32150 \begin_inset Quotes eld
32154 \begin_inset Quotes erd
32157 link, you will see the
32158 \begin_inset Quotes eld
32162 \begin_inset Quotes erd
32165 module in the available list and you can add it to your document.
32168 \begin_layout Paragraph
32172 \begin_layout Standard
32174 enables you to write code with a custom inset named
32175 \begin_inset Flex Noun
32178 \begin_layout Plain Layout
32185 Noweb delimits chunks like this:
32188 \begin_layout LyX-Code
32192 \begin_layout LyX-Code
32196 \begin_layout LyX-Code
32200 \begin_layout LyX-Code
32204 \begin_layout LyX-Code
32208 \begin_layout Standard
32209 The problem is that whatever is written in between the << and the
32213 must be taken literally, i.
32214 \begin_inset space \thinspace{}
32218 \begin_inset space \space{}
32222 should be prevented from making any special interpretation of what has
32224 This is also handled by
32225 \begin_inset Flex Noun
32228 \begin_layout Plain Layout
32234 , that works like a normal text inset but has a free spacing capability.
32237 \begin_layout Standard
32238 As a special note, you can also use the
32239 \begin_inset Quotes eld
32243 \begin_inset Quotes erd
32246 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
32250 \begin_layout LyX-Code
32254 \begin_layout LyX-Code
32255 def some_function(args):
32258 \begin_layout LyX-Code
32259 "This is the doc string for this function."
32262 \begin_layout LyX-Code
32263 print "My args: ", args
32266 \begin_layout LyX-Code
32267 @ %def some_function
32270 \begin_layout Standard
32271 For an example of this usage and the resulting cross-reference output, look
32272 at the Literate python program in
32274 LIBDIR/examples/listerrors.lyx
32276 which should make this all clear.
32279 \begin_layout Paragraph
32280 Generating the documentation
32283 \begin_layout Standard
32284 At this point you already have a new document file with a proper document
32285 class, and with some code and text on it.
32286 How do I print it? The answer is simple, you select
32288 View\SpecialChar menuseparator
32292 Just like you would do for a plain document.
32293 No special procedure is required.
32296 \begin_layout Standard
32297 To help orientate you, I will now explain what happens inside \SpecialChar LyX
32301 \begin_layout Enumerate
32304 Update\SpecialChar menuseparator
32307 menu option is chosen, a \SpecialChar LaTeX
32313 \begin_layout Standard
32314 If the document is of any literate class the generated file will be named
32315 with an extension name defined by the
32316 \begin_inset Quotes eld
32320 \begin_inset Quotes erd
32323 format (defined in the Preferences panel), otherwise the file will have
32332 \begin_layout Enumerate
32333 Note that the only difference so far is in the name of the file, no special
32334 processing is required by \SpecialChar LyX
32336 Given that you formatted the code using the
32337 \begin_inset Flex Noun
32340 \begin_layout Plain Layout
32346 inset that, by itself, takes care of the business.
32349 \begin_layout Enumerate
32350 If the document is of any literate class \SpecialChar LyX
32351 will then use the internal \SpecialChar LyX
32353 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
32358 \begin_layout Plain Layout
32359 The converters are defined in the
32361 Tools\SpecialChar menuseparator
32365 \begin_inset Quotes eld
32369 \begin_inset Quotes erd
32381 manual for general information about converters.
32386 to generate the \SpecialChar LaTeX
32391 \begin_layout Standard
32392 Otherwise it will just skip this step.
32396 \begin_layout Enumerate
32397 Finally, \SpecialChar LaTeX
32398 is invoked and the regular post processing continues as in a plain
32402 \begin_layout Standard
32403 Independence from a particular
32404 \begin_inset Quotes eld
32408 \begin_inset Quotes erd
32411 is easily achieved by changing the commands that are run by the various
32415 \begin_layout Paragraph
32416 Generating the code
32419 \begin_layout Standard
32420 When the build menu option is chosen or the corresponding button in the
32421 toolbar is pressed, a \SpecialChar LaTeX
32422 file is generated just like step 1 above.
32423 Next, \SpecialChar LyX
32429 This converter needs to be defined by the user and is not installed by
32430 default, though the Program format is.
32431 This converter (like any other converter) will have two parts:
32434 \begin_layout Enumerate
32435 The converter program itself.
32436 This program performs the conversion from the one format to the other (in
32437 this case, from the Noweb format to the Program pseudo-format).
32440 \begin_layout Enumerate
32441 The error log parser.
32442 This is a program whose sole purpose is to rewrite error messages in a
32443 format that \SpecialChar LyX
32445 This makes it possible for \SpecialChar LyX
32446 to place error boxes in the right places in
32450 \begin_layout Standard
32451 The first part, the
32452 \begin_inset Quotes eld
32456 \begin_inset Quotes erd
32459 setting, should be set to
32462 \begin_layout LyX-Code
32470 \begin_layout Standard
32471 This basically means that \SpecialChar LyX
32473 \begin_inset Quotes eld
32477 \begin_inset Quotes erd
32480 (a program or script) with the name of the Noweb file (normally a file
32481 in the \SpecialChar LyX
32482 temp directory) and the directory path of the original \SpecialChar LyX
32487 \begin_layout Standard
32488 This is an implementation of
32489 \begin_inset Quotes eld
32493 \begin_inset Quotes erd
32496 that you can place in a directory on your path:
32499 \begin_layout LyX-Code
32505 \begin_layout LyX-Code
32511 \begin_layout LyX-Code
32514 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
32517 \begin_layout Standard
32518 The next part of the converter setting is the
32519 \begin_inset Quotes eld
32523 \begin_inset Quotes erd
32526 which is to be set to
32529 \begin_layout LyX-Code
32532 parselog=$$s/scripts/listerrors
32535 \begin_layout Standard
32536 This will run any errors that are generated by the
32537 \begin_inset Quotes eld
32541 \begin_inset Quotes erd
32544 process through the
32545 \begin_inset Quotes eld
32549 \begin_inset Quotes erd
32555 \begin_layout Standard
32556 The build will normally take place in \SpecialChar LyX
32557 's temporary directory, so the files
32558 produced by the conversion will be in that directory.
32560 will copy out what it regards as the `main' file, but the
32564 conversion may produce several files, and so most of these would then be
32565 deleted when \SpecialChar LyX
32567 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
32568 the build-script chunk can place the generated files in that location.
32571 \begin_layout Paragraph
32572 Build instructions in the document
32575 \begin_layout Standard
32576 The last piece of the integration between \SpecialChar LyX
32578 \begin_inset Quotes eld
32582 \begin_inset Quotes erd
32586 Generally, the instructions for building your program should be embedded
32587 in a chunk of its own.
32589 \begin_inset Quotes eld
32593 \begin_inset Quotes erd
32596 above uses the notangle command to look for this chunk (called
32597 \begin_inset Quotes eld
32601 \begin_inset Quotes erd
32604 ) and runs its contents through
32605 \begin_inset Quotes eld
32609 \begin_inset Quotes erd
32615 \begin_layout Standard
32616 Typically, such a chunk would look something like this:
32619 \begin_layout LyX-Code
32623 \begin_layout LyX-Code
32625 \begin_inset Newline newline
32628 if [ -z "${NOWEB_SOURCE}" ]
32629 \begin_inset Newline newline
32635 \begin_layout LyX-Code
32636 NOWEB_SOURCE=myfile.nw
32637 \begin_inset Newline newline
32641 \begin_inset Newline newline
32645 code to extract files ...
32646 use NOWEB_OUTPUT_DIR here ...]
32647 \begin_inset Newline newline
32651 code to compile files ...]
32652 \begin_inset Newline newline
32658 \begin_layout Standard
32660 \change_deleted 564990737 1672161716
32663 LIBDIR/examples/listerrors.lyx
32667 LIBDIR/examples/Literate.lyx
32668 \change_inserted 564990737 1672161716
32673 File\SpecialChar menuseparator
32674 Open Example\SpecialChar menuseparator
32675 Modules\SpecialChar menuseparator
32682 \change_deleted 564990737 1672161729
32686 \begin_inset Quotes eld
32690 \begin_inset Quotes erd
32693 program for some illustrations of how all of these pieces go together or
32695 \change_deleted 564990737 1672161756
32698 LIBDIR/examples/noweb2lyx.lyx
32699 \change_inserted 564990737 1672161756
32704 File\SpecialChar menuseparator
32705 Open Example\SpecialChar menuseparator
32706 Modules\SpecialChar menuseparator
32707 Noweb2\SpecialChar LyX
32717 Interestingly, these
32718 \change_deleted 564990737 1672161767
32721 files show off the language-indepence of the \SpecialChar LyX
32722 literate programming support
32723 since they are written in Python
32724 \change_deleted 564990737 1672161782
32727 and Perl respectively.
32730 \begin_layout Subsubsection
32731 Configuring \SpecialChar LyX
32735 \begin_layout Standard
32736 All the Literate Programming support is configured by the
32738 Tools\SpecialChar menuseparator
32742 \begin_inset Quotes eld
32746 \begin_inset Quotes erd
32750 The important parts are:
32753 \begin_layout Description
32755 \begin_inset space ~
32759 \begin_inset Quotes eld
32763 \begin_inset Quotes erd
32767 \begin_inset space ~
32770 format Set up via the File Formats tab, this is where the Noweb-specific
32780 , the file extension is set to
32785 This tells \SpecialChar LyX
32786 to create a file with a
32790 extension in the first step of the conversion process.
32793 \begin_layout Description
32795 \begin_inset space ~
32803 \begin_inset space ~
32806 format This is an empty format whose sole purpose is to be the endpoint
32807 of a conversion (which then allows us to set up a converter for it).
32810 \begin_layout Description
32820 This converter performs the
32821 \begin_inset Quotes eld
32825 \begin_inset Quotes erd
32828 of the literate document.
32829 For Noweb, it is set to
32830 \begin_inset Quotes eld
32835 noweave -delay -index $$i > $$o
32838 \begin_inset Quotes erd
32844 \begin_layout Description
32854 \begin_inset Quotes eld
32858 \begin_inset Quotes erd
32862 As stated above, the Converter is set to
32863 \begin_inset Quotes eld
32871 \begin_inset Quotes erd
32874 , with Flags set to
32875 \begin_inset Newline newline
32879 \begin_inset Quotes eld
32884 parselog=$$s/scripts/listerrors
32887 \begin_inset Quotes erd
32893 \begin_layout Subsubsection
32897 \begin_layout Standard
32898 There is also a new function implemented in the \SpecialChar LyX
32900 \begin_inset Quotes eld
32903 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
32907 \begin_layout Standard
32908 When debugging code with ddd/gdb, it is possible to invoke a text editor
32909 at the current execution position with a single key stroke.
32910 The default ddd configuration for that is shift-ctrl-V.
32911 It happens that you can define the editor command line invocation in ddd
32914 Edit\SpecialChar menuseparator
32915 Preferences\SpecialChar menuseparator
32918 dialog and changing the "Edit Sources" entry.
32921 \begin_layout Standard
32922 I take advantage of the newly created \SpecialChar LyX
32923 server function and this ddd feature,
32925 \begin_inset Quotes eld
32929 \begin_inset Quotes erd
32935 \begin_layout LyX-Code
32936 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
32939 \begin_layout Standard
32940 With this, whenever you are using ddd and find a point in the program that
32941 you want to edit, you just press shift-ctrl-V (in the ddd window), and
32942 ddd will forward this information to \SpecialChar LyX
32943 through the \SpecialChar LyX
32944 server and then the
32946 window will show the same file with the cursor at the same position ddd
32948 No more guessing or long scrolling to locate a point in the program back
32952 \begin_layout Standard
32953 Note however that you must enable the \SpecialChar LyX
32954 server to get this feature working
32955 (it is disabled by default).
32957 \begin_inset space ~
32961 \begin_inset CommandInset ref
32963 reference "sec:Starting-the-Server"
32967 explains how to do that.
32970 \begin_layout Subsubsection
32974 \begin_layout Standard
32975 There are six new buttons that can be added to your \SpecialChar LyX
32977 Four of these buttons are short cuts to layout styles:
32995 , one for the custom inset
33000 The last one is a short cut to the
33001 \begin_inset Quotes eld
33005 \begin_inset Quotes erd
33012 \begin_layout Standard
33014 has a range of buttons that are available for tool bar customization.
33015 In my toolbar I like to combine the six short cuts above with two more:
33020 \SpecialChar menuseparator
33025 \SpecialChar menuseparator
33032 Document\SpecialChar menuseparator
33033 View\SpecialChar menuseparator
33037 Here is how it looks like:
33040 \begin_layout LyX-Code
33044 \begin_layout LyX-Code
33048 \begin_layout LyX-Code
33049 Icon "layout Standard"
33052 \begin_layout LyX-Code
33053 Icon "layout Section"
33056 \begin_layout LyX-Code
33057 Icon "layout \SpecialChar LaTeX
33061 \begin_layout LyX-Code
33062 Icon "layout \SpecialChar LyX
33066 \begin_layout LyX-Code
33067 Icon "flex.insert Chunk"
33070 \begin_layout LyX-Code
33074 \begin_layout LyX-Code
33078 \begin_layout LyX-Code
33079 Icon "buffer-typeset"
33082 \begin_layout LyX-Code
33083 Icon "build-program"
33086 \begin_layout LyX-Code
33090 \begin_layout LyX-Code
33094 \begin_layout LyX-Code
33098 \begin_layout LyX-Code
33102 \begin_layout LyX-Code
33106 \begin_layout Subsubsection
33107 Colors customization
33110 \begin_layout Standard
33111 There are a number of colors in \SpecialChar LyX
33112 that can be customized in
33117 One of the things that bothers people is the \SpecialChar LaTeX
33119 The default color is red, since the chunks uses \SpecialChar LaTeX
33120 font, and there is a lot
33121 of chunks in literate documents, you may get tired of seeing everything
33123 You can change it by going to the tabs
33132 \begin_layout Standard
33133 The next thing is the visible presence of the newline character in the screen.
33134 You can choose the color of this particular character and make it blend
33136 I recommend you choosing a color that is close to the background but not
33137 equal, that way you still can see it is there, but it is not bothering
33141 \begin_layout Subsection
33146 \begin_layout Standard
33156 \change_inserted 564990737 1672161863
33160 Help\SpecialChar menuseparator
33161 Specific Manuals\SpecialChar menuseparator
33169 \change_deleted 564990737 1671643409
33175 \change_inserted 564990737 1672161856
33179 File\SpecialChar menuseparator
33180 Open Example\SpecialChar menuseparator
33181 Modules\SpecialChar menuseparator
33188 \change_deleted 564990737 1671643461
33189 the Sweave manual (menu
33191 Help\SpecialChar menuseparator
33195 \change_inserted 564990737 1672161856
33199 Help\SpecialChar menuseparator
33200 Specific Manuals\SpecialChar menuseparator
33202 \change_deleted 564990737 1672161921
33208 \change_inserted 564990737 1672161917
33212 File\SpecialChar menuseparator
33213 Open Example\SpecialChar menuseparator
33214 Modules\SpecialChar menuseparator
33222 \begin_layout Chapter
33224 \change_deleted 564990737 1671355343
33228 \begin_layout Standard
33230 \change_deleted 564990737 1671355343
33231 You can do everything with \SpecialChar LyX
33232 that you can do with \SpecialChar LaTeX
33234 However, \SpecialChar LyX
33235 cannot support every \SpecialChar LaTeX
33237 But you can always use \SpecialChar TeX
33239 This chapter shows you some more special things you might want to use.
33240 For other special things you can do with figures, tables, floats, boxes
33241 and notes, have a look at the
33244 \begin_inset space ~