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
41 \maintain_unincluded_children no
43 \language_package default
46 \font_roman "lmodern" "default"
47 \font_sans "lmss" "default"
48 \font_typewriter "lmtt" "default"
49 \font_math "auto" "auto"
50 \font_default_family default
51 \use_non_tex_fonts false
55 \font_typewriter_osf false
56 \font_sf_scale 100 100
57 \font_tt_scale 100 100
59 \use_dash_ligatures true
61 \default_output_format pdf2
63 \bibtex_command default
64 \index_command default
65 \float_placement class
66 \float_alignment class
70 \pdf_title "LyX's Additional Features manual"
71 \pdf_author "LyX Team"
72 \pdf_subject "LyX's additional features documentation"
73 \pdf_keywords "LyX, Documentation, Additional"
75 \pdf_bookmarksnumbered true
76 \pdf_bookmarksopen false
77 \pdf_bookmarksopenlevel 1
82 \pdf_pdfusetitle false
83 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
86 \use_package amsmath 1
87 \use_package amssymb 1
90 \use_package mathdots 1
91 \use_package mathtools 1
93 \use_package stackrel 1
94 \use_package stmaryrd 1
95 \use_package undertilde 1
97 \cite_engine_type default
101 \paperorientation portrait
107 \notefontcolor #0000ff
114 \paragraph_separation indent
115 \paragraph_indentation default
117 \math_indentation default
118 \math_numbering_side default
119 \quotes_style english
123 \paperpagestyle headings
125 \tracking_changes true
126 \output_changes false
128 \postpone_fragile_content false
132 \docbook_table_output 0
133 \docbook_mathml_prefix 1
134 \author -712698321 "Jürgen Spitzmüller"
137 \author 244031559 "Yuriy"
138 \author 564990737 "John Lyx"
139 \author 630872221 "Jean-Pierre Chrétien" jeanpierre.chretien@free.fr
140 \author 1075283030 "Thibaut"
141 \author 1119979965 "Joel A. Kulesza"
147 Additional \SpecialChar LyX
151 \begin_layout Subtitle
153 \change_deleted 630872221 1622909155
155 \change_inserted 630872221 1622909155
162 by the \SpecialChar LyX
167 \begin_layout Plain Layout
169 Principal maintainer of this file is
171 Richard Kimberly Heck
174 If you have comments or error corrections, please send them to the \SpecialChar LyX
177 \begin_inset Flex Code
180 \begin_layout Plain Layout
181 <lyx-docs@lists.lyx.org>
194 \begin_layout Standard
195 \begin_inset CommandInset toc
196 LatexCommand tableofcontents
203 \begin_layout Chapter
207 \begin_layout Standard
208 This manual is essentially Part II of the
210 User's Guide\SpecialChar endofsentence
213 The reason for separating the two documents is simple: the
217 is already quite lengthy, and it contains information on all of the basic
218 features one needs to know in order to prepare most documents.
219 However, the \SpecialChar LyX
220 Team has worked to make \SpecialChar LyX
221 extensible through various configuration
222 files and external packages.
223 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
225 create a layout file (or module) for it without having to alter \SpecialChar LyX
227 We've already had contributions of several new features this way, and some
228 of them are documented here.
229 There are also some more `advanced' features, such as how to control the
230 presentation of bibliographies and how to work with multi-part documents,
231 that are not covered in the
235 and are discussed here.
238 \begin_layout Standard
239 This manual also documents some special features, like fax support
240 \change_deleted 244031559 1603802929
242 \change_inserted 244031559 1603802931
246 \change_deleted 244031559 1603802954
249 , which require additional software to work properly.
250 There is also a chapter on \SpecialChar LyX
252 And lastly, there's a chapter of \SpecialChar LaTeX
253 tools and tips, things you can use to
254 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
256 After all, \SpecialChar LyX
261 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
265 \begin_layout Standard
266 If you haven't read the
270 yet, you are definitely in the wrong manual.
275 is the first place to go, since it describes the notation and format of
277 You should also be thoroughly familiar with the
281 and all of the basic features of \SpecialChar LyX
282 before attempting to read this one.
285 \begin_layout Standard
286 Since many of the topics in this manual depend heavily on \SpecialChar LyX
288 with \SpecialChar LaTeX
289 , this first chapter covers the inner workings of \SpecialChar LyX
292 to generate exactly the \SpecialChar LaTeX
294 It is obviously for more seasoned \SpecialChar LyX
298 \begin_layout Chapter
300 and \SpecialChar LaTeX
304 \begin_layout Section
306 Uses \SpecialChar LaTeX
310 \begin_layout Standard
311 This chapter is for both \SpecialChar TeX
312 -nicians and the \SpecialChar LaTeX
314 In it, we'll explain how \SpecialChar LyX
315 and \SpecialChar LaTeX
316 work together to produce printable output.
317 This is the only place in any of the manuals where we assume you know something
318 about \SpecialChar LaTeX
322 \begin_layout Standard
323 At one time, \SpecialChar LyX
325 \begin_inset Quotes eld
328 WYSIWYM frontend to \SpecialChar LaTeX
330 \begin_inset Quotes erd
333 but that's no longer true.
334 There are frontends to \SpecialChar LaTeX
339 \begin_layout Plain Layout
340 Some familar ones are \SpecialChar TeX
341 maker and kile, on Linux, and \SpecialChar TeX
343 There are also the \SpecialChar LaTeX
344 modes for vi and emacs, of course.
349 These are basically text editors with the ability to run \SpecialChar LaTeX
351 errors in the file you're editing.
352 Although \SpecialChar LyX
361 run \SpecialChar LaTeX
362 , and it also indicates errors in the file, it also does much, much
364 For one thing, you don't need to know \SpecialChar LaTeX
365 to use \SpecialChar LyX
368 has added its own extensions to \SpecialChar LaTeX
370 Try the following sometime: select
371 \begin_inset Flex Noun
374 \begin_layout Plain Layout
375 Export\SpecialChar menuseparator
382 \begin_inset Flex Noun
385 \begin_layout Plain Layout
392 \begin_inset Flex Noun
395 \begin_layout Plain Layout
396 View\SpecialChar menuseparator
406 ), then look at the preamble of the resulting
407 \begin_inset Flex Code
410 \begin_layout Plain Layout
417 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
419 These macros are defined automatically, according to the features you use
423 \begin_layout Standard
424 There are several commands that automatically invoke \SpecialChar LaTeX
429 \begin_layout Itemize
430 \begin_inset Flex Noun
433 \begin_layout Plain Layout
434 Document\SpecialChar menuseparator
443 \begin_layout Itemize
444 \begin_inset Flex Noun
447 \begin_layout Plain Layout
448 Document\SpecialChar menuseparator
457 \begin_layout Standard
458 They will only invoke \SpecialChar LaTeX
459 if the file has changed since the last time \SpecialChar LaTeX
465 \begin_layout Standard
466 When \SpecialChar LyX
467 runs \SpecialChar LaTeX
468 on the file you're editing, it performs these steps:
471 \begin_layout Enumerate
472 Convert the document to \SpecialChar LaTeX
473 and save to a file with the extension
474 \begin_inset Flex Code
477 \begin_layout Plain Layout
484 \begin_inset Flex Code
487 \begin_layout Plain Layout
496 \begin_layout Enumerate
497 Run \SpecialChar LaTeX
499 \begin_inset Flex Code
502 \begin_layout Plain Layout
508 file (maybe several times), and run any other commands (such as
509 \begin_inset Flex Code
512 \begin_layout Plain Layout
519 \begin_inset Flex Code
522 \begin_layout Plain Layout
528 ) needed to compile the \SpecialChar LaTeX
532 \begin_layout Enumerate
533 If there are any errors, show the error log.
536 \begin_layout Standard
537 If you have run \SpecialChar LaTeX
539 \begin_inset Flex Noun
542 \begin_layout Plain Layout
543 View\SpecialChar menuseparator
550 then runs a DVI viewer to display the DVI-file.
552 \begin_inset Flex Noun
555 \begin_layout Plain Layout
556 View\SpecialChar menuseparator
563 performs further steps:
566 \begin_layout Enumerate
568 \begin_inset Flex Code
571 \begin_layout Plain Layout
577 to convert the DVI file to PostScript.
580 \begin_layout Enumerate
581 Run a PostScript viewer, such as
582 \begin_inset Flex Code
585 \begin_layout Plain Layout
591 , to display the PostScript file.
594 \begin_layout Standard
596 does similar things when viewing, or exporting, other formats.
599 \begin_layout Section
600 Translating \SpecialChar LaTeX
601 files into \SpecialChar LyX
605 \begin_layout Standard
606 You can import a \SpecialChar LaTeX
607 file into \SpecialChar LyX
609 \begin_inset Flex Noun
612 \begin_layout Plain Layout
613 File\SpecialChar menuseparator
614 Import\SpecialChar menuseparator
620 command in \SpecialChar LyX
622 This will call a program named
623 \begin_inset Flex Code
626 \begin_layout Plain Layout
632 which will create a file
633 \begin_inset Flex Code
636 \begin_layout Plain Layout
643 \begin_inset Flex Code
646 \begin_layout Plain Layout
654 will then open that file.
658 \begin_layout Plain Layout
659 \begin_inset Flex Code
662 \begin_layout Plain Layout
668 can also be run from the command line, of course.
676 \begin_layout Standard
677 \begin_inset Flex Code
680 \begin_layout Plain Layout
686 will translate most legal \SpecialChar LaTeX
687 , but not everything.
688 It will put things it doesn't understand into \SpecialChar TeX
689 code, so after translating
691 \begin_inset Flex Code
694 \begin_layout Plain Layout
700 , you can look for \SpecialChar TeX
701 code and hand-edit it until it looks right.
704 \begin_layout Standard
705 If you don't know what \SpecialChar TeX
706 code is, read the next section.
709 \begin_layout Section
710 \begin_inset CommandInset label
712 name "sec:Inserting-TeX-Code"
716 Inserting \SpecialChar TeX
717 Code into \SpecialChar LyX
721 \begin_layout Standard
722 Anything you can do in \SpecialChar LaTeX
723 you can do in \SpecialChar LyX
724 , for a very simple reason: You can
725 always insert \SpecialChar TeX
726 code into any \SpecialChar LyX
729 cannot, and will never be able to, display every possible \SpecialChar LaTeX
731 If ever you need to insert \SpecialChar LaTeX
732 commands into your \SpecialChar LyX
733 document, you can use the
735 \begin_inset Flex Code
738 \begin_layout Plain Layout
745 box, which you can insert into your document with
746 \begin_inset Flex Noun
749 \begin_layout Plain Layout
750 Insert\SpecialChar menuseparator
760 or the keyboard shortcut
769 \begin_layout Standard
770 Here's an example of inserting \SpecialChar LaTeX
771 commands in a \SpecialChar LyX
773 The code looks like this:
776 \begin_layout LyX-Code
780 \begin_inset Newline newline
786 \begin_inset Newline newline
789 This is an example of a minipage environment.
791 \begin_inset Newline newline
794 can put nearly everything in it, even (non-floating)
795 \begin_inset Newline newline
800 \begin_inset Newline newline
806 \begin_inset Newline newline
810 \begin_inset Newline newline
816 \begin_inset Newline newline
822 \begin_inset Newline newline
828 \begin_inset Newline newline
833 \begin_inset Newline newline
839 \begin_inset Newline newline
845 \begin_inset Newline newline
851 \begin_inset Newline newline
859 \begin_layout LyX-Code
863 \begin_layout Standard
865 \begin_inset Flex Code
868 \begin_layout Plain Layout
875 box containing this text is directly after this paragraph.
876 Those of you reading the manual in \SpecialChar LyX
877 will only see the \SpecialChar TeX
879 Those reading a printed version of the manuals will see the actual results:
880 \begin_inset VSpace bigskip
886 \begin_layout Standard
890 \begin_layout Plain Layout
897 \begin_layout Plain Layout
904 \begin_layout Plain Layout
906 This is an example of a minipage environment.
907 You can put nearly everything in it, even (non-floating) figures and tables.
911 \begin_layout Plain Layout
918 \begin_layout Plain Layout
923 \begin_layout Plain Layout
930 \begin_layout Plain Layout
937 \begin_layout Plain Layout
944 \begin_layout Plain Layout
950 \begin_layout Plain Layout
957 \begin_layout Plain Layout
964 \begin_layout Plain Layout
971 \begin_layout Plain Layout
981 \begin_inset VSpace bigskip
987 \begin_layout Standard
988 In addition to using \SpecialChar TeX
989 code, you can also create a separate file containing
990 some complex \SpecialChar LaTeX
991 structure and then use
992 \begin_inset Flex Noun
995 \begin_layout Plain Layout
996 Insert\SpecialChar menuseparator
1006 to include your file (you should select the type
1007 \begin_inset Flex Code
1010 \begin_layout Plain Layout
1017 We recommend that you only do this if you have a
1018 \begin_inset Flex Code
1021 \begin_layout Plain Layout
1032 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1036 \begin_layout Standard
1037 There are a few last points to emphasize:
1040 \begin_layout Itemize
1046 check if your \SpecialChar LaTeX
1050 \begin_layout Itemize
1051 Beware of reinventing the wheel.
1054 \begin_layout Standard
1055 On that last point, \SpecialChar LyX
1056 does have quite a few features tucked into it, and
1058 Be sure to check the manuals to make sure that \SpecialChar LyX
1059 doesn't have such-and-such
1060 feature before you decide you have to do it by hand.
1061 Moreover, there are numerous \SpecialChar LaTeX
1062 packages out there to do all sorts of things,
1063 from labels to envelopes to fancy multipage tables.
1065 \change_inserted 244031559 1603815732
1067 \begin_inset CommandInset href
1070 target "https://www.ctan.org/"
1076 \change_deleted 244031559 1603815732
1078 \begin_inset CommandInset href
1081 target "http://www.ctan.org/"
1091 \begin_layout Standard
1092 If you do need to do some wild and fancy things within your document, be
1093 sure to check out a good \SpecialChar LaTeX
1094 book for assistance.
1095 There are a number of them listed in the bibliography of the
1102 \begin_layout Section
1104 and the \SpecialChar LaTeX
1108 \begin_layout Subsection
1109 About the \SpecialChar LaTeX
1113 \begin_layout Standard
1114 If you already know \SpecialChar LaTeX
1115 , there is no need to explain here what the preamble
1117 If you don't, the following will give you some ideas—we recommend again
1118 that you consult a \SpecialChar LaTeX
1119 book for further information.
1120 In any case, you should read the points below, because they explain what
1121 you can do and what you don't need to do in the \SpecialChar LaTeX
1122 preamble of a \SpecialChar LyX
1126 \begin_layout Standard
1127 The \SpecialChar LaTeX
1128 preamble comes at the very beginning of a document,
1136 \begin_layout Itemize
1137 Declare the document class.
1139 \begin_inset Newline newline
1143 already does this for you.
1144 If you're a seasoned \SpecialChar LaTeX
1145 -nician, and you have a custom document class you
1146 want to use, check out the
1148 Customization Manual
1150 for information on how to make \SpecialChar LyX
1154 \begin_layout Itemize
1155 Declare the usage of packages.
1157 \begin_inset Newline newline
1161 packages provide special commands, which are only available within a document
1162 when the package has been declared in the preamble.
1163 In addition to providing special commands, the inclusion of a package can
1164 change the document.
1165 For example, the package
1166 \begin_inset Flex Code
1169 \begin_layout Plain Layout
1175 forces all paragraphs to be indented.
1176 There are other packages for labels, envelopes, margins, etc.
1180 \begin_layout Itemize
1181 Set counters, variables, lengths and widths.
1183 \begin_inset Newline newline
1186 There are several \SpecialChar LaTeX
1187 counters and variables that
1191 be set globally from within the preamble in order to have the desired effect.
1192 (There are variables that you can set and reset inside the document, too.)
1193 Margins are a good example of something that must be set in the preamble.
1194 Another example is the label format for lists.
1195 You can actually set these just about anywhere, but it's best to do it
1196 just once, inside the preamble.
1199 \begin_layout Itemize
1200 Declare user defined commands (with
1201 \begin_inset Flex Code
1204 \begin_layout Plain Layout
1213 \begin_inset Flex Code
1216 \begin_layout Plain Layout
1225 \begin_inset Newline newline
1228 These are abbreviations for \SpecialChar LaTeX
1229 commands which appear very often inside a document.
1230 Although the preamble is a good place to declare such commands, they
1234 be declared anywhere (before they are used for the first time, of course).
1235 This can be useful if there is a lot of raw \SpecialChar LaTeX
1236 code in your document, which
1237 normally should not be the case.
1240 \begin_layout Standard
1242 adds its own set of definitions to the preamble of the
1243 \begin_inset Flex Code
1246 \begin_layout Plain Layout
1253 This makes \SpecialChar LaTeX
1254 files generated by \SpecialChar LyX
1258 \begin_layout Subsection
1259 Changing the Preamble
1262 \begin_layout Standard
1263 The commands which \SpecialChar LyX
1264 adds to the preamble of a \SpecialChar LaTeX
1265 file are fixed; you can't
1266 change them without patching \SpecialChar LyX
1268 You can, however, add your own stuff to the preamble by selecting
1269 \begin_inset Flex Noun
1272 \begin_layout Plain Layout
1275 \begin_inset space ~
1284 \begin_inset Flex Noun
1287 \begin_layout Plain Layout
1288 Document\SpecialChar menuseparator
1296 adds anything in the
1297 \begin_inset Flex Noun
1300 \begin_layout Plain Layout
1306 dialog to its own built-in preamble.
1307 Before adding your own declarations in the preamble, you should make sure
1308 that \SpecialChar LyX
1309 doesn't already support what you want to do.
1310 (Remember what we said about reinventing the wheel?) Also,
1312 make sure your preamble code is correct
1316 doesn't check it for you.
1317 If there is an error, you're likely to get an error like
1318 \begin_inset Quotes eld
1322 \begin_inset Flex Code
1325 \begin_layout Plain Layout
1334 \begin_inset Quotes erd
1338 If you see this error, check your preamble.
1341 \begin_layout Subsection
1345 \begin_layout Standard
1346 Here are some examples of what you can add to a preamble, and what they
1350 \begin_layout Subsubsection
1354 \begin_layout Standard
1355 There are two variables under \SpecialChar LaTeX
1356 that control page position:
1357 \begin_inset Flex Code
1360 \begin_layout Plain Layout
1369 \begin_inset Flex Code
1372 \begin_layout Plain Layout
1381 Their names should be self-explanatory.
1382 These variables are useful if you think for a moment about computer labels.
1383 Sometimes, the size of a print medium and the area of the medium that you
1384 can actually print on aren't the same.
1386 \begin_inset Flex Code
1389 \begin_layout Plain Layout
1398 \begin_inset Flex Code
1401 \begin_layout Plain Layout
1412 \begin_layout Standard
1413 The default values for
1414 \begin_inset Flex Code
1417 \begin_layout Plain Layout
1426 \begin_inset Flex Code
1429 \begin_layout Plain Layout
1438 \begin_inset space \thinspace{}
1442 \begin_inset space \thinspace{}
1446 \begin_inset space \space{}
1449 the page isn't shifted.
1450 Unfortunately, some DVI drivers always seem to shift the page.
1451 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1452 If you're using \SpecialChar LyX
1453 on a system that you don't personally maintain, and your
1454 sysadmin is a doofus,
1455 \begin_inset Flex Code
1458 \begin_layout Plain Layout
1467 \begin_inset Flex Code
1470 \begin_layout Plain Layout
1479 Suppose your left and top margins are always 0.5
1480 \begin_inset space \thinspace{}
1484 You can add this to the preamble:
1487 \begin_layout LyX-Code
1495 \begin_layout LyX-Code
1503 \begin_layout Standard
1504 and your margins should now be correct.
1507 \begin_layout Subsubsection
1511 \begin_layout Standard
1512 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1513 There's a rather nice package, available at your nearest CTAN archive,
1514 for printing sheets of labels:
1515 \begin_inset Flex Code
1518 \begin_layout Plain Layout
1525 Now, your system may not have this package installed by default.
1526 We leave that up to you to check.
1527 You'll also want to read the documentation for it; we're not going to do
1529 Since this is an example, however, we'll give you an example of how you
1533 \begin_layout Standard
1534 First, make sure you're using the
1535 \begin_inset Flex Code
1538 \begin_layout Plain Layout
1545 Next, you need to put the following in your preamble:
1548 \begin_layout LyX-Code
1554 \begin_layout LyX-Code
1560 \begin_layout LyX-Code
1566 \begin_layout LyX-Code
1572 \begin_layout LyX-Code
1578 \begin_layout LyX-Code
1584 \begin_layout LyX-Code
1590 \begin_layout Standard
1591 This sets things up for Avery label sheets, stock #5360.
1592 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1595 \begin_inset Flex Code
1598 \begin_layout Plain Layout
1607 \begin_inset Flex Code
1610 \begin_layout Plain Layout
1618 around each label text.
1619 This and other special features of
1620 \begin_inset Flex Code
1623 \begin_layout Plain Layout
1629 are explained in its documentation.
1632 \begin_layout Standard
1633 Someday, someone may write a \SpecialChar LyX
1634 layout file to support this package directly.
1635 Maybe that someone is you.
1638 \begin_layout Subsubsection
1639 Example #3: Paragraph Indentation
1642 \begin_layout Standard
1643 Americans are trained to indent the first line of
1648 As with all of their other weird quirks, most Americans will whine and
1649 moan until they can have their way and indent the first line of all paragraphs.
1658 \begin_layout Standard
1659 Of course, this behavior isn't standard typography.
1660 In books, you typically only indent the first line of a paragraph
1664 it follows another one.
1665 The idea behind indenting the first line of a paragraph is to distinguish
1666 neighboring paragraphs from one another.
1667 If there is no previous paragraph—for example, if it follows a figure or
1668 is the first paragraph in a section—then there is no need for indentation.
1672 \begin_layout Standard
1673 If you're a typical American (we're still joking!), though, you don't care
1674 about such esoteric things; you want your indentation! Add this to the
1678 \begin_layout LyX-Code
1681 usepackage{indentfirst}
1684 \begin_layout Standard
1685 If your \SpecialChar TeX
1686 distribution isn't braindead, you'll have this package, and all
1687 of your paragraphs will get the indentation the Founding Fathers intended
1691 \begin_layout Subsubsection
1692 Example #4: This Document
1695 \begin_layout Standard
1696 You can also check out the preamble of this document to get an idea of some
1697 of the advanced things you can do.
1700 \begin_layout Section
1702 and \SpecialChar LaTeX
1706 \begin_layout Standard
1707 When \SpecialChar LyX
1708 calls \SpecialChar LaTeX
1709 , it tells \SpecialChar LaTeX
1710 to blithely ignore any errors and keep going.
1711 It then uses the logfile from the \SpecialChar LaTeX
1712 run to do a post-mortem.
1713 After analyzing the logfile, \SpecialChar LyX
1714 displays a dialog listing the errors.
1715 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1717 where the error occurred.
1721 \begin_layout Plain Layout
1723 Analyzing the logfile is a tough job, and \SpecialChar LyX
1724 doesn't always go to the right
1726 There are also cases where \SpecialChar LaTeX
1727 reports the error on one line, but the actual
1729 This is not unlike forgetting a closing brace in a program: You'll get
1730 an error, but only later.
1738 \begin_layout Standard
1739 Some folks also like to look at the log file directly: It is available from
1741 \begin_inset Flex Noun
1744 \begin_layout Plain Layout
1745 Document\SpecialChar menuseparator
1747 \begin_inset space ~
1756 There are some fairly common error messages and warnings.
1757 We'll cover those here.
1758 You should look at a good \SpecialChar LaTeX
1759 book for a complete listing.
1762 \begin_layout Itemize
1763 \begin_inset Flex Code
1766 \begin_layout Plain Layout
1773 \begin_inset Newline newline
1776 Anything beginning with these words is a warning message for the purpose
1778 \begin_inset Quotes eld
1782 \begin_inset Quotes erd
1785 the \SpecialChar LaTeX
1787 You'll get messages like this if you added or changed cross-references
1788 or bibliography entries, in which case, \SpecialChar LaTeX
1789 is trying to tell you that you
1790 need to make another run.
1791 You can by-and-large ignore these.
1794 \begin_layout Itemize
1795 \begin_inset Flex Code
1798 \begin_layout Plain Layout
1805 \begin_inset Newline newline
1808 Another warning message, this time about fonts which \SpecialChar LaTeX
1810 The rest of the message will often say something about a replacement font
1811 that \SpecialChar LaTeX
1813 You can safely ignore these, too.
1816 \begin_layout Itemize
1817 \begin_inset Flex Code
1820 \begin_layout Plain Layout
1829 \begin_inset Newline newline
1838 It seems to generate at least one of these messages for just about any
1840 They are warnings about lines that were too long and run past the right
1842 This happens if \SpecialChar LaTeX
1843 does not find a reasonable way to break the lines (notoriously
1844 often with typewriter font, since this does not allow for automatic break
1846 In many cases, this is unnoticeable in the final output.
1847 (It can be just a point or two.) Sometimes, however, the lines run rather
1848 visibly into the margin; something you will not want to have in your final
1851 \begin_inset Newline newline
1854 There are several global ways to try to minimize the overfull lines.
1857 Enable micro-typographic extensions
1861 Document\SpecialChar menuseparator
1862 Settings\SpecialChar menuseparator
1865 might already improve things a lot.
1866 Furthermore, \SpecialChar LaTeX
1867 code such as the following in
1869 Document\SpecialChar menuseparator
1870 Settings\SpecialChar menuseparator
1873 usually reduces the overfull lines drastically (we use this in the preamble
1878 \begin_layout LyX-Code
1882 \begin_inset Newline newline
1888 \begin_inset Newline newline
1893 emergencystretch 1.5em
1894 \begin_inset Newline newline
1902 \begin_layout Standard
1903 In some cases, however, you eventually have to rewrite the text to get the
1904 line breaking right.
1908 \begin_layout Plain Layout
1909 For more information, see
1910 \begin_inset Flex URL
1913 \begin_layout Plain Layout
1915 http://www.tex.ac.uk/FAQ-overfull.html
1928 \begin_layout Standard
1929 In any case, you should check the respective lines, at least for the final
1930 version of your document.
1931 Your eyes will tell you if there's a problem with something that's too
1936 \begin_layout Plain Layout
1937 You can also enable the `draft' option in
1938 \begin_inset Flex Noun
1941 \begin_layout Plain Layout
1942 Document\SpecialChar menuseparator
1948 , and then \SpecialChar LaTeX
1949 will draw a black box in the margin of lines that are overfull.
1958 \begin_layout Itemize
1959 \begin_inset Flex Code
1962 \begin_layout Plain Layout
1971 \begin_inset Newline newline
1974 Not quite as common as its cousin.
1975 This happens again if \SpecialChar LaTeX
1976 does not find a reasonable break point and consequently
1977 generates too loose lines.
1978 As with the overfull lines, you should check if this is a visible problem.
1981 \begin_layout Itemize
1982 \begin_inset Flex Code
1985 \begin_layout Plain Layout
1994 \begin_inset Flex Code
1997 \begin_layout Plain Layout
2006 \begin_inset Newline newline
2009 Warnings about troubles breaking the page.
2010 Once again, just look at the output.
2011 Your eyes will tell you where something has gone wrong.
2014 \begin_layout Itemize
2015 \begin_inset Flex Code
2018 \begin_layout Plain Layout
2020 \begin_inset Quotes els
2024 \begin_inset Quotes ers
2033 \begin_inset Newline newline
2037 \begin_inset Quotes eld
2041 \begin_inset Quotes erd
2044 isn't installed on this system.
2045 This usually appears because some package your document needs isn't installed.
2046 If you didn't touch the preamble or didn't use the
2047 \begin_inset Flex Code
2050 \begin_layout Plain Layout
2058 command, then one of the packages \SpecialChar LyX
2059 tried to load is missing.
2061 \begin_inset Flex Noun
2064 \begin_layout Plain Layout
2065 Help\SpecialChar menuseparator
2072 to get a list of packages that \SpecialChar LyX
2074 This file is updated whenever you reconfigure \SpecialChar LyX
2076 \begin_inset Flex Noun
2079 \begin_layout Plain Layout
2080 Tools\SpecialChar menuseparator
2086 ) and tells you which packages have been detected and what they do.
2087 \begin_inset Newline newline
2091 \begin_inset Flex Code
2094 \begin_layout Plain Layout
2102 command and the package in question isn't installed, then you'll need to
2103 install it yourself.
2106 \begin_layout Itemize
2107 \begin_inset Flex Code
2110 \begin_layout Plain Layout
2111 LaTeX Error: Unknown option
2117 \begin_inset Newline newline
2120 Error messages beginning with this are trying to tell you that you specified
2121 a bad or undefined option to a package.
2122 Check the package's documentation.
2125 \begin_layout Itemize
2126 \begin_inset Flex Code
2129 \begin_layout Plain Layout
2130 Undefined control sequence
2136 \begin_inset Newline newline
2139 If you've inserted \SpecialChar LaTeX
2140 code into your document, but made a typo, you'll get
2142 You may have forgotten to load a package.
2143 In any case, this error message usually means that you used an undefined
2148 \begin_layout Standard
2149 There are other error and warning messages.
2150 Some are self-explanatory.
2151 These are usually \SpecialChar LaTeX
2153 Others are downright cryptic.
2154 These are usually \SpecialChar TeX
2155 error messages, and we really have
2159 what they mean or how to decipher them.
2163 \begin_layout Standard
2164 There's a general sequence you should follow if you get error messages:
2167 \begin_layout Enumerate
2168 Look at the \SpecialChar LaTeX
2169 code you inserted for typos.
2172 \begin_layout Enumerate
2173 If there are no typos, check that you used the command(s) correctly.
2176 \begin_layout Enumerate
2177 If you get a bunch of error boxes piled up at the very top of the document—and
2178 especially if you see a
2179 \begin_inset Quotes eld
2183 \begin_inset Flex Code
2186 \begin_layout Plain Layout
2195 \begin_inset Quotes erd
2198 error—it means that there are errors in the preamble.
2199 Start debugging your preamble.
2202 \begin_layout Enumerate
2203 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2205 document, the first suspect is your \SpecialChar LaTeX
2206 distribution itself.
2207 Check for missing packages and install them.
2210 \begin_layout Enumerate
2211 Okay, so there are no missing packages.
2212 Did you use any of the fine-tuning options in \SpecialChar LyX
2213 ? Specifically, did you
2217 any of them, like trying to manually insert lots of
2218 \begin_inset Flex Code
2221 \begin_layout Plain Layout
2223 \change_deleted 177693 1654669036
2225 \change_inserted 177693 1654669038
2229 \begin_inset space ~
2233 \change_deleted 177693 1654669040
2235 \change_inserted 177693 1654669041
2244 \begin_inset Flex Code
2247 \begin_layout Plain Layout
2254 \begin_inset Flex Code
2257 \begin_layout Plain Layout
2263 ? Did you try to kludge something together with these instead of using the
2264 appropriate paragraph environment?
2267 \begin_layout Enumerate
2268 All right, you didn't use any of the fine-tuning options, you played by
2270 Did you try to pull a fancy maneuver? Did you do something funky inside
2271 a table or an equation, like inserting a graphic into a table cell?
2274 \begin_layout Enumerate
2275 Do you have long sections of text where \SpecialChar LaTeX
2276 cannot find a place to break a
2277 line? By default, \SpecialChar LaTeX
2278 is rather strict about how much extra inter-word spacing
2279 it will add in order to break a line.
2280 Preferably, you should rework the paragraph to avoid the problem.
2283 \begin_layout Enumerate
2284 Did you go overboard with the nesting? \SpecialChar LyX
2285 (currently) doesn't check to make
2286 sure you're in the limits for nesting environments.
2287 If you nested a bunch of environments to the
2288 \begin_inset Formula $17^{\mathrm{th}}$
2291 level, that's the problem.
2292 (The limit in \SpecialChar LaTeX
2296 \begin_layout Enumerate
2297 Okay, you didn't get any error messages, but your output looks awful.
2298 If you have a table or figure that's too wide or long for the page, you
2303 \begin_layout Enumerate
2304 rescale the figure so it fits.
2307 \begin_layout Enumerate
2308 trim down the table so it fits.
2312 \begin_layout Enumerate
2313 If something else is wrong with the output, and you didn't try to pull anything
2314 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2317 \begin_layout Standard
2318 If all this doesn't help—well, then
2322 you might have found a bug in \SpecialChar LyX
2327 \begin_layout Chapter
2329 \change_inserted 564990737 1670439508
2333 \begin_layout Section
2335 \change_inserted 564990737 1670439533
2336 \begin_inset CommandInset label
2338 name "sec:Collections"
2345 \begin_layout Subsection
2346 AMS \SpecialChar LaTeX
2350 \begin_layout Standard
2357 Richard Kimberly Heck
2360 \begin_layout Standard
2361 \begin_inset VSpace bigskip
2367 \begin_layout Standard
2369 The AMS \SpecialChar LaTeX
2370 layouts are set up to conform to suggested styles for mathematical
2371 papers to be submitted to American Mathematical Society publications.
2372 The layouts are not tailored to a specific journal, but easily can be.
2373 You should refer to the AMS documentation for specific instructions for
2374 each journal (usually it will entail only changing a single line in the
2377 That documentation is available on the Web at
2378 \begin_inset Flex URL
2381 \begin_layout Plain Layout
2389 \begin_inset Flex URL
2392 \begin_layout Plain Layout
2394 ftp://ftp.ams.org/pub/tex/amslatex/
2400 These layouts are appropriate, and useful, for any mathematical writing.
2404 \begin_layout Standard
2405 There are two basic AMS \SpecialChar LaTeX
2409 \begin_layout Itemize
2410 amsart: The standard AMS article format.
2413 \begin_layout Itemize
2414 amsbook: the standard AMS book (really, monograph) format.
2418 \begin_layout Standard
2419 The layouts themselves contain only the minimum necessary to use the AMS
2421 They do not, in particular, contain any of the `theorem' environments used
2422 for setting theorems, lemmas, and the like.
2423 These are contained, instead, in the
2424 \begin_inset Flex Code
2427 \begin_layout Plain Layout
2433 module, which is loaded by default when you select one of the AMS classes.
2434 (It can also be used with other classes and can be removed, if you would
2435 rather use something else.) Less commonly used environments are in the
2436 \begin_inset Flex Code
2439 \begin_layout Plain Layout
2440 Theorems (AMS-Extended)
2445 module, which must be loaded manually.
2448 \begin_layout Standard
2449 By default, theorems and the like are numbered consecutively throughout
2450 the document, but this may be modified by loading the module
2451 \begin_inset Flex Code
2454 \begin_layout Plain Layout
2455 Theorems (Order by Section)
2460 or, if you are using
2461 \begin_inset Flex Code
2464 \begin_layout Plain Layout
2471 \begin_inset Flex Code
2474 \begin_layout Plain Layout
2475 Theorems (Order by Chapter)
2481 These will number the results as
2482 \begin_inset Formula $n.m$
2485 , where the first number refers to the section (or chapter) and the second
2486 refers to the total number of results so far in that section (or chapter).
2487 Many environments are also available unnumbered.
2488 These are indicated by an asterisk at the end.
2489 If you happen to want
2493 unnumbered results, the module
2494 \begin_inset Flex Code
2497 \begin_layout Plain Layout
2503 provides that option.
2506 \begin_layout Standard
2507 Note that these modules do not
2511 to be used with the AMS classes.
2512 It is perfectly possible to use the
2513 \begin_inset Flex Code
2516 \begin_layout Plain Layout
2522 module, and the others mentioned, with other classes, such as
2523 \begin_inset Flex Code
2526 \begin_layout Plain Layout
2533 \begin_inset Flex Code
2536 \begin_layout Plain Layout
2543 \begin_inset Flex Code
2546 \begin_layout Plain Layout
2555 \begin_layout Subsubsection
2556 What these layouts provide
2559 \begin_layout Standard
2560 There is a long list of included environments provided by these layouts.
2561 In AMS-\SpecialChar LaTeX
2562 , there is, in fact, an opportunity to define an unlimited variety
2563 of `theorem' environments.
2564 However, the AMS recommends the environments that are available in \SpecialChar LyX
2569 \begin_layout Standard
2570 The following environments—as well as the standard environments, such as
2572 \begin_inset Flex Noun
2575 \begin_layout Plain Layout
2582 \begin_inset Flex Noun
2585 \begin_layout Plain Layout
2592 \begin_inset Flex Noun
2595 \begin_layout Plain Layout
2602 \begin_inset Flex Noun
2605 \begin_layout Plain Layout
2612 \begin_inset Flex Noun
2615 \begin_layout Plain Layout
2622 \begin_inset Flex Code
2625 \begin_layout Plain Layout
2632 \begin_inset Flex Code
2635 \begin_layout Plain Layout
2644 \begin_layout Description
2645 Address This should be the author's permanent address.
2648 \begin_layout Description
2650 \begin_inset space ~
2653 Address This should be the author's temporary address at the time of submission,
2654 if different from the Address.
2657 \begin_layout Description
2658 Email Author's e-mail address
2661 \begin_layout Description
2662 URL Author's Web address, if desired.
2665 \begin_layout Description
2666 Keywords Key words or phrases used to identify specific topics discussed
2670 \begin_layout Description
2671 Subjectclass These refer to the AMS Subject Classifications, published and
2674 Mathematical Reviews
2677 These are also available online at the AMS cites listed above.
2680 \begin_layout Description
2684 \begin_layout Description
2688 \begin_layout Description
2692 \begin_layout Standard
2693 The following environments are provided by both the
2694 \begin_inset Flex Code
2697 \begin_layout Plain Layout
2704 \begin_inset Flex Code
2707 \begin_layout Plain Layout
2713 modules, in the latter case in both starred (unnumbered) and unstarred
2714 (numbered) versions.
2715 These same environments are provided only in the starred versions by the
2717 \begin_inset Flex Code
2720 \begin_layout Plain Layout
2729 \begin_layout Theorem
2730 This is typically used for the statements of major results.
2734 \begin_layout Corollary*
2735 This is used for statements which follow fairly directly from previous statement
2737 Again, these can be major results.
2742 These are smaller results needed to prove other statements.
2745 \begin_layout Proposition
2746 These are less major results which (hopefully) add to the general theory
2750 \begin_layout Conjecture
2751 These are statements provided without justification, which the author does
2752 not know how to prove, but which seem to be true (to the author, at least).
2755 \begin_layout Definition*
2756 Guess what this is for.
2757 The font is different for this environment than for the previous ones.
2761 \begin_layout Example*
2762 Used for examples illustrating proven results.
2765 \begin_layout Problem
2766 It's not really known what this is for.
2767 You should figure it out.
2770 \begin_layout Exercise*
2771 Write a description for this one.
2774 \begin_layout Remark
2775 This environment is also a type of theorem, usually a lesser sort of observation.
2778 \begin_layout Claim*
2779 Often used in the course of giving a proof of a larger result.
2783 Generally, these are used to break up long arguments, using specific instances
2789 The numbering scheme for cases is on its own, not together with other numbered
2795 At the end of this environment, a QED symbol (usually a square, but it can
2796 vary with different styles) is placed.
2797 If you want to have other environments within this one—for example, Case
2798 environments—and have the QED symbol appear only after them, then the other
2799 environments need to be nested within the proof environment.
2802 Nesting Environments
2808 for information on nesting.
2811 \begin_layout Standard
2812 And these environments are provided by
2813 \begin_inset Flex Code
2816 \begin_layout Plain Layout
2817 Theorems (AMS-Extended)
2825 \begin_layout Criterion*
2826 A required condition.
2829 \begin_layout Algorithm*
2830 A general procedure to be used.
2833 \begin_layout Axiom*
2834 This is a property or statement taken as true within the system being discussed.
2837 \begin_layout Condition*
2838 Sometimes used to state a condition assumed within the present context of
2843 Similar to a Remark.
2846 \begin_layout Notation*
2847 Used for the explanation of, yes, notation.
2850 \begin_layout Summary
2851 Do we really need to tell you?
2854 \begin_layout Acknowledgement*
2858 \begin_layout Conclusion*
2859 Sometimes used at the end of a long train of argument.
2863 Used in a way similar to Proposition, though perhaps lower on the scale.
2866 \begin_layout Standard
2867 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
2870 They need to be available on your system in order to use these environments.
2873 \begin_layout Subsection
2875 \change_inserted 564990737 1671383236
2878 \begin_inset CommandInset label
2880 name "subsec:Extra-font-sizes"
2887 \begin_layout Standard
2889 \change_inserted 564990737 1671383236
2892 The “Extra font sizes” collection provides the document classes
2895 \begin_inset space \thinspace{}
2898 (with extra font sizes)
2903 \begin_inset space \thinspace{}
2906 (with extra font sizes)
2911 \begin_inset space \thinspace{}
2914 (with extra font sizes)
2919 \begin_inset space \thinspace{}
2922 (with extra font sizes)
2940 document classes respectively but offer the additional
2946 \begin_inset space ~
2951 options 8, 9, 14, 17 and 20 in the
2956 ocument\SpecialChar menuseparator
2961 ettings\SpecialChar menuseparator
2967 \begin_layout Subsection
2969 \change_inserted 564990737 1671383236
2975 \begin_layout Standard
2977 \change_inserted 564990737 1671383236
2980 The document classes
2983 \begin_inset space \thinspace{}
2991 \begin_inset space \thinspace{}
3006 document classes to facilitate the use of Hebrew in \SpecialChar LyX
3010 \begin_layout Subsection
3012 \change_inserted 564990737 1671383236
3015 \begin_inset CommandInset label
3017 name "subsec:Japanese"
3024 \begin_layout Standard
3026 \change_inserted 564990737 1671383236
3029 The document classes
3032 \begin_inset space \thinspace{}
3040 \begin_inset space \thinspace{}
3043 (Japanese Standard Class Vertical Writing)
3048 \begin_inset space \thinspace{}
3051 (Japanese Standard Class)
3056 \begin_inset space \thinspace{}
3064 \begin_inset space \thinspace{}
3067 (Japanese Standard Class Vertical Writing)
3072 \begin_inset space \thinspace{}
3075 (Japanese Standard Class)
3080 \begin_inset space \thinspace{}
3083 (Japanese Vertical Writing)
3088 \begin_inset space \thinspace{}
3091 (Japanese Standard Class)
3093 provide document classes for the Japanese language.
3096 \begin_layout Subsection
3100 \begin_layout Standard
3106 \begin_layout Subsubsection
3110 \begin_layout Standard
3111 The \SpecialChar LyX
3114 article (koma-script)
3118 report (koma-script)
3136 correspond to the \SpecialChar LaTeX
3154 \begin_inset space ~
3157 of the Koma-Script family.
3158 They are replacements for the standard document classes
3174 , resp., and fit better to European typography conventions in a number of
3178 \begin_layout Itemize
3179 Standard character size is 11pt in
3181 article (koma-script)
3185 report (koma-script)
3193 letter (koma-script)
3198 \begin_layout Itemize
3199 Headings, labels of the description environment, and a number of elements
3202 letter (koma-script)
3204 document class are set in a bold sans serif font.
3208 \begin_layout Plain Layout
3209 There is a big difference between the bold sans serif old cm fonts and new
3210 ec fonts, especially in the appearance of headings.
3211 In comparison, the ec bold sans serif fonts look a bit thin.
3212 Here the \SpecialChar LaTeX
3221 helps to produce the
3222 \begin_inset Quotes eld
3226 \begin_inset Quotes erd
3229 appearance when using the ec fonts.
3234 The numbering of chapter headings is made in the same way as the numbering
3235 of section headings, that is without the extra line
3236 \begin_inset Quotes eld
3239 Chapter\SpecialChar ldots
3241 \begin_inset Quotes erd
3245 In addition, the appearance of the headings can be modified by using a
3246 number of options (in \SpecialChar LyX
3247 to be entered in the field
3250 \begin_inset space ~
3257 Layout\SpecialChar menuseparator
3264 \begin_layout Itemize
3265 The main means in the Koma-Script document classes to design the type area
3274 (in \SpecialChar LyX
3275 to be entered in the extra class options field in the dialog
3277 Document\SpecialChar menuseparator
3281 They make a clearer modification of page margins possible as do the options
3284 Document\SpecialChar menuseparator
3291 \begin_layout Itemize
3292 The \SpecialChar LaTeX
3293 document classes of the Koma-Script family define a number of additional
3295 Those part of it which makes sense in \SpecialChar LyX
3296 is implemented in corresponding
3300 \begin_layout Standard
3301 Detailed descriptions of the \SpecialChar LaTeX
3302 document classes of the Koma-Script family
3303 can be found in the Koma-Script documentation
3314 \begin_layout Subsubsection
3315 article (koma-script), report (koma-script), and book (koma-script)
3318 \begin_layout Standard
3319 The document classes
3321 article (koma-script)
3325 report (koma-script)
3335 are implemented in the layout files
3348 They contain all the paragraph types of the corresponding standard document
3361 , resp., partly modified, with the exception of the \SpecialChar LyX
3366 -type, which is replaced by the new
3370 -type having the same functionality.
3375 -Type there is a number of new paragraph types added.
3382 letter (koma-script)
3387 \begin_layout Itemize
3396 : are equivalents to
3404 , resp., additionally inserting an entry in the table of contents.
3413 are not contained in
3415 article (koma-script)
3420 \begin_layout Itemize
3437 , resp., additionally clearing running heads.
3444 article (koma-script)
3450 \begin_layout Plain Layout
3463 report (koma-script)
3465 , but since this is identical to
3469 , is has not been implemented in \SpecialChar LyX
3478 \begin_layout Itemize
3483 : generates a heading directly above the following paragraph in the standard
3484 character size without affecting the structure of the document.
3487 \begin_layout Itemize
3496 are special captions which respect the different space settings needed
3497 for captions placed above or below an element (if you follow strict typographic
3498 rules, you might want to place table captions always above the table).
3499 You can also use the class option
3516 You need at least Koma-Script version 2.8q to use this.
3519 \begin_layout Itemize
3524 : can be used to set a bonmot, e.
3525 \begin_inset space \thinspace{}
3529 \begin_inset space \space{}
3532 at the beginning of a chapter.
3533 If you use the optional argument (
3535 Insert\SpecialChar menuseparator
3537 \begin_inset space ~
3542 ), you can insert the dictum's author there.
3543 Dictum and author are separated by a line.
3544 You need at least Koma-Script version 2.8q to use this.
3551 article (koma-script)
3556 \begin_layout Standard
3557 The following types, together with the standard types
3569 , form the title area of the document.
3570 They must be entered ahead of the first
3571 \begin_inset Quotes eld
3575 \begin_inset Quotes erd
3582 \begin_layout Plain Layout
3583 The corresponding \SpecialChar LaTeX
3584 commands must appear before the
3595 When such a type is used more than once, the latter usage overwrites the
3596 former one, that means, for every type only the latest usage is valid.
3597 The order of the different types however has, like
3609 , no effect on the appearance of the produced document.
3612 \begin_layout Itemize
3617 : produces a centered paragraph above the ordinary title (
3629 ) for the subject of the document.
3632 \begin_layout Itemize
3637 : produces a centered paragraph below the ordinary title (
3649 ) for the publishers' name.
3652 \begin_layout Itemize
3659 report (koma-script)
3665 produces a centered paragraph on its own page behind the title page, or
3668 article (koma-script)
3670 produces a centered paragraph below the ordinary title (
3689 \begin_layout Itemize
3694 : produces a left aligned paragraph above the ordinary title (
3710 ) for a document`s head.
3713 \begin_layout Itemize
3718 : produces in a double-sided print in
3720 report (koma-script)
3726 a left-aligned paragraph at the top of the title page`s back or has no
3727 effect in a single-sided print or in
3729 article (koma-script)
3734 \begin_layout Itemize
3739 : produces in a double-sided print in
3741 report (koma-script)
3747 a left-aligned paragraph at the bottom of the title page`s back or has
3748 no effect in a single-sided print or in
3750 article (koma-script)
3755 \begin_layout Itemize
3760 : produces a special
3761 \begin_inset Quotes eld
3765 \begin_inset Quotes erd
3768 page ahead of the actual document containing a paragraph without special
3772 \begin_layout Standard
3773 The layout files for the document classes
3775 article (koma-script)
3779 report (koma-script)
3790 This is thought of as a place to define your own types.
3795 in your personal layout directory and edit the file!
3798 \begin_layout Subsubsection
3799 letter (koma-script)
3802 \begin_layout Description
3803 Note: This section discusses the obsolete
3805 KOMA-Script-Letter (v.
3806 \begin_inset space ~
3811 , which is not even included anymore in recent KOMA releases.
3812 Please refer to the next section for the current KOMA-Script-Letter class
3814 \begin_inset space ~
3820 \begin_layout Standard
3824 letter (koma-script)
3826 is implemented in the layout file
3831 It contains all the paragraph types of the corresponding standard document
3836 , partly modified, with the exception of the \SpecialChar LyX
3850 type, which is replaced by the new
3855 In addition, it contains, in contrast to the standard document class, the
3874 Furthermore, there are a number of new letter specific types.
3877 \begin_layout Standard
3878 The appearance of the letter produced by this document class can be controlled
3879 by a number of \SpecialChar LaTeX
3880 commands, which you can put in the \SpecialChar LaTeX
3885 \begin_layout Plain Layout
3886 For example, the standard appearance of the letter`s heading, consisting
3887 of name and address, is quite self-willed.
3889 \begin_inset Quotes eld
3893 \begin_inset Quotes erd
3896 heading is produced by the following \SpecialChar LaTeX
3897 commands in the preamble:
3900 \begin_layout LyX-Code
3910 \begin_layout LyX-Code
3926 \begin_layout LyX-Code
3936 \begin_layout LyX-Code
3956 A detailed German description of such \SpecialChar LaTeX
3957 commands can be found in the Koma-Script
3963 With it, the letter's author can produce his personal letter layout.
3966 \begin_layout Standard
3975 define the beginning of the letter and must be used in every letter.
3976 To emphasize them in the \SpecialChar LyX
3977 document class, they are marked with the letter
3987 \begin_inset space ~
3991 It is possible to write any number of letters in one file.
3996 type produces a new letter using the same addressee and a
4000 type produces a new addressee.
4017 are ordinary paragraph types and can also be used several times in one
4018 and the same letter.
4021 \begin_layout Itemize
4026 : produces a paragraph for the addressee and implicitly defines the beginning
4030 \begin_layout Itemize
4035 : produces a paragraph for the form of address and implicitly produces a
4039 \begin_layout Itemize
4044 : produces a paragraph for a close.
4047 \begin_layout Itemize
4052 : produces a paragraph for a postscript.
4055 \begin_layout Itemize
4060 : produces a paragraph for a distribution list.
4063 \begin_layout Itemize
4068 : produces a paragraph for enclosures.
4071 \begin_layout Standard
4112 are input types provided with a label to enter information, which will
4113 be processed by the document class.
4117 \begin_layout Plain Layout
4118 It could be seen as a matter of inconsequence, that the types
4126 described above are not such input types as well.
4127 Because of the special meaning of those types, however, I have implemented
4128 them as ordinary paragraph types with a one letter mark in the left margin.
4129 Moreover, it would affect my feeling of symmetry, if the
4137 type had such a serious different appearance.
4142 The types must be used ahead of the corresponding
4149 \begin_layout Standard
4150 An implementation of these types in a WYSIWYG fashion does not seem to make
4151 sense, because the real appearance of the produced letter does not only
4152 depend on the usage of the particular type, but also on other factors.
4153 For example, a signature entered in the
4157 type will in the standard behavior appear in the produced letter only,
4158 when in the same letter also a
4163 The entered value of the
4167 type will in the standard behavior not appear in the produced letter at
4169 The possibility to design the letter`s heading freely is already indicated
4170 in a footnote above.
4173 \begin_layout Standard
4174 The input types can also be used as empty paragraphs.
4176 \begin_inset space \thinspace{}
4180 \begin_inset space \space{}
4192 type is not used at all, in the standard behavior the value of the
4196 type is used as signature, whereas if an empty
4200 type is used, no signature value is defined.
4203 \begin_layout Standard
4204 By using the input types it is possible to write a letter template, containing
4205 filled input types with your personal dates (name, address, etc.) and empty
4206 input types for other dates you want to enter.
4209 \begin_layout Itemize
4214 : sender's name, in the standard behavior appears as a centered paragraph
4215 in small caps in the letter`s heading.
4218 \begin_layout Itemize
4223 : sender's signature, in the standard behavior appears below the
4232 type is used, the value of the
4236 type appears instead.
4239 \begin_layout Itemize
4244 : sender's address, in the standard behavior appears in a centered paragraph
4245 in the letter`s heading below the sender's name.
4248 \begin_layout Itemize
4253 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
4264 \begin_layout Itemize
4269 : place of the letter`s making.
4272 \begin_layout Itemize
4277 : date of the letter`s making.
4286 , in the standard behavior, produce the place and the date in a right-aligned
4287 line below the addressee's field.
4292 type is used, neither place nor date appear, independent of the value of
4302 type is used, the date of the letter `s production is used.
4305 \begin_layout Itemize
4310 : sender`s back address, in the standard behavior appears above the addressee's
4311 field in a small sans serif font.
4314 \begin_layout Itemize
4319 : special mail information, in the standard behavior appears underlined
4320 above the addressee's field below the back address.
4323 \begin_layout Itemize
4328 : additional information, in the standard behavior appears on right side
4329 below the addressee`s field.
4332 \begin_layout Itemize
4337 : the letter's title, in the standard behavior appears in a big, bold, sans
4338 serif font above the subject.
4341 \begin_layout Itemize
4346 : the letter's subject, in the standard behavior appears in a bold font
4354 \begin_layout Standard
4375 produce a business letter like line above the
4379 line containing the fields
4380 \begin_inset Quotes eld
4384 \begin_inset Quotes erd
4388 \begin_inset Quotes eld
4392 \begin_inset Quotes erd
4396 \begin_inset Quotes eld
4400 \begin_inset Quotes erd
4404 \begin_inset Quotes eld
4408 \begin_inset Quotes erd
4412 \begin_inset Quotes eld
4416 \begin_inset Quotes erd
4420 \begin_inset Quotes eld
4424 \begin_inset Quotes erd
4428 For the date field, the value of the
4434 \begin_inset Quotes eld
4437 business letter types
4438 \begin_inset Quotes erd
4441 is used, the value of the
4445 type however does not appear, but only the \SpecialChar LaTeX
4453 The ordinary output of place and date in a right-aligned line below the
4454 addressee`s field is suppressed.
4455 The types are implemented as input types provided with a label and must
4456 be used ahead of the corresponding
4463 \begin_layout Itemize
4471 \begin_layout Itemize
4479 \begin_layout Itemize
4487 \begin_layout Itemize
4495 \begin_layout Itemize
4503 \begin_layout Subsubsection
4504 The new letter class: letter (koma-script v.2)
4507 \begin_layout Standard
4513 \begin_layout Standard
4514 \begin_inset VSpace medskip
4520 \begin_layout Standard
4522 Koma-Script version 2.8 has introduced a new letter class
4526 which supersedes the now unsupported
4531 It has — on the \SpecialChar LaTeX
4532 side — a completely new interface and is not compatible
4534 Therefore, \SpecialChar LyX
4535 supports both, though it is recommended you use the new class.
4538 \begin_layout Standard
4539 This class covers the same functionality as
4541 letter (koma-script),
4548 (receiver's address, same as
4565 will start a new letter (i.
4566 \begin_inset space \thinspace{}
4570 \begin_inset space \space{}
4573 you can write several letters per document).
4574 New elements are sender's
4590 and the possibility to use a
4596 Insert\SpecialChar menuseparator
4602 \begin_layout Standard
4603 The biggest improvement is, though, that the letter's layout is configurable
4604 to meet almost any needs.
4605 This can be done via the preamble or with a special style file (Letter
4606 Class Option, extension
4610 ), that will be read in as a class option.
4614 \begin_layout Plain Layout
4615 The KOMA package comes with some default
4620 There is, for instance, a
4624 file that follows german typesetting rules, or a
4628 that provides the default layout of the old
4633 The latter can be loaded with the class option
4639 Layout\SpecialChar menuseparator
4640 Document\SpecialChar menuseparator
4649 \change_deleted 564990737 1671617922
4657 \change_deleted 564990737 1671617938
4658 that is included in \SpecialChar LyX
4660 \change_inserted 564990737 1671617997
4667 ile\SpecialChar menuseparator
4669 \begin_inset space ~
4677 \begin_inset space ~
4680 Template\SpecialChar menuseparator
4683 \SpecialChar menuseparator
4684 KOMA-Script Letter (V.2)
4689 A detailed description is to be found in the Koma-Script documentation
4697 \begin_layout Subsubsection
4701 \begin_layout Standard
4702 Visualizing the Koma-Script document classes in \SpecialChar LyX
4703 , the \SpecialChar LyX
4704 internals cause some
4708 \begin_layout Itemize
4709 The chapter number of a
4713 type appears on a line of its own above the chapter heading instead of
4714 appearing in the same line ahead of it.
4715 The cause for that is the \SpecialChar LyX
4716 internal behavior for the labeltype
4723 \begin_layout Itemize
4724 The headings of the types
4733 \begin_inset Quotes eld
4737 \begin_inset Quotes erd
4741 table of contents, but not in the \SpecialChar LyX
4744 Document\SpecialChar menuseparator
4746 \begin_inset space ~
4750 \begin_inset space ~
4758 \begin_layout Itemize
4763 document class appear in a skip separation mode, not indented.
4764 This is the standard behavior, no special \SpecialChar LaTeX
4765 commands are needed for that.
4768 Document\SpecialChar menuseparator
4771 dialog the corresponding radio button indicates
4780 value always has the effect that extra \SpecialChar LaTeX
4781 commands are inserted in the document
4782 to produce the gap, which is not what is wanted in this case.
4785 \begin_layout Subsection
4787 \change_inserted 564990737 1670924924
4789 \begin_inset space \thinspace{}
4793 \begin_inset space \space{}
4797 \change_deleted 564990737 1670924933
4798 Article (mwart), book (mwbk) and report (mwrep)
4799 \begin_inset Argument status
4802 \begin_layout Plain Layout
4817 \begin_layout Standard
4823 \begin_layout Standard
4824 The \SpecialChar LyX
4841 correspond to the \SpecialChar LaTeX
4855 They are replacements for the standard document classes
4867 , resp., and fit better to Polish typography conventions in a number of points.
4871 \begin_layout Standard
4875 \begin_layout Itemize
4876 Unnumbered titles (with star, e.
4877 \begin_inset space \thinspace{}
4881 \begin_inset space \space{}
4888 ) are added into table of contents,
4891 \begin_layout Itemize
4892 Additional page styles:
4896 \begin_layout Description
4897 uheadings header with separated lines,
4900 \begin_layout Description
4901 myheadings custom header, contents headers via commands:
4916 \begin_layout Description
4917 myuheadings custom header with separated lines,
4920 \begin_layout Description
4921 outer page number is placed on outer side of page
4925 \begin_layout Itemize
4930 \begin_layout Description
4931 rmheadings serif titles — default,
4934 \begin_layout Description
4935 sfheadings sansserif titles,
4938 \begin_layout Description
4939 authortitle on title page first placed is author next title — default,
4942 \begin_layout Description
4943 titleauthor on title page first placed is title next author,
4946 \begin_layout Description
4947 withmarginpar reserve place on page for margins.
4951 \begin_layout Section
4953 \change_inserted 564990737 1670439534
4957 \begin_layout Standard
4959 \change_inserted 564990737 1670794710
4960 See also the document classes in the Collections (section
4961 \begin_inset space ~
4965 \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
7787 reference "sec:Collections"
7794 \begin_layout Subsection
7798 \begin_layout Standard
7804 \begin_layout Subsubsection
7808 \begin_layout Standard
7809 Memoir is a very powerful and constantly evolving class.
7810 It has been designed with regard to fictional and non-fictional literature.
7811 Its aim is to let the user have maximum control over the typesetting of
7813 Memoir is based on the standard book class, but it can also emulate the
7814 article class (see below).
7817 \begin_layout Standard
7818 Peter Wilson, the developer of Memoir, is known as the author of lots of
7819 useful packages in the \SpecialChar LaTeX
7821 Most of them have been merged with Memoir.
7822 Therefore, it is much easier to layout the table of contents, appendices,
7823 chapter designs and such.
7825 , though, does not support all of these goodies natively.
7826 Some of them might be added to forthcoming releases
7830 \begin_layout Plain Layout
7831 You are invited to send suggestions to
7832 \begin_inset Flex URL
7835 \begin_layout Plain Layout
7837 lyx-devel@lists.lyx.org
7847 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
7849 Of course you can still use all features with the help of some native \SpecialChar LaTeX
7851 commands (\SpecialChar TeX
7856 \begin_layout Plain Layout
7861 \begin_layout Plain Layout
7871 \begin_inset space ~
7875 \begin_inset CommandInset ref
7878 reference "sec:Inserting-TeX-Code"
7888 In this section, we can only list those features that are natively supported
7891 For detailed descriptions (and for the rest of features) we recommend you
7892 have a look at the detailed manual of the Memoir class
7896 \begin_layout Plain Layout
7901 \begin_layout Plain Layout
7911 \begin_inset Flex URL
7914 \begin_layout Plain Layout
7916 CTAN:/macros/latex/memoir/memman.pdf
7926 , which is not only a user guide for the class, but also both a comprehensive
7927 description on good typesetting and a superb example for good typesetting
7931 \begin_layout Subsubsection
7932 Basic features and restrictions
7935 \begin_layout Standard
7936 Memoir supports basically all features of the standard book classes.
7937 There are, however, some differences, as follows:
7940 \begin_layout Description
7942 \begin_inset space ~
7945 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
7948 \begin_layout Description
7950 \begin_inset space ~
7953 style: The fancy page style is not supported, due to a command clash between
7954 Memoir and the fancyhdr package (they both define a command with the same
7955 name, which confuses \SpecialChar LaTeX
7957 Instead, Memoir comes with a number of its own page styles (see
7959 Document\SpecialChar menuseparator
7960 Settings\SpecialChar menuseparator
7962 \begin_inset space ~
7968 If you want to use these for the chapter pages, you have to use the command
7975 in the main text or in preamble (e.
7976 \begin_inset space \thinspace{}
7980 \begin_inset space \space{}
7987 chapterstyle{companion}
7992 \begin_layout Description
7993 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
7994 optional argument in the standard classes.
7995 With this, you can specify an alternative version of the title for the
7996 table of contents and the headers (for instance, if the title is too long).
7998 , you can do this via
8000 Insert\SpecialChar menuseparator
8002 \begin_inset space ~
8007 at the beginning of a chapter/section.
8008 Memoir features a second optional argument and thus separates the table
8009 of contents from the header.
8010 You can define three variants of a title with this: one for the main text,
8011 one for the table of contents, and one for the headers.
8013 makes these available in form of specific
8024 \begin_layout Description
8025 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
8026 of contents, the list of figures and the list of table start a new page
8028 Memoir does not follow this route.
8029 You have to insert a page break yourself, if you want to have one.
8032 \begin_layout Description
8033 Titlepage: For some unknown reason, Memoir uses pagination on the title
8034 page (in the standard classes, title pages are
8035 \begin_inset Quotes eld
8039 \begin_inset Quotes erd
8043 If you want an empty title page, type
8047 aliaspagestyle{title}{empty}
8052 \begin_layout Description
8053 Article: With the class option
8059 Document\SpecialChar menuseparator
8060 Settings\SpecialChar menuseparator
8061 Class Settings\SpecialChar menuseparator
8063 \begin_inset space ~
8068 ), you can emulate article style.
8069 That is, counters (footnotes, figures, tables etc.) will not be reset on
8070 new chapters, chapters don't start a new page (but are—in contrary to
8071 \begin_inset Quotes eld
8075 \begin_inset Quotes erd
8078 article classes—still allowed), parts, though, use their own page, as in
8082 \begin_layout Description
8083 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
8084 font commands, which have been used in the old \SpecialChar LaTeX
8086 \begin_inset space \thinspace{}
8090 \begin_inset space \space{}
8106 It produces an error and stops \SpecialChar LaTeX
8107 whenever such a command appears.
8112 reallows the commands and spits out warnings instead (which does at least
8113 not stop \SpecialChar LaTeX
8115 Since a lot of packages and particularly Bib\SpecialChar TeX
8116 style files are still using
8117 those commands, we have decided to use this option by default.
8120 \begin_layout Subsubsection
8124 \begin_layout Standard
8125 We will only describe the features supported by \SpecialChar LyX
8126 (which is not much currently).
8127 Please consult the Memoir manual
8131 \begin_layout Plain Layout
8136 \begin_layout Plain Layout
8146 \begin_inset Flex URL
8149 \begin_layout Plain Layout
8151 CTAN:/macros/latex/memoir/memman.pdf
8164 \begin_layout Description
8165 Abstract: You may wonder why an abstract is an extra feature.
8166 Well, it is in book class.
8167 Usually books don't have abstracts.
8168 Memoir, however, has.
8169 You can use it wherever and how often you like.
8172 \begin_layout Description
8173 Chapterprecis: You may know this older typesetting style: The contents of
8174 a chapter are summarized below the title and also in the table of contents
8176 \begin_inset space \thinspace{}
8180 \begin_inset space \space{}
8185 Our hero arrives in Troia; he loses some friends; he finds others
8188 Chapterprecis does exactly this.
8189 It is therefore only sensible below a chapter.
8192 \begin_layout Description
8193 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
8194 The epigraph environment provides an elegant way of typesetting such a
8196 The motto itself (text) and its (optional) author (source) are divided
8198 The author (source) can be inserted via
8200 Insert\SpecialChar menuseparator
8207 \begin_layout Description
8208 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
8209 complex figurative poems).
8211 can only support a few of them.
8212 One is poemtitle, which is a centered title for poems, which will also
8213 be added to the table of contents (verse is the standard environment for
8215 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
8217 because they have to be nested inside regular verse environments, which
8218 is not possible with \SpecialChar LyX
8222 \begin_layout Description
8223 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
8226 \begin_layout Subsection
8228 \change_inserted 564990737 1671442175
8234 \begin_layout Standard
8236 \change_inserted 564990737 1671442175
8246 \begin_inset space \thinspace{}
8251 document class but adds two environments:
8254 \begin_layout Description
8256 \change_inserted 564990737 1671442175
8259 Recipe a numbered section environment at the
8263 level which generates a bold centered heading above a double horizontal
8267 \begin_layout Description
8269 \change_inserted 564990737 1671442175
8282 are what are being described and the environment ends with a horizontal
8286 \begin_layout Standard
8288 \change_inserted 564990737 1671642866
8292 File\SpecialChar menuseparator
8293 Open Example\SpecialChar menuseparator
8294 Books\SpecialChar menuseparator
8298 illustrates its use.
8301 \begin_layout Standard
8303 \change_inserted 564990737 1671442175
8306 It is designed for typesetting one or two recipes per page, with dimensions
8308 \begin_inset Quotes qrd
8312 \begin_inset Quotes qrd
8316 The hyperlinked table of contents (ToC) and page numbers make browsing
8317 recipes convenient, and the pages can be joined together or printed 2 per
8318 page to normal letterpaper easily.
8319 The size was chosen to work in half-page 3-ring binder cover sheets, because
8320 un-laminated paper just doesn't last in the kitchen.
8323 \begin_layout Standard
8325 \change_inserted 564990737 1671442175
8328 The half-letter pages can be printed two per page using your printer driver,
8329 or bound together using
8331 pdfjam --nup 2x1 --papersize '{11in,8.5in}'
8341 is the compiled version of your recipes.
8344 \begin_layout Section
8346 \change_inserted 564990737 1671442207
8350 \begin_layout Subsection
8352 \change_inserted 564990737 1671442208
8358 \begin_layout Standard
8360 \change_inserted 564990737 1671642942
8366 \begin_inset space \space{}
8370 \begin_inset space \thinspace{}
8379 document class, an unofficial implementation of the ‘Europass CV’ recommended
8380 by the European Commission in 2013.
8384 File\SpecialChar menuseparator
8385 Open Example\SpecialChar menuseparator
8386 Curricula Vitae\SpecialChar menuseparator
8390 offers guidance on its use.
8391 Its documentation is available from
8392 \begin_inset CommandInset href
8395 target "http://mirrors.ctan.org/macros/latex/contrib/europasscv/europasscv.pdf"
8403 \begin_layout Subsection
8405 \change_inserted 564990737 1671442208
8411 \begin_layout Standard
8413 \change_inserted 564990737 1671642984
8419 \begin_inset space \space{}
8423 \begin_inset space \thinspace{}
8432 document class, an unofficial implementation of the “Europass CV” recommended
8433 by the European Commission in 2002.
8437 File\SpecialChar menuseparator
8438 Open Example\SpecialChar menuseparator
8439 Curricula Vitae\SpecialChar menuseparator
8443 offers guidance on its use.
8444 Its documentation is available from
8445 \begin_inset CommandInset href
8448 target "http://mirrors.ctan.org/macros/latex/contrib/europecv/europecv.pdf"
8456 \begin_layout Subsection
8458 \change_inserted 564990737 1671442208
8464 \begin_layout Standard
8466 \change_inserted 564990737 1671643003
8472 \begin_inset space \space{}
8476 \begin_inset space \thinspace{}
8486 This allows the creation of customizable CVs.
8490 File\SpecialChar menuseparator
8491 Open Example\SpecialChar menuseparator
8492 Curricula Vitae\SpecialChar menuseparator
8496 offers guidance on its use.
8497 Its documentation is available from
8498 \begin_inset CommandInset href
8501 target "http://mirrors.ctan.org/macros/latex/contrib/moderncv/manual/moderncv_userguide.pdf"
8509 \begin_layout Subsection
8511 \change_inserted 564990737 1671442208
8517 \begin_layout Standard
8519 \change_inserted 564990737 1671643024
8525 \begin_inset space \space{}
8529 \begin_inset space \thinspace{}
8538 document class, originally developed for use with \SpecialChar LyX
8543 File\SpecialChar menuseparator
8544 Open Example\SpecialChar menuseparator
8545 Curricula Vitae\SpecialChar menuseparator
8549 offers guidance on its use.
8550 Its documentation is available from
8551 \begin_inset CommandInset href
8554 target "http://mirrors.ctan.org/macros/latex/contrib/simplecv/simplecv.pdf"
8562 \begin_layout Section
8564 \change_inserted 564990737 1671041968
8568 \begin_layout Subsection
8570 \change_inserted 564990737 1671041970
8576 \begin_layout Standard
8578 \change_inserted 564990737 1671617528
8589 document class for writing letters according to the
8591 Deutsches Institut für Normung
8594 The file in the menu
8599 ile\SpecialChar menuseparator
8601 \begin_inset space ~
8609 \begin_inset space ~
8612 Template\SpecialChar menuseparator
8613 Letters\SpecialChar menuseparator
8616 offers guidance on its use.
8617 The documentation is available from
8618 \begin_inset CommandInset href
8621 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
8629 \begin_layout Subsection
8631 \change_inserted 564990737 1671458835
8637 \begin_layout Standard
8639 \change_inserted 564990737 1671617591
8650 document class for English letters and to create mailing labels.
8651 The file in the menu
8656 ile\SpecialChar menuseparator
8658 \begin_inset space ~
8666 \begin_inset space ~
8669 Template\SpecialChar menuseparator
8670 Letters\SpecialChar menuseparator
8671 Letter (Standard Class)
8673 offers guidance on its use.
8676 \begin_layout Section
8678 \change_inserted 564990737 1670439660
8682 \begin_layout Subsection
8684 \change_inserted 564990737 1671458922
8690 \begin_layout Standard
8692 \change_inserted 564990737 1671617655
8698 \begin_inset space \thinspace{}
8707 document class for creating presentations.
8708 The file in the menu
8713 ile\SpecialChar menuseparator
8715 \begin_inset space ~
8723 \begin_inset space ~
8726 Template\SpecialChar menuseparator
8727 Presentations\SpecialChar menuseparator
8730 offers guidance on its use.
8731 The documentation is available from
8732 \begin_inset CommandInset href
8735 target "http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf"
8743 \begin_layout Subsection
8746 Foil\SpecialChar TeX
8750 \begin_inset CommandInset label
8759 \begin_layout Standard
8765 \begin_layout Subsubsection
8769 \begin_layout Standard
8770 This section describes how to use \SpecialChar LyX
8771 to make slides for overhead projectors.
8772 There are two document classes that can do this: the default slides class
8775 Foil\SpecialChar TeX
8779 This section documents the latter.
8782 \begin_layout Standard
8783 I'm going to say this again, nice and clear, so that there's no misunderstanding
8787 \begin_layout Standard
8788 \begin_inset VSpace bigskip
8794 \begin_layout Standard
8798 This section documents the class
8799 \begin_inset Quotes eld
8807 \begin_inset Quotes erd
8815 \begin_layout Standard
8816 \begin_inset VSpace bigskip
8822 \begin_layout Standard
8823 If you're looking for the documentation for
8824 \begin_inset Quotes eld
8832 \begin_inset Quotes erd
8836 \begin_inset space ~
8840 \begin_inset CommandInset ref
8843 reference "sec:slitex"
8848 If your machine doesn't have the
8856 installed, you'll probably have to use the default
8860 class, which isn't quite as good as
8865 \begin_layout Standard
8870 class is designed for use with version
8871 \begin_inset space ~
8879 class file which is now an integral part of \SpecialChar LaTeX2e
8883 \begin_layout Subsubsection
8887 \begin_layout Standard
8888 Obviously, to use this document class, you need to select
8899 \begin_inset space ~
8905 There are some settings in the
8908 \begin_inset space ~
8913 dialog that you should know about that are specific to this class:
8916 \begin_layout Itemize
8917 Don't change the options
8928 \begin_inset space ~
8934 They're ignored by the
8941 \begin_layout Itemize
8942 The default font size is 20
8943 \begin_inset space \thinspace{}
8946 pt with the other options being 17
8947 \begin_inset space \thinspace{}
8951 \begin_inset space \thinspace{}
8955 \begin_inset space \thinspace{}
8961 \begin_layout Itemize
8970 but all math equations are still typeset in the usual roman font.
8973 \begin_layout Itemize
8976 Foil\SpecialChar TeX
8979 supports A4 and Letter paper sizes as well as a special size for working
8981 \begin_inset space \thinspace{}
8985 It doesn't support A5, B5, legal or executive paper sizes.
8988 \begin_layout Itemize
8989 Don't bother changing the
8993 settings because they are ignored anyway.
8994 All floats appear where they are defined in the text.
8997 \begin_layout Itemize
9002 setting behaves a bit differently for this class.
9005 Foil\SpecialChar TeX
9008 provides extensive footer and header capabilities including a user-defined
9011 \begin_inset space ~
9015 \begin_inset CommandInset ref
9018 reference "sec:foilfoot"
9023 The title page is treated differently to all other pages in the document
9032 has the logo centered at the bottom of the page (if one is defined).
9033 The possible page style choices and what they do are as follows:
9037 \begin_layout Labeling
9038 \labelwidthstring MMMMMMM
9045 The final output contains no page numbers, or other headers or footers
9046 (except footnotes of course).
9050 \begin_layout Labeling
9051 \labelwidthstring MMMMMMM
9058 The final output contains page numbers centered at the bottom of the page.
9059 No other headings or footers (other than footnotes).
9062 \begin_layout Labeling
9063 \labelwidthstring MMMMMMM
9068 Page numbers in lower right corner.
9069 Additional headers and footers are also shown.
9070 This is also the default.
9073 \begin_layout Labeling
9074 \labelwidthstring MMMMMMM
9079 Gives you access to the
9083 package although its use with
9085 Foil\SpecialChar TeX
9088 is discouraged by the writer of the
9090 Foil\SpecialChar TeX
9093 package because of some potential page layout clashes.
9097 \begin_layout Paragraph
9101 \begin_layout Standard
9102 The following options may be used in the extra class options in the
9104 Document\SpecialChar menuseparator
9110 \begin_layout Labeling
9111 \labelwidthstring MMMMMMx
9116 This sets up the page layout for 7.33
9117 \begin_inset space \thinspace{}
9121 \begin_inset space \thinspace{}
9124 in paper, which is about the same aspect ratio as a 35
9125 \begin_inset space \thinspace{}
9128 mm slide, making it a bit easier to work with this medium.
9131 \begin_layout Labeling
9132 \labelwidthstring MMMMMMx
9137 Places a rule across the page below the header on every page except the
9141 \begin_layout Labeling
9142 \labelwidthstring MMMMMMx
9147 Places a rule across the page above the footer on every page except the
9151 \begin_layout Labeling
9152 \labelwidthstring MMMMMMx
9157 This is automatically set each time you create a new
9164 Foil\SpecialChar TeX
9167 to use the dvips driver to rotate those pages that are set as landscape
9171 \begin_layout Labeling
9172 \labelwidthstring MMMMMMx
9177 Simply changes the page dimensions to those of a landscape page but doesn't
9179 Thus if you use this option you need to use an external program to rotate
9180 each page or feed your paper through your printer as landscape.
9181 Note that this option effectively reverses the roles of the
9189 environments (don't worry these are described in the next section).
9192 \begin_layout Labeling
9193 \labelwidthstring MMMMMMx
9198 Equation numbers on the left.
9201 \begin_layout Labeling
9202 \labelwidthstring MMMMMMx
9207 Flush-left equations.
9210 \begin_layout Subsubsection
9211 Supported Environments
9214 \begin_layout Standard
9215 Most of the environments commonly supported in other classes are also supported
9221 There are several additional environments provided by
9223 Foil\SpecialChar TeX
9226 as well as a couple added by \SpecialChar LyX
9228 The following environments are shared with other classes:
9231 \begin_layout Standard
9232 \begin_inset Flex Multiple Columns
9235 \begin_layout Itemize
9241 \begin_layout Itemize
9247 \begin_layout Itemize
9253 \begin_layout Itemize
9259 \begin_layout Itemize
9265 \begin_layout Itemize
9272 \begin_layout Itemize
9278 \begin_layout Itemize
9284 \begin_layout Itemize
9290 \begin_layout Itemize
9296 \begin_layout Itemize
9302 \begin_layout Itemize
9308 \begin_layout Itemize
9314 \begin_layout Itemize
9320 \begin_layout Itemize
9331 \begin_layout Standard
9332 That is, all the major environments apart from the sectioning environments.
9333 Since foils are essentially self-contained sections, with a title and body,
9336 Foil\SpecialChar TeX
9339 provides specific commands for starting new foils and these are:
9342 \begin_layout Itemize
9348 \begin_layout Itemize
9354 \begin_layout Standard
9356 also provides slightly modified versions of these two environments called:
9359 \begin_layout Itemize
9365 \begin_layout Itemize
9371 \begin_layout Standard
9372 and the differences will be explained in the next section.
9375 \begin_layout Standard
9376 Since foils are often used in presenting ideas or new theorems and such
9379 Foil\SpecialChar TeX
9382 also provides a comprehensive box of goodies for presenting them:
9385 \begin_layout Standard
9386 \begin_inset Flex Multiple Columns
9389 \begin_layout Itemize
9395 \begin_layout Itemize
9401 \begin_layout Itemize
9407 \begin_layout Itemize
9413 \begin_layout Itemize
9419 \begin_layout Itemize
9425 \begin_layout Itemize
9431 \begin_layout Itemize
9437 \begin_layout Itemize
9443 \begin_layout Itemize
9449 \begin_layout Itemize
9460 \begin_layout Standard
9461 The starred versions are unnumbered while the unstarred versions are numbered.
9462 There are also two list environments added by \SpecialChar LyX
9466 \begin_layout Itemize
9472 \begin_layout Itemize
9478 \begin_layout Standard
9481 Foil\SpecialChar TeX
9484 provides some powerful header and footer capabilities that are best set
9485 in the preamble although they may be set at any point in a document.
9486 If you want to change these settings in your document the best place to
9487 do so is at the very top of a foil, i.
9488 \begin_inset space \thinspace{}
9494 \begin_inset space \space{}
9499 straight after the foilhead.
9502 \begin_layout Standard
9503 For this purpose, the following command styles are provided [
9510 \begin_layout Standard
9511 \begin_inset Flex Multiple Columns
9514 \begin_layout Itemize
9518 \begin_inset space ~
9524 \begin_layout Itemize
9530 \begin_layout Itemize
9534 \begin_inset space ~
9540 \begin_layout Itemize
9544 \begin_inset space ~
9550 \begin_layout Itemize
9554 \begin_inset space ~
9561 \begin_layout Plain Layout
9562 \begin_inset space ~
9574 \begin_layout Standard
9575 There are also a few commands provided by
9577 Foil\SpecialChar TeX
9580 that aren't directly supported by \SpecialChar LyX
9581 but I'll tell you what they do and how
9582 to use them in section
9583 \begin_inset space ~
9587 \begin_inset CommandInset ref
9590 reference "sec:unsuppfoils"
9597 \begin_layout Subsubsection
9598 Building a Set of Foils
9601 \begin_layout Standard
9602 This section will give a simple introduction to using the different environments
9603 to build a set of foils.
9604 If you want to see an example set of foils, take a look at
9605 \change_deleted 564990737 1671643085
9610 file you find in \SpecialChar LyX
9616 \change_inserted 564990737 1671643099
9620 File\SpecialChar menuseparator
9623 \SpecialChar menuseparator
9624 Presentations\SpecialChar menuseparator
9632 \begin_layout Paragraph
9633 Give It a Title Page
9636 \begin_layout Standard
9637 Unlike other classes that provide
9657 creates the title on a page of its own.
9658 If you leave out the
9662 environment \SpecialChar LaTeX
9663 will substitute the current date (every time you regenerate
9667 \begin_layout Paragraph
9671 \begin_layout Standard
9672 As I mentioned earlier, there are four ways of starting a new foil.
9673 For portrait foils you should use
9682 The difference between these two environments is the amount of space between
9683 the title of the foil (the foilhead) and the body of the foil.
9686 \begin_layout Standard
9687 Landscape foils are generated using the
9696 Again the only difference is the spacing between foilhead and body.
9697 Both of the short versions have 0.5
9698 \begin_inset space ~
9701 inches less separation between the foilhead and the body.
9705 \begin_layout Standard
9706 One problem with the support for landscape foils is the requirement that
9711 driver to generate the PostScript output otherwise the foils won't be rotated.
9712 It is possible to get landscape foils even if you haven't got the
9716 driver provided you can feed your foils sideways through your printer ;-)
9719 \begin_layout Paragraph
9720 Theorems, Lemmas, Proofs and more
9723 \begin_layout Standard
9724 You can't have two of the same type of these environments directly following
9726 If you use a normal paragraph break, , you will just be extending the previous
9727 environment as if you had merged the two environments together.
9728 Rather than that, you need to insert a so-called separator.
9729 Please refer to the section entitled
9740 \begin_layout Paragraph
9744 \begin_layout Standard
9745 You get all the commonly supported list styles found in other classes as
9746 well as two new ones.
9747 I'll only describe the new ones here.
9748 If you want to find out more about the other list environments check out
9754 If you intend to use itemized lists you might also want to read about the
9758 \begin_inset space ~
9762 \begin_inset space ~
9767 dialog described above in section
9768 \begin_inset space ~
9772 \change_inserted 564990737 1671355684
9774 \begin_inset CommandInset ref
9777 reference "chap:bullets"
9782 \change_deleted 564990737 1671355684
9784 \begin_inset CommandInset ref
9787 reference "sec:bullet"
9796 \begin_layout Standard
9797 The two new list styles,
9805 , are designed to make it easier for you to create lists of do's and don'ts
9806 or right and wrong by providing dedicated environments that use a tick
9807 or a cross as the label of the list.
9808 These lists are in fact dedicated variants of the
9813 They do however require that you have the
9820 \begin_layout Paragraph
9824 \begin_layout Standard
9827 Foil\SpecialChar TeX
9830 redefines the floating tables and figures so that they appear exactly where
9831 they are in the text rather than pushing them to the top of the page or
9832 to some user specified location.
9833 In fact if you change the float placement settings they are simply ignored.
9836 \begin_layout Paragraph
9837 Page Headers and Footers
9838 \begin_inset CommandInset label
9847 \begin_layout Standard
9851 \begin_inset space ~
9860 are two commands used to control the left-footer text string.
9861 The first is meant to allow you to include a graphic logo on your foils
9863 \begin_inset Quotes eld
9868 Foil\SpecialChar TeX
9872 \begin_inset Quotes erd
9876 While the second is meant to provide a classification for the audience,
9880 \begin_inset space \thinspace{}
9886 \begin_inset space \space{}
9890 It is empty by default.
9893 \begin_layout Standard
9894 The remaining page corners can be filled by
9897 \begin_inset space ~
9902 (which defaults to page numbers),
9905 \begin_inset space ~
9913 \begin_inset space ~
9921 \begin_layout Subsubsection
9924 Foil\SpecialChar TeX
9928 \begin_inset CommandInset label
9930 name "sec:unsuppfoils"
9937 \begin_layout Standard
9938 All the commands mentioned below need to be set in a
9948 within another environment.
9951 \begin_layout Paragraph
9955 \begin_layout Standard
9956 All lengths are adjusted using the
9979 should be replaced by the name given to the length you want to change and
9984 is the length value.
9985 All lengths should be specified in units of length such as inches (
9997 ) or relative to some document or font-based length such as
10007 \begin_layout Standard
10008 It's possible to change the spacing between a foilhead and the body of the
10009 foil by adjusting the length specified by
10016 For example, to make
10021 \begin_inset space \space{}
10024 in closer to their bodies put the following in the preamble:
10030 foilheadskip}{-0.5in}
10033 \begin_layout Standard
10034 The spacings around floats can be adjusted by setting these lengths:
10037 \begin_layout Labeling
10038 \labelwidthstring MMMMMMMMMMM
10045 Separation between the text and the top of the float
10048 \begin_layout Labeling
10049 \labelwidthstring MMMMMMMMMMM
10056 Separation between the float and the caption
10059 \begin_layout Labeling
10060 \labelwidthstring MMMMMMMMMMM
10067 Separation between the caption and the following text
10070 \begin_layout Labeling
10071 \labelwidthstring MMMMMMMMMMM
10078 You can make the captions narrower than the surrounding text by adjusting
10080 Best done relative to
10089 \begin_layout Standard
10090 There are also several title page related lengths that you may find useful
10091 if you have a long title or several authors:
10094 \begin_layout Labeling
10095 \labelwidthstring MMMMMMMMMMM
10102 Separation from headers to
10107 \begin_layout Labeling
10108 \labelwidthstring MMMMMMMMMMM
10126 \begin_layout Labeling
10127 \labelwidthstring MMMMMMMMMMM
10141 \begin_layout Labeling
10142 \labelwidthstring MMMMMMMMMMM
10158 \begin_layout Labeling
10159 \labelwidthstring MMMMMMMMMMM
10175 \begin_layout Standard
10176 The last length related command affects all the list environments.
10187 a list environment then all the vertical spacing between the list items
10189 Note that this is a command not a length so it doesn't require
10195 like the stuff mentioned above.
10198 \begin_layout Paragraph
10199 Headers and Footers
10202 \begin_layout Standard
10215 commands control whether the logo in the
10219 definition appear on a given page.
10226 in the preamble then none of the foils will have the logo on them.
10227 If you don't want the logo on a particular page place the
10233 directly after the foilhead of that page and the
10239 directly after the next foilhead.
10242 \begin_layout Standard
10243 If you decide to use the
10247 page style setting in the
10250 \begin_inset space ~
10255 dialog you should probably add
10265 to your preamble so headers and footers on landscape pages are correctly
10266 placed when rotated.
10267 This is due to some clashes between the page layouts provided by the
10278 \begin_layout Subsection
10280 \change_inserted 564990737 1671459032
10286 \begin_layout Standard
10288 \change_inserted 564990737 1671643165
10294 \begin_inset space \thinspace{}
10303 document class for creating presentations.
10307 File\SpecialChar menuseparator
10308 Open Example\SpecialChar menuseparator
10309 Presentations\SpecialChar menuseparator
10313 offers guidance on its use.
10314 The documentation is available from
10315 \begin_inset CommandInset href
10318 target "http://mirrors.ctan.org/macros/latex/contrib/powerdot/doc/powerdot.pdf"
10326 \begin_layout Subsection
10328 \change_inserted 564990737 1671459032
10331 \begin_inset CommandInset label
10333 name "subsec:Seminar"
10342 \begin_layout Standard
10344 \change_inserted 564990737 1671643194
10350 \begin_inset space \thinspace{}
10359 document class for creating presentations.
10363 File\SpecialChar menuseparator
10364 Open Example\SpecialChar menuseparator
10365 Presentations\SpecialChar menuseparator
10369 offers guidance on its use.
10370 The documentation is available from
10371 \begin_inset CommandInset href
10374 target "http://mirrors.ctan.org/macros/latex/contrib/seminar/doc/seminar-doc.pdf"
10382 \begin_layout Subsection
10385 Sli\SpecialChar TeX
10389 \begin_inset CommandInset label
10398 \begin_layout Standard
10406 \begin_layout Subsubsection
10410 \begin_layout Standard
10411 This section describes how to use \SpecialChar LyX
10412 to make slides for overhead projectors.
10413 There are two document classes that can do this: the default slides class
10416 Foil\SpecialChar TeX
10420 This section documents the former.
10423 \begin_layout Standard
10424 I'm going to say this again, nice and clear, so that there's no misunderstanding
10428 \begin_layout Standard
10429 \begin_inset VSpace bigskip
10435 \begin_layout Standard
10439 This section documents the class
10440 \begin_inset Quotes eld
10448 \begin_inset Quotes erd
10456 \begin_layout Standard
10457 \begin_inset VSpace bigskip
10463 \begin_layout Standard
10464 If you're looking for the documentation for
10465 \begin_inset Quotes eld
10470 slides (Foil\SpecialChar TeX
10474 \begin_inset Quotes erd
10477 , check out section
10478 \begin_inset space ~
10482 \begin_inset CommandInset ref
10485 reference "sec:foiltex"
10495 \begin_inset Quotes eld
10500 slides (Foil\SpecialChar TeX
10504 \begin_inset Quotes erd
10507 ] is actually somewhat better than the default
10515 \begin_layout Plain Layout
10517 or so I've been told repeatedly by its advocates.
10518 Having never used it, I have no idea if this claim is true or not.
10523 which this section documents.
10526 \begin_layout Standard
10527 This class is the \SpecialChar LaTeX2e
10528 improvement of the old
10530 Sli\SpecialChar TeX
10534 Every \SpecialChar LaTeX2e
10535 distribution includes this class [which I'll just refer to as
10536 \begin_inset Quotes eld
10544 \begin_inset Quotes erd
10547 from now on], so you're bound to have it.
10548 As I noted earlier, there are other classes, such as
10552 , which also produce slides for overhead projectors and do a better job
10554 However, there are some things which
10558 can do which the others can't, such as generate overlays.
10559 Read on to learn more!
10562 \begin_layout Subsubsection
10564 \begin_inset CommandInset label
10566 name "sec:slidesetup"
10573 \begin_layout Standard
10574 Obviously, to use this document class, you need to select
10575 \begin_inset Quotes eld
10583 \begin_inset Quotes erd
10586 from the class list in the
10588 Document\SpecialChar menuseparator
10592 There are some other special things you should know about this class:
10595 \begin_layout Itemize
10596 Don't bother changing the options
10601 They're not supported by the
10608 \begin_layout Itemize
10612 \begin_inset space ~
10617 behaves a bit differently for this class.
10618 The possible choices and what they do are as follows:
10622 \begin_layout Description
10627 The final output contains page numbers in the lower right corner.
10630 \begin_layout Description
10639 , but also prints out any time markers you've put in.
10640 This is the default.
10643 \begin_layout Description
10648 The final output contains no page numbers, time markers, or alignment markers.
10652 \begin_layout Itemize
10657 class has an extra option:
10663 \begin_inset Quotes eld
10671 \begin_inset Quotes erd
10674 in the extra class options.
10678 \begin_layout Standard
10679 Using this options allows you to add time markers to
10685 \begin_inset space ~
10689 \begin_inset CommandInset ref
10692 reference "sec:slideNote"
10700 \begin_layout Standard
10701 You can also use the template file
10702 \change_deleted 564990737 1671617694
10704 \begin_inset Quotes eld
10712 \begin_inset Quotes erd
10717 to automatically set up a document to use the
10722 \change_deleted 564990737 1671617699
10727 File\SpecialChar menuseparator
10729 \begin_inset space ~
10733 \begin_inset space ~
10737 \change_inserted 564990737 1671617723
10738 \SpecialChar menuseparator
10739 Presentations\SpecialChar menuseparator
10744 to open your new document
10745 \change_deleted 564990737 1671617728
10749 The template file also contains some examples of the special paragraph
10750 environments used by this class.
10751 I'll describe those next.
10754 \begin_layout Subsubsection
10755 Paragraph Environments
10758 \begin_layout Paragraph
10759 Supported Environments
10762 \begin_layout Standard
10763 The first thing you'll notice when you start up a new
10767 document is the font size and type: it's the equivalent of the size
10768 \begin_inset Quotes eld
10776 \begin_inset Quotes erd
10782 \begin_inset space ~
10788 This is also what's used in the output.
10790 \begin_inset Quotes eld
10794 \begin_inset Quotes erd
10797 to remind you that this is a slide.
10798 Your final slides will use a larger font; ergo, you'll have less space.
10799 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
10802 \begin_layout Standard
10803 The next thing that becomes obvious is the changes to the paragraph environment
10804 pull-down box [at the far-left end of the toolbar].
10805 Most of the paragraph environments you're used to seeing are missing.
10806 There are also five new ones.
10811 class itself only supports certain paragraph environments:
10814 \begin_layout Itemize
10820 \begin_layout Itemize
10826 \begin_layout Itemize
10832 \begin_layout Itemize
10838 \begin_layout Itemize
10844 \begin_layout Itemize
10850 \begin_layout Itemize
10856 \begin_layout Itemize
10862 \begin_layout Itemize
10868 \begin_layout Itemize
10875 \begin_layout Standard
10876 All of the other standard environments, including the section-heading environmen
10877 ts, aren't used in the
10884 \begin_layout Standard
10885 On the other hand, you'll notice the following new environments:
10888 \begin_layout Itemize
10894 \begin_layout Itemize
10900 \begin_layout Itemize
10906 \begin_layout Itemize
10912 \begin_layout Itemize
10918 \begin_layout Standard
10919 These five are kind of quirky, due to a
10920 \begin_inset Quotes eld
10924 \begin_inset Quotes erd
10927 in \SpecialChar LyX
10929 You see, \SpecialChar LyX
10930 doesn't permit you to nest any other paragraph environment into
10931 an empty environment.
10932 Now, that's fine and dandy, but it means that you wouldn't be able to start
10933 a slide with anything except plain text.
10934 To deal with this, I've performed a little
10935 \begin_inset Quotes eld
10940 \begin_inset Quotes erd
10946 \begin_layout Paragraph
10947 Quirks of the New Environments
10948 \begin_inset CommandInset label
10950 name "sec:slideQuirk"
10957 \begin_layout Standard
10958 All five of the new paragraph environments are somewhat quirky due to inherent
10959 limitiations in the current version of \SpecialChar LyX
10961 As I just mentioned, \SpecialChar LyX
10962 forbids environments that begin with another environment.
10963 To get around this, the
10967 environment isn't a paragraph environment as described in the
10975 \begin_layout Standard
10976 You should consider
10989 \begin_inset Quotes eld
10992 pseudo-environments.
10993 \begin_inset Quotes erd
10996 They look like a section heading or a
10997 \begin_inset Quotes eld
11005 \begin_inset Quotes erd
11008 but really begin a [and, if necessary, end the previous] paragraph environment.
11018 \begin_inset Quotes eld
11022 \begin_inset Quotes erd
11025 These two perform some action.
11028 \begin_layout Standard
11029 A common feature of all five environments,
11049 , is a rather long-ish label.
11050 The text following this label — ordinarily the contents of the paragraph
11051 environment — is utterly irrelevant for
11073 completely ignores it.
11074 In fact, you can leave these five environments completely empty.
11078 \begin_layout Standard
11083 to put any text after the rather long-ish label, you might want to.
11084 This could be a short description of the contents of the
11089 In that case, enter your descriptive comment and hit
11093 as you normally would.
11096 \begin_layout Standard
11097 If, on the other hand, you don't want to enter any descriptive text, you'll
11098 hit another \SpecialChar LyX
11101 , like nature, abhors a vacuum, and will not let you start a new paragraph
11102 environment until you put something in the old one.
11106 \begin_layout Itemize
11107 Start entering the text that will
11135 \begin_layout Itemize
11136 Now move to the beginning of that paragraph.
11140 \begin_layout Itemize
11149 \begin_layout Itemize
11150 Finally, change this new, empty paragraph to a
11174 \begin_layout Standard
11175 Some future version of \SpecialChar LyX
11176 will, hopefully, resolve this quirkiness\SpecialChar ldots
11180 \begin_layout Subsubsection
11181 Making a Presentation with
11194 \begin_layout Paragraph
11202 \begin_layout Standard
11203 If you're expecting this section to teach you how to actually make a presentatio
11204 n, you'll be sorely disappointed.
11205 Naturally, I'll describe all of the ways the
11209 class can assist you in preparing the materials for a presentation.
11210 Filling in the contents, however, is up to you.
11215 the \SpecialChar LyX
11219 \begin_layout Standard
11224 environment [in the manner described in section
11225 \begin_inset space ~
11229 \begin_inset CommandInset ref
11232 reference "sec:slideQuirk"
11236 ] tells \SpecialChar LyX
11237 to begin a new slide [duh].
11238 The label for this environment/
11239 \begin_inset Quotes erd
11243 \begin_inset Quotes erd
11247 \begin_inset Quotes eld
11251 \begin_inset Quotes erd
11254 in cool blue, followed by the label,
11255 \begin_inset Quotes eld
11259 \begin_inset Quotes erd
11263 Any text or paragraph environments that follow this one go on the new slide.
11267 \begin_layout Standard
11268 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
11270 (this can be specified in the
11275 In fact, you'll want to, once you finish entering the contents of one slide.
11276 If you've entered more text than can physically fit on a slide, the extra
11277 overflows onto a new slide.
11278 I don't recommend doing this, however, since the overflow slide won't have
11279 any page number on it.
11280 Furthermore, it may interfere with any
11284 you've made to accompany the oversized
11291 \begin_layout Standard
11300 environments work the same way as the
11305 They both create an
11306 \begin_inset Quotes eld
11310 \begin_inset Quotes erd
11313 followed by a label [
11314 \begin_inset Quotes eld
11318 \begin_inset Quotes erd
11322 \begin_inset Quotes eld
11326 \begin_inset Quotes erd
11330 The color is a stunning magenta instead of blue, and the
11331 \begin_inset Quotes eld
11335 \begin_inset Quotes erd
11338 will look different, in style and in length.
11339 The label fonts of all three also differ from one another.
11342 \begin_layout Standard
11347 , if the contents of a
11355 exceed the physical size of a slide or sheet of paper, the extra will overflow
11357 Again, you should avoid this.
11358 It defeats the whole purpose of
11369 \begin_layout Paragraph
11379 \begin_layout Standard
11384 is a slide that sits atop another slide.
11385 Perhaps you wish to discuss a figure on the main
11389 before displaying the text associated with it.
11390 One way to accomplish this is tape a flap of dark paper over the part of
11395 you want to display later.
11396 This method fails, however, if you wish to overlap one graph with another,
11398 You would then have to fumble while speaking to align the two separate,
11403 s to align the two graphs.
11408 environment in both cases makes life much easier.
11411 \begin_layout Standard
11416 receives the page number of its
11417 \begin_inset Quotes eld
11421 \begin_inset Quotes erd
11429 \begin_inset Quotes eld
11437 \begin_inset Quotes erd
11444 \begin_layout Plain Layout
11445 Presumably, mutliple
11450 \begin_inset Quotes eld
11458 \begin_inset Quotes erd
11462 \begin_inset Quotes eld
11470 \begin_inset Quotes erd
11474 \begin_inset Quotes eld
11482 \begin_inset Quotes erd
11486 \begin_inset space ~
11489 appended to the page number of the parent
11499 Clearly, you want the contents of both the
11507 to each fit on a single physical slide! You should probably consider an
11513 \begin_inset Quotes eld
11517 \begin_inset Quotes erd
11525 Indeed, the \SpecialChar LyX
11530 class provides a visual cue for this: the label at the start of an
11534 is shorter than that at the start of a
11539 Lastly, when you generate printable output, you'll find alignment markers
11540 in all four corners of both the
11544 page and its parent
11549 These will assist you in lining up the two physical slides.
11552 \begin_layout Standard
11553 The major problem in overlaying two slides is aligning the contents of the
11554 two transparencies.
11555 How much space should you leave for that graph on the second slide? Worse
11556 still, what if you want a graph and a sentence on second slide, but there
11557 is text on the main transparency that goes in between them? You could try
11558 and insert vertical space of the right size.
11559 The better way is to use
11570 \begin_layout Standard
11571 As their names imply,
11579 are two command-like paragraph environments that make all subsequent text
11580 invisible and visible, respectively.
11582 \begin_inset space ~
11586 \begin_inset CommandInset ref
11589 reference "sec:slideQuirk"
11593 that you don't place anything
11597 these two environments, however.
11602 , it inserts a centered, sky-blue label into the page reading
11603 \begin_inset Quotes eld
11606 <Invisible Text Follows>
11607 \begin_inset Quotes erd
11611 For paragraphs following this label, the parts of the
11619 ; it doesn't matter which] where they would be contain instead blank space.
11623 \begin_layout Standard
11628 , the corresponding centered label is
11629 \begin_inset Quotes eld
11632 <Visible Text Follows>
11633 \begin_inset Quotes erd
11637 Paragraphs following this label behave normally.
11638 Note that the beginning of a new
11650 automatically shuts off an
11655 It's therefore not necessary to use
11666 \begin_layout Standard
11667 By now, it should be obvious how to create overlay transparencies using
11668 the proper combination of
11687 \begin_layout Enumerate
11692 , including everything that will appear on it, whether on the main slide
11700 \begin_layout Enumerate
11701 Before each figure or paragraph that will appear only on the
11710 If necessary, insert a
11714 environment after the
11721 \begin_layout Enumerate
11726 immediately following the
11733 \begin_layout Enumerate
11734 Copy the contents of this
11745 \begin_layout Enumerate
11750 , change all of the
11761 \begin_layout Standard
11763 You've just made an
11770 \begin_layout Standard
11771 There's one problem with the way I've designed the \SpecialChar LyX
11776 class: you can't make text in the middle of a paragraph invisible, nor
11777 make text in the middle of an invisible paragraph visible again.
11778 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
11783 \begin_layout Plain Layout
11784 The commands of interest are:
11787 \begin_layout Itemize
11792 invisible \SpecialChar ldots
11796 \begin_layout Itemize
11801 visible \SpecialChar ldots
11805 \begin_layout Plain Layout
11807 and need to be marked as \SpecialChar TeX
11810 \begin_inset Quotes eld
11814 \begin_inset Quotes erd
11817 you wish to change goes in between the brackets [and after the
11830 If you don't know how to mark text as \SpecialChar TeX
11831 , see the appropriate section of
11844 \begin_layout Paragraph
11854 \begin_inset CommandInset label
11856 name "sec:slideNote"
11863 \begin_layout Standard
11872 is associated with a
11873 \begin_inset Quotes eld
11877 \begin_inset Quotes erd
11885 Here, too, the \SpecialChar LyX
11890 class provides visual cues.
11895 is shorter than that of a
11899 [yet longer than that of an
11903 ] and, like the label of an
11907 is shockingly magenta.
11908 Additionally, the printed
11912 has the page number of its
11913 \begin_inset Quotes eld
11917 \begin_inset Quotes erd
11925 \begin_inset Quotes eld
11933 \begin_inset Quotes erd
11937 \begin_inset Quotes eld
11945 \begin_inset Quotes erd
11949 \begin_inset Quotes eld
11957 \begin_inset Quotes erd
11961 You can have multiple
11965 s associated with a single
11977 , you'll probably want to break up long
11981 s so that they fit on a single sheet of paper.
11984 \begin_layout Standard
11989 is obvious: it contains anything additional you might want to say about
11995 It could also be used as a sheet of reminders for a particular
12000 In the case of the latter, you might want to make use of time markers.
12001 Currently, the \SpecialChar LyX
12007 \begin_inset Quotes eld
12011 \begin_inset Quotes erd
12014 support for time markers, a
12016 Sli\SpecialChar TeX
12020 So, you'll have to resort to using the \SpecialChar LaTeX
12024 \begin_layout Standard
12025 To use time markers, you'll need to specify the extra class option
12026 \begin_inset Quotes eld
12034 \begin_inset Quotes erd
12038 \begin_inset space ~
12042 \begin_inset CommandInset ref
12045 reference "sec:slidesetup"
12050 This option turns on timing marks, which will appear in the lower-left-hand
12056 To set what appears in the time marker, you use the \SpecialChar LaTeX
12058 \begin_inset Quotes eld
12068 \begin_inset Quotes erd
12072 \begin_inset Quotes eld
12082 \begin_inset Quotes erd
12086 The arguments of both commands are time measured in seconds.
12088 \begin_inset Quotes eld
12098 \begin_inset Quotes erd
12101 sets the time marker to a given time.
12103 \begin_inset Quotes eld
12113 \begin_inset Quotes erd
12116 increments the time marker by the specified amount.
12117 Using time markers and
12121 s in this fashion, you can remind yourself how much time to spend on a particula
12129 \begin_layout Standard
12130 There's one last feature to describe.
12131 Clearly, you'd like to print out all of your
12139 s on transparencies while printing all of your
12156 with which it is associated.
12157 What's a person to do?
12160 \begin_layout Standard
12161 Luckily, there are two \SpecialChar LaTeX
12162 commands that allow you to select what to print
12164 Both must be placed into the preamble of your document.
12166 \begin_inset Quotes eld
12178 \begin_inset Quotes erd
12181 will cause the output to contain only the
12190 Correspondingly, the command
12191 \begin_inset Quotes eld
12203 \begin_inset Quotes erd
12206 prevents the output of anything but
12211 I'd advise placing both commands in the preamble and initially comment
12213 You can then preview your entire presentation as you write.
12214 When you're done writing, you can then uncomment one of the two to select
12215 what you want to print.
12216 I like to uncomment
12217 \begin_inset Quotes eld
12229 \begin_inset Quotes erd
12232 , print to a file with
12233 \begin_inset Quotes eld
12241 \begin_inset Quotes erd
12244 in its name, comment it back out, then uncomment
12245 \begin_inset Quotes eld
12257 \begin_inset Quotes erd
12261 \begin_inset Quotes eld
12269 \begin_inset Quotes erd
12273 I can then send either file to a printer, loading transparencies or plain
12274 paper as appropriate.
12277 \begin_layout Standard
12278 You can also provide other arguments to the
12279 \begin_inset Quotes eld
12289 \begin_inset Quotes erd
12293 \begin_inset Quotes eld
12303 \begin_inset Quotes erd
12307 See a good \SpecialChar LaTeX
12311 \begin_layout Subsubsection
12316 Class Template File
12319 \begin_layout Standard
12320 I have also provided a template file
12321 \change_deleted 564990737 1671617750
12323 \begin_inset Quotes eld
12331 \begin_inset Quotes erd
12341 To use it, begin your new presentation with
12343 File\SpecialChar menuseparator
12345 \begin_inset space ~
12349 \begin_inset space ~
12353 \change_inserted 564990737 1671616988
12354 \SpecialChar menuseparator
12355 Presentations\SpecialChar menuseparator
12361 Your new \SpecialChar LyX
12362 presentation file will contain an example
12383 additionally contain an example of the use of
12392 Lastly, the preamble will contain:
12395 \begin_layout LyX-Code
12396 % Uncomment to print out only slides and overlays
12399 \begin_layout LyX-Code
12403 \begin_layout LyX-Code
12409 \begin_inset Newline newline
12415 \begin_layout LyX-Code
12416 % Uncomment to print out only notes
12419 \begin_layout LyX-Code
12423 \begin_layout LyX-Code
12431 \begin_layout Standard
12432 One final thing: I created this class to support the \SpecialChar LaTeX2e
12434 \begin_inset Quotes eld
12439 Sli\SpecialChar TeX
12443 \begin_inset Quotes erd
12446 class, one of the built-in \SpecialChar LaTeX2e
12448 Neither I nor the rest of the \SpecialChar LyX
12449 Team endorse or oppose the use of this built-in
12451 It's here if you want it or need it.
12452 There exist other \SpecialChar LaTeX2e
12453 classes for creating presentations, such as the
12458 \begin_inset space ~
12462 \begin_inset CommandInset ref
12465 reference "sec:foiltex"
12470 \begin_inset Quotes eld
12478 \begin_inset Quotes erd
12481 package [present on some \SpecialChar TeX
12483 The latter is not yet supported under \SpecialChar LyX
12488 \begin_layout Plain Layout
12489 Perhaps you can take on the task\SpecialChar ldots
12495 I know nothing about these other classes.
12496 Try them out to see what sort of alternative they provide.
12499 \begin_layout Section
12501 \change_inserted 564990737 1670439661
12505 \begin_layout Subsection
12507 \change_inserted 564990737 1670439661
12511 \begin_layout Standard
12513 \change_inserted 564990737 1670439661
12522 document class for preparing reports.
12527 document class, this provides parts, chapters and sections but does not
12528 provide the paragraph styles needed for a book; like the
12532 document class, it provides the abstract paragraph style.
12533 In two-sided mode, it does not start a new chapter on the right hand page.
12536 \begin_layout Standard
12538 \change_inserted 564990737 1670439674
12543 document classes are described in the Collections (section
12544 \begin_inset space ~
12548 \begin_inset CommandInset ref
12551 reference "sec:Collections"
12558 \begin_layout Section
12560 \change_inserted 564990737 1670439674
12564 \begin_layout Subsection
12568 \begin_layout Standard
12574 \begin_layout Subsubsection
12578 \begin_layout Standard
12579 Broadway is for writing plays.
12580 The format is more decorative than Hollywood, and much less standardized.
12581 This format should be suitable for workshops.
12584 \begin_layout Subsubsection
12588 \begin_layout Standard
12589 The same as in Hollywood.
12592 \begin_layout Subsubsection
12596 \begin_layout Standard
12601 names as labels then cross-reference the label to insert the name.
12602 The cross-reference dialog will show the current cast of characters.
12605 \begin_layout Subsubsection
12606 Paper size and Margins
12609 \begin_layout Standard
12610 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12613 \begin_layout Subsubsection
12617 \begin_layout Standard
12618 The following environments are available.
12619 You can use broadway.bind to get the bind keys shown at the right.
12622 \begin_layout Itemize
12626 \begin_inset Newline newline
12631 You should not have to use this, but it is here for anything that does not
12635 \begin_layout Itemize
12639 \begin_inset space \hfill{}
12643 \begin_inset Newline newline
12648 Used to describe stage setting and the action.
12649 First use of speaker names in all CAPs.
12652 \begin_layout Itemize
12656 \begin_inset space \hfill{}
12660 \begin_inset Newline newline
12665 Automatically numbered.
12666 On screen it will be arabic, but will print as Roman.
12669 \begin_layout Itemize
12673 \begin_inset space \hfill{}
12677 \begin_inset Newline newline
12687 It is just centered text.
12690 \begin_layout Itemize
12694 \begin_inset space \hfill{}
12698 \begin_inset Newline newline
12703 Not automatically numbered.
12704 You supply the number.
12705 This is because I couldn't figure out how.
12708 \begin_layout Itemize
12712 \begin_inset space \hfill{}
12716 \begin_inset Newline newline
12721 A special case of Narrative to describe the setting and action as the curtain
12725 \begin_layout Itemize
12729 \begin_inset space \hfill{}
12733 \begin_inset Newline newline
12738 The speaker's (actor's) title, centered in all CAPS.
12741 \begin_layout Itemize
12745 \begin_inset space \hfill{}
12749 \begin_inset Newline newline
12754 Instructions to the speaker.
12755 The parentheses are automatically inserted.
12756 The ( will appear on screen, but both will be in the printed play.
12757 This environment is only used within
12764 \begin_layout Itemize
12768 \begin_inset space \hfill{}
12772 \begin_inset Newline newline
12777 What the Speaker says.
12780 \begin_layout Itemize
12784 \begin_inset space \hfill{}
12788 \begin_inset Newline newline
12793 The curtain comes down.
12796 \begin_layout Itemize
12800 \begin_inset space \hfill{}
12806 \begin_layout Itemize
12810 \begin_inset space \hfill{}
12816 \begin_layout Itemize
12820 \begin_inset space \hfill{}
12826 \begin_layout Standard
12830 \begin_layout Subsection
12831 Hollywood (Hollywood spec scripts)
12834 \begin_layout Standard
12840 \begin_layout Subsubsection
12844 \begin_layout Standard
12845 Getting the format of a Hollywood script right is a
12846 \begin_inset Quotes eld
12850 \begin_inset Quotes erd
12853 It is designed to make the readers focus on content and to be easy and
12854 familiar for the actors to read.
12855 Each page of a script should be one minute of film.
12856 Nothing goes in a script that you cannot see or hear on screen.
12857 The courier 12 pt font should be used throughout.
12861 \begin_layout Subsubsection
12865 \begin_layout Standard
12866 Speakers' lines should NEVER break in mid-sentence.
12867 If a speaker's lines continue over a page break, repeat the
12871 title followed by (Cont'd).
12874 \begin_layout Subsubsection
12878 \begin_layout Standard
12883 names as labels then cross-reference the label to insert the name.
12884 The cross-reference dialog will show the current cast of characters.
12885 You can use this to insert the speaker name in narratives also.
12888 \begin_layout Subsubsection
12889 Paper size and Margins
12892 \begin_layout Standard
12893 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12896 \begin_layout Subsubsection
12900 \begin_layout Standard
12901 The following environments are available.
12902 You can use hollywood.bind to get the bind keys shown at the right.
12905 \begin_layout Itemize
12909 \begin_inset Newline newline
12914 Used where nothing else works.
12918 \begin_layout Itemize
12924 \begin_inset space \hfill{}
12932 \begin_inset Newline newline
12935 Usually followed by something like
12936 \begin_inset Quotes eld
12939 on Sally waking up.
12940 \begin_inset Quotes erd
12946 \begin_layout Itemize
12950 \begin_inset space \hfill{}
12954 \begin_inset Newline newline
12959 Introduces a new INTERIOR camera set-up.
12960 Always followed by DAY or NIGHT, or something similar to define the lighting
12962 Everthing on this line in CAPS.
12965 \begin_layout Itemize
12969 \begin_inset space \hfill{}
12973 \begin_inset Newline newline
12978 Introduces a new EXTERIOR camera set-up.
12979 Everthing on this line in CAPS.
12982 \begin_layout Itemize
12986 \begin_inset space \hfill{}
12990 \begin_inset Newline newline
12995 The character speaking.
12998 \begin_layout Itemize
13002 \begin_inset space \hfill{}
13006 \begin_inset Newline newline
13011 Instructions to the speaker.
13012 The () are automatically inserted.
13015 \begin_layout Itemize
13019 \begin_inset space \hfill{}
13023 \begin_inset Newline newline
13035 \begin_layout Itemize
13039 \begin_inset space \hfill{}
13043 \begin_inset Newline newline
13048 Camera movement instruction.
13050 \begin_inset space \thinspace{}
13054 \begin_inset space \space{}
13060 \begin_layout Itemize
13064 \begin_inset space \hfill{}
13070 \begin_layout Itemize
13074 \begin_inset space \hfill{}
13080 \begin_layout Itemize
13084 \begin_inset space \hfill{}
13090 \begin_layout Itemize
13094 \begin_inset space \hfill{}
13100 \begin_layout Subsubsection
13104 \begin_layout Itemize
13108 \begin_layout Itemize
13112 \begin_layout Itemize
13114 \begin_inset space \thinspace{}
13121 \begin_layout Itemize
13126 \begin_layout Itemize
13127 PAN — camera movement
13130 \begin_layout Itemize
13131 INSERT — cut to close-up of
13134 \begin_layout Chapter
13136 \change_inserted 564990737 1671185876
13140 \begin_layout Section
13142 \change_inserted 564990737 1671716212
13145 Academic Field Specifics
13148 \begin_layout Subsection
13150 \change_inserted 564990737 1671716212
13153 Chemistry: Hazard and Precautionary Statements
13156 \begin_layout Standard
13158 \change_inserted 564990737 1671716212
13161 This module provides two insets to typeset numbers and phrases of chemical
13162 hazard and precautionary statements.
13163 For a description see
13166 File\SpecialChar menuseparator
13167 Open Example\SpecialChar menuseparator
13168 Modules\SpecialChar menuseparator
13169 Hazard and Precautionary Statements
13173 Help\SpecialChar menuseparator
13174 Specific Manuals\SpecialChar menuseparator
13175 Hazard and Precautionary Statements
13181 \begin_layout Subsection
13183 \change_inserted 564990737 1671716212
13187 Chemistry: Risk and Safety Statements
13190 \begin_layout Standard
13192 \change_inserted 564990737 1671716212
13195 This module provides two insets,
13203 , accessible via the menu
13208 nsert\SpecialChar menuseparator
13210 \begin_inset space ~
13215 and an environment to typeset numbers and phrases of chemical risk and
13219 \begin_layout Subsection
13221 \change_inserted 564990737 1671716212
13227 \begin_layout Standard
13229 \change_inserted 564990737 1671716212
13232 This module uses the
13236 package to add environments useful for linguistics (numbered examples,
13237 glosses, semantic markup, tableau floats).
13238 You can obtain information about this module in
13243 elp\SpecialChar menuseparator
13249 \begin_inset space ~
13252 Manuals\SpecialChar menuseparator
13262 File\SpecialChar menuseparator
13263 Open Example\SpecialChar menuseparator
13266 Modules\SpecialChar menuseparator
13272 \begin_layout Section
13274 \change_inserted 564990737 1671788778
13280 \begin_layout Subsection
13282 \change_inserted 564990737 1671788778
13288 \begin_layout Standard
13290 \change_inserted 564990737 1671788778
13293 This module supports the Braille writing system.
13294 It requires the \SpecialChar LaTeX
13300 This and its documentation can be obtained from
13301 \begin_inset CommandInset href
13304 target "https://www.ctan.org/pkg/braille"
13310 You do not have to reconfigure your system after installing it.
13316 elp\SpecialChar menuseparator
13322 \begin_inset space ~
13325 Manuals\SpecialChar menuseparator
13334 File\SpecialChar menuseparator
13335 Open Example\SpecialChar menuseparator
13336 Modules\SpecialChar menuseparator
13342 \begin_layout Section
13344 \change_inserted 564990737 1671788778
13347 Annotation & Revision
13350 \begin_layout Subsection
13352 \change_inserted 564990737 1671788778
13358 \begin_layout Standard
13360 \change_inserted 564990737 1671788778
13363 This module provides “FiXme” (marginal) annotations for document revision
13365 A list of annotations can be produced by using the “List of FIXMEs” paragraph
13367 The annotations are customizable via the LaTeX preamble.
13368 See the FiXme documentation which can be obtained from
13369 \begin_inset CommandInset href
13372 target "http://mirrors.ctan.org/macros/latex/contrib/fixme/fixme.pdf"
13381 \begin_layout Paragraph
13383 \change_inserted 564990737 1671788778
13389 \begin_layout Standard
13391 \change_inserted 564990737 1671788778
13394 by default, the notes are only displayed in “draft” mode (if the option
13395 “draft” has been inserted in
13397 Document\SpecialChar menuseparator
13398 Settings\SpecialChar menuseparator
13399 Document Class\SpecialChar menuseparator
13400 Class Options\SpecialChar menuseparator
13404 To display them always, insert
13412 Document\SpecialChar menuseparator
13413 Settings\SpecialChar menuseparator
13421 \begin_layout Subsection
13423 \change_inserted 564990737 1671788778
13429 \begin_layout Standard
13431 \change_inserted 564990737 1671788778
13434 This module provides various kinds of annotations for PDF output.
13437 Help\SpecialChar menuseparator
13438 Specific Manuals\SpecialChar menuseparator
13439 PDF comments and File\SpecialChar menuseparator
13440 Open Example\SpecialChar menuseparator
13441 Modules\SpecialChar menuseparator
13447 \begin_layout Subsection
13449 \change_inserted 564990737 1671788778
13456 \begin_layout Standard
13458 \change_inserted 564990737 1671788778
13461 This module provides fields and buttons for PDF forms.
13463 \begin_inset CommandInset href
13465 name "hyperref documentation"
13466 target "http://mirrors.ctan.org/macros/latex/contrib/hyperref/doc/hyperref-doc.pdf"
13473 Help\SpecialChar menuseparator
13474 Specific Manuals\SpecialChar menuseparator
13475 PDF forms and File\SpecialChar menuseparator
13476 Open Example\SpecialChar menuseparator
13477 Modules\SpecialChar menuseparator
13483 \begin_layout Subsection
13485 \change_inserted 564990737 1671788778
13492 \begin_layout Standard
13494 \change_inserted 564990737 1671788778
13497 This module defines an inset to typeset reading aids (ruby, furigana) to
13498 Chinese characters.
13499 It uses the “okumakro,” “luatexja-ruby” or “ruby” package (depending on
13500 the TeX engine) or a fallback definition.
13504 \begin_layout Subsection
13506 \change_inserted 564990737 1671788778
13513 \begin_layout Standard
13515 \change_inserted 564990737 1671788778
13518 This module provides custom insets to insert TODO items in your document.
13519 In order to generate a “List of TODOs,” the module provides a paragraph
13521 Inserting “final” in
13523 Document\SpecialChar menuseparator
13524 Settings\SpecialChar menuseparator
13525 Document Class\SpecialChar menuseparator
13526 Class Options\SpecialChar menuseparator
13529 ) suppresses the output of TODO notes.
13531 \begin_inset CommandInset href
13533 name "todonotes documentation"
13534 target "http://mirrors.ctan.org/macros/latex/contrib/todonotes/todonotes.pdf"
13542 \begin_layout Section
13544 \change_inserted 564990737 1671829045
13550 \begin_layout Subsection
13552 \change_inserted 564990737 1671829045
13555 APA Style with NatBib
13558 \begin_layout Standard
13560 \change_inserted 564990737 1671829045
13563 This module adds support for using natbib together with apacite (the bibliograph
13564 y style need not be apacite — it could be apacite, apacitex, or any bibliography
13565 that works with both the natbib and apacite packages.)
13568 \begin_layout Section
13570 \change_inserted 564990737 1671829045
13576 \begin_layout Subsection
13578 \change_inserted 564990737 1671829045
13581 Fancy Colored Boxes
13584 \begin_layout Standard
13586 \change_inserted 564990737 1671829045
13589 This module adds ten custom insets that support colored boxes via the tcolorbox
13593 Help\SpecialChar menuseparator
13594 Specific Manuals\SpecialChar menuseparator
13599 File\SpecialChar menuseparator
13600 Open Example\SpecialChar menuseparator
13601 Modules\SpecialChar menuseparator
13605 \begin_inset CommandInset href
13607 name "tcolorbox documentation"
13608 target "http://mirrors.ctan.org/macros/latex/contrib/tcolorbox/tcolorbox.pdf"
13617 \begin_layout Subsection
13619 \change_inserted 564990737 1671829045
13625 \begin_layout Standard
13627 \change_inserted 564990737 1671829045
13630 This provides the custom insets
13646 to scale and rotate its content.
13649 \begin_layout Standard
13651 \change_inserted 564990737 1671829045
13657 is a simple way of reversing text without any other enhancement:
13660 \begin_layout Standard
13662 \change_inserted 564990737 1671829045
13665 \begin_inset Flex Reflectbox
13668 \begin_layout Plain Layout
13670 \change_inserted 564990737 1671829045
13673 Great Western Railway
13683 \begin_layout Standard
13685 \change_inserted 564990737 1671829045
13688 (You will need to use Ctrl-R to see any of these examples.)
13691 \begin_layout Standard
13693 \change_inserted 564990737 1671829045
13699 allows you to specify the dimensions of the text or image; permissible
13700 units are em, ex, in, pt, pc, cm, mm, dd, cc, nd, nc, bp, or sp; if you
13709 it scales by the width factor:
13712 \begin_layout Standard
13714 \change_inserted 564990737 1671829045
13717 \begin_inset Flex Resizebox
13720 \begin_layout Plain Layout
13722 \change_inserted 564990737 1671829045
13725 \begin_inset Argument 1
13728 \begin_layout Plain Layout
13730 \change_inserted 564990737 1671829045
13741 \begin_inset Argument 2
13744 \begin_layout Plain Layout
13746 \change_inserted 564990737 1671829045
13756 Great Western Railway
13766 \begin_layout Standard
13768 \change_inserted 564990737 1671829045
13774 allows you to rotate text around the reference point of the box.
13775 If you wish to rotate the box around a different origin, place the cursor
13776 inside the box and select Insert\SpecialChar menuseparator
13801 or meaningful combinations of these and the counterclockwise rotation angle
13802 is expressed in degrees.
13806 \begin_layout Standard
13808 \change_inserted 564990737 1671829045
13811 \begin_inset Flex Rotatebox
13814 \begin_layout Plain Layout
13816 \change_inserted 564990737 1671829045
13819 \begin_inset Argument 1
13822 \begin_layout Plain Layout
13824 \change_inserted 564990737 1671829045
13835 \begin_inset Argument 2
13838 \begin_layout Plain Layout
13840 \change_inserted 564990737 1671829045
13850 Great Western Railway
13860 \begin_layout Standard
13862 \change_inserted 564990737 1671829045
13865 You can combine boxes as in:
13868 \begin_layout Standard
13870 \change_inserted 564990737 1671829045
13873 \begin_inset Flex Rotatebox
13876 \begin_layout Plain Layout
13878 \change_inserted 564990737 1671829045
13881 \begin_inset Argument 1
13884 \begin_layout Plain Layout
13886 \change_inserted 564990737 1671829045
13897 \begin_inset Argument 2
13900 \begin_layout Plain Layout
13902 \change_inserted 564990737 1671829045
13913 \begin_inset Flex Resizebox
13916 \begin_layout Plain Layout
13918 \change_inserted 564990737 1671829045
13921 \begin_inset Argument 1
13924 \begin_layout Plain Layout
13926 \change_inserted 564990737 1671829045
13937 \begin_inset Argument 2
13940 \begin_layout Plain Layout
13942 \change_inserted 564990737 1671829045
13953 \begin_inset Flex Reflectbox
13956 \begin_layout Plain Layout
13958 \change_inserted 564990737 1671829045
13961 Great Western Railway
13985 \begin_layout Standard
13987 \change_inserted 564990737 1671829045
13993 scales text; select Insert\SpecialChar menuseparator
13994 V-Factor to add a vertical factor.
13995 If the vertical factor is omitted, the horizontal is used.
13996 Adding different horizontal and vertical values creates distortion as in
14000 \begin_layout Standard
14002 \change_inserted 564990737 1671829045
14006 \begin_inset Flex Scalebox
14009 \begin_layout Plain Layout
14011 \change_inserted 564990737 1671829045
14014 \begin_inset Argument 1
14017 \begin_layout Plain Layout
14019 \change_inserted 564990737 1671829045
14030 \begin_inset Argument 2
14033 \begin_layout Plain Layout
14035 \change_inserted 564990737 1671829045
14047 Great Western Railway
14057 \begin_layout Standard
14059 \change_inserted 564990737 1671829045
14062 A negative horizontal value reverses the text and a negative vertical value
14063 inverts it so that you get
14066 \begin_layout Standard
14068 \change_inserted 564990737 1671829045
14071 \begin_inset Flex Scalebox
14074 \begin_layout Plain Layout
14076 \change_inserted 564990737 1671829045
14079 \begin_inset Argument 1
14082 \begin_layout Plain Layout
14084 \change_inserted 564990737 1671829045
14095 \begin_inset Argument 2
14098 \begin_layout Plain Layout
14100 \change_inserted 564990737 1671829045
14110 Great Western Railway
14118 \begin_inset Flex Scalebox
14121 \begin_layout Plain Layout
14123 \change_inserted 564990737 1671829045
14126 \begin_inset Argument 1
14129 \begin_layout Plain Layout
14131 \change_inserted 564990737 1671829045
14142 \begin_inset Argument 2
14145 \begin_layout Plain Layout
14147 \change_inserted 564990737 1671829045
14157 Great Western Railway
14167 \begin_layout Subsection
14169 \change_inserted 564990737 1671884699
14175 \begin_layout Standard
14177 \change_inserted 564990737 1671884699
14180 This module defines Boxes with section header.
14181 It is mainly intended for the SciPoster Document class.
14185 \begin_layout Subsection
14187 \change_inserted 564990737 1671884699
14190 Variable-width Minipages
14193 \begin_layout Standard
14195 \change_inserted 564990737 1671884699
14201 \begin_inset space \thinspace{}
14208 Insert\SpecialChar menuseparator
14220 package provides a variable-width minipage, whose resulting width is the
14221 width of its contents (if this does not exceed the specified maximum width).
14222 The inset has two optional arguments which can be added by placing the
14223 cursor inside the minipage and entering
14225 Insert\SpecialChar menuseparator
14227 \begin_inset space \thinspace{}
14238 Insert\SpecialChar menuseparator
14240 \begin_inset space \thinspace{}
14254 File\SpecialChar menuseparator
14255 Open Example\SpecialChar menuseparator
14256 Variable-width Minipages
14262 \begin_layout Section
14264 \change_inserted 564990737 1671884699
14270 \begin_layout Subsection
14272 \change_inserted 564990737 1671884699
14275 Fix Computer Modern Fonts
14278 \begin_layout Standard
14280 \change_inserted 564990737 1671884699
14283 This module uses the
14287 package to improve the appearance of Computer Modern fonts and make them
14288 available with arbitrary sizes.
14290 \begin_inset CommandInset href
14292 name "fix-cm documentation"
14293 target "http://mirrors.ctan.org/macros/latex/base/fix-cm.pdf"
14302 \begin_layout Subsection
14304 \change_inserted 564990737 1671884699
14308 Kernel Fixes (Obsolete)
14311 \begin_layout Standard
14313 \change_inserted 564990737 1671884699
14316 This module loads the \SpecialChar LaTeX
14321 which contains some bug fixes for \SpecialChar LaTeX
14323 If you use this module your typeset document may look different when you
14324 process it, depending on the respective version of
14332 \begin_layout Paragraph
14334 \change_inserted 564990737 1671884699
14340 \begin_layout Standard
14342 \change_inserted 564990737 1671884699
14345 recent \SpecialChar LaTeX
14346 kernels (as of 2015/01/01) include the functionality of
14354 module is obsolete with newer \SpecialChar LaTeX
14359 \begin_layout Subsection
14361 \change_inserted 564990737 1671884699
14364 Minimalistic Insets
14367 \begin_layout Standard
14369 \change_inserted 564990737 1671884699
14372 This module redefines several insets (Index, Branch, URL) as being Minimalistic.
14375 \begin_layout Subsection
14377 \change_inserted 564990737 1671884699
14380 Title and Preamble Hacks
14383 \begin_layout Standard
14385 \change_inserted 564990737 1671884699
14388 This module provides two new paragraph styles:
14391 \begin_layout Enumerate
14393 \change_inserted 564990737 1671884699
14399 which puts whatever is entered into it into the preamble.
14400 This can be used, if one wishes, to include preamble code in the body of
14405 \begin_layout Enumerate
14407 \change_inserted 564990737 1671884699
14413 which that will put its contents into the body of the LaTeX document, but
14421 This is useful for making branches and notes in title-related material.
14422 (However, if you put these in a Standard layout, this signals to LyX to
14429 , which may then come too early.)
14432 \begin_layout Section
14433 Multiple Text Columns
14436 \begin_layout Standard
14437 This feature is independent of the option
14439 Two-column document
14441 in the document settings under
14446 If you want to have 2
14447 \begin_inset space ~
14450 columns for the whole document, it is recommended to use the
14452 Two-column document
14455 For all other cases use this feature.
14458 \begin_layout Standard
14459 To use multiple text columns in your document, you have to load the module
14466 Document\SpecialChar menuseparator
14467 Settings\SpecialChar menuseparator
14470 ) and must have the \SpecialChar LaTeX
14472 \begin_inset Flex Code
14475 \begin_layout Plain Layout
14484 \begin_layout Standard
14485 Footnotes within multiple columns will be placed at the bottom of the page
14486 and not under each column.
14487 Within the different columns you can use everything, with the limitation
14488 that for floats you need to use the float option
14495 \begin_layout Subsection
14499 \begin_layout Standard
14500 If you want to have 2
14501 \begin_inset space ~
14504 columns in your text, insert a multicolumn inset via the menu
14506 Insert\SpecialChar menuseparator
14508 \begin_inset space ~
14511 Insets\SpecialChar menuseparator
14513 \begin_inset space ~
14518 where the columns should start.
14519 Write all text that should be printed in 2
14520 \begin_inset space ~
14523 columns into this inset.
14526 \begin_layout Standard
14527 Here is an example:
14530 \begin_layout Standard
14532 \begin_inset Flex Multiple Columns
14535 \begin_layout Plain Layout
14540 The Adventure of the Empty House
14543 \begin_inset Newline newline
14546 by Sir Arthur Conan Doyle
14549 \begin_layout Plain Layout
14552 It was in the spring of the year 1894 that all London was interested, and
14553 the fashionable world dismayed, by the murder of the Honourable Ronald
14554 Adair under most unusual and inexplicable circumstances.
14555 The public has already learned those particulars of the crime which came
14556 out in the police investigation, but a good deal was suppressed upon that
14557 occasion, since the case for the prosecution was so overwhelmingly strong
14558 that it was not necessary to bring forward all the facts.
14559 Only now, at the end of nearly ten years, am I allowed to supply those
14560 missing links which make up the whole of that remarkable chain.
14561 The crime was of interest in itself, but that interest was as nothing to
14562 me compared to the inconceivable sequel, which afforded me the greatest
14563 shock and surprise of any event in my adventurous life.
14564 Even now, after this long interval, I find myself thrilling as I think
14565 of it, and feeling once more that sudden flood of joy, amazement, and increduli
14566 ty which utterly submerged my mind.
14567 Let me say to that public, which has shown some interest in those glimpses
14568 which I have occasionally given them of the thoughts and actions of a very
14569 remarkable man, that they are not to blame me if I have not shared my knowledge
14570 with them, for I should have considered it my first duty to do so, had
14571 I not been barred by a positive prohibition from his own lips, which was
14572 only withdrawn upon the third of last month.
14580 \begin_layout Standard
14581 To get 3 or more columns, set the cursor into the multicolumn inset and
14584 Insert\SpecialChar menuseparator
14586 \begin_inset space ~
14590 \begin_inset space ~
14596 The number of the desired columns is written into that inset (for 3
14597 \begin_inset space ~
14601 \begin_inset Quotes eld
14605 \begin_inset Quotes erd
14609 \begin_inset Newline newline
14612 Here is an example with 3
14613 \begin_inset space ~
14619 \begin_layout Standard
14620 \begin_inset Flex Multiple Columns
14623 \begin_layout Plain Layout
14626 \begin_inset Argument 1
14629 \begin_layout Plain Layout
14636 It can be imagined that my close intimacy with Sherlock Holmes had interested
14637 me deeply in crime, and that after his disappearance I never failed to
14638 read with care the various problems which came before the public.
14639 And I even attempted, more than once, for my own private satisfaction,
14640 to employ his methods in their solution, though with indifferent success.
14641 There was none, however, which appealed to me like this tragedy of Ronald
14643 As I read the evidence at the inquest, which led up to a verdict of willful
14644 murder against some person or persons unknown, I realized more clearly
14645 than I had ever done the loss which the community had sustained by the
14646 death of Sherlock Holmes.
14647 There were points about this strange business which would, I was sure,
14648 have specially appealed to him, and the efforts of the police would have
14649 been supplemented, or more probably anticipated, by the trained observation
14650 and the alert mind of the first criminal agent in Europe.
14651 All day, as I drove upon my round, I turned over the case in my mind and
14652 found no explanation which appeared to me to be adequate.
14653 At the risk of telling a twice-told tale, I will recapitulate the facts
14654 as they were known to the public at the conclusion of the inquest.
14662 \begin_layout Standard
14663 You can have up to 10
14664 \begin_inset space ~
14667 columns if you want to, but that might not be very pleasant for the readers
14671 \begin_layout Standard
14672 \begin_inset Newpage newpage
14678 \begin_layout Subsection
14679 Columns inside Columns
14682 \begin_layout Standard
14683 You can also have columns inside columns:
14686 \begin_layout Standard
14687 \begin_inset Flex Multiple Columns
14690 \begin_layout Plain Layout
14693 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
14694 at that time governor of one of the Australian colonies.
14695 Adair's mother had returned from Australia to undergo the operation for
14696 cataract, and she, her son Ronald, and her daughter Hilda were living together
14700 \begin_layout Plain Layout
14701 \begin_inset Flex Multiple Columns
14704 \begin_layout Plain Layout
14707 The youth moved in the best society
14708 \begin_inset space ~
14711 – had, so far as was known, no enemies and no particular vices.
14712 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
14713 had been broken off by mutual consent some months before, and there was
14714 no sign that it had left any very profound feeling behind it.
14715 For the rest {sic} the man's life moved in a narrow and conventional circle,
14716 for his habits were quiet and his nature unemotional.
14717 Yet it was upon this easy-going young aristocrat that death came, in most
14718 strange and unexpected form, between the hours of ten and eleven-twenty
14719 on the night of March 30, 1894.
14727 \begin_layout Plain Layout
14730 Ronald Adair was fond of cards
14731 \begin_inset space ~
14734 – playing continually, but never for such stakes as would hurt him.
14735 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
14736 It was shown that, after dinner on the day of his death, he had played
14737 a rubber of whist at the latter club.
14738 He had also played there in the afternoon.
14743 The evidence of those who had played with him
14744 \begin_inset space ~
14748 Murray, Sir John Hardy, and Colonel Moran
14749 \begin_inset space ~
14752 – showed that the game was whist, and that there was a fairly equal fall
14754 Adair might have lost five pounds, but not more.
14755 His fortune was a considerable one, and such a loss could not in any way
14757 He had played nearly every day at one club or other, but he was a cautious
14758 player, and usually rose a winner.
14759 It came out in evidence that, in partnership with Colonel Moran, he had
14760 actually won as much as four hundred and twenty pounds in a sitting, some
14761 weeks before, from Godfrey Milner and Lord Balmoral.
14762 So much for his recent history as it came out at the inquest.
14770 \begin_layout Subsection
14774 \begin_layout Standard
14775 The examples in this section show some more special features of multiple
14779 \begin_layout Standard
14780 For more features of multiple columns, have a look at the
14781 \begin_inset CommandInset href
14783 name "documentation"
14784 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
14789 of the \SpecialChar LaTeX
14791 \begin_inset Flex Code
14794 \begin_layout Plain Layout
14803 \begin_layout Subsubsection
14807 \begin_layout Standard
14808 To add a preface text for multiple columns, set the cursor into the multicolumn
14809 inset and use the menu
14811 Insert\SpecialChar menuseparator
14815 Write your preface text into that inset.
14816 \begin_inset Newline newline
14819 This is an example with some preface text:
14822 \begin_layout Standard
14823 \begin_inset VSpace bigskip
14829 \begin_layout Standard
14830 \begin_inset Flex Multiple Columns
14833 \begin_layout Plain Layout
14834 \begin_inset Argument 2
14837 \begin_layout Plain Layout
14838 And the story continues and continues and continues and continues\SpecialChar ldots
14846 On the evening of the crime, he returned from the club exactly at ten.
14847 His mother and sister were out spending the evening with a relation.
14848 The servant deposed that she heard him enter the front room on the second
14849 floor, generally used as his sitting-room.
14850 She had lit a fire there, and as it smoked she had opened the window.
14851 No sound was heard from the room until eleven-twenty, the hour of the return
14852 of Lady Maynooth and her daughter.
14853 Desiring to say good-night, she attempted to enter her son's room.
14854 The door was locked on the inside, and no answer could be got to their
14855 cries and knocking.
14856 Help was obtained, and the door forced.
14857 The unfortunate young man was found lying near the table.
14858 His head had been horribly mutilated by an expanding revolver bullet, but
14859 no weapon of any sort was to be found in the room.
14867 \begin_layout Standard
14868 You can also use a section heading as the preface if you use a section command
14869 as \SpecialChar TeX
14871 For example the command
14874 \begin_layout LyX-Code
14877 subsection{subsection title}
14880 \begin_layout Standard
14881 creates a subsection.
14882 In this example the preface is a subsubsection:
14885 \begin_layout Standard
14886 \begin_inset Flex Multiple Columns
14889 \begin_layout Plain Layout
14890 \begin_inset Argument 2
14893 \begin_layout Plain Layout
14897 \begin_layout Plain Layout
14906 This is a subsubsection heading as a preface
14910 \begin_layout Plain Layout
14924 A minute examination of the circumstances served only to make the case more
14926 In the first place, no reason could be given why the young man should have
14927 fastened the door upon the inside.
14928 There was the possibility that the murderer had done this, and had afterwards
14929 escaped by the window.
14930 The drop was at least twenty feet, however, and a bed of crocuses in full
14932 Neither the flowers nor the earth showed any sign of having been disturbed,
14933 nor were there any marks upon the narrow strip of grass which separated
14934 the house from the road.
14935 Apparently, therefore, it was the young man himself who had fastened the
14937 But how did he come by his death? No one could have climbed up to the window
14938 without leaving traces.
14939 Suppose a man had fired through the window, he would indeed be a remarkable
14940 shot who could with a revolver inflict so deadly a wound.
14941 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
14942 a hundred yards of the house.
14943 No one had heard a shot.
14951 \begin_layout Standard
14952 If there is less vertical space than 6
14953 \begin_inset space ~
14956 text lines is left on the page at the beginning of the multiple columns,
14957 a page break will be inserted before the multiple columns.
14958 Depending on the number of lines of the preface text, you might want to
14960 This is done by setting the cursor into the mulitcolumn inset behind the
14961 preface (if there is any) and using the menu
14963 Insert\SpecialChar menuseparator
14965 \begin_inset space ~
14969 \begin_inset space ~
14973 \begin_inset space ~
14979 Insert into that inset the amount of space like e.
14980 \begin_inset space \thinspace{}
14984 \begin_inset space \space{}
14988 \begin_inset Quotes eld
14992 \begin_inset Quotes erd
14996 \begin_inset Newline newline
14999 In this example the space is set to 7
15000 \begin_inset space ~
15003 text lines by using
15004 \begin_inset Flex Code
15007 \begin_layout Plain Layout
15016 \begin_inset Flex Code
15019 \begin_layout Plain Layout
15027 needs to be inserted as \SpecialChar TeX
15031 \begin_layout Standard
15032 \begin_inset Flex Multiple Columns
15035 \begin_layout Plain Layout
15036 \begin_inset Argument 3
15039 \begin_layout Plain Layout
15044 \begin_layout Plain Layout
15060 On the evening of the crime, he returned from the club exactly at ten.
15061 His mother and sister were out spending the evening with a relation.
15062 The servant deposed that she heard him enter the front room on the second
15063 floor, generally used as his sitting-room.
15064 She had lit a fire there, and as it smoked she had opened the window.
15065 No sound was heard from the room until eleven-twenty, the hour of the return
15066 of Lady Maynooth and her daughter.
15067 Desiring to say good-night, she attempted to enter her son's room.
15068 The door was locked on the inside, and no answer could be got to their
15069 cries and knocking.
15070 Help was obtained, and the door forced.
15071 The unfortunate young man was found lying near the table.
15072 His head had been horribly mutilated by an expanding revolver bullet, but
15073 no weapon of any sort was to be found in the room.
15081 \begin_layout Subsubsection
15085 \begin_layout Standard
15086 The amount of space before and after multiple columns can be changed by
15087 changing the length
15088 \begin_inset Flex Code
15091 \begin_layout Plain Layout
15100 For example the command
15103 \begin_layout LyX-Code
15111 \begin_layout Standard
15112 in \SpecialChar TeX
15113 Code changes its value to 3
15114 \begin_inset space \thinspace{}
15118 The change must be made before the multiple columns' start.
15119 The predefined value is 13
15120 \begin_inset space \thinspace{}
15126 \begin_layout Standard
15128 \begin_inset Flex Code
15131 \begin_layout Plain Layout
15140 \begin_inset space \thinspace{}
15146 \begin_layout Standard
15150 \begin_layout Plain Layout
15156 multicolsep}{2.5cm}
15164 \begin_layout Standard
15165 \begin_inset Flex Multiple Columns
15168 \begin_layout Plain Layout
15171 All day I turned these facts over in my mind, endeavouring to hit upon some
15172 theory which could reconcile them all, and to find that line of least resistanc
15173 e which my poor friend had declared to be the starting-point of every investigat
15175 I confess that I made little progress.
15176 In the evening I strolled across the Park, and found myself about six o'clock
15177 at the Oxford Street end of Park Lane.
15178 A group of loafers upon the pavements, all staring up at a particular window,
15179 directed me to the house which I had come to see.
15180 A tall, thin man with coloured glasses, whom I strongly suspected of being
15181 a plain-clothes detective, was pointing out some theory of his own, while
15182 the others crowded round to listen to what he said.
15183 I got as near him as I could, but his observations seemed to me to be absurd,
15184 so I withdrew again in some disgust.
15185 As I did so I struck against an elderly, deformed man, who had been behind
15186 me, and I knocked down several books which he was carrying.
15194 \begin_layout Standard
15195 \begin_inset Note Greyedout
15198 \begin_layout Plain Layout
15203 The values you set with
15204 \begin_inset Flex Code
15207 \begin_layout Plain Layout
15215 will be used for all following multiple columns until you change them again.
15223 \begin_layout Standard
15227 \begin_layout Plain Layout
15239 \begin_inset Note Note
15242 \begin_layout Plain Layout
15243 go back to the default
15251 \begin_layout Standard
15252 \begin_inset Newpage newpage
15258 \begin_layout Subsubsection
15262 \begin_layout Standard
15263 A column break can be forced by inserting the command
15264 \begin_inset Flex Code
15267 \begin_layout Plain Layout
15275 as \SpecialChar TeX
15276 Code to that position in the text where the column should be broken.
15277 Note that this leads in most cases to whitespace in the text.
15278 \begin_inset Newline newline
15281 Here is an example:
15284 \begin_layout Standard
15285 \begin_inset Flex Multiple Columns
15288 \begin_layout Plain Layout
15291 \begin_inset Quotes eld
15294 You're surprised to see me, sir,
15295 \begin_inset Quotes erd
15298 said he, in a strange, croaking voice.
15301 \begin_layout Plain Layout
15304 I acknowledged that I was.
15307 \begin_layout Plain Layout
15310 \begin_inset Quotes eld
15313 Well, I've a conscience, sir, and when I chanced to see you go into this
15314 house, as I came hobbling after you, I thought to myself, I'll just step
15315 in and see that kind gentleman, and tell him that if I was a bit gruff
15316 in my manner there was not any harm meant, and that I am much obliged to
15317 him for picking up my books.
15318 \begin_inset Quotes erd
15324 \begin_layout Plain Layout
15327 \begin_inset Quotes eld
15330 You make too much of a trifle,
15331 \begin_inset Quotes erd
15336 \begin_inset Quotes eld
15339 May I ask how you knew who I was?
15340 \begin_inset Quotes erd
15343 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
15347 \begin_layout Plain Layout
15359 \begin_layout Plain Layout
15362 \begin_inset Quotes eld
15365 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
15366 you'll find my little bookshop at the corner of Church Street, and very
15367 happy to see you, I am sure.
15368 Maybe you collect yourself, sir.
15372 \begin_inset space ~
15386 \begin_inset space ~
15389 – a bargain, every one of them.
15390 With five volumes you could just fill that gap on that second shelf.
15391 It looks untidy, does it not, sir?
15392 \begin_inset Quotes erd
15403 \begin_layout Subsubsection
15407 \begin_layout Standard
15408 The width of the columns is automatically calculated, but you can modify
15409 the space between the columns.
15410 This is done by changing the length
15411 \begin_inset Flex Code
15414 \begin_layout Plain Layout
15423 Its predefined value is 10
15424 \begin_inset space \thinspace{}
15428 Here is an example where
15429 \begin_inset Flex Code
15432 \begin_layout Plain Layout
15441 \begin_inset space \thinspace{}
15447 \begin_layout Standard
15451 \begin_layout Plain Layout
15465 \begin_layout Standard
15466 \begin_inset Flex Multiple Columns
15469 \begin_layout Plain Layout
15472 My observations of No.
15473 \begin_inset space \space{}
15476 427 Park Lane did little to clear up the problem in which I was interested.
15477 The house was separated from the street by a low wall and railing, the
15478 whole not more than five feet high.
15479 It was perfectly easy, therefore, for anyone to get into the garden, but
15480 the window was entirely inaccessible, since there was no water pipe or
15481 anything which could help the most active man to climb it.
15482 More puzzled than ever, I retraced my steps to Kensington.
15483 I had not been in my study five minutes when the maid entered to say that
15484 a person desired to see me.
15485 To my astonishment it was none other than my strange old book collector,
15486 his sharp, wizened face peering out from a frame of white hair, and his
15487 precious volumes, a dozen of them at least, wedged under his right arm.
15495 \begin_layout Standard
15499 \begin_layout Plain Layout
15511 \begin_inset Note Note
15514 \begin_layout Plain Layout
15515 go back to the default
15523 \begin_layout Subsubsection
15527 \begin_layout Standard
15528 Between the columns a rule with a width of the length
15529 \begin_inset Flex Code
15532 \begin_layout Plain Layout
15541 If this rule width is set to 0
15542 \begin_inset space \thinspace{}
15545 pt (this is the default), the rule is suppressed.
15546 In the following example the rule is 2
15547 \begin_inset space \thinspace{}
15553 \begin_layout Standard
15557 \begin_layout Plain Layout
15563 columnseprule}{2pt}
15571 \begin_layout Standard
15572 \begin_inset Flex Multiple Columns
15575 \begin_layout Plain Layout
15578 \begin_inset Quotes eld
15581 You're surprised to see me, sir,
15582 \begin_inset Quotes erd
15585 said he, in a strange, croaking voice.
15588 \begin_layout Plain Layout
15591 I acknowledged that I was.
15594 \begin_layout Plain Layout
15597 \begin_inset Quotes eld
15600 Well, I've a conscience, sir, and when I chanced to see you go into this
15601 house, as I came hobbling after you, I thought to myself, I'll just step
15602 in and see that kind gentleman, and tell him that if I was a bit gruff
15603 in my manner there was not any harm meant, and that I am much obliged to
15604 him for picking up my books.
15605 \begin_inset Quotes erd
15611 \begin_layout Plain Layout
15614 \begin_inset Quotes eld
15617 You make too much of a trifle,
15618 \begin_inset Quotes erd
15623 \begin_inset Quotes eld
15626 May I ask how you knew who I was?
15627 \begin_inset Quotes erd
15633 \begin_layout Plain Layout
15636 \begin_inset Quotes eld
15639 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
15640 you'll find my little bookshop at the corner of Church Street, and very
15641 happy to see you, I am sure.
15642 Maybe you collect yourself, sir.
15646 \begin_inset space ~
15660 \begin_inset space ~
15663 – a bargain, every one of them.
15664 With five volumes you could just fill that gap on that second shelf.
15665 It looks untidy, does it not, sir?
15666 \begin_inset Quotes erd
15677 \begin_layout Standard
15678 \begin_inset VSpace defskip
15684 \begin_layout Standard
15685 The rule can be colored by redefining the command
15686 \begin_inset Flex Code
15689 \begin_layout Plain Layout
15698 This is done by inserting the command
15701 \begin_layout LyX-Code
15706 columnseprulecolor}{
15711 \begin_layout Standard
15712 as \SpecialChar TeX
15713 Code before the multicolumn inset.
15715 \begin_inset Flex Code
15718 \begin_layout Plain Layout
15724 in this command by a color of your choice.
15725 You can use all pre- and self-defined colors.
15733 \begin_inset space ~
15738 for more information about pre- and self-defined colors.
15739 To go back to the default color insert the command
15742 \begin_layout LyX-Code
15747 columnseprulecolor}{
15752 \begin_layout Standard
15753 Here is the example with a cyan rule and 1
15754 \begin_inset space \thinspace{}
15757 cm column separation:
15760 \begin_layout Standard
15764 \begin_layout Plain Layout
15773 \begin_layout Plain Layout
15779 columnseprulecolor}{
15789 \begin_layout Standard
15790 \begin_inset Flex Multiple Columns
15793 \begin_layout Plain Layout
15796 \begin_inset Quotes eld
15799 You're surprised to see me, sir,
15800 \begin_inset Quotes erd
15803 said he, in a strange, croaking voice.
15806 \begin_layout Plain Layout
15809 I acknowledged that I was.
15812 \begin_layout Plain Layout
15815 \begin_inset Quotes eld
15818 Well, I've a conscience, sir, and when I chanced to see you go into this
15819 house, as I came hobbling after you, I thought to myself, I'll just step
15820 in and see that kind gentleman, and tell him that if I was a bit gruff
15821 in my manner there was not any harm meant, and that I am much obliged to
15822 him for picking up my books.
15823 \begin_inset Quotes erd
15829 \begin_layout Plain Layout
15832 \begin_inset Quotes eld
15835 You make too much of a trifle,
15836 \begin_inset Quotes erd
15841 \begin_inset Quotes eld
15844 May I ask how you knew who I was?
15845 \begin_inset Quotes erd
15851 \begin_layout Plain Layout
15854 \begin_inset Quotes eld
15857 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
15858 you'll find my little bookshop at the corner of Church Street, and very
15859 happy to see you, I am sure.
15860 Maybe you collect yourself, sir.
15864 \begin_inset space ~
15878 \begin_inset space ~
15881 – a bargain, every one of them.
15882 With five volumes you could just fill that gap on that second shelf.
15883 It looks untidy, does it not, sir?
15884 \begin_inset Quotes erd
15895 \begin_layout Standard
15899 \begin_layout Plain Layout
15905 columnseprule}{0pt}
15908 \begin_layout Plain Layout
15914 columnseprulecolor}{
15922 \begin_inset Note Note
15925 \begin_layout Plain Layout
15926 go back to the default
15934 \begin_layout Section
15936 \change_inserted 564990737 1671270380
15940 \begin_layout Subsection
15942 \change_inserted 564990737 1671270398
15944 \change_deleted 564990737 1671270396
15950 \begin_layout Standard
15953 as well as any other text processor uses by default rectangular paragraphs.
15954 For special cases like for example posters, invitation cards or poems you
15955 can modify the paragraph shape to one of your choice.
15956 This can be done by using the \SpecialChar LaTeX
15958 \begin_inset Flex Code
15961 \begin_layout Plain Layout
15967 which is loaded by using in the document settings the module
15969 Custom paragraph shapes
15974 \begin_layout Subsubsection
15978 \begin_layout Standard
15983 provides the following shapes:
15986 \begin_layout Standard
15987 \begin_inset Tabular
15988 <lyxtabular version="3" rows="13" columns="3">
15989 <features booktabs="true" islongtable="true" longtabularalignment="center">
15990 <column alignment="left" valignment="middle" width="16col%">
15991 <column alignment="left" valignment="middle" width="40col%">
15992 <column alignment="left" valignment="middle" width="35col%">
15993 <row endhead="true">
15994 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
15997 \begin_layout Plain Layout
16006 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
16009 \begin_layout Plain Layout
16018 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
16021 \begin_layout Plain Layout
16031 <row interlinespace="default">
16032 <cell alignment="left" valignment="top" usebox="none">
16035 \begin_layout Plain Layout
16043 <cell alignment="left" valignment="top" usebox="none">
16046 \begin_layout Plain Layout
16049 Circle with circular hole (in the size of a CD/DVD)
16054 <cell alignment="left" valignment="top" usebox="none">
16057 \begin_layout Plain Layout
16060 Cannot be scaled, take care there is not too much text
16066 <row interlinespace="default">
16067 <cell alignment="left" valignment="top" usebox="none">
16070 \begin_layout Plain Layout
16078 <cell alignment="left" valignment="top" usebox="none">
16081 \begin_layout Plain Layout
16089 <cell alignment="left" valignment="top" usebox="none">
16092 \begin_layout Plain Layout
16095 Fragile, calculation might fail
16101 <row interlinespace="default">
16102 <cell alignment="left" valignment="top" usebox="none">
16105 \begin_layout Plain Layout
16113 <cell alignment="left" valignment="top" usebox="none">
16116 \begin_layout Plain Layout
16119 Rhomboid (symbolizing a
16120 \begin_inset Quotes eld
16124 \begin_inset Quotes erd
16132 <cell alignment="left" valignment="top" usebox="none">
16135 \begin_layout Plain Layout
16144 <row interlinespace="default">
16145 <cell alignment="left" valignment="top" usebox="none">
16148 \begin_layout Plain Layout
16156 <cell alignment="left" valignment="top" usebox="none">
16159 \begin_layout Plain Layout
16167 <cell alignment="left" valignment="top" usebox="none">
16170 \begin_layout Plain Layout
16179 <row interlinespace="default">
16180 <cell alignment="left" valignment="top" usebox="none">
16183 \begin_layout Plain Layout
16191 <cell alignment="left" valignment="top" usebox="none">
16194 \begin_layout Plain Layout
16202 <cell alignment="left" valignment="top" usebox="none">
16205 \begin_layout Plain Layout
16214 <row interlinespace="default">
16215 <cell alignment="left" valignment="top" usebox="none">
16218 \begin_layout Plain Layout
16226 <cell alignment="left" valignment="top" usebox="none">
16229 \begin_layout Plain Layout
16232 Nut for bolt (hexagon with circular hole)
16237 <cell alignment="left" valignment="top" usebox="none">
16240 \begin_layout Plain Layout
16249 <row interlinespace="default">
16250 <cell alignment="left" valignment="top" usebox="none">
16253 \begin_layout Plain Layout
16261 <cell alignment="left" valignment="top" usebox="none">
16264 \begin_layout Plain Layout
16272 <cell alignment="left" valignment="top" usebox="none">
16275 \begin_layout Plain Layout
16284 <row interlinespace="default">
16285 <cell alignment="left" valignment="top" usebox="none">
16288 \begin_layout Plain Layout
16296 <cell alignment="left" valignment="top" usebox="none">
16299 \begin_layout Plain Layout
16307 <cell alignment="left" valignment="top" usebox="none">
16310 \begin_layout Plain Layout
16319 <row interlinespace="default">
16320 <cell alignment="left" valignment="top" usebox="none">
16323 \begin_layout Plain Layout
16331 <cell alignment="left" valignment="top" usebox="none">
16334 \begin_layout Plain Layout
16342 <cell alignment="left" valignment="top" usebox="none">
16345 \begin_layout Plain Layout
16354 <row interlinespace="default">
16355 <cell alignment="left" valignment="top" usebox="none">
16358 \begin_layout Plain Layout
16366 <cell alignment="left" valignment="top" usebox="none">
16369 \begin_layout Plain Layout
16372 Normal/reversed rain drop
16377 <cell alignment="left" valignment="top" usebox="none">
16380 \begin_layout Plain Layout
16383 Fragile, calculation might fail
16389 <row interlinespace="default">
16390 <cell alignment="left" valignment="top" usebox="none">
16393 \begin_layout Plain Layout
16402 <cell alignment="left" valignment="top" usebox="none">
16405 \begin_layout Plain Layout
16408 The \SpecialChar TeX
16414 <cell alignment="left" valignment="top" usebox="none">
16417 \begin_layout Plain Layout
16426 <row interlinespace="default">
16427 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
16430 \begin_layout Plain Layout
16434 \begin_inset Newline newline
16442 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
16445 \begin_layout Plain Layout
16448 Triangles in different orientations
16453 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
16456 \begin_layout Plain Layout
16472 \begin_layout Standard
16473 To use a shape for your paragraph, simply select it in \SpecialChar LyX
16475 for environments in the toolbar.
16478 \begin_layout Standard
16479 \begin_inset Newpage newpage
16485 \begin_layout Standard
16486 Here is an example paragraph in the shape of a nut:
16489 \begin_layout Standard
16490 \begin_inset VSpace bigskip
16499 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16500 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16502 At vero eos et accusam et justo duo dolores et ea rebum.
16503 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
16505 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16506 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16510 \begin_layout Standard
16511 \begin_inset VSpace bigskip
16517 \begin_layout Standard
16518 \begin_inset Note Greyedout
16521 \begin_layout Plain Layout
16530 paragraphs cannot run over a page break.
16538 \begin_layout Standard
16539 \begin_inset VSpace bigskip
16545 \begin_layout Standard
16547 \begin_inset Flex Code
16550 \begin_layout Plain Layout
16556 takes care that the shape will always be preserved, no matter how much
16557 text is in the paragraph.
16558 Therefore the paragraph size changes with the amount of contained text.
16559 This can lead to paragraph sizes exceeding the page margins.
16560 To demonstrate the size scaling, here is the same example paragraph but
16561 with twice as much text:
16564 \begin_layout Standard
16565 \begin_inset Newpage newpage
16574 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16575 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16577 At vero eos et accusam et justo duo dolores et ea rebum.
16578 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
16580 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16581 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16583 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16584 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16586 At vero eos et accusam et justo duo dolores et ea rebum.
16587 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
16589 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16590 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16594 \begin_layout Standard
16595 \begin_inset VSpace bigskip
16601 \begin_layout Standard
16602 An exception is the shape
16607 It cannot be scaled because it must fit the size of a CD/DVD.
16608 Therefore the amount of text that fits into the shape is limited.
16609 \begin_inset Newline newline
16620 shape are fragile, meaning that the calculation of their size can fail,
16621 depending on the amount of text.
16622 You will then get the \SpecialChar LaTeX
16624 \begin_inset Quotes eld
16627 Arithmetic overflow
16628 \begin_inset Quotes erd
16632 In this case one can try to remove or add some text; if nothing works one
16633 has to use another shape.
16636 \begin_layout Standard
16637 \begin_inset VSpace bigskip
16643 \begin_layout Standard
16644 For shapes with tips you will maybe see that \SpecialChar LaTeX
16645 's hyphenation routine fails
16646 for text in the tips.
16647 Therefore it is often necessary to add hyphenation points
16652 arg "specialchar-insert hyphenation"
16657 ) to the corresponding text parts.
16660 \begin_layout Standard
16661 \begin_inset VSpace bigskip
16667 \begin_layout Standard
16668 Shapepar paragraphs are either always centered or placed on the page so
16669 that their left border touches the left page margin.
16670 You can therefore not use the paragraph dialog to align such paragraphs.
16671 A solution is to put the paragraph into a minipage or parbox and align
16673 The problem is hereby to find the right width for the box.
16674 Because if it is too wide and you center the box, the paragraph is not
16675 centered too because it sticks at the left side of the box.
16676 So you might have to play a bit with the width until it fits.
16677 Here are two heart-shaped paragraphs, the first one is not aligned, the
16678 second one is right-aligned:
16681 \begin_layout Standard
16682 \begin_inset Newpage newpage
16688 \begin_layout Heart
16692 Lo\SpecialChar softhyphen
16693 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16694 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16696 At vero eos et accusam et justo duo dolores et ea rebum.
16697 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
16701 \begin_layout Standard
16702 \begin_inset VSpace bigskip
16708 \begin_layout Standard
16711 \begin_inset Box Frameless
16721 height_special "totalheight"
16726 backgroundcolor "none"
16729 \begin_layout Heart
16733 Lo\SpecialChar softhyphen
16734 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16735 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16737 At vero eos et accusam et justo duo dolores et ea rebum.
16738 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
16747 \begin_layout Subsubsection
16751 \begin_layout Standard
16752 You can define any shape you want.
16753 Doing this manually is a lot of work because every coordinate must be specified.
16754 But there is a way to let the computer calculate the coordinates:
16757 \begin_layout Enumerate
16758 Install the program
16759 \begin_inset CommandInset href
16762 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
16770 \begin_layout Enumerate
16777 TeX/LaTeX\SpecialChar menuseparator
16778 Settings\SpecialChar menuseparator
16781 and select the font size you are using in your document.
16782 For example this document uses the size 12
16783 \begin_inset space \thinspace{}
16789 \begin_layout Enumerate
16793 \begin_layout Enumerate
16796 TeX/LaTeX\SpecialChar menuseparator
16799 to export the shape to coordinates.
16800 In the appearing dialog use either the outline of your shape for the coordinate
16801 s or the path itself.
16805 \begin_layout Plain Layout
16806 For more information see
16807 \begin_inset CommandInset href
16809 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
16822 \begin_layout Standard
16823 The coordinates are written into a \SpecialChar TeX
16825 To use it for your \SpecialChar LyX
16829 \begin_layout Enumerate
16830 Place the cursor before the first character of your paragraph (or into a
16834 \begin_layout Enumerate
16835 Open in \SpecialChar LyX
16838 Insert\SpecialChar menuseparator
16839 File\SpecialChar menuseparator
16841 \begin_inset space ~
16846 , select the file and use
16855 \begin_layout Standard
16856 \begin_inset VSpace defskip
16862 \begin_layout Standard
16863 \begin_inset Note Greyedout
16866 \begin_layout Plain Layout
16871 : The changed shape only applies to the current paragraph; everything is
16872 reset to normal for the next paragraph.
16873 Therefore the shape definition file must be input into every paragraph
16874 with the desired shape.
16882 \begin_layout Standard
16883 \begin_inset VSpace bigskip
16889 \begin_layout Standard
16890 Here is an example:
16893 \begin_layout Standard
16894 \begin_inset VSpace bigskip
16900 \begin_layout Standard
16901 \begin_inset CommandInset include
16903 filename "SpecialParagraphShape.tex"
16910 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16911 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16913 At vero eos et accusam et justo duo dolores et ea rebum.
16914 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
16916 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16917 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16921 \begin_layout Standard
16922 \begin_inset VSpace bigskip
16928 \begin_layout Standard
16933 to draw complexer shapes in
16937 you can draw the shape in a program of your choice and import the resulting
16943 Then you only need to draw a line or spline along the outline of the image.
16946 \begin_layout Standard
16947 \begin_inset VSpace bigskip
16953 \begin_layout Standard
16956 Custom paragraph shapes
16958 also provides the two commands
16966 which can be used to define custom shapes coordinate by coordinate.
16970 \begin_layout Plain Layout
16971 These commands are internally used for all shapes described here.
16976 For information how these styles are used and about further customization
16977 possibilities, have a look at the
16978 \begin_inset CommandInset href
16980 name "documentation"
16981 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
16987 \begin_inset Flex Code
16990 \begin_layout Plain Layout
16999 \begin_layout Chapter
17001 \change_deleted 564990737 1671304317
17005 \change_inserted 564990737 1671304322
17007 \change_deleted 564990737 1671304331
17008 ies with Bib\SpecialChar TeX
17014 \begin_layout Standard
17015 The most basic information about how to use Bib\SpecialChar TeX
17020 with \SpecialChar LyX
17021 is contained in the section
17023 Bibliography databases
17030 The following subsections explain special bibliography features supported
17031 by \SpecialChar LyX
17035 \begin_layout Section
17036 Alternative Citation Styles
17039 \begin_layout Standard
17040 Standard Bib\SpecialChar TeX
17042 \begin_inset space \thinspace{}
17046 \begin_inset space \space{}
17050 \begin_inset Quotes eld
17054 \begin_inset Quotes erd
17057 ) to refer to a cited work.
17058 However, in many scientific disciplines, other citation styles are in use.
17059 The most common one is the author-year style (e.
17060 \begin_inset space \thinspace{}
17064 \begin_inset space \space{}
17068 \begin_inset Quotes eld
17072 \begin_inset Quotes erd
17077 supports three packages that provide this style,
17078 \begin_inset Flex Code
17081 \begin_layout Plain Layout
17088 \begin_inset Flex Code
17091 \begin_layout Plain Layout
17098 \begin_inset Flex Code
17101 \begin_layout Plain Layout
17108 Each of these packages has their pros and cons, which cannot be listed
17110 If you only want to have simple author-year (or author-numerical) style,
17111 or if you want to use one of the countless style files for
17112 \begin_inset Flex Code
17115 \begin_layout Plain Layout
17121 , then the established
17122 \begin_inset Flex Code
17125 \begin_layout Plain Layout
17131 package is probably your choice.
17132 If you look for specific citation styles common in law studies, you might
17134 \begin_inset Flex Code
17137 \begin_layout Plain Layout
17144 If you want to have full control over the formatting or look for advanced
17145 features such as ibidem, footnote citations, full title citations, advanced
17146 date formats (such as 400 BC) or full localization to other languages than
17147 English, you should definitely consider
17148 \begin_inset Flex Code
17151 \begin_layout Plain Layout
17157 , which exceeds all other packages in terms of features, but is also quite
17158 heavy and more resource-hungry.
17161 \begin_layout Standard
17162 The handling of these packages in \SpecialChar LyX
17163 is basically the same.
17165 \begin_inset Flex Noun
17168 \begin_layout Plain Layout
17169 Document\SpecialChar menuseparator
17176 \begin_inset Flex Noun
17179 \begin_layout Plain Layout
17186 \begin_inset Flex Noun
17189 \begin_layout Plain Layout
17196 \begin_inset Flex Noun
17199 \begin_layout Plain Layout
17206 \begin_inset Flex Noun
17209 \begin_layout Plain Layout
17216 \begin_inset Flex Noun
17219 \begin_layout Plain Layout
17220 Biblatex (Natbib mode)
17226 \begin_inset Flex Noun
17229 \begin_layout Plain Layout
17236 \begin_inset Flex Noun
17239 \begin_layout Plain Layout
17246 \begin_inset space ~
17249 6.5.3 in the User's Guide for more information on these choices).
17250 With all these packages, you will get some extra features in the citation
17251 dialog and you can select the style of the reference (
17252 \begin_inset Quotes eld
17256 \begin_inset Quotes erd
17260 \begin_inset Quotes eld
17264 \begin_inset Quotes erd
17268 \begin_inset Quotes eld
17272 \begin_inset Quotes erd
17276 \begin_inset Quotes eld
17280 \begin_inset Quotes erd
17284 Note that either package needs specifically designed style files.
17285 They all ship their own, but there are lots of additional style files,
17286 and there is even an interactive style file builder
17290 \begin_layout Plain Layout
17292 \begin_inset Flex URL
17295 \begin_layout Plain Layout
17297 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
17308 \begin_inset Flex Code
17311 \begin_layout Plain Layout
17320 \begin_layout Section
17321 Subdivided Bibliographies
17324 \begin_layout Standard
17325 Sometimes you might need to divide your bibliography into several sections.
17326 If you are for instance a historian, the possibility to separate sources
17327 and scientific works is most likely a
17328 \begin_inset Quotes eld
17332 \begin_inset Quotes erd
17336 Unfortunately, Bib\SpecialChar TeX
17337 itself does not allow you to do this.
17338 But with the help of some \SpecialChar LaTeX
17339 packages, Bib\SpecialChar TeX
17340 can be extended to fit your needs.
17343 \begin_layout Standard
17345 provides native support for one of these packages,
17353 \begin_layout Plain Layout
17355 \begin_inset Flex URL
17358 \begin_layout Plain Layout
17360 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
17370 The advantage of this package (compared to other packages such as
17374 ) is that you don't need to define new citation commands.
17375 Instead, you need to prepare different bibliographic databases which include
17376 the entries for the different sections of the bibliography.
17377 For example: If you want to divide your bibliography into the sections
17379 \begin_inset Quotes eld
17383 \begin_inset Quotes erd
17387 \begin_inset Quotes eld
17391 \begin_inset Quotes erd
17394 , you first need to create two bibliographic databases, e.
17395 \begin_inset space \thinspace{}
17399 \begin_inset space \space{}
17403 \begin_inset Flex Code
17406 \begin_layout Plain Layout
17413 \begin_inset Flex Code
17416 \begin_layout Plain Layout
17426 \begin_layout Standard
17428 \begin_inset Flex Noun
17431 \begin_layout Plain Layout
17432 Document\SpecialChar menuseparator
17439 \begin_inset Flex Noun
17442 \begin_layout Plain Layout
17449 \begin_inset Flex Noun
17452 \begin_layout Plain Layout
17453 Subdivided bibliography
17459 Now you can insert multiple Bib\SpecialChar TeX
17460 bibliographies, one for each section of
17462 Returning to our example: Insert the Bib\SpecialChar TeX
17464 \begin_inset Flex Code
17467 \begin_layout Plain Layout
17473 and a second one for the database
17474 \begin_inset Flex Code
17477 \begin_layout Plain Layout
17484 You are free to use the same or different styles for each section.
17485 Additionally, you can choose if the bibliography section should contain
17487 \begin_inset Quotes eld
17490 all cited references
17491 \begin_inset Quotes erd
17494 of the specified database(s) (which is the default),
17495 \begin_inset Quotes eld
17498 all uncited references
17499 \begin_inset Quotes erd
17503 \begin_inset Quotes eld
17507 \begin_inset Quotes erd
17511 This might be useful if you would like to separate your bibliography into
17513 \begin_inset Quotes eld
17517 \begin_inset Quotes erd
17521 \begin_inset Quotes eld
17525 \begin_inset Quotes erd
17529 \begin_inset Quotes eld
17533 \begin_inset Quotes erd
17537 The titles for the sections can be added as ordinary sections or subsections.
17539 \begin_inset Flex Code
17542 \begin_layout Plain Layout
17548 removes the bibliography title, you have to manually re-add that, too (as
17549 a chapter* or section*, for instance).
17552 \begin_layout Standard
17557 , the procedure is a bit different.
17566 , the aforementioned
17567 \begin_inset Flex Noun
17570 \begin_layout Plain Layout
17571 Subdivided bibliography
17576 option is disabled if you use
17585 provides its own means to generate subdivided bibliographies.
17586 You can either add keywords to bibliography entries via the
17587 \begin_inset Flex Code
17590 \begin_layout Plain Layout
17596 entry option and then filter bibliography sections by keyword (by adding
17598 \begin_inset Flex Code
17601 \begin_layout Plain Layout
17608 \begin_inset Flex Noun
17611 \begin_layout Plain Layout
17617 field of the dialog that opens if you left-click on the
17618 \begin_inset Flex Noun
17621 \begin_layout Plain Layout
17622 Biblatex Generated Bibliography
17627 button), or you can filter by entry types (such as
17636 \begin_inset space \thinspace{}
17641 \begin_inset Flex Code
17644 \begin_layout Plain Layout
17651 \begin_inset Flex Code
17654 \begin_layout Plain Layout
17661 \begin_inset Flex Noun
17664 \begin_layout Plain Layout
17670 field, or you can create so-called
17671 \begin_inset Quotes eld
17674 Bibliography Categories
17675 \begin_inset Quotes erd
17678 to which you can assign individual entries.
17679 Please refer to the Biblatex manual, section
17681 Subdivided Bibliographies
17686 \begin_layout Section
17687 Multiple Bibliographies
17688 \begin_inset CommandInset label
17690 name "subsec:Multiple-Bibliographies"
17697 \begin_layout Standard
17698 Multiple bibliographies, e.
17699 \begin_inset space \thinspace{}
17703 \begin_inset space \space{}
17706 a bibliography for each part, chapter, section, subsection or child (sub-documen
17707 t) of the document, are also supported by \SpecialChar LyX
17709 In order to enable it, go to
17710 \begin_inset Flex Noun
17713 \begin_layout Plain Layout
17714 Document\SpecialChar menuseparator
17715 Settings\SpecialChar menuseparator
17721 and select the relevant unit (e.
17722 \begin_inset space \thinspace{}
17726 \begin_inset Quotes eld
17730 \begin_inset Quotes erd
17734 \begin_inset Flex Noun
17737 \begin_layout Plain Layout
17738 Multiple Bibliographies
17744 Then add a Bib(la)\SpecialChar TeX
17745 bibliography to each unit (e.
17746 \begin_inset space \thinspace{}
17749 g., section) of your document.
17750 In the output, a separate bibliography, containing only the references
17751 done in the current unit is generated.
17754 \begin_layout Standard
17755 If you use Bib\SpecialChar TeX
17757 \begin_inset Flex Code
17760 \begin_layout Plain Layout
17767 \begin_inset Flex Code
17770 \begin_layout Plain Layout
17776 package is used to create multiple bibliographies.
17777 The former package is used if you select
17778 \begin_inset Quotes eld
17782 \begin_inset Quotes erd
17790 \begin_inset Flex Noun
17793 \begin_layout Plain Layout
17794 Sectioned Bibliography
17800 In all other cases,
17801 \begin_inset Flex Code
17804 \begin_layout Plain Layout
17814 \begin_layout Plain Layout
17815 An alternative approach, if you are willing to use some
17816 \begin_inset Flex Noun
17819 \begin_layout Plain Layout
17827 \begin_inset space ~
17831 \begin_inset CommandInset ref
17834 reference "sec:Inserting-TeX-Code"
17839 \begin_inset Flex Code
17842 \begin_layout Plain Layout
17854 \begin_inset Flex Code
17857 \begin_layout Plain Layout
17863 is used, \SpecialChar LyX
17864 encloses the specified units in
17865 \begin_inset Flex Code
17868 \begin_layout Plain Layout
17875 \begin_inset Flex Code
17878 \begin_layout Plain Layout
17887 \begin_inset Flex Code
17890 \begin_layout Plain Layout
17898 in order to create the units.
17899 Note that this approach has some limitations.
17900 First, every citation reference has to be inside some
17901 \begin_inset Flex Code
17904 \begin_layout Plain Layout
17911 So citations outside a defined unit (e.
17912 \begin_inset space \thinspace{}
17915 g., before the first section if you use
17916 \begin_inset Quotes eld
17920 \begin_inset Quotes erd
17924 \begin_inset Quotes eld
17928 \begin_inset Quotes erd
17932 You can also create your own units by entering
17933 \begin_inset Flex Code
17936 \begin_layout Plain Layout
17945 \begin_inset Flex Code
17948 \begin_layout Plain Layout
17956 as \SpecialChar TeX
17957 code (for instance to work around the mentioned limitation).
17959 \begin_inset Flex Code
17962 \begin_layout Plain Layout
17968 s cannot be nested.
17969 A second limitation is that
17970 \begin_inset Flex Code
17973 \begin_layout Plain Layout
17979 always processes all references of a bibliography database, even if they
17981 This can result in odd labels (e.
17982 \begin_inset space \thinspace{}
17987 \begin_inset Quotes eld
17991 \begin_inset Quotes erd
17994 if two works of this author from 2014 are in the database, even if only
17998 \begin_layout Standard
18004 \begin_inset Flex Code
18007 \begin_layout Plain Layout
18013 option is used instead.
18014 If you need specific units, you can start them with the \SpecialChar TeX
18016 \begin_inset Flex Code
18019 \begin_layout Plain Layout
18028 \begin_inset Flex Code
18031 \begin_layout Plain Layout
18040 If you also want to control the end of the unit, use the environment
18041 \begin_inset Flex Code
18044 \begin_layout Plain Layout
18054 \begin_inset Flex Code
18057 \begin_layout Plain Layout
18067 \begin_inset Flex Code
18070 \begin_layout Plain Layout
18076 s cannot be nested.
18077 In addition to the individual bibliography of the current unit,
18081 also provides an easy way to output all bibliographies, subsequently, at
18083 \begin_inset space \thinspace{}
18086 g., at the end of the document).
18088 \begin_inset Quotes eld
18091 all reference units
18092 \begin_inset Quotes erd
18095 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
18097 Please refer to the
18101 manual for more information on this topic.
18104 \begin_layout Chapter
18106 \change_deleted 564990737 1671355654
18110 \change_inserted 564990737 1671355667
18112 \change_deleted 564990737 1671355661
18114 \change_inserted 564990737 1671355684
18116 \begin_inset CommandInset label
18118 name "chap:bullets"
18123 \change_deleted 564990737 1671355684
18125 \begin_inset CommandInset label
18136 \begin_layout Standard
18142 \begin_layout Section
18146 \begin_layout Standard
18148 provides 216 bullet shapes that can be accessed from a simple dialog.
18149 Using this dialog you can easily specify what bullet shape to use at each
18150 level of an itemized list.
18151 These settings are document-wide so you won't be able to specify different
18152 sets of bullets for different paragraphs.
18156 \begin_layout Plain Layout
18157 Well, actually you can but you'll have to do it by hand.
18165 \begin_layout Section
18169 \begin_layout Standard
18170 Open the dialog by selecting the
18171 \begin_inset Flex Noun
18174 \begin_layout Plain Layout
18175 Document\SpecialChar menuseparator
18181 menu item and then select the
18182 \begin_inset Flex Noun
18185 \begin_layout Plain Layout
18194 \begin_layout Standard
18195 The dialog provides you with a table of bullet shapes.
18196 A column of buttons on the left of the table provides access to the six
18197 different panels of bullet shapes.
18198 The row of buttons across the top is used to select which bullet depth
18201 \change_deleted 244031559 1603875981
18202 A text entry under the table shows the currently selected bullet shape's
18204 equivalent and this can be edited if desired.
18205 If you do modify the text you will also need to specify any needed packages
18206 in the \SpecialChar LaTeX
18212 \begin_layout Standard
18213 The six panels are divided up by the packages they require.
18214 The following table shows the mappings from button name to \SpecialChar LaTeX
18218 \begin_layout Standard
18220 \begin_inset Tabular
18221 <lyxtabular version="3" rows="7" columns="2">
18222 <features tabularvalignment="middle">
18223 <column alignment="center" valignment="top" width="0pt">
18224 <column alignment="center" valignment="top" width="0pt">
18226 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
18229 \begin_layout Plain Layout
18244 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
18247 \begin_layout Plain Layout
18264 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
18267 \begin_layout Plain Layout
18282 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
18285 \begin_layout Plain Layout
18294 base \SpecialChar LaTeX
18302 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
18305 \begin_layout Plain Layout
18320 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
18323 \begin_layout Plain Layout
18340 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
18343 \begin_layout Plain Layout
18358 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
18361 \begin_layout Plain Layout
18378 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
18381 \begin_layout Plain Layout
18396 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
18399 \begin_layout Plain Layout
18416 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
18419 \begin_layout Plain Layout
18434 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
18437 \begin_layout Plain Layout
18454 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
18457 \begin_layout Plain Layout
18472 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
18475 \begin_layout Plain Layout
18498 \begin_layout Standard
18500 doesn't stop you using bullets from packages you don't have.
18501 If you get errors from \SpecialChar LaTeX
18502 when you try to view or print the file, then it
18503 is likely you are missing a package.
18507 \begin_layout Plain Layout
18509 doesn't restrict your use since you may be editing locally and exporting
18518 \begin_layout Section
18522 \begin_layout Standard
18523 Select which bullet depth you want to change then select the bullet shape
18525 Any changes will not be visible in \SpecialChar LyX
18526 , but are visible when viewing the document.
18529 \begin_layout Standard
18530 You can reset a bullet shape to the default simply by clicking your right
18531 mouse button on the appropriate bullet depth button.
18535 \begin_layout Plain Layout
18540 want to have multiple sets of paragraphs with different sets of bullets
18541 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
18543 The bullet selection dialog can help though because it provides you with
18544 the \SpecialChar LaTeX
18545 code for a wide range of bullet shapes.
18546 To make your own custom paragraphs you have the following options:
18549 \begin_layout Plain Layout
18553 \begin_layout Plain Layout
18569 \begin_layout Plain Layout
18573 \begin_layout Plain Layout
18595 \begin_layout Itemize
18596 Use the \SpecialChar LaTeX
18598 \begin_inset Flex Code
18601 \begin_layout Plain Layout
18609 to specify a new bullet shape for a given depth.
18610 You'll also need to save the current bullet shape so you can restore it
18612 In this itemized list the following \SpecialChar LaTeX
18613 code was used to change the bullet
18614 used for the first depth.
18618 \begin_layout LyX-Code
18628 \begin_layout LyX-Code
18645 \begin_layout Itemize
18646 Note that the itemize depth is specified in Roman numerals as part of the
18656 \begin_layout Itemize
18657 \begin_inset Argument item:1
18660 \begin_layout Plain Layout
18664 \begin_layout Plain Layout
18682 Specify each individual entry by starting each item with the bullet shape
18684 \begin_inset Quotes eld
18688 \begin_inset Quotes erd
18691 inset (available at
18693 Insert\SpecialChar menuseparator
18697 \begin_inset Flex Noun
18700 \begin_layout Plain Layout
18708 For example, this item was started with
18709 \begin_inset Flex Code
18712 \begin_layout Plain Layout
18727 \begin_layout Plain Layout
18731 \begin_layout Plain Layout
18747 \begin_layout Plain Layout
18748 You'll also need to revert the labelitem back to its previous setting for
18749 the global bullet shape settings to remain in effect.
18750 The way used here was:
18753 \begin_layout LyX-Code
18768 \begin_layout Chapter
18772 \begin_layout Section
18773 Multipart Documents
18776 \begin_layout Subsection
18780 \begin_layout Standard
18781 When you are working on a large file with many sections, it is often convenient
18782 to break up the document into several files, or perhaps you have something
18783 where a table may change from time to time, but the preceding text does
18785 In these cases, you should seriously consider using multipart documents.
18786 For example, scientific papers often have five major sections: the introduction
18787 , observations, results, discussion, and conclusion.
18788 Each of these could be its own separate \SpecialChar LyX
18790 \begin_inset Quotes eld
18794 \begin_inset Quotes erd
18797 file which contains the title, authors, abstract, references, etc., plus
18798 the five included files.
18799 It is important to note that each of these files is a full \SpecialChar LyX
18801 can be formatted and printed on its own, as well as included in a master
18803 Each of these files must have the same document class, however—don't attempt
18804 to mix book classes with article classes.
18805 You may also include \SpecialChar LaTeX
18806 files; however, these files must not have their own
18808 \begin_inset space \thinspace{}
18812 \begin_inset space \space{}
18815 everything up to and including the
18816 \begin_inset Flex Code
18819 \begin_layout Plain Layout
18827 line as well as the
18828 \begin_inset Flex Code
18831 \begin_layout Plain Layout
18839 line must be deleted) or else errors will be generated when you try to
18843 \begin_layout Standard
18845 allows you to include files quite easily with
18846 \begin_inset Flex Noun
18849 \begin_layout Plain Layout
18850 Insert\SpecialChar menuseparator
18852 \begin_inset space ~
18861 When you click on this selection a small box is inserted into the file
18862 at the current cursor location.
18863 Clicking on the box raises a dialog which allows you to select the file
18864 to be included, and the method of its inclusion.
18868 \begin_layout Standard
18869 The file selection box should by now be obvious.
18870 The three inclusion methods are
18871 \begin_inset Quotes eld
18875 \begin_inset Quotes erd
18879 \begin_inset Quotes eld
18883 \begin_inset Quotes erd
18887 \begin_inset Quotes eld
18891 \begin_inset Quotes erd
18896 \begin_inset Quotes eld
18900 \begin_inset Quotes erd
18904 \begin_inset Quotes eld
18908 \begin_inset Quotes erd
18911 are similar in many ways, but there are also some notable differences:
18914 \begin_layout Enumerate
18916 \begin_inset Quotes eld
18920 \begin_inset Quotes erd
18923 are typeset beginning on a new page, while files that are
18924 \begin_inset Quotes eld
18928 \begin_inset Quotes erd
18931 are typeset starting on the current page.
18934 \begin_layout Enumerate
18935 \begin_inset Quotes eld
18939 \begin_inset Quotes erd
18942 files cannot themselves
18943 \begin_inset Quotes eld
18947 \begin_inset Quotes erd
18951 \begin_inset Quotes eld
18955 \begin_inset Quotes erd
18960 \begin_inset Quotes eld
18964 \begin_inset Quotes erd
18967 , on the other hand, infinite sub-inputting is possible.
18970 \begin_layout Enumerate
18971 \begin_inset Quotes eld
18975 \begin_inset Quotes erd
18978 allow for the output of only selected
18979 \begin_inset Quotes eld
18983 \begin_inset Quotes erd
18986 files, while maintaining the actual counters (pagination etc.) and references
18987 (please refer to the section
18990 \begin_inset space ~
18998 \begin_inset space ~
19003 manual for details).
19006 \begin_layout Standard
19008 \begin_inset Quotes eld
19012 \begin_inset Quotes erd
19015 is the preferred method for chapters that are outsourced to child documents,
19017 \begin_inset Quotes eld
19021 \begin_inset Quotes erd
19024 is more suitable for arbitrary file inheritance.
19027 \begin_layout Standard
19029 \begin_inset Quotes eld
19033 \begin_inset Quotes erd
19036 included file allows you to include a file typeset exactly as it appears
19038 \begin_inset space \thinspace{}
19042 \begin_inset space \space{}
19046 \begin_inset Flex Code
19049 \begin_layout Plain Layout
19055 mode, with the characters set in a fixed-width typewriter font.
19056 Normally, spaces in this file are invisible, though two consecutive spaces
19057 are conserved, unlike \SpecialChar LyX
19058 's normal treatment of spaces.
19059 However, setting the
19060 \begin_inset Flex Noun
19063 \begin_layout Plain Layout
19065 \begin_inset space ~
19069 \begin_inset space ~
19073 \begin_inset space ~
19081 checkbox typesets a mark to unambiguously define the presence of a space.
19085 \begin_layout Standard
19086 Generally, the master file is converted into a full \SpecialChar LaTeX
19087 file before typesetting,
19088 while the included files are converted to \SpecialChar LaTeX
19089 files that do not have all the
19090 preamble information.
19093 \begin_layout Subsection
19094 Cross-References Between Files
19097 \begin_layout Standard
19098 \begin_inset Box Shadowbox
19108 height_special "totalheight"
19113 backgroundcolor "none"
19116 \begin_layout Plain Layout
19117 This section is somewhat out of date.
19118 Need to describe default master documents and how children are opened when
19128 \begin_layout Standard
19129 It is possible to set up cross-references between the different files.
19130 First, open all the files in question: let's call them A and B in a two
19131 file example, where B is included in A.
19132 Let's say you insert a label in A, then want to reference it in B.
19133 Open the cross-reference dialog whilst in document B, and you can select
19135 \begin_inset Quotes eld
19139 \begin_inset Quotes erd
19145 \begin_layout Subsection
19146 Bibliography Lists in all Subdocuments
19149 \begin_layout Standard
19150 If you work with child documents, you might want to have only one main bibliogra
19151 phy at the end, but still be able to have a selected bibliography for the
19152 child if you output it on its own.
19153 Here is how to achieve this.
19156 \begin_layout Standard
19157 For the main document, you just insert a bibliography inset at the place
19158 where the main bibliography has to appear (within the master file or within
19160 If the bibliography inset is in the master file, the references will be
19161 inherited by all children, so they are available in the citation dialog
19165 \begin_layout Standard
19166 For child-specific bibliographies, insert bibliography insets within the
19167 child documents, at the place where the bibliography should appear when
19168 the child is compiled separately.
19169 However, the trick is to insert them into a branch (
19171 Insert\SpecialChar menuseparator
19172 Branch\SpecialChar menuseparator
19173 Insert New Branch...
19176 \begin_inset space \thinspace{}
19181 \begin_inset Quotes eld
19185 \begin_inset Quotes erd
19189 Within the children, activate the branch (
19191 Document\SpecialChar menuseparator
19192 Settings...\SpecialChar menuseparator
19196 Within the master, deactivate the branch (
19198 Document\SpecialChar menuseparator
19199 Settings...\SpecialChar menuseparator
19203 Now the child's bibliography will be ignored by the master, but considered
19207 \begin_layout Standard
19208 If you need multiple bibliographies (e.
19209 \begin_inset space \thinspace{}
19212 g., one per child in the
19216 ), please refer to sec.
19217 \begin_inset space ~
19221 \begin_inset CommandInset ref
19224 reference "subsec:Multiple-Bibliographies"
19231 \begin_layout Section
19236 \begin_layout Standard
19237 Users sometimes need to be able to
19238 \begin_inset Quotes eld
19242 \begin_inset Quotes erd
19246 file together with all the images (and other files) on which it depends,
19247 either for sending to a publisher or for sharing with a co-author.
19249 includes a Python script (
19250 \begin_inset Flex Code
19253 \begin_layout Plain Layout
19259 ) that automates this process.
19260 To use it, you must have either the
19261 \begin_inset Flex Code
19264 \begin_layout Plain Layout
19271 \begin_inset Flex Code
19274 \begin_layout Plain Layout
19280 python modules installed on your system.
19281 By default, the script prefers the
19282 \begin_inset Flex Code
19285 \begin_layout Plain Layout
19292 \begin_inset Flex Code
19295 \begin_layout Plain Layout
19301 format on Unix-like systems and the
19302 \begin_inset Flex Code
19305 \begin_layout Plain Layout
19314 \begin_layout Standard
19316 's configuration process will set the script up to export a `\SpecialChar LyX
19318 and this format will then be available under
19319 \begin_inset Flex Code
19322 \begin_layout Plain Layout
19323 File\SpecialChar menuseparator
19332 \begin_layout Standard
19333 Independently of the platform, the generation of a particular archive format
19334 can be forced by adding either the
19335 \begin_inset Flex Code
19338 \begin_layout Plain Layout
19345 \begin_inset Flex Code
19348 \begin_layout Plain Layout
19355 \begin_inset Flex Code
19358 \begin_layout Plain Layout
19365 \begin_inset Flex Code
19368 \begin_layout Plain Layout
19374 format) switch to the
19375 \begin_inset Flex Code
19378 \begin_layout Plain Layout
19380 \SpecialChar menuseparator
19388 \begin_inset Flex Code
19391 \begin_layout Plain Layout
19392 Tools\SpecialChar menuseparator
19393 Preferences\SpecialChar menuseparator
19394 File Handling\SpecialChar menuseparator
19401 (Make sure you add the switch after the script name, not before it.)
19404 \begin_layout Section
19405 Fancy Headers and Footers
19408 \begin_layout Standard
19409 The default page layout is rather plain; for an
19410 \begin_inset Flex Code
19413 \begin_layout Plain Layout
19419 document class, all you get is a centered page number at the bottom of
19421 This document uses KOMA-script's book class, so it appears to be a bit
19423 But to really put on a show, you need to set the document page style to
19425 \begin_inset Quotes eld
19429 \begin_inset Quotes erd
19432 , as mentioned in the
19437 This section describes the \SpecialChar LaTeX
19438 code you need to insert in your \SpecialChar LaTeX
19440 order to get the desired effects.
19443 \begin_layout Standard
19444 For more information on fancy headers, see the
19445 \begin_inset Flex Code
19448 \begin_layout Plain Layout
19454 package documentation.
19456 \begin_inset Flex URL
19459 \begin_layout Plain Layout
19461 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
19469 \begin_layout Standard
19470 The page header is divided into three fields, not surprisingly labeled
19471 \begin_inset Quotes eld
19475 \begin_inset Quotes erd
19479 \begin_inset Quotes eld
19483 \begin_inset Quotes erd
19487 \begin_inset Quotes eld
19491 \begin_inset Quotes erd
19495 The footer is also divided into these three fields.
19496 The \SpecialChar LaTeX
19497 commands to set these fields in the simplest manner are
19498 \begin_inset Flex Code
19501 \begin_layout Plain Layout
19510 \begin_inset Flex Code
19513 \begin_layout Plain Layout
19522 \begin_inset Flex Code
19525 \begin_layout Plain Layout
19534 \begin_inset Flex Code
19537 \begin_layout Plain Layout
19546 Suppose you wish to put your name in the upper left hand corner of each
19548 Simply insert the following command in the preamble:
19551 \begin_layout Standard
19560 \begin_layout Standard
19561 You will now see your name in the upper left.
19562 If a field has a default entry that you would like to get rid of (often
19563 the page number appears in the central footer) simply include a command
19564 with a blank argument, e.
19565 \begin_inset space \thinspace{}
19571 \begin_layout Standard
19579 \begin_layout Standard
19580 Let's get really fancy: lets put the section number with the word
19581 \begin_inset Quotes eld
19585 \begin_inset Quotes erd
19589 \begin_inset space \thinspace{}
19593 \begin_inset space \space{}
19596 Section 3) in the upper left, the page number (e.
19597 \begin_inset space \thinspace{}
19601 \begin_inset space \space{}
19604 Page 4) in the upper right, your name in the lower left, and the date in
19606 The following commands should now appear in the preamble:
19609 \begin_layout Standard
19619 \begin_layout Standard
19627 \begin_layout Standard
19637 \begin_layout Standard
19646 \begin_layout Standard
19654 \begin_layout Standard
19664 \begin_layout Standard
19666 \begin_inset Flex Code
19669 \begin_layout Plain Layout
19678 \begin_inset Flex Code
19681 \begin_layout Plain Layout
19689 access \SpecialChar LaTeX
19690 's section and page counters, and so print out the current section
19693 \begin_inset Flex Code
19696 \begin_layout Plain Layout
19704 simply prints out today's date.
19707 \begin_layout Standard
19708 The thicknesses of the horizontal rules drawn beneath the header and above
19709 the footer can also be modified.
19710 If you don't want one of the rules, set its thickness to 0.
19711 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
19717 \begin_inset Flex Code
19720 \begin_layout Plain Layout
19725 headrulewidth}{0.4pt}
19731 \begin_inset Flex Code
19734 \begin_layout Plain Layout
19739 footrulewidth}{0.4pt}
19744 to set the thicknesses.
19747 \begin_layout Standard
19748 You can switch the header/footer settings on and off for individual pages
19749 using commands like
19750 \begin_inset Flex Code
19753 \begin_layout Plain Layout
19756 thispagestyle{empty}
19762 \begin_inset Flex Code
19765 \begin_layout Plain Layout
19768 thispagestyle{plain}
19774 \begin_inset Flex Code
19777 \begin_layout Plain Layout
19780 thispagestyle{fancy}
19786 Simply insert them in the text on the page you want changed and mark them
19787 as \SpecialChar TeX
19789 In fact, title pages are marked as plain by default, while following pages
19790 are marked fancy when using the global fancy setting.
19793 \begin_layout Standard
19794 As a final example, it is possible to include an image in the header or
19796 Suppose you want to put a company logo in the upper lefthand corner.
19797 You might try something like
19800 \begin_layout Standard
19809 includegraphics{logo.eps}}}
19812 \begin_layout Standard
19814 (you may need to preface this with
19815 \begin_inset Flex Code
19818 \begin_layout Plain Layout
19821 usepackage{graphics}
19826 if you don't include graphics elsewhere in your document).
19829 \begin_layout Chapter
19831 and the World Wide Web
19834 \begin_layout Standard
19836 has long supported the export of documents to various web-friendly formats,
19838 Before version 2.0, however, HTML export was always accomplished by the
19839 use of external converters.
19843 \begin_layout Plain Layout
19844 For details on the use of external converters with \SpecialChar LyX
19849 section of the Customization manual.
19854 These fall into two large groups: there are converters that use \SpecialChar LaTeX
19856 intermediate format, such as
19857 \begin_inset Flex Code
19860 \begin_layout Plain Layout
19867 \begin_inset Flex Code
19870 \begin_layout Plain Layout
19877 \begin_inset Flex Code
19880 \begin_layout Plain Layout
19886 , relying upon \SpecialChar LyX
19887 to produce the \SpecialChar LaTeX
19888 ; and there is a converter that works directly
19889 on \SpecialChar LyX
19891 \begin_inset Flex Code
19894 \begin_layout Plain Layout
19902 All of these have different advantages and disadvantages.
19906 \begin_layout Standard
19907 The \SpecialChar LaTeX
19908 -based converters have the advantage that, in principle, they know everythin
19909 g about the exported document that \SpecialChar LaTeX
19911 Such converters do not care, for example, if a certain block of code was
19912 produced by \SpecialChar LyX
19913 or was Evil Red Text.
19914 These converters know about
19915 \begin_inset Flex Code
19918 \begin_layout Plain Layout
19924 files, counters, and references, and can often make use of the
19925 \begin_inset Flex Code
19928 \begin_layout Plain Layout
19934 files generated by Bib\SpecialChar TeX
19936 On the other hand, \SpecialChar LaTeX
19937 is a very hard language to parse—it is sometimes said
19938 that only \SpecialChar TeX
19939 itself understands \SpecialChar TeX
19940 —and \SpecialChar LaTeX
19941 -based converters will often choke on
19942 what seem to be quite simple constructs; complex ones can throw them completely
19943 , and as of this writing, for example, the
19947 manual will not export with
19948 \begin_inset Flex Code
19951 \begin_layout Plain Layout
19957 , though the others will.
19958 The other issue concerns how math is handled.
19959 These converters typically convert the formulae into little pictures that
19960 are then linked from the HTML document.
19961 Since these are actually generated by \SpecialChar LaTeX
19962 , they are accurate.
19963 But they do not scale well, and just getting them to look as if they are
19964 actually meant to be in your document—so that the font sizes seem to be
19965 roughly the same—can be a challenge.
19968 \begin_layout Standard
19970 \begin_inset Flex Code
19973 \begin_layout Plain Layout
19981 \begin_inset CommandInset href
19983 name "http://pinchito.es/elyxer/"
19984 target "http://pinchito.es/elyxer/"
19989 ) solves some of these problems.
19990 In particular, the formulae it produces scale perfectly, since it renders
19991 math using a combination of HTML and CSS rather than converting the formulae
19993 But even moderately complex formula are rendered less well than with
19994 \begin_inset Flex Code
19997 \begin_layout Plain Layout
20003 ; this reflects the limitations of HTML.
20007 \begin_layout Plain Layout
20009 \begin_inset Flex Code
20012 \begin_layout Plain Layout
20019 can also use jsMath and MathJax for equations, but this setting is only
20020 available globally and requires one to have access to a server that runs
20026 More importantly (as of version 1.1.1, at least),
20027 \begin_inset Flex Code
20030 \begin_layout Plain Layout
20037 has limited support for math macros and no support for user-defined paragraph
20038 or character styles.
20039 These limitations make
20040 \begin_inset Flex Code
20043 \begin_layout Plain Layout
20050 unsuitable for many of the documents \SpecialChar LyX
20052 In principle, of course, these problems could be solved, but the \SpecialChar LyX
20054 have decided to follow a different path and have made \SpecialChar LyX
20056 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
20057 , DocBook, and plaintext.
20060 \begin_layout Standard
20061 As of this writing, XHTML output remains under development and should probably
20063 \begin_inset Quotes eld
20067 \begin_inset Quotes erd
20074 \begin_layout Plain Layout
20076 \begin_inset Flex Code
20079 \begin_layout Plain Layout
20080 development/HTML/HTML.notes
20085 , which can be found in the \SpecialChar LyX
20087 \begin_inset CommandInset href
20089 name "accessed online"
20090 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
20095 , usually contains up-to-date information about the state of XHTML output.
20096 See also the list of XHTML bugs on
20097 \begin_inset CommandInset href
20099 name "the bug tracker"
20100 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"
20110 Still, the developers have chosen this approach because it has several
20111 potential advantages over the other two.
20114 \begin_layout Standard
20115 These advantages are primarily due to the fact that the XHTML output routines,
20116 since they are part of \SpecialChar LyX
20117 , know everything \SpecialChar LyX
20118 knows about the document being
20123 \begin_layout Plain Layout
20124 Another advantage is that, since these routines are internal to \SpecialChar LyX
20126 immune to changes in \SpecialChar LyX
20127 's file format, or to changes in the semantics of
20133 So they know about the table of contents (as displayed in the outline),
20134 about the counters associated with different paragraph styles, and about
20135 user-defined styles.
20136 The XHTML output routines know what \SpecialChar LyX
20137 knows about internationalization,
20138 too, so they will output
20139 \begin_inset Quotes eld
20143 \begin_inset Quotes erd
20147 \begin_inset Quotes eld
20155 \begin_inset Quotes erd
20158 , depending upon the language in effect at the time.
20162 \begin_layout Standard
20163 Quite generally, the output routines know what \SpecialChar LyX
20164 knows about document layout,
20165 that is, about how the document is to be rendered on screen.
20166 We use this information when we output the document as XHTML.
20167 In particular, \SpecialChar LyX
20172 generates CSS style information corresponding to the layout information
20173 it uses to render the document on screen: if section headings are supposed
20174 to be sans-serif and bold as seen in \SpecialChar LyX
20175 , then (by default) they will be sans-seri
20176 f and bold when viewed in a web browser, too.
20177 And this is true not just for pre-defined styles, like Section, but for
20178 any style, including user-defined styles.
20179 Indeed, the XHTML output routines make no distinction between user-defined
20181 \change_deleted 244031559 1603876931
20183 \change_inserted 244031559 1603876940
20186 styles and \SpecialChar LyX
20187 's own pre-defined styles: in each case, everything \SpecialChar LyX
20189 the styles is contained in the layout files.
20190 And much the same is true as regards pre-defined textual insets, such as
20191 footnotes, and various custom insets.
20195 \begin_layout Standard
20196 The result is that XHTML output can be customized and extended in exactly
20197 the same way \SpecialChar LaTeX
20198 output can be customized and extended: through layout files
20200 See chapter five of the
20204 manual for the details.
20207 \begin_layout Standard
20208 The remainder of this chapter contains more detailed information on XHTML
20209 output, its limitations, and ways to work around those limitations.
20212 \begin_layout Section
20213 Math Output in XHTML
20216 \begin_layout Standard
20218 offers four choices for how math is rendered.
20219 These have various advantages and disadvantages:
20222 \begin_layout Itemize
20224 \begin_inset Newline newline
20227 MathML is a dialect of XML designed specifically for mathematics on the
20228 web, and it typically renders very well in browsers that support it.
20229 The disadvantage is that not all browsers support MathML, and support is
20230 not complete even in the Gecko-based browsers, such as Firefox.
20231 \begin_inset Newline newline
20234 If \SpecialChar LyX
20235 is unable to render a formula as MathML—for example, if the formula
20237 \begin_inset Flex Code
20240 \begin_layout Plain Layout
20246 package or ERT—then it will instead output the formula as an image.
20250 \begin_layout Itemize
20252 \begin_inset Newline newline
20255 As mentioned above,
20256 \begin_inset Flex Code
20259 \begin_layout Plain Layout
20265 outputs math as HTML, styled by CSS.
20269 \begin_layout Plain Layout
20271 has borrowed some of the CSS for its HTML output from
20272 \begin_inset Flex Code
20275 \begin_layout Plain Layout
20286 For simple formulae, this can work quite well, though with more complicated
20287 formulae it tends to break down.
20288 Still, this method has the advantage that it is very widely supported and
20289 so it may be appropriate for documents that contain only a little, fairly
20291 \begin_inset Newline newline
20294 If Lyx is unable to render a formula as HTML—for example, if the formula
20296 \begin_inset Flex Code
20299 \begin_layout Plain Layout
20305 package or ERT—then it will instead output the formula as an image.
20309 \begin_layout Itemize
20311 \begin_inset Newline newline
20315 \begin_inset Flex Code
20318 \begin_layout Plain Layout
20325 will output formulae as images, the very same images, in fact, that are
20326 used for instant preview.
20330 \begin_layout Plain Layout
20331 Instant preview does
20335 have to be on for images to be output, however.
20340 The advantage to this method is that the images are simply generated by
20342 , so they are very accurate.
20343 The disadvantage, as mentioned earlier, is that these are bitmapped images,
20344 so they do not scale terribly well, and one cannot copy them, etc.
20345 \begin_inset Newline newline
20348 The size of the images can be controlled by setting the
20349 \begin_inset Quotes eld
20352 Math Images Scaling
20353 \begin_inset Quotes erd
20357 \begin_inset Flex Noun
20360 \begin_layout Plain Layout
20361 Document\SpecialChar menuseparator
20362 Settings\SpecialChar menuseparator
20372 \begin_layout Plain Layout
20373 For those who want to know, this controls the resolution of the image in
20374 dots per inch and is based upon a default of 75 dpi.
20380 \begin_inset Newline newline
20383 If \SpecialChar LyX
20384 for some reason fails to create an image for a formula (e.g., if a required
20386 package is not installed), then it will fall back to outputing the raw
20391 \begin_layout Itemize
20394 \begin_inset Newline newline
20397 Finally, \SpecialChar LyX
20398 will happily output math as \SpecialChar LaTeX
20400 As well as being the output of last resort, this method can be used with
20402 \begin_inset CommandInset href
20405 target "http://www.math.union.edu/~dpvc/jsMath/"
20410 , which uses JavaScript to render \SpecialChar LaTeX
20411 embedded in HTML documents.
20413 wraps the \SpecialChar LaTeX
20415 \begin_inset Flex Code
20418 \begin_layout Plain Layout
20424 (for inline formulas) or
20425 \begin_inset Flex Code
20428 \begin_layout Plain Layout
20434 (for displayed formulas) with
20435 \begin_inset Flex Code
20438 \begin_layout Plain Layout
20444 , as is required for jsMath.
20447 \begin_layout Standard
20448 One of these output methods must be selected under
20449 \begin_inset Flex Noun
20452 \begin_layout Plain Layout
20453 Document\SpecialChar menuseparator
20454 Settings\SpecialChar menuseparator
20461 By default, \SpecialChar LyX
20463 This is a document-wide setting, therefore.
20466 \begin_layout Standard
20467 Eventually, \SpecialChar LyX
20468 will offer the user the option to select an alternate output
20469 method for a particular inset, say, one that isn't being rendered very
20474 \begin_layout Plain Layout
20475 That said, since \SpecialChar LyX
20476 falls back to images if the inset contains ERT, then one
20477 can force output as an image by putting some harmless ERT into the math,
20479 \begin_inset Formula $a=b\relax$
20490 \begin_layout Section
20491 Bibliography and Citations
20494 \begin_layout Standard
20495 XHTML output fully supports bibliographies and citations.
20499 \begin_layout Standard
20500 Citation labels are generated by the same machinery that generates \SpecialChar LyX
20502 labels, so the labels will look in the output much as they do in \SpecialChar LyX
20505 If you are using numerical citations, then \SpecialChar LyX
20506 will output numerical labels,
20507 such as [1] or [17], rather than simply showing the citation key in square
20508 brackets, as it does on-screen.
20509 If you are using author-year citations, then \SpecialChar LyX
20510 will add lowercase letters
20511 to the years, just as Bib\SpecialChar TeX
20512 does, if it finds more than one citation for
20513 a given author-year combination.
20514 The labels will be printed with the bibliography entries.
20515 Note that there is, at present, no way to customize the appearance of the
20516 labels, for example, to choose between square brackets and parentheses.
20519 \begin_layout Standard
20520 Bibliography output is handled by the same machinery that handles the presentati
20521 on of reference information in the citation dialog, so you will see in the
20522 XHTML output pretty much what you would see if you were to look at a given
20523 entry in the citation dialog.
20524 The formatting can be customized in your layout file or, preferably, in
20530 manual for the details.
20533 \begin_layout Standard
20534 The main defect at present is that cross-referenced information is printed
20535 with every entry with which it is associated.
20536 So you can see things like this:
20539 \begin_layout Quote
20541 \begin_inset Quotes eld
20544 Context and Logical Form
20545 \begin_inset Quotes erd
20550 Language in Context: Selected Essays
20552 (Oxford: Oxford University Press, 2007), pp.
20556 \begin_layout Quote
20558 \begin_inset Quotes eld
20561 Semantics in Context
20562 \begin_inset Quotes erd
20567 Language in Context: Selected Essays
20569 (Oxford: Oxford University Press, 2007), pp.
20573 \begin_layout Standard
20574 This should be fixed before long.
20577 \begin_layout Standard
20578 There is no support at present for sectioned bibliographies.
20579 If you have multiple bibliographies, then \SpecialChar LyX
20580 will print the same bibliography
20584 \begin_layout Section
20588 \begin_layout Standard
20590 will happily export indexes as XHTML, but with certain limitations at the
20594 \begin_layout Standard
20595 Index export will be most reliable when you do not attempt to use the fancy
20596 constructs that are described in the section on indexes in the
20604 \begin_layout Plain Layout
20605 The main issue here is that \SpecialChar LyX
20606 itself does not really handle these.
20607 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
20613 We'll describe how they are handled using the subsection headings from
20617 \begin_layout Itemize
20618 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
20619 makes an effort to support these,
20620 but the entries must be separated by
20621 \begin_inset Quotes eld
20625 \begin_inset Quotes erd
20628 , that is, there must be spaces around the exclamation point.
20629 This is because it is otherwise too difficult to check for escaped exclamation
20630 points, ones in math, and so forth.
20633 \begin_layout Itemize
20634 Page Ranges: There is no support at all for page ranges, since these make
20635 no sense with XHMTL.
20636 Instead, you will just get two index entries, one at either end.
20639 \begin_layout Itemize
20640 Cross-referencing: There is no support for cross-referencing.
20641 If \SpecialChar LyX
20642 finds an entry containing the
20643 \begin_inset Quotes eld
20646 |see\SpecialChar ldots
20648 \begin_inset Quotes erd
20651 construct, it is just dropped, and the rest is treated as an ordinary index
20655 \begin_layout Itemize
20656 Index Entry Order: \SpecialChar LyX
20657 does support attempts to fix the sorting order.
20658 It will take what is before the first `@' it finds and use that for sorting,
20659 taking what follows the first `@' to be the actual entry.
20660 At present, \SpecialChar LyX
20661 does not check for escaped `@', so do not try to index email
20665 \begin_layout Itemize
20666 Index Entry Layout: You can format entries by using the text style dialog,
20667 or by using any other method available within \SpecialChar LyX
20669 There is no support for constructs like:
20670 \begin_inset Quotes eld
20674 \begin_inset Quotes erd
20678 Indeed, if \SpecialChar LyX
20679 finds a pipe symbol, `|', in an entry, it will delete it and
20680 everything that follows it.
20683 \begin_layout Itemize
20684 Multiple Indexes: There is no support for multiple indexes.
20685 Rather, all index entries will be printed as one large index.
20686 To avoid our printing several versions of the index, we print only the
20687 main index, so make sure you have one.
20690 \begin_layout Section
20691 Nomenclature and Glossary
20694 \begin_layout Standard
20695 There is at present no support for glossaries.
20696 Adding it would be fairly trivial, and welcome.
20699 \begin_layout Chapter
20701 \change_inserted 1075283030 1616534180
20705 \begin_layout Standard
20707 \change_inserted 1075283030 1616534386
20708 Apart from HTML, \SpecialChar LyX
20709 can generate documents in the DocBook XML vocabulary.
20710 With versions 2.3 and before, only select templates could be used to generate
20711 DocBook documents (only version 4).
20712 Starting with \SpecialChar LyX
20713 2.4, most \SpecialChar LyX
20714 layouts can generate valid DocBook documents (only
20716 This feature is built into \SpecialChar LyX
20717 and does not require the use of external tools.
20720 \begin_layout Standard
20722 \change_inserted 1075283030 1616534437
20723 The result is that the DocBook output can be customized and extended in
20724 exactly the same way \SpecialChar LaTeX
20725 output can be customized and extended: through layout
20727 See chapter five of the
20731 manual for the details.
20734 \begin_layout Standard
20736 \change_inserted 1075283030 1616534475
20737 Most \SpecialChar LyX
20738 features are supported with DocBook, like math output.
20741 \begin_layout Itemize
20743 \change_inserted 1075283030 1616534741
20744 Math output is performed mostly in MathML (the major exception being constructio
20745 ns not supported by \SpecialChar LyX
20748 All formulae are also available in raw \SpecialChar TeX
20749 in the DocBook output for further
20753 \begin_layout Itemize
20755 \change_inserted 1075283030 1616534852
20756 Bibliographies and citations are implemented, including with an external
20758 Bibliography entries are not prerendered when the detailed information
20759 are available, but rather output with the standard DocBook constructs.
20760 The external DocBook processor is expected to handle the rendering of entries.
20763 \begin_layout Itemize
20765 \change_inserted 1075283030 1616534863
20766 Indexes are supported, including multiple indices.
20771 ), page ranges, and cross-references (
20775 ) are supported, with the exception of the same symbols escaped.
20784 ) are not supported.
20785 There is no support for escaping of index entries.
20788 \begin_layout Itemize
20790 \change_inserted 1075283030 1616534884
20791 Glossaries are implemented.
20794 \begin_layout Standard
20796 \change_inserted 1075283030 1616534894
20797 Two major parameters can be set at the document level.
20800 \begin_layout Itemize
20802 \change_inserted 1075283030 1616534948
20803 Format for tables: \SpecialChar LyX
20804 can generate tables either as HTML (default value) or
20805 CALS, depending on the user's requirements.
20806 Most DocBook processors accept both formats.
20809 \begin_layout Itemize
20811 \change_inserted 1075283030 1616535006
20812 MathML prefix: in DocBook, MathML is included within its own name space,
20814 The implication is that there must be an indication of the tags belonging
20815 to the MathML standard.
20816 Three choices are offered:
20820 \begin_layout Itemize
20822 \change_inserted 1075283030 1616535044
20823 Inline: the MathML name space is defined for each formula (using the
20827 attribute on each formula)
20830 \begin_layout Itemize
20832 \change_inserted 1075283030 1616535090
20837 prefix (default): the MathML name space is defined at the document level
20842 attribute on the root element).
20843 Each MathML is prefixed with
20852 \begin_layout Itemize
20854 \change_inserted 1075283030 1616620405
20859 prefix: similar to the
20868 \begin_layout Standard
20870 \change_inserted 1075283030 1616620470
20871 This option is especially useful if you want \SpecialChar LyX
20872 to match your personal style
20873 or to work with buggy software that only accepts one prefix for MathML.
20879 \begin_layout Chapter
20880 The \SpecialChar LyX
20884 \begin_layout Section
20888 \begin_layout Standard
20889 The `\SpecialChar LyX
20890 server' allows other programs to talk to \SpecialChar LyX
20891 , invoke \SpecialChar LyX
20892 commands, and retrieve
20893 information about the \SpecialChar LyX
20895 This is only intended for advanced users, but they should find it useful.
20896 It is by writing to the \SpecialChar LyX
20897 server, for example, that bibliography managers,
20898 such as JabRef, are able to
20899 \begin_inset Quotes eld
20903 \begin_inset Quotes erd
20906 citations to \SpecialChar LyX
20910 \begin_layout Section
20911 Starting the \SpecialChar LyX
20913 \begin_inset CommandInset label
20915 name "sec:Starting-the-Server"
20922 \begin_layout Standard
20923 The \SpecialChar LyX
20924 server works through the use of a pair of named pipes.
20925 These are usually located in
20926 \begin_inset Flex Code
20929 \begin_layout Plain Layout
20935 , (except on Windows, where
20939 named pipes are special objects located in
20940 \begin_inset Flex Code
20943 \begin_layout Plain Layout
20955 ) and have the names
20956 \begin_inset Quotes eld
20960 \begin_inset Flex Code
20963 \begin_layout Plain Layout
20970 \begin_inset Quotes erd
20974 \begin_inset Quotes eld
20978 \begin_inset Flex Code
20981 \begin_layout Plain Layout
20988 \begin_inset Quotes erd
20992 External programs write into
20993 \begin_inset Flex Code
20996 \begin_layout Plain Layout
21002 and read back data from
21003 \begin_inset Flex Code
21006 \begin_layout Plain Layout
21013 The stem of the pipe names can be defined in the
21014 \begin_inset Flex Noun
21017 \begin_layout Plain Layout
21018 Tools\SpecialChar menuseparator
21024 dialog, for example
21025 \begin_inset Flex Code
21028 \begin_layout Plain Layout
21029 "/home/myhome/lyxpipe"
21035 \begin_inset Flex Code
21038 \begin_layout Plain Layout
21052 on Windows (where any working path instead of lyxpipe can be used, for
21054 \begin_inset Flex Code
21057 \begin_layout Plain Layout
21080 configure this manually in order for the server to start.
21083 \begin_layout Standard
21086 \begin_inset Flex Code
21089 \begin_layout Plain Layout
21096 \begin_inset Flex Code
21099 \begin_layout Plain Layout
21105 ' to create the pipes.
21106 If one of the pipes already exists, \SpecialChar LyX
21107 will assume that another \SpecialChar LyX
21109 is already running and will not start the server.
21110 On POSIX (Unix like) systems, if for some other reason, an unused
21111 \begin_inset Quotes eld
21115 \begin_inset Quotes erd
21118 pipe is left in existence when \SpecialChar LyX
21119 closes, then \SpecialChar LyX
21120 will try to delete it.
21121 If this fails for some reason, you will need to delete the pipes manually
21122 and then restart \SpecialChar LyX
21124 On Windows, pipes are deleted by the OS on program termination or crash,
21126 \begin_inset Quotes eld
21130 \begin_inset Quotes erd
21133 pipes should not be possible.
21136 \begin_layout Standard
21137 To have several \SpecialChar LyX
21138 processes with servers at the same time, you have to use
21139 different configurations, perhaps by using separate user directories, each
21141 \begin_inset Flex Code
21144 \begin_layout Plain Layout
21150 file, for each process.
21153 \begin_layout Standard
21154 If you are developing a client program, you might find it useful to enable
21155 debugging information from the \SpecialChar LyX
21157 Do this by starting \SpecialChar LyX
21159 \begin_inset Flex Code
21162 \begin_layout Plain Layout
21171 \begin_layout Standard
21172 You can find a complete example client written in C++ in the source distribution
21174 \begin_inset Flex Code
21177 \begin_layout Plain Layout
21178 development/lyxserver/server_monitor.cpp
21186 \begin_layout Standard
21187 Another useful tool is the command-line based client found in
21188 \begin_inset Flex Code
21191 \begin_layout Plain Layout
21192 src/client/lyxclient
21200 \begin_layout Section
21201 Normal communication
21204 \begin_layout Standard
21205 To issue a \SpecialChar LyX
21206 call, the client writes a line of ASCII text into the input
21208 This line has the following format:
21211 \begin_layout Quote
21225 \begin_layout Description
21226 clientname is a name that the client can choose arbitrarily.
21227 Its only use is that \SpecialChar LyX
21228 will echo it if it sends an answer—so a client can
21229 dispatch results from different requesters.
21232 \begin_layout Description
21233 function is the function you want \SpecialChar LyX
21235 It is the same as the commands you'd use in the minibuffer.
21238 \begin_layout Description
21239 argument is an optional argument which is meaningful only to some functions
21241 \begin_inset Quotes eld
21245 \begin_inset Quotes erd
21248 LFUN will insert the argument as text at the cursor position).
21251 \begin_layout Standard
21252 The answer from \SpecialChar LyX
21253 will arrive in the output pipe and be of the form
21256 \begin_layout Quote
21270 \begin_layout Standard
21279 are just echoed from the command request, while
21283 is more or less useful information filled according to how the command
21284 execution worked out.
21285 Some commands, such as
21286 \begin_inset Quotes eld
21290 \begin_inset Quotes erd
21293 , will return information about the internal state of \SpecialChar LyX
21295 return an empty data-response.
21296 This means that the command execution went fine.
21299 \begin_layout Standard
21300 In case of errors, the response from \SpecialChar LyX
21301 will have this form
21304 \begin_layout Quote
21318 \begin_layout Standard
21323 should contain an explanation of why the command failed.
21326 \begin_layout Standard
21330 \begin_layout LyX-Code
21331 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
21332 \begin_inset Newline newline
21335 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
21336 \begin_inset Newline newline
21339 read a <~/.lyxpipe.out
21340 \begin_inset Newline newline
21346 \begin_layout Subsection
21347 AppleScript (Mac OS X)
21350 \begin_layout Standard
21351 Since \SpecialChar LyX
21352 2.1, \SpecialChar LyX
21353 supports basic interactions with AppleScript for normal communicatio
21354 n through the command run.
21355 This command takes a direct argument (the
21359 to perform) and an optional argument.
21360 It either returns the output of the function or triggers an error with
21361 the error message and code.
21364 \begin_layout Standard
21368 \begin_layout LyX-Code
21369 tell application "\SpecialChar LyX
21373 \begin_layout LyX-Code
21377 \begin_layout LyX-Code
21378 -- Stores the current file name into f
21381 \begin_layout LyX-Code
21382 set f to (run "server-get-filename" with argument "")
21385 \begin_layout LyX-Code
21386 on error the error_message number the error_number
21389 \begin_layout LyX-Code
21390 display dialog "Error: " & the error_number & ".
21394 \begin_layout LyX-Code
21395 & the error_message buttons {"OK"} default button 1
21398 \begin_layout LyX-Code
21402 \begin_layout LyX-Code
21406 \begin_layout Section
21410 \begin_layout Standard
21412 can notify clients of events going on asynchronously.
21413 Currently it will only do this if the user binds a key sequence with the
21415 \begin_inset Quotes eld
21419 \begin_inset Quotes erd
21423 The format of the string \SpecialChar LyX
21424 sends is as follows:
21427 \begin_layout Quote
21428 \begin_inset Flex Code
21431 \begin_layout Plain Layout
21442 \begin_layout Standard
21447 is the printed representation of the key sequence that was actually typed
21451 \begin_layout Standard
21452 This mechanism can be used to extend \SpecialChar LyX
21453 's command set and implement macros.
21454 Bind some key sequence to
21455 \begin_inset Quotes eld
21459 \begin_inset Quotes erd
21463 Then start a client that listens on the output pipe, dispatches the command
21464 according to the sequence, and starts a function that may use \SpecialChar LyX
21467 requests to issue a command or a series of commands to \SpecialChar LyX
21471 \begin_layout Section
21472 The simple \SpecialChar LyX
21476 \begin_layout Standard
21478 implements a simple protocol that can be used for session management.
21479 All messages are of the form
21482 \begin_layout Quote
21492 \begin_layout Standard
21498 \begin_inset Quotes eld
21502 \begin_inset Quotes erd
21506 \begin_inset Quotes eld
21510 \begin_inset Quotes erd
21515 \begin_inset Quotes eld
21519 \begin_inset Quotes erd
21522 is received from a client, \SpecialChar LyX
21523 will report back to inform the client that
21524 it's listening to it's messages, while
21525 \begin_inset Quotes eld
21529 \begin_inset Quotes erd
21532 sent from \SpecialChar LyX
21533 will inform clients that \SpecialChar LyX
21537 \begin_layout Section
21538 Reverse DVI/PDF search
21541 \begin_layout Standard
21542 Some DVI/PDF viewers
21546 \begin_layout Plain Layout
21547 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
21548 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
21557 facility (also called
21562 This means that you can tell \SpecialChar LyX
21563 to put the cursor to a specific line in the
21564 document by clicking at the respective position in the DVI/PDF output.
21565 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
21567 This is done via the \SpecialChar LyX
21568 server either by using the named pipe (
21572 ), or the UNIX domain socket (
21576 ) that \SpecialChar LyX
21577 creates in its temporary directory (this is the way the
21578 \begin_inset Flex Code
21581 \begin_layout Plain Layout
21587 program communicates with \SpecialChar LyX
21589 In some cases, you need a helper script that mediates between the viewer
21590 and \SpecialChar LyX
21591 , in others, the viewer can communicate with \SpecialChar LyX
21593 This depends on the selected viewer and on your operating system.
21594 The same applies to the way viewers need to be configured and the way the
21595 reverse search is actually performed.
21596 In what follows, we will thus describe how to setup reverse search for
21598 Before we turn to this, though, we will explain what needs to be done generally
21599 to enable reverse search in the DVI/PDF output.
21602 \begin_layout Subsection
21604 \begin_inset CommandInset label
21606 name "subsec:rev-search"
21613 \begin_layout Standard
21614 In most cases \SpecialChar LyX
21615 will do the work for you by pressing the following button
21619 arg "buffer-toggle-output-sync"
21623 Alternatively, you can also enable the feature by checking
21625 Synchronize with Output
21628 \begin_inset Flex Noun
21631 \begin_layout Plain Layout
21632 Document\SpecialChar menuseparator
21633 Settings\SpecialChar menuseparator
21640 In such a case \SpecialChar LyX
21641 will automatically insert the necessary Sync\SpecialChar TeX
21643 PDF) or load the srcltx package (for DVI) respectively.
21644 This option can be easily reached also on
21645 \begin_inset Flex Code
21648 \begin_layout Plain Layout
21657 \begin_layout Standard
21658 If you need a different setting, you can select or input a custom macro
21659 from the drop down box just below
21660 \begin_inset Flex Noun
21663 \begin_layout Plain Layout
21664 Document\SpecialChar menuseparator
21665 Settings\SpecialChar menuseparator
21666 Output\SpecialChar menuseparator
21667 Synchronize with Output
21675 \begin_layout Standard
21676 Note that the method
21677 \begin_inset Flex Code
21680 \begin_layout Plain Layout
21688 enables gzip compression.
21689 If your viewer does not support it, you should instead use
21690 \begin_inset Flex Code
21693 \begin_layout Plain Layout
21704 \begin_layout Standard
21705 Please also note that including the
21706 \begin_inset Flex Code
21709 \begin_layout Plain Layout
21716 \begin_inset Flex Code
21719 \begin_layout Plain Layout
21725 sometimes has an undesired impact on the typesetting.
21726 Thus, you should switch output synchronization off for the final typesetting
21728 \begin_inset Flex Code
21731 \begin_layout Plain Layout
21738 \begin_inset Flex Code
21741 \begin_layout Plain Layout
21751 \begin_layout Standard
21752 In case you need some more special settings that are not covered by the
21753 automatic settings, read the next section about how to set up output synchroniz
21755 If the automatic setup suits your needs, you can readily jump to section
21756 \begin_inset space ~
21760 \begin_inset CommandInset ref
21763 reference "subsec:configuring-viewers"
21767 , where the necessary configuration steps in your viewer – needed both with
21768 the automatic and the manual setup – are described.
21771 \begin_layout Subsection
21775 \begin_layout Standard
21777 provides several different methods for reverse search.
21778 Some are built-in in the
21779 \begin_inset Flex Code
21782 \begin_layout Plain Layout
21788 program, some are provided by external packages.
21789 Your choice depends on whether your \SpecialChar LaTeX
21790 distribution already provides a given
21791 method (the built-in methods are rather new) and whether your viewer can
21793 The available methods are described in the following.
21796 \begin_layout Subsubsection*
21797 Built-in DVI-search via src-specials (DVI only)
21800 \begin_layout Standard
21801 This method provides the DVI file with the necessary information for reverse
21803 It is available in \SpecialChar LaTeX
21804 since quite some time (any somewhat recent \SpecialChar LaTeX
21806 should include it), and it works reliably.
21807 To enable it, change the
21808 \begin_inset Flex Noun
21811 \begin_layout Plain Layout
21822 \begin_inset Flex Noun
21825 \begin_layout Plain Layout
21836 \begin_inset Flex Noun
21839 \begin_layout Plain Layout
21840 Preferences\SpecialChar menuseparator
21841 File Handling\SpecialChar menuseparator
21848 \begin_inset Flex Code
21851 \begin_layout Plain Layout
21852 latex -src-specials $$i
21858 If this doesn't work, check if your \SpecialChar TeX
21859 engine needs different options (the
21860 syntax might differ in some distributions).
21863 \begin_layout Subsubsection*
21864 External Packages (PDFSync and scrltx)
21867 \begin_layout Standard
21876 provide reverse search facility for PDF output (via pdflatex) and DVI output,
21878 In order to enable it, load the packages in the \SpecialChar LyX
21882 \begin_layout Itemize
21883 \begin_inset Flex Code
21886 \begin_layout Plain Layout
21889 usepackage{pdfsync}
21894 for reverse PDF search,
21897 \begin_layout Itemize
21898 \begin_inset Flex Code
21901 \begin_layout Plain Layout
21904 usepackage[active]{srcltx}
21909 for reverse DVI search.
21912 \begin_layout Standard
21913 If you want to be able to perform both DVI and PDF reverse searches, you
21914 can also insert in the preamble the following lines
21917 \begin_layout LyX-Code
21921 \begin_inset Newline newline
21927 \begin_inset Newline newline
21932 usepackage{pdfsync}
21933 \begin_inset Newline newline
21939 \begin_inset Newline newline
21944 usepackage[active]{srcltx}
21945 \begin_inset Newline newline
21953 \begin_layout Standard
21954 This way, you can preview the file as either DVI or PDF (pdflatex) and the
21955 right package will be used.
21958 \begin_layout Standard
21959 Note that PDFSync might affect the output layout of your document.
21960 It is therefore advised to disable PDFsync for final documents.
21963 \begin_layout Subsubsection*
21964 Built-in reverse search via Sync\SpecialChar TeX
21968 \begin_layout Standard
21970 \begin_inset Flex Code
21973 \begin_layout Plain Layout
21979 have built-in support for both PDF and DVI reverse search.
21982 Sync\SpecialChar TeX
21985 facility is basically the result of the integration of the PDFSync package
21986 to the pdftex program and its merge with the
21991 You need at least \SpecialChar TeX
21992 Live 2008 or a recent Mik\SpecialChar TeX
21993 distribution in order to use
21998 \begin_layout Plain Layout
21999 For some reason, Mik\SpecialChar TeX
22000 does not understand/obey the command \SpecialChar LyX
22002 the preamble when you check the "Enable Forward/Reverse Search" button
22003 in the toolbar and does not generate the necessary info.
22006 \begin_layout Plain Layout
22007 The generation of the required info can be forced by changing the converter
22008 "\SpecialChar LaTeX
22009 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
22010 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
22011 the -synctex=1 switch).
22016 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
22017 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
22018 already provide Sync\SpecialChar TeX
22022 \begin_layout Standard
22023 To enable Sync\SpecialChar TeX
22024 for DVI output, change the
22025 \begin_inset Flex Noun
22028 \begin_layout Plain Layout
22039 \begin_inset Flex Noun
22042 \begin_layout Plain Layout
22047 (plain) -> DraftDVI
22053 \begin_inset Flex Noun
22056 \begin_layout Plain Layout
22057 Preferences\SpecialChar menuseparator
22058 File Handling\SpecialChar menuseparator
22065 \begin_inset Flex Code
22068 \begin_layout Plain Layout
22069 latex -synctex=1 $$i
22074 , and for PDF output, change the
22075 \begin_inset Flex Noun
22078 \begin_layout Plain Layout
22083 (pdflatex) -> PDF (pdflatex)
22089 \begin_inset Flex Code
22092 \begin_layout Plain Layout
22093 pdflatex -synctex=1 $$i
22099 Should your viewer not be considered in the following description, or in
22100 case of missing success, please check the documentation of your viewer
22101 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
22106 \begin_layout Plain Layout
22107 Note that the option
22108 \begin_inset Flex Code
22111 \begin_layout Plain Layout
22117 option enables gzip compression.
22118 If your viewer does not support it, you should instead use
22119 \begin_inset Flex Code
22122 \begin_layout Plain Layout
22136 \begin_layout Subsection
22137 Configuring and using specific viewers
22138 \begin_inset CommandInset label
22140 name "subsec:configuring-viewers"
22147 \begin_layout Subsubsection*
22148 Xdvi (all platforms)
22151 \begin_layout Standard
22153 \begin_inset Flex Code
22156 \begin_layout Plain Layout
22162 , you don't need to do anything else for performing a reverse DVI search,
22163 as \SpecialChar LyX
22164 already provides the necessary hooks for automatically using the
22165 \begin_inset Flex Code
22168 \begin_layout Plain Layout
22175 Just setup your document as described above (reverse search is triggered
22176 by Ctrl-click or Alt-click on Mac OSX, respectively).
22179 \begin_layout Standard
22180 However, if for whatever reason you want to use the named pipe instead of
22181 the socket for communicating with \SpecialChar LyX
22182 , simply change the DVI viewer in
22183 \begin_inset Flex Noun
22186 \begin_layout Plain Layout
22187 Preferences\SpecialChar menuseparator
22188 File Handling\SpecialChar menuseparator
22198 \begin_layout Plain Layout
22199 On Mac OSX you have to use
22200 \begin_inset Flex Code
22203 \begin_layout Plain Layout
22204 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
22215 \begin_inset Flex Code
22218 \begin_layout Plain Layout
22219 xdvi -editor "lyxeditor.sh %f %l"
22225 \begin_inset Flex Code
22228 \begin_layout Plain Layout
22234 is a suitable script.
22235 For example, a minimal shell script is the following one:
22238 \begin_layout LyX-Code
22240 \begin_inset Newline newline
22243 LYXPIPE="/path/to/lyxpipe"
22244 \begin_inset Newline newline
22247 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
22248 \begin_inset Newline newline
22251 echo "$COMMAND" > "${LYXPIPE}".in || exit
22252 \begin_inset Newline newline
22255 read TMP < "${LYXPIPE}".out || exit
22258 \begin_layout Standard
22260 \begin_inset Flex Code
22263 \begin_layout Plain Layout
22269 is the LyXServer pipe path specified in
22270 \begin_inset Flex Noun
22273 \begin_layout Plain Layout
22274 Preferences\SpecialChar menuseparator
22284 \begin_layout Plain Layout
22286 \begin_inset Flex Code
22289 \begin_layout Plain Layout
22295 folder of a source distribution you can find a
22296 \begin_inset Flex Code
22299 \begin_layout Plain Layout
22305 script which is able to locate the
22309 based on your preferences.
22317 \begin_layout Subsubsection*
22321 \begin_layout Standard
22323 \begin_inset Flex Code
22326 \begin_layout Plain Layout
22327 /Applications/MacDviX_Folder/calleditor.script
22332 , add the following lines:
22335 \begin_layout LyX-Code
22336 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
22337 \begin_inset Newline newline
22343 \begin_layout Standard
22344 Modify the lines accordingly if you install \SpecialChar LyX
22345 somewhere else than in the
22346 Applications folder.
22349 \begin_layout Standard
22350 Reverse search is triggered by Alt-click (OPTION-click).
22353 \begin_layout Subsubsection*
22357 \begin_layout Standard
22359 \begin_inset Flex Code
22362 \begin_layout Plain Layout
22363 open -a Skim.app $$i
22368 to the viewer setting in
22369 \begin_inset Flex Noun
22372 \begin_layout Plain Layout
22373 Preferences\SpecialChar menuseparator
22374 File Handling\SpecialChar menuseparator
22375 File formats\SpecialChar menuseparator
22382 \begin_inset Flex Noun
22385 \begin_layout Plain Layout
22386 Skim\SpecialChar menuseparator
22387 Preferences\SpecialChar menuseparator
22394 \begin_inset Flex Noun
22397 \begin_layout Plain Layout
22403 preset and enter command
22404 \begin_inset Flex Noun
22407 \begin_layout Plain Layout
22408 /Applications/\SpecialChar LyX
22409 .app/Contents/MacOS/lyxeditor
22417 \begin_layout Standard
22418 Reverse search is triggered by COMMAND-SHIFT-click
22421 \begin_layout Subsubsection*
22425 \begin_layout Standard
22426 Reverse search with evince does not work out of the box, but it can be achieved
22427 by means of some third party helper scripts.
22429 \begin_inset CommandInset href
22431 target "https://wiki.lyx.org/LyX/SyncTeX"
22439 \begin_layout Subsubsection*
22443 \begin_layout Standard
22445 \begin_inset Flex Noun
22448 \begin_layout Plain Layout
22449 Settings\SpecialChar menuseparator
22450 Configure Okular\SpecialChar menuseparator
22457 \begin_inset Quotes erd
22461 This inserts the appropriate command (
22462 \begin_inset Flex Code
22465 \begin_layout Plain Layout
22474 \begin_layout Standard
22475 Reverse search is triggered by SHIFT-click.
22477 \change_inserted -712698321 1578211026
22478 Note that this only works if Okular is in
22479 \begin_inset Quotes eld
22483 \begin_inset Quotes erd
22487 \begin_inset space \thinspace{}
22490 e., the hand symbol is clicked).
22495 \begin_layout Subsubsection*
22499 \begin_layout Standard
22500 Qpdfview supports Sync\SpecialChar TeX
22501 since version 0.3.5.
22503 \begin_inset Flex Noun
22506 \begin_layout Plain Layout
22507 Edit\SpecialChar menuseparator
22508 Settings\SpecialChar menuseparator
22514 , click on the input field of the
22515 \begin_inset Quotes eld
22519 \begin_inset Quotes erd
22522 item and add the command
22523 \begin_inset Flex Code
22526 \begin_layout Plain Layout
22535 \begin_layout Standard
22536 Reverse search is triggered by double-click or, in more recent versions,
22540 \begin_layout Subsubsection*
22544 \begin_layout Standard
22545 Launch yap, choose its
22546 \begin_inset Flex Noun
22549 \begin_layout Plain Layout
22550 View\SpecialChar menuseparator
22556 menu and select the
22557 \begin_inset Quotes eld
22561 \begin_inset Quotes erd
22566 \begin_inset Quotes eld
22569 New\SpecialChar ldots
22571 \begin_inset Quotes erd
22574 button and, in the window that opens, enter
22575 \begin_inset Quotes eld
22580 \begin_inset Quotes erd
22583 (or any other name you like) in the
22584 \begin_inset Quotes eld
22588 \begin_inset Quotes erd
22592 Now click on the button labeled
22593 \begin_inset Quotes eld
22598 \begin_inset Quotes erd
22601 to open a file dialog and navigate to the directory containing the batch
22603 \begin_inset Flex Code
22606 \begin_layout Plain Layout
22614 \begin_inset Flex Code
22617 \begin_layout Plain Layout
22623 and then specify the program arguments as
22624 \begin_inset Flex Code
22627 \begin_layout Plain Layout
22635 \begin_inset Flex Code
22638 \begin_layout Plain Layout
22644 wrapper is used for communicating with \SpecialChar LyX
22652 \begin_layout LyX-Code
22654 \begin_inset Newline newline
22657 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
22666 \begin_inset Newline newline
22680 \begin_layout Standard
22681 Make sure that the \SpecialChar LyX
22682 Server pipe path you specified in \SpecialChar LyX
22684 \begin_inset Flex Code
22687 \begin_layout Plain Layout
22701 , otherwise change the
22702 \begin_inset Flex Code
22705 \begin_layout Plain Layout
22711 wrapper accordingly.
22714 \begin_layout Standard
22715 In yap, reverse search is triggered by double-click.
22718 \begin_layout Subsubsection*
22719 SumatraPDF (Windows)
22722 \begin_layout Standard
22723 In order to use SumatraPDF for inverse search, enter
22724 \begin_inset Flex Code
22727 \begin_layout Plain Layout
22728 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
22733 in the viewer setting in
22734 \begin_inset Flex Noun
22737 \begin_layout Plain Layout
22738 Preferences\SpecialChar menuseparator
22739 File Handling\SpecialChar menuseparator
22740 File formats\SpecialChar menuseparator
22747 \begin_inset Flex Code
22750 \begin_layout Plain Layout
22756 is the previous wrapper.
22757 If SumatraPDF.exe is not in your command PATH, use its full file name.
22760 \begin_layout Standard
22761 Reverse search is triggered by double-click.
22764 \begin_layout Subsubsection*
22768 \begin_layout Standard
22769 First of all, make sure that yap is your default DVI viewer in the Windows
22770 environment, then launch it, choose its
22771 \begin_inset Flex Noun
22774 \begin_layout Plain Layout
22775 View\SpecialChar menuseparator
22781 menu and select the
22782 \begin_inset Quotes eld
22786 \begin_inset Quotes erd
22791 \begin_inset Quotes eld
22794 New\SpecialChar ldots
22796 \begin_inset Quotes erd
22799 button and, in the window that opens, enter
22800 \begin_inset Quotes eld
22805 \begin_inset Quotes erd
22808 (or any other name you like) in the
22809 \begin_inset Quotes eld
22813 \begin_inset Quotes erd
22817 Now click on the button labeled
22818 \begin_inset Quotes eld
22823 \begin_inset Quotes erd
22826 to open a file dialog and navigate to the directory containing the
22827 \begin_inset Flex Code
22830 \begin_layout Plain Layout
22836 program (which is installed by default on Cygwin along with the \SpecialChar LyX
22839 \begin_inset Flex Code
22842 \begin_layout Plain Layout
22848 and then specify the program arguments as
22849 \begin_inset Flex Code
22852 \begin_layout Plain Layout
22859 In this way, you will be using the
22863 for communicating with \SpecialChar LyX
22865 If, for whatever reason, you want to use the
22870 \begin_inset Flex Code
22873 \begin_layout Plain Layout
22879 option and be sure to specify the \SpecialChar LyX
22880 Server pipe path in the \SpecialChar LyX
22884 \begin_layout Standard
22885 In yap, reverse search is triggered by double-click.
22888 \begin_layout Subsubsection*
22889 SumatraPDF (Cygwin)
22892 \begin_layout Standard
22893 In order to use SumatraPDF for inverse search, enter
22894 \begin_inset Flex Code
22897 \begin_layout Plain Layout
22898 SumatraPDF -inverse-search "lyxeditor -g %f %l"
22903 in the viewer setting in
22904 \begin_inset Flex Noun
22907 \begin_layout Plain Layout
22908 Preferences\SpecialChar menuseparator
22909 File Handling\SpecialChar menuseparator
22910 File formats\SpecialChar menuseparator
22917 If SumatraPDF.exe is not in your command PATH, use its full posix path.
22919 \begin_inset Flex Code
22922 \begin_layout Plain Layout
22928 enables communication via the
22934 \begin_inset Flex Code
22937 \begin_layout Plain Layout
22943 option if you want to use the
22947 , and be sure to specify the \SpecialChar LyX
22948 Server pipe path in the \SpecialChar LyX
22952 \begin_layout Standard
22953 Reverse search is triggered by double-click.
22956 \begin_layout Section
22960 \begin_layout Standard
22961 Forward search is, as the name implies, in a sense the
22962 \begin_inset Quotes eld
22966 \begin_inset Quotes erd
22970 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
22972 If forward search is set up (as described in what follows), you can put
22973 the cursor anywhere in your \SpecialChar LyX
22975 \begin_inset Flex Noun
22978 \begin_layout Plain Layout
22979 Navigate\SpecialChar menuseparator
22986 \begin_inset Flex Noun
22989 \begin_layout Plain Layout
22995 in the context menu via right mouse click), and then the viewer will jump
22996 to that position as well.
22997 This implies, of course, that your viewer supports this function.
23000 \begin_layout Standard
23001 To make forward search possible, you first need to provide the generated
23002 output PDF/DVI file with additional information about the \SpecialChar TeX
23004 This can be done via the methods described in the section
23005 \begin_inset CommandInset ref
23008 reference "subsec:rev-search"
23015 \begin_layout Standard
23016 Additionally, you need to configure \SpecialChar LyX
23017 for using your viewers in
23018 \begin_inset Flex Noun
23021 \begin_layout Plain Layout
23022 Tools\SpecialChar menuseparator
23023 Preferences\SpecialChar menuseparator
23024 Output\SpecialChar menuseparator
23031 We provide a range of tested configurations for some viewers, which you
23032 can select from the drop down list.
23033 If none of these configurations suits you, you have to find out and enter
23034 a suitable configuration yourself.
23035 The definition syntax uses the following placeholders:
23038 \begin_layout Itemize
23040 \begin_inset Flex Code
23043 \begin_layout Plain Layout
23052 \begin_layout Itemize
23054 \begin_inset Flex Code
23057 \begin_layout Plain Layout
23063 : name of the (temporary) exported .tex file (without path)
23066 \begin_layout Itemize
23068 \begin_inset Flex Code
23071 \begin_layout Plain Layout
23077 : name of the (temporary) exported .tex file (including path)
23080 \begin_layout Itemize
23082 \begin_inset Flex Code
23085 \begin_layout Plain Layout
23091 : name of the exported output file (either dvi or pdf, depending on which
23092 one exists in the temporary directory)
23095 \begin_layout Standard
23096 Note that only some of the viewers provide full and usable forward search
23097 functionality out of the box, among them yap, xdvi, okular
23101 \begin_layout Plain Layout
23102 You might want to set
23103 \begin_inset Flex Code
23106 \begin_layout Plain Layout
23113 \begin_inset Flex Noun
23116 \begin_layout Plain Layout
23117 Tools\SpecialChar menuseparator
23118 Preferences\SpecialChar menuseparator
23119 File Handling\SpecialChar menuseparator
23121 \begin_inset space ~
23134 , qpdfview, and SumatraPDF
23138 \begin_layout Plain Layout
23139 SumatraPDF can also use DDE commands through the external program CMCDDE
23140 — downloadable from
23141 \begin_inset CommandInset href
23143 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
23154 Others, such as evince
23158 \begin_layout Plain Layout
23159 Forward search with evince can be achieved by means of third party helper
23162 \begin_inset CommandInset href
23164 target "https://wiki.lyx.org/LyX/SyncTeX"
23174 , require some extra tools in order to use forward search.
23175 While many of the widespread PDF viewers (most notably Adobe Reader) do
23176 not support forward search at all, some other viewers – e.
23177 \begin_inset space \thinspace{}
23181 xpdf – allow at least to reload the document and jump to a specific page
23182 of the file, so you can at least navigate
23183 \begin_inset Quotes eld
23187 \begin_inset Quotes erd
23191 This latter functionality is provided by an external call of synctex (see
23192 the predefined example configurations).
23196 \begin_layout Standard
23197 Forward search works both with DVI and PDF output.
23199 simply checks which preview format you have used before (i.
23200 \begin_inset space \thinspace{}
23203 e., which format is already there in the temporary directory) and chooses
23204 the appropriate configuration for the respective format.
23207 \begin_layout Chapter
23209 \change_deleted 564990737 1671097409
23210 Special Document Classes
23215 \begin_layout Section
23217 \change_deleted 564990737 1669742044
23221 \begin_layout Standard
23223 \change_deleted 564990737 1669742044
23229 \begin_layout Subsection
23231 \change_deleted 564990737 1669742044
23235 \begin_layout Standard
23237 \change_deleted 564990737 1669742044
23238 This section describes how \SpecialChar LyX
23239 can be used to write articles for submission
23240 to the scientific journal
23242 Astronomy and Astrophysics
23245 \begin_inset Flex URL
23248 \begin_layout Plain Layout
23250 https://www.aanda.org/
23255 ) using Version 5.01 of the document class
23260 This package can be downloaded from the ftp site
23263 \begin_layout Standard
23265 \change_deleted 564990737 1669742044
23266 \begin_inset VSpace medskip
23272 \begin_layout Standard
23275 \change_deleted 564990737 1669742044
23276 \begin_inset Flex URL
23279 \begin_layout Plain Layout
23281 ftp://ftp.edpsciences.org/pub/aa/readme.html
23289 \begin_layout Standard
23291 \change_deleted 564990737 1669742044
23292 \begin_inset VSpace medskip
23298 \begin_layout Standard
23300 \change_deleted 564990737 1669742044
23301 A manual comes together with that package, and this text is not meant to
23302 replace the original manual but is merely a short guide in how to realize
23303 the correct form of your paper.
23307 \begin_layout Standard
23309 \change_deleted 564990737 1669742044
23310 Please note that the publisher of the journal was changed from Springer
23311 to EDP Sciences starting January 1, 2001.
23312 That change involved also some slight changes to the style files, namely
23313 the removal of the thesaurus command.
23314 The \SpecialChar LyX
23315 class aa supports the newest version of these style files, V 5.01.
23316 If you have an older version installed, please upgrade.
23317 For compatibility, the old (version 4) layout has been kept as
23322 Please refer to the comments in
23325 Dir/layouts/aapaper.layout
23330 \begin_layout Subsection
23332 \change_deleted 564990737 1669742044
23336 \begin_layout Standard
23338 \change_deleted 564990737 1669742044
23339 It is recommended you start from the example template distributed with \SpecialChar LyX
23341 If you are not using a template, note the following settings:
23344 \begin_layout Itemize
23346 \change_deleted 564990737 1669742044
23353 Document\SpecialChar menuseparator
23356 dialog (OK, that one was obvious).
23359 \begin_layout Itemize
23361 \change_deleted 564990737 1669742044
23362 Don't change the option
23365 \begin_inset space ~
23375 The whole layout is done by the macros, you shouldn't change anything.
23378 \begin_layout Subsection
23380 \change_deleted 564990737 1669742044
23384 \begin_layout Standard
23386 \change_deleted 564990737 1669742044
23387 First thing to enter is the header information.
23388 It consists of seven entries, of which some are optional.
23392 \begin_layout Itemize
23394 \change_deleted 564990737 1669742044
23402 \begin_layout Itemize
23404 \change_deleted 564990737 1669742044
23412 \begin_layout Itemize
23414 \change_deleted 564990737 1669742044
23422 \begin_layout Itemize
23424 \change_deleted 564990737 1669742044
23432 \begin_layout Itemize
23434 \change_deleted 564990737 1669742044
23439 : [optional] if more than one author: whom to contact for offprint requests.
23442 \begin_layout Itemize
23444 \change_deleted 564990737 1669742044
23449 : [optional] mail address for contacts.
23452 \begin_layout Itemize
23454 \change_deleted 564990737 1669742044
23460 Suggested format is
23462 Received: <date>; Accepted <date>
23465 \begin_layout Standard
23467 \change_deleted 564990737 1669742044
23468 There is no need to issue the
23474 command, this is done automatically by \SpecialChar LyX
23475 when the header is finished.
23476 Although the order of the single header entries doesn't matter it is advised
23477 to keep the above sequence, just to get the best optics and meets the layout
23478 of the real document.
23481 \begin_layout Standard
23483 \change_deleted 564990737 1669742044
23484 If you want to place footnotes in the header block, e.
23485 \begin_inset space \thinspace{}
23489 \begin_inset space \space{}
23492 to state your present address, just use the standard footnote via the menu
23495 Insert\SpecialChar menuseparator
23500 will automagically use the term
23509 \begin_layout Standard
23511 \change_deleted 564990737 1669742044
23514 Edit\SpecialChar menuseparator
23517 , you'll find two insets which are relevant for the titling:
23520 \begin_layout Itemize
23522 \change_deleted 564990737 1669742044
23529 to mark corresponding author\SpecialChar breakableslash
23531 The institutes are numbered sequentially as they appear in the
23535 field, so you have to put a marker to each author.
23538 \begin_layout Itemize
23540 \change_deleted 564990737 1669742044
23545 to supply an email address for fast contact.
23548 \begin_layout Standard
23550 \change_deleted 564990737 1669742044
23551 In addition to these topics, the macros use one additional \SpecialChar LaTeX
23553 has no counterpart in \SpecialChar LyX
23557 \begin_layout Itemize
23559 \change_deleted 564990737 1669742044
23566 to separate different names for more than one author and institute, respectivel
23570 \begin_layout Standard
23572 \change_deleted 564990737 1669742044
23573 The appropriate command has to be entered in \SpecialChar LyX
23574 and marked as \SpecialChar LaTeX
23580 \begin_layout Subsection
23582 \change_deleted 564990737 1669742044
23586 \begin_layout Standard
23588 \change_deleted 564990737 1669742044
23589 The abstract should immediately follow the header block.
23590 With version 5 the abstract environment was changed to a command, and there
23591 is now a restriction to only one paragraph.
23592 In addition, it should contain an entry with the keywords.
23593 This is done via the paragraph style
23598 Refer to the example paper.
23601 \begin_layout Subsection
23603 \change_deleted 564990737 1669742044
23604 Supported environments
23607 \begin_layout Standard
23609 \change_deleted 564990737 1669742044
23610 The A&A paper layout supports the following environments for structuring
23614 \begin_layout Itemize
23616 \change_deleted 564990737 1669742044
23622 \begin_layout Itemize
23624 \change_deleted 564990737 1669742044
23630 \begin_layout Itemize
23632 \change_deleted 564990737 1669742044
23638 \begin_layout Itemize
23640 \change_deleted 564990737 1669742044
23646 \begin_layout Itemize
23648 \change_deleted 564990737 1669742044
23654 \begin_layout Itemize
23656 \change_deleted 564990737 1669742044
23662 \begin_layout Itemize
23664 \change_deleted 564990737 1669742044
23670 \begin_layout Itemize
23672 \change_deleted 564990737 1669742044
23678 \begin_layout Itemize
23680 \change_deleted 564990737 1669742044
23686 \begin_layout Itemize
23688 \change_deleted 564990737 1669742044
23694 \begin_layout Itemize
23696 \change_deleted 564990737 1669742044
23702 \begin_layout Itemize
23704 \change_deleted 564990737 1669742044
23711 \begin_layout Subsection
23713 \change_deleted 564990737 1669742044
23714 Commands not supported by \SpecialChar LyX
23718 \begin_layout Standard
23720 \change_deleted 564990737 1669742044
23721 Some commands are not yet supported by the
23725 layout for \SpecialChar LyX
23727 Some have already been mentioned.
23728 For the sake of completeness, they are listed all together here:
23731 \begin_layout Itemize
23733 \change_deleted 564990737 1669742044
23741 \begin_layout Itemize
23743 \change_deleted 564990737 1669742044
23751 \begin_layout Itemize
23753 \change_deleted 564990737 1669742044
23761 \begin_layout Itemize
23763 \change_deleted 564990737 1669742044
23771 \begin_layout Standard
23773 \change_deleted 564990737 1669742044
23774 If you want to use any of these commands, you have to enter them yourself.
23777 Do not forget to mark them as \SpecialChar LaTeX
23781 \begin_layout Subsection
23783 \change_deleted 564990737 1669742044
23784 Figure and Table Floats
23787 \begin_layout Standard
23789 \change_deleted 564990737 1669742044
23791 provides support for the necessary float environments
23793 figure, figure*, table
23799 , therefore we won't tell much about it here.
23803 \begin_inset space ~
23809 Just remember that tables should be left-aligned.
23810 For that, select the table and change the alignment in
23812 Edit\SpecialChar menuseparator
23814 \begin_inset space ~
23820 \begin_layout Standard
23822 \change_deleted 564990737 1669742044
23823 There is only one special thing: the figures with caption besides the figure.
23824 To create such a figure, you have to do the following:
23827 \begin_layout Enumerate
23829 \change_deleted 564990737 1669742044
23830 Create a wide figure float:
23832 Insert\SpecialChar menuseparator
23833 Float\SpecialChar menuseparator
23836 , then right click in the figure and select
23839 \begin_inset space ~
23847 \begin_layout Enumerate
23849 \change_deleted 564990737 1669742044
23850 Enter your caption text.
23853 \begin_layout Enumerate
23855 \change_deleted 564990737 1669742044
23860 to move the cursor above the caption.
23863 \begin_layout Enumerate
23865 \change_deleted 564990737 1669742044
23869 \begin_layout Enumerate
23871 \change_deleted 564990737 1669742044
23872 Position the cursor behind the figure and insert a horizontal fill:
23874 Insert\SpecialChar menuseparator
23876 \begin_inset space ~
23879 Character\SpecialChar menuseparator
23881 \begin_inset space ~
23889 \begin_layout Enumerate
23891 \change_deleted 564990737 1669742044
23892 Switch to \SpecialChar LaTeX
23896 \begin_inset space ~
23904 \begin_layout Enumerate
23906 \change_deleted 564990737 1669742044
23916 Do not close the brace!
23919 \begin_layout Enumerate
23921 \change_deleted 564990737 1669742044
23922 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
23927 \begin_inset space ~
23939 \begin_layout Standard
23941 \change_deleted 564990737 1669742044
23942 Also, refer to the figures in the example paper.
23945 \begin_layout Subsection
23947 \change_deleted 564990737 1669742044
23951 \begin_layout Standard
23953 \change_deleted 564990737 1669742044
23954 For submission, the paper has to be formated in a special double-spacing
23956 For this purpose, you have to give the option
23960 to the document class.
23961 This must be done using the custom class options field in the
23963 Document\SpecialChar menuseparator
23967 Just enter the string
23974 \begin_layout Subsection
23976 \change_deleted 564990737 1669742044
23980 \begin_layout Standard
23982 \change_deleted 564990737 1669742044
23987 directory contains an example paper written with \SpecialChar LyX
23989 It is the example paper from the original macro package, translated to
23992 Use it for inspiration, and compare the original \SpecialChar LaTeX
23993 code with \SpecialChar LyX
23997 \begin_layout Section
23999 \change_deleted 564990737 1671097429
24003 \begin_layout Standard
24005 \change_deleted 564990737 1671097429
24010 can be used to type letters according to German conventions.
24011 A template file is included in
24013 .../lyx/share/templates
24015 for you to use as a starting point.
24018 \begin_layout Section
24020 \change_deleted 564990737 1671097429
24024 \begin_layout Standard
24026 \change_deleted 564990737 1671097429
24027 See the \SpecialChar LyX
24033 It contains all infos you need.
24036 \begin_layout Section
24038 \change_deleted 564990737 1669755802
24042 \begin_layout Standard
24044 \change_deleted 564990737 1669755802
24047 Panayotis Papasotiriou
24050 \begin_layout Subsection
24052 \change_deleted 564990737 1669755802
24056 \begin_layout Standard
24058 \change_deleted 564990737 1669755802
24059 The ijmpc package is a set of macros that facilitates electronic manuscript
24062 International Journal of Modern Physics C
24065 Similarly, the ijmpd package is for creating manuscripts to be submitted
24068 International Journal of Modern Physics D
24071 Both journals are published by World Scientific.
24072 The corresponding document classes are named
24081 These files, together with instructions for the authors, can be downloaded
24083 \begin_inset Flex URL
24086 \begin_layout Plain Layout
24088 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
24094 \begin_inset Flex URL
24097 \begin_layout Plain Layout
24099 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
24105 Both packages are modified versions of the standard
24106 \begin_inset Quotes eld
24110 \begin_inset Quotes erd
24113 package, and they are almost (but not exactly) identical.
24114 Most of their features are supported by \SpecialChar LyX
24116 I have used \SpecialChar LyX
24117 successfully to write articles submitted to both journals
24118 without any problem.
24121 \begin_layout Subsection
24123 \change_deleted 564990737 1669755802
24127 \begin_layout Standard
24129 \change_deleted 564990737 1669755802
24130 As usual, the easiest way to write a paper is to start with a template.
24133 File\SpecialChar menuseparator
24149 This will give an (almost) empty document that includes the most common
24150 fields found in a manuscript.
24151 Simply overwrite the existing text (including the brackets,
24156 You should keep in mind the following remarks.
24159 \begin_layout Enumerate
24161 \change_deleted 564990737 1669755802
24163 won't let you change the font size and the page style of the document,
24164 because such modifications are not allowed by both packages.
24167 \begin_layout Enumerate
24169 \change_deleted 564990737 1669755802
24170 The language of the document should not be changed.
24171 Before previewing your paper, be sure that the babel package is not used.
24172 To do this, click on
24175 arg "dialog-show document"
24180 \SpecialChar menuseparator
24184 \begin_inset Quotes eld
24188 \begin_inset Quotes erd
24198 \begin_layout Enumerate
24200 \change_deleted 564990737 1669755802
24202 \begin_inset Quotes eld
24206 \begin_inset Quotes erd
24209 style must be used to define keywords.
24212 \begin_layout Enumerate
24214 \change_deleted 564990737 1669755802
24215 The ijmpc package provides a style named
24216 \begin_inset Quotes eld
24219 Classification Codes
24220 \begin_inset Quotes erd
24223 , which can be used to define classification codes, such as PACS numbers.
24224 Note that this facility is not supported by the ijmpd package.
24227 \begin_layout Enumerate
24229 \change_deleted 564990737 1669755802
24230 Several new environments are available:
24231 \begin_inset Quotes eld
24235 \begin_inset Quotes erd
24239 \begin_inset Quotes eld
24243 \begin_inset Quotes erd
24247 \begin_inset Quotes eld
24251 \begin_inset Quotes erd
24255 \begin_inset Quotes eld
24259 \begin_inset Quotes erd
24263 \begin_inset Quotes eld
24267 \begin_inset Quotes erd
24271 \begin_inset Quotes eld
24275 \begin_inset Quotes erd
24279 \begin_inset Quotes eld
24283 \begin_inset Quotes erd
24287 \begin_inset Quotes eld
24291 \begin_inset Quotes erd
24295 \begin_inset Quotes eld
24299 \begin_inset Quotes erd
24303 \begin_inset Quotes eld
24307 \begin_inset Quotes erd
24311 \begin_inset Quotes eld
24315 \begin_inset Quotes erd
24319 \begin_inset Quotes eld
24323 \begin_inset Quotes erd
24327 \begin_inset Quotes eld
24331 \begin_inset Quotes erd
24335 \begin_inset Quotes eld
24339 \begin_inset Quotes erd
24343 Their use is more or less obvious.
24345 supports all these environments; it will use the proper label, text style,
24346 and numbering scheme for each of them.
24349 \begin_layout Enumerate
24351 \change_deleted 564990737 1669755802
24352 Both packages use basic citations; the natbib package should not be used.
24353 In \SpecialChar LyX
24354 , citation references are shown as usual; in the output, citations are
24355 shown as superscripts.
24356 If you want to use a citation as normal text, you should use the
24361 \begin_inset space \thinspace{}
24365 \begin_inset space \space{}
24369 \begin_inset Quotes eld
24373 \begin_inset space \space{}
24383 \begin_inset Quotes erd
24389 \begin_layout Enumerate
24391 \change_deleted 564990737 1669755802
24393 \begin_inset Quotes eld
24397 \begin_inset Quotes erd
24400 section in both packages.
24401 To put acknowledgments, just use the
24402 \begin_inset Quotes eld
24406 \begin_inset Quotes erd
24412 \begin_layout Enumerate
24414 \change_deleted 564990737 1669755802
24415 Appendices may be added to the paper,
24419 the Acknowledgments and
24425 provides a special environment, called
24426 \begin_inset Quotes eld
24430 \begin_inset Quotes erd
24433 which marks the beginning of the appendices.
24434 This environment should be left blank; it just sends a \SpecialChar LaTeX
24435 command, but nothing
24437 In \SpecialChar LyX
24439 \begin_inset Quotes eld
24443 \begin_inset Quotes erd
24446 is printed with blue letters, as a signal that all sections after that
24447 point are appendices.
24448 To write an appendix, use the
24449 \begin_inset Quotes eld
24453 \begin_inset Quotes erd
24458 will number each appendix with capital letters, as required by both journals.
24460 \begin_inset Quotes eld
24464 \begin_inset Quotes erd
24471 be present before the first appendix; if not, all appendices will be numbered
24472 as normal sections in the output.
24475 \begin_layout Enumerate
24477 \change_deleted 564990737 1669755802
24478 The ijmpc and the ijmpd packages use the
24482 command to implement table captions.
24483 As a result, a table created by \SpecialChar LyX
24484 is printed correctly, but its caption
24486 However, you can use some \SpecialChar TeX
24487 code to overcome this problem, so that captions
24488 are printed as expected.
24489 To do so, create a float table as usual, remove the caption, and replace
24490 it with the \SpecialChar TeX
24501 (sic); you must also the \SpecialChar TeX
24506 immediately after the tabular material.
24507 Study the example table included in the template files to see how this
24508 trick is implemented.
24509 Alternatively, If you need table captions, you should implement the whole
24514 file, then include this file to the \SpecialChar LyX
24517 Insert\SpecialChar menuseparator
24518 File\SpecialChar menuseparator
24520 \begin_inset space ~
24526 Details on how to create a table float can be found in the files
24534 , included in the corresponding packages.
24537 \begin_layout Subsection
24539 \change_deleted 564990737 1669755802
24540 Preparing a paper for submission
24543 \begin_layout Standard
24545 \change_deleted 564990737 1669755802
24546 Before you submit your paper you must export the \SpecialChar LyX
24547 document as a \SpecialChar LaTeX
24550 File\SpecialChar menuseparator
24551 Export\SpecialChar menuseparator
24559 \begin_layout Plain Layout
24560 Actually you have the choice between \SpecialChar LaTeX
24561 (plain) and pdflatex.
24562 If you intend to use pdflatex to prepare the paper, you should use the
24563 pdflatex option so that included graphics are converted to PDF format,
24564 ready for use by pdflatex.
24569 , then make the following changes to the resulting
24576 \begin_layout Enumerate
24578 \change_deleted 564990737 1669755802
24579 Remove the comment lines before the
24588 \begin_layout Enumerate
24590 \change_deleted 564990737 1669755802
24591 Remove everything between (and including) the
24603 commands, except for any commands you specifically put into the \SpecialChar LaTeX
24607 \begin_layout Standard
24609 \change_deleted 564990737 1669755802
24614 file should be saved and processed through \SpecialChar LaTeX
24615 as many times as necessary.
24616 You may also want to check the resulting
24625 \begin_layout Section
24627 \change_deleted 564990737 1669801478
24631 \begin_layout Standard
24633 \change_deleted 564990737 1669801478
24639 \begin_layout Subsection
24641 \change_deleted 564990737 1669801478
24645 \begin_layout Standard
24647 \change_deleted 564990737 1669801478
24648 The iopart package provides a document class to create electronic manuscript
24649 submission to the journals published by the Institute of Physics.
24650 Instructions for the authors how to create a paper using the iopart class
24651 can be downloaded together with the iopart package from the site
24652 \begin_inset Flex URL
24655 \begin_layout Plain Layout
24657 ftp://ftp.iop.org/pub/journals/latex2e
24665 \begin_layout Subsection
24667 \change_deleted 564990737 1669801478
24671 \begin_layout Standard
24673 \change_deleted 564990737 1669801478
24674 The easiest way to write a paper is to start with the template
24678 that is available via
24680 File\SpecialChar menuseparator
24683 The template explains how to use the special text environments.
24684 Here are the most important advices:
24687 \begin_layout Itemize
24689 \change_deleted 564990737 1669801478
24690 To be able to compile your document to a PDF, PS, or DVI, ensure that the
24691 no AMS packages are loaded in
24693 Document\SpecialChar menuseparator
24694 Settings\SpecialChar menuseparator
24700 \begin_layout Itemize
24702 \change_deleted 564990737 1669801478
24705 The title environment defines the kind of your paper.
24706 So use one of the following environments for the title:
24710 \begin_layout Itemize
24712 \change_deleted 564990737 1669801478
24721 \begin_layout Itemize
24723 \change_deleted 564990737 1669801478
24732 \begin_layout Itemize
24734 \change_deleted 564990737 1669801478
24740 for a Topical review
24743 \begin_layout Itemize
24745 \change_deleted 564990737 1669801478
24754 \begin_layout Itemize
24756 \change_deleted 564990737 1669801478
24765 \begin_layout Itemize
24767 \change_deleted 564990737 1669801478
24773 for a Paper (same as Title)
24776 \begin_layout Itemize
24778 \change_deleted 564990737 1669801478
24784 for a Preliminary communication
24787 \begin_layout Itemize
24789 \change_deleted 564990737 1669801478
24795 for a Rapid communication
24798 \begin_layout Itemize
24800 \change_deleted 564990737 1669801478
24806 for a Letter to the editor
24810 \begin_layout Itemize
24812 \change_deleted 564990737 1669801478
24815 All title environments except of
24819 can have an optional short title.
24822 \begin_layout Itemize
24824 \change_deleted 564990737 1669801478
24825 There is a general title environment
24829 which is not directly supported by \SpecialChar LyX
24831 This can be used as \SpecialChar TeX
24832 code when your document doesn't fit into one of the
24836 \begin_layout Standard
24838 \change_deleted 564990737 1669801478
24839 For more informations like hints for special table and formula formatting,
24840 look at the IOP author guidelines.
24845 \begin_layout Section
24847 \change_deleted 564990737 1670317155
24851 \begin_layout Standard
24853 \change_deleted 564990737 1670317155
24856 Panayotis Papasotiriou
24859 \begin_layout Subsection
24861 \change_deleted 564990737 1670317155
24865 \begin_layout Standard
24867 \change_deleted 564990737 1670317155
24868 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
24869 that facilitates electronic manuscript submission to the journals they
24871 Most known of them (at least in my domain of interest) are
24873 Astrophysics and Space Science
24879 , but there are many others (see a complete list at
24880 \begin_inset Flex URL
24883 \begin_layout Plain Layout
24885 http://www.wkap.nl/jrnllist.htm/JRNLHOME
24891 The Kluwer package may be downloaded from the site
24892 \begin_inset Flex URL
24895 \begin_layout Plain Layout
24897 http://www.wkap.nl/kaphtml.htm/STYLEFILES
24903 A complete user guide is contained in that package (but it can also be
24904 downloaded separately).
24907 \begin_layout Standard
24909 \change_deleted 564990737 1670317155
24911 supports many features of the package but not everything.
24912 However, the \SpecialChar TeX
24913 code needed is reduced to some
24914 \begin_inset Quotes eld
24918 \begin_inset Quotes erd
24921 commands of the package (see
24922 \begin_inset space ~
24926 \begin_inset CommandInset ref
24929 reference "subsec:kluwer_peculiarities"
24934 I have recently used \SpecialChar LyX
24935 to write an article submitted to the
24937 Astrophysics and Space Science
24939 without any problem.
24942 \begin_layout Subsection
24944 \change_deleted 564990737 1670317155
24948 \begin_layout Standard
24950 \change_deleted 564990737 1670317155
24951 The easiest way to write a paper is to start with the Kluwer template file.
24954 File\SpecialChar menuseparator
24966 This will give an (almost) empty document that includes the most common
24967 fields found in a manuscript and a short description of their use.
24968 As in most templates, simply overwrite the existing text (including the
24973 ) with the correct information.
24976 \begin_layout Subsection
24978 \change_deleted 564990737 1670317155
24979 Preparing a paper for submission
24982 \begin_layout Standard
24984 \change_deleted 564990737 1670317155
24985 As in the AAS\SpecialChar TeX
24986 package, before you submit your paper to a journal you must
24988 \begin_inset Quotes eld
24992 \begin_inset Quotes erd
24998 \begin_layout Enumerate
25000 \change_deleted 564990737 1670317155
25001 Export your paper as a \SpecialChar LaTeX
25003 To do this, click on
25005 File\SpecialChar menuseparator
25006 Export\SpecialChar menuseparator
25014 \begin_layout Enumerate
25016 \change_deleted 564990737 1670317155
25021 file with a text editor and make the following changes
25025 \begin_layout Enumerate
25027 \change_deleted 564990737 1670317155
25028 remove the comment lines before the
25037 \begin_layout Enumerate
25039 \change_deleted 564990737 1670317155
25040 remove everything between (and including) the
25052 commands, except for any commands you specifically put into the \SpecialChar LaTeX
25056 \begin_layout Standard
25058 \change_deleted 564990737 1670317155
25067 \begin_layout Enumerate
25069 \change_deleted 564990737 1670317155
25074 file through \SpecialChar LaTeX
25075 as many times as necessary (usually up to three).
25078 \begin_layout Enumerate
25080 \change_deleted 564990737 1670317155
25086 \begin_inset space \thinspace{}
25090 \begin_inset space \space{}
25097 , and check if everything is OK (it should, if you didn't make any mistake).
25100 \begin_layout Subsection
25102 \change_deleted 564990737 1670317155
25103 \begin_inset Quotes eld
25107 \begin_inset Quotes erd
25110 of the Kluwer package
25111 \begin_inset CommandInset label
25113 name "subsec:kluwer_peculiarities"
25120 \begin_layout Standard
25122 \change_deleted 564990737 1670317155
25123 The Kluwer package has the following
25124 \begin_inset Quotes eld
25128 \begin_inset Quotes erd
25134 \begin_layout Enumerate
25136 \change_deleted 564990737 1670317155
25137 It is possible to write multiple articles in the same \SpecialChar LaTeX
25142 \begin_layout Plain Layout
25143 I can't imagine any good reason to do this.
25149 Each article must be included in the environment
25150 \begin_inset Quotes eld
25154 \begin_inset Quotes erd
25158 Unfortunately, this environment cannot be omitted, even if you write just
25160 Therefore, each article starts with the command
25166 and, obviously, ends with the command
25173 Although this can be implemented in \SpecialChar LyX
25174 , I didn't included it, since it looks
25175 ugly and can confuse the novice user.
25176 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
25179 \begin_inset Quotes eld
25184 \begin_inset Quotes erd
25190 \begin_layout Enumerate
25192 \change_deleted 564990737 1670317155
25193 Information given at the beginning of the article (i.
25194 \begin_inset space \thinspace{}
25198 \begin_inset space \space{}
25201 title, subtitle, author, institution, running title, running author, abstract
25202 and keywords) must be included in an environment called
25203 \begin_inset Quotes eld
25207 \begin_inset Quotes erd
25211 This is not implemented in \SpecialChar LyX
25212 , so you must enter title, subtitle etc.
25213 \begin_inset space ~
25216 between two \SpecialChar TeX
25232 \begin_layout Enumerate
25234 \change_deleted 564990737 1670317155
25235 According to the user manual, the label of each bibliography item must be
25259 \begin_layout Standard
25261 \change_deleted 564990737 1670317155
25266 template takes care of all these
25267 \begin_inset Quotes eld
25271 \begin_inset Quotes erd
25275 If you start a new paper using this template you don't need to do anything
25280 \begin_layout Enumerate
25282 \change_deleted 564990737 1670317155
25283 don't delete the \SpecialChar TeX
25284 code included in the template, and
25287 \begin_layout Enumerate
25289 \change_deleted 564990737 1670317155
25290 copy the example bibliography item included in the template and modify it
25291 as necessary to enter new bibliography items.
25294 \begin_layout Section
25296 \change_deleted 564990737 1671097446
25300 \begin_layout Standard
25302 \change_deleted 564990737 1671097446
25307 provides an alternative to the standard
25312 It provides similar functionality, but you might prefer this layout with
25313 sans serif sections, headings, and more.
25316 \begin_layout Section
25318 \change_deleted 564990737 1671097446
25319 Springer Journals (
25326 \begin_layout Standard
25328 \change_deleted 564990737 1671097446
25334 \begin_layout Subsection
25336 \change_deleted 564990737 1671097446
25340 \begin_layout Standard
25342 \change_deleted 564990737 1671097446
25343 These are the layout files for some of the journal formats used by Springer
25344 Verlag and listed on
25345 \begin_inset Flex URL
25348 \begin_layout Plain Layout
25350 http://www.springer.de/author/tex/help-journals.html
25355 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
25357 It is a modular system: the things common to all journals are implemented
25362 , which journal-specific layout files (such as, e.
25363 \begin_inset space \thinspace{}
25367 \begin_inset space \space{}
25374 for Journal of Geodesy) can include.
25377 \begin_layout Standard
25379 \change_deleted 564990737 1671097446
25380 This means that implementing support for any other Springer journal on this
25381 list is as simple as writing your own
25389 file following the outline given in
25397 \begin_layout Standard
25399 \change_deleted 564990737 1671097446
25400 It is reasonably well tested only for the Journal of Geodesy.
25409 come with the standard \SpecialChar LyX
25411 Install the relevant class file (downloaded from Springer) in a proper
25412 directory, reconfigure \SpecialChar LaTeX
25413 (in the te\SpecialChar TeX
25418 , as root if necessary — doesn't \SpecialChar LyX
25419 take care of this?), reconfigure \SpecialChar LyX
25424 \begin_layout Subsection
25426 \change_deleted 564990737 1671097446
25430 \begin_layout Standard
25432 \change_deleted 564990737 1671097446
25433 A large number of theorem-like styles —
25445 \begin_layout Standard
25447 \change_deleted 564990737 1671097446
25450 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
25451 _Title, Author_Running, Institute,
25452 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
25455 See the Springer class file documentation for details.
25458 \begin_layout Subsection
25460 \change_deleted 564990737 1671097446
25464 \begin_layout Itemize
25466 \change_deleted 564990737 1671097446
25478 \begin_layout Itemize
25480 \change_deleted 564990737 1671097446
25483 Probability Theory and Related Fields
25489 — Jean-Marc Lasgouttes
25492 \begin_layout Standard
25494 \change_deleted 564990737 1671097446
25495 Add your own, it isn't so hard!
25498 \begin_layout Subsection
25500 \change_deleted 564990737 1671097446
25504 \begin_layout Standard
25506 \change_deleted 564990737 1671097446
25507 These files are partly based on the older
25511 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
25513 file from Springer.
25518 layout, are now defunct.
25519 Jean-Marc Lasgouttes helped out big in making me find my way around the
25521 layout file mechanism.
25524 \begin_layout Subsection
25526 \change_deleted 564990737 1671097446
25530 \begin_layout Standard
25532 \change_deleted 564990737 1671097446
25534 But probably less than in the old hacked-\SpecialChar LaTeX
25542 \begin_layout Chapter
25544 Features needing Extra Software
25547 \begin_layout Section
25548 Checking \SpecialChar TeX
25552 \begin_layout Standard
25558 \begin_layout Subsection
25562 \begin_layout Standard
25571 \begin_layout Plain Layout
25576 is not yet available when you are using the \SpecialChar LaTeX
25577 distribution MiK\SpecialChar TeX
25583 , you'll find in the
25590 \begin_inset space ~
25601 \begin_inset Newline newline
25605 \begin_inset CommandInset href
25607 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
25615 \begin_layout Standard
25618 Chk\SpecialChar TeX
25621 package is a program that was written by
25622 \begin_inset Flex Noun
25625 \begin_layout Plain Layout
25627 \begin_inset space ~
25635 in frustration because some constructs in \SpecialChar LaTeX
25636 are sometimes non-intuitive,
25637 and easy to forget.
25638 The program runs over your \SpecialChar LaTeX
25639 file, checks the integrity of the file, and
25640 flags some common errors.
25641 In other technical words, it is
25645 for \SpecialChar LaTeX
25649 \begin_layout Standard
25650 Well, what is a syntax checker doing in \SpecialChar LyX
25651 which is supposed to produce correct
25653 anyways? The answer is simple: Just as
25657 not only checks the
25661 of C programs, but also does
25665 checks for type-errors,
25667 Chk\SpecialChar TeX
25670 catches some common
25674 errors, in addition to the syntactical ones.
25677 Chk\SpecialChar TeX
25680 is capable of detecting several common errors, such as
25683 \begin_layout Itemize
25684 Ellipsis detection:
25685 \begin_inset Newline newline
25688 Use \SpecialChar ldots
25692 \begin_layout Itemize
25693 No space in front of/after parenthesis:
25694 \begin_inset Newline newline
25700 \begin_layout Itemize
25701 Enforcement of normal space after common abbreviations:
25702 \begin_inset Newline newline
25706 \begin_inset space \thinspace{}
25710 \begin_inset space \space{}
25713 is too wide spacing.
25716 \begin_layout Itemize
25717 Enforcement of end-of-sentence space when the last sentence ends with a
25719 \begin_inset Newline newline
25723 And this is wrong spacing.
25726 \begin_layout Itemize
25727 Space in front of labels and similar commands:
25728 \begin_inset Newline newline
25731 The label should stick right up to the text to avoid falling to a wrong
25734 \begin_inset CommandInset label
25744 \begin_layout Plain Layout
25745 This footnote is in danger of falling off to a wrong page
25750 The label is separated too much.
25753 \begin_layout Itemize
25754 Space in front of references, instead of hard spaces:
25755 \begin_inset Newline newline
25758 If you have bad luck, the text will break right between the referenced text
25759 and reference number, and that's a pity.
25761 \begin_inset CommandInset ref
25764 reference "sec:chktex"
25771 \begin_layout Itemize
25773 \begin_inset Quotes eld
25777 \begin_inset Quotes erd
25781 \begin_inset Formula $\times$
25785 \begin_inset Newline newline
25788 2x2 looks cheap compared to
25789 \begin_inset Formula $2\times2$
25795 \begin_layout Standard
25796 and more \SpecialChar ldots
25797 It is an invaluable tool when you are
25798 \begin_inset Quotes eld
25802 \begin_inset Quotes erd
25805 your document before printing, and you should run it right after the obligatory
25806 spelling check, and before you go fine tuning the typesetting.
25809 \begin_layout Subsection
25813 \begin_layout Standard
25814 If you have the program installed, usage is as simple as choosing
25816 Tools\SpecialChar menuseparator
25818 \begin_inset space ~
25824 This will make \SpecialChar LyX
25825 generate a \SpecialChar LaTeX
25826 file of your document, start
25828 Chk\SpecialChar TeX
25831 to check it, and then make \SpecialChar LyX
25833 \begin_inset Quotes eld
25837 \begin_inset Quotes erd
25840 with the warnings from
25842 Chk\SpecialChar TeX
25845 , if there were any.
25846 The warnings will be placed close to the point of the mistake, and you
25847 can quickly find them by using the
25849 Navigate\SpecialChar menuseparator
25852 menu item, or the shortcut key
25861 Open the error boxes by clicking on them with the mouse, or use the shortcut
25870 bindings, or the corresponding
25879 Read the warning and correct the mistake, if it is a mistake.
25880 If you have trouble understanding what the warning is about, you can safely
25882 Remember that there is a hidden layer between the document on screen and
25883 the technical details in invoking
25885 Chk\SpecialChar TeX
25888 , and this gap can make some warnings seem arcane or just plain silly.
25891 \begin_layout Standard
25892 This document is an excellent testing bed for the feature, and it should
25893 provide quite a few warnings for you to fiddle with.
25894 Since computers are only so smart, expect most of the warnings to be false
25898 \begin_layout Subsection
25899 How to fine tune it
25902 \begin_layout Standard
25903 Sometimes, you'll find that
25905 Chk\SpecialChar TeX
25908 makes more noise than suits your mood.
25909 Then you can choose not to use it, wait until your mood changes, or try
25912 Chk\SpecialChar TeX
25915 to get better along with you.
25918 \begin_layout Standard
25921 Chk\SpecialChar TeX
25928 very configurable and extensible, you should not expect to solve all problems
25931 Chk\SpecialChar TeX
25934 in \SpecialChar LyX
25936 Since \SpecialChar LyX
25937 has to generate a somewhat special \SpecialChar LaTeX
25938 file to be able to match the
25939 line numbers from the
25941 Chk\SpecialChar TeX
25948 \begin_layout Plain Layout
25949 You can inspect the specific output from
25955 Document\SpecialChar menuseparator
25958 \begin_inset space ~
25972 to the internal document structure, some of the warnings will not appear
25974 There are two things you can do about this:
25977 \begin_layout Itemize
25980 Chk\SpecialChar TeX
25983 invocation command line in
25984 \begin_inset Flex Noun
25987 \begin_layout Plain Layout
25988 Tools\SpecialChar menuseparator
25989 Preferences\SpecialChar menuseparator
25990 Output\SpecialChar menuseparator
25991 LaTeX\SpecialChar menuseparator
25999 Chk\SpecialChar TeX
26002 installation configuration file (usually with the file
26007 See below to learn what warnings can be enabled and disabled on the command
26011 \begin_layout Itemize
26012 Export your document as a raw \SpecialChar LaTeX
26015 File\SpecialChar menuseparator
26016 Export\SpecialChar menuseparator
26025 Invoked in this way, it can be a hassle to find the corresponding place
26026 in the document inside \SpecialChar LyX
26027 , but with a little patience, you should be able
26031 \begin_layout Standard
26032 Here follows the warning messages that can be enabled and disabled in
26041 to disable a warning, and
26045 to enable a warning.
26046 The emphasized entries are disabled by default, because the default is
26049 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
26054 \begin_layout Standard
26055 Notice that you should only use the options that enable and disable warnings,
26056 because \SpecialChar LyX
26057 relies on some of the other command line parameters to be set
26058 in a specific way to have a chance to communicate with
26065 \begin_layout Enumerate
26069 Command terminated with space.
26072 \begin_layout Enumerate
26075 Non-breaking space (
26076 \begin_inset Quotes eld
26084 \begin_inset Quotes erd
26087 ) should have been used.
26090 \begin_layout Enumerate
26094 You should enclose the previous parenthesis with
26095 \begin_inset Quotes eld
26103 \begin_inset Quotes erd
26109 \begin_layout Enumerate
26112 Italic correction (
26113 \begin_inset Quotes eld
26123 \begin_inset Quotes erd
26126 ) found in non-italic buffer.
26129 \begin_layout Enumerate
26132 Italic correction (
26133 \begin_inset Quotes eld
26143 \begin_inset Quotes erd
26146 ) found more than once.
26149 \begin_layout Enumerate
26153 No italic correction (
26154 \begin_inset Quotes eld
26164 \begin_inset Quotes erd
26170 \begin_layout Enumerate
26174 \begin_inset Quotes eld
26182 \begin_inset Quotes erd
26186 \begin_inset Quotes eld
26194 \begin_inset Quotes erd
26200 \begin_layout Enumerate
26203 Wrong length of dash may have been used.
26206 \begin_layout Enumerate
26210 \begin_inset Quotes eld
26218 \begin_inset Quotes erd
26222 \begin_inset Quotes eld
26230 \begin_inset Quotes erd
26236 \begin_layout Enumerate
26240 \begin_inset Quotes eld
26248 \begin_inset Quotes erd
26254 \begin_layout Enumerate
26258 \begin_inset Quotes eld
26266 \begin_inset Quotes erd
26269 to achieve an ellipsis.
26272 \begin_layout Enumerate
26275 Inter-word spacing (
26276 \begin_inset Quotes eld
26286 \begin_inset Quotes eld
26289 ) should perhaps be used.
26292 \begin_layout Enumerate
26295 Inter-sentence spacing (
26296 \begin_inset Quotes eld
26306 \begin_inset Quotes erd
26309 ) should perhaps be used.
26312 \begin_layout Enumerate
26315 Could not find argument for command.
26318 \begin_layout Enumerate
26322 \begin_inset Quotes eld
26330 \begin_inset Quotes erd
26336 \begin_layout Enumerate
26339 Math mode still on at end of \SpecialChar LaTeX
26343 \begin_layout Enumerate
26347 \begin_inset Quotes eld
26355 \begin_inset Quotes erd
26358 doesn't match the number of
26359 \begin_inset Quotes eld
26367 \begin_inset Quotes erd
26373 \begin_layout Enumerate
26376 You should use either
26379 \begin_inset Quotes eld
26387 \begin_inset Quotes erd
26392 as an alternative to
26393 \begin_inset Quotes eld
26401 \begin_inset Quotes erd
26407 \begin_layout Enumerate
26414 " (ASCII 39) instead of "
26421 \begin_layout Enumerate
26424 User-specified pattern found.
26427 \begin_layout Enumerate
26430 This command might not be intended.
26433 \begin_layout Enumerate
26440 \begin_layout Enumerate
26458 \begin_layout Enumerate
26461 Delete this space to maintain correct page references.
26464 \begin_layout Enumerate
26468 You might wish to put this between a pair of
26469 \begin_inset Quotes eld
26477 \begin_inset Quotes erd
26483 \begin_layout Enumerate
26486 You ought to remove spaces in front of punctuation.
26489 \begin_layout Enumerate
26492 Could not execute \SpecialChar LaTeX
26496 \begin_layout Enumerate
26505 in front of small punctuation.
26508 \begin_layout Enumerate
26516 may look prettier here.
26519 \begin_layout Enumerate
26523 Multiple spaces detected in output.
26526 \begin_layout Enumerate
26529 This text may be ignored.
26532 \begin_layout Enumerate
26538 \begin_inset Quotes eld
26543 to begin quotation, not
26550 \begin_layout Enumerate
26557 to end quotation, not
26560 \begin_inset Quotes eld
26568 \begin_layout Enumerate
26574 \begin_layout Enumerate
26577 You should perhaps use
26578 \begin_inset Quotes eld
26586 \begin_inset Quotes erd
26592 \begin_layout Enumerate
26595 You should put a space in front of/after parenthesis.
26598 \begin_layout Enumerate
26601 You should avoid spaces in front of/after parenthesis.
26604 \begin_layout Enumerate
26608 You should not use punctuation in front of/after quotes.
26611 \begin_layout Enumerate
26614 Double space found.
26617 \begin_layout Enumerate
26620 You should put punctuation outside inner/inside display math mode.
26623 \begin_layout Enumerate
26626 You ought to not use primitive \SpecialChar TeX
26627 in \SpecialChar LaTeX
26631 \begin_layout Enumerate
26634 You should remove spaces in front of
26635 \begin_inset Quotes eld
26643 \begin_inset Quotes erd
26649 \begin_layout Enumerate
26652 \begin_inset Quotes eld
26660 \begin_inset Quotes erd
26663 is normally not followed by
26664 \begin_inset Quotes eld
26672 \begin_inset Quotes erd
26678 \begin_layout Standard
26679 In later versions of \SpecialChar LyX
26680 , we hope to provide a more complete interface to this
26681 tool (and it's smaller cousin
26685 ) to exploit the full power of it.
26686 But it's not exactly useless as it is now: go try it on one of your existing
26687 documents of a certain length and be surprised.
26690 \begin_layout Section
26691 Version Control in \SpecialChar LyX
26695 \begin_layout Standard
26698 Lars Gullik Bjønnes
26705 \begin_layout Subsection
26709 \begin_layout Standard
26711 supports some of the most basic RCS/CVS/SVN/GIT commands.
26712 If you need something a bit more sophisticated you will have to do that
26713 manually in a terminal.
26716 \begin_layout Standard
26717 Also note that CVS support is not as good as subversion support, so we advise
26719 A good place to start learning Subversion is the SVN Book
26723 \begin_layout Plain Layout
26724 \begin_inset CommandInset href
26726 target "http://svnbook.red-bean.com/"
26737 In the case of RCS you should read
26738 \begin_inset Quotes eld
26742 \begin_inset Quotes erd
26745 (a man file, read it with
26750 This file describes all the basic features of RCS.
26751 You should especially notice the comment about a RCS directory, and the
26752 notion of a master RCS file (the file ending in
26759 \begin_layout Standard
26760 Before you begin to use the version control features in \SpecialChar LyX
26762 familiar with RCS/CVS/SVN/GIT usage.
26763 The implementation in \SpecialChar LyX
26764 assumes a recent version of the GNU RCS or CVS/SVN
26765 package — no guarantees are made for older versions.
26766 Most of the log messages are not currently displayed after operations —
26767 you can check them in the Messages pane if you are unsure.
26768 Regular users of version control will appreciate the VC toolbar, which
26771 View\SpecialChar menuseparator
26772 Toolbars\SpecialChar menuseparator
26774 \begin_inset space ~
26782 \begin_layout Standard
26783 For introducing your own external commands consult
26784 \begin_inset Flex Code
26787 \begin_layout Plain Layout
26801 \begin_layout Standard
26802 It is strongly recommended to store documents in uncompressed format if
26803 using version control (uncheck
26805 Document\SpecialChar menuseparator
26808 if it is checked): Uncompressed LyX documents are text files and therefore
26809 for merging two different versions by version control systems.
26810 Compressed LyX documents are binary files, which cannot be merged by version
26814 \begin_layout Subsection
26815 RCS commands in \SpecialChar LyX
26819 \begin_layout Standard
26820 The following sections describe the RCS commands supported by \SpecialChar LyX
26822 You can find them in the
26824 File\SpecialChar menuseparator
26826 \begin_inset space ~
26833 was tested against RCS 5.7/5.8.
26836 \begin_layout Subsubsection
26842 \begin_layout Standard
26843 If your document is not under revision control, this is the only item shown
26845 And if it is under revision control, the
26849 item is not visible.
26853 \begin_layout Standard
26854 This command registers your document with RCS (unless you are under the
26855 directory managed by CVS)\SpecialChar endofsentence
26856 You are asked interactively to supply an initial
26857 description of the document.
26858 The document is now set in Read-Only mode and you have to
26861 \begin_inset space ~
26865 \begin_inset space ~
26869 \begin_inset space ~
26874 , before making any changes to it.
26875 A document under revision control has a
26876 \begin_inset Quotes eld
26879 [RCS:<version> <locker>]
26880 \begin_inset Quotes erd
26883 item tagged to the filename in the minibuffer.
26886 \begin_layout Standard
26887 RCS command that is run:
26890 \begin_layout LyX-Code
26893 ci -q -u -i -t-"<initial description>" <file-name>
26896 \begin_layout Standard
26901 to understand the switches.
26905 \begin_layout Subsubsection
26911 \begin_layout Standard
26912 When you are finished editing a file, you check in your changes.
26913 When you do this, you are asked for a description of the changes.
26914 This is stored in the history log.
26915 The version number is bumped, your changes are applied to the master RCS
26916 file, the document is unlocked and set to Read-Only mode.
26919 \begin_layout Itemize
26922 ci -q -u -m"<description>" <file-name>
26925 \begin_layout Subsubsection
26931 \begin_layout Standard
26932 By doing this you lock the document so that only you can edit it.
26933 This will also make the document Read-Write only for you.
26934 You will usually continue editing for a while and when you are finished
26935 you check in your changes.
26936 The status line is changed to reflect that you have locked the file.
26939 \begin_layout Itemize
26942 co -q -l <file-name>
26945 \begin_layout Subsubsection
26948 Revert To Repository Version
26951 \begin_layout Standard
26952 This will discard all changes made to the document since the last check
26954 You get a warning before changes are discarded.
26957 \begin_layout Itemize
26960 co -f -u<version> <file-name>
26963 \begin_layout Subsubsection
26969 \begin_layout Standard
26970 This will create a copy of the current document.
26971 Since RCS does not support copy operations natively, the version history
26972 is not preserved, and the copy is added as a new file.
26973 It requires a clean document without any changes since the last checkin.
26974 You are asked for a file name and a description of the copy operation.
26975 After that the copy is created, both locally and in the repository.
26976 If the parent directories of the copied and original document differ, all
26977 relative paths of included files of the copy are adjusted (like in
26979 File\SpecialChar menuseparator
26984 Finally, the copy is loaded instead of the original document.
26987 \begin_layout Labeling
26988 \labelwidthstring 00.00.0000
26990 \begin_inset space ~
26994 \begin_inset space ~
26998 \begin_inset Newline newline
27002 \begin_inset Flex Code
27005 \begin_layout Plain Layout
27008 \begin_inset Quotes qld
27012 \begin_inset Quotes qld
27021 \begin_inset Flex Code
27024 \begin_layout Plain Layout
27027 \begin_inset Quotes qld
27031 \begin_inset Quotes qld
27040 \begin_inset Newline newline
27044 \begin_inset Flex Code
27047 \begin_layout Plain Layout
27051 \begin_inset Quotes qld
27055 \begin_inset Quotes qld
27066 \begin_layout Subsubsection
27072 \begin_layout Standard
27073 This makes as if the last check in never happened.
27074 No changes are made to the document loaded into \SpecialChar LyX
27075 , but the last version
27076 is removed from the master RCS file.
27079 \begin_layout Itemize
27082 rcs -o<version> <file-name>
27085 \begin_layout Subsubsection
27091 \begin_layout Standard
27092 This shows the complete history of the RCS document.
27097 is shown in a browser.
27105 \begin_layout Subsubsection
27109 \begin_layout Standard
27111 supports RCS version number, author name, date and time of last commit.
27112 All those are extracted from
27114 rlog -r <file-name>
27118 \begin_inset CommandInset ref
27121 reference "subsec:VCS-Revision-Information"
27128 \begin_layout Subsection
27129 CVS commands in \SpecialChar LyX
27133 \begin_layout Standard
27134 A subset of CVS operations is supported by \SpecialChar LyX
27136 You can find the commands in the
27138 File\SpecialChar menuseparator
27140 \begin_inset space ~
27146 The version control system SVN is more powerful, so please use it instead
27147 of CVS if possible.
27150 \begin_layout Subsubsection
27156 \begin_layout Standard
27157 If you start from scratch with CVS you have to create your repository and
27158 checkout the working copy with external tools.
27159 If you're using a client-server setup you may need to login before doing
27160 the first repository checkout.
27163 \begin_layout Standard
27164 If your documents are under revision control and others are using the same
27165 repository problems arise when different changes to the same document at
27166 the same location happen.
27167 Standard CVS repositories don't operate with a file locking mechanism.
27168 This may be surprising, but conflicts only occur if people disagree on
27169 the proper content of the same part of a document.
27170 So, if co-workers are used to communicate regularly, these conflicts occur
27172 If they don't communicate they have a fundamental problem anyway.
27173 Nevertheless some people like to work with so called
27174 \begin_inset Quotes eld
27178 \begin_inset Quotes erd
27182 If they do so the working copy of all files is readonly when checked out
27183 first and the user starts editing after using a special command to make
27184 the working copy writable.
27185 When the changes are checked in the working copy returns to readonly state.
27186 With \SpecialChar LyX
27187 one has to edit the
27188 \begin_inset Flex Code
27191 \begin_layout Plain Layout
27197 file and add the line
27198 \begin_inset Flex Code
27201 \begin_layout Plain Layout
27207 to work with reserved checkouts.
27208 The benefit is the possibility to see who is using a writable copy of some
27210 It's not guaranteed only one user makes a copy writable.
27213 \begin_layout Standard
27215 tries to guess if you're using reserved or non-reserved checkouts.
27216 If your working copy is readonly or it is writable and an additional copy
27217 of your document exists in the CVS/Base sub-directory a reserved otherwise
27218 a non-reserved checkout is assumed.
27219 When a reserved checkout is detected you have to use
27220 \begin_inset Flex Noun
27223 \begin_layout Plain Layout
27229 to make your working copy writable if it's readonly.
27231 \begin_inset Flex Noun
27234 \begin_layout Plain Layout
27240 operation is possible and that makes your working copy readonly again after
27241 transferring your changes to the repository.
27244 \begin_layout Standard
27245 More information about CVS can be found here
27246 \begin_inset Flex URL
27249 \begin_layout Plain Layout
27251 http://www.nongnu.org/cvs
27257 \begin_inset Flex URL
27260 \begin_layout Plain Layout
27262 http://ximbiot.com/cvs
27270 \begin_layout Standard
27275 to understand the sub-commands and the switches mentioned below.
27278 \begin_layout Subsubsection
27284 \begin_layout Standard
27285 If your document is not under revision control, this is the only item shown
27287 And if it is under revision control, the
27291 item is not visible.
27295 \begin_layout Standard
27296 This command registers in CVS your document
27297 \begin_inset Flex Strong
27300 \begin_layout Plain Layout
27308 in the case you have already the documents directory under CVS control
27314 This means you have to create or checkout the archive by yourself using
27316 (In case you forget that step \SpecialChar LyX
27317 registers the document with RCS.)
27320 \begin_layout Standard
27321 Then you are asked interactively to supply an initial description of the
27323 Don't forget that registered file is not yet checked in.
27326 \begin_layout Standard
27327 CVS command that is run:
27329 cvs -q add -m"<entered message>" "<file-name>"
27332 \begin_layout Standard
27337 above and for all other CVS commands is an abbreviation for
27338 \begin_inset Quotes eld
27341 change the current working directory to file location and use the file name
27342 without path component as argument
27343 \begin_inset Quotes erd
27349 \begin_layout Subsubsection
27355 \begin_layout Standard
27356 When you are finished editing a file, you commit your changes.
27357 When you do this and you had changed the document, you are asked for a
27358 description of the changes.
27359 After that changes are written to the repository.
27360 In case you didn't change the document and a reserved checkout is detected
27361 the reservation made on
27362 \begin_inset Flex Noun
27365 \begin_layout Plain Layout
27374 \begin_layout Labeling
27375 \labelwidthstring 00.00.0000
27377 \begin_inset space ~
27381 \begin_inset space ~
27385 \begin_inset Newline newline
27389 \begin_inset Flex Code
27392 \begin_layout Plain Layout
27395 -q commit -m"<description>" "<file-name>"
27401 \begin_inset Newline newline
27405 \begin_inset Flex Code
27408 \begin_layout Plain Layout
27419 \begin_layout Subsubsection
27425 \begin_layout Standard
27426 When you are sharing a repository with others, you may have to incorporate
27427 their changes into your working copy.
27430 \begin_layout Standard
27433 cvs -q update "<file-name>"
27436 \begin_layout Standard
27437 If a readonly checkout is detected the working copy is made writable and
27441 \begin_layout Standard
27444 cvs -q edit "<file-name>"
27447 \begin_layout Subsubsection
27450 Revert To Repository Version
27453 \begin_layout Standard
27454 This will discard all changes made to the document since the last check
27456 You get a warning before changes are discarded.
27457 Firstly the file is deleted, secondly CVS update command is run.
27460 \begin_layout Standard
27463 cvs -q update "<file-name>"
27466 \begin_layout Standard
27467 If a reserved checkout is detected and the working copy has no changes only
27468 the reservation is undone.
27471 \begin_layout Standard
27474 cvs -q unedit "<file-name>"
27477 \begin_layout Subsubsection
27483 \begin_layout Standard
27484 This will create a copy of the current document.
27485 Since CVS does not support copy operations natively, the version history
27486 is not preserved, and the copy is added as a new file.
27487 It requires a clean document without any changes since the last checkin.
27488 You are asked for a file name and a description of the copy operation.
27489 After that the copy is created, both locally and in the repository.
27490 If the parent directories of the copied and original document differ, all
27491 relative paths of included files of the copy are adjusted (like in
27493 File\SpecialChar menuseparator
27498 Finally, the copy is loaded instead of the original document.
27501 \begin_layout Labeling
27502 \labelwidthstring 00.00.0000
27504 \begin_inset space ~
27508 \begin_inset space ~
27512 \begin_inset Newline newline
27516 \begin_inset Flex Code
27519 \begin_layout Plain Layout
27526 \begin_inset Flex Code
27529 \begin_layout Plain Layout
27536 \begin_inset Newline newline
27540 \begin_inset Flex Code
27543 \begin_layout Plain Layout
27544 cvs -q add "<new-file-name>"
27552 \begin_layout Subsubsection
27558 \begin_layout Standard
27559 This will rename the current document.
27560 Since CVS does not support rename operations natively, the version history
27561 is not preserved, the renamed document is added as a new file, and the
27562 original document is deleted.
27563 It requires a clean document without any changes since the last checkin.
27564 You are asked for a file name and a description of the rename operation.
27565 After that the document is renamed, both locally and in the repository.
27566 If the parent directories of the new and old file names differ, all relative
27567 paths of included files are adjusted (like in
27569 File\SpecialChar menuseparator
27574 Finally, the document is reloaded using the new name.
27577 \begin_layout Labeling
27578 \labelwidthstring 00.00.0000
27580 \begin_inset space ~
27584 \begin_inset space ~
27588 \begin_inset Newline newline
27592 \begin_inset Flex Code
27595 \begin_layout Plain Layout
27602 \begin_inset Flex Code
27605 \begin_layout Plain Layout
27612 \begin_inset Newline newline
27616 \begin_inset Flex Code
27619 \begin_layout Plain Layout
27620 cvs -q add "<new-file-name>"
27626 \begin_inset Newline newline
27630 \begin_inset Flex Code
27633 \begin_layout Plain Layout
27634 cvs -q remove "<file-name>"
27642 \begin_layout Subsubsection
27643 Update of the local directory checkout from repository
27646 \begin_layout Standard
27647 Once your documents gets more complex, containing sub-documents and pictures,
27649 \begin_inset Flex Code
27652 \begin_layout Plain Layout
27658 files and so on using version control becomes more complicated.
27660 supports updating the whole tree in which resides the document.
27661 This become especially useful once you cooperate with people which neither
27662 have detailed knowledge about CVS usage nor they have ambition to commit
27663 additional material to the repository.
27664 You have to organize the files structure so that all external files are
27665 in the same directory or subdirectories of the document.
27666 It's good practice anyway to store multipart documents in an extra directory.
27669 \begin_layout Standard
27671 \begin_inset Flex Code
27674 \begin_layout Plain Layout
27675 Update local directory from repository
27680 command updates the whole directory.
27681 If local changes are detected user is warned before update starts.
27682 In case of merge conflicts both versions of the conflicting document parts
27683 are placed in the final document.
27684 You have to review and correct the result of the merge.
27685 You'll find the conflicts enclosed in pairs of
27686 \begin_inset Flex Code
27689 \begin_layout Plain Layout
27696 \begin_inset Flex Code
27699 \begin_layout Plain Layout
27706 \begin_inset Flex Code
27709 \begin_layout Plain Layout
27716 The first part is your version as before the update operation with the
27717 document name prepended.
27718 The second one is the repository version with the version number after
27720 \begin_inset Flex Code
27723 \begin_layout Plain Layout
27732 \begin_layout Labeling
27733 \labelwidthstring 00.00.0000
27735 \begin_inset space ~
27739 \begin_inset space ~
27743 \begin_inset Newline newline
27747 \begin_inset Flex Code
27750 \begin_layout Plain Layout
27758 (Ask if changes are detected.)
27759 \begin_inset Newline newline
27763 \begin_inset Flex Code
27766 \begin_layout Plain Layout
27767 cd $path; cvs -q update
27777 \begin_layout Standard
27779 \begin_inset Flex Code
27782 \begin_layout Plain Layout
27788 stands for the path to the document.
27791 \begin_layout Subsubsection
27797 \begin_layout Standard
27798 This shows the complete history of the CVS document.
27801 cvs log "<file-name>"
27803 is shown in a browser.
27806 \begin_layout Subsubsection
27810 \begin_layout Standard
27812 supports CVS version number, author name, date and time of last commit.
27813 All those are extracted from
27815 cvs log -r <file-name>
27819 \begin_inset CommandInset ref
27822 reference "subsec:VCS-Revision-Information"
27829 \begin_layout Subsection
27830 SVN commands in \SpecialChar LyX
27834 \begin_layout Standard
27835 SVN is now partially supported by \SpecialChar LyX
27837 You can find the commands in the
27839 File\SpecialChar menuseparator
27841 \begin_inset space ~
27847 Please note that if you use password protected access to repository via
27848 ssh, you will be asked in terminal window.
27850 was tested against SVN 1.5, 1.6, 1.7 and 1.8
27854 \begin_layout Plain Layout
27855 Most of the commands will work with 1.4 too, see
27856 \begin_inset CommandInset ref
27859 reference "subsec:SVN-Repo-Update"
27864 There seems to be currently unresolved permissions problem under SVN 1.8
27865 with reverting changes when file is locked.
27873 \begin_layout Subsubsection
27879 \begin_layout Standard
27880 If your document is not under revision control, this is the only item shown
27882 And if it is under revision control, the
27886 item is not visible.
27889 \begin_layout Standard
27890 This command registers in SVN your document ONLY in case you have already
27891 the documents directory under SVN control (in particular
27896 This means you have to checkout the archive by yourself.
27899 \begin_layout Standard
27900 Then you are asked interactively to supply an initial description of the
27902 Don't forget that registered file is not yet commited.
27905 \begin_layout Standard
27906 SVN command that is run:
27909 \begin_inset Quotes qld
27913 \begin_inset Quotes qld
27919 \begin_layout Standard
27924 to understand the switches.
27927 \begin_layout Subsubsection
27933 \begin_layout Standard
27934 When you are finished editing a file, you commit your changes.
27935 When you do this, you are asked for a description of the changes.
27936 After that changes are commited.
27939 \begin_layout Standard
27944 \begin_layout Plain Layout
27945 In case locking is not enabled.
27947 \begin_inset CommandInset ref
27950 reference "subsec:SVN-File-Locking"
27961 svn commit -q -m"<description>" <file-name>
27964 \begin_layout Subsubsection
27970 \begin_layout Standard
27971 Updates the changes of this file from the repository.
27972 Be sure you understand SVN merging and conflicts resolving before using
27973 this function, because all conflicts has to be resolved manually by you!
27976 \begin_layout Standard
27981 \begin_layout Plain Layout
27989 svn update --non-interactive
27990 \begin_inset Quotes qld
27994 \begin_inset Quotes qld
28000 \begin_layout Subsubsection
28003 Revert To Repository Version
28006 \begin_layout Standard
28007 This will discard all changes made to the document since the last check
28009 You get a warning before changes are discarded.
28012 \begin_layout Standard
28016 \begin_inset Quotes qld
28020 \begin_inset Quotes qld
28026 \begin_layout Subsubsection
28032 \begin_layout Standard
28033 This will create a copy of the current document including the version history.
28034 It requires a clean document without any changes since the last checkin.
28035 You are asked for a file name and a description of the copy operation.
28036 After that the copy is created, both locally and in the repository.
28037 If the parent directories of the copied and original document differ, all
28038 relative paths of included files of the copy are adjusted (like in
28040 File\SpecialChar menuseparator
28045 Finally, the copy is loaded instead of the original document.
28048 \begin_layout Labeling
28049 \labelwidthstring 00.00.0000
28051 \begin_inset space ~
28055 \begin_inset space ~
28059 \begin_inset Newline newline
28063 \begin_inset Flex Code
28066 \begin_layout Plain Layout
28070 \begin_inset Quotes qld
28074 \begin_inset Quotes qld
28078 \begin_inset Quotes qld
28082 \begin_inset Quotes qld
28091 \begin_inset Newline newline
28095 \begin_inset Flex Code
28098 \begin_layout Plain Layout
28107 \begin_layout Subsubsection
28113 \begin_layout Standard
28114 This will rename the current document including the version history.
28115 It requires a clean document without any changes since the last checkin.
28116 You are asked for a file name and a description of the rename operation.
28117 After that the document is renamed, both locally and in the repository.
28118 If the parent directories of the new and old file names differ, all relative
28119 paths of included files are adjusted (like in
28121 File\SpecialChar menuseparator
28126 Finally, the document is reloaded using the new name.
28129 \begin_layout Labeling
28130 \labelwidthstring 00.00.0000
28132 \begin_inset space ~
28136 \begin_inset space ~
28140 \begin_inset Newline newline
28144 \begin_inset Flex Code
28147 \begin_layout Plain Layout
28151 \begin_inset Quotes qld
28155 \begin_inset Quotes qld
28159 \begin_inset Quotes qld
28163 \begin_inset Quotes qld
28172 \begin_inset Newline newline
28176 \begin_inset Flex Code
28179 \begin_layout Plain Layout
28188 \begin_layout Subsubsection
28189 \begin_inset CommandInset label
28191 name "subsec:SVN-Repo-Update"
28195 Update of the local directory checkout from repository
28199 \begin_layout Plain Layout
28200 Note that this command will work only with subversion
28201 \begin_inset Formula $\geqq1.5$
28212 \begin_layout Standard
28213 All the commands above have one shortcoming – they deal with the current
28215 Once your document contains pictures, includes external
28216 \begin_inset Flex Code
28219 \begin_layout Plain Layout
28225 files and so on administration becomes more complicated.
28227 now supports updating the whole tree in which resides the document
28231 \begin_layout Plain Layout
28232 One need to organize the files structure so that all external files are
28233 in the same directory or subdirectories of the document.
28240 This become especially useful once you cooperate with people which neither
28241 know about subversion management nor they have ambition to commit additional
28242 material to the repository.
28246 \begin_layout Standard
28247 \begin_inset Flex Code
28250 \begin_layout Plain Layout
28251 Update local directory from repository
28256 command updates the whole directory and in case of merge conflicts local
28257 version of the files are left, so no unintended data loss occurs.
28258 If local changes are detected user is warned before update starts.
28261 \begin_layout Labeling
28262 \labelwidthstring 00.00.0000
28264 \begin_inset space ~
28268 \begin_inset space ~
28272 \begin_inset Newline newline
28276 \begin_inset Flex Code
28279 \begin_layout Plain Layout
28285 (Ask if changes are detected.)
28286 \begin_inset Newline newline
28290 \begin_inset Flex Code
28293 \begin_layout Plain Layout
28294 svn update --accept mine-full $path
28302 \begin_layout Standard
28304 \begin_inset Flex Code
28307 \begin_layout Plain Layout
28313 stands for the path to the document.
28316 \begin_layout Subsubsection
28322 \begin_layout Standard
28323 This shows the complete history of the SVN document.
28327 \begin_inset Quotes qld
28331 \begin_inset Quotes qld
28336 is shown in a browser.
28339 \begin_layout Subsubsection
28341 \begin_inset CommandInset label
28343 name "subsec:SVN-File-Locking"
28350 \begin_layout Standard
28351 The file exchange through various revision control systems brings the problem
28352 of merge conflicts in case two different users try to edit the same (parts
28354 When such a conflict happens it needs manual resolving and one reasonable
28355 alternative is to provide some kind of locking mechanism, which guarantees
28356 that only one user is allowed to edit file at the given time.
28359 \begin_layout Standard
28360 SVN has two such mechanisms to provide mutual exclusivity for file access
28361 – locks and automatic setting of write permissions (see sec.
28363 \begin_inset CommandInset ref
28366 reference "subsec:Automatical-Locking-Property"
28371 \begin_inset Flex Code
28374 \begin_layout Plain Layout
28384 \begin_layout Plain Layout
28385 \begin_inset Flex URL
28388 \begin_layout Plain Layout
28390 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
28401 If this property is detected for a given document \SpecialChar LyX
28402 starts to use SVN locks
28403 for document editing automatically and the whole check-in/out mechanism
28404 switches to the same regimen as for RCS.
28405 This in particular means there are two different modes of file use in \SpecialChar LyX
28409 \begin_layout Itemize
28411 The loaded file is in the read-only mode.
28412 For editing on needs to check-out.
28417 consists of updating from the repository and gaining write lock.
28418 If the lock is not possible to obtain, we remain in unlocked state.
28421 \begin_layout Itemize
28423 The loaded file is in the
28424 \begin_inset Quotes els
28428 \begin_inset Quotes ers
28432 No other user is allowed to edit the file.
28437 consists of commiting changes and releasing write-lock.
28438 If no changes have been made to the document, no commit will be produced
28442 \begin_layout Plain Layout
28443 Don't be puzzled by the fact that you will be asked for commit message anyway.
28448 and only the write-lock will be released.
28451 \begin_layout Standard
28455 \begin_layout Labeling
28456 \labelwidthstring 00.00.0000
28459 svn commit -q -m"<description>" "<file-name>"
28460 \begin_inset Newline newline
28463 svn unlock "<file-name>"
28466 \begin_layout Labeling
28467 \labelwidthstring 00.00.0000
28470 svn update "<file-name>"
28471 \begin_inset Newline newline
28474 svn lock "<file-name>"
28477 \begin_layout Subsubsection
28480 \begin_inset CommandInset label
28482 name "subsec:Automatical-Locking-Property"
28488 Automatic Locking Property
28491 \begin_layout Standard
28492 The above mentioned automatic setting of write permissions of the .lyx file
28495 File\SpecialChar menuseparator
28497 \begin_inset space ~
28500 Control\SpecialChar menuseparator
28501 Use Locking Property
28504 This command is active only when the file is not locked on the svn server
28506 you need to check-out before proceeding).
28509 \begin_layout Labeling
28510 \labelwidthstring 00.00.0000
28512 \begin_inset space ~
28518 \begin_layout Labeling
28519 \labelwidthstring 00.00.0000
28522 svn propset svn:needs-lock ON "<file-name>"
28525 \begin_layout Labeling
28526 \labelwidthstring 00.00.0000
28529 svn propdel svn:needs-lock "<file-name>"
28532 \begin_layout Subsubsection
28533 \begin_inset CommandInset label
28535 name "subsec:VCS-Revision-Information"
28539 Revision Information in Documents
28542 \begin_layout Standard
28543 There are more possibilities how to activate revision information in our
28547 \begin_layout Itemize
28553 \begin_layout Itemize
28554 tree revision information (
28555 \begin_inset Flex Code
28558 \begin_layout Plain Layout
28565 The result is the output of the
28566 \begin_inset Flex Code
28569 \begin_layout Plain Layout
28575 command, the following table gives you an idea, how to read the results.
28578 \begin_layout Standard
28580 \begin_inset Tabular
28581 <lyxtabular version="3" rows="6" columns="2">
28582 <features tabularvalignment="middle">
28583 <column alignment="left" valignment="top">
28584 <column alignment="left" valignment="top">
28586 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
28589 \begin_layout Plain Layout
28597 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
28600 \begin_layout Plain Layout
28610 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
28613 \begin_layout Plain Layout
28619 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
28622 \begin_layout Plain Layout
28623 mixed revision working copy
28630 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
28633 \begin_layout Plain Layout
28639 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
28642 \begin_layout Plain Layout
28643 modified working copy
28650 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
28653 \begin_layout Plain Layout
28659 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
28662 \begin_layout Plain Layout
28663 switched working copy
28670 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
28673 \begin_layout Plain Layout
28679 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
28682 \begin_layout Plain Layout
28683 partial working copy, from a sparse checkout
28690 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
28693 \begin_layout Plain Layout
28699 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
28702 \begin_layout Plain Layout
28703 mixed revision, modified, switched working copy
28716 \begin_layout Itemize
28717 file revision information.
28718 The result comes from parsing the output of
28719 \begin_inset Flex Code
28722 \begin_layout Plain Layout
28724 \begin_inset space ~
28728 \begin_inset space ~
28732 \begin_inset space ~
28741 Supported flags are:
28745 \begin_layout Itemize
28746 version number of the last commit (
28747 \begin_inset Flex Code
28750 \begin_layout Plain Layout
28759 \begin_layout Itemize
28760 author of the last commit (
28761 \begin_inset Flex Code
28764 \begin_layout Plain Layout
28773 \begin_layout Itemize
28774 date of the last commit (
28775 \begin_inset Flex Code
28778 \begin_layout Plain Layout
28787 \begin_layout Itemize
28788 time of the last commit (
28789 \begin_inset Flex Code
28792 \begin_layout Plain Layout
28802 \begin_layout Standard
28803 You can obtain this info via InsetInfo (
28804 \change_inserted 5863208 1564400022
28807 Insert\SpecialChar menuseparator
28808 Field\SpecialChar menuseparator
28809 Version Control Revision
28810 \change_deleted 5863208 1564399852
28815 \begin_inset Flex Code
28818 \begin_layout Plain Layout
28819 info-insert buffer vcs-date
28827 The information will be available only when you have the file stored under
28828 svn managment (i.e.
28830 \begin_inset Flex Code
28833 \begin_layout Plain Layout
28839 directory is available with your document).
28843 \begin_layout Itemize
28844 Another—a hacking one—possibility is to use svn keywords
28848 \begin_layout Plain Layout
28849 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
28855 In short – you set file keywords property (e.g.
28858 svn propset svn:keywords 'Rev' file.lyx
28860 ) and then paste keyword \SpecialChar TeX
28865 \begin_layout Plain Layout
28866 This is an easy way how to ensure that \SpecialChar LyX
28867 won't break the line in the middle
28873 tag in your document (e.g.
28875 \begin_inset Flex Code
28878 \begin_layout Plain Layout
28885 This way svn client will automatically substitute revision number (e.g.
28887 \begin_inset Flex Code
28890 \begin_layout Plain Layout
28896 ) after each update and commit.
28897 There are more problems with this approach.
28898 Firstly, the '$' character is used in \SpecialChar TeX
28899 world for math equations, so any
28900 occurence of math formula
28901 \begin_inset Formula $Rev$
28905 \begin_inset Formula $Rev:59$
28908 in your \SpecialChar LyX
28910 Similarly for other keywords like Id, Date, Author, etc.
28911 Secondly svn output is dependent on your locales, so its very easy that
28912 svn would produce some problematic strings once Date is used.
28913 Thirdly you get the whole 'Rev: 59' string in your document instead of
28915 Until subversion implements user's custom keywords it will be hard to use
28916 this approach reliably or let \SpecialChar LyX
28917 to support it directly.
28920 \begin_layout Subsection
28921 SVN and Windows Environment
28924 \begin_layout Quote
28925 My inclination is to say that if the user cannot figure out the command
28926 line operations on their own fairly quickly, they would be well advised
28927 to use TortoiseSVN.
28933 \begin_layout Subsubsection
28937 \begin_layout Standard
28938 In addition to installing \SpecialChar LyX
28939 , and having access to a Subversion repository,
28940 the user will need to install the Subversion client program.
28941 A Windows installer for the client program is available from
28942 \begin_inset CommandInset href
28945 target "http://www.collab.net/nonav/downloads/subversion/"
28951 The user may also want to install
28952 \begin_inset CommandInset href
28955 target "http://tortoisesvn.tigris.org/"
28960 , which integrates Subversion operations into the context (rightclick) menu
28961 of Windows Explorer.
28962 Operations done outside \SpecialChar LyX
28963 will typically be more convenient using the Explorer
28965 Note that TortoiseSVN is not a replacement for the client program, which
28966 is what \SpecialChar LyX
28970 \begin_layout Subsubsection
28971 Bringing a document under Subversion control
28974 \begin_layout Standard
28975 Before a \SpecialChar LyX
28976 document can be brought under version control in Subversion, its
28977 parent directory needs to be under version control.
28978 If the document is being added to a project already in the repository,
28979 this is accomplished by checking the project out to the directory where
28980 the new document will be placed.
28981 If the project itself is not yet under version control (for instance, if
28982 this document starts a new project), the directory must be imported into
28984 This is done outside \SpecialChar LyX
28986 Both import and checkout are easily accomplished from the Explorer context
28987 menu using TortoiseSVN, or alternatively can be done using the command
28988 line client at a DOS prompt.
28989 The procedure for importing the project using TortoiseSVN is described
28990 below, assuming an existing repository and a new project being started
28998 For information on using the Subversion client program, run
29005 \begin_layout Enumerate
29012 in Windows Explorer, right click it, and select
29014 TortoiseSVN\SpecialChar menuseparator
29018 If necessary, adjust the URL for the repository, then click OK.
29021 \begin_layout Enumerate
29022 Right click the level of the repository under which you want to place the
29023 new project folder (typically the top level) and click
29027 Supply a name for the project folder and click OK.
29028 Add a message for the log file if desired, then click OK again.
29029 The new project folder should appear in the repository.
29030 Finally, click OK again to exit the repository browser.
29033 \begin_layout Enumerate
29034 Once again right click
29040 , this time selecting SVN Checkout\SpecialChar ldots
29041 Select the URL of the project folder
29042 you just created in the repository, and set the checkout directory to
29050 You will be warned about a non-empty folder; click OK to proceed.
29051 You should now have a
29062 \begin_layout Enumerate
29063 Create or open your document in \SpecialChar LyX
29066 File\SpecialChar menuseparator
29068 \begin_inset space ~
29071 Control\SpecialChar menuseparator
29075 Add a log message and click OK to commit the document to version control.
29078 \begin_layout Standard
29079 From this point onward, you should have full functionality in the
29081 File\SpecialChar menuseparator
29083 \begin_inset space ~
29089 You also have the option of checking the document in and out, viewing its
29091 using the TortoiseSVN context menu in Windows Explorer or the Subversion
29092 client program from a command prompt.
29095 \begin_layout Subsubsection
29096 SSH tunnel used with SVN under Windows
29099 \begin_layout Standard
29100 Compared with Linux setting up an svn client to communicate over ssh under
29101 Windows is a rather troublesome task.
29102 We will at least offer some hints how to setup the client side but prior
29103 knowledge about ssh and the Windows command line is needed, also be prepared
29104 for a great deal of frustration\SpecialChar ldots
29108 \begin_layout Enumerate
29109 Get an svn client for windows, as described in the previous sections.
29110 When it is a fresh install run some svn command (e.g.
29112 \begin_inset Flex Code
29115 \begin_layout Plain Layout
29121 ) to create config files, which you will need to change later on.
29124 \begin_layout Enumerate
29125 Choose an ssh client for Windows.
29126 There are several possibilities, we will use the one from Putty tools
29130 \begin_layout Plain Layout
29131 \begin_inset Flex URL
29134 \begin_layout Plain Layout
29136 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
29147 You will need to set the connection up so that the client doesn't ask for
29148 any password from you.
29149 To keep things easy we will use only keys without any additional password
29154 \begin_layout Enumerate
29156 \begin_inset Flex Code
29159 \begin_layout Plain Layout
29166 Save your private .ppk key file and put the public one on the server side.
29167 If the SVN server runs on Linux, note that the format of the public key
29168 is not compatible with Linux openssh and you will need to direcly copy-paste
29170 \begin_inset Quotes eld
29175 Public key for pasting into OpenSSH authorized_keys file
29178 \begin_inset Quotes erd
29181 edit field into the server's
29182 \begin_inset Flex Code
29185 \begin_layout Plain Layout
29186 ~/.ssh/authorized_keys
29192 \begin_inset Flex Code
29195 \begin_layout Plain Layout
29204 \begin_layout Enumerate
29206 \begin_inset Flex Code
29209 \begin_layout Plain Layout
29216 In the SVN config file
29220 \begin_layout Plain Layout
29221 Exact path depends on Windows version, usually somewhere around
29222 \begin_inset Flex Code
29225 \begin_layout Plain Layout
29228 Documents and Settings
29242 \begin_inset Flex Code
29245 \begin_layout Plain Layout
29260 , section [tunnels], setup ssh command, e.g.
29262 \begin_inset Flex Code
29265 \begin_layout Plain Layout
29266 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
29275 \begin_layout Plain Layout
29276 It will usually take a lot of time to get exact command right and it depends
29278 For example do not have some remote server saved as a default session in
29280 If things fail, try to connect via plink without SVN first.
29289 \begin_layout Enumerate
29290 Checkout the SVN archive, e.
29291 \begin_inset space \thinspace{}
29295 \begin_inset Newline newline
29299 \begin_inset Flex Code
29302 \begin_layout Plain Layout
29303 svn co svn+ssh://user@server/repository_path
29311 \begin_layout Subsubsection
29312 End-of-Line Conversions
29315 \begin_layout Standard
29316 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
29318 use different line endings inside the .lyx files.
29319 This is not a problem as far as \SpecialChar LyX
29320 functionality is concerned, but the commit
29321 diffs will be huge and merge-conflicts prone.
29322 Fortunately SVN itself knows
29326 \begin_layout Plain Layout
29327 \begin_inset Flex URL
29330 \begin_layout Plain Layout
29332 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
29342 how to deal with CR/LF problems when switching .lyx files to the
29343 \begin_inset Flex Code
29346 \begin_layout Plain Layout
29356 \begin_layout Plain Layout
29358 \begin_inset Flex Code
29361 \begin_layout Plain Layout
29362 svn propset svn:eol-style native FILE_NAME
29375 \begin_layout Subsection
29376 GIT commands in \SpecialChar LyX
29380 \begin_layout Standard
29381 A minimal subset of GIT commands is now supported by \SpecialChar LyX
29383 You can find the commands in the
29385 File\SpecialChar menuseparator
29387 \begin_inset space ~
29393 Please note that if you use password protected access to repository via
29394 ssh, you will be asked in terminal window.
29396 was tested against GIT 1.7.
29400 \begin_layout Plain Layout
29401 Windows users please note that you need to ensure that git is on the path.
29402 This can be set from within \SpecialChar LyX
29405 Tools\SpecialChar menuseparator
29406 Preferences\SpecialChar menuseparator
29407 Paths\SpecialChar menuseparator
29418 \begin_layout Standard
29419 One big difference of GIT and the other supported version control systems
29420 is the distributed nature of GIT: With traditional version control systems
29421 there is one central server which hosts the repository.
29422 Users commit their changes to the server, and get updates made by other
29424 With GIT, users commit to a local repository.
29425 The local repository can be synchronized with one or more remote repositories
29427 \begin_inset Flex Code
29430 \begin_layout Plain Layout
29437 \begin_inset Flex Code
29440 \begin_layout Plain Layout
29448 does not interact in any way with remote GIT repositories.
29449 It works exclusively with the local repository in a very similar way as
29450 with a central CVS or SVN repository.
29451 If you use remote GIT repositories you need to do the
29452 \begin_inset Flex Code
29455 \begin_layout Plain Layout
29462 \begin_inset Flex Code
29465 \begin_layout Plain Layout
29471 operations with your favourite GIT client.
29474 \begin_layout Subsubsection
29480 \begin_layout Standard
29481 If your document is not under revision control, this is the only item shown
29483 And if it is under revision control, the
29487 item is not visible.
29490 \begin_layout Standard
29491 This command registers in GIT your document ONLY in case you have already
29492 the documents directory under GIT control (in particular
29497 This means you have to checkout the archive by yourself.
29500 \begin_layout Standard
29501 Then you are asked interactively to supply an initial description of the
29503 Don't forget that registered file is not yet committed.
29506 \begin_layout Standard
29507 GIT command that is run:
29510 \begin_inset Quotes qld
29514 \begin_inset Quotes qld
29520 \begin_layout Standard
29525 to understand the switches.
29528 \begin_layout Subsubsection
29534 \begin_layout Standard
29535 When you are finished editing a file, you commit your changes.
29536 When you do this, you are asked for a description of the changes.
29537 After that changes are committed.
29540 \begin_layout Standard
29543 git commit -q -m"<description>" <file-name>
29546 \begin_layout Subsubsection
29549 Revert To Repository Version
29552 \begin_layout Standard
29553 This will discard all changes made to the document since the last check
29555 You get a warning before changes are discarded.
29558 \begin_layout Standard
29562 \begin_inset Quotes qld
29566 \begin_inset Quotes qld
29572 \begin_layout Subsubsection
29578 \begin_layout Standard
29579 This will rename the current document including the version history.
29580 It requires a clean document without any changes since the last checkin.
29581 You are asked for a file name and a description of the rename operation.
29582 After that the document is renamed, both locally and in the repository.
29583 If the parent directories of the new and old file names differ, all relative
29584 paths of included files are adjusted (like in
29586 File\SpecialChar menuseparator
29591 Finally, the document is reloaded using the new name.
29594 \begin_layout Labeling
29595 \labelwidthstring 00.00.0000
29597 \begin_inset space ~
29601 \begin_inset space ~
29605 \begin_inset Newline newline
29609 \begin_inset Flex Code
29612 \begin_layout Plain Layout
29616 \begin_inset Quotes qld
29620 \begin_inset Quotes qld
29624 \begin_inset Quotes qld
29628 \begin_inset Quotes qld
29637 \begin_inset Newline newline
29641 \begin_inset Flex Code
29644 \begin_layout Plain Layout
29653 \begin_layout Subsubsection
29659 \begin_layout Standard
29660 This shows the complete history of the GIT document.
29664 \begin_inset Quotes qld
29668 \begin_inset Quotes qld
29673 is shown in a browser.
29676 \begin_layout Subsubsection
29680 \begin_layout Standard
29682 supports GIT hash number of the last commit to the file,
29683 \change_inserted 1119979965 1564297456
29684 its abbreviated form,
29686 author name, date and time of last commit.
29687 All those are extracted from
29689 git log -n 1 --pretty=format:%H%n
29690 \change_inserted 1119979965 1564297427
29696 Tree version information is obtained via
29698 git describe --abbrev --dirty --long
29702 \begin_inset CommandInset ref
29705 reference "subsec:VCS-Revision-Information"
29712 \begin_layout Subsection
29716 \begin_layout Standard
29717 With the recent addition of the
29718 \begin_inset Flex Code
29721 \begin_layout Plain Layout
29727 function \SpecialChar LyX
29728 power users are allowed to create their own commands for revision
29732 \begin_layout Standard
29733 As an example you can see how two TortoiseSVN commands could be integrated
29737 \begin_layout Description
29739 \begin_inset Flex Code
29742 \begin_layout Plain Layout
29743 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
29751 \begin_layout Description
29753 \begin_inset Flex Code
29756 \begin_layout Plain Layout
29757 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
29765 \begin_layout Subsection
29766 Version control and Document comparison
29769 \begin_layout Standard
29770 One of the typical uses of version control is to inspect the changes between
29771 revisions, usually by creating
29772 \begin_inset Flex Code
29775 \begin_layout Plain Layout
29782 While this is useful for plain text files, it is much less useful in the
29783 case of \SpecialChar LyX
29784 files, which have more a complicated structure.
29785 Hence we provide binding to the Document comparison feature.
29786 There are two ways of calling this feature – either by direct call of
29787 \begin_inset Flex Code
29790 \begin_layout Plain Layout
29797 function (for details see \SpecialChar LyX
29798 functions manual) or by the toolbar icon
29811 One can either compare two chosen revisions of the document or he can simply
29812 compare the current version of edited text with older revisions (where
29814 \begin_inset Flex Noun
29817 \begin_layout Plain Layout
29823 ' revisions back means comparison of the edited file with last commited
29828 \begin_layout Standard
29829 This feature is supported for SVN and RCS though due to the more complicated
29830 versioning scheme of RCS there is a constraint – when addressing the revisions
29831 in dialog, numbers always point to the last number in RCS revision number,
29834 We don't currently support GIT addressing of revisions, one can just compare
29835 edited document with its revision X steps backs, where X is addressed as
29837 \begin_inset Flex Code
29840 \begin_layout Plain Layout
29849 \begin_layout Section
29850 Literate Programming
29853 \begin_layout Standard
29858 (kayvan@sylvan.com)
29862 original documentation written by
29864 Edmar Wienskoski Jr.
29867 (edmar-w-jr@technologist.com)
29870 \begin_layout Subsection
29874 \begin_layout Standard
29875 The main purpose of this documentation is to show you how to use \SpecialChar LyX
29877 programming, where it is assumed that you are familiar with this programming
29878 technique, and know what
29879 \begin_inset Quotes eld
29883 \begin_inset Quotes erd
29887 \begin_inset Quotes eld
29891 \begin_inset Quotes erd
29895 If that is not the case, please follow the web links provided in the following
29897 There is a lot of good documentation out there covering old development
29898 history to the latest tools tips.
29901 \begin_layout Standard
29902 It is also assumed that you are familiar with \SpecialChar LyX
29903 itself to a point that you
29904 are comfortable changing your \SpecialChar LyX
29905 preferences, and X resources file.
29906 If that is not the case please refer to other \SpecialChar LyX
29907 documentation to cover your
29911 \begin_layout Subsection
29912 Literate Programming
29915 \begin_layout Standard
29916 From the Literate Programming FAQ:
29919 \begin_layout Quotation
29920 Literate programming is the combination of documentation and source together
29921 in a fashion suited for reading by human beings.
29922 In fact, literate programs should be enjoyable reading, even inviting!
29923 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
29924 and documentation in a single file.
29925 Literate programming tools then parse the file to produce either readable
29926 documentation or compilable source.
29927 The WEB style of literate programming was created by D.
29928 \begin_inset space \thinspace{}
29932 Knuth during the development of his \SpecialChar TeX
29933 typesetting software.
29937 \begin_layout Standard
29938 Another excerpt says:
29941 \begin_layout Quotation
29944 How is literate programming different from verbose commenting?
29947 \begin_layout Quotation
29948 There are three distinguishing characteristics.
29949 In order of importance, they are:
29953 \begin_layout Itemize
29954 flexible order of elaboration
29957 \begin_layout Itemize
29958 automatic support for browsing
29961 \begin_layout Itemize
29962 typeset documentation, especially diagrams and mathematics
29966 \begin_layout Standard
29967 Now that I sparked your curiosity, take a look in the references.
29970 \begin_layout Subsubsection
29974 \begin_layout Standard
29975 The complete Literate Programming FAQ can be found at:
29978 \begin_layout Quote
29979 Literate Programming FAQ
29980 \begin_inset Flex URL
29983 \begin_layout Plain Layout
29985 http://www.literateprogramming.com/lpfaq.pdf
29993 \begin_layout Standard
29994 The FAQ lists 23 (twenty three!) different literate programming tools.
29995 Where some are specialized or
29996 \begin_inset Quotes eld
30000 \begin_inset Quotes erd
30003 for particular programming languages, while other have general scope.
30008 for my own use for several reasons:
30011 \begin_layout Itemize
30012 It can generate the documentation either in \SpecialChar LaTeX
30016 \begin_layout Itemize
30017 It has a open architecture, i.
30018 \begin_inset space \thinspace{}
30022 \begin_inset space \space{}
30025 it is easy to plug in new filters
30029 \begin_layout Plain Layout
30034 are programs that read a given data stream and output a manipulated data
30036 That way, a WEB file (consisting of literate code) can be turned into a
30037 file consisting only of C program code or \SpecialChar LaTeX
30043 and to perform special processing that you may need.
30047 \begin_layout Itemize
30048 There is a good selection of filters available already (the HTML is one
30052 \begin_layout Itemize
30056 \begin_layout Standard
30057 The Noweb web page can be found at:
30060 \begin_layout Quote
30062 \begin_inset Flex URL
30065 \begin_layout Plain Layout
30067 https://www.cs.tufts.edu/~nr/noweb/
30075 \begin_layout Standard
30076 Starting from there you can reach many other interesting links and even
30077 some literate program examples.
30080 \begin_layout Subsection
30082 and Literate Programming with Noweb
30085 \begin_layout Standard
30086 The \SpecialChar LyX
30087 support for Literate Programming is provided by using the generic \SpecialChar LyX
30089 converters mechanism.
30090 This support is provided in a
30091 \begin_inset Quotes eld
30095 \begin_inset Quotes erd
30099 \begin_inset space \thinspace{}
30103 \begin_inset space \space{}
30106 you will be able to use this new \SpecialChar LyX
30107 feature with some other literate programming
30108 tool of your choice by just changing your \SpecialChar LyX
30112 \begin_layout Subsubsection
30113 Generating documents and code (weaving and tangling)
30116 \begin_layout Paragraph
30117 Using the noweb module
30120 \begin_layout Standard
30121 If you have installed Noweb and \SpecialChar LyX
30122 successfully, whenever you open a new document,
30123 after you have chosen its document class, use the
30125 Document\SpecialChar menuseparator
30129 \begin_inset Quotes eld
30133 \begin_inset Quotes erd
30137 If Noweb is correctly installed, when you click on the
30138 \begin_inset Quotes eld
30142 \begin_inset Quotes erd
30145 link, you will see the
30146 \begin_inset Quotes eld
30150 \begin_inset Quotes erd
30153 module in the available list and you can add it to your document.
30156 \begin_layout Paragraph
30160 \begin_layout Standard
30162 enables you to write code with a custom inset named
30163 \begin_inset Flex Noun
30166 \begin_layout Plain Layout
30173 Noweb delimits chunks like this:
30176 \begin_layout LyX-Code
30180 \begin_layout LyX-Code
30184 \begin_layout LyX-Code
30188 \begin_layout LyX-Code
30192 \begin_layout LyX-Code
30196 \begin_layout Standard
30197 The problem is that whatever is written in between the << and the
30201 must be taken literally, i.
30202 \begin_inset space \thinspace{}
30206 \begin_inset space \space{}
30210 should be prevented from making any special interpretation of what has
30212 This is also handled by
30213 \begin_inset Flex Noun
30216 \begin_layout Plain Layout
30222 , that works like a normal text inset but has a free spacing capability.
30225 \begin_layout Standard
30226 As a special note, you can also use the
30227 \begin_inset Quotes eld
30231 \begin_inset Quotes erd
30234 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
30238 \begin_layout LyX-Code
30242 \begin_layout LyX-Code
30243 def some_function(args):
30246 \begin_layout LyX-Code
30247 "This is the doc string for this function."
30250 \begin_layout LyX-Code
30251 print "My args: ", args
30254 \begin_layout LyX-Code
30255 @ %def some_function
30258 \begin_layout Standard
30259 For an example of this usage and the resulting cross-reference output, look
30260 at the Literate python program in
30262 LIBDIR/examples/listerrors.lyx
30264 which should make this all clear.
30267 \begin_layout Paragraph
30268 Generating the documentation
30271 \begin_layout Standard
30272 At this point you already have a new document file with a proper document
30273 class, and with some code and text on it.
30274 How do I print it? The answer is simple, you select
30276 View\SpecialChar menuseparator
30280 Just like you would do for a plain document.
30281 No special procedure is required.
30284 \begin_layout Standard
30285 To help orientate you, I will now explain what happens inside \SpecialChar LyX
30289 \begin_layout Enumerate
30292 Update\SpecialChar menuseparator
30295 menu option is chosen, a \SpecialChar LaTeX
30301 \begin_layout Standard
30302 If the document is of any literate class the generated file will be named
30303 with an extension name defined by the
30304 \begin_inset Quotes eld
30308 \begin_inset Quotes erd
30311 format (defined in the Preferences panel), otherwise the file will have
30320 \begin_layout Enumerate
30321 Note that the only difference so far is in the name of the file, no special
30322 processing is required by \SpecialChar LyX
30324 Given that you formatted the code using the
30325 \begin_inset Flex Noun
30328 \begin_layout Plain Layout
30334 inset that, by itself, takes care of the business.
30337 \begin_layout Enumerate
30338 If the document is of any literate class \SpecialChar LyX
30339 will then use the internal \SpecialChar LyX
30341 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
30346 \begin_layout Plain Layout
30347 The converters are defined in the
30349 Tools\SpecialChar menuseparator
30353 \begin_inset Quotes eld
30357 \begin_inset Quotes erd
30369 manual for general information about converters.
30374 to generate the \SpecialChar LaTeX
30379 \begin_layout Standard
30380 Otherwise it will just skip this step.
30384 \begin_layout Enumerate
30385 Finally, \SpecialChar LaTeX
30386 is invoked and the regular post processing continues as in a plain
30390 \begin_layout Standard
30391 Independence from a particular
30392 \begin_inset Quotes eld
30396 \begin_inset Quotes erd
30399 is easily achieved by changing the commands that are run by the various
30403 \begin_layout Paragraph
30404 Generating the code
30407 \begin_layout Standard
30408 When the build menu option is chosen or the corresponding button in the
30409 toolbar is pressed, a \SpecialChar LaTeX
30410 file is generated just like step 1 above.
30411 Next, \SpecialChar LyX
30417 This converter needs to be defined by the user and is not installed by
30418 default, though the Program format is.
30419 This converter (like any other converter) will have two parts:
30422 \begin_layout Enumerate
30423 The converter program itself.
30424 This program performs the conversion from the one format to the other (in
30425 this case, from the Noweb format to the Program pseudo-format).
30428 \begin_layout Enumerate
30429 The error log parser.
30430 This is a program whose sole purpose is to rewrite error messages in a
30431 format that \SpecialChar LyX
30433 This makes it possible for \SpecialChar LyX
30434 to place error boxes in the right places in
30438 \begin_layout Standard
30439 The first part, the
30440 \begin_inset Quotes eld
30444 \begin_inset Quotes erd
30447 setting, should be set to
30450 \begin_layout LyX-Code
30458 \begin_layout Standard
30459 This basically means that \SpecialChar LyX
30461 \begin_inset Quotes eld
30465 \begin_inset Quotes erd
30468 (a program or script) with the name of the Noweb file (normally a file
30469 in the \SpecialChar LyX
30470 temp directory) and the directory path of the original \SpecialChar LyX
30475 \begin_layout Standard
30476 This is an implementation of
30477 \begin_inset Quotes eld
30481 \begin_inset Quotes erd
30484 that you can place in a directory on your path:
30487 \begin_layout LyX-Code
30493 \begin_layout LyX-Code
30499 \begin_layout LyX-Code
30502 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
30505 \begin_layout Standard
30506 The next part of the converter setting is the
30507 \begin_inset Quotes eld
30511 \begin_inset Quotes erd
30514 which is to be set to
30517 \begin_layout LyX-Code
30520 parselog=$$s/scripts/listerrors
30523 \begin_layout Standard
30524 This will run any errors that are generated by the
30525 \begin_inset Quotes eld
30529 \begin_inset Quotes erd
30532 process through the
30533 \begin_inset Quotes eld
30537 \begin_inset Quotes erd
30543 \begin_layout Standard
30544 The build will normally take place in \SpecialChar LyX
30545 's temporary directory, so the files
30546 produced by the conversion will be in that directory.
30548 will copy out what it regards as the `main' file, but the
30552 conversion may produce several files, and so most of these would then be
30553 deleted when \SpecialChar LyX
30555 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
30556 the build-script chunk can place the generated files in that location.
30559 \begin_layout Paragraph
30560 Build instructions in the document
30563 \begin_layout Standard
30564 The last piece of the integration between \SpecialChar LyX
30566 \begin_inset Quotes eld
30570 \begin_inset Quotes erd
30574 Generally, the instructions for building your program should be embedded
30575 in a chunk of its own.
30577 \begin_inset Quotes eld
30581 \begin_inset Quotes erd
30584 above uses the notangle command to look for this chunk (called
30585 \begin_inset Quotes eld
30589 \begin_inset Quotes erd
30592 ) and runs its contents through
30593 \begin_inset Quotes eld
30597 \begin_inset Quotes erd
30603 \begin_layout Standard
30604 Typically, such a chunk would look something like this:
30607 \begin_layout LyX-Code
30611 \begin_layout LyX-Code
30613 \begin_inset Newline newline
30616 if [ -z "${NOWEB_SOURCE}" ]
30617 \begin_inset Newline newline
30623 \begin_layout LyX-Code
30624 NOWEB_SOURCE=myfile.nw
30625 \begin_inset Newline newline
30629 \begin_inset Newline newline
30633 code to extract files ...
30634 use NOWEB_OUTPUT_DIR here ...]
30635 \begin_inset Newline newline
30639 code to compile files ...]
30640 \begin_inset Newline newline
30646 \begin_layout Standard
30649 LIBDIR/examples/listerrors.lyx
30653 LIBDIR/examples/Literate.lyx
30655 which implement two versions of the
30656 \begin_inset Quotes eld
30660 \begin_inset Quotes erd
30663 program for some illustrations of how all of these pieces go together or
30666 LIBDIR/examples/noweb2lyx.lyx.
30669 Interestingly, these three files show off the language-indepence of the
30671 literate programming support since they are written in Python, C and Perl
30675 \begin_layout Subsubsection
30676 Configuring \SpecialChar LyX
30680 \begin_layout Standard
30681 All the Literate Programming support is configured by the
30683 Tools\SpecialChar menuseparator
30687 \begin_inset Quotes eld
30691 \begin_inset Quotes erd
30695 The important parts are:
30698 \begin_layout Description
30700 \begin_inset space ~
30704 \begin_inset Quotes eld
30708 \begin_inset Quotes erd
30712 \begin_inset space ~
30715 format Set up via the File Formats tab, this is where the Noweb-specific
30725 , the file extension is set to
30730 This tells \SpecialChar LyX
30731 to create a file with a
30735 extension in the first step of the conversion process.
30738 \begin_layout Description
30740 \begin_inset space ~
30748 \begin_inset space ~
30751 format This is an empty format whose sole purpose is to be the endpoint
30752 of a conversion (which then allows us to set up a converter for it).
30755 \begin_layout Description
30765 This converter performs the
30766 \begin_inset Quotes eld
30770 \begin_inset Quotes erd
30773 of the literate document.
30774 For Noweb, it is set to
30775 \begin_inset Quotes eld
30780 noweave -delay -index $$i > $$o
30783 \begin_inset Quotes erd
30789 \begin_layout Description
30799 \begin_inset Quotes eld
30803 \begin_inset Quotes erd
30807 As stated above, the Converter is set to
30808 \begin_inset Quotes eld
30816 \begin_inset Quotes erd
30819 , with Flags set to
30820 \begin_inset Newline newline
30824 \begin_inset Quotes eld
30829 parselog=$$s/scripts/listerrors
30832 \begin_inset Quotes erd
30838 \begin_layout Subsubsection
30842 \begin_layout Standard
30843 There is also a new function implemented in the \SpecialChar LyX
30845 \begin_inset Quotes eld
30848 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
30852 \begin_layout Standard
30853 When debugging code with ddd/gdb, it is possible to invoke a text editor
30854 at the current execution position with a single key stroke.
30855 The default ddd configuration for that is shift-ctrl-V.
30856 It happens that you can define the editor command line invocation in ddd
30859 Edit\SpecialChar menuseparator
30860 Preferences\SpecialChar menuseparator
30863 dialog and changing the "Edit Sources" entry.
30866 \begin_layout Standard
30867 I take advantage of the newly created \SpecialChar LyX
30868 server function and this ddd feature,
30870 \begin_inset Quotes eld
30874 \begin_inset Quotes erd
30880 \begin_layout LyX-Code
30881 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
30884 \begin_layout Standard
30885 With this, whenever you are using ddd and find a point in the program that
30886 you want to edit, you just press shift-ctrl-V (in the ddd window), and
30887 ddd will forward this information to \SpecialChar LyX
30888 through the \SpecialChar LyX
30889 server and then the
30891 window will show the same file with the cursor at the same position ddd
30893 No more guessing or long scrolling to locate a point in the program back
30897 \begin_layout Standard
30898 Note however that you must enable the \SpecialChar LyX
30899 server to get this feature working
30900 (it is disabled by default).
30902 \begin_inset space ~
30906 \begin_inset CommandInset ref
30909 reference "sec:Starting-the-Server"
30913 explains how to do that.
30916 \begin_layout Subsubsection
30920 \begin_layout Standard
30921 There are six new buttons that can be added to your \SpecialChar LyX
30923 Four of these buttons are short cuts to layout styles:
30941 , one for the custom inset
30946 The last one is a short cut to the
30947 \begin_inset Quotes eld
30951 \begin_inset Quotes erd
30958 \begin_layout Standard
30960 has a range of buttons that are available for tool bar customization.
30961 In my toolbar I like to combine the six short cuts above with two more:
30966 \SpecialChar menuseparator
30971 \SpecialChar menuseparator
30978 Document\SpecialChar menuseparator
30979 View\SpecialChar menuseparator
30983 Here is how it looks like:
30986 \begin_layout LyX-Code
30990 \begin_layout LyX-Code
30994 \begin_layout LyX-Code
30995 Icon "layout Standard"
30998 \begin_layout LyX-Code
30999 Icon "layout Section"
31002 \begin_layout LyX-Code
31003 Icon "layout \SpecialChar LaTeX
31007 \begin_layout LyX-Code
31008 Icon "layout \SpecialChar LyX
31012 \begin_layout LyX-Code
31013 Icon "flex.insert Chunk"
31016 \begin_layout LyX-Code
31020 \begin_layout LyX-Code
31024 \begin_layout LyX-Code
31025 Icon "buffer-typeset"
31028 \begin_layout LyX-Code
31029 Icon "build-program"
31032 \begin_layout LyX-Code
31036 \begin_layout LyX-Code
31040 \begin_layout LyX-Code
31044 \begin_layout LyX-Code
31048 \begin_layout LyX-Code
31052 \begin_layout Subsubsection
31053 Colors customization
31056 \begin_layout Standard
31057 There are a number of colors in \SpecialChar LyX
31058 that can be customized in
31063 One of the things that bothers people is the \SpecialChar LaTeX
31065 The default color is red, since the chunks uses \SpecialChar LaTeX
31066 font, and there is a lot
31067 of chunks in literate documents, you may get tired of seeing everything
31069 You can change it by going to the tabs
31078 \begin_layout Standard
31079 The next thing is the visible presence of the newline character in the screen.
31080 You can choose the color of this particular character and make it blend
31082 I recommend you choosing a color that is close to the background but not
31083 equal, that way you still can see it is there, but it is not bothering
31087 \begin_layout Subsection
31092 \begin_layout Standard
31102 \change_deleted 564990737 1671643409
31108 \change_inserted 564990737 1671643443
31112 File\SpecialChar menuseparator
31113 Open Example\SpecialChar menuseparator
31114 Modules\SpecialChar menuseparator
31121 \change_deleted 564990737 1671643461
31122 the Sweave manual (menu
31124 Help\SpecialChar menuseparator
31128 \change_inserted 564990737 1671643461
31132 Help\SpecialChar menuseparator
31133 Specific Manuals\SpecialChar menuseparator
31142 \begin_layout Chapter
31144 \change_deleted 564990737 1671355343
31148 \begin_layout Standard
31150 \change_deleted 564990737 1671355343
31151 You can do everything with \SpecialChar LyX
31152 that you can do with \SpecialChar LaTeX
31154 However, \SpecialChar LyX
31155 cannot support every \SpecialChar LaTeX
31157 But you can always use \SpecialChar TeX
31159 This chapter shows you some more special things you might want to use.
31160 For other special things you can do with figures, tables, floats, boxes
31161 and notes, have a look at the
31164 \begin_inset space ~