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
4967 reference "sec:Collections"
4974 \begin_layout Subsection
4976 \change_inserted 564990737 1670794716
4982 \begin_layout Standard
4984 \change_inserted 564990737 1670794716
4991 ; updated by the \SpecialChar LyX
4995 \begin_layout Subsubsection
4997 \change_inserted 564990737 1670794716
5003 \begin_layout Standard
5005 \change_inserted 564990737 1670794716
5008 This section describes how \SpecialChar LyX
5009 can be used to write articles for submission
5010 to the scientific journal
5012 Astronomy and Astrophysics
5015 \begin_inset CommandInset href
5018 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
5023 ) using Version 9.1 of the document class
5027 ; information about it is available at
5028 \begin_inset Flex URL
5031 \begin_layout Plain Layout
5033 \change_inserted 564990737 1670794716
5035 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
5045 \begin_layout Standard
5047 \change_inserted 564990737 1670794716
5050 A manual comes together with the package and should be consulted before
5051 installing this document class as described in the
5053 Installing New Document Classe
5063 \begin_layout Standard
5065 \change_inserted 564990737 1670794716
5068 \begin_inset Note Greyedout
5071 \begin_layout Plain Layout
5073 \change_inserted 564990737 1670794716
5076 Please note that the publisher of the journal was changed from Springer
5077 to EDP Sciences starting January 1, 2001.
5078 That change also involved some slight changes to the style files, namely
5079 the removal of the thesaurus command.
5080 If you have an older version installed, please upgrade.
5081 For information about compatibility with the old (version 4) layout, please
5082 refer to the comments in
5085 Dir/layouts/aapaper.layout
5095 \begin_layout Subsubsection
5097 \change_inserted 564990737 1670794716
5103 \begin_layout Standard
5105 \change_inserted 564990737 1671617129
5108 It is recommended you start from the template in the menu
5113 ile\SpecialChar menuseparator
5115 \begin_inset space ~
5123 \begin_inset space ~
5128 \SpecialChar menuseparator
5129 Articles\SpecialChar menuseparator
5130 Astronomy & Astrophysics
5134 If you are not using the template, note the following settings:
5137 \begin_layout Itemize
5139 \change_inserted 564990737 1670794716
5151 ocument\SpecialChar menuseparator
5156 ettings\SpecialChar menuseparator
5158 \begin_inset space ~
5163 dialog (OK, that one was obvious).
5166 \begin_layout Itemize
5168 \change_inserted 564990737 1670794716
5174 \begin_inset space ~
5186 \begin_inset space ~
5191 dialog: leave it set to
5196 The whole layout is done by the macros, you shouldn't change anything.
5199 \begin_layout Subsubsection
5201 \change_inserted 564990737 1670794716
5207 \begin_layout Standard
5209 \change_inserted 564990737 1670794716
5212 First thing to enter is the header information.
5213 It consists of five entries, of which one is optional.
5217 \begin_layout Itemize
5219 \change_inserted 564990737 1670794716
5228 \begin_layout Itemize
5230 \change_inserted 564990737 1670794716
5239 \begin_layout Itemize
5241 \change_inserted 564990737 1670794716
5250 \begin_layout Itemize
5252 \change_inserted 564990737 1670794716
5261 \begin_layout Itemize
5263 \change_inserted 564990737 1670794716
5272 Received: <date>; Accepted <date>
5275 \begin_layout Standard
5277 \change_inserted 564990737 1670794716
5280 Although the order of the single header entries doesn't matter it is advised
5281 to keep the above sequence, just to get the best optics and meets the layout
5282 of the real document.
5285 \begin_layout Standard
5287 \change_inserted 564990737 1670794716
5290 If you want to place footnotes in the header block, e.
5291 \begin_inset space \thinspace{}
5295 \begin_inset space \space{}
5298 to state your present address, just use the standard footnote via the menu
5304 nsert\SpecialChar menuseparator
5313 will automagically use the term
5322 \begin_layout Standard
5324 \change_inserted 564990737 1670794716
5327 In addition to these topics, the macros use three additional \SpecialChar LaTeX
5329 have no counterpart in \SpecialChar LyX
5333 \begin_layout Itemize
5335 \change_inserted 564990737 1670794716
5343 to separate different names for more than one author and institute, respectivel
5347 \begin_layout Itemize
5349 \change_inserted 564990737 1670794716
5357 to mark corresponding author/institute pairs.
5358 The institutes are numbered sequentially as they appear in the
5362 field, so you have to put a marker to each author.
5365 \begin_layout Itemize
5367 \change_inserted 564990737 1670794716
5375 to supply an email address for fast contact.
5378 \begin_layout Standard
5380 \change_inserted 564990737 1671642374
5383 In all cases, the appropriate command has to be entered as \SpecialChar TeX
5384 code in \SpecialChar LyX
5386 See the examples in the template and in
5389 File\SpecialChar menuseparator
5390 Open Example\SpecialChar menuseparator
5391 Articles\SpecialChar menuseparator
5392 Astronomy & Astrophysics
5400 \begin_layout Subsubsection
5402 \change_inserted 564990737 1670794716
5408 \begin_layout Standard
5410 \change_inserted 564990737 1670794716
5413 The abstract should immediately follow the header block and must contain
5423 \begin_layout Enumerate
5425 \change_inserted 564990737 1670794716
5431 (optional) {} leave it empty if necessary
5434 \begin_layout Enumerate
5436 \change_inserted 564990737 1670794716
5445 \begin_layout Enumerate
5447 \change_inserted 564990737 1670794716
5456 \begin_layout Enumerate
5458 \change_inserted 564990737 1670794716
5467 \begin_layout Enumerate
5469 \change_inserted 564990737 1670794716
5475 (optional) {} leave it empty if necessary
5478 \begin_layout Standard
5480 \change_inserted 564990737 1670794716
5484 This structure not shown in
5491 \begin_layout Subsubsection
5493 \change_inserted 564990737 1670794716
5496 Supported environments
5499 \begin_layout Standard
5501 \change_inserted 564990737 1670794716
5504 The A&A paper layout supports the following environments for structuring
5508 \begin_layout Itemize
5510 \change_inserted 564990737 1670794716
5517 \begin_layout Itemize
5519 \change_inserted 564990737 1670794716
5526 \begin_layout Itemize
5528 \change_inserted 564990737 1670794716
5535 \begin_layout Itemize
5537 \change_inserted 564990737 1670794716
5544 \begin_layout Itemize
5546 \change_inserted 564990737 1670794716
5553 \begin_layout Itemize
5555 \change_inserted 564990737 1670794716
5562 \begin_layout Itemize
5564 \change_inserted 564990737 1670794716
5571 \begin_layout Itemize
5573 \change_inserted 564990737 1670794716
5580 \begin_layout Itemize
5582 \change_inserted 564990737 1670794716
5589 \begin_layout Itemize
5591 \change_inserted 564990737 1670794716
5598 \begin_layout Itemize
5600 \change_inserted 564990737 1670794716
5607 \begin_layout Itemize
5609 \change_inserted 564990737 1670794716
5617 \begin_layout Subsubsection
5619 \change_inserted 564990737 1670794716
5622 Commands not supported by \SpecialChar LyX
5626 \begin_layout Standard
5628 \change_inserted 564990737 1670794716
5631 Some commands are not yet supported by the
5635 layout for \SpecialChar LyX
5637 Some have already been mentioned.
5638 For the sake of completeness, they are listed all together here:
5641 \begin_layout Itemize
5643 \change_inserted 564990737 1670794716
5652 \begin_layout Itemize
5654 \change_inserted 564990737 1670794716
5663 \begin_layout Itemize
5665 \change_inserted 564990737 1670794716
5674 \begin_layout Itemize
5676 \change_inserted 564990737 1670794716
5685 \begin_layout Itemize
5687 \change_inserted 564990737 1670794716
5696 \begin_layout Standard
5698 \change_inserted 564990737 1670794716
5701 If you want to use any of these commands, you have to enter them yourself.
5704 Do not forget to use
5710 nsert\SpecialChar menuseparator
5713 \begin_inset space ~
5722 \begin_layout Subsubsection
5724 \change_inserted 564990737 1670794716
5727 Figure and Table Floats
5730 \begin_layout Standard
5732 \change_inserted 564990737 1670794716
5736 provides support for the necessary float environments
5738 figure, figure*, table
5744 , therefore we won't tell much about it here.
5748 \begin_inset space ~
5754 Just remember that tables should be left-aligned.
5755 For that, select the table and change the alignment in
5760 dit\SpecialChar menuseparator
5766 \begin_inset space ~
5772 \begin_layout Standard
5774 \change_inserted 564990737 1670794716
5777 There is only one special thing: the figures with a caption beside the figure.
5778 To create such a figure, you have to do the following:
5781 \begin_layout Enumerate
5783 \change_inserted 564990737 1670794716
5786 Create a wide figure float:
5791 nsert\SpecialChar menuseparator
5796 t\SpecialChar menuseparator
5799 , then, from within the float, use the menu
5804 dit\SpecialChar menuseparator
5810 \begin_inset space ~
5821 \begin_inset space ~
5833 \begin_layout Enumerate
5835 \change_inserted 564990737 1670794716
5838 Enter your caption text.
5841 \begin_layout Enumerate
5843 \change_inserted 564990737 1670794716
5850 to move the cursor above the caption.
5853 \begin_layout Enumerate
5855 \change_inserted 564990737 1670794716
5861 \begin_layout Enumerate
5863 \change_inserted 564990737 1670794716
5866 Position the cursor after the figure and insert a horizontal fill by using
5872 nsert\SpecialChar menuseparator
5877 rmatting\SpecialChar menuseparator
5883 \begin_inset space ~
5892 dialog and select the
5906 \begin_layout Enumerate
5908 \change_inserted 564990737 1670794716
5911 Switch to \SpecialChar LaTeX
5915 \begin_inset space ~
5923 \begin_layout Enumerate
5925 \change_inserted 564990737 1670794716
5936 Do not close the brace!
5939 \begin_layout Enumerate
5941 \change_inserted 564990737 1670794716
5944 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
5949 \begin_inset space ~
5961 \begin_layout Standard
5963 \change_inserted 564990737 1671642458
5966 Also, refer to the figures in the file in
5969 File\SpecialChar menuseparator
5970 Open Example\SpecialChar menuseparator
5971 Articles\SpecialChar menuseparator
5972 Astronomy & Astrophysics
5978 \begin_layout Subsubsection
5980 \change_inserted 564990737 1670794716
5986 \begin_layout Standard
5988 \change_inserted 564990737 1670794716
5991 For submission, the paper has to be formatted in a special double-spacing
5993 For this purpose, you have to add the option
6004 \begin_inset space ~
6014 ocument\SpecialChar menuseparator
6019 ettings\SpecialChar menuseparator
6021 \begin_inset space ~
6030 \begin_layout Subsubsection
6032 \change_inserted 564990737 1670794716
6038 \begin_layout Standard
6040 \change_inserted 564990737 1671642520
6046 File\SpecialChar menuseparator
6047 Open Example\SpecialChar menuseparator
6048 Articles\SpecialChar menuseparator
6049 Astronomy & Astrophysics
6052 was written with \SpecialChar LyX
6054 It is the example paper from the original macro package,
6059 \begin_inset CommandInset href
6062 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
6067 , but translated to \SpecialChar LyX
6068 using the older unstructured abstract type.
6069 Use it for inspiration, and compare the \SpecialChar LaTeX
6074 with the \SpecialChar LyX
6078 \begin_layout Subsection
6083 \begin_layout Standard
6089 \begin_layout Subsubsection
6093 \begin_layout Standard
6095 is a set of macros produced by the American Astronomical Society to
6096 facilitate electronic manuscript submission to the three journals they
6097 publish: the Astrophysical Journal (including the Letters and Supplement),
6098 the Astronomical Journal, and the Publications of the Astronomical Society
6101 has proven to be an excellent tool for generating these documents, especially
6102 given its equation, citation, and figure handling capabilities.
6104 requires version 5.0 (or higher) of these macros; preferably 6.0, which
6105 is the version described here, or higher.
6106 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
6107 2.09 and are fundamentally
6108 incompatible with \SpecialChar LyX
6110 The AAS\SpecialChar TeX
6111 package may be downloaded from the AAS\SpecialChar TeX
6115 \begin_layout Standard
6116 \begin_inset VSpace medskip
6122 \begin_layout Standard
6124 \begin_inset Flex URL
6127 \begin_layout Plain Layout
6129 https://aas.org/aastex/aastex-downloads
6137 \begin_layout Standard
6138 \begin_inset VSpace medskip
6144 \begin_layout Standard
6145 A complete user guide is contained in that package and you should familiarize
6146 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
6149 will not reduce the need to figure out all the AAS\SpecialChar TeX
6150 commands, it will only
6151 reduce the drudgery of typing everything in.
6152 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
6154 completely to the requirements of the journal to which you are submitting
6158 \begin_layout Subsubsection
6159 Starting a New Paper
6162 \begin_layout Standard
6163 I strongly suggest that you start with the AAS\SpecialChar TeX
6167 File\SpecialChar menuseparator
6173 \change_inserted 564990737 1671617265
6174 \SpecialChar menuseparator
6175 Articles\SpecialChar menuseparator
6176 American Astronomical Society
6177 \change_deleted 564990737 1671617310
6180 , enter the new file name, then choose the
6187 This will show the most common fields found in a manuscript.
6188 Simply overwrite the existing text (including the brackets,
6192 ) with the correct information.
6193 Many of the AAS\SpecialChar TeX
6194 commands and environments can be implemented directly in
6197 For commands such as these, the \SpecialChar LaTeX
6198 code must be entered directly and marked
6200 Such commands are referred to as \SpecialChar TeX
6201 code, or Evil Red Text.
6202 I tried to minimize the amount of \SpecialChar TeX
6203 code needed in an AAS\SpecialChar TeX
6207 \begin_layout Subsubsection
6208 Finishing Your Paper
6211 \begin_layout Standard
6212 When the paper is finished to your satisfaction and previews/prints correctly,
6214 \begin_inset Quotes eld
6218 \begin_inset Quotes erd
6221 actions which need to be done before you submit it to the journals.
6225 \begin_layout Enumerate
6226 Export your paper as a \SpecialChar LaTeX
6229 File\SpecialChar menuseparator
6230 Export\SpecialChar menuseparator
6238 \begin_layout Enumerate
6243 file with your favorite text editor
6247 \begin_layout Enumerate
6248 remove the comment lines before the
6257 \begin_layout Enumerate
6262 usepackage...{fontenc}
6264 line if it appears (usually just after
6279 \begin_layout Enumerate
6280 remove everything between (and including) the
6292 commands, except for any commands you specifically put into the \SpecialChar LaTeX
6294 (which should appear immediately after the
6295 \begin_inset Quotes eld
6298 User specified \SpecialChar LaTeX
6300 \begin_inset Quotes erd
6311 \begin_layout Enumerate
6312 Run the resulting file through \SpecialChar LaTeX
6313 to make sure it still processes correctly.
6316 \begin_layout Enumerate
6317 Reread the journal requirements to make sure your filenames and formats
6321 \begin_layout Enumerate
6325 \begin_layout Subsubsection
6326 Comments On Specific Commands
6329 \begin_layout Standard
6330 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
6337 ) gives a good description of each.
6338 Thus it's probably easiest for me to go down the list as found in the guide
6339 and offer comments where necessary.
6340 So let's begin \SpecialChar ldots
6344 \begin_layout Paragraph
6345 Things that work as expected
6348 \begin_layout Standard
6349 Because they work as you might expect, I simply list them and the section
6450 begin{thebibliography}
6458 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6459 graphicx figure commands (2.14.1),
6483 (2.15.4, amongst other places),
6510 \begin_layout Standard
6511 The following style options also work correctly:
6532 Simply put them in the
6538 Layout\SpecialChar menuseparator
6544 \begin_layout Paragraph
6545 Things that work, but require more comment
6548 \begin_layout Standard
6549 The following items work, but require a little more discussion:
6552 \begin_layout Itemize
6553 These items are reserved for use by the journal editors, but you can put
6554 them into the \SpecialChar LaTeX
6555 preamble if you feel compelled to do so:
6588 \begin_layout Itemize
6589 These items may be placed in the \SpecialChar LaTeX
6590 preamble, and are included as blanks in
6612 \begin_layout Itemize
6619 (2.3) – can only be used
6620 \begin_inset Quotes eld
6624 \begin_inset Quotes erd
6627 , not in the middle of a paragraph.
6628 Use \SpecialChar TeX
6629 code if you need to embed it.
6632 \begin_layout Itemize
6639 (2.3) – will have extra {} after it.
6640 This should not cause an error.
6643 \begin_layout Itemize
6650 (2.6) – can only be used
6651 \begin_inset Quotes eld
6655 \begin_inset Quotes erd
6658 , not in the middle of a paragraph.
6659 Use \SpecialChar TeX
6660 code if you need to embed it.
6663 \begin_layout Itemize
6670 (2.8) – can't insert a cross-reference tag, you must type the tag name by
6674 \begin_layout Itemize
6688 \begin_layout Itemize
6695 (2.9) – will have extra {} after it.
6696 This should not cause an error.
6699 \begin_layout Itemize
6706 (2.11) – will have extra {} after it.
6707 This should not cause an error.
6710 \begin_layout Itemize
6717 (2.14.2) – you can insert an optional filename argument by placing the cursor
6718 at the beginning of the text and selecting
6720 Insert\SpecialChar menuseparator
6725 \begin_inset Quotes eld
6729 \begin_inset Quotes erd
6732 inserts an optional argument of the type needed by
6739 Hopefully it will be renamed someday.
6742 \begin_layout Itemize
6755 for the catalog ID optional parameter
6758 \begin_layout Itemize
6771 for the catalog ID optional parameter
6774 \begin_layout Paragraph
6775 Things not implemented, use \SpecialChar TeX
6779 \begin_layout Standard
6790 setcounter{equation}
6792 (2.12), Journal name abbreviations (2.13.4),
6828 (2.15.4, insert it as the first element in the lefthand cell after where
6830 Don't use any of \SpecialChar LyX
6831 's rules in the table),
6843 (2.15.5), much of Misc (2.17, except
6894 \begin_layout Paragraph
6895 Things that cannot be implemented
6898 \begin_layout Standard
6900 at least in any meaningful sort of way, so I suggest ignoring them.
6901 They are the references environment (2.13.3), and the deluxetable environment
6903 If you really, really need to use deluxetable, I suggest editing it in
6904 a separate file with a text editor, then using
6906 Insert\SpecialChar menuseparator
6908 \begin_inset space ~
6913 to include it in your \SpecialChar LyX
6916 \change_deleted 564990737 1671642564
6922 \change_inserted 564990737 1671642618
6926 File\SpecialChar menuseparator
6927 Open Example\SpecialChar menuseparator
6928 Articles\SpecialChar menuseparator
6929 American Astronomical Society
6935 \change_inserted 564990737 1671642621
6941 \begin_layout Subsubsection
6942 FAQs, Tips, Tricks, and Other Ruminations
6945 \begin_layout Paragraph
6946 Getting \SpecialChar LyX
6947 and AAS\SpecialChar TeX
6951 \begin_layout Standard
6952 It can be a bit tricky to get \SpecialChar LyX
6953 to recognize a new layout and document class.
6954 When all else fails, do this:
6957 \begin_layout Enumerate
6958 Make certain that \SpecialChar LaTeX
6959 can find AAS\SpecialChar TeX
6961 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
6963 directory completely unrelated to \SpecialChar LaTeX
6964 or AAS\SpecialChar TeX
6965 and run \SpecialChar LaTeX
6973 \begin_layout Enumerate
6978 appears in \SpecialChar LyX
6986 \begin_layout Enumerate
6989 Tools\SpecialChar menuseparator
6993 , then restart \SpecialChar LyX
6997 \begin_layout Enumerate
6998 Open a regular new file, not from a template.
6999 Does AAS\SpecialChar TeX
7000 appear in the class list in
7002 Document\SpecialChar menuseparator
7008 \begin_layout Standard
7009 If you get a warning from an existing AAS\SpecialChar TeX
7010 document about not being able
7011 to find the AAS\SpecialChar TeX
7012 layout or a message about
7013 \begin_inset Quotes eld
7016 You should not mix title layouts with normal ones
7017 \begin_inset Quotes erd
7020 , things haven't been installed correctly.
7023 \begin_layout Paragraph
7025 error processing a table
7028 \begin_layout Standard
7030 , by default, attempts to center the table caption/title.
7031 This seems to produce a bad interaction in AAS\SpecialChar TeX
7032 so you should click somewhere
7033 in the caption/title, then select
7035 Edit\SpecialChar menuseparator
7037 \begin_inset space ~
7051 This took care of it for me.
7054 \begin_layout Paragraph
7058 \begin_layout Standard
7059 A couple of things: 1) I have noticed some funny spacing in the reference
7060 entries in the text.
7061 When you enter the bibliography item data, make sure their is
7065 space between the last author and the parenthesis setting off the year;
7069 \begin_inset space \thinspace{}
7073 \begin_inset space \space{}
7087 2) Entering the references at all is not obvious.
7088 The easiest thing is to start typing your first reference at the end of
7089 the document, then mark it as type
7094 That will put a small gray box in front of what you just typed.
7095 Click on the box to fill in the rest of the information.
7096 For new references, go to the end of an existing reference and press return.
7097 That will create a new line with its own box, etc.
7100 \begin_layout Paragraph
7104 \begin_layout Standard
7105 Even though AAS\SpecialChar TeX
7106 provides its own figure commands (
7112 , for example), I much prefer \SpecialChar LaTeX
7113 's standard figure commands (with the default
7122 \begin_inset space ~
7125 commands as \SpecialChar TeX
7126 code into a Figure Float box if you desire, but I never have
7127 much luck getting the layout right.
7128 With the standard graphics, \SpecialChar LyX
7133 usepackage{graphicx}
7135 command into the \SpecialChar LaTeX
7136 preamble and handle the figures in the standard \SpecialChar LaTeX2e
7138 interspersing the figures in the text.
7139 I believe ApJ accepts figures exactly this way now; AJ might still use
7141 \begin_inset Quotes eld
7144 stack everything at the end
7145 \begin_inset Quotes erd
7151 \begin_layout Paragraph
7152 Things I could have done, but didn't
7155 \begin_layout Standard
7157 \begin_inset Quotes eld
7161 \begin_inset Quotes erd
7164 things I could have implemented, but chose not to.
7165 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
7167 even though it is double-spaced in the paper manuscript.
7168 Also, I chose not to make separate layouts for the preprint and preprint2
7170 Since I assume you will spend most of your time in the plain manuscript
7171 mode anyway, I decided not to chew up more disk space with this.
7175 \begin_layout Subsubsection
7179 \begin_layout Standard
7180 Your mileage may vary.
7181 I've now had papers published by both ApJ and AJ that have had 98% of the
7182 effort done in \SpecialChar LyX
7183 ; the last 2% was the \SpecialChar LaTeX
7184 post-processing and a few cleanups.
7185 I have had no trouble with the submission process, and I'm sure the journals
7186 were never aware that there might be a difference.
7187 So, go forth and publish!
7190 \begin_layout Subsection
7192 \change_inserted 564990737 1671442131
7198 \begin_layout Standard
7200 \change_inserted 564990737 1671642768
7206 \begin_inset space \thinspace{}
7215 document class together with the style
7219 to facilitate the description of chess games.
7223 File\SpecialChar menuseparator
7226 \SpecialChar menuseparator
7227 Articles\SpecialChar menuseparator
7246 \begin_layout Subsection
7248 \change_inserted 564990737 1671042028
7254 \begin_layout Standard
7256 \change_inserted 564990737 1671617396
7262 \begin_inset space \thinspace{}
7272 This provides the following additional environments:
7275 \begin_inset space ~
7283 \begin_inset space ~
7291 \begin_inset space ~
7309 A template is available in the menu
7314 ile\SpecialChar menuseparator
7316 \begin_inset space ~
7324 \begin_inset space ~
7329 \SpecialChar menuseparator
7330 Articles\SpecialChar menuseparator
7335 It has been customized with further environments and contains all the informati
7337 However, the documentation is also available from
7338 \begin_inset CommandInset href
7341 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
7349 \begin_layout Subsection
7351 \change_inserted 564990737 1671042046
7357 \begin_layout Standard
7359 \change_inserted 564990737 1671042046
7365 \begin_inset space \thinspace{}
7370 provides an alternative to the
7375 It provides similar functionality, but you might prefer this layout with
7376 sans serif sections, headings, and more.
7379 \begin_layout Subsection
7384 \begin_layout Standard
7390 \begin_layout Standard
7391 \begin_inset VSpace bigskip
7397 \begin_layout Standard
7402 \begin_inset space ~
7407 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
7409 \begin_inset Formula $\beta$
7412 release of May, 1999) class.
7415 \begin_layout Standard
7421 textclass, which works with Rev\SpecialChar TeX
7423 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
7425 That means that it doesn't interact very well with \SpecialChar LyX
7426 , which requires \SpecialChar LaTeX2e
7428 it has been kludged to work.
7429 Since Rev\SpecialChar TeX
7430 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
7437 \begin_inset space ~
7442 textclass should also be pretty easy to use.
7445 \begin_layout Standard
7446 These documents are supposed to be used in
7450 to the Rev\SpecialChar TeX
7451 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
7453 and assume you'll know what to put in the preamble if necessary.
7456 \begin_layout Subsubsection
7460 \begin_layout Standard
7461 All you need to do is install Rev\SpecialChar TeX
7462 4, as described in the package's README
7464 The package can be found at The Rev\SpecialChar TeX
7466 \begin_inset Flex URL
7469 \begin_layout Plain Layout
7471 http://publish.aps.org/revtex4/
7477 Install it somewhere that \SpecialChar LaTeX
7479 Test it by trying to \SpecialChar LaTeX
7480 a short Rev\SpecialChar TeX
7481 4 document in some random directory (i.
7482 \begin_inset space \thinspace{}
7486 \begin_inset space \space{}
7489 not the directory where you installed the class file.) Then, if you reconfigure
7491 , it will find the class file and let you use the Rev\SpecialChar TeX
7495 \begin_layout Standard
7496 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
7505 \begin_inset space ~
7510 template, found in the templates directory.
7513 \begin_layout Subsubsection
7517 \begin_layout Standard
7518 Optional arguments to
7525 \begin_inset Quotes eld
7529 \begin_inset Quotes erd
7533 \begin_inset Quotes eld
7537 \begin_inset Quotes erd
7543 \begin_inset space ~
7551 \begin_inset space ~
7557 Remember that in Rev\SpecialChar TeX
7558 , at least one optional argument is required!
7561 \begin_layout Standard
7562 Other preamble matter, like
7569 \begin_inset space ~
7576 \begin_inset space ~
7581 dialog, also as usual.
7584 \begin_layout Subsubsection
7588 \begin_layout Standard
7589 The layouts basically correspond to the commands in Rev\SpecialChar TeX
7591 For example, the Email layout corresponds to
7598 Note that (at least as of Rev\SpecialChar TeX
7607 layouts are exactly equivalent, so you shouldn't need to use both.
7611 \begin_layout Plain Layout
7612 In case you're curious, both were included so that
7616 would be able to translate both
7636 \begin_layout Subsubsection
7640 \begin_layout Standard
7641 There are a couple of important unique aspects of Rev\SpecialChar TeX
7643 bugs that will be even more confusing in \SpecialChar LyX
7647 \begin_layout Standard
7648 In Rev\SpecialChar TeX
7666 The \SpecialChar LyX
7667 equivalent is that there is a separate Thanks layout.
7672 write footnotes in the
7676 layout, or weird things may happen.
7677 See the Rev\SpecialChar TeX
7678 4 documentation for more details.
7681 \begin_layout Standard
7685 \begin_inset space ~
7693 \begin_inset space ~
7702 layouts must be placed
7710 layout and the corresponding
7727 , the \SpecialChar LaTeX
7731 \begin_layout Subsection
7733 \change_inserted 564990737 1671042072
7739 \begin_layout Standard
7741 \change_inserted 564990737 1671042072
7748 classes were replaced in 2013 with a completely new
7753 This package provides a \SpecialChar LaTeX
7754 class and templates for books to be published
7755 at Springer Gabler Research, Springer Vieweg Research, Springer Spektrum
7756 Research, Springer VS Research, or Springer VS Forschung.
7757 The documentation is available in German from
7758 \begin_inset CommandInset href
7761 target "http://mirrors.ctan.org/macros/latex/contrib/springer/sr-vorl/sr-vorl.pdf"
7769 \begin_layout Section
7771 \change_inserted 564990737 1670439560
7775 \begin_layout Standard
7777 \change_inserted 564990737 1670439581
7778 See also the document classes in the Collections (section
7779 \begin_inset space ~
7783 \begin_inset CommandInset ref
7785 reference "sec:Collections"
7792 \begin_layout Subsection
7796 \begin_layout Standard
7802 \begin_layout Subsubsection
7806 \begin_layout Standard
7807 Memoir is a very powerful and constantly evolving class.
7808 It has been designed with regard to fictional and non-fictional literature.
7809 Its aim is to let the user have maximum control over the typesetting of
7811 Memoir is based on the standard book class, but it can also emulate the
7812 article class (see below).
7815 \begin_layout Standard
7816 Peter Wilson, the developer of Memoir, is known as the author of lots of
7817 useful packages in the \SpecialChar LaTeX
7819 Most of them have been merged with Memoir.
7820 Therefore, it is much easier to layout the table of contents, appendices,
7821 chapter designs and such.
7823 , though, does not support all of these goodies natively.
7824 Some of them might be added to forthcoming releases
7828 \begin_layout Plain Layout
7829 You are invited to send suggestions to
7830 \begin_inset Flex URL
7833 \begin_layout Plain Layout
7835 lyx-devel@lists.lyx.org
7845 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
7847 Of course you can still use all features with the help of some native \SpecialChar LaTeX
7849 commands (\SpecialChar TeX
7854 \begin_layout Plain Layout
7859 \begin_layout Plain Layout
7869 \begin_inset space ~
7873 \begin_inset CommandInset ref
7875 reference "sec:Inserting-TeX-Code"
7885 In this section, we can only list those features that are natively supported
7888 For detailed descriptions (and for the rest of features) we recommend you
7889 have a look at the detailed manual of the Memoir class
7893 \begin_layout Plain Layout
7898 \begin_layout Plain Layout
7908 \begin_inset Flex URL
7911 \begin_layout Plain Layout
7913 CTAN:/macros/latex/memoir/memman.pdf
7923 , which is not only a user guide for the class, but also both a comprehensive
7924 description on good typesetting and a superb example for good typesetting
7928 \begin_layout Subsubsection
7929 Basic features and restrictions
7932 \begin_layout Standard
7933 Memoir supports basically all features of the standard book classes.
7934 There are, however, some differences, as follows:
7937 \begin_layout Description
7939 \begin_inset space ~
7942 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
7945 \begin_layout Description
7947 \begin_inset space ~
7950 style: The fancy page style is not supported, due to a command clash between
7951 Memoir and the fancyhdr package (they both define a command with the same
7952 name, which confuses \SpecialChar LaTeX
7954 Instead, Memoir comes with a number of its own page styles (see
7956 Document\SpecialChar menuseparator
7957 Settings\SpecialChar menuseparator
7959 \begin_inset space ~
7965 If you want to use these for the chapter pages, you have to use the command
7972 in the main text or in preamble (e.
7973 \begin_inset space \thinspace{}
7977 \begin_inset space \space{}
7984 chapterstyle{companion}
7989 \begin_layout Description
7990 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
7991 optional argument in the standard classes.
7992 With this, you can specify an alternative version of the title for the
7993 table of contents and the headers (for instance, if the title is too long).
7995 , you can do this via
7997 Insert\SpecialChar menuseparator
7999 \begin_inset space ~
8004 at the beginning of a chapter/section.
8005 Memoir features a second optional argument and thus separates the table
8006 of contents from the header.
8007 You can define three variants of a title with this: one for the main text,
8008 one for the table of contents, and one for the headers.
8010 makes these available in form of specific
8021 \begin_layout Description
8022 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
8023 of contents, the list of figures and the list of table start a new page
8025 Memoir does not follow this route.
8026 You have to insert a page break yourself, if you want to have one.
8029 \begin_layout Description
8030 Titlepage: For some unknown reason, Memoir uses pagination on the title
8031 page (in the standard classes, title pages are
8032 \begin_inset Quotes eld
8036 \begin_inset Quotes erd
8040 If you want an empty title page, type
8044 aliaspagestyle{title}{empty}
8049 \begin_layout Description
8050 Article: With the class option
8056 Document\SpecialChar menuseparator
8057 Settings\SpecialChar menuseparator
8058 Class Settings\SpecialChar menuseparator
8060 \begin_inset space ~
8065 ), you can emulate article style.
8066 That is, counters (footnotes, figures, tables etc.) will not be reset on
8067 new chapters, chapters don't start a new page (but are—in contrary to
8068 \begin_inset Quotes eld
8072 \begin_inset Quotes erd
8075 article classes—still allowed), parts, though, use their own page, as in
8079 \begin_layout Description
8080 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
8081 font commands, which have been used in the old \SpecialChar LaTeX
8083 \begin_inset space \thinspace{}
8087 \begin_inset space \space{}
8103 It produces an error and stops \SpecialChar LaTeX
8104 whenever such a command appears.
8109 reallows the commands and spits out warnings instead (which does at least
8110 not stop \SpecialChar LaTeX
8112 Since a lot of packages and particularly Bib\SpecialChar TeX
8113 style files are still using
8114 those commands, we have decided to use this option by default.
8117 \begin_layout Subsubsection
8121 \begin_layout Standard
8122 We will only describe the features supported by \SpecialChar LyX
8123 (which is not much currently).
8124 Please consult the Memoir manual
8128 \begin_layout Plain Layout
8133 \begin_layout Plain Layout
8143 \begin_inset Flex URL
8146 \begin_layout Plain Layout
8148 CTAN:/macros/latex/memoir/memman.pdf
8161 \begin_layout Description
8162 Abstract: You may wonder why an abstract is an extra feature.
8163 Well, it is in book class.
8164 Usually books don't have abstracts.
8165 Memoir, however, has.
8166 You can use it wherever and how often you like.
8169 \begin_layout Description
8170 Chapterprecis: You may know this older typesetting style: The contents of
8171 a chapter are summarized below the title and also in the table of contents
8173 \begin_inset space \thinspace{}
8177 \begin_inset space \space{}
8182 Our hero arrives in Troia; he loses some friends; he finds others
8185 Chapterprecis does exactly this.
8186 It is therefore only sensible below a chapter.
8189 \begin_layout Description
8190 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
8191 The epigraph environment provides an elegant way of typesetting such a
8193 The motto itself (text) and its (optional) author (source) are divided
8195 The author (source) can be inserted via
8197 Insert\SpecialChar menuseparator
8204 \begin_layout Description
8205 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
8206 complex figurative poems).
8208 can only support a few of them.
8209 One is poemtitle, which is a centered title for poems, which will also
8210 be added to the table of contents (verse is the standard environment for
8212 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
8214 because they have to be nested inside regular verse environments, which
8215 is not possible with \SpecialChar LyX
8219 \begin_layout Description
8220 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
8223 \begin_layout Subsection
8225 \change_inserted 564990737 1671442175
8231 \begin_layout Standard
8233 \change_inserted 564990737 1671442175
8243 \begin_inset space \thinspace{}
8248 document class but adds two environments:
8251 \begin_layout Description
8253 \change_inserted 564990737 1671442175
8256 Recipe a numbered section environment at the
8260 level which generates a bold centered heading above a double horizontal
8264 \begin_layout Description
8266 \change_inserted 564990737 1671442175
8279 are what are being described and the environment ends with a horizontal
8283 \begin_layout Standard
8285 \change_inserted 564990737 1671642866
8289 File\SpecialChar menuseparator
8290 Open Example\SpecialChar menuseparator
8291 Books\SpecialChar menuseparator
8295 illustrates its use.
8298 \begin_layout Standard
8300 \change_inserted 564990737 1671442175
8303 It is designed for typesetting one or two recipes per page, with dimensions
8305 \begin_inset Quotes qrd
8309 \begin_inset Quotes qrd
8313 The hyperlinked table of contents (ToC) and page numbers make browsing
8314 recipes convenient, and the pages can be joined together or printed 2 per
8315 page to normal letterpaper easily.
8316 The size was chosen to work in half-page 3-ring binder cover sheets, because
8317 un-laminated paper just doesn't last in the kitchen.
8320 \begin_layout Standard
8322 \change_inserted 564990737 1671442175
8325 The half-letter pages can be printed two per page using your printer driver,
8326 or bound together using
8328 pdfjam --nup 2x1 --papersize '{11in,8.5in}'
8338 is the compiled version of your recipes.
8341 \begin_layout Section
8343 \change_inserted 564990737 1671442207
8347 \begin_layout Subsection
8349 \change_inserted 564990737 1671442208
8355 \begin_layout Standard
8357 \change_inserted 564990737 1671642942
8363 \begin_inset space \space{}
8367 \begin_inset space \thinspace{}
8376 document class, an unofficial implementation of the ‘Europass CV’ recommended
8377 by the European Commission in 2013.
8381 File\SpecialChar menuseparator
8382 Open Example\SpecialChar menuseparator
8383 Curricula Vitae\SpecialChar menuseparator
8387 offers guidance on its use.
8388 Its documentation is available from
8389 \begin_inset CommandInset href
8392 target "http://mirrors.ctan.org/macros/latex/contrib/europasscv/europasscv.pdf"
8400 \begin_layout Subsection
8402 \change_inserted 564990737 1671442208
8408 \begin_layout Standard
8410 \change_inserted 564990737 1671642984
8416 \begin_inset space \space{}
8420 \begin_inset space \thinspace{}
8429 document class, an unofficial implementation of the “Europass CV” recommended
8430 by the European Commission in 2002.
8434 File\SpecialChar menuseparator
8435 Open Example\SpecialChar menuseparator
8436 Curricula Vitae\SpecialChar menuseparator
8440 offers guidance on its use.
8441 Its documentation is available from
8442 \begin_inset CommandInset href
8445 target "http://mirrors.ctan.org/macros/latex/contrib/europecv/europecv.pdf"
8453 \begin_layout Subsection
8455 \change_inserted 564990737 1671442208
8461 \begin_layout Standard
8463 \change_inserted 564990737 1671643003
8469 \begin_inset space \space{}
8473 \begin_inset space \thinspace{}
8483 This allows the creation of customizable CVs.
8487 File\SpecialChar menuseparator
8488 Open Example\SpecialChar menuseparator
8489 Curricula Vitae\SpecialChar menuseparator
8493 offers guidance on its use.
8494 Its documentation is available from
8495 \begin_inset CommandInset href
8498 target "http://mirrors.ctan.org/macros/latex/contrib/moderncv/manual/moderncv_userguide.pdf"
8506 \begin_layout Subsection
8508 \change_inserted 564990737 1671442208
8514 \begin_layout Standard
8516 \change_inserted 564990737 1671643024
8522 \begin_inset space \space{}
8526 \begin_inset space \thinspace{}
8535 document class, originally developed for use with \SpecialChar LyX
8540 File\SpecialChar menuseparator
8541 Open Example\SpecialChar menuseparator
8542 Curricula Vitae\SpecialChar menuseparator
8546 offers guidance on its use.
8547 Its documentation is available from
8548 \begin_inset CommandInset href
8551 target "http://mirrors.ctan.org/macros/latex/contrib/simplecv/simplecv.pdf"
8559 \begin_layout Section
8561 \change_inserted 564990737 1671041968
8565 \begin_layout Subsection
8567 \change_inserted 564990737 1671041970
8573 \begin_layout Standard
8575 \change_inserted 564990737 1671617528
8586 document class for writing letters according to the
8588 Deutsches Institut für Normung
8591 The file in the menu
8596 ile\SpecialChar menuseparator
8598 \begin_inset space ~
8606 \begin_inset space ~
8609 Template\SpecialChar menuseparator
8610 Letters\SpecialChar menuseparator
8613 offers guidance on its use.
8614 The documentation is available from
8615 \begin_inset CommandInset href
8618 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
8626 \begin_layout Subsection
8628 \change_inserted 564990737 1671458835
8634 \begin_layout Standard
8636 \change_inserted 564990737 1671617591
8647 document class for English letters and to create mailing labels.
8648 The file in the menu
8653 ile\SpecialChar menuseparator
8655 \begin_inset space ~
8663 \begin_inset space ~
8666 Template\SpecialChar menuseparator
8667 Letters\SpecialChar menuseparator
8668 Letter (Standard Class)
8670 offers guidance on its use.
8673 \begin_layout Section
8675 \change_inserted 564990737 1670439660
8679 \begin_layout Subsection
8681 \change_inserted 564990737 1671458922
8687 \begin_layout Standard
8689 \change_inserted 564990737 1671617655
8695 \begin_inset space \thinspace{}
8704 document class for creating presentations.
8705 The file in the menu
8710 ile\SpecialChar menuseparator
8712 \begin_inset space ~
8720 \begin_inset space ~
8723 Template\SpecialChar menuseparator
8724 Presentations\SpecialChar menuseparator
8727 offers guidance on its use.
8728 The documentation is available from
8729 \begin_inset CommandInset href
8732 target "http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf"
8740 \begin_layout Subsection
8743 Foil\SpecialChar TeX
8747 \begin_inset CommandInset label
8756 \begin_layout Standard
8762 \begin_layout Subsubsection
8766 \begin_layout Standard
8767 This section describes how to use \SpecialChar LyX
8768 to make slides for overhead projectors.
8769 There are two document classes that can do this: the default slides class
8772 Foil\SpecialChar TeX
8776 This section documents the latter.
8779 \begin_layout Standard
8780 I'm going to say this again, nice and clear, so that there's no misunderstanding
8784 \begin_layout Standard
8785 \begin_inset VSpace bigskip
8791 \begin_layout Standard
8795 This section documents the class
8796 \begin_inset Quotes eld
8804 \begin_inset Quotes erd
8812 \begin_layout Standard
8813 \begin_inset VSpace bigskip
8819 \begin_layout Standard
8820 If you're looking for the documentation for
8821 \begin_inset Quotes eld
8829 \begin_inset Quotes erd
8833 \begin_inset space ~
8837 \begin_inset CommandInset ref
8839 reference "sec:slitex"
8844 If your machine doesn't have the
8852 installed, you'll probably have to use the default
8856 class, which isn't quite as good as
8861 \begin_layout Standard
8866 class is designed for use with version
8867 \begin_inset space ~
8875 class file which is now an integral part of \SpecialChar LaTeX2e
8879 \begin_layout Subsubsection
8883 \begin_layout Standard
8884 Obviously, to use this document class, you need to select
8895 \begin_inset space ~
8901 There are some settings in the
8904 \begin_inset space ~
8909 dialog that you should know about that are specific to this class:
8912 \begin_layout Itemize
8913 Don't change the options
8924 \begin_inset space ~
8930 They're ignored by the
8937 \begin_layout Itemize
8938 The default font size is 20
8939 \begin_inset space \thinspace{}
8942 pt with the other options being 17
8943 \begin_inset space \thinspace{}
8947 \begin_inset space \thinspace{}
8951 \begin_inset space \thinspace{}
8957 \begin_layout Itemize
8966 but all math equations are still typeset in the usual roman font.
8969 \begin_layout Itemize
8972 Foil\SpecialChar TeX
8975 supports A4 and Letter paper sizes as well as a special size for working
8977 \begin_inset space \thinspace{}
8981 It doesn't support A5, B5, legal or executive paper sizes.
8984 \begin_layout Itemize
8985 Don't bother changing the
8989 settings because they are ignored anyway.
8990 All floats appear where they are defined in the text.
8993 \begin_layout Itemize
8998 setting behaves a bit differently for this class.
9001 Foil\SpecialChar TeX
9004 provides extensive footer and header capabilities including a user-defined
9007 \begin_inset space ~
9011 \begin_inset CommandInset ref
9013 reference "sec:foilfoot"
9018 The title page is treated differently to all other pages in the document
9027 has the logo centered at the bottom of the page (if one is defined).
9028 The possible page style choices and what they do are as follows:
9032 \begin_layout Labeling
9033 \labelwidthstring MMMMMMM
9040 The final output contains no page numbers, or other headers or footers
9041 (except footnotes of course).
9045 \begin_layout Labeling
9046 \labelwidthstring MMMMMMM
9053 The final output contains page numbers centered at the bottom of the page.
9054 No other headings or footers (other than footnotes).
9057 \begin_layout Labeling
9058 \labelwidthstring MMMMMMM
9063 Page numbers in lower right corner.
9064 Additional headers and footers are also shown.
9065 This is also the default.
9068 \begin_layout Labeling
9069 \labelwidthstring MMMMMMM
9074 Gives you access to the
9078 package although its use with
9080 Foil\SpecialChar TeX
9083 is discouraged by the writer of the
9085 Foil\SpecialChar TeX
9088 package because of some potential page layout clashes.
9092 \begin_layout Paragraph
9096 \begin_layout Standard
9097 The following options may be used in the extra class options in the
9099 Document\SpecialChar menuseparator
9105 \begin_layout Labeling
9106 \labelwidthstring MMMMMMx
9111 This sets up the page layout for 7.33
9112 \begin_inset space \thinspace{}
9116 \begin_inset space \thinspace{}
9119 in paper, which is about the same aspect ratio as a 35
9120 \begin_inset space \thinspace{}
9123 mm slide, making it a bit easier to work with this medium.
9126 \begin_layout Labeling
9127 \labelwidthstring MMMMMMx
9132 Places a rule across the page below the header on every page except the
9136 \begin_layout Labeling
9137 \labelwidthstring MMMMMMx
9142 Places a rule across the page above the footer on every page except the
9146 \begin_layout Labeling
9147 \labelwidthstring MMMMMMx
9152 This is automatically set each time you create a new
9159 Foil\SpecialChar TeX
9162 to use the dvips driver to rotate those pages that are set as landscape
9166 \begin_layout Labeling
9167 \labelwidthstring MMMMMMx
9172 Simply changes the page dimensions to those of a landscape page but doesn't
9174 Thus if you use this option you need to use an external program to rotate
9175 each page or feed your paper through your printer as landscape.
9176 Note that this option effectively reverses the roles of the
9184 environments (don't worry these are described in the next section).
9187 \begin_layout Labeling
9188 \labelwidthstring MMMMMMx
9193 Equation numbers on the left.
9196 \begin_layout Labeling
9197 \labelwidthstring MMMMMMx
9202 Flush-left equations.
9205 \begin_layout Subsubsection
9206 Supported Environments
9209 \begin_layout Standard
9210 Most of the environments commonly supported in other classes are also supported
9216 There are several additional environments provided by
9218 Foil\SpecialChar TeX
9221 as well as a couple added by \SpecialChar LyX
9223 The following environments are shared with other classes:
9226 \begin_layout Standard
9227 \begin_inset Flex Multiple Columns
9230 \begin_layout Itemize
9236 \begin_layout Itemize
9242 \begin_layout Itemize
9248 \begin_layout Itemize
9254 \begin_layout Itemize
9260 \begin_layout Itemize
9267 \begin_layout Itemize
9273 \begin_layout Itemize
9279 \begin_layout Itemize
9285 \begin_layout Itemize
9291 \begin_layout Itemize
9297 \begin_layout Itemize
9303 \begin_layout Itemize
9309 \begin_layout Itemize
9315 \begin_layout Itemize
9326 \begin_layout Standard
9327 That is, all the major environments apart from the sectioning environments.
9328 Since foils are essentially self-contained sections, with a title and body,
9331 Foil\SpecialChar TeX
9334 provides specific commands for starting new foils and these are:
9337 \begin_layout Itemize
9343 \begin_layout Itemize
9349 \begin_layout Standard
9351 also provides slightly modified versions of these two environments called:
9354 \begin_layout Itemize
9360 \begin_layout Itemize
9366 \begin_layout Standard
9367 and the differences will be explained in the next section.
9370 \begin_layout Standard
9371 Since foils are often used in presenting ideas or new theorems and such
9374 Foil\SpecialChar TeX
9377 also provides a comprehensive box of goodies for presenting them:
9380 \begin_layout Standard
9381 \begin_inset Flex Multiple Columns
9384 \begin_layout Itemize
9390 \begin_layout Itemize
9396 \begin_layout Itemize
9402 \begin_layout Itemize
9408 \begin_layout Itemize
9414 \begin_layout Itemize
9420 \begin_layout Itemize
9426 \begin_layout Itemize
9432 \begin_layout Itemize
9438 \begin_layout Itemize
9444 \begin_layout Itemize
9455 \begin_layout Standard
9456 The starred versions are unnumbered while the unstarred versions are numbered.
9457 There are also two list environments added by \SpecialChar LyX
9461 \begin_layout Itemize
9467 \begin_layout Itemize
9473 \begin_layout Standard
9476 Foil\SpecialChar TeX
9479 provides some powerful header and footer capabilities that are best set
9480 in the preamble although they may be set at any point in a document.
9481 If you want to change these settings in your document the best place to
9482 do so is at the very top of a foil, i.
9483 \begin_inset space \thinspace{}
9489 \begin_inset space \space{}
9494 straight after the foilhead.
9497 \begin_layout Standard
9498 For this purpose, the following command styles are provided [
9505 \begin_layout Standard
9506 \begin_inset Flex Multiple Columns
9509 \begin_layout Itemize
9513 \begin_inset space ~
9519 \begin_layout Itemize
9525 \begin_layout Itemize
9529 \begin_inset space ~
9535 \begin_layout Itemize
9539 \begin_inset space ~
9545 \begin_layout Itemize
9549 \begin_inset space ~
9556 \begin_layout Plain Layout
9557 \begin_inset space ~
9569 \begin_layout Standard
9570 There are also a few commands provided by
9572 Foil\SpecialChar TeX
9575 that aren't directly supported by \SpecialChar LyX
9576 but I'll tell you what they do and how
9577 to use them in section
9578 \begin_inset space ~
9582 \begin_inset CommandInset ref
9584 reference "sec:unsuppfoils"
9591 \begin_layout Subsubsection
9592 Building a Set of Foils
9595 \begin_layout Standard
9596 This section will give a simple introduction to using the different environments
9597 to build a set of foils.
9598 If you want to see an example set of foils, take a look at
9599 \change_deleted 564990737 1671643085
9604 file you find in \SpecialChar LyX
9610 \change_inserted 564990737 1671643099
9614 File\SpecialChar menuseparator
9617 \SpecialChar menuseparator
9618 Presentations\SpecialChar menuseparator
9626 \begin_layout Paragraph
9627 Give It a Title Page
9630 \begin_layout Standard
9631 Unlike other classes that provide
9651 creates the title on a page of its own.
9652 If you leave out the
9656 environment \SpecialChar LaTeX
9657 will substitute the current date (every time you regenerate
9661 \begin_layout Paragraph
9665 \begin_layout Standard
9666 As I mentioned earlier, there are four ways of starting a new foil.
9667 For portrait foils you should use
9676 The difference between these two environments is the amount of space between
9677 the title of the foil (the foilhead) and the body of the foil.
9680 \begin_layout Standard
9681 Landscape foils are generated using the
9690 Again the only difference is the spacing between foilhead and body.
9691 Both of the short versions have 0.5
9692 \begin_inset space ~
9695 inches less separation between the foilhead and the body.
9699 \begin_layout Standard
9700 One problem with the support for landscape foils is the requirement that
9705 driver to generate the PostScript output otherwise the foils won't be rotated.
9706 It is possible to get landscape foils even if you haven't got the
9710 driver provided you can feed your foils sideways through your printer ;-)
9713 \begin_layout Paragraph
9714 Theorems, Lemmas, Proofs and more
9717 \begin_layout Standard
9718 You can't have two of the same type of these environments directly following
9720 If you use a normal paragraph break, , you will just be extending the previous
9721 environment as if you had merged the two environments together.
9722 Rather than that, you need to insert a so-called separator.
9723 Please refer to the section entitled
9734 \begin_layout Paragraph
9738 \begin_layout Standard
9739 You get all the commonly supported list styles found in other classes as
9740 well as two new ones.
9741 I'll only describe the new ones here.
9742 If you want to find out more about the other list environments check out
9748 If you intend to use itemized lists you might also want to read about the
9752 \begin_inset space ~
9756 \begin_inset space ~
9761 dialog described above in section
9762 \begin_inset space ~
9766 \change_inserted 564990737 1671355684
9768 \begin_inset CommandInset ref
9770 reference "chap:bullets"
9775 \change_deleted 564990737 1671355684
9777 \begin_inset CommandInset ref
9779 reference "sec:bullet"
9788 \begin_layout Standard
9789 The two new list styles,
9797 , are designed to make it easier for you to create lists of do's and don'ts
9798 or right and wrong by providing dedicated environments that use a tick
9799 or a cross as the label of the list.
9800 These lists are in fact dedicated variants of the
9805 They do however require that you have the
9812 \begin_layout Paragraph
9816 \begin_layout Standard
9819 Foil\SpecialChar TeX
9822 redefines the floating tables and figures so that they appear exactly where
9823 they are in the text rather than pushing them to the top of the page or
9824 to some user specified location.
9825 In fact if you change the float placement settings they are simply ignored.
9828 \begin_layout Paragraph
9829 Page Headers and Footers
9830 \begin_inset CommandInset label
9839 \begin_layout Standard
9843 \begin_inset space ~
9852 are two commands used to control the left-footer text string.
9853 The first is meant to allow you to include a graphic logo on your foils
9855 \begin_inset Quotes eld
9860 Foil\SpecialChar TeX
9864 \begin_inset Quotes erd
9868 While the second is meant to provide a classification for the audience,
9872 \begin_inset space \thinspace{}
9878 \begin_inset space \space{}
9882 It is empty by default.
9885 \begin_layout Standard
9886 The remaining page corners can be filled by
9889 \begin_inset space ~
9894 (which defaults to page numbers),
9897 \begin_inset space ~
9905 \begin_inset space ~
9913 \begin_layout Subsubsection
9916 Foil\SpecialChar TeX
9920 \begin_inset CommandInset label
9922 name "sec:unsuppfoils"
9929 \begin_layout Standard
9930 All the commands mentioned below need to be set in a
9940 within another environment.
9943 \begin_layout Paragraph
9947 \begin_layout Standard
9948 All lengths are adjusted using the
9971 should be replaced by the name given to the length you want to change and
9976 is the length value.
9977 All lengths should be specified in units of length such as inches (
9989 ) or relative to some document or font-based length such as
9999 \begin_layout Standard
10000 It's possible to change the spacing between a foilhead and the body of the
10001 foil by adjusting the length specified by
10008 For example, to make
10013 \begin_inset space \space{}
10016 in closer to their bodies put the following in the preamble:
10022 foilheadskip}{-0.5in}
10025 \begin_layout Standard
10026 The spacings around floats can be adjusted by setting these lengths:
10029 \begin_layout Labeling
10030 \labelwidthstring MMMMMMMMMMM
10037 Separation between the text and the top of the float
10040 \begin_layout Labeling
10041 \labelwidthstring MMMMMMMMMMM
10048 Separation between the float and the caption
10051 \begin_layout Labeling
10052 \labelwidthstring MMMMMMMMMMM
10059 Separation between the caption and the following text
10062 \begin_layout Labeling
10063 \labelwidthstring MMMMMMMMMMM
10070 You can make the captions narrower than the surrounding text by adjusting
10072 Best done relative to
10081 \begin_layout Standard
10082 There are also several title page related lengths that you may find useful
10083 if you have a long title or several authors:
10086 \begin_layout Labeling
10087 \labelwidthstring MMMMMMMMMMM
10094 Separation from headers to
10099 \begin_layout Labeling
10100 \labelwidthstring MMMMMMMMMMM
10118 \begin_layout Labeling
10119 \labelwidthstring MMMMMMMMMMM
10133 \begin_layout Labeling
10134 \labelwidthstring MMMMMMMMMMM
10150 \begin_layout Labeling
10151 \labelwidthstring MMMMMMMMMMM
10167 \begin_layout Standard
10168 The last length related command affects all the list environments.
10179 a list environment then all the vertical spacing between the list items
10181 Note that this is a command not a length so it doesn't require
10187 like the stuff mentioned above.
10190 \begin_layout Paragraph
10191 Headers and Footers
10194 \begin_layout Standard
10207 commands control whether the logo in the
10211 definition appear on a given page.
10218 in the preamble then none of the foils will have the logo on them.
10219 If you don't want the logo on a particular page place the
10225 directly after the foilhead of that page and the
10231 directly after the next foilhead.
10234 \begin_layout Standard
10235 If you decide to use the
10239 page style setting in the
10242 \begin_inset space ~
10247 dialog you should probably add
10257 to your preamble so headers and footers on landscape pages are correctly
10258 placed when rotated.
10259 This is due to some clashes between the page layouts provided by the
10270 \begin_layout Subsection
10272 \change_inserted 564990737 1671459032
10278 \begin_layout Standard
10280 \change_inserted 564990737 1671643165
10286 \begin_inset space \thinspace{}
10295 document class for creating presentations.
10299 File\SpecialChar menuseparator
10300 Open Example\SpecialChar menuseparator
10301 Presentations\SpecialChar menuseparator
10305 offers guidance on its use.
10306 The documentation is available from
10307 \begin_inset CommandInset href
10310 target "http://mirrors.ctan.org/macros/latex/contrib/powerdot/doc/powerdot.pdf"
10318 \begin_layout Subsection
10320 \change_inserted 564990737 1671459032
10323 \begin_inset CommandInset label
10325 name "subsec:Seminar"
10334 \begin_layout Standard
10336 \change_inserted 564990737 1671643194
10342 \begin_inset space \thinspace{}
10351 document class for creating presentations.
10355 File\SpecialChar menuseparator
10356 Open Example\SpecialChar menuseparator
10357 Presentations\SpecialChar menuseparator
10361 offers guidance on its use.
10362 The documentation is available from
10363 \begin_inset CommandInset href
10366 target "http://mirrors.ctan.org/macros/latex/contrib/seminar/doc/seminar-doc.pdf"
10374 \begin_layout Subsection
10377 Sli\SpecialChar TeX
10381 \begin_inset CommandInset label
10390 \begin_layout Standard
10398 \begin_layout Subsubsection
10402 \begin_layout Standard
10403 This section describes how to use \SpecialChar LyX
10404 to make slides for overhead projectors.
10405 There are two document classes that can do this: the default slides class
10408 Foil\SpecialChar TeX
10412 This section documents the former.
10415 \begin_layout Standard
10416 I'm going to say this again, nice and clear, so that there's no misunderstanding
10420 \begin_layout Standard
10421 \begin_inset VSpace bigskip
10427 \begin_layout Standard
10431 This section documents the class
10432 \begin_inset Quotes eld
10440 \begin_inset Quotes erd
10448 \begin_layout Standard
10449 \begin_inset VSpace bigskip
10455 \begin_layout Standard
10456 If you're looking for the documentation for
10457 \begin_inset Quotes eld
10462 slides (Foil\SpecialChar TeX
10466 \begin_inset Quotes erd
10469 , check out section
10470 \begin_inset space ~
10474 \begin_inset CommandInset ref
10476 reference "sec:foiltex"
10486 \begin_inset Quotes eld
10491 slides (Foil\SpecialChar TeX
10495 \begin_inset Quotes erd
10498 ] is actually somewhat better than the default
10506 \begin_layout Plain Layout
10508 or so I've been told repeatedly by its advocates.
10509 Having never used it, I have no idea if this claim is true or not.
10514 which this section documents.
10517 \begin_layout Standard
10518 This class is the \SpecialChar LaTeX2e
10519 improvement of the old
10521 Sli\SpecialChar TeX
10525 Every \SpecialChar LaTeX2e
10526 distribution includes this class [which I'll just refer to as
10527 \begin_inset Quotes eld
10535 \begin_inset Quotes erd
10538 from now on], so you're bound to have it.
10539 As I noted earlier, there are other classes, such as
10543 , which also produce slides for overhead projectors and do a better job
10545 However, there are some things which
10549 can do which the others can't, such as generate overlays.
10550 Read on to learn more!
10553 \begin_layout Subsubsection
10555 \begin_inset CommandInset label
10557 name "sec:slidesetup"
10564 \begin_layout Standard
10565 Obviously, to use this document class, you need to select
10566 \begin_inset Quotes eld
10574 \begin_inset Quotes erd
10577 from the class list in the
10579 Document\SpecialChar menuseparator
10583 There are some other special things you should know about this class:
10586 \begin_layout Itemize
10587 Don't bother changing the options
10592 They're not supported by the
10599 \begin_layout Itemize
10603 \begin_inset space ~
10608 behaves a bit differently for this class.
10609 The possible choices and what they do are as follows:
10613 \begin_layout Description
10618 The final output contains page numbers in the lower right corner.
10621 \begin_layout Description
10630 , but also prints out any time markers you've put in.
10631 This is the default.
10634 \begin_layout Description
10639 The final output contains no page numbers, time markers, or alignment markers.
10643 \begin_layout Itemize
10648 class has an extra option:
10654 \begin_inset Quotes eld
10662 \begin_inset Quotes erd
10665 in the extra class options.
10669 \begin_layout Standard
10670 Using this options allows you to add time markers to
10676 \begin_inset space ~
10680 \begin_inset CommandInset ref
10682 reference "sec:slideNote"
10690 \begin_layout Standard
10691 You can also use the template file
10692 \change_deleted 564990737 1671617694
10694 \begin_inset Quotes eld
10702 \begin_inset Quotes erd
10707 to automatically set up a document to use the
10712 \change_deleted 564990737 1671617699
10717 File\SpecialChar menuseparator
10719 \begin_inset space ~
10723 \begin_inset space ~
10727 \change_inserted 564990737 1671617723
10728 \SpecialChar menuseparator
10729 Presentations\SpecialChar menuseparator
10734 to open your new document
10735 \change_deleted 564990737 1671617728
10739 The template file also contains some examples of the special paragraph
10740 environments used by this class.
10741 I'll describe those next.
10744 \begin_layout Subsubsection
10745 Paragraph Environments
10748 \begin_layout Paragraph
10749 Supported Environments
10752 \begin_layout Standard
10753 The first thing you'll notice when you start up a new
10757 document is the font size and type: it's the equivalent of the size
10758 \begin_inset Quotes eld
10766 \begin_inset Quotes erd
10772 \begin_inset space ~
10778 This is also what's used in the output.
10780 \begin_inset Quotes eld
10784 \begin_inset Quotes erd
10787 to remind you that this is a slide.
10788 Your final slides will use a larger font; ergo, you'll have less space.
10789 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
10792 \begin_layout Standard
10793 The next thing that becomes obvious is the changes to the paragraph environment
10794 pull-down box [at the far-left end of the toolbar].
10795 Most of the paragraph environments you're used to seeing are missing.
10796 There are also five new ones.
10801 class itself only supports certain paragraph environments:
10804 \begin_layout Itemize
10810 \begin_layout Itemize
10816 \begin_layout Itemize
10822 \begin_layout Itemize
10828 \begin_layout Itemize
10834 \begin_layout Itemize
10840 \begin_layout Itemize
10846 \begin_layout Itemize
10852 \begin_layout Itemize
10858 \begin_layout Itemize
10865 \begin_layout Standard
10866 All of the other standard environments, including the section-heading environmen
10867 ts, aren't used in the
10874 \begin_layout Standard
10875 On the other hand, you'll notice the following new environments:
10878 \begin_layout Itemize
10884 \begin_layout Itemize
10890 \begin_layout Itemize
10896 \begin_layout Itemize
10902 \begin_layout Itemize
10908 \begin_layout Standard
10909 These five are kind of quirky, due to a
10910 \begin_inset Quotes eld
10914 \begin_inset Quotes erd
10917 in \SpecialChar LyX
10919 You see, \SpecialChar LyX
10920 doesn't permit you to nest any other paragraph environment into
10921 an empty environment.
10922 Now, that's fine and dandy, but it means that you wouldn't be able to start
10923 a slide with anything except plain text.
10924 To deal with this, I've performed a little
10925 \begin_inset Quotes eld
10930 \begin_inset Quotes erd
10936 \begin_layout Paragraph
10937 Quirks of the New Environments
10938 \begin_inset CommandInset label
10940 name "sec:slideQuirk"
10947 \begin_layout Standard
10948 All five of the new paragraph environments are somewhat quirky due to inherent
10949 limitiations in the current version of \SpecialChar LyX
10951 As I just mentioned, \SpecialChar LyX
10952 forbids environments that begin with another environment.
10953 To get around this, the
10957 environment isn't a paragraph environment as described in the
10965 \begin_layout Standard
10966 You should consider
10979 \begin_inset Quotes eld
10982 pseudo-environments.
10983 \begin_inset Quotes erd
10986 They look like a section heading or a
10987 \begin_inset Quotes eld
10995 \begin_inset Quotes erd
10998 but really begin a [and, if necessary, end the previous] paragraph environment.
11008 \begin_inset Quotes eld
11012 \begin_inset Quotes erd
11015 These two perform some action.
11018 \begin_layout Standard
11019 A common feature of all five environments,
11039 , is a rather long-ish label.
11040 The text following this label — ordinarily the contents of the paragraph
11041 environment — is utterly irrelevant for
11063 completely ignores it.
11064 In fact, you can leave these five environments completely empty.
11068 \begin_layout Standard
11073 to put any text after the rather long-ish label, you might want to.
11074 This could be a short description of the contents of the
11079 In that case, enter your descriptive comment and hit
11083 as you normally would.
11086 \begin_layout Standard
11087 If, on the other hand, you don't want to enter any descriptive text, you'll
11088 hit another \SpecialChar LyX
11091 , like nature, abhors a vacuum, and will not let you start a new paragraph
11092 environment until you put something in the old one.
11096 \begin_layout Itemize
11097 Start entering the text that will
11125 \begin_layout Itemize
11126 Now move to the beginning of that paragraph.
11130 \begin_layout Itemize
11139 \begin_layout Itemize
11140 Finally, change this new, empty paragraph to a
11164 \begin_layout Standard
11165 Some future version of \SpecialChar LyX
11166 will, hopefully, resolve this quirkiness\SpecialChar ldots
11170 \begin_layout Subsubsection
11171 Making a Presentation with
11184 \begin_layout Paragraph
11192 \begin_layout Standard
11193 If you're expecting this section to teach you how to actually make a presentatio
11194 n, you'll be sorely disappointed.
11195 Naturally, I'll describe all of the ways the
11199 class can assist you in preparing the materials for a presentation.
11200 Filling in the contents, however, is up to you.
11205 the \SpecialChar LyX
11209 \begin_layout Standard
11214 environment [in the manner described in section
11215 \begin_inset space ~
11219 \begin_inset CommandInset ref
11221 reference "sec:slideQuirk"
11225 ] tells \SpecialChar LyX
11226 to begin a new slide [duh].
11227 The label for this environment/
11228 \begin_inset Quotes erd
11232 \begin_inset Quotes erd
11236 \begin_inset Quotes eld
11240 \begin_inset Quotes erd
11243 in cool blue, followed by the label,
11244 \begin_inset Quotes eld
11248 \begin_inset Quotes erd
11252 Any text or paragraph environments that follow this one go on the new slide.
11256 \begin_layout Standard
11257 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
11259 (this can be specified in the
11264 In fact, you'll want to, once you finish entering the contents of one slide.
11265 If you've entered more text than can physically fit on a slide, the extra
11266 overflows onto a new slide.
11267 I don't recommend doing this, however, since the overflow slide won't have
11268 any page number on it.
11269 Furthermore, it may interfere with any
11273 you've made to accompany the oversized
11280 \begin_layout Standard
11289 environments work the same way as the
11294 They both create an
11295 \begin_inset Quotes eld
11299 \begin_inset Quotes erd
11302 followed by a label [
11303 \begin_inset Quotes eld
11307 \begin_inset Quotes erd
11311 \begin_inset Quotes eld
11315 \begin_inset Quotes erd
11319 The color is a stunning magenta instead of blue, and the
11320 \begin_inset Quotes eld
11324 \begin_inset Quotes erd
11327 will look different, in style and in length.
11328 The label fonts of all three also differ from one another.
11331 \begin_layout Standard
11336 , if the contents of a
11344 exceed the physical size of a slide or sheet of paper, the extra will overflow
11346 Again, you should avoid this.
11347 It defeats the whole purpose of
11358 \begin_layout Paragraph
11368 \begin_layout Standard
11373 is a slide that sits atop another slide.
11374 Perhaps you wish to discuss a figure on the main
11378 before displaying the text associated with it.
11379 One way to accomplish this is tape a flap of dark paper over the part of
11384 you want to display later.
11385 This method fails, however, if you wish to overlap one graph with another,
11387 You would then have to fumble while speaking to align the two separate,
11392 s to align the two graphs.
11397 environment in both cases makes life much easier.
11400 \begin_layout Standard
11405 receives the page number of its
11406 \begin_inset Quotes eld
11410 \begin_inset Quotes erd
11418 \begin_inset Quotes eld
11426 \begin_inset Quotes erd
11433 \begin_layout Plain Layout
11434 Presumably, mutliple
11439 \begin_inset Quotes eld
11447 \begin_inset Quotes erd
11451 \begin_inset Quotes eld
11459 \begin_inset Quotes erd
11463 \begin_inset Quotes eld
11471 \begin_inset Quotes erd
11475 \begin_inset space ~
11478 appended to the page number of the parent
11488 Clearly, you want the contents of both the
11496 to each fit on a single physical slide! You should probably consider an
11502 \begin_inset Quotes eld
11506 \begin_inset Quotes erd
11514 Indeed, the \SpecialChar LyX
11519 class provides a visual cue for this: the label at the start of an
11523 is shorter than that at the start of a
11528 Lastly, when you generate printable output, you'll find alignment markers
11529 in all four corners of both the
11533 page and its parent
11538 These will assist you in lining up the two physical slides.
11541 \begin_layout Standard
11542 The major problem in overlaying two slides is aligning the contents of the
11543 two transparencies.
11544 How much space should you leave for that graph on the second slide? Worse
11545 still, what if you want a graph and a sentence on second slide, but there
11546 is text on the main transparency that goes in between them? You could try
11547 and insert vertical space of the right size.
11548 The better way is to use
11559 \begin_layout Standard
11560 As their names imply,
11568 are two command-like paragraph environments that make all subsequent text
11569 invisible and visible, respectively.
11571 \begin_inset space ~
11575 \begin_inset CommandInset ref
11577 reference "sec:slideQuirk"
11581 that you don't place anything
11585 these two environments, however.
11590 , it inserts a centered, sky-blue label into the page reading
11591 \begin_inset Quotes eld
11594 <Invisible Text Follows>
11595 \begin_inset Quotes erd
11599 For paragraphs following this label, the parts of the
11607 ; it doesn't matter which] where they would be contain instead blank space.
11611 \begin_layout Standard
11616 , the corresponding centered label is
11617 \begin_inset Quotes eld
11620 <Visible Text Follows>
11621 \begin_inset Quotes erd
11625 Paragraphs following this label behave normally.
11626 Note that the beginning of a new
11638 automatically shuts off an
11643 It's therefore not necessary to use
11654 \begin_layout Standard
11655 By now, it should be obvious how to create overlay transparencies using
11656 the proper combination of
11675 \begin_layout Enumerate
11680 , including everything that will appear on it, whether on the main slide
11688 \begin_layout Enumerate
11689 Before each figure or paragraph that will appear only on the
11698 If necessary, insert a
11702 environment after the
11709 \begin_layout Enumerate
11714 immediately following the
11721 \begin_layout Enumerate
11722 Copy the contents of this
11733 \begin_layout Enumerate
11738 , change all of the
11749 \begin_layout Standard
11751 You've just made an
11758 \begin_layout Standard
11759 There's one problem with the way I've designed the \SpecialChar LyX
11764 class: you can't make text in the middle of a paragraph invisible, nor
11765 make text in the middle of an invisible paragraph visible again.
11766 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
11771 \begin_layout Plain Layout
11772 The commands of interest are:
11775 \begin_layout Itemize
11780 invisible \SpecialChar ldots
11784 \begin_layout Itemize
11789 visible \SpecialChar ldots
11793 \begin_layout Plain Layout
11795 and need to be marked as \SpecialChar TeX
11798 \begin_inset Quotes eld
11802 \begin_inset Quotes erd
11805 you wish to change goes in between the brackets [and after the
11818 If you don't know how to mark text as \SpecialChar TeX
11819 , see the appropriate section of
11832 \begin_layout Paragraph
11842 \begin_inset CommandInset label
11844 name "sec:slideNote"
11851 \begin_layout Standard
11860 is associated with a
11861 \begin_inset Quotes eld
11865 \begin_inset Quotes erd
11873 Here, too, the \SpecialChar LyX
11878 class provides visual cues.
11883 is shorter than that of a
11887 [yet longer than that of an
11891 ] and, like the label of an
11895 is shockingly magenta.
11896 Additionally, the printed
11900 has the page number of its
11901 \begin_inset Quotes eld
11905 \begin_inset Quotes erd
11913 \begin_inset Quotes eld
11921 \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 You can have multiple
11953 s associated with a single
11965 , you'll probably want to break up long
11969 s so that they fit on a single sheet of paper.
11972 \begin_layout Standard
11977 is obvious: it contains anything additional you might want to say about
11983 It could also be used as a sheet of reminders for a particular
11988 In the case of the latter, you might want to make use of time markers.
11989 Currently, the \SpecialChar LyX
11995 \begin_inset Quotes eld
11999 \begin_inset Quotes erd
12002 support for time markers, a
12004 Sli\SpecialChar TeX
12008 So, you'll have to resort to using the \SpecialChar LaTeX
12012 \begin_layout Standard
12013 To use time markers, you'll need to specify the extra class option
12014 \begin_inset Quotes eld
12022 \begin_inset Quotes erd
12026 \begin_inset space ~
12030 \begin_inset CommandInset ref
12032 reference "sec:slidesetup"
12037 This option turns on timing marks, which will appear in the lower-left-hand
12043 To set what appears in the time marker, you use the \SpecialChar LaTeX
12045 \begin_inset Quotes eld
12055 \begin_inset Quotes erd
12059 \begin_inset Quotes eld
12069 \begin_inset Quotes erd
12073 The arguments of both commands are time measured in seconds.
12075 \begin_inset Quotes eld
12085 \begin_inset Quotes erd
12088 sets the time marker to a given time.
12090 \begin_inset Quotes eld
12100 \begin_inset Quotes erd
12103 increments the time marker by the specified amount.
12104 Using time markers and
12108 s in this fashion, you can remind yourself how much time to spend on a particula
12116 \begin_layout Standard
12117 There's one last feature to describe.
12118 Clearly, you'd like to print out all of your
12126 s on transparencies while printing all of your
12143 with which it is associated.
12144 What's a person to do?
12147 \begin_layout Standard
12148 Luckily, there are two \SpecialChar LaTeX
12149 commands that allow you to select what to print
12151 Both must be placed into the preamble of your document.
12153 \begin_inset Quotes eld
12165 \begin_inset Quotes erd
12168 will cause the output to contain only the
12177 Correspondingly, the command
12178 \begin_inset Quotes eld
12190 \begin_inset Quotes erd
12193 prevents the output of anything but
12198 I'd advise placing both commands in the preamble and initially comment
12200 You can then preview your entire presentation as you write.
12201 When you're done writing, you can then uncomment one of the two to select
12202 what you want to print.
12203 I like to uncomment
12204 \begin_inset Quotes eld
12216 \begin_inset Quotes erd
12219 , print to a file with
12220 \begin_inset Quotes eld
12228 \begin_inset Quotes erd
12231 in its name, comment it back out, then uncomment
12232 \begin_inset Quotes eld
12244 \begin_inset Quotes erd
12248 \begin_inset Quotes eld
12256 \begin_inset Quotes erd
12260 I can then send either file to a printer, loading transparencies or plain
12261 paper as appropriate.
12264 \begin_layout Standard
12265 You can also provide other arguments to the
12266 \begin_inset Quotes eld
12276 \begin_inset Quotes erd
12280 \begin_inset Quotes eld
12290 \begin_inset Quotes erd
12294 See a good \SpecialChar LaTeX
12298 \begin_layout Subsubsection
12303 Class Template File
12306 \begin_layout Standard
12307 I have also provided a template file
12308 \change_deleted 564990737 1671617750
12310 \begin_inset Quotes eld
12318 \begin_inset Quotes erd
12328 To use it, begin your new presentation with
12330 File\SpecialChar menuseparator
12332 \begin_inset space ~
12336 \begin_inset space ~
12340 \change_inserted 564990737 1671616988
12341 \SpecialChar menuseparator
12342 Presentations\SpecialChar menuseparator
12348 Your new \SpecialChar LyX
12349 presentation file will contain an example
12370 additionally contain an example of the use of
12379 Lastly, the preamble will contain:
12382 \begin_layout LyX-Code
12383 % Uncomment to print out only slides and overlays
12386 \begin_layout LyX-Code
12390 \begin_layout LyX-Code
12396 \begin_inset Newline newline
12402 \begin_layout LyX-Code
12403 % Uncomment to print out only notes
12406 \begin_layout LyX-Code
12410 \begin_layout LyX-Code
12418 \begin_layout Standard
12419 One final thing: I created this class to support the \SpecialChar LaTeX2e
12421 \begin_inset Quotes eld
12426 Sli\SpecialChar TeX
12430 \begin_inset Quotes erd
12433 class, one of the built-in \SpecialChar LaTeX2e
12435 Neither I nor the rest of the \SpecialChar LyX
12436 Team endorse or oppose the use of this built-in
12438 It's here if you want it or need it.
12439 There exist other \SpecialChar LaTeX2e
12440 classes for creating presentations, such as the
12445 \begin_inset space ~
12449 \begin_inset CommandInset ref
12451 reference "sec:foiltex"
12456 \begin_inset Quotes eld
12464 \begin_inset Quotes erd
12467 package [present on some \SpecialChar TeX
12469 The latter is not yet supported under \SpecialChar LyX
12474 \begin_layout Plain Layout
12475 Perhaps you can take on the task\SpecialChar ldots
12481 I know nothing about these other classes.
12482 Try them out to see what sort of alternative they provide.
12485 \begin_layout Section
12487 \change_inserted 564990737 1670439661
12491 \begin_layout Subsection
12493 \change_inserted 564990737 1670439661
12497 \begin_layout Standard
12499 \change_inserted 564990737 1670439661
12508 document class for preparing reports.
12513 document class, this provides parts, chapters and sections but does not
12514 provide the paragraph styles needed for a book; like the
12518 document class, it provides the abstract paragraph style.
12519 In two-sided mode, it does not start a new chapter on the right hand page.
12522 \begin_layout Standard
12524 \change_inserted 564990737 1670439674
12529 document classes are described in the Collections (section
12530 \begin_inset space ~
12534 \begin_inset CommandInset ref
12536 reference "sec:Collections"
12543 \begin_layout Section
12545 \change_inserted 564990737 1670439674
12549 \begin_layout Subsection
12553 \begin_layout Standard
12559 \begin_layout Subsubsection
12563 \begin_layout Standard
12564 Broadway is for writing plays.
12565 The format is more decorative than Hollywood, and much less standardized.
12566 This format should be suitable for workshops.
12569 \begin_layout Subsubsection
12573 \begin_layout Standard
12574 The same as in Hollywood.
12577 \begin_layout Subsubsection
12581 \begin_layout Standard
12586 names as labels then cross-reference the label to insert the name.
12587 The cross-reference dialog will show the current cast of characters.
12590 \begin_layout Subsubsection
12591 Paper size and Margins
12594 \begin_layout Standard
12595 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12598 \begin_layout Subsubsection
12602 \begin_layout Standard
12603 The following environments are available.
12604 You can use broadway.bind to get the bind keys shown at the right.
12607 \begin_layout Itemize
12611 \begin_inset Newline newline
12616 You should not have to use this, but it is here for anything that does not
12620 \begin_layout Itemize
12624 \begin_inset space \hfill{}
12628 \begin_inset Newline newline
12633 Used to describe stage setting and the action.
12634 First use of speaker names in all CAPs.
12637 \begin_layout Itemize
12641 \begin_inset space \hfill{}
12645 \begin_inset Newline newline
12650 Automatically numbered.
12651 On screen it will be arabic, but will print as Roman.
12654 \begin_layout Itemize
12658 \begin_inset space \hfill{}
12662 \begin_inset Newline newline
12672 It is just centered text.
12675 \begin_layout Itemize
12679 \begin_inset space \hfill{}
12683 \begin_inset Newline newline
12688 Not automatically numbered.
12689 You supply the number.
12690 This is because I couldn't figure out how.
12693 \begin_layout Itemize
12697 \begin_inset space \hfill{}
12701 \begin_inset Newline newline
12706 A special case of Narrative to describe the setting and action as the curtain
12710 \begin_layout Itemize
12714 \begin_inset space \hfill{}
12718 \begin_inset Newline newline
12723 The speaker's (actor's) title, centered in all CAPS.
12726 \begin_layout Itemize
12730 \begin_inset space \hfill{}
12734 \begin_inset Newline newline
12739 Instructions to the speaker.
12740 The parentheses are automatically inserted.
12741 The ( will appear on screen, but both will be in the printed play.
12742 This environment is only used within
12749 \begin_layout Itemize
12753 \begin_inset space \hfill{}
12757 \begin_inset Newline newline
12762 What the Speaker says.
12765 \begin_layout Itemize
12769 \begin_inset space \hfill{}
12773 \begin_inset Newline newline
12778 The curtain comes down.
12781 \begin_layout Itemize
12785 \begin_inset space \hfill{}
12791 \begin_layout Itemize
12795 \begin_inset space \hfill{}
12801 \begin_layout Itemize
12805 \begin_inset space \hfill{}
12811 \begin_layout Standard
12815 \begin_layout Subsection
12816 Hollywood (Hollywood spec scripts)
12819 \begin_layout Standard
12825 \begin_layout Subsubsection
12829 \begin_layout Standard
12830 Getting the format of a Hollywood script right is a
12831 \begin_inset Quotes eld
12835 \begin_inset Quotes erd
12838 It is designed to make the readers focus on content and to be easy and
12839 familiar for the actors to read.
12840 Each page of a script should be one minute of film.
12841 Nothing goes in a script that you cannot see or hear on screen.
12842 The courier 12 pt font should be used throughout.
12846 \begin_layout Subsubsection
12850 \begin_layout Standard
12851 Speakers' lines should NEVER break in mid-sentence.
12852 If a speaker's lines continue over a page break, repeat the
12856 title followed by (Cont'd).
12859 \begin_layout Subsubsection
12863 \begin_layout Standard
12868 names as labels then cross-reference the label to insert the name.
12869 The cross-reference dialog will show the current cast of characters.
12870 You can use this to insert the speaker name in narratives also.
12873 \begin_layout Subsubsection
12874 Paper size and Margins
12877 \begin_layout Standard
12878 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12881 \begin_layout Subsubsection
12885 \begin_layout Standard
12886 The following environments are available.
12887 You can use hollywood.bind to get the bind keys shown at the right.
12890 \begin_layout Itemize
12894 \begin_inset Newline newline
12899 Used where nothing else works.
12903 \begin_layout Itemize
12909 \begin_inset space \hfill{}
12917 \begin_inset Newline newline
12920 Usually followed by something like
12921 \begin_inset Quotes eld
12924 on Sally waking up.
12925 \begin_inset Quotes erd
12931 \begin_layout Itemize
12935 \begin_inset space \hfill{}
12939 \begin_inset Newline newline
12944 Introduces a new INTERIOR camera set-up.
12945 Always followed by DAY or NIGHT, or something similar to define the lighting
12947 Everthing on this line in CAPS.
12950 \begin_layout Itemize
12954 \begin_inset space \hfill{}
12958 \begin_inset Newline newline
12963 Introduces a new EXTERIOR camera set-up.
12964 Everthing on this line in CAPS.
12967 \begin_layout Itemize
12971 \begin_inset space \hfill{}
12975 \begin_inset Newline newline
12980 The character speaking.
12983 \begin_layout Itemize
12987 \begin_inset space \hfill{}
12991 \begin_inset Newline newline
12996 Instructions to the speaker.
12997 The () are automatically inserted.
13000 \begin_layout Itemize
13004 \begin_inset space \hfill{}
13008 \begin_inset Newline newline
13020 \begin_layout Itemize
13024 \begin_inset space \hfill{}
13028 \begin_inset Newline newline
13033 Camera movement instruction.
13035 \begin_inset space \thinspace{}
13039 \begin_inset space \space{}
13045 \begin_layout Itemize
13049 \begin_inset space \hfill{}
13055 \begin_layout Itemize
13059 \begin_inset space \hfill{}
13065 \begin_layout Itemize
13069 \begin_inset space \hfill{}
13075 \begin_layout Itemize
13079 \begin_inset space \hfill{}
13085 \begin_layout Subsubsection
13089 \begin_layout Itemize
13093 \begin_layout Itemize
13097 \begin_layout Itemize
13099 \begin_inset space \thinspace{}
13106 \begin_layout Itemize
13111 \begin_layout Itemize
13112 PAN — camera movement
13115 \begin_layout Itemize
13116 INSERT — cut to close-up of
13119 \begin_layout Chapter
13121 \change_inserted 564990737 1671185876
13125 \begin_layout Section
13127 \change_inserted 564990737 1671716212
13130 Academic Field Specifics
13133 \begin_layout Subsection
13135 \change_inserted 564990737 1671716212
13138 Chemistry: Hazard and Precautionary Statements
13141 \begin_layout Standard
13143 \change_inserted 564990737 1671716212
13146 This module provides two insets to typeset numbers and phrases of chemical
13147 hazard and precautionary statements.
13148 For a description see
13151 File\SpecialChar menuseparator
13152 Open Example\SpecialChar menuseparator
13153 Modules\SpecialChar menuseparator
13154 Hazard and Precautionary Statements
13158 Help\SpecialChar menuseparator
13159 Specific Manuals\SpecialChar menuseparator
13160 Hazard and Precautionary Statements
13166 \begin_layout Subsection
13168 \change_inserted 564990737 1671716212
13172 Chemistry: Risk and Safety Statements
13175 \begin_layout Standard
13177 \change_inserted 564990737 1671716212
13180 This module provides two insets,
13188 , accessible via the menu
13193 nsert\SpecialChar menuseparator
13195 \begin_inset space ~
13200 and an environment to typeset numbers and phrases of chemical risk and
13204 \begin_layout Subsection
13206 \change_inserted 564990737 1671716212
13212 \begin_layout Standard
13214 \change_inserted 564990737 1671716212
13217 This module uses the
13221 package to add environments useful for linguistics (numbered examples,
13222 glosses, semantic markup, tableau floats).
13223 You can obtain information about this module in
13228 elp\SpecialChar menuseparator
13234 \begin_inset space ~
13237 Manuals\SpecialChar menuseparator
13247 File\SpecialChar menuseparator
13248 Open Example\SpecialChar menuseparator
13251 Modules\SpecialChar menuseparator
13257 \begin_layout Section
13259 \change_inserted 564990737 1671788778
13265 \begin_layout Subsection
13267 \change_inserted 564990737 1671788778
13273 \begin_layout Standard
13275 \change_inserted 564990737 1671788778
13278 This module supports the Braille writing system.
13279 It requires the \SpecialChar LaTeX
13285 This and its documentation can be obtained from
13286 \begin_inset CommandInset href
13289 target "https://www.ctan.org/pkg/braille"
13295 You do not have to reconfigure your system after installing it.
13301 elp\SpecialChar menuseparator
13307 \begin_inset space ~
13310 Manuals\SpecialChar menuseparator
13319 File\SpecialChar menuseparator
13320 Open Example\SpecialChar menuseparator
13321 Modules\SpecialChar menuseparator
13327 \begin_layout Section
13329 \change_inserted 564990737 1671788778
13332 Annotation & Revision
13335 \begin_layout Subsection
13337 \change_inserted 564990737 1671788778
13343 \begin_layout Standard
13345 \change_inserted 564990737 1671788778
13348 This module provides “FiXme” (marginal) annotations for document revision
13350 A list of annotations can be produced by using the “List of FIXMEs” paragraph
13352 The annotations are customizable via the LaTeX preamble.
13353 See the FiXme documentation which can be obtained from
13354 \begin_inset CommandInset href
13357 target "http://mirrors.ctan.org/macros/latex/contrib/fixme/fixme.pdf"
13366 \begin_layout Paragraph
13368 \change_inserted 564990737 1671788778
13374 \begin_layout Standard
13376 \change_inserted 564990737 1671788778
13379 by default, the notes are only displayed in “draft” mode (if the option
13380 “draft” has been inserted in
13382 Document\SpecialChar menuseparator
13383 Settings\SpecialChar menuseparator
13384 Document Class\SpecialChar menuseparator
13385 Class Options\SpecialChar menuseparator
13389 To display them always, insert
13397 Document\SpecialChar menuseparator
13398 Settings\SpecialChar menuseparator
13406 \begin_layout Subsection
13408 \change_inserted 564990737 1671788778
13414 \begin_layout Standard
13416 \change_inserted 564990737 1671788778
13419 This module provides various kinds of annotations for PDF output.
13422 Help\SpecialChar menuseparator
13423 Specific Manuals\SpecialChar menuseparator
13424 PDF comments and File\SpecialChar menuseparator
13425 Open Example\SpecialChar menuseparator
13426 Modules\SpecialChar menuseparator
13432 \begin_layout Subsection
13434 \change_inserted 564990737 1671788778
13441 \begin_layout Standard
13443 \change_inserted 564990737 1671788778
13446 This module provides fields and buttons for PDF forms.
13448 \begin_inset CommandInset href
13450 name "hyperref documentation"
13451 target "http://mirrors.ctan.org/macros/latex/contrib/hyperref/doc/hyperref-doc.pdf"
13458 Help\SpecialChar menuseparator
13459 Specific Manuals\SpecialChar menuseparator
13460 PDF forms and File\SpecialChar menuseparator
13461 Open Example\SpecialChar menuseparator
13462 Modules\SpecialChar menuseparator
13468 \begin_layout Subsection
13470 \change_inserted 564990737 1671788778
13477 \begin_layout Standard
13479 \change_inserted 564990737 1671788778
13482 This module defines an inset to typeset reading aids (ruby, furigana) to
13483 Chinese characters.
13484 It uses the “okumakro,” “luatexja-ruby” or “ruby” package (depending on
13485 the TeX engine) or a fallback definition.
13489 \begin_layout Subsection
13491 \change_inserted 564990737 1671788778
13498 \begin_layout Standard
13500 \change_inserted 564990737 1671788778
13503 This module provides custom insets to insert TODO items in your document.
13504 In order to generate a “List of TODOs,” the module provides a paragraph
13506 Inserting “final” in
13508 Document\SpecialChar menuseparator
13509 Settings\SpecialChar menuseparator
13510 Document Class\SpecialChar menuseparator
13511 Class Options\SpecialChar menuseparator
13514 ) suppresses the output of TODO notes.
13516 \begin_inset CommandInset href
13518 name "todonotes documentation"
13519 target "http://mirrors.ctan.org/macros/latex/contrib/todonotes/todonotes.pdf"
13527 \begin_layout Section
13529 \change_inserted 564990737 1671829045
13535 \begin_layout Subsection
13537 \change_inserted 564990737 1671829045
13540 APA Style with NatBib
13543 \begin_layout Standard
13545 \change_inserted 564990737 1671829045
13548 This module adds support for using natbib together with apacite (the bibliograph
13549 y style need not be apacite — it could be apacite, apacitex, or any bibliography
13550 that works with both the natbib and apacite packages.)
13553 \begin_layout Section
13555 \change_inserted 564990737 1671829045
13561 \begin_layout Subsection
13563 \change_inserted 564990737 1671829045
13566 Fancy Colored Boxes
13569 \begin_layout Standard
13571 \change_inserted 564990737 1671829045
13574 This module adds ten custom insets that support colored boxes via the tcolorbox
13578 Help\SpecialChar menuseparator
13579 Specific Manuals\SpecialChar menuseparator
13584 File\SpecialChar menuseparator
13585 Open Example\SpecialChar menuseparator
13586 Modules\SpecialChar menuseparator
13590 \begin_inset CommandInset href
13592 name "tcolorbox documentation"
13593 target "http://mirrors.ctan.org/macros/latex/contrib/tcolorbox/tcolorbox.pdf"
13602 \begin_layout Subsection
13604 \change_inserted 564990737 1671829045
13610 \begin_layout Standard
13612 \change_inserted 564990737 1671829045
13615 This provides the custom insets
13631 to scale and rotate its content.
13634 \begin_layout Standard
13636 \change_inserted 564990737 1671829045
13642 is a simple way of reversing text without any other enhancement:
13645 \begin_layout Standard
13647 \change_inserted 564990737 1671829045
13650 \begin_inset Flex Reflectbox
13653 \begin_layout Plain Layout
13655 \change_inserted 564990737 1671829045
13658 Great Western Railway
13668 \begin_layout Standard
13670 \change_inserted 564990737 1671829045
13673 (You will need to use Ctrl-R to see any of these examples.)
13676 \begin_layout Standard
13678 \change_inserted 564990737 1671829045
13684 allows you to specify the dimensions of the text or image; permissible
13685 units are em, ex, in, pt, pc, cm, mm, dd, cc, nd, nc, bp, or sp; if you
13694 it scales by the width factor:
13697 \begin_layout Standard
13699 \change_inserted 564990737 1671829045
13702 \begin_inset Flex Resizebox
13705 \begin_layout Plain Layout
13707 \change_inserted 564990737 1671829045
13710 \begin_inset Argument 1
13713 \begin_layout Plain Layout
13715 \change_inserted 564990737 1671829045
13726 \begin_inset Argument 2
13729 \begin_layout Plain Layout
13731 \change_inserted 564990737 1671829045
13741 Great Western Railway
13751 \begin_layout Standard
13753 \change_inserted 564990737 1671829045
13759 allows you to rotate text around the reference point of the box.
13760 If you wish to rotate the box around a different origin, place the cursor
13761 inside the box and select Insert\SpecialChar menuseparator
13786 or meaningful combinations of these and the counterclockwise rotation angle
13787 is expressed in degrees.
13791 \begin_layout Standard
13793 \change_inserted 564990737 1671829045
13796 \begin_inset Flex Rotatebox
13799 \begin_layout Plain Layout
13801 \change_inserted 564990737 1671829045
13804 \begin_inset Argument 1
13807 \begin_layout Plain Layout
13809 \change_inserted 564990737 1671829045
13820 \begin_inset Argument 2
13823 \begin_layout Plain Layout
13825 \change_inserted 564990737 1671829045
13835 Great Western Railway
13845 \begin_layout Standard
13847 \change_inserted 564990737 1671829045
13850 You can combine boxes as in:
13853 \begin_layout Standard
13855 \change_inserted 564990737 1671829045
13858 \begin_inset Flex Rotatebox
13861 \begin_layout Plain Layout
13863 \change_inserted 564990737 1671829045
13866 \begin_inset Argument 1
13869 \begin_layout Plain Layout
13871 \change_inserted 564990737 1671829045
13882 \begin_inset Argument 2
13885 \begin_layout Plain Layout
13887 \change_inserted 564990737 1671829045
13898 \begin_inset Flex Resizebox
13901 \begin_layout Plain Layout
13903 \change_inserted 564990737 1671829045
13906 \begin_inset Argument 1
13909 \begin_layout Plain Layout
13911 \change_inserted 564990737 1671829045
13922 \begin_inset Argument 2
13925 \begin_layout Plain Layout
13927 \change_inserted 564990737 1671829045
13938 \begin_inset Flex Reflectbox
13941 \begin_layout Plain Layout
13943 \change_inserted 564990737 1671829045
13946 Great Western Railway
13970 \begin_layout Standard
13972 \change_inserted 564990737 1671829045
13978 scales text; select Insert\SpecialChar menuseparator
13979 V-Factor to add a vertical factor.
13980 If the vertical factor is omitted, the horizontal is used.
13981 Adding different horizontal and vertical values creates distortion as in
13985 \begin_layout Standard
13987 \change_inserted 564990737 1671829045
13991 \begin_inset Flex Scalebox
13994 \begin_layout Plain Layout
13996 \change_inserted 564990737 1671829045
13999 \begin_inset Argument 1
14002 \begin_layout Plain Layout
14004 \change_inserted 564990737 1671829045
14015 \begin_inset Argument 2
14018 \begin_layout Plain Layout
14020 \change_inserted 564990737 1671829045
14032 Great Western Railway
14042 \begin_layout Standard
14044 \change_inserted 564990737 1671829045
14047 A negative horizontal value reverses the text and a negative vertical value
14048 inverts it so that you get
14051 \begin_layout Standard
14053 \change_inserted 564990737 1671829045
14056 \begin_inset Flex Scalebox
14059 \begin_layout Plain Layout
14061 \change_inserted 564990737 1671829045
14064 \begin_inset Argument 1
14067 \begin_layout Plain Layout
14069 \change_inserted 564990737 1671829045
14080 \begin_inset Argument 2
14083 \begin_layout Plain Layout
14085 \change_inserted 564990737 1671829045
14095 Great Western Railway
14103 \begin_inset Flex Scalebox
14106 \begin_layout Plain Layout
14108 \change_inserted 564990737 1671829045
14111 \begin_inset Argument 1
14114 \begin_layout Plain Layout
14116 \change_inserted 564990737 1671829045
14127 \begin_inset Argument 2
14130 \begin_layout Plain Layout
14132 \change_inserted 564990737 1671829045
14142 Great Western Railway
14152 \begin_layout Subsection
14154 \change_inserted 564990737 1671884699
14160 \begin_layout Standard
14162 \change_inserted 564990737 1671884699
14165 This module defines Boxes with section header.
14166 It is mainly intended for the SciPoster Document class.
14170 \begin_layout Subsection
14172 \change_inserted 564990737 1671884699
14175 Variable-width Minipages
14178 \begin_layout Standard
14180 \change_inserted 564990737 1671884699
14186 \begin_inset space \thinspace{}
14193 Insert\SpecialChar menuseparator
14205 package provides a variable-width minipage, whose resulting width is the
14206 width of its contents (if this does not exceed the specified maximum width).
14207 The inset has two optional arguments which can be added by placing the
14208 cursor inside the minipage and entering
14210 Insert\SpecialChar menuseparator
14212 \begin_inset space \thinspace{}
14223 Insert\SpecialChar menuseparator
14225 \begin_inset space \thinspace{}
14239 File\SpecialChar menuseparator
14240 Open Example\SpecialChar menuseparator
14241 Variable-width Minipages
14247 \begin_layout Section
14249 \change_inserted 564990737 1671884699
14255 \begin_layout Subsection
14257 \change_inserted 564990737 1671884699
14260 Fix Computer Modern Fonts
14263 \begin_layout Standard
14265 \change_inserted 564990737 1671884699
14268 This module uses the
14272 package to improve the appearance of Computer Modern fonts and make them
14273 available with arbitrary sizes.
14275 \begin_inset CommandInset href
14277 name "fix-cm documentation"
14278 target "http://mirrors.ctan.org/macros/latex/base/fix-cm.pdf"
14287 \begin_layout Subsection
14289 \change_inserted 564990737 1671884699
14293 Kernel Fixes (Obsolete)
14296 \begin_layout Standard
14298 \change_inserted 564990737 1671884699
14301 This module loads the \SpecialChar LaTeX
14306 which contains some bug fixes for \SpecialChar LaTeX
14308 If you use this module your typeset document may look different when you
14309 process it, depending on the respective version of
14317 \begin_layout Paragraph
14319 \change_inserted 564990737 1671884699
14325 \begin_layout Standard
14327 \change_inserted 564990737 1671884699
14330 recent \SpecialChar LaTeX
14331 kernels (as of 2015/01/01) include the functionality of
14339 module is obsolete with newer \SpecialChar LaTeX
14344 \begin_layout Subsection
14346 \change_inserted 564990737 1671884699
14349 Minimalistic Insets
14352 \begin_layout Standard
14354 \change_inserted 564990737 1671884699
14357 This module redefines several insets (Index, Branch, URL) as being Minimalistic.
14360 \begin_layout Subsection
14362 \change_inserted 564990737 1671884699
14365 Title and Preamble Hacks
14368 \begin_layout Standard
14370 \change_inserted 564990737 1671884699
14373 This module provides two new paragraph styles:
14376 \begin_layout Enumerate
14378 \change_inserted 564990737 1671884699
14384 which puts whatever is entered into it into the preamble.
14385 This can be used, if one wishes, to include preamble code in the body of
14390 \begin_layout Enumerate
14392 \change_inserted 564990737 1671884699
14398 which that will put its contents into the body of the LaTeX document, but
14406 This is useful for making branches and notes in title-related material.
14407 (However, if you put these in a Standard layout, this signals to LyX to
14414 , which may then come too early.)
14417 \begin_layout Section
14418 Multiple Text Columns
14421 \begin_layout Standard
14422 This feature is independent of the option
14424 Two-column document
14426 in the document settings under
14431 If you want to have 2
14432 \begin_inset space ~
14435 columns for the whole document, it is recommended to use the
14437 Two-column document
14440 For all other cases use this feature.
14443 \begin_layout Standard
14444 To use multiple text columns in your document, you have to load the module
14451 Document\SpecialChar menuseparator
14452 Settings\SpecialChar menuseparator
14455 ) and must have the \SpecialChar LaTeX
14457 \begin_inset Flex Code
14460 \begin_layout Plain Layout
14469 \begin_layout Standard
14470 Footnotes within multiple columns will be placed at the bottom of the page
14471 and not under each column.
14472 Within the different columns you can use everything, with the limitation
14473 that for floats you need to use the float option
14480 \begin_layout Subsection
14484 \begin_layout Standard
14485 If you want to have 2
14486 \begin_inset space ~
14489 columns in your text, insert a multicolumn inset via the menu
14491 Insert\SpecialChar menuseparator
14493 \begin_inset space ~
14496 Insets\SpecialChar menuseparator
14498 \begin_inset space ~
14503 where the columns should start.
14504 Write all text that should be printed in 2
14505 \begin_inset space ~
14508 columns into this inset.
14511 \begin_layout Standard
14512 Here is an example:
14515 \begin_layout Standard
14517 \begin_inset Flex Multiple Columns
14520 \begin_layout Plain Layout
14525 The Adventure of the Empty House
14528 \begin_inset Newline newline
14531 by Sir Arthur Conan Doyle
14534 \begin_layout Plain Layout
14537 It was in the spring of the year 1894 that all London was interested, and
14538 the fashionable world dismayed, by the murder of the Honourable Ronald
14539 Adair under most unusual and inexplicable circumstances.
14540 The public has already learned those particulars of the crime which came
14541 out in the police investigation, but a good deal was suppressed upon that
14542 occasion, since the case for the prosecution was so overwhelmingly strong
14543 that it was not necessary to bring forward all the facts.
14544 Only now, at the end of nearly ten years, am I allowed to supply those
14545 missing links which make up the whole of that remarkable chain.
14546 The crime was of interest in itself, but that interest was as nothing to
14547 me compared to the inconceivable sequel, which afforded me the greatest
14548 shock and surprise of any event in my adventurous life.
14549 Even now, after this long interval, I find myself thrilling as I think
14550 of it, and feeling once more that sudden flood of joy, amazement, and increduli
14551 ty which utterly submerged my mind.
14552 Let me say to that public, which has shown some interest in those glimpses
14553 which I have occasionally given them of the thoughts and actions of a very
14554 remarkable man, that they are not to blame me if I have not shared my knowledge
14555 with them, for I should have considered it my first duty to do so, had
14556 I not been barred by a positive prohibition from his own lips, which was
14557 only withdrawn upon the third of last month.
14565 \begin_layout Standard
14566 To get 3 or more columns, set the cursor into the multicolumn inset and
14569 Insert\SpecialChar menuseparator
14571 \begin_inset space ~
14575 \begin_inset space ~
14581 The number of the desired columns is written into that inset (for 3
14582 \begin_inset space ~
14586 \begin_inset Quotes eld
14590 \begin_inset Quotes erd
14594 \begin_inset Newline newline
14597 Here is an example with 3
14598 \begin_inset space ~
14604 \begin_layout Standard
14605 \begin_inset Flex Multiple Columns
14608 \begin_layout Plain Layout
14611 \begin_inset Argument 1
14614 \begin_layout Plain Layout
14621 It can be imagined that my close intimacy with Sherlock Holmes had interested
14622 me deeply in crime, and that after his disappearance I never failed to
14623 read with care the various problems which came before the public.
14624 And I even attempted, more than once, for my own private satisfaction,
14625 to employ his methods in their solution, though with indifferent success.
14626 There was none, however, which appealed to me like this tragedy of Ronald
14628 As I read the evidence at the inquest, which led up to a verdict of willful
14629 murder against some person or persons unknown, I realized more clearly
14630 than I had ever done the loss which the community had sustained by the
14631 death of Sherlock Holmes.
14632 There were points about this strange business which would, I was sure,
14633 have specially appealed to him, and the efforts of the police would have
14634 been supplemented, or more probably anticipated, by the trained observation
14635 and the alert mind of the first criminal agent in Europe.
14636 All day, as I drove upon my round, I turned over the case in my mind and
14637 found no explanation which appeared to me to be adequate.
14638 At the risk of telling a twice-told tale, I will recapitulate the facts
14639 as they were known to the public at the conclusion of the inquest.
14647 \begin_layout Standard
14648 You can have up to 10
14649 \begin_inset space ~
14652 columns if you want to, but that might not be very pleasant for the readers
14656 \begin_layout Standard
14657 \begin_inset Newpage newpage
14663 \begin_layout Subsection
14664 Columns inside Columns
14667 \begin_layout Standard
14668 You can also have columns inside columns:
14671 \begin_layout Standard
14672 \begin_inset Flex Multiple Columns
14675 \begin_layout Plain Layout
14678 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
14679 at that time governor of one of the Australian colonies.
14680 Adair's mother had returned from Australia to undergo the operation for
14681 cataract, and she, her son Ronald, and her daughter Hilda were living together
14685 \begin_layout Plain Layout
14686 \begin_inset Flex Multiple Columns
14689 \begin_layout Plain Layout
14692 The youth moved in the best society
14693 \begin_inset space ~
14696 – had, so far as was known, no enemies and no particular vices.
14697 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
14698 had been broken off by mutual consent some months before, and there was
14699 no sign that it had left any very profound feeling behind it.
14700 For the rest {sic} the man's life moved in a narrow and conventional circle,
14701 for his habits were quiet and his nature unemotional.
14702 Yet it was upon this easy-going young aristocrat that death came, in most
14703 strange and unexpected form, between the hours of ten and eleven-twenty
14704 on the night of March 30, 1894.
14712 \begin_layout Plain Layout
14715 Ronald Adair was fond of cards
14716 \begin_inset space ~
14719 – playing continually, but never for such stakes as would hurt him.
14720 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
14721 It was shown that, after dinner on the day of his death, he had played
14722 a rubber of whist at the latter club.
14723 He had also played there in the afternoon.
14728 The evidence of those who had played with him
14729 \begin_inset space ~
14733 Murray, Sir John Hardy, and Colonel Moran
14734 \begin_inset space ~
14737 – showed that the game was whist, and that there was a fairly equal fall
14739 Adair might have lost five pounds, but not more.
14740 His fortune was a considerable one, and such a loss could not in any way
14742 He had played nearly every day at one club or other, but he was a cautious
14743 player, and usually rose a winner.
14744 It came out in evidence that, in partnership with Colonel Moran, he had
14745 actually won as much as four hundred and twenty pounds in a sitting, some
14746 weeks before, from Godfrey Milner and Lord Balmoral.
14747 So much for his recent history as it came out at the inquest.
14755 \begin_layout Subsection
14759 \begin_layout Standard
14760 The examples in this section show some more special features of multiple
14764 \begin_layout Standard
14765 For more features of multiple columns, have a look at the
14766 \begin_inset CommandInset href
14768 name "documentation"
14769 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
14774 of the \SpecialChar LaTeX
14776 \begin_inset Flex Code
14779 \begin_layout Plain Layout
14788 \begin_layout Subsubsection
14792 \begin_layout Standard
14793 To add a preface text for multiple columns, set the cursor into the multicolumn
14794 inset and use the menu
14796 Insert\SpecialChar menuseparator
14800 Write your preface text into that inset.
14801 \begin_inset Newline newline
14804 This is an example with some preface text:
14807 \begin_layout Standard
14808 \begin_inset VSpace bigskip
14814 \begin_layout Standard
14815 \begin_inset Flex Multiple Columns
14818 \begin_layout Plain Layout
14819 \begin_inset Argument 2
14822 \begin_layout Plain Layout
14823 And the story continues and continues and continues and continues\SpecialChar ldots
14831 On the evening of the crime, he returned from the club exactly at ten.
14832 His mother and sister were out spending the evening with a relation.
14833 The servant deposed that she heard him enter the front room on the second
14834 floor, generally used as his sitting-room.
14835 She had lit a fire there, and as it smoked she had opened the window.
14836 No sound was heard from the room until eleven-twenty, the hour of the return
14837 of Lady Maynooth and her daughter.
14838 Desiring to say good-night, she attempted to enter her son's room.
14839 The door was locked on the inside, and no answer could be got to their
14840 cries and knocking.
14841 Help was obtained, and the door forced.
14842 The unfortunate young man was found lying near the table.
14843 His head had been horribly mutilated by an expanding revolver bullet, but
14844 no weapon of any sort was to be found in the room.
14852 \begin_layout Standard
14853 You can also use a section heading as the preface if you use a section command
14854 as \SpecialChar TeX
14856 For example the command
14859 \begin_layout LyX-Code
14862 subsection{subsection title}
14865 \begin_layout Standard
14866 creates a subsection.
14867 In this example the preface is a subsubsection:
14870 \begin_layout Standard
14871 \begin_inset Flex Multiple Columns
14874 \begin_layout Plain Layout
14875 \begin_inset Argument 2
14878 \begin_layout Plain Layout
14882 \begin_layout Plain Layout
14891 This is a subsubsection heading as a preface
14895 \begin_layout Plain Layout
14909 A minute examination of the circumstances served only to make the case more
14911 In the first place, no reason could be given why the young man should have
14912 fastened the door upon the inside.
14913 There was the possibility that the murderer had done this, and had afterwards
14914 escaped by the window.
14915 The drop was at least twenty feet, however, and a bed of crocuses in full
14917 Neither the flowers nor the earth showed any sign of having been disturbed,
14918 nor were there any marks upon the narrow strip of grass which separated
14919 the house from the road.
14920 Apparently, therefore, it was the young man himself who had fastened the
14922 But how did he come by his death? No one could have climbed up to the window
14923 without leaving traces.
14924 Suppose a man had fired through the window, he would indeed be a remarkable
14925 shot who could with a revolver inflict so deadly a wound.
14926 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
14927 a hundred yards of the house.
14928 No one had heard a shot.
14936 \begin_layout Standard
14937 If there is less vertical space than 6
14938 \begin_inset space ~
14941 text lines is left on the page at the beginning of the multiple columns,
14942 a page break will be inserted before the multiple columns.
14943 Depending on the number of lines of the preface text, you might want to
14945 This is done by setting the cursor into the mulitcolumn inset behind the
14946 preface (if there is any) and using the menu
14948 Insert\SpecialChar menuseparator
14950 \begin_inset space ~
14954 \begin_inset space ~
14958 \begin_inset space ~
14964 Insert into that inset the amount of space like e.
14965 \begin_inset space \thinspace{}
14969 \begin_inset space \space{}
14973 \begin_inset Quotes eld
14977 \begin_inset Quotes erd
14981 \begin_inset Newline newline
14984 In this example the space is set to 7
14985 \begin_inset space ~
14988 text lines by using
14989 \begin_inset Flex Code
14992 \begin_layout Plain Layout
15001 \begin_inset Flex Code
15004 \begin_layout Plain Layout
15012 needs to be inserted as \SpecialChar TeX
15016 \begin_layout Standard
15017 \begin_inset Flex Multiple Columns
15020 \begin_layout Plain Layout
15021 \begin_inset Argument 3
15024 \begin_layout Plain Layout
15029 \begin_layout Plain Layout
15045 On the evening of the crime, he returned from the club exactly at ten.
15046 His mother and sister were out spending the evening with a relation.
15047 The servant deposed that she heard him enter the front room on the second
15048 floor, generally used as his sitting-room.
15049 She had lit a fire there, and as it smoked she had opened the window.
15050 No sound was heard from the room until eleven-twenty, the hour of the return
15051 of Lady Maynooth and her daughter.
15052 Desiring to say good-night, she attempted to enter her son's room.
15053 The door was locked on the inside, and no answer could be got to their
15054 cries and knocking.
15055 Help was obtained, and the door forced.
15056 The unfortunate young man was found lying near the table.
15057 His head had been horribly mutilated by an expanding revolver bullet, but
15058 no weapon of any sort was to be found in the room.
15066 \begin_layout Subsubsection
15070 \begin_layout Standard
15071 The amount of space before and after multiple columns can be changed by
15072 changing the length
15073 \begin_inset Flex Code
15076 \begin_layout Plain Layout
15085 For example the command
15088 \begin_layout LyX-Code
15096 \begin_layout Standard
15097 in \SpecialChar TeX
15098 Code changes its value to 3
15099 \begin_inset space \thinspace{}
15103 The change must be made before the multiple columns' start.
15104 The predefined value is 13
15105 \begin_inset space \thinspace{}
15111 \begin_layout Standard
15113 \begin_inset Flex Code
15116 \begin_layout Plain Layout
15125 \begin_inset space \thinspace{}
15131 \begin_layout Standard
15135 \begin_layout Plain Layout
15141 multicolsep}{2.5cm}
15149 \begin_layout Standard
15150 \begin_inset Flex Multiple Columns
15153 \begin_layout Plain Layout
15156 All day I turned these facts over in my mind, endeavouring to hit upon some
15157 theory which could reconcile them all, and to find that line of least resistanc
15158 e which my poor friend had declared to be the starting-point of every investigat
15160 I confess that I made little progress.
15161 In the evening I strolled across the Park, and found myself about six o'clock
15162 at the Oxford Street end of Park Lane.
15163 A group of loafers upon the pavements, all staring up at a particular window,
15164 directed me to the house which I had come to see.
15165 A tall, thin man with coloured glasses, whom I strongly suspected of being
15166 a plain-clothes detective, was pointing out some theory of his own, while
15167 the others crowded round to listen to what he said.
15168 I got as near him as I could, but his observations seemed to me to be absurd,
15169 so I withdrew again in some disgust.
15170 As I did so I struck against an elderly, deformed man, who had been behind
15171 me, and I knocked down several books which he was carrying.
15179 \begin_layout Standard
15180 \begin_inset Note Greyedout
15183 \begin_layout Plain Layout
15188 The values you set with
15189 \begin_inset Flex Code
15192 \begin_layout Plain Layout
15200 will be used for all following multiple columns until you change them again.
15208 \begin_layout Standard
15212 \begin_layout Plain Layout
15224 \begin_inset Note Note
15227 \begin_layout Plain Layout
15228 go back to the default
15236 \begin_layout Standard
15237 \begin_inset Newpage newpage
15243 \begin_layout Subsubsection
15247 \begin_layout Standard
15248 A column break can be forced by inserting the command
15249 \begin_inset Flex Code
15252 \begin_layout Plain Layout
15260 as \SpecialChar TeX
15261 Code to that position in the text where the column should be broken.
15262 Note that this leads in most cases to whitespace in the text.
15263 \begin_inset Newline newline
15266 Here is an example:
15269 \begin_layout Standard
15270 \begin_inset Flex Multiple Columns
15273 \begin_layout Plain Layout
15276 \begin_inset Quotes eld
15279 You're surprised to see me, sir,
15280 \begin_inset Quotes erd
15283 said he, in a strange, croaking voice.
15286 \begin_layout Plain Layout
15289 I acknowledged that I was.
15292 \begin_layout Plain Layout
15295 \begin_inset Quotes eld
15298 Well, I've a conscience, sir, and when I chanced to see you go into this
15299 house, as I came hobbling after you, I thought to myself, I'll just step
15300 in and see that kind gentleman, and tell him that if I was a bit gruff
15301 in my manner there was not any harm meant, and that I am much obliged to
15302 him for picking up my books.
15303 \begin_inset Quotes erd
15309 \begin_layout Plain Layout
15312 \begin_inset Quotes eld
15315 You make too much of a trifle,
15316 \begin_inset Quotes erd
15321 \begin_inset Quotes eld
15324 May I ask how you knew who I was?
15325 \begin_inset Quotes erd
15328 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
15332 \begin_layout Plain Layout
15344 \begin_layout Plain Layout
15347 \begin_inset Quotes eld
15350 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
15351 you'll find my little bookshop at the corner of Church Street, and very
15352 happy to see you, I am sure.
15353 Maybe you collect yourself, sir.
15357 \begin_inset space ~
15371 \begin_inset space ~
15374 – a bargain, every one of them.
15375 With five volumes you could just fill that gap on that second shelf.
15376 It looks untidy, does it not, sir?
15377 \begin_inset Quotes erd
15388 \begin_layout Subsubsection
15392 \begin_layout Standard
15393 The width of the columns is automatically calculated, but you can modify
15394 the space between the columns.
15395 This is done by changing the length
15396 \begin_inset Flex Code
15399 \begin_layout Plain Layout
15408 Its predefined value is 10
15409 \begin_inset space \thinspace{}
15413 Here is an example where
15414 \begin_inset Flex Code
15417 \begin_layout Plain Layout
15426 \begin_inset space \thinspace{}
15432 \begin_layout Standard
15436 \begin_layout Plain Layout
15450 \begin_layout Standard
15451 \begin_inset Flex Multiple Columns
15454 \begin_layout Plain Layout
15457 My observations of No.
15458 \begin_inset space \space{}
15461 427 Park Lane did little to clear up the problem in which I was interested.
15462 The house was separated from the street by a low wall and railing, the
15463 whole not more than five feet high.
15464 It was perfectly easy, therefore, for anyone to get into the garden, but
15465 the window was entirely inaccessible, since there was no water pipe or
15466 anything which could help the most active man to climb it.
15467 More puzzled than ever, I retraced my steps to Kensington.
15468 I had not been in my study five minutes when the maid entered to say that
15469 a person desired to see me.
15470 To my astonishment it was none other than my strange old book collector,
15471 his sharp, wizened face peering out from a frame of white hair, and his
15472 precious volumes, a dozen of them at least, wedged under his right arm.
15480 \begin_layout Standard
15484 \begin_layout Plain Layout
15496 \begin_inset Note Note
15499 \begin_layout Plain Layout
15500 go back to the default
15508 \begin_layout Subsubsection
15512 \begin_layout Standard
15513 Between the columns a rule with a width of the length
15514 \begin_inset Flex Code
15517 \begin_layout Plain Layout
15526 If this rule width is set to 0
15527 \begin_inset space \thinspace{}
15530 pt (this is the default), the rule is suppressed.
15531 In the following example the rule is 2
15532 \begin_inset space \thinspace{}
15538 \begin_layout Standard
15542 \begin_layout Plain Layout
15548 columnseprule}{2pt}
15556 \begin_layout Standard
15557 \begin_inset Flex Multiple Columns
15560 \begin_layout Plain Layout
15563 \begin_inset Quotes eld
15566 You're surprised to see me, sir,
15567 \begin_inset Quotes erd
15570 said he, in a strange, croaking voice.
15573 \begin_layout Plain Layout
15576 I acknowledged that I was.
15579 \begin_layout Plain Layout
15582 \begin_inset Quotes eld
15585 Well, I've a conscience, sir, and when I chanced to see you go into this
15586 house, as I came hobbling after you, I thought to myself, I'll just step
15587 in and see that kind gentleman, and tell him that if I was a bit gruff
15588 in my manner there was not any harm meant, and that I am much obliged to
15589 him for picking up my books.
15590 \begin_inset Quotes erd
15596 \begin_layout Plain Layout
15599 \begin_inset Quotes eld
15602 You make too much of a trifle,
15603 \begin_inset Quotes erd
15608 \begin_inset Quotes eld
15611 May I ask how you knew who I was?
15612 \begin_inset Quotes erd
15618 \begin_layout Plain Layout
15621 \begin_inset Quotes eld
15624 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
15625 you'll find my little bookshop at the corner of Church Street, and very
15626 happy to see you, I am sure.
15627 Maybe you collect yourself, sir.
15631 \begin_inset space ~
15645 \begin_inset space ~
15648 – a bargain, every one of them.
15649 With five volumes you could just fill that gap on that second shelf.
15650 It looks untidy, does it not, sir?
15651 \begin_inset Quotes erd
15662 \begin_layout Standard
15663 \begin_inset VSpace defskip
15669 \begin_layout Standard
15670 The rule can be colored by redefining the command
15671 \begin_inset Flex Code
15674 \begin_layout Plain Layout
15683 This is done by inserting the command
15686 \begin_layout LyX-Code
15691 columnseprulecolor}{
15696 \begin_layout Standard
15697 as \SpecialChar TeX
15698 Code before the multicolumn inset.
15700 \begin_inset Flex Code
15703 \begin_layout Plain Layout
15709 in this command by a color of your choice.
15710 You can use all pre- and self-defined colors.
15718 \begin_inset space ~
15723 for more information about pre- and self-defined colors.
15724 To go back to the default color insert the command
15727 \begin_layout LyX-Code
15732 columnseprulecolor}{
15737 \begin_layout Standard
15738 Here is the example with a cyan rule and 1
15739 \begin_inset space \thinspace{}
15742 cm column separation:
15745 \begin_layout Standard
15749 \begin_layout Plain Layout
15758 \begin_layout Plain Layout
15764 columnseprulecolor}{
15774 \begin_layout Standard
15775 \begin_inset Flex Multiple Columns
15778 \begin_layout Plain Layout
15781 \begin_inset Quotes eld
15784 You're surprised to see me, sir,
15785 \begin_inset Quotes erd
15788 said he, in a strange, croaking voice.
15791 \begin_layout Plain Layout
15794 I acknowledged that I was.
15797 \begin_layout Plain Layout
15800 \begin_inset Quotes eld
15803 Well, I've a conscience, sir, and when I chanced to see you go into this
15804 house, as I came hobbling after you, I thought to myself, I'll just step
15805 in and see that kind gentleman, and tell him that if I was a bit gruff
15806 in my manner there was not any harm meant, and that I am much obliged to
15807 him for picking up my books.
15808 \begin_inset Quotes erd
15814 \begin_layout Plain Layout
15817 \begin_inset Quotes eld
15820 You make too much of a trifle,
15821 \begin_inset Quotes erd
15826 \begin_inset Quotes eld
15829 May I ask how you knew who I was?
15830 \begin_inset Quotes erd
15836 \begin_layout Plain Layout
15839 \begin_inset Quotes eld
15842 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
15843 you'll find my little bookshop at the corner of Church Street, and very
15844 happy to see you, I am sure.
15845 Maybe you collect yourself, sir.
15849 \begin_inset space ~
15863 \begin_inset space ~
15866 – a bargain, every one of them.
15867 With five volumes you could just fill that gap on that second shelf.
15868 It looks untidy, does it not, sir?
15869 \begin_inset Quotes erd
15880 \begin_layout Standard
15884 \begin_layout Plain Layout
15890 columnseprule}{0pt}
15893 \begin_layout Plain Layout
15899 columnseprulecolor}{
15907 \begin_inset Note Note
15910 \begin_layout Plain Layout
15911 go back to the default
15919 \begin_layout Section
15921 \change_inserted 564990737 1671270380
15925 \begin_layout Subsection
15927 \change_inserted 564990737 1671270398
15929 \change_deleted 564990737 1671270396
15935 \begin_layout Standard
15938 as well as any other text processor uses by default rectangular paragraphs.
15939 For special cases like for example posters, invitation cards or poems you
15940 can modify the paragraph shape to one of your choice.
15941 This can be done by using the \SpecialChar LaTeX
15943 \begin_inset Flex Code
15946 \begin_layout Plain Layout
15952 which is loaded by using in the document settings the module
15954 Custom paragraph shapes
15959 \begin_layout Subsubsection
15963 \begin_layout Standard
15968 provides the following shapes:
15971 \begin_layout Standard
15972 \begin_inset Tabular
15973 <lyxtabular version="3" rows="13" columns="3">
15974 <features booktabs="true" islongtable="true" longtabularalignment="center">
15975 <column alignment="left" valignment="middle" width="16col%">
15976 <column alignment="left" valignment="middle" width="40col%">
15977 <column alignment="left" valignment="middle" width="35col%">
15978 <row endhead="true">
15979 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
15982 \begin_layout Plain Layout
15991 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
15994 \begin_layout Plain Layout
16003 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
16006 \begin_layout Plain Layout
16016 <row interlinespace="default">
16017 <cell alignment="left" valignment="top" usebox="none">
16020 \begin_layout Plain Layout
16028 <cell alignment="left" valignment="top" usebox="none">
16031 \begin_layout Plain Layout
16034 Circle with circular hole (in the size of a CD/DVD)
16039 <cell alignment="left" valignment="top" usebox="none">
16042 \begin_layout Plain Layout
16045 Cannot be scaled, take care there is not too much text
16051 <row interlinespace="default">
16052 <cell alignment="left" valignment="top" usebox="none">
16055 \begin_layout Plain Layout
16063 <cell alignment="left" valignment="top" usebox="none">
16066 \begin_layout Plain Layout
16074 <cell alignment="left" valignment="top" usebox="none">
16077 \begin_layout Plain Layout
16080 Fragile, calculation might fail
16086 <row interlinespace="default">
16087 <cell alignment="left" valignment="top" usebox="none">
16090 \begin_layout Plain Layout
16098 <cell alignment="left" valignment="top" usebox="none">
16101 \begin_layout Plain Layout
16104 Rhomboid (symbolizing a
16105 \begin_inset Quotes eld
16109 \begin_inset Quotes erd
16117 <cell alignment="left" valignment="top" usebox="none">
16120 \begin_layout Plain Layout
16129 <row interlinespace="default">
16130 <cell alignment="left" valignment="top" usebox="none">
16133 \begin_layout Plain Layout
16141 <cell alignment="left" valignment="top" usebox="none">
16144 \begin_layout Plain Layout
16152 <cell alignment="left" valignment="top" usebox="none">
16155 \begin_layout Plain Layout
16164 <row interlinespace="default">
16165 <cell alignment="left" valignment="top" usebox="none">
16168 \begin_layout Plain Layout
16176 <cell alignment="left" valignment="top" usebox="none">
16179 \begin_layout Plain Layout
16187 <cell alignment="left" valignment="top" usebox="none">
16190 \begin_layout Plain Layout
16199 <row interlinespace="default">
16200 <cell alignment="left" valignment="top" usebox="none">
16203 \begin_layout Plain Layout
16211 <cell alignment="left" valignment="top" usebox="none">
16214 \begin_layout Plain Layout
16217 Nut for bolt (hexagon with circular hole)
16222 <cell alignment="left" valignment="top" usebox="none">
16225 \begin_layout Plain Layout
16234 <row interlinespace="default">
16235 <cell alignment="left" valignment="top" usebox="none">
16238 \begin_layout Plain Layout
16246 <cell alignment="left" valignment="top" usebox="none">
16249 \begin_layout Plain Layout
16257 <cell alignment="left" valignment="top" usebox="none">
16260 \begin_layout Plain Layout
16269 <row interlinespace="default">
16270 <cell alignment="left" valignment="top" usebox="none">
16273 \begin_layout Plain Layout
16281 <cell alignment="left" valignment="top" usebox="none">
16284 \begin_layout Plain Layout
16292 <cell alignment="left" valignment="top" usebox="none">
16295 \begin_layout Plain Layout
16304 <row interlinespace="default">
16305 <cell alignment="left" valignment="top" usebox="none">
16308 \begin_layout Plain Layout
16316 <cell alignment="left" valignment="top" usebox="none">
16319 \begin_layout Plain Layout
16327 <cell alignment="left" valignment="top" usebox="none">
16330 \begin_layout Plain Layout
16339 <row interlinespace="default">
16340 <cell alignment="left" valignment="top" usebox="none">
16343 \begin_layout Plain Layout
16351 <cell alignment="left" valignment="top" usebox="none">
16354 \begin_layout Plain Layout
16357 Normal/reversed rain drop
16362 <cell alignment="left" valignment="top" usebox="none">
16365 \begin_layout Plain Layout
16368 Fragile, calculation might fail
16374 <row interlinespace="default">
16375 <cell alignment="left" valignment="top" usebox="none">
16378 \begin_layout Plain Layout
16387 <cell alignment="left" valignment="top" usebox="none">
16390 \begin_layout Plain Layout
16393 The \SpecialChar TeX
16399 <cell alignment="left" valignment="top" usebox="none">
16402 \begin_layout Plain Layout
16411 <row interlinespace="default">
16412 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
16415 \begin_layout Plain Layout
16419 \begin_inset Newline newline
16427 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
16430 \begin_layout Plain Layout
16433 Triangles in different orientations
16438 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
16441 \begin_layout Plain Layout
16457 \begin_layout Standard
16458 To use a shape for your paragraph, simply select it in \SpecialChar LyX
16460 for environments in the toolbar.
16463 \begin_layout Standard
16464 \begin_inset Newpage newpage
16470 \begin_layout Standard
16471 Here is an example paragraph in the shape of a nut:
16474 \begin_layout Standard
16475 \begin_inset VSpace bigskip
16484 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16485 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16487 At vero eos et accusam et justo duo dolores et ea rebum.
16488 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
16490 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16491 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16495 \begin_layout Standard
16496 \begin_inset VSpace bigskip
16502 \begin_layout Standard
16503 \begin_inset Note Greyedout
16506 \begin_layout Plain Layout
16515 paragraphs cannot run over a page break.
16523 \begin_layout Standard
16524 \begin_inset VSpace bigskip
16530 \begin_layout Standard
16532 \begin_inset Flex Code
16535 \begin_layout Plain Layout
16541 takes care that the shape will always be preserved, no matter how much
16542 text is in the paragraph.
16543 Therefore the paragraph size changes with the amount of contained text.
16544 This can lead to paragraph sizes exceeding the page margins.
16545 To demonstrate the size scaling, here is the same example paragraph but
16546 with twice as much text:
16549 \begin_layout Standard
16550 \begin_inset Newpage newpage
16559 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16560 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16562 At vero eos et accusam et justo duo dolores et ea rebum.
16563 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
16565 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16566 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16568 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16569 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16571 At vero eos et accusam et justo duo dolores et ea rebum.
16572 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
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
16579 \begin_layout Standard
16580 \begin_inset VSpace bigskip
16586 \begin_layout Standard
16587 An exception is the shape
16592 It cannot be scaled because it must fit the size of a CD/DVD.
16593 Therefore the amount of text that fits into the shape is limited.
16594 \begin_inset Newline newline
16605 shape are fragile, meaning that the calculation of their size can fail,
16606 depending on the amount of text.
16607 You will then get the \SpecialChar LaTeX
16609 \begin_inset Quotes eld
16612 Arithmetic overflow
16613 \begin_inset Quotes erd
16617 In this case one can try to remove or add some text; if nothing works one
16618 has to use another shape.
16621 \begin_layout Standard
16622 \begin_inset VSpace bigskip
16628 \begin_layout Standard
16629 For shapes with tips you will maybe see that \SpecialChar LaTeX
16630 's hyphenation routine fails
16631 for text in the tips.
16632 Therefore it is often necessary to add hyphenation points
16637 arg "specialchar-insert hyphenation"
16642 ) to the corresponding text parts.
16645 \begin_layout Standard
16646 \begin_inset VSpace bigskip
16652 \begin_layout Standard
16653 Shapepar paragraphs are either always centered or placed on the page so
16654 that their left border touches the left page margin.
16655 You can therefore not use the paragraph dialog to align such paragraphs.
16656 A solution is to put the paragraph into a minipage or parbox and align
16658 The problem is hereby to find the right width for the box.
16659 Because if it is too wide and you center the box, the paragraph is not
16660 centered too because it sticks at the left side of the box.
16661 So you might have to play a bit with the width until it fits.
16662 Here are two heart-shaped paragraphs, the first one is not aligned, the
16663 second one is right-aligned:
16666 \begin_layout Standard
16667 \begin_inset Newpage newpage
16673 \begin_layout Heart
16677 Lo\SpecialChar softhyphen
16678 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16679 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16681 At vero eos et accusam et justo duo dolores et ea rebum.
16682 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
16686 \begin_layout Standard
16687 \begin_inset VSpace bigskip
16693 \begin_layout Standard
16696 \begin_inset Box Frameless
16706 height_special "totalheight"
16711 backgroundcolor "none"
16714 \begin_layout Heart
16718 Lo\SpecialChar softhyphen
16719 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16720 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16722 At vero eos et accusam et justo duo dolores et ea rebum.
16723 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
16732 \begin_layout Subsubsection
16736 \begin_layout Standard
16737 You can define any shape you want.
16738 Doing this manually is a lot of work because every coordinate must be specified.
16739 But there is a way to let the computer calculate the coordinates:
16742 \begin_layout Enumerate
16743 Install the program
16744 \begin_inset CommandInset href
16747 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
16755 \begin_layout Enumerate
16762 TeX/LaTeX\SpecialChar menuseparator
16763 Settings\SpecialChar menuseparator
16766 and select the font size you are using in your document.
16767 For example this document uses the size 12
16768 \begin_inset space \thinspace{}
16774 \begin_layout Enumerate
16778 \begin_layout Enumerate
16781 TeX/LaTeX\SpecialChar menuseparator
16784 to export the shape to coordinates.
16785 In the appearing dialog use either the outline of your shape for the coordinate
16786 s or the path itself.
16790 \begin_layout Plain Layout
16791 For more information see
16792 \begin_inset CommandInset href
16794 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
16807 \begin_layout Standard
16808 The coordinates are written into a \SpecialChar TeX
16810 To use it for your \SpecialChar LyX
16814 \begin_layout Enumerate
16815 Place the cursor before the first character of your paragraph (or into a
16819 \begin_layout Enumerate
16820 Open in \SpecialChar LyX
16823 Insert\SpecialChar menuseparator
16824 File\SpecialChar menuseparator
16826 \begin_inset space ~
16831 , select the file and use
16840 \begin_layout Standard
16841 \begin_inset VSpace defskip
16847 \begin_layout Standard
16848 \begin_inset Note Greyedout
16851 \begin_layout Plain Layout
16856 : The changed shape only applies to the current paragraph; everything is
16857 reset to normal for the next paragraph.
16858 Therefore the shape definition file must be input into every paragraph
16859 with the desired shape.
16867 \begin_layout Standard
16868 \begin_inset VSpace bigskip
16874 \begin_layout Standard
16875 Here is an example:
16878 \begin_layout Standard
16879 \begin_inset VSpace bigskip
16885 \begin_layout Standard
16886 \begin_inset CommandInset include
16888 filename "SpecialParagraphShape.tex"
16895 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16896 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16898 At vero eos et accusam et justo duo dolores et ea rebum.
16899 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
16901 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16902 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16906 \begin_layout Standard
16907 \begin_inset VSpace bigskip
16913 \begin_layout Standard
16918 to draw complexer shapes in
16922 you can draw the shape in a program of your choice and import the resulting
16928 Then you only need to draw a line or spline along the outline of the image.
16931 \begin_layout Standard
16932 \begin_inset VSpace bigskip
16938 \begin_layout Standard
16941 Custom paragraph shapes
16943 also provides the two commands
16951 which can be used to define custom shapes coordinate by coordinate.
16955 \begin_layout Plain Layout
16956 These commands are internally used for all shapes described here.
16961 For information how these styles are used and about further customization
16962 possibilities, have a look at the
16963 \begin_inset CommandInset href
16965 name "documentation"
16966 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
16972 \begin_inset Flex Code
16975 \begin_layout Plain Layout
16984 \begin_layout Chapter
16986 \change_deleted 564990737 1671304317
16990 \change_inserted 564990737 1671304322
16992 \change_deleted 564990737 1671304331
16993 ies with Bib\SpecialChar TeX
16999 \begin_layout Standard
17000 The most basic information about how to use Bib\SpecialChar TeX
17005 with \SpecialChar LyX
17006 is contained in the section
17008 Bibliography databases
17015 The following subsections explain special bibliography features supported
17016 by \SpecialChar LyX
17020 \begin_layout Section
17021 Alternative Citation Styles
17024 \begin_layout Standard
17025 Standard Bib\SpecialChar TeX
17027 \begin_inset space \thinspace{}
17031 \begin_inset space \space{}
17035 \begin_inset Quotes eld
17039 \begin_inset Quotes erd
17042 ) to refer to a cited work.
17043 However, in many scientific disciplines, other citation styles are in use.
17044 The most common one is the author-year style (e.
17045 \begin_inset space \thinspace{}
17049 \begin_inset space \space{}
17053 \begin_inset Quotes eld
17057 \begin_inset Quotes erd
17062 supports three packages that provide this style,
17063 \begin_inset Flex Code
17066 \begin_layout Plain Layout
17073 \begin_inset Flex Code
17076 \begin_layout Plain Layout
17083 \begin_inset Flex Code
17086 \begin_layout Plain Layout
17093 Each of these packages has their pros and cons, which cannot be listed
17095 If you only want to have simple author-year (or author-numerical) style,
17096 or if you want to use one of the countless style files for
17097 \begin_inset Flex Code
17100 \begin_layout Plain Layout
17106 , then the established
17107 \begin_inset Flex Code
17110 \begin_layout Plain Layout
17116 package is probably your choice.
17117 If you look for specific citation styles common in law studies, you might
17119 \begin_inset Flex Code
17122 \begin_layout Plain Layout
17129 If you want to have full control over the formatting or look for advanced
17130 features such as ibidem, footnote citations, full title citations, advanced
17131 date formats (such as 400 BC) or full localization to other languages than
17132 English, you should definitely consider
17133 \begin_inset Flex Code
17136 \begin_layout Plain Layout
17142 , which exceeds all other packages in terms of features, but is also quite
17143 heavy and more resource-hungry.
17146 \begin_layout Standard
17147 The handling of these packages in \SpecialChar LyX
17148 is basically the same.
17150 \begin_inset Flex Noun
17153 \begin_layout Plain Layout
17154 Document\SpecialChar menuseparator
17161 \begin_inset Flex Noun
17164 \begin_layout Plain Layout
17171 \begin_inset Flex Noun
17174 \begin_layout Plain Layout
17181 \begin_inset Flex Noun
17184 \begin_layout Plain Layout
17191 \begin_inset Flex Noun
17194 \begin_layout Plain Layout
17201 \begin_inset Flex Noun
17204 \begin_layout Plain Layout
17205 Biblatex (Natbib mode)
17211 \begin_inset Flex Noun
17214 \begin_layout Plain Layout
17221 \begin_inset Flex Noun
17224 \begin_layout Plain Layout
17231 \begin_inset space ~
17234 6.5.3 in the User's Guide for more information on these choices).
17235 With all these packages, you will get some extra features in the citation
17236 dialog and you can select the style of the reference (
17237 \begin_inset Quotes eld
17241 \begin_inset Quotes erd
17245 \begin_inset Quotes eld
17249 \begin_inset Quotes erd
17253 \begin_inset Quotes eld
17257 \begin_inset Quotes erd
17261 \begin_inset Quotes eld
17265 \begin_inset Quotes erd
17269 Note that either package needs specifically designed style files.
17270 They all ship their own, but there are lots of additional style files,
17271 and there is even an interactive style file builder
17275 \begin_layout Plain Layout
17277 \begin_inset Flex URL
17280 \begin_layout Plain Layout
17282 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
17293 \begin_inset Flex Code
17296 \begin_layout Plain Layout
17305 \begin_layout Section
17306 Subdivided Bibliographies
17309 \begin_layout Standard
17310 Sometimes you might need to divide your bibliography into several sections.
17311 If you are for instance a historian, the possibility to separate sources
17312 and scientific works is most likely a
17313 \begin_inset Quotes eld
17317 \begin_inset Quotes erd
17321 Unfortunately, Bib\SpecialChar TeX
17322 itself does not allow you to do this.
17323 But with the help of some \SpecialChar LaTeX
17324 packages, Bib\SpecialChar TeX
17325 can be extended to fit your needs.
17328 \begin_layout Standard
17330 provides native support for one of these packages,
17338 \begin_layout Plain Layout
17340 \begin_inset Flex URL
17343 \begin_layout Plain Layout
17345 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
17355 The advantage of this package (compared to other packages such as
17359 ) is that you don't need to define new citation commands.
17360 Instead, you need to prepare different bibliographic databases which include
17361 the entries for the different sections of the bibliography.
17362 For example: If you want to divide your bibliography into the sections
17364 \begin_inset Quotes eld
17368 \begin_inset Quotes erd
17372 \begin_inset Quotes eld
17376 \begin_inset Quotes erd
17379 , you first need to create two bibliographic databases, e.
17380 \begin_inset space \thinspace{}
17384 \begin_inset space \space{}
17388 \begin_inset Flex Code
17391 \begin_layout Plain Layout
17398 \begin_inset Flex Code
17401 \begin_layout Plain Layout
17411 \begin_layout Standard
17413 \begin_inset Flex Noun
17416 \begin_layout Plain Layout
17417 Document\SpecialChar menuseparator
17424 \begin_inset Flex Noun
17427 \begin_layout Plain Layout
17434 \begin_inset Flex Noun
17437 \begin_layout Plain Layout
17438 Subdivided bibliography
17444 Now you can insert multiple Bib\SpecialChar TeX
17445 bibliographies, one for each section of
17447 Returning to our example: Insert the Bib\SpecialChar TeX
17449 \begin_inset Flex Code
17452 \begin_layout Plain Layout
17458 and a second one for the database
17459 \begin_inset Flex Code
17462 \begin_layout Plain Layout
17469 You are free to use the same or different styles for each section.
17470 Additionally, you can choose if the bibliography section should contain
17472 \begin_inset Quotes eld
17475 all cited references
17476 \begin_inset Quotes erd
17479 of the specified database(s) (which is the default),
17480 \begin_inset Quotes eld
17483 all uncited references
17484 \begin_inset Quotes erd
17488 \begin_inset Quotes eld
17492 \begin_inset Quotes erd
17496 This might be useful if you would like to separate your bibliography into
17498 \begin_inset Quotes eld
17502 \begin_inset Quotes erd
17506 \begin_inset Quotes eld
17510 \begin_inset Quotes erd
17514 \begin_inset Quotes eld
17518 \begin_inset Quotes erd
17522 The titles for the sections can be added as ordinary sections or subsections.
17524 \begin_inset Flex Code
17527 \begin_layout Plain Layout
17533 removes the bibliography title, you have to manually re-add that, too (as
17534 a chapter* or section*, for instance).
17537 \begin_layout Standard
17542 , the procedure is a bit different.
17551 , the aforementioned
17552 \begin_inset Flex Noun
17555 \begin_layout Plain Layout
17556 Subdivided bibliography
17561 option is disabled if you use
17570 provides its own means to generate subdivided bibliographies.
17571 You can either add keywords to bibliography entries via the
17572 \begin_inset Flex Code
17575 \begin_layout Plain Layout
17581 entry option and then filter bibliography sections by keyword (by adding
17583 \begin_inset Flex Code
17586 \begin_layout Plain Layout
17593 \begin_inset Flex Noun
17596 \begin_layout Plain Layout
17602 field of the dialog that opens if you left-click on the
17603 \begin_inset Flex Noun
17606 \begin_layout Plain Layout
17607 Biblatex Generated Bibliography
17612 button), or you can filter by entry types (such as
17621 \begin_inset space \thinspace{}
17626 \begin_inset Flex Code
17629 \begin_layout Plain Layout
17636 \begin_inset Flex Code
17639 \begin_layout Plain Layout
17646 \begin_inset Flex Noun
17649 \begin_layout Plain Layout
17655 field, or you can create so-called
17656 \begin_inset Quotes eld
17659 Bibliography Categories
17660 \begin_inset Quotes erd
17663 to which you can assign individual entries.
17664 Please refer to the Biblatex manual, section
17666 Subdivided Bibliographies
17671 \begin_layout Section
17672 Multiple Bibliographies
17673 \begin_inset CommandInset label
17675 name "subsec:Multiple-Bibliographies"
17682 \begin_layout Standard
17683 Multiple bibliographies, e.
17684 \begin_inset space \thinspace{}
17688 \begin_inset space \space{}
17691 a bibliography for each part, chapter, section, subsection or child (sub-documen
17692 t) of the document, are also supported by \SpecialChar LyX
17694 In order to enable it, go to
17695 \begin_inset Flex Noun
17698 \begin_layout Plain Layout
17699 Document\SpecialChar menuseparator
17700 Settings\SpecialChar menuseparator
17706 and select the relevant unit (e.
17707 \begin_inset space \thinspace{}
17711 \begin_inset Quotes eld
17715 \begin_inset Quotes erd
17719 \begin_inset Flex Noun
17722 \begin_layout Plain Layout
17723 Multiple Bibliographies
17729 Then add a Bib(la)\SpecialChar TeX
17730 bibliography to each unit (e.
17731 \begin_inset space \thinspace{}
17734 g., section) of your document.
17735 In the output, a separate bibliography, containing only the references
17736 done in the current unit is generated.
17739 \begin_layout Standard
17740 If you use Bib\SpecialChar TeX
17742 \begin_inset Flex Code
17745 \begin_layout Plain Layout
17752 \begin_inset Flex Code
17755 \begin_layout Plain Layout
17761 package is used to create multiple bibliographies.
17762 The former package is used if you select
17763 \begin_inset Quotes eld
17767 \begin_inset Quotes erd
17775 \begin_inset Flex Noun
17778 \begin_layout Plain Layout
17779 Sectioned Bibliography
17785 In all other cases,
17786 \begin_inset Flex Code
17789 \begin_layout Plain Layout
17799 \begin_layout Plain Layout
17800 An alternative approach, if you are willing to use some
17801 \begin_inset Flex Noun
17804 \begin_layout Plain Layout
17812 \begin_inset space ~
17816 \begin_inset CommandInset ref
17818 reference "sec:Inserting-TeX-Code"
17823 \begin_inset Flex Code
17826 \begin_layout Plain Layout
17838 \begin_inset Flex Code
17841 \begin_layout Plain Layout
17847 is used, \SpecialChar LyX
17848 encloses the specified units in
17849 \begin_inset Flex Code
17852 \begin_layout Plain Layout
17859 \begin_inset Flex Code
17862 \begin_layout Plain Layout
17871 \begin_inset Flex Code
17874 \begin_layout Plain Layout
17882 in order to create the units.
17883 Note that this approach has some limitations.
17884 First, every citation reference has to be inside some
17885 \begin_inset Flex Code
17888 \begin_layout Plain Layout
17895 So citations outside a defined unit (e.
17896 \begin_inset space \thinspace{}
17899 g., before the first section if you use
17900 \begin_inset Quotes eld
17904 \begin_inset Quotes erd
17908 \begin_inset Quotes eld
17912 \begin_inset Quotes erd
17916 You can also create your own units by entering
17917 \begin_inset Flex Code
17920 \begin_layout Plain Layout
17929 \begin_inset Flex Code
17932 \begin_layout Plain Layout
17940 as \SpecialChar TeX
17941 code (for instance to work around the mentioned limitation).
17943 \begin_inset Flex Code
17946 \begin_layout Plain Layout
17952 s cannot be nested.
17953 A second limitation is that
17954 \begin_inset Flex Code
17957 \begin_layout Plain Layout
17963 always processes all references of a bibliography database, even if they
17965 This can result in odd labels (e.
17966 \begin_inset space \thinspace{}
17971 \begin_inset Quotes eld
17975 \begin_inset Quotes erd
17978 if two works of this author from 2014 are in the database, even if only
17982 \begin_layout Standard
17988 \begin_inset Flex Code
17991 \begin_layout Plain Layout
17997 option is used instead.
17998 If you need specific units, you can start them with the \SpecialChar TeX
18000 \begin_inset Flex Code
18003 \begin_layout Plain Layout
18012 \begin_inset Flex Code
18015 \begin_layout Plain Layout
18024 If you also want to control the end of the unit, use the environment
18025 \begin_inset Flex Code
18028 \begin_layout Plain Layout
18038 \begin_inset Flex Code
18041 \begin_layout Plain Layout
18051 \begin_inset Flex Code
18054 \begin_layout Plain Layout
18060 s cannot be nested.
18061 In addition to the individual bibliography of the current unit,
18065 also provides an easy way to output all bibliographies, subsequently, at
18067 \begin_inset space \thinspace{}
18070 g., at the end of the document).
18072 \begin_inset Quotes eld
18075 all reference units
18076 \begin_inset Quotes erd
18079 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
18081 Please refer to the
18085 manual for more information on this topic.
18088 \begin_layout Chapter
18090 \change_deleted 564990737 1671355654
18094 \change_inserted 564990737 1671355667
18096 \change_deleted 564990737 1671355661
18098 \change_inserted 564990737 1671355684
18100 \begin_inset CommandInset label
18102 name "chap:bullets"
18107 \change_deleted 564990737 1671355684
18109 \begin_inset CommandInset label
18120 \begin_layout Standard
18126 \begin_layout Section
18130 \begin_layout Standard
18132 provides 216 bullet shapes that can be accessed from a simple dialog.
18133 Using this dialog you can easily specify what bullet shape to use at each
18134 level of an itemized list.
18135 These settings are document-wide so you won't be able to specify different
18136 sets of bullets for different paragraphs.
18140 \begin_layout Plain Layout
18141 Well, actually you can but you'll have to do it by hand.
18149 \begin_layout Section
18153 \begin_layout Standard
18154 Open the dialog by selecting the
18155 \begin_inset Flex Noun
18158 \begin_layout Plain Layout
18159 Document\SpecialChar menuseparator
18165 menu item and then select the
18166 \begin_inset Flex Noun
18169 \begin_layout Plain Layout
18178 \begin_layout Standard
18179 The dialog provides you with a table of bullet shapes.
18180 A column of buttons on the left of the table provides access to the six
18181 different panels of bullet shapes.
18182 The row of buttons across the top is used to select which bullet depth
18185 \change_deleted 244031559 1603875981
18186 A text entry under the table shows the currently selected bullet shape's
18188 equivalent and this can be edited if desired.
18189 If you do modify the text you will also need to specify any needed packages
18190 in the \SpecialChar LaTeX
18196 \begin_layout Standard
18197 The six panels are divided up by the packages they require.
18198 The following table shows the mappings from button name to \SpecialChar LaTeX
18202 \begin_layout Standard
18204 \begin_inset Tabular
18205 <lyxtabular version="3" rows="7" columns="2">
18206 <features tabularvalignment="middle">
18207 <column alignment="center" valignment="top" width="0pt">
18208 <column alignment="center" valignment="top" width="0pt">
18210 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
18213 \begin_layout Plain Layout
18228 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
18231 \begin_layout Plain Layout
18248 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
18251 \begin_layout Plain Layout
18266 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
18269 \begin_layout Plain Layout
18278 base \SpecialChar LaTeX
18286 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
18289 \begin_layout Plain Layout
18304 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
18307 \begin_layout Plain Layout
18324 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
18327 \begin_layout Plain Layout
18342 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
18345 \begin_layout Plain Layout
18362 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
18365 \begin_layout Plain Layout
18380 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
18383 \begin_layout Plain Layout
18400 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
18403 \begin_layout Plain Layout
18418 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
18421 \begin_layout Plain Layout
18438 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
18441 \begin_layout Plain Layout
18456 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
18459 \begin_layout Plain Layout
18482 \begin_layout Standard
18484 doesn't stop you using bullets from packages you don't have.
18485 If you get errors from \SpecialChar LaTeX
18486 when you try to view or print the file, then it
18487 is likely you are missing a package.
18491 \begin_layout Plain Layout
18493 doesn't restrict your use since you may be editing locally and exporting
18502 \begin_layout Section
18506 \begin_layout Standard
18507 Select which bullet depth you want to change then select the bullet shape
18509 Any changes will not be visible in \SpecialChar LyX
18510 , but are visible when viewing the document.
18513 \begin_layout Standard
18514 You can reset a bullet shape to the default simply by clicking your right
18515 mouse button on the appropriate bullet depth button.
18519 \begin_layout Plain Layout
18524 want to have multiple sets of paragraphs with different sets of bullets
18525 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
18527 The bullet selection dialog can help though because it provides you with
18528 the \SpecialChar LaTeX
18529 code for a wide range of bullet shapes.
18530 To make your own custom paragraphs you have the following options:
18533 \begin_layout Plain Layout
18537 \begin_layout Plain Layout
18553 \begin_layout Plain Layout
18557 \begin_layout Plain Layout
18579 \begin_layout Itemize
18580 Use the \SpecialChar LaTeX
18582 \begin_inset Flex Code
18585 \begin_layout Plain Layout
18593 to specify a new bullet shape for a given depth.
18594 You'll also need to save the current bullet shape so you can restore it
18596 In this itemized list the following \SpecialChar LaTeX
18597 code was used to change the bullet
18598 used for the first depth.
18602 \begin_layout LyX-Code
18612 \begin_layout LyX-Code
18629 \begin_layout Itemize
18630 Note that the itemize depth is specified in Roman numerals as part of the
18640 \begin_layout Itemize
18641 \begin_inset Argument item:1
18644 \begin_layout Plain Layout
18648 \begin_layout Plain Layout
18666 Specify each individual entry by starting each item with the bullet shape
18668 \begin_inset Quotes eld
18672 \begin_inset Quotes erd
18675 inset (available at
18677 Insert\SpecialChar menuseparator
18681 \begin_inset Flex Noun
18684 \begin_layout Plain Layout
18692 For example, this item was started with
18693 \begin_inset Flex Code
18696 \begin_layout Plain Layout
18711 \begin_layout Plain Layout
18715 \begin_layout Plain Layout
18731 \begin_layout Plain Layout
18732 You'll also need to revert the labelitem back to its previous setting for
18733 the global bullet shape settings to remain in effect.
18734 The way used here was:
18737 \begin_layout LyX-Code
18752 \begin_layout Chapter
18756 \begin_layout Section
18757 Multipart Documents
18760 \begin_layout Subsection
18764 \begin_layout Standard
18765 When you are working on a large file with many sections, it is often convenient
18766 to break up the document into several files, or perhaps you have something
18767 where a table may change from time to time, but the preceding text does
18769 In these cases, you should seriously consider using multipart documents.
18770 For example, scientific papers often have five major sections: the introduction
18771 , observations, results, discussion, and conclusion.
18772 Each of these could be its own separate \SpecialChar LyX
18774 \begin_inset Quotes eld
18778 \begin_inset Quotes erd
18781 file which contains the title, authors, abstract, references, etc., plus
18782 the five included files.
18783 It is important to note that each of these files is a full \SpecialChar LyX
18785 can be formatted and printed on its own, as well as included in a master
18787 Each of these files must have the same document class, however—don't attempt
18788 to mix book classes with article classes.
18789 You may also include \SpecialChar LaTeX
18790 files; however, these files must not have their own
18792 \begin_inset space \thinspace{}
18796 \begin_inset space \space{}
18799 everything up to and including the
18800 \begin_inset Flex Code
18803 \begin_layout Plain Layout
18811 line as well as the
18812 \begin_inset Flex Code
18815 \begin_layout Plain Layout
18823 line must be deleted) or else errors will be generated when you try to
18827 \begin_layout Standard
18829 allows you to include files quite easily with
18830 \begin_inset Flex Noun
18833 \begin_layout Plain Layout
18834 Insert\SpecialChar menuseparator
18836 \begin_inset space ~
18845 When you click on this selection a small box is inserted into the file
18846 at the current cursor location.
18847 Clicking on the box raises a dialog which allows you to select the file
18848 to be included, and the method of its inclusion.
18852 \begin_layout Standard
18853 The file selection box should by now be obvious.
18854 The three inclusion methods are
18855 \begin_inset Quotes eld
18859 \begin_inset Quotes erd
18863 \begin_inset Quotes eld
18867 \begin_inset Quotes erd
18871 \begin_inset Quotes eld
18875 \begin_inset Quotes erd
18880 \begin_inset Quotes eld
18884 \begin_inset Quotes erd
18888 \begin_inset Quotes eld
18892 \begin_inset Quotes erd
18895 are similar in many ways, but there are also some notable differences:
18898 \begin_layout Enumerate
18900 \begin_inset Quotes eld
18904 \begin_inset Quotes erd
18907 are typeset beginning on a new page, while files that are
18908 \begin_inset Quotes eld
18912 \begin_inset Quotes erd
18915 are typeset starting on the current page.
18918 \begin_layout Enumerate
18919 \begin_inset Quotes eld
18923 \begin_inset Quotes erd
18926 files cannot themselves
18927 \begin_inset Quotes eld
18931 \begin_inset Quotes erd
18935 \begin_inset Quotes eld
18939 \begin_inset Quotes erd
18944 \begin_inset Quotes eld
18948 \begin_inset Quotes erd
18951 , on the other hand, infinite sub-inputting is possible.
18954 \begin_layout Enumerate
18955 \begin_inset Quotes eld
18959 \begin_inset Quotes erd
18962 allow for the output of only selected
18963 \begin_inset Quotes eld
18967 \begin_inset Quotes erd
18970 files, while maintaining the actual counters (pagination etc.) and references
18971 (please refer to the section
18974 \begin_inset space ~
18982 \begin_inset space ~
18987 manual for details).
18990 \begin_layout Standard
18992 \begin_inset Quotes eld
18996 \begin_inset Quotes erd
18999 is the preferred method for chapters that are outsourced to child documents,
19001 \begin_inset Quotes eld
19005 \begin_inset Quotes erd
19008 is more suitable for arbitrary file inheritance.
19011 \begin_layout Standard
19013 \begin_inset Quotes eld
19017 \begin_inset Quotes erd
19020 included file allows you to include a file typeset exactly as it appears
19022 \begin_inset space \thinspace{}
19026 \begin_inset space \space{}
19030 \begin_inset Flex Code
19033 \begin_layout Plain Layout
19039 mode, with the characters set in a fixed-width typewriter font.
19040 Normally, spaces in this file are invisible, though two consecutive spaces
19041 are conserved, unlike \SpecialChar LyX
19042 's normal treatment of spaces.
19043 However, setting the
19044 \begin_inset Flex Noun
19047 \begin_layout Plain Layout
19049 \begin_inset space ~
19053 \begin_inset space ~
19057 \begin_inset space ~
19065 checkbox typesets a mark to unambiguously define the presence of a space.
19069 \begin_layout Standard
19070 Generally, the master file is converted into a full \SpecialChar LaTeX
19071 file before typesetting,
19072 while the included files are converted to \SpecialChar LaTeX
19073 files that do not have all the
19074 preamble information.
19077 \begin_layout Subsection
19078 Cross-References Between Files
19081 \begin_layout Standard
19082 \begin_inset Box Shadowbox
19092 height_special "totalheight"
19097 backgroundcolor "none"
19100 \begin_layout Plain Layout
19101 This section is somewhat out of date.
19102 Need to describe default master documents and how children are opened when
19112 \begin_layout Standard
19113 It is possible to set up cross-references between the different files.
19114 First, open all the files in question: let's call them A and B in a two
19115 file example, where B is included in A.
19116 Let's say you insert a label in A, then want to reference it in B.
19117 Open the cross-reference dialog whilst in document B, and you can select
19119 \begin_inset Quotes eld
19123 \begin_inset Quotes erd
19129 \begin_layout Subsection
19130 Bibliography Lists in all Subdocuments
19133 \begin_layout Standard
19134 If you work with child documents, you might want to have only one main bibliogra
19135 phy at the end, but still be able to have a selected bibliography for the
19136 child if you output it on its own.
19137 Here is how to achieve this.
19140 \begin_layout Standard
19141 For the main document, you just insert a bibliography inset at the place
19142 where the main bibliography has to appear (within the master file or within
19144 If the bibliography inset is in the master file, the references will be
19145 inherited by all children, so they are available in the citation dialog
19149 \begin_layout Standard
19150 For child-specific bibliographies, insert bibliography insets within the
19151 child documents, at the place where the bibliography should appear when
19152 the child is compiled separately.
19153 However, the trick is to insert them into a branch (
19155 Insert\SpecialChar menuseparator
19156 Branch\SpecialChar menuseparator
19157 Insert New Branch...
19160 \begin_inset space \thinspace{}
19165 \begin_inset Quotes eld
19169 \begin_inset Quotes erd
19173 Within the children, activate the branch (
19175 Document\SpecialChar menuseparator
19176 Settings...\SpecialChar menuseparator
19180 Within the master, deactivate the branch (
19182 Document\SpecialChar menuseparator
19183 Settings...\SpecialChar menuseparator
19187 Now the child's bibliography will be ignored by the master, but considered
19191 \begin_layout Standard
19192 If you need multiple bibliographies (e.
19193 \begin_inset space \thinspace{}
19196 g., one per child in the
19200 ), please refer to sec.
19201 \begin_inset space ~
19205 \begin_inset CommandInset ref
19207 reference "subsec:Multiple-Bibliographies"
19214 \begin_layout Section
19219 \begin_layout Standard
19220 Users sometimes need to be able to
19221 \begin_inset Quotes eld
19225 \begin_inset Quotes erd
19229 file together with all the images (and other files) on which it depends,
19230 either for sending to a publisher or for sharing with a co-author.
19232 includes a Python script (
19233 \begin_inset Flex Code
19236 \begin_layout Plain Layout
19242 ) that automates this process.
19243 To use it, you must have either the
19244 \begin_inset Flex Code
19247 \begin_layout Plain Layout
19254 \begin_inset Flex Code
19257 \begin_layout Plain Layout
19263 python modules installed on your system.
19264 By default, the script prefers the
19265 \begin_inset Flex Code
19268 \begin_layout Plain Layout
19275 \begin_inset Flex Code
19278 \begin_layout Plain Layout
19284 format on Unix-like systems and the
19285 \begin_inset Flex Code
19288 \begin_layout Plain Layout
19297 \begin_layout Standard
19299 's configuration process will set the script up to export a `\SpecialChar LyX
19301 and this format will then be available under
19302 \begin_inset Flex Code
19305 \begin_layout Plain Layout
19306 File\SpecialChar menuseparator
19315 \begin_layout Standard
19316 Independently of the platform, the generation of a particular archive format
19317 can be forced by adding either the
19318 \begin_inset Flex Code
19321 \begin_layout Plain Layout
19328 \begin_inset Flex Code
19331 \begin_layout Plain Layout
19338 \begin_inset Flex Code
19341 \begin_layout Plain Layout
19348 \begin_inset Flex Code
19351 \begin_layout Plain Layout
19357 format) switch to the
19358 \begin_inset Flex Code
19361 \begin_layout Plain Layout
19363 \SpecialChar menuseparator
19371 \begin_inset Flex Code
19374 \begin_layout Plain Layout
19375 Tools\SpecialChar menuseparator
19376 Preferences\SpecialChar menuseparator
19377 File Handling\SpecialChar menuseparator
19384 (Make sure you add the switch after the script name, not before it.)
19387 \begin_layout Section
19388 Fancy Headers and Footers
19391 \begin_layout Standard
19392 The default page layout is rather plain; for an
19393 \begin_inset Flex Code
19396 \begin_layout Plain Layout
19402 document class, all you get is a centered page number at the bottom of
19404 This document uses KOMA-script's book class, so it appears to be a bit
19406 But to really put on a show, you need to set the document page style to
19408 \begin_inset Quotes eld
19412 \begin_inset Quotes erd
19415 , as mentioned in the
19420 This section describes the \SpecialChar LaTeX
19421 code you need to insert in your \SpecialChar LaTeX
19423 order to get the desired effects.
19426 \begin_layout Standard
19427 For more information on fancy headers, see the
19428 \begin_inset Flex Code
19431 \begin_layout Plain Layout
19437 package documentation.
19439 \begin_inset Flex URL
19442 \begin_layout Plain Layout
19444 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
19452 \begin_layout Standard
19453 The page header is divided into three fields, not surprisingly labeled
19454 \begin_inset Quotes eld
19458 \begin_inset Quotes erd
19462 \begin_inset Quotes eld
19466 \begin_inset Quotes erd
19470 \begin_inset Quotes eld
19474 \begin_inset Quotes erd
19478 The footer is also divided into these three fields.
19479 The \SpecialChar LaTeX
19480 commands to set these fields in the simplest manner are
19481 \begin_inset Flex Code
19484 \begin_layout Plain Layout
19493 \begin_inset Flex Code
19496 \begin_layout Plain Layout
19505 \begin_inset Flex Code
19508 \begin_layout Plain Layout
19517 \begin_inset Flex Code
19520 \begin_layout Plain Layout
19529 Suppose you wish to put your name in the upper left hand corner of each
19531 Simply insert the following command in the preamble:
19534 \begin_layout Standard
19543 \begin_layout Standard
19544 You will now see your name in the upper left.
19545 If a field has a default entry that you would like to get rid of (often
19546 the page number appears in the central footer) simply include a command
19547 with a blank argument, e.
19548 \begin_inset space \thinspace{}
19554 \begin_layout Standard
19562 \begin_layout Standard
19563 Let's get really fancy: lets put the section number with the word
19564 \begin_inset Quotes eld
19568 \begin_inset Quotes erd
19572 \begin_inset space \thinspace{}
19576 \begin_inset space \space{}
19579 Section 3) in the upper left, the page number (e.
19580 \begin_inset space \thinspace{}
19584 \begin_inset space \space{}
19587 Page 4) in the upper right, your name in the lower left, and the date in
19589 The following commands should now appear in the preamble:
19592 \begin_layout Standard
19602 \begin_layout Standard
19610 \begin_layout Standard
19620 \begin_layout Standard
19629 \begin_layout Standard
19637 \begin_layout Standard
19647 \begin_layout Standard
19649 \begin_inset Flex Code
19652 \begin_layout Plain Layout
19661 \begin_inset Flex Code
19664 \begin_layout Plain Layout
19672 access \SpecialChar LaTeX
19673 's section and page counters, and so print out the current section
19676 \begin_inset Flex Code
19679 \begin_layout Plain Layout
19687 simply prints out today's date.
19690 \begin_layout Standard
19691 The thicknesses of the horizontal rules drawn beneath the header and above
19692 the footer can also be modified.
19693 If you don't want one of the rules, set its thickness to 0.
19694 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
19700 \begin_inset Flex Code
19703 \begin_layout Plain Layout
19708 headrulewidth}{0.4pt}
19714 \begin_inset Flex Code
19717 \begin_layout Plain Layout
19722 footrulewidth}{0.4pt}
19727 to set the thicknesses.
19730 \begin_layout Standard
19731 You can switch the header/footer settings on and off for individual pages
19732 using commands like
19733 \begin_inset Flex Code
19736 \begin_layout Plain Layout
19739 thispagestyle{empty}
19745 \begin_inset Flex Code
19748 \begin_layout Plain Layout
19751 thispagestyle{plain}
19757 \begin_inset Flex Code
19760 \begin_layout Plain Layout
19763 thispagestyle{fancy}
19769 Simply insert them in the text on the page you want changed and mark them
19770 as \SpecialChar TeX
19772 In fact, title pages are marked as plain by default, while following pages
19773 are marked fancy when using the global fancy setting.
19776 \begin_layout Standard
19777 As a final example, it is possible to include an image in the header or
19779 Suppose you want to put a company logo in the upper lefthand corner.
19780 You might try something like
19783 \begin_layout Standard
19792 includegraphics{logo.eps}}}
19795 \begin_layout Standard
19797 (you may need to preface this with
19798 \begin_inset Flex Code
19801 \begin_layout Plain Layout
19804 usepackage{graphics}
19809 if you don't include graphics elsewhere in your document).
19812 \begin_layout Chapter
19814 and the World Wide Web
19817 \begin_layout Standard
19819 has long supported the export of documents to various web-friendly formats,
19821 Before version 2.0, however, HTML export was always accomplished by the
19822 use of external converters.
19826 \begin_layout Plain Layout
19827 For details on the use of external converters with \SpecialChar LyX
19832 section of the Customization manual.
19837 These fall into two large groups: there are converters that use \SpecialChar LaTeX
19839 intermediate format, such as
19840 \begin_inset Flex Code
19843 \begin_layout Plain Layout
19850 \begin_inset Flex Code
19853 \begin_layout Plain Layout
19860 \begin_inset Flex Code
19863 \begin_layout Plain Layout
19869 , relying upon \SpecialChar LyX
19870 to produce the \SpecialChar LaTeX
19871 ; and there is a converter that works directly
19872 on \SpecialChar LyX
19874 \begin_inset Flex Code
19877 \begin_layout Plain Layout
19885 All of these have different advantages and disadvantages.
19889 \begin_layout Standard
19890 The \SpecialChar LaTeX
19891 -based converters have the advantage that, in principle, they know everythin
19892 g about the exported document that \SpecialChar LaTeX
19894 Such converters do not care, for example, if a certain block of code was
19895 produced by \SpecialChar LyX
19896 or was Evil Red Text.
19897 These converters know about
19898 \begin_inset Flex Code
19901 \begin_layout Plain Layout
19907 files, counters, and references, and can often make use of the
19908 \begin_inset Flex Code
19911 \begin_layout Plain Layout
19917 files generated by Bib\SpecialChar TeX
19919 On the other hand, \SpecialChar LaTeX
19920 is a very hard language to parse—it is sometimes said
19921 that only \SpecialChar TeX
19922 itself understands \SpecialChar TeX
19923 —and \SpecialChar LaTeX
19924 -based converters will often choke on
19925 what seem to be quite simple constructs; complex ones can throw them completely
19926 , and as of this writing, for example, the
19930 manual will not export with
19931 \begin_inset Flex Code
19934 \begin_layout Plain Layout
19940 , though the others will.
19941 The other issue concerns how math is handled.
19942 These converters typically convert the formulae into little pictures that
19943 are then linked from the HTML document.
19944 Since these are actually generated by \SpecialChar LaTeX
19945 , they are accurate.
19946 But they do not scale well, and just getting them to look as if they are
19947 actually meant to be in your document—so that the font sizes seem to be
19948 roughly the same—can be a challenge.
19951 \begin_layout Standard
19953 \begin_inset Flex Code
19956 \begin_layout Plain Layout
19964 \begin_inset CommandInset href
19966 name "http://pinchito.es/elyxer/"
19967 target "http://pinchito.es/elyxer/"
19972 ) solves some of these problems.
19973 In particular, the formulae it produces scale perfectly, since it renders
19974 math using a combination of HTML and CSS rather than converting the formulae
19976 But even moderately complex formula are rendered less well than with
19977 \begin_inset Flex Code
19980 \begin_layout Plain Layout
19986 ; this reflects the limitations of HTML.
19990 \begin_layout Plain Layout
19992 \begin_inset Flex Code
19995 \begin_layout Plain Layout
20002 can also use jsMath and MathJax for equations, but this setting is only
20003 available globally and requires one to have access to a server that runs
20009 More importantly (as of version 1.1.1, at least),
20010 \begin_inset Flex Code
20013 \begin_layout Plain Layout
20020 has limited support for math macros and no support for user-defined paragraph
20021 or character styles.
20022 These limitations make
20023 \begin_inset Flex Code
20026 \begin_layout Plain Layout
20033 unsuitable for many of the documents \SpecialChar LyX
20035 In principle, of course, these problems could be solved, but the \SpecialChar LyX
20037 have decided to follow a different path and have made \SpecialChar LyX
20039 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
20040 , DocBook, and plaintext.
20043 \begin_layout Standard
20044 As of this writing, XHTML output remains under development and should probably
20046 \begin_inset Quotes eld
20050 \begin_inset Quotes erd
20057 \begin_layout Plain Layout
20059 \begin_inset Flex Code
20062 \begin_layout Plain Layout
20063 development/HTML/HTML.notes
20068 , which can be found in the \SpecialChar LyX
20070 \begin_inset CommandInset href
20072 name "accessed online"
20073 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
20078 , usually contains up-to-date information about the state of XHTML output.
20079 See also the list of XHTML bugs on
20080 \begin_inset CommandInset href
20082 name "the bug tracker"
20083 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"
20093 Still, the developers have chosen this approach because it has several
20094 potential advantages over the other two.
20097 \begin_layout Standard
20098 These advantages are primarily due to the fact that the XHTML output routines,
20099 since they are part of \SpecialChar LyX
20100 , know everything \SpecialChar LyX
20101 knows about the document being
20106 \begin_layout Plain Layout
20107 Another advantage is that, since these routines are internal to \SpecialChar LyX
20109 immune to changes in \SpecialChar LyX
20110 's file format, or to changes in the semantics of
20116 So they know about the table of contents (as displayed in the outline),
20117 about the counters associated with different paragraph styles, and about
20118 user-defined styles.
20119 The XHTML output routines know what \SpecialChar LyX
20120 knows about internationalization,
20121 too, so they will output
20122 \begin_inset Quotes eld
20126 \begin_inset Quotes erd
20130 \begin_inset Quotes eld
20138 \begin_inset Quotes erd
20141 , depending upon the language in effect at the time.
20145 \begin_layout Standard
20146 Quite generally, the output routines know what \SpecialChar LyX
20147 knows about document layout,
20148 that is, about how the document is to be rendered on screen.
20149 We use this information when we output the document as XHTML.
20150 In particular, \SpecialChar LyX
20155 generates CSS style information corresponding to the layout information
20156 it uses to render the document on screen: if section headings are supposed
20157 to be sans-serif and bold as seen in \SpecialChar LyX
20158 , then (by default) they will be sans-seri
20159 f and bold when viewed in a web browser, too.
20160 And this is true not just for pre-defined styles, like Section, but for
20161 any style, including user-defined styles.
20162 Indeed, the XHTML output routines make no distinction between user-defined
20164 \change_deleted 244031559 1603876931
20166 \change_inserted 244031559 1603876940
20169 styles and \SpecialChar LyX
20170 's own pre-defined styles: in each case, everything \SpecialChar LyX
20172 the styles is contained in the layout files.
20173 And much the same is true as regards pre-defined textual insets, such as
20174 footnotes, and various custom insets.
20178 \begin_layout Standard
20179 The result is that XHTML output can be customized and extended in exactly
20180 the same way \SpecialChar LaTeX
20181 output can be customized and extended: through layout files
20183 See chapter five of the
20187 manual for the details.
20190 \begin_layout Standard
20191 The remainder of this chapter contains more detailed information on XHTML
20192 output, its limitations, and ways to work around those limitations.
20195 \begin_layout Section
20196 Math Output in XHTML
20199 \begin_layout Standard
20201 offers four choices for how math is rendered.
20202 These have various advantages and disadvantages:
20205 \begin_layout Itemize
20207 \begin_inset Newline newline
20210 MathML is a dialect of XML designed specifically for mathematics on the
20211 web, and it typically renders very well in browsers that support it.
20212 The disadvantage is that not all browsers support MathML, and support is
20213 not complete even in the Gecko-based browsers, such as Firefox.
20214 \begin_inset Newline newline
20217 If \SpecialChar LyX
20218 is unable to render a formula as MathML—for example, if the formula
20220 \begin_inset Flex Code
20223 \begin_layout Plain Layout
20229 package or ERT—then it will instead output the formula as an image.
20233 \begin_layout Itemize
20235 \begin_inset Newline newline
20238 As mentioned above,
20239 \begin_inset Flex Code
20242 \begin_layout Plain Layout
20248 outputs math as HTML, styled by CSS.
20252 \begin_layout Plain Layout
20254 has borrowed some of the CSS for its HTML output from
20255 \begin_inset Flex Code
20258 \begin_layout Plain Layout
20269 For simple formulae, this can work quite well, though with more complicated
20270 formulae it tends to break down.
20271 Still, this method has the advantage that it is very widely supported and
20272 so it may be appropriate for documents that contain only a little, fairly
20274 \begin_inset Newline newline
20277 If Lyx is unable to render a formula as HTML—for example, if the formula
20279 \begin_inset Flex Code
20282 \begin_layout Plain Layout
20288 package or ERT—then it will instead output the formula as an image.
20292 \begin_layout Itemize
20294 \begin_inset Newline newline
20298 \begin_inset Flex Code
20301 \begin_layout Plain Layout
20308 will output formulae as images, the very same images, in fact, that are
20309 used for instant preview.
20313 \begin_layout Plain Layout
20314 Instant preview does
20318 have to be on for images to be output, however.
20323 The advantage to this method is that the images are simply generated by
20325 , so they are very accurate.
20326 The disadvantage, as mentioned earlier, is that these are bitmapped images,
20327 so they do not scale terribly well, and one cannot copy them, etc.
20328 \begin_inset Newline newline
20331 The size of the images can be controlled by setting the
20332 \begin_inset Quotes eld
20335 Math Images Scaling
20336 \begin_inset Quotes erd
20340 \begin_inset Flex Noun
20343 \begin_layout Plain Layout
20344 Document\SpecialChar menuseparator
20345 Settings\SpecialChar menuseparator
20355 \begin_layout Plain Layout
20356 For those who want to know, this controls the resolution of the image in
20357 dots per inch and is based upon a default of 75 dpi.
20363 \begin_inset Newline newline
20366 If \SpecialChar LyX
20367 for some reason fails to create an image for a formula (e.g., if a required
20369 package is not installed), then it will fall back to outputing the raw
20374 \begin_layout Itemize
20377 \begin_inset Newline newline
20380 Finally, \SpecialChar LyX
20381 will happily output math as \SpecialChar LaTeX
20383 As well as being the output of last resort, this method can be used with
20385 \begin_inset CommandInset href
20388 target "http://www.math.union.edu/~dpvc/jsMath/"
20393 , which uses JavaScript to render \SpecialChar LaTeX
20394 embedded in HTML documents.
20396 wraps the \SpecialChar LaTeX
20398 \begin_inset Flex Code
20401 \begin_layout Plain Layout
20407 (for inline formulas) or
20408 \begin_inset Flex Code
20411 \begin_layout Plain Layout
20417 (for displayed formulas) with
20418 \begin_inset Flex Code
20421 \begin_layout Plain Layout
20427 , as is required for jsMath.
20430 \begin_layout Standard
20431 One of these output methods must be selected under
20432 \begin_inset Flex Noun
20435 \begin_layout Plain Layout
20436 Document\SpecialChar menuseparator
20437 Settings\SpecialChar menuseparator
20444 By default, \SpecialChar LyX
20446 This is a document-wide setting, therefore.
20449 \begin_layout Standard
20450 Eventually, \SpecialChar LyX
20451 will offer the user the option to select an alternate output
20452 method for a particular inset, say, one that isn't being rendered very
20457 \begin_layout Plain Layout
20458 That said, since \SpecialChar LyX
20459 falls back to images if the inset contains ERT, then one
20460 can force output as an image by putting some harmless ERT into the math,
20462 \begin_inset Formula $a=b\relax$
20473 \begin_layout Section
20474 Bibliography and Citations
20477 \begin_layout Standard
20478 XHTML output fully supports bibliographies and citations.
20482 \begin_layout Standard
20483 Citation labels are generated by the same machinery that generates \SpecialChar LyX
20485 labels, so the labels will look in the output much as they do in \SpecialChar LyX
20488 If you are using numerical citations, then \SpecialChar LyX
20489 will output numerical labels,
20490 such as [1] or [17], rather than simply showing the citation key in square
20491 brackets, as it does on-screen.
20492 If you are using author-year citations, then \SpecialChar LyX
20493 will add lowercase letters
20494 to the years, just as Bib\SpecialChar TeX
20495 does, if it finds more than one citation for
20496 a given author-year combination.
20497 The labels will be printed with the bibliography entries.
20498 Note that there is, at present, no way to customize the appearance of the
20499 labels, for example, to choose between square brackets and parentheses.
20502 \begin_layout Standard
20503 Bibliography output is handled by the same machinery that handles the presentati
20504 on of reference information in the citation dialog, so you will see in the
20505 XHTML output pretty much what you would see if you were to look at a given
20506 entry in the citation dialog.
20507 The formatting can be customized in your layout file or, preferably, in
20513 manual for the details.
20516 \begin_layout Standard
20517 The main defect at present is that cross-referenced information is printed
20518 with every entry with which it is associated.
20519 So you can see things like this:
20522 \begin_layout Quote
20524 \begin_inset Quotes eld
20527 Context and Logical Form
20528 \begin_inset Quotes erd
20533 Language in Context: Selected Essays
20535 (Oxford: Oxford University Press, 2007), pp.
20539 \begin_layout Quote
20541 \begin_inset Quotes eld
20544 Semantics in Context
20545 \begin_inset Quotes erd
20550 Language in Context: Selected Essays
20552 (Oxford: Oxford University Press, 2007), pp.
20556 \begin_layout Standard
20557 This should be fixed before long.
20560 \begin_layout Standard
20561 There is no support at present for sectioned bibliographies.
20562 If you have multiple bibliographies, then \SpecialChar LyX
20563 will print the same bibliography
20567 \begin_layout Section
20571 \begin_layout Standard
20573 will happily export indexes as XHTML, but with certain limitations at the
20577 \begin_layout Standard
20578 Index export will be most reliable when you do not attempt to use the fancy
20579 constructs that are described in the section on indexes in the
20587 \begin_layout Plain Layout
20588 The main issue here is that \SpecialChar LyX
20589 itself does not really handle these.
20590 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
20596 We'll describe how they are handled using the subsection headings from
20600 \begin_layout Itemize
20601 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
20602 makes an effort to support these,
20603 but the entries must be separated by
20604 \begin_inset Quotes eld
20608 \begin_inset Quotes erd
20611 , that is, there must be spaces around the exclamation point.
20612 This is because it is otherwise too difficult to check for escaped exclamation
20613 points, ones in math, and so forth.
20616 \begin_layout Itemize
20617 Page Ranges: There is no support at all for page ranges, since these make
20618 no sense with XHMTL.
20619 Instead, you will just get two index entries, one at either end.
20622 \begin_layout Itemize
20623 Cross-referencing: There is no support for cross-referencing.
20624 If \SpecialChar LyX
20625 finds an entry containing the
20626 \begin_inset Quotes eld
20629 |see\SpecialChar ldots
20631 \begin_inset Quotes erd
20634 construct, it is just dropped, and the rest is treated as an ordinary index
20638 \begin_layout Itemize
20639 Index Entry Order: \SpecialChar LyX
20640 does support attempts to fix the sorting order.
20641 It will take what is before the first `@' it finds and use that for sorting,
20642 taking what follows the first `@' to be the actual entry.
20643 At present, \SpecialChar LyX
20644 does not check for escaped `@', so do not try to index email
20648 \begin_layout Itemize
20649 Index Entry Layout: You can format entries by using the text style dialog,
20650 or by using any other method available within \SpecialChar LyX
20652 There is no support for constructs like:
20653 \begin_inset Quotes eld
20657 \begin_inset Quotes erd
20661 Indeed, if \SpecialChar LyX
20662 finds a pipe symbol, `|', in an entry, it will delete it and
20663 everything that follows it.
20666 \begin_layout Itemize
20667 Multiple Indexes: There is no support for multiple indexes.
20668 Rather, all index entries will be printed as one large index.
20669 To avoid our printing several versions of the index, we print only the
20670 main index, so make sure you have one.
20673 \begin_layout Section
20674 Nomenclature and Glossary
20677 \begin_layout Standard
20678 There is at present no support for glossaries.
20679 Adding it would be fairly trivial, and welcome.
20682 \begin_layout Chapter
20684 \change_inserted 1075283030 1616534180
20688 \begin_layout Standard
20690 \change_inserted 1075283030 1616534386
20691 Apart from HTML, \SpecialChar LyX
20692 can generate documents in the DocBook XML vocabulary.
20693 With versions 2.3 and before, only select templates could be used to generate
20694 DocBook documents (only version 4).
20695 Starting with \SpecialChar LyX
20696 2.4, most \SpecialChar LyX
20697 layouts can generate valid DocBook documents (only
20699 This feature is built into \SpecialChar LyX
20700 and does not require the use of external tools.
20703 \begin_layout Standard
20705 \change_inserted 1075283030 1616534437
20706 The result is that the DocBook output can be customized and extended in
20707 exactly the same way \SpecialChar LaTeX
20708 output can be customized and extended: through layout
20710 See chapter five of the
20714 manual for the details.
20717 \begin_layout Standard
20719 \change_inserted 1075283030 1616534475
20720 Most \SpecialChar LyX
20721 features are supported with DocBook, like math output.
20724 \begin_layout Itemize
20726 \change_inserted 1075283030 1616534741
20727 Math output is performed mostly in MathML (the major exception being constructio
20728 ns not supported by \SpecialChar LyX
20731 All formulae are also available in raw \SpecialChar TeX
20732 in the DocBook output for further
20736 \begin_layout Itemize
20738 \change_inserted 1075283030 1616534852
20739 Bibliographies and citations are implemented, including with an external
20741 Bibliography entries are not prerendered when the detailed information
20742 are available, but rather output with the standard DocBook constructs.
20743 The external DocBook processor is expected to handle the rendering of entries.
20746 \begin_layout Itemize
20748 \change_inserted 1075283030 1616534863
20749 Indexes are supported, including multiple indices.
20754 ), page ranges, and cross-references (
20758 ) are supported, with the exception of the same symbols escaped.
20767 ) are not supported.
20768 There is no support for escaping of index entries.
20771 \begin_layout Itemize
20773 \change_inserted 1075283030 1616534884
20774 Glossaries are implemented.
20777 \begin_layout Standard
20779 \change_inserted 1075283030 1616534894
20780 Two major parameters can be set at the document level.
20783 \begin_layout Itemize
20785 \change_inserted 1075283030 1616534948
20786 Format for tables: \SpecialChar LyX
20787 can generate tables either as HTML (default value) or
20788 CALS, depending on the user's requirements.
20789 Most DocBook processors accept both formats.
20792 \begin_layout Itemize
20794 \change_inserted 1075283030 1616535006
20795 MathML prefix: in DocBook, MathML is included within its own name space,
20797 The implication is that there must be an indication of the tags belonging
20798 to the MathML standard.
20799 Three choices are offered:
20803 \begin_layout Itemize
20805 \change_inserted 1075283030 1616535044
20806 Inline: the MathML name space is defined for each formula (using the
20810 attribute on each formula)
20813 \begin_layout Itemize
20815 \change_inserted 1075283030 1616535090
20820 prefix (default): the MathML name space is defined at the document level
20825 attribute on the root element).
20826 Each MathML is prefixed with
20835 \begin_layout Itemize
20837 \change_inserted 1075283030 1616620405
20842 prefix: similar to the
20851 \begin_layout Standard
20853 \change_inserted 1075283030 1616620470
20854 This option is especially useful if you want \SpecialChar LyX
20855 to match your personal style
20856 or to work with buggy software that only accepts one prefix for MathML.
20862 \begin_layout Chapter
20863 The \SpecialChar LyX
20867 \begin_layout Section
20871 \begin_layout Standard
20872 The `\SpecialChar LyX
20873 server' allows other programs to talk to \SpecialChar LyX
20874 , invoke \SpecialChar LyX
20875 commands, and retrieve
20876 information about the \SpecialChar LyX
20878 This is only intended for advanced users, but they should find it useful.
20879 It is by writing to the \SpecialChar LyX
20880 server, for example, that bibliography managers,
20881 such as JabRef, are able to
20882 \begin_inset Quotes eld
20886 \begin_inset Quotes erd
20889 citations to \SpecialChar LyX
20893 \begin_layout Section
20894 Starting the \SpecialChar LyX
20896 \begin_inset CommandInset label
20898 name "sec:Starting-the-Server"
20905 \begin_layout Standard
20906 The \SpecialChar LyX
20907 server works through the use of a pair of named pipes.
20908 These are usually located in
20909 \begin_inset Flex Code
20912 \begin_layout Plain Layout
20918 , (except on Windows, where
20922 named pipes are special objects located in
20923 \begin_inset Flex Code
20926 \begin_layout Plain Layout
20938 ) and have the names
20939 \begin_inset Quotes eld
20943 \begin_inset Flex Code
20946 \begin_layout Plain Layout
20953 \begin_inset Quotes erd
20957 \begin_inset Quotes eld
20961 \begin_inset Flex Code
20964 \begin_layout Plain Layout
20971 \begin_inset Quotes erd
20975 External programs write into
20976 \begin_inset Flex Code
20979 \begin_layout Plain Layout
20985 and read back data from
20986 \begin_inset Flex Code
20989 \begin_layout Plain Layout
20996 The stem of the pipe names can be defined in the
20997 \begin_inset Flex Noun
21000 \begin_layout Plain Layout
21001 Tools\SpecialChar menuseparator
21007 dialog, for example
21008 \begin_inset Flex Code
21011 \begin_layout Plain Layout
21012 "/home/myhome/lyxpipe"
21018 \begin_inset Flex Code
21021 \begin_layout Plain Layout
21035 on Windows (where any working path instead of lyxpipe can be used, for
21037 \begin_inset Flex Code
21040 \begin_layout Plain Layout
21063 configure this manually in order for the server to start.
21066 \begin_layout Standard
21069 \begin_inset Flex Code
21072 \begin_layout Plain Layout
21079 \begin_inset Flex Code
21082 \begin_layout Plain Layout
21088 ' to create the pipes.
21089 If one of the pipes already exists, \SpecialChar LyX
21090 will assume that another \SpecialChar LyX
21092 is already running and will not start the server.
21093 On POSIX (Unix like) systems, if for some other reason, an unused
21094 \begin_inset Quotes eld
21098 \begin_inset Quotes erd
21101 pipe is left in existence when \SpecialChar LyX
21102 closes, then \SpecialChar LyX
21103 will try to delete it.
21104 If this fails for some reason, you will need to delete the pipes manually
21105 and then restart \SpecialChar LyX
21107 On Windows, pipes are deleted by the OS on program termination or crash,
21109 \begin_inset Quotes eld
21113 \begin_inset Quotes erd
21116 pipes should not be possible.
21119 \begin_layout Standard
21120 To have several \SpecialChar LyX
21121 processes with servers at the same time, you have to use
21122 different configurations, perhaps by using separate user directories, each
21124 \begin_inset Flex Code
21127 \begin_layout Plain Layout
21133 file, for each process.
21136 \begin_layout Standard
21137 If you are developing a client program, you might find it useful to enable
21138 debugging information from the \SpecialChar LyX
21140 Do this by starting \SpecialChar LyX
21142 \begin_inset Flex Code
21145 \begin_layout Plain Layout
21154 \begin_layout Standard
21155 You can find a complete example client written in C++ in the source distribution
21157 \begin_inset Flex Code
21160 \begin_layout Plain Layout
21161 development/lyxserver/server_monitor.cpp
21169 \begin_layout Standard
21170 Another useful tool is the command-line based client found in
21171 \begin_inset Flex Code
21174 \begin_layout Plain Layout
21175 src/client/lyxclient
21183 \begin_layout Section
21184 Normal communication
21187 \begin_layout Standard
21188 To issue a \SpecialChar LyX
21189 call, the client writes a line of ASCII text into the input
21191 This line has the following format:
21194 \begin_layout Quote
21208 \begin_layout Description
21209 clientname is a name that the client can choose arbitrarily.
21210 Its only use is that \SpecialChar LyX
21211 will echo it if it sends an answer—so a client can
21212 dispatch results from different requesters.
21215 \begin_layout Description
21216 function is the function you want \SpecialChar LyX
21218 It is the same as the commands you'd use in the minibuffer.
21221 \begin_layout Description
21222 argument is an optional argument which is meaningful only to some functions
21224 \begin_inset Quotes eld
21228 \begin_inset Quotes erd
21231 LFUN will insert the argument as text at the cursor position).
21234 \begin_layout Standard
21235 The answer from \SpecialChar LyX
21236 will arrive in the output pipe and be of the form
21239 \begin_layout Quote
21253 \begin_layout Standard
21262 are just echoed from the command request, while
21266 is more or less useful information filled according to how the command
21267 execution worked out.
21268 Some commands, such as
21269 \begin_inset Quotes eld
21273 \begin_inset Quotes erd
21276 , will return information about the internal state of \SpecialChar LyX
21278 return an empty data-response.
21279 This means that the command execution went fine.
21282 \begin_layout Standard
21283 In case of errors, the response from \SpecialChar LyX
21284 will have this form
21287 \begin_layout Quote
21301 \begin_layout Standard
21306 should contain an explanation of why the command failed.
21309 \begin_layout Standard
21313 \begin_layout LyX-Code
21314 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
21315 \begin_inset Newline newline
21318 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
21319 \begin_inset Newline newline
21322 read a <~/.lyxpipe.out
21323 \begin_inset Newline newline
21329 \begin_layout Subsection
21330 AppleScript (Mac OS X)
21333 \begin_layout Standard
21334 Since \SpecialChar LyX
21335 2.1, \SpecialChar LyX
21336 supports basic interactions with AppleScript for normal communicatio
21337 n through the command run.
21338 This command takes a direct argument (the
21342 to perform) and an optional argument.
21343 It either returns the output of the function or triggers an error with
21344 the error message and code.
21347 \begin_layout Standard
21351 \begin_layout LyX-Code
21352 tell application "\SpecialChar LyX
21356 \begin_layout LyX-Code
21360 \begin_layout LyX-Code
21361 -- Stores the current file name into f
21364 \begin_layout LyX-Code
21365 set f to (run "server-get-filename" with argument "")
21368 \begin_layout LyX-Code
21369 on error the error_message number the error_number
21372 \begin_layout LyX-Code
21373 display dialog "Error: " & the error_number & ".
21377 \begin_layout LyX-Code
21378 & the error_message buttons {"OK"} default button 1
21381 \begin_layout LyX-Code
21385 \begin_layout LyX-Code
21389 \begin_layout Section
21393 \begin_layout Standard
21395 can notify clients of events going on asynchronously.
21396 Currently it will only do this if the user binds a key sequence with the
21398 \begin_inset Quotes eld
21402 \begin_inset Quotes erd
21406 The format of the string \SpecialChar LyX
21407 sends is as follows:
21410 \begin_layout Quote
21411 \begin_inset Flex Code
21414 \begin_layout Plain Layout
21425 \begin_layout Standard
21430 is the printed representation of the key sequence that was actually typed
21434 \begin_layout Standard
21435 This mechanism can be used to extend \SpecialChar LyX
21436 's command set and implement macros.
21437 Bind some key sequence to
21438 \begin_inset Quotes eld
21442 \begin_inset Quotes erd
21446 Then start a client that listens on the output pipe, dispatches the command
21447 according to the sequence, and starts a function that may use \SpecialChar LyX
21450 requests to issue a command or a series of commands to \SpecialChar LyX
21454 \begin_layout Section
21455 The simple \SpecialChar LyX
21459 \begin_layout Standard
21461 implements a simple protocol that can be used for session management.
21462 All messages are of the form
21465 \begin_layout Quote
21475 \begin_layout Standard
21481 \begin_inset Quotes eld
21485 \begin_inset Quotes erd
21489 \begin_inset Quotes eld
21493 \begin_inset Quotes erd
21498 \begin_inset Quotes eld
21502 \begin_inset Quotes erd
21505 is received from a client, \SpecialChar LyX
21506 will report back to inform the client that
21507 it's listening to it's messages, while
21508 \begin_inset Quotes eld
21512 \begin_inset Quotes erd
21515 sent from \SpecialChar LyX
21516 will inform clients that \SpecialChar LyX
21520 \begin_layout Section
21521 Reverse DVI/PDF search
21524 \begin_layout Standard
21525 Some DVI/PDF viewers
21529 \begin_layout Plain Layout
21530 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
21531 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
21540 facility (also called
21545 This means that you can tell \SpecialChar LyX
21546 to put the cursor to a specific line in the
21547 document by clicking at the respective position in the DVI/PDF output.
21548 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
21550 This is done via the \SpecialChar LyX
21551 server either by using the named pipe (
21555 ), or the UNIX domain socket (
21559 ) that \SpecialChar LyX
21560 creates in its temporary directory (this is the way the
21561 \begin_inset Flex Code
21564 \begin_layout Plain Layout
21570 program communicates with \SpecialChar LyX
21572 In some cases, you need a helper script that mediates between the viewer
21573 and \SpecialChar LyX
21574 , in others, the viewer can communicate with \SpecialChar LyX
21576 This depends on the selected viewer and on your operating system.
21577 The same applies to the way viewers need to be configured and the way the
21578 reverse search is actually performed.
21579 In what follows, we will thus describe how to setup reverse search for
21581 Before we turn to this, though, we will explain what needs to be done generally
21582 to enable reverse search in the DVI/PDF output.
21585 \begin_layout Subsection
21587 \begin_inset CommandInset label
21589 name "subsec:rev-search"
21596 \begin_layout Standard
21597 In most cases \SpecialChar LyX
21598 will do the work for you by pressing the following button
21602 arg "buffer-toggle-output-sync"
21606 Alternatively, you can also enable the feature by checking
21608 Synchronize with Output
21611 \begin_inset Flex Noun
21614 \begin_layout Plain Layout
21615 Document\SpecialChar menuseparator
21616 Settings\SpecialChar menuseparator
21623 In such a case \SpecialChar LyX
21624 will automatically insert the necessary Sync\SpecialChar TeX
21626 PDF) or load the srcltx package (for DVI) respectively.
21627 This option can be easily reached also on
21628 \begin_inset Flex Code
21631 \begin_layout Plain Layout
21640 \begin_layout Standard
21641 If you need a different setting, you can select or input a custom macro
21642 from the drop down box just below
21643 \begin_inset Flex Noun
21646 \begin_layout Plain Layout
21647 Document\SpecialChar menuseparator
21648 Settings\SpecialChar menuseparator
21649 Output\SpecialChar menuseparator
21650 Synchronize with Output
21658 \begin_layout Standard
21659 Note that the method
21660 \begin_inset Flex Code
21663 \begin_layout Plain Layout
21671 enables gzip compression.
21672 If your viewer does not support it, you should instead use
21673 \begin_inset Flex Code
21676 \begin_layout Plain Layout
21687 \begin_layout Standard
21688 Please also note that including the
21689 \begin_inset Flex Code
21692 \begin_layout Plain Layout
21699 \begin_inset Flex Code
21702 \begin_layout Plain Layout
21708 sometimes has an undesired impact on the typesetting.
21709 Thus, you should switch output synchronization off for the final typesetting
21711 \begin_inset Flex Code
21714 \begin_layout Plain Layout
21721 \begin_inset Flex Code
21724 \begin_layout Plain Layout
21734 \begin_layout Standard
21735 In case you need some more special settings that are not covered by the
21736 automatic settings, read the next section about how to set up output synchroniz
21738 If the automatic setup suits your needs, you can readily jump to section
21739 \begin_inset space ~
21743 \begin_inset CommandInset ref
21745 reference "subsec:configuring-viewers"
21749 , where the necessary configuration steps in your viewer – needed both with
21750 the automatic and the manual setup – are described.
21753 \begin_layout Subsection
21757 \begin_layout Standard
21759 provides several different methods for reverse search.
21760 Some are built-in in the
21761 \begin_inset Flex Code
21764 \begin_layout Plain Layout
21770 program, some are provided by external packages.
21771 Your choice depends on whether your \SpecialChar LaTeX
21772 distribution already provides a given
21773 method (the built-in methods are rather new) and whether your viewer can
21775 The available methods are described in the following.
21778 \begin_layout Subsubsection*
21779 Built-in DVI-search via src-specials (DVI only)
21782 \begin_layout Standard
21783 This method provides the DVI file with the necessary information for reverse
21785 It is available in \SpecialChar LaTeX
21786 since quite some time (any somewhat recent \SpecialChar LaTeX
21788 should include it), and it works reliably.
21789 To enable it, change the
21790 \begin_inset Flex Noun
21793 \begin_layout Plain Layout
21804 \begin_inset Flex Noun
21807 \begin_layout Plain Layout
21818 \begin_inset Flex Noun
21821 \begin_layout Plain Layout
21822 Preferences\SpecialChar menuseparator
21823 File Handling\SpecialChar menuseparator
21830 \begin_inset Flex Code
21833 \begin_layout Plain Layout
21834 latex -src-specials $$i
21840 If this doesn't work, check if your \SpecialChar TeX
21841 engine needs different options (the
21842 syntax might differ in some distributions).
21845 \begin_layout Subsubsection*
21846 External Packages (PDFSync and scrltx)
21849 \begin_layout Standard
21858 provide reverse search facility for PDF output (via pdflatex) and DVI output,
21860 In order to enable it, load the packages in the \SpecialChar LyX
21864 \begin_layout Itemize
21865 \begin_inset Flex Code
21868 \begin_layout Plain Layout
21871 usepackage{pdfsync}
21876 for reverse PDF search,
21879 \begin_layout Itemize
21880 \begin_inset Flex Code
21883 \begin_layout Plain Layout
21886 usepackage[active]{srcltx}
21891 for reverse DVI search.
21894 \begin_layout Standard
21895 If you want to be able to perform both DVI and PDF reverse searches, you
21896 can also insert in the preamble the following lines
21899 \begin_layout LyX-Code
21903 \begin_inset Newline newline
21909 \begin_inset Newline newline
21914 usepackage{pdfsync}
21915 \begin_inset Newline newline
21921 \begin_inset Newline newline
21926 usepackage[active]{srcltx}
21927 \begin_inset Newline newline
21935 \begin_layout Standard
21936 This way, you can preview the file as either DVI or PDF (pdflatex) and the
21937 right package will be used.
21940 \begin_layout Standard
21941 Note that PDFSync might affect the output layout of your document.
21942 It is therefore advised to disable PDFsync for final documents.
21945 \begin_layout Subsubsection*
21946 Built-in reverse search via Sync\SpecialChar TeX
21950 \begin_layout Standard
21952 \begin_inset Flex Code
21955 \begin_layout Plain Layout
21961 have built-in support for both PDF and DVI reverse search.
21964 Sync\SpecialChar TeX
21967 facility is basically the result of the integration of the PDFSync package
21968 to the pdftex program and its merge with the
21973 You need at least \SpecialChar TeX
21974 Live 2008 or a recent Mik\SpecialChar TeX
21975 distribution in order to use
21980 \begin_layout Plain Layout
21981 For some reason, Mik\SpecialChar TeX
21982 does not understand/obey the command \SpecialChar LyX
21984 the preamble when you check the "Enable Forward/Reverse Search" button
21985 in the toolbar and does not generate the necessary info.
21988 \begin_layout Plain Layout
21989 The generation of the required info can be forced by changing the converter
21990 "\SpecialChar LaTeX
21991 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
21992 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
21993 the -synctex=1 switch).
21998 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
21999 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
22000 already provide Sync\SpecialChar TeX
22004 \begin_layout Standard
22005 To enable Sync\SpecialChar TeX
22006 for DVI output, change the
22007 \begin_inset Flex Noun
22010 \begin_layout Plain Layout
22021 \begin_inset Flex Noun
22024 \begin_layout Plain Layout
22029 (plain) -> DraftDVI
22035 \begin_inset Flex Noun
22038 \begin_layout Plain Layout
22039 Preferences\SpecialChar menuseparator
22040 File Handling\SpecialChar menuseparator
22047 \begin_inset Flex Code
22050 \begin_layout Plain Layout
22051 latex -synctex=1 $$i
22056 , and for PDF output, change the
22057 \begin_inset Flex Noun
22060 \begin_layout Plain Layout
22065 (pdflatex) -> PDF (pdflatex)
22071 \begin_inset Flex Code
22074 \begin_layout Plain Layout
22075 pdflatex -synctex=1 $$i
22081 Should your viewer not be considered in the following description, or in
22082 case of missing success, please check the documentation of your viewer
22083 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
22088 \begin_layout Plain Layout
22089 Note that the option
22090 \begin_inset Flex Code
22093 \begin_layout Plain Layout
22099 option enables gzip compression.
22100 If your viewer does not support it, you should instead use
22101 \begin_inset Flex Code
22104 \begin_layout Plain Layout
22118 \begin_layout Subsection
22119 Configuring and using specific viewers
22120 \begin_inset CommandInset label
22122 name "subsec:configuring-viewers"
22129 \begin_layout Subsubsection*
22130 Xdvi (all platforms)
22133 \begin_layout Standard
22135 \begin_inset Flex Code
22138 \begin_layout Plain Layout
22144 , you don't need to do anything else for performing a reverse DVI search,
22145 as \SpecialChar LyX
22146 already provides the necessary hooks for automatically using the
22147 \begin_inset Flex Code
22150 \begin_layout Plain Layout
22157 Just setup your document as described above (reverse search is triggered
22158 by Ctrl-click or Alt-click on Mac OSX, respectively).
22161 \begin_layout Standard
22162 However, if for whatever reason you want to use the named pipe instead of
22163 the socket for communicating with \SpecialChar LyX
22164 , simply change the DVI viewer in
22165 \begin_inset Flex Noun
22168 \begin_layout Plain Layout
22169 Preferences\SpecialChar menuseparator
22170 File Handling\SpecialChar menuseparator
22180 \begin_layout Plain Layout
22181 On Mac OSX you have to use
22182 \begin_inset Flex Code
22185 \begin_layout Plain Layout
22186 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
22197 \begin_inset Flex Code
22200 \begin_layout Plain Layout
22201 xdvi -editor "lyxeditor.sh %f %l"
22207 \begin_inset Flex Code
22210 \begin_layout Plain Layout
22216 is a suitable script.
22217 For example, a minimal shell script is the following one:
22220 \begin_layout LyX-Code
22222 \begin_inset Newline newline
22225 LYXPIPE="/path/to/lyxpipe"
22226 \begin_inset Newline newline
22229 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
22230 \begin_inset Newline newline
22233 echo "$COMMAND" > "${LYXPIPE}".in || exit
22234 \begin_inset Newline newline
22237 read TMP < "${LYXPIPE}".out || exit
22240 \begin_layout Standard
22242 \begin_inset Flex Code
22245 \begin_layout Plain Layout
22251 is the LyXServer pipe path specified in
22252 \begin_inset Flex Noun
22255 \begin_layout Plain Layout
22256 Preferences\SpecialChar menuseparator
22266 \begin_layout Plain Layout
22268 \begin_inset Flex Code
22271 \begin_layout Plain Layout
22277 folder of a source distribution you can find a
22278 \begin_inset Flex Code
22281 \begin_layout Plain Layout
22287 script which is able to locate the
22291 based on your preferences.
22299 \begin_layout Subsubsection*
22303 \begin_layout Standard
22305 \begin_inset Flex Code
22308 \begin_layout Plain Layout
22309 /Applications/MacDviX_Folder/calleditor.script
22314 , add the following lines:
22317 \begin_layout LyX-Code
22318 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
22319 \begin_inset Newline newline
22325 \begin_layout Standard
22326 Modify the lines accordingly if you install \SpecialChar LyX
22327 somewhere else than in the
22328 Applications folder.
22331 \begin_layout Standard
22332 Reverse search is triggered by Alt-click (OPTION-click).
22335 \begin_layout Subsubsection*
22339 \begin_layout Standard
22341 \begin_inset Flex Code
22344 \begin_layout Plain Layout
22345 open -a Skim.app $$i
22350 to the viewer setting in
22351 \begin_inset Flex Noun
22354 \begin_layout Plain Layout
22355 Preferences\SpecialChar menuseparator
22356 File Handling\SpecialChar menuseparator
22357 File formats\SpecialChar menuseparator
22364 \begin_inset Flex Noun
22367 \begin_layout Plain Layout
22368 Skim\SpecialChar menuseparator
22369 Preferences\SpecialChar menuseparator
22376 \begin_inset Flex Noun
22379 \begin_layout Plain Layout
22385 preset and enter command
22386 \begin_inset Flex Noun
22389 \begin_layout Plain Layout
22390 /Applications/\SpecialChar LyX
22391 .app/Contents/MacOS/lyxeditor
22399 \begin_layout Standard
22400 Reverse search is triggered by COMMAND-SHIFT-click
22403 \begin_layout Subsubsection*
22407 \begin_layout Standard
22408 Reverse search with evince does not work out of the box, but it can be achieved
22409 by means of some third party helper scripts.
22411 \begin_inset CommandInset href
22413 target "https://wiki.lyx.org/LyX/SyncTeX"
22421 \begin_layout Subsubsection*
22425 \begin_layout Standard
22427 \begin_inset Flex Noun
22430 \begin_layout Plain Layout
22431 Settings\SpecialChar menuseparator
22432 Configure Okular\SpecialChar menuseparator
22439 \begin_inset Quotes erd
22443 This inserts the appropriate command (
22444 \begin_inset Flex Code
22447 \begin_layout Plain Layout
22456 \begin_layout Standard
22457 Reverse search is triggered by SHIFT-click.
22459 \change_inserted -712698321 1578211026
22460 Note that this only works if Okular is in
22461 \begin_inset Quotes eld
22465 \begin_inset Quotes erd
22469 \begin_inset space \thinspace{}
22472 e., the hand symbol is clicked).
22477 \begin_layout Subsubsection*
22481 \begin_layout Standard
22482 Qpdfview supports Sync\SpecialChar TeX
22483 since version 0.3.5.
22485 \begin_inset Flex Noun
22488 \begin_layout Plain Layout
22489 Edit\SpecialChar menuseparator
22490 Settings\SpecialChar menuseparator
22496 , click on the input field of the
22497 \begin_inset Quotes eld
22501 \begin_inset Quotes erd
22504 item and add the command
22505 \begin_inset Flex Code
22508 \begin_layout Plain Layout
22517 \begin_layout Standard
22518 Reverse search is triggered by double-click or, in more recent versions,
22522 \begin_layout Subsubsection*
22526 \begin_layout Standard
22527 Launch yap, choose its
22528 \begin_inset Flex Noun
22531 \begin_layout Plain Layout
22532 View\SpecialChar menuseparator
22538 menu and select the
22539 \begin_inset Quotes eld
22543 \begin_inset Quotes erd
22548 \begin_inset Quotes eld
22551 New\SpecialChar ldots
22553 \begin_inset Quotes erd
22556 button and, in the window that opens, enter
22557 \begin_inset Quotes eld
22562 \begin_inset Quotes erd
22565 (or any other name you like) in the
22566 \begin_inset Quotes eld
22570 \begin_inset Quotes erd
22574 Now click on the button labeled
22575 \begin_inset Quotes eld
22580 \begin_inset Quotes erd
22583 to open a file dialog and navigate to the directory containing the batch
22585 \begin_inset Flex Code
22588 \begin_layout Plain Layout
22596 \begin_inset Flex Code
22599 \begin_layout Plain Layout
22605 and then specify the program arguments as
22606 \begin_inset Flex Code
22609 \begin_layout Plain Layout
22617 \begin_inset Flex Code
22620 \begin_layout Plain Layout
22626 wrapper is used for communicating with \SpecialChar LyX
22634 \begin_layout LyX-Code
22636 \begin_inset Newline newline
22639 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
22648 \begin_inset Newline newline
22662 \begin_layout Standard
22663 Make sure that the \SpecialChar LyX
22664 Server pipe path you specified in \SpecialChar LyX
22666 \begin_inset Flex Code
22669 \begin_layout Plain Layout
22683 , otherwise change the
22684 \begin_inset Flex Code
22687 \begin_layout Plain Layout
22693 wrapper accordingly.
22696 \begin_layout Standard
22697 In yap, reverse search is triggered by double-click.
22700 \begin_layout Subsubsection*
22701 SumatraPDF (Windows)
22704 \begin_layout Standard
22705 In order to use SumatraPDF for inverse search, enter
22706 \begin_inset Flex Code
22709 \begin_layout Plain Layout
22710 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
22715 in the viewer setting in
22716 \begin_inset Flex Noun
22719 \begin_layout Plain Layout
22720 Preferences\SpecialChar menuseparator
22721 File Handling\SpecialChar menuseparator
22722 File formats\SpecialChar menuseparator
22729 \begin_inset Flex Code
22732 \begin_layout Plain Layout
22738 is the previous wrapper.
22739 If SumatraPDF.exe is not in your command PATH, use its full file name.
22742 \begin_layout Standard
22743 Reverse search is triggered by double-click.
22746 \begin_layout Subsubsection*
22750 \begin_layout Standard
22751 First of all, make sure that yap is your default DVI viewer in the Windows
22752 environment, then launch it, choose its
22753 \begin_inset Flex Noun
22756 \begin_layout Plain Layout
22757 View\SpecialChar menuseparator
22763 menu and select the
22764 \begin_inset Quotes eld
22768 \begin_inset Quotes erd
22773 \begin_inset Quotes eld
22776 New\SpecialChar ldots
22778 \begin_inset Quotes erd
22781 button and, in the window that opens, enter
22782 \begin_inset Quotes eld
22787 \begin_inset Quotes erd
22790 (or any other name you like) in the
22791 \begin_inset Quotes eld
22795 \begin_inset Quotes erd
22799 Now click on the button labeled
22800 \begin_inset Quotes eld
22805 \begin_inset Quotes erd
22808 to open a file dialog and navigate to the directory containing the
22809 \begin_inset Flex Code
22812 \begin_layout Plain Layout
22818 program (which is installed by default on Cygwin along with the \SpecialChar LyX
22821 \begin_inset Flex Code
22824 \begin_layout Plain Layout
22830 and then specify the program arguments as
22831 \begin_inset Flex Code
22834 \begin_layout Plain Layout
22841 In this way, you will be using the
22845 for communicating with \SpecialChar LyX
22847 If, for whatever reason, you want to use the
22852 \begin_inset Flex Code
22855 \begin_layout Plain Layout
22861 option and be sure to specify the \SpecialChar LyX
22862 Server pipe path in the \SpecialChar LyX
22866 \begin_layout Standard
22867 In yap, reverse search is triggered by double-click.
22870 \begin_layout Subsubsection*
22871 SumatraPDF (Cygwin)
22874 \begin_layout Standard
22875 In order to use SumatraPDF for inverse search, enter
22876 \begin_inset Flex Code
22879 \begin_layout Plain Layout
22880 SumatraPDF -inverse-search "lyxeditor -g %f %l"
22885 in the viewer setting in
22886 \begin_inset Flex Noun
22889 \begin_layout Plain Layout
22890 Preferences\SpecialChar menuseparator
22891 File Handling\SpecialChar menuseparator
22892 File formats\SpecialChar menuseparator
22899 If SumatraPDF.exe is not in your command PATH, use its full posix path.
22901 \begin_inset Flex Code
22904 \begin_layout Plain Layout
22910 enables communication via the
22916 \begin_inset Flex Code
22919 \begin_layout Plain Layout
22925 option if you want to use the
22929 , and be sure to specify the \SpecialChar LyX
22930 Server pipe path in the \SpecialChar LyX
22934 \begin_layout Standard
22935 Reverse search is triggered by double-click.
22938 \begin_layout Section
22942 \begin_layout Standard
22943 Forward search is, as the name implies, in a sense the
22944 \begin_inset Quotes eld
22948 \begin_inset Quotes erd
22952 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
22954 If forward search is set up (as described in what follows), you can put
22955 the cursor anywhere in your \SpecialChar LyX
22957 \begin_inset Flex Noun
22960 \begin_layout Plain Layout
22961 Navigate\SpecialChar menuseparator
22968 \begin_inset Flex Noun
22971 \begin_layout Plain Layout
22977 in the context menu via right mouse click), and then the viewer will jump
22978 to that position as well.
22979 This implies, of course, that your viewer supports this function.
22982 \begin_layout Standard
22983 To make forward search possible, you first need to provide the generated
22984 output PDF/DVI file with additional information about the \SpecialChar TeX
22986 This can be done via the methods described in the section
22987 \begin_inset CommandInset ref
22989 reference "subsec:rev-search"
22996 \begin_layout Standard
22997 Additionally, you need to configure \SpecialChar LyX
22998 for using your viewers in
22999 \begin_inset Flex Noun
23002 \begin_layout Plain Layout
23003 Tools\SpecialChar menuseparator
23004 Preferences\SpecialChar menuseparator
23005 Output\SpecialChar menuseparator
23012 We provide a range of tested configurations for some viewers, which you
23013 can select from the drop down list.
23014 If none of these configurations suits you, you have to find out and enter
23015 a suitable configuration yourself.
23016 The definition syntax uses the following placeholders:
23019 \begin_layout Itemize
23021 \begin_inset Flex Code
23024 \begin_layout Plain Layout
23033 \begin_layout Itemize
23035 \begin_inset Flex Code
23038 \begin_layout Plain Layout
23044 : name of the (temporary) exported .tex file (without path)
23047 \begin_layout Itemize
23049 \begin_inset Flex Code
23052 \begin_layout Plain Layout
23058 : name of the (temporary) exported .tex file (including path)
23061 \begin_layout Itemize
23063 \begin_inset Flex Code
23066 \begin_layout Plain Layout
23072 : name of the exported output file (either dvi or pdf, depending on which
23073 one exists in the temporary directory)
23076 \begin_layout Standard
23077 Note that only some of the viewers provide full and usable forward search
23078 functionality out of the box, among them yap, xdvi, okular
23082 \begin_layout Plain Layout
23083 You might want to set
23084 \begin_inset Flex Code
23087 \begin_layout Plain Layout
23094 \begin_inset Flex Noun
23097 \begin_layout Plain Layout
23098 Tools\SpecialChar menuseparator
23099 Preferences\SpecialChar menuseparator
23100 File Handling\SpecialChar menuseparator
23102 \begin_inset space ~
23115 , qpdfview, and SumatraPDF
23119 \begin_layout Plain Layout
23120 SumatraPDF can also use DDE commands through the external program CMCDDE
23121 — downloadable from
23122 \begin_inset CommandInset href
23124 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
23135 Others, such as evince
23139 \begin_layout Plain Layout
23140 Forward search with evince can be achieved by means of third party helper
23143 \begin_inset CommandInset href
23145 target "https://wiki.lyx.org/LyX/SyncTeX"
23155 , require some extra tools in order to use forward search.
23156 While many of the widespread PDF viewers (most notably Adobe Reader) do
23157 not support forward search at all, some other viewers – e.
23158 \begin_inset space \thinspace{}
23162 xpdf – allow at least to reload the document and jump to a specific page
23163 of the file, so you can at least navigate
23164 \begin_inset Quotes eld
23168 \begin_inset Quotes erd
23172 This latter functionality is provided by an external call of synctex (see
23173 the predefined example configurations).
23177 \begin_layout Standard
23178 Forward search works both with DVI and PDF output.
23180 simply checks which preview format you have used before (i.
23181 \begin_inset space \thinspace{}
23184 e., which format is already there in the temporary directory) and chooses
23185 the appropriate configuration for the respective format.
23188 \begin_layout Chapter
23190 \change_deleted 564990737 1671097409
23191 Special Document Classes
23196 \begin_layout Section
23198 \change_deleted 564990737 1669742044
23202 \begin_layout Standard
23204 \change_deleted 564990737 1669742044
23210 \begin_layout Subsection
23212 \change_deleted 564990737 1669742044
23216 \begin_layout Standard
23218 \change_deleted 564990737 1669742044
23219 This section describes how \SpecialChar LyX
23220 can be used to write articles for submission
23221 to the scientific journal
23223 Astronomy and Astrophysics
23226 \begin_inset Flex URL
23229 \begin_layout Plain Layout
23231 https://www.aanda.org/
23236 ) using Version 5.01 of the document class
23241 This package can be downloaded from the ftp site
23244 \begin_layout Standard
23246 \change_deleted 564990737 1669742044
23247 \begin_inset VSpace medskip
23253 \begin_layout Standard
23256 \change_deleted 564990737 1669742044
23257 \begin_inset Flex URL
23260 \begin_layout Plain Layout
23262 ftp://ftp.edpsciences.org/pub/aa/readme.html
23270 \begin_layout Standard
23272 \change_deleted 564990737 1669742044
23273 \begin_inset VSpace medskip
23279 \begin_layout Standard
23281 \change_deleted 564990737 1669742044
23282 A manual comes together with that package, and this text is not meant to
23283 replace the original manual but is merely a short guide in how to realize
23284 the correct form of your paper.
23288 \begin_layout Standard
23290 \change_deleted 564990737 1669742044
23291 Please note that the publisher of the journal was changed from Springer
23292 to EDP Sciences starting January 1, 2001.
23293 That change involved also some slight changes to the style files, namely
23294 the removal of the thesaurus command.
23295 The \SpecialChar LyX
23296 class aa supports the newest version of these style files, V 5.01.
23297 If you have an older version installed, please upgrade.
23298 For compatibility, the old (version 4) layout has been kept as
23303 Please refer to the comments in
23306 Dir/layouts/aapaper.layout
23311 \begin_layout Subsection
23313 \change_deleted 564990737 1669742044
23317 \begin_layout Standard
23319 \change_deleted 564990737 1669742044
23320 It is recommended you start from the example template distributed with \SpecialChar LyX
23322 If you are not using a template, note the following settings:
23325 \begin_layout Itemize
23327 \change_deleted 564990737 1669742044
23334 Document\SpecialChar menuseparator
23337 dialog (OK, that one was obvious).
23340 \begin_layout Itemize
23342 \change_deleted 564990737 1669742044
23343 Don't change the option
23346 \begin_inset space ~
23356 The whole layout is done by the macros, you shouldn't change anything.
23359 \begin_layout Subsection
23361 \change_deleted 564990737 1669742044
23365 \begin_layout Standard
23367 \change_deleted 564990737 1669742044
23368 First thing to enter is the header information.
23369 It consists of seven entries, of which some are optional.
23373 \begin_layout Itemize
23375 \change_deleted 564990737 1669742044
23383 \begin_layout Itemize
23385 \change_deleted 564990737 1669742044
23393 \begin_layout Itemize
23395 \change_deleted 564990737 1669742044
23403 \begin_layout Itemize
23405 \change_deleted 564990737 1669742044
23413 \begin_layout Itemize
23415 \change_deleted 564990737 1669742044
23420 : [optional] if more than one author: whom to contact for offprint requests.
23423 \begin_layout Itemize
23425 \change_deleted 564990737 1669742044
23430 : [optional] mail address for contacts.
23433 \begin_layout Itemize
23435 \change_deleted 564990737 1669742044
23441 Suggested format is
23443 Received: <date>; Accepted <date>
23446 \begin_layout Standard
23448 \change_deleted 564990737 1669742044
23449 There is no need to issue the
23455 command, this is done automatically by \SpecialChar LyX
23456 when the header is finished.
23457 Although the order of the single header entries doesn't matter it is advised
23458 to keep the above sequence, just to get the best optics and meets the layout
23459 of the real document.
23462 \begin_layout Standard
23464 \change_deleted 564990737 1669742044
23465 If you want to place footnotes in the header block, e.
23466 \begin_inset space \thinspace{}
23470 \begin_inset space \space{}
23473 to state your present address, just use the standard footnote via the menu
23476 Insert\SpecialChar menuseparator
23481 will automagically use the term
23490 \begin_layout Standard
23492 \change_deleted 564990737 1669742044
23495 Edit\SpecialChar menuseparator
23498 , you'll find two insets which are relevant for the titling:
23501 \begin_layout Itemize
23503 \change_deleted 564990737 1669742044
23510 to mark corresponding author\SpecialChar breakableslash
23512 The institutes are numbered sequentially as they appear in the
23516 field, so you have to put a marker to each author.
23519 \begin_layout Itemize
23521 \change_deleted 564990737 1669742044
23526 to supply an email address for fast contact.
23529 \begin_layout Standard
23531 \change_deleted 564990737 1669742044
23532 In addition to these topics, the macros use one additional \SpecialChar LaTeX
23534 has no counterpart in \SpecialChar LyX
23538 \begin_layout Itemize
23540 \change_deleted 564990737 1669742044
23547 to separate different names for more than one author and institute, respectivel
23551 \begin_layout Standard
23553 \change_deleted 564990737 1669742044
23554 The appropriate command has to be entered in \SpecialChar LyX
23555 and marked as \SpecialChar LaTeX
23561 \begin_layout Subsection
23563 \change_deleted 564990737 1669742044
23567 \begin_layout Standard
23569 \change_deleted 564990737 1669742044
23570 The abstract should immediately follow the header block.
23571 With version 5 the abstract environment was changed to a command, and there
23572 is now a restriction to only one paragraph.
23573 In addition, it should contain an entry with the keywords.
23574 This is done via the paragraph style
23579 Refer to the example paper.
23582 \begin_layout Subsection
23584 \change_deleted 564990737 1669742044
23585 Supported environments
23588 \begin_layout Standard
23590 \change_deleted 564990737 1669742044
23591 The A&A paper layout supports the following environments for structuring
23595 \begin_layout Itemize
23597 \change_deleted 564990737 1669742044
23603 \begin_layout Itemize
23605 \change_deleted 564990737 1669742044
23611 \begin_layout Itemize
23613 \change_deleted 564990737 1669742044
23619 \begin_layout Itemize
23621 \change_deleted 564990737 1669742044
23627 \begin_layout Itemize
23629 \change_deleted 564990737 1669742044
23635 \begin_layout Itemize
23637 \change_deleted 564990737 1669742044
23643 \begin_layout Itemize
23645 \change_deleted 564990737 1669742044
23651 \begin_layout Itemize
23653 \change_deleted 564990737 1669742044
23659 \begin_layout Itemize
23661 \change_deleted 564990737 1669742044
23667 \begin_layout Itemize
23669 \change_deleted 564990737 1669742044
23675 \begin_layout Itemize
23677 \change_deleted 564990737 1669742044
23683 \begin_layout Itemize
23685 \change_deleted 564990737 1669742044
23692 \begin_layout Subsection
23694 \change_deleted 564990737 1669742044
23695 Commands not supported by \SpecialChar LyX
23699 \begin_layout Standard
23701 \change_deleted 564990737 1669742044
23702 Some commands are not yet supported by the
23706 layout for \SpecialChar LyX
23708 Some have already been mentioned.
23709 For the sake of completeness, they are listed all together here:
23712 \begin_layout Itemize
23714 \change_deleted 564990737 1669742044
23722 \begin_layout Itemize
23724 \change_deleted 564990737 1669742044
23732 \begin_layout Itemize
23734 \change_deleted 564990737 1669742044
23742 \begin_layout Itemize
23744 \change_deleted 564990737 1669742044
23752 \begin_layout Standard
23754 \change_deleted 564990737 1669742044
23755 If you want to use any of these commands, you have to enter them yourself.
23758 Do not forget to mark them as \SpecialChar LaTeX
23762 \begin_layout Subsection
23764 \change_deleted 564990737 1669742044
23765 Figure and Table Floats
23768 \begin_layout Standard
23770 \change_deleted 564990737 1669742044
23772 provides support for the necessary float environments
23774 figure, figure*, table
23780 , therefore we won't tell much about it here.
23784 \begin_inset space ~
23790 Just remember that tables should be left-aligned.
23791 For that, select the table and change the alignment in
23793 Edit\SpecialChar menuseparator
23795 \begin_inset space ~
23801 \begin_layout Standard
23803 \change_deleted 564990737 1669742044
23804 There is only one special thing: the figures with caption besides the figure.
23805 To create such a figure, you have to do the following:
23808 \begin_layout Enumerate
23810 \change_deleted 564990737 1669742044
23811 Create a wide figure float:
23813 Insert\SpecialChar menuseparator
23814 Float\SpecialChar menuseparator
23817 , then right click in the figure and select
23820 \begin_inset space ~
23828 \begin_layout Enumerate
23830 \change_deleted 564990737 1669742044
23831 Enter your caption text.
23834 \begin_layout Enumerate
23836 \change_deleted 564990737 1669742044
23841 to move the cursor above the caption.
23844 \begin_layout Enumerate
23846 \change_deleted 564990737 1669742044
23850 \begin_layout Enumerate
23852 \change_deleted 564990737 1669742044
23853 Position the cursor behind the figure and insert a horizontal fill:
23855 Insert\SpecialChar menuseparator
23857 \begin_inset space ~
23860 Character\SpecialChar menuseparator
23862 \begin_inset space ~
23870 \begin_layout Enumerate
23872 \change_deleted 564990737 1669742044
23873 Switch to \SpecialChar LaTeX
23877 \begin_inset space ~
23885 \begin_layout Enumerate
23887 \change_deleted 564990737 1669742044
23897 Do not close the brace!
23900 \begin_layout Enumerate
23902 \change_deleted 564990737 1669742044
23903 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
23908 \begin_inset space ~
23920 \begin_layout Standard
23922 \change_deleted 564990737 1669742044
23923 Also, refer to the figures in the example paper.
23926 \begin_layout Subsection
23928 \change_deleted 564990737 1669742044
23932 \begin_layout Standard
23934 \change_deleted 564990737 1669742044
23935 For submission, the paper has to be formated in a special double-spacing
23937 For this purpose, you have to give the option
23941 to the document class.
23942 This must be done using the custom class options field in the
23944 Document\SpecialChar menuseparator
23948 Just enter the string
23955 \begin_layout Subsection
23957 \change_deleted 564990737 1669742044
23961 \begin_layout Standard
23963 \change_deleted 564990737 1669742044
23968 directory contains an example paper written with \SpecialChar LyX
23970 It is the example paper from the original macro package, translated to
23973 Use it for inspiration, and compare the original \SpecialChar LaTeX
23974 code with \SpecialChar LyX
23978 \begin_layout Section
23980 \change_deleted 564990737 1671097429
23984 \begin_layout Standard
23986 \change_deleted 564990737 1671097429
23991 can be used to type letters according to German conventions.
23992 A template file is included in
23994 .../lyx/share/templates
23996 for you to use as a starting point.
23999 \begin_layout Section
24001 \change_deleted 564990737 1671097429
24005 \begin_layout Standard
24007 \change_deleted 564990737 1671097429
24008 See the \SpecialChar LyX
24014 It contains all infos you need.
24017 \begin_layout Section
24019 \change_deleted 564990737 1669755802
24023 \begin_layout Standard
24025 \change_deleted 564990737 1669755802
24028 Panayotis Papasotiriou
24031 \begin_layout Subsection
24033 \change_deleted 564990737 1669755802
24037 \begin_layout Standard
24039 \change_deleted 564990737 1669755802
24040 The ijmpc package is a set of macros that facilitates electronic manuscript
24043 International Journal of Modern Physics C
24046 Similarly, the ijmpd package is for creating manuscripts to be submitted
24049 International Journal of Modern Physics D
24052 Both journals are published by World Scientific.
24053 The corresponding document classes are named
24062 These files, together with instructions for the authors, can be downloaded
24064 \begin_inset Flex URL
24067 \begin_layout Plain Layout
24069 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
24075 \begin_inset Flex URL
24078 \begin_layout Plain Layout
24080 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
24086 Both packages are modified versions of the standard
24087 \begin_inset Quotes eld
24091 \begin_inset Quotes erd
24094 package, and they are almost (but not exactly) identical.
24095 Most of their features are supported by \SpecialChar LyX
24097 I have used \SpecialChar LyX
24098 successfully to write articles submitted to both journals
24099 without any problem.
24102 \begin_layout Subsection
24104 \change_deleted 564990737 1669755802
24108 \begin_layout Standard
24110 \change_deleted 564990737 1669755802
24111 As usual, the easiest way to write a paper is to start with a template.
24114 File\SpecialChar menuseparator
24130 This will give an (almost) empty document that includes the most common
24131 fields found in a manuscript.
24132 Simply overwrite the existing text (including the brackets,
24137 You should keep in mind the following remarks.
24140 \begin_layout Enumerate
24142 \change_deleted 564990737 1669755802
24144 won't let you change the font size and the page style of the document,
24145 because such modifications are not allowed by both packages.
24148 \begin_layout Enumerate
24150 \change_deleted 564990737 1669755802
24151 The language of the document should not be changed.
24152 Before previewing your paper, be sure that the babel package is not used.
24153 To do this, click on
24156 arg "dialog-show document"
24161 \SpecialChar menuseparator
24165 \begin_inset Quotes eld
24169 \begin_inset Quotes erd
24179 \begin_layout Enumerate
24181 \change_deleted 564990737 1669755802
24183 \begin_inset Quotes eld
24187 \begin_inset Quotes erd
24190 style must be used to define keywords.
24193 \begin_layout Enumerate
24195 \change_deleted 564990737 1669755802
24196 The ijmpc package provides a style named
24197 \begin_inset Quotes eld
24200 Classification Codes
24201 \begin_inset Quotes erd
24204 , which can be used to define classification codes, such as PACS numbers.
24205 Note that this facility is not supported by the ijmpd package.
24208 \begin_layout Enumerate
24210 \change_deleted 564990737 1669755802
24211 Several new environments are available:
24212 \begin_inset Quotes eld
24216 \begin_inset Quotes erd
24220 \begin_inset Quotes eld
24224 \begin_inset Quotes erd
24228 \begin_inset Quotes eld
24232 \begin_inset Quotes erd
24236 \begin_inset Quotes eld
24240 \begin_inset Quotes erd
24244 \begin_inset Quotes eld
24248 \begin_inset Quotes erd
24252 \begin_inset Quotes eld
24256 \begin_inset Quotes erd
24260 \begin_inset Quotes eld
24264 \begin_inset Quotes erd
24268 \begin_inset Quotes eld
24272 \begin_inset Quotes erd
24276 \begin_inset Quotes eld
24280 \begin_inset Quotes erd
24284 \begin_inset Quotes eld
24288 \begin_inset Quotes erd
24292 \begin_inset Quotes eld
24296 \begin_inset Quotes erd
24300 \begin_inset Quotes eld
24304 \begin_inset Quotes erd
24308 \begin_inset Quotes eld
24312 \begin_inset Quotes erd
24316 \begin_inset Quotes eld
24320 \begin_inset Quotes erd
24324 Their use is more or less obvious.
24326 supports all these environments; it will use the proper label, text style,
24327 and numbering scheme for each of them.
24330 \begin_layout Enumerate
24332 \change_deleted 564990737 1669755802
24333 Both packages use basic citations; the natbib package should not be used.
24334 In \SpecialChar LyX
24335 , citation references are shown as usual; in the output, citations are
24336 shown as superscripts.
24337 If you want to use a citation as normal text, you should use the
24342 \begin_inset space \thinspace{}
24346 \begin_inset space \space{}
24350 \begin_inset Quotes eld
24354 \begin_inset space \space{}
24364 \begin_inset Quotes erd
24370 \begin_layout Enumerate
24372 \change_deleted 564990737 1669755802
24374 \begin_inset Quotes eld
24378 \begin_inset Quotes erd
24381 section in both packages.
24382 To put acknowledgments, just use the
24383 \begin_inset Quotes eld
24387 \begin_inset Quotes erd
24393 \begin_layout Enumerate
24395 \change_deleted 564990737 1669755802
24396 Appendices may be added to the paper,
24400 the Acknowledgments and
24406 provides a special environment, called
24407 \begin_inset Quotes eld
24411 \begin_inset Quotes erd
24414 which marks the beginning of the appendices.
24415 This environment should be left blank; it just sends a \SpecialChar LaTeX
24416 command, but nothing
24418 In \SpecialChar LyX
24420 \begin_inset Quotes eld
24424 \begin_inset Quotes erd
24427 is printed with blue letters, as a signal that all sections after that
24428 point are appendices.
24429 To write an appendix, use the
24430 \begin_inset Quotes eld
24434 \begin_inset Quotes erd
24439 will number each appendix with capital letters, as required by both journals.
24441 \begin_inset Quotes eld
24445 \begin_inset Quotes erd
24452 be present before the first appendix; if not, all appendices will be numbered
24453 as normal sections in the output.
24456 \begin_layout Enumerate
24458 \change_deleted 564990737 1669755802
24459 The ijmpc and the ijmpd packages use the
24463 command to implement table captions.
24464 As a result, a table created by \SpecialChar LyX
24465 is printed correctly, but its caption
24467 However, you can use some \SpecialChar TeX
24468 code to overcome this problem, so that captions
24469 are printed as expected.
24470 To do so, create a float table as usual, remove the caption, and replace
24471 it with the \SpecialChar TeX
24482 (sic); you must also the \SpecialChar TeX
24487 immediately after the tabular material.
24488 Study the example table included in the template files to see how this
24489 trick is implemented.
24490 Alternatively, If you need table captions, you should implement the whole
24495 file, then include this file to the \SpecialChar LyX
24498 Insert\SpecialChar menuseparator
24499 File\SpecialChar menuseparator
24501 \begin_inset space ~
24507 Details on how to create a table float can be found in the files
24515 , included in the corresponding packages.
24518 \begin_layout Subsection
24520 \change_deleted 564990737 1669755802
24521 Preparing a paper for submission
24524 \begin_layout Standard
24526 \change_deleted 564990737 1669755802
24527 Before you submit your paper you must export the \SpecialChar LyX
24528 document as a \SpecialChar LaTeX
24531 File\SpecialChar menuseparator
24532 Export\SpecialChar menuseparator
24540 \begin_layout Plain Layout
24541 Actually you have the choice between \SpecialChar LaTeX
24542 (plain) and pdflatex.
24543 If you intend to use pdflatex to prepare the paper, you should use the
24544 pdflatex option so that included graphics are converted to PDF format,
24545 ready for use by pdflatex.
24550 , then make the following changes to the resulting
24557 \begin_layout Enumerate
24559 \change_deleted 564990737 1669755802
24560 Remove the comment lines before the
24569 \begin_layout Enumerate
24571 \change_deleted 564990737 1669755802
24572 Remove everything between (and including) the
24584 commands, except for any commands you specifically put into the \SpecialChar LaTeX
24588 \begin_layout Standard
24590 \change_deleted 564990737 1669755802
24595 file should be saved and processed through \SpecialChar LaTeX
24596 as many times as necessary.
24597 You may also want to check the resulting
24606 \begin_layout Section
24608 \change_deleted 564990737 1669801478
24612 \begin_layout Standard
24614 \change_deleted 564990737 1669801478
24620 \begin_layout Subsection
24622 \change_deleted 564990737 1669801478
24626 \begin_layout Standard
24628 \change_deleted 564990737 1669801478
24629 The iopart package provides a document class to create electronic manuscript
24630 submission to the journals published by the Institute of Physics.
24631 Instructions for the authors how to create a paper using the iopart class
24632 can be downloaded together with the iopart package from the site
24633 \begin_inset Flex URL
24636 \begin_layout Plain Layout
24638 ftp://ftp.iop.org/pub/journals/latex2e
24646 \begin_layout Subsection
24648 \change_deleted 564990737 1669801478
24652 \begin_layout Standard
24654 \change_deleted 564990737 1669801478
24655 The easiest way to write a paper is to start with the template
24659 that is available via
24661 File\SpecialChar menuseparator
24664 The template explains how to use the special text environments.
24665 Here are the most important advices:
24668 \begin_layout Itemize
24670 \change_deleted 564990737 1669801478
24671 To be able to compile your document to a PDF, PS, or DVI, ensure that the
24672 no AMS packages are loaded in
24674 Document\SpecialChar menuseparator
24675 Settings\SpecialChar menuseparator
24681 \begin_layout Itemize
24683 \change_deleted 564990737 1669801478
24686 The title environment defines the kind of your paper.
24687 So use one of the following environments for the title:
24691 \begin_layout Itemize
24693 \change_deleted 564990737 1669801478
24702 \begin_layout Itemize
24704 \change_deleted 564990737 1669801478
24713 \begin_layout Itemize
24715 \change_deleted 564990737 1669801478
24721 for a Topical review
24724 \begin_layout Itemize
24726 \change_deleted 564990737 1669801478
24735 \begin_layout Itemize
24737 \change_deleted 564990737 1669801478
24746 \begin_layout Itemize
24748 \change_deleted 564990737 1669801478
24754 for a Paper (same as Title)
24757 \begin_layout Itemize
24759 \change_deleted 564990737 1669801478
24765 for a Preliminary communication
24768 \begin_layout Itemize
24770 \change_deleted 564990737 1669801478
24776 for a Rapid communication
24779 \begin_layout Itemize
24781 \change_deleted 564990737 1669801478
24787 for a Letter to the editor
24791 \begin_layout Itemize
24793 \change_deleted 564990737 1669801478
24796 All title environments except of
24800 can have an optional short title.
24803 \begin_layout Itemize
24805 \change_deleted 564990737 1669801478
24806 There is a general title environment
24810 which is not directly supported by \SpecialChar LyX
24812 This can be used as \SpecialChar TeX
24813 code when your document doesn't fit into one of the
24817 \begin_layout Standard
24819 \change_deleted 564990737 1669801478
24820 For more informations like hints for special table and formula formatting,
24821 look at the IOP author guidelines.
24826 \begin_layout Section
24828 \change_deleted 564990737 1670317155
24832 \begin_layout Standard
24834 \change_deleted 564990737 1670317155
24837 Panayotis Papasotiriou
24840 \begin_layout Subsection
24842 \change_deleted 564990737 1670317155
24846 \begin_layout Standard
24848 \change_deleted 564990737 1670317155
24849 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
24850 that facilitates electronic manuscript submission to the journals they
24852 Most known of them (at least in my domain of interest) are
24854 Astrophysics and Space Science
24860 , but there are many others (see a complete list at
24861 \begin_inset Flex URL
24864 \begin_layout Plain Layout
24866 http://www.wkap.nl/jrnllist.htm/JRNLHOME
24872 The Kluwer package may be downloaded from the site
24873 \begin_inset Flex URL
24876 \begin_layout Plain Layout
24878 http://www.wkap.nl/kaphtml.htm/STYLEFILES
24884 A complete user guide is contained in that package (but it can also be
24885 downloaded separately).
24888 \begin_layout Standard
24890 \change_deleted 564990737 1670317155
24892 supports many features of the package but not everything.
24893 However, the \SpecialChar TeX
24894 code needed is reduced to some
24895 \begin_inset Quotes eld
24899 \begin_inset Quotes erd
24902 commands of the package (see
24903 \begin_inset space ~
24907 \begin_inset CommandInset ref
24909 reference "subsec:kluwer_peculiarities"
24914 I have recently used \SpecialChar LyX
24915 to write an article submitted to the
24917 Astrophysics and Space Science
24919 without any problem.
24922 \begin_layout Subsection
24924 \change_deleted 564990737 1670317155
24928 \begin_layout Standard
24930 \change_deleted 564990737 1670317155
24931 The easiest way to write a paper is to start with the Kluwer template file.
24934 File\SpecialChar menuseparator
24946 This will give an (almost) empty document that includes the most common
24947 fields found in a manuscript and a short description of their use.
24948 As in most templates, simply overwrite the existing text (including the
24953 ) with the correct information.
24956 \begin_layout Subsection
24958 \change_deleted 564990737 1670317155
24959 Preparing a paper for submission
24962 \begin_layout Standard
24964 \change_deleted 564990737 1670317155
24965 As in the AAS\SpecialChar TeX
24966 package, before you submit your paper to a journal you must
24968 \begin_inset Quotes eld
24972 \begin_inset Quotes erd
24978 \begin_layout Enumerate
24980 \change_deleted 564990737 1670317155
24981 Export your paper as a \SpecialChar LaTeX
24983 To do this, click on
24985 File\SpecialChar menuseparator
24986 Export\SpecialChar menuseparator
24994 \begin_layout Enumerate
24996 \change_deleted 564990737 1670317155
25001 file with a text editor and make the following changes
25005 \begin_layout Enumerate
25007 \change_deleted 564990737 1670317155
25008 remove the comment lines before the
25017 \begin_layout Enumerate
25019 \change_deleted 564990737 1670317155
25020 remove everything between (and including) the
25032 commands, except for any commands you specifically put into the \SpecialChar LaTeX
25036 \begin_layout Standard
25038 \change_deleted 564990737 1670317155
25047 \begin_layout Enumerate
25049 \change_deleted 564990737 1670317155
25054 file through \SpecialChar LaTeX
25055 as many times as necessary (usually up to three).
25058 \begin_layout Enumerate
25060 \change_deleted 564990737 1670317155
25066 \begin_inset space \thinspace{}
25070 \begin_inset space \space{}
25077 , and check if everything is OK (it should, if you didn't make any mistake).
25080 \begin_layout Subsection
25082 \change_deleted 564990737 1670317155
25083 \begin_inset Quotes eld
25087 \begin_inset Quotes erd
25090 of the Kluwer package
25091 \begin_inset CommandInset label
25093 name "subsec:kluwer_peculiarities"
25100 \begin_layout Standard
25102 \change_deleted 564990737 1670317155
25103 The Kluwer package has the following
25104 \begin_inset Quotes eld
25108 \begin_inset Quotes erd
25114 \begin_layout Enumerate
25116 \change_deleted 564990737 1670317155
25117 It is possible to write multiple articles in the same \SpecialChar LaTeX
25122 \begin_layout Plain Layout
25123 I can't imagine any good reason to do this.
25129 Each article must be included in the environment
25130 \begin_inset Quotes eld
25134 \begin_inset Quotes erd
25138 Unfortunately, this environment cannot be omitted, even if you write just
25140 Therefore, each article starts with the command
25146 and, obviously, ends with the command
25153 Although this can be implemented in \SpecialChar LyX
25154 , I didn't included it, since it looks
25155 ugly and can confuse the novice user.
25156 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
25159 \begin_inset Quotes eld
25164 \begin_inset Quotes erd
25170 \begin_layout Enumerate
25172 \change_deleted 564990737 1670317155
25173 Information given at the beginning of the article (i.
25174 \begin_inset space \thinspace{}
25178 \begin_inset space \space{}
25181 title, subtitle, author, institution, running title, running author, abstract
25182 and keywords) must be included in an environment called
25183 \begin_inset Quotes eld
25187 \begin_inset Quotes erd
25191 This is not implemented in \SpecialChar LyX
25192 , so you must enter title, subtitle etc.
25193 \begin_inset space ~
25196 between two \SpecialChar TeX
25212 \begin_layout Enumerate
25214 \change_deleted 564990737 1670317155
25215 According to the user manual, the label of each bibliography item must be
25239 \begin_layout Standard
25241 \change_deleted 564990737 1670317155
25246 template takes care of all these
25247 \begin_inset Quotes eld
25251 \begin_inset Quotes erd
25255 If you start a new paper using this template you don't need to do anything
25260 \begin_layout Enumerate
25262 \change_deleted 564990737 1670317155
25263 don't delete the \SpecialChar TeX
25264 code included in the template, and
25267 \begin_layout Enumerate
25269 \change_deleted 564990737 1670317155
25270 copy the example bibliography item included in the template and modify it
25271 as necessary to enter new bibliography items.
25274 \begin_layout Section
25276 \change_deleted 564990737 1671097446
25280 \begin_layout Standard
25282 \change_deleted 564990737 1671097446
25287 provides an alternative to the standard
25292 It provides similar functionality, but you might prefer this layout with
25293 sans serif sections, headings, and more.
25296 \begin_layout Section
25298 \change_deleted 564990737 1671097446
25299 Springer Journals (
25306 \begin_layout Standard
25308 \change_deleted 564990737 1671097446
25314 \begin_layout Subsection
25316 \change_deleted 564990737 1671097446
25320 \begin_layout Standard
25322 \change_deleted 564990737 1671097446
25323 These are the layout files for some of the journal formats used by Springer
25324 Verlag and listed on
25325 \begin_inset Flex URL
25328 \begin_layout Plain Layout
25330 http://www.springer.de/author/tex/help-journals.html
25335 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
25337 It is a modular system: the things common to all journals are implemented
25342 , which journal-specific layout files (such as, e.
25343 \begin_inset space \thinspace{}
25347 \begin_inset space \space{}
25354 for Journal of Geodesy) can include.
25357 \begin_layout Standard
25359 \change_deleted 564990737 1671097446
25360 This means that implementing support for any other Springer journal on this
25361 list is as simple as writing your own
25369 file following the outline given in
25377 \begin_layout Standard
25379 \change_deleted 564990737 1671097446
25380 It is reasonably well tested only for the Journal of Geodesy.
25389 come with the standard \SpecialChar LyX
25391 Install the relevant class file (downloaded from Springer) in a proper
25392 directory, reconfigure \SpecialChar LaTeX
25393 (in the te\SpecialChar TeX
25398 , as root if necessary — doesn't \SpecialChar LyX
25399 take care of this?), reconfigure \SpecialChar LyX
25404 \begin_layout Subsection
25406 \change_deleted 564990737 1671097446
25410 \begin_layout Standard
25412 \change_deleted 564990737 1671097446
25413 A large number of theorem-like styles —
25425 \begin_layout Standard
25427 \change_deleted 564990737 1671097446
25430 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
25431 _Title, Author_Running, Institute,
25432 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
25435 See the Springer class file documentation for details.
25438 \begin_layout Subsection
25440 \change_deleted 564990737 1671097446
25444 \begin_layout Itemize
25446 \change_deleted 564990737 1671097446
25458 \begin_layout Itemize
25460 \change_deleted 564990737 1671097446
25463 Probability Theory and Related Fields
25469 — Jean-Marc Lasgouttes
25472 \begin_layout Standard
25474 \change_deleted 564990737 1671097446
25475 Add your own, it isn't so hard!
25478 \begin_layout Subsection
25480 \change_deleted 564990737 1671097446
25484 \begin_layout Standard
25486 \change_deleted 564990737 1671097446
25487 These files are partly based on the older
25491 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
25493 file from Springer.
25498 layout, are now defunct.
25499 Jean-Marc Lasgouttes helped out big in making me find my way around the
25501 layout file mechanism.
25504 \begin_layout Subsection
25506 \change_deleted 564990737 1671097446
25510 \begin_layout Standard
25512 \change_deleted 564990737 1671097446
25514 But probably less than in the old hacked-\SpecialChar LaTeX
25522 \begin_layout Chapter
25524 Features needing Extra Software
25527 \begin_layout Section
25528 Checking \SpecialChar TeX
25532 \begin_layout Standard
25538 \begin_layout Subsection
25542 \begin_layout Standard
25551 \begin_layout Plain Layout
25556 is not yet available when you are using the \SpecialChar LaTeX
25557 distribution MiK\SpecialChar TeX
25563 , you'll find in the
25570 \begin_inset space ~
25581 \begin_inset Newline newline
25585 \begin_inset CommandInset href
25587 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
25595 \begin_layout Standard
25598 Chk\SpecialChar TeX
25601 package is a program that was written by
25602 \begin_inset Flex Noun
25605 \begin_layout Plain Layout
25607 \begin_inset space ~
25615 in frustration because some constructs in \SpecialChar LaTeX
25616 are sometimes non-intuitive,
25617 and easy to forget.
25618 The program runs over your \SpecialChar LaTeX
25619 file, checks the integrity of the file, and
25620 flags some common errors.
25621 In other technical words, it is
25625 for \SpecialChar LaTeX
25629 \begin_layout Standard
25630 Well, what is a syntax checker doing in \SpecialChar LyX
25631 which is supposed to produce correct
25633 anyways? The answer is simple: Just as
25637 not only checks the
25641 of C programs, but also does
25645 checks for type-errors,
25647 Chk\SpecialChar TeX
25650 catches some common
25654 errors, in addition to the syntactical ones.
25657 Chk\SpecialChar TeX
25660 is capable of detecting several common errors, such as
25663 \begin_layout Itemize
25664 Ellipsis detection:
25665 \begin_inset Newline newline
25668 Use \SpecialChar ldots
25672 \begin_layout Itemize
25673 No space in front of/after parenthesis:
25674 \begin_inset Newline newline
25680 \begin_layout Itemize
25681 Enforcement of normal space after common abbreviations:
25682 \begin_inset Newline newline
25686 \begin_inset space \thinspace{}
25690 \begin_inset space \space{}
25693 is too wide spacing.
25696 \begin_layout Itemize
25697 Enforcement of end-of-sentence space when the last sentence ends with a
25699 \begin_inset Newline newline
25703 And this is wrong spacing.
25706 \begin_layout Itemize
25707 Space in front of labels and similar commands:
25708 \begin_inset Newline newline
25711 The label should stick right up to the text to avoid falling to a wrong
25714 \begin_inset CommandInset label
25724 \begin_layout Plain Layout
25725 This footnote is in danger of falling off to a wrong page
25730 The label is separated too much.
25733 \begin_layout Itemize
25734 Space in front of references, instead of hard spaces:
25735 \begin_inset Newline newline
25738 If you have bad luck, the text will break right between the referenced text
25739 and reference number, and that's a pity.
25741 \begin_inset CommandInset ref
25743 reference "sec:chktex"
25750 \begin_layout Itemize
25752 \begin_inset Quotes eld
25756 \begin_inset Quotes erd
25760 \begin_inset Formula $\times$
25764 \begin_inset Newline newline
25767 2x2 looks cheap compared to
25768 \begin_inset Formula $2\times2$
25774 \begin_layout Standard
25775 and more \SpecialChar ldots
25776 It is an invaluable tool when you are
25777 \begin_inset Quotes eld
25781 \begin_inset Quotes erd
25784 your document before printing, and you should run it right after the obligatory
25785 spelling check, and before you go fine tuning the typesetting.
25788 \begin_layout Subsection
25792 \begin_layout Standard
25793 If you have the program installed, usage is as simple as choosing
25795 Tools\SpecialChar menuseparator
25797 \begin_inset space ~
25803 This will make \SpecialChar LyX
25804 generate a \SpecialChar LaTeX
25805 file of your document, start
25807 Chk\SpecialChar TeX
25810 to check it, and then make \SpecialChar LyX
25812 \begin_inset Quotes eld
25816 \begin_inset Quotes erd
25819 with the warnings from
25821 Chk\SpecialChar TeX
25824 , if there were any.
25825 The warnings will be placed close to the point of the mistake, and you
25826 can quickly find them by using the
25828 Navigate\SpecialChar menuseparator
25831 menu item, or the shortcut key
25840 Open the error boxes by clicking on them with the mouse, or use the shortcut
25849 bindings, or the corresponding
25858 Read the warning and correct the mistake, if it is a mistake.
25859 If you have trouble understanding what the warning is about, you can safely
25861 Remember that there is a hidden layer between the document on screen and
25862 the technical details in invoking
25864 Chk\SpecialChar TeX
25867 , and this gap can make some warnings seem arcane or just plain silly.
25870 \begin_layout Standard
25871 This document is an excellent testing bed for the feature, and it should
25872 provide quite a few warnings for you to fiddle with.
25873 Since computers are only so smart, expect most of the warnings to be false
25877 \begin_layout Subsection
25878 How to fine tune it
25881 \begin_layout Standard
25882 Sometimes, you'll find that
25884 Chk\SpecialChar TeX
25887 makes more noise than suits your mood.
25888 Then you can choose not to use it, wait until your mood changes, or try
25891 Chk\SpecialChar TeX
25894 to get better along with you.
25897 \begin_layout Standard
25900 Chk\SpecialChar TeX
25907 very configurable and extensible, you should not expect to solve all problems
25910 Chk\SpecialChar TeX
25913 in \SpecialChar LyX
25915 Since \SpecialChar LyX
25916 has to generate a somewhat special \SpecialChar LaTeX
25917 file to be able to match the
25918 line numbers from the
25920 Chk\SpecialChar TeX
25927 \begin_layout Plain Layout
25928 You can inspect the specific output from
25934 Document\SpecialChar menuseparator
25937 \begin_inset space ~
25951 to the internal document structure, some of the warnings will not appear
25953 There are two things you can do about this:
25956 \begin_layout Itemize
25959 Chk\SpecialChar TeX
25962 invocation command line in
25963 \begin_inset Flex Noun
25966 \begin_layout Plain Layout
25967 Tools\SpecialChar menuseparator
25968 Preferences\SpecialChar menuseparator
25969 Output\SpecialChar menuseparator
25970 LaTeX\SpecialChar menuseparator
25978 Chk\SpecialChar TeX
25981 installation configuration file (usually with the file
25986 See below to learn what warnings can be enabled and disabled on the command
25990 \begin_layout Itemize
25991 Export your document as a raw \SpecialChar LaTeX
25994 File\SpecialChar menuseparator
25995 Export\SpecialChar menuseparator
26004 Invoked in this way, it can be a hassle to find the corresponding place
26005 in the document inside \SpecialChar LyX
26006 , but with a little patience, you should be able
26010 \begin_layout Standard
26011 Here follows the warning messages that can be enabled and disabled in
26020 to disable a warning, and
26024 to enable a warning.
26025 The emphasized entries are disabled by default, because the default is
26028 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
26033 \begin_layout Standard
26034 Notice that you should only use the options that enable and disable warnings,
26035 because \SpecialChar LyX
26036 relies on some of the other command line parameters to be set
26037 in a specific way to have a chance to communicate with
26044 \begin_layout Enumerate
26048 Command terminated with space.
26051 \begin_layout Enumerate
26054 Non-breaking space (
26055 \begin_inset Quotes eld
26063 \begin_inset Quotes erd
26066 ) should have been used.
26069 \begin_layout Enumerate
26073 You should enclose the previous parenthesis with
26074 \begin_inset Quotes eld
26082 \begin_inset Quotes erd
26088 \begin_layout Enumerate
26091 Italic correction (
26092 \begin_inset Quotes eld
26102 \begin_inset Quotes erd
26105 ) found in non-italic buffer.
26108 \begin_layout Enumerate
26111 Italic correction (
26112 \begin_inset Quotes eld
26122 \begin_inset Quotes erd
26125 ) found more than once.
26128 \begin_layout Enumerate
26132 No italic correction (
26133 \begin_inset Quotes eld
26143 \begin_inset Quotes erd
26149 \begin_layout Enumerate
26153 \begin_inset Quotes eld
26161 \begin_inset Quotes erd
26165 \begin_inset Quotes eld
26173 \begin_inset Quotes erd
26179 \begin_layout Enumerate
26182 Wrong length of dash may have been used.
26185 \begin_layout Enumerate
26189 \begin_inset Quotes eld
26197 \begin_inset Quotes erd
26201 \begin_inset Quotes eld
26209 \begin_inset Quotes erd
26215 \begin_layout Enumerate
26219 \begin_inset Quotes eld
26227 \begin_inset Quotes erd
26233 \begin_layout Enumerate
26237 \begin_inset Quotes eld
26245 \begin_inset Quotes erd
26248 to achieve an ellipsis.
26251 \begin_layout Enumerate
26254 Inter-word spacing (
26255 \begin_inset Quotes eld
26265 \begin_inset Quotes eld
26268 ) should perhaps be used.
26271 \begin_layout Enumerate
26274 Inter-sentence spacing (
26275 \begin_inset Quotes eld
26285 \begin_inset Quotes erd
26288 ) should perhaps be used.
26291 \begin_layout Enumerate
26294 Could not find argument for command.
26297 \begin_layout Enumerate
26301 \begin_inset Quotes eld
26309 \begin_inset Quotes erd
26315 \begin_layout Enumerate
26318 Math mode still on at end of \SpecialChar LaTeX
26322 \begin_layout Enumerate
26326 \begin_inset Quotes eld
26334 \begin_inset Quotes erd
26337 doesn't match the number of
26338 \begin_inset Quotes eld
26346 \begin_inset Quotes erd
26352 \begin_layout Enumerate
26355 You should use either
26358 \begin_inset Quotes eld
26366 \begin_inset Quotes erd
26371 as an alternative to
26372 \begin_inset Quotes eld
26380 \begin_inset Quotes erd
26386 \begin_layout Enumerate
26393 " (ASCII 39) instead of "
26400 \begin_layout Enumerate
26403 User-specified pattern found.
26406 \begin_layout Enumerate
26409 This command might not be intended.
26412 \begin_layout Enumerate
26419 \begin_layout Enumerate
26437 \begin_layout Enumerate
26440 Delete this space to maintain correct page references.
26443 \begin_layout Enumerate
26447 You might wish to put this between a pair of
26448 \begin_inset Quotes eld
26456 \begin_inset Quotes erd
26462 \begin_layout Enumerate
26465 You ought to remove spaces in front of punctuation.
26468 \begin_layout Enumerate
26471 Could not execute \SpecialChar LaTeX
26475 \begin_layout Enumerate
26484 in front of small punctuation.
26487 \begin_layout Enumerate
26495 may look prettier here.
26498 \begin_layout Enumerate
26502 Multiple spaces detected in output.
26505 \begin_layout Enumerate
26508 This text may be ignored.
26511 \begin_layout Enumerate
26517 \begin_inset Quotes eld
26522 to begin quotation, not
26529 \begin_layout Enumerate
26536 to end quotation, not
26539 \begin_inset Quotes eld
26547 \begin_layout Enumerate
26553 \begin_layout Enumerate
26556 You should perhaps use
26557 \begin_inset Quotes eld
26565 \begin_inset Quotes erd
26571 \begin_layout Enumerate
26574 You should put a space in front of/after parenthesis.
26577 \begin_layout Enumerate
26580 You should avoid spaces in front of/after parenthesis.
26583 \begin_layout Enumerate
26587 You should not use punctuation in front of/after quotes.
26590 \begin_layout Enumerate
26593 Double space found.
26596 \begin_layout Enumerate
26599 You should put punctuation outside inner/inside display math mode.
26602 \begin_layout Enumerate
26605 You ought to not use primitive \SpecialChar TeX
26606 in \SpecialChar LaTeX
26610 \begin_layout Enumerate
26613 You should remove spaces in front of
26614 \begin_inset Quotes eld
26622 \begin_inset Quotes erd
26628 \begin_layout Enumerate
26631 \begin_inset Quotes eld
26639 \begin_inset Quotes erd
26642 is normally not followed by
26643 \begin_inset Quotes eld
26651 \begin_inset Quotes erd
26657 \begin_layout Standard
26658 In later versions of \SpecialChar LyX
26659 , we hope to provide a more complete interface to this
26660 tool (and it's smaller cousin
26664 ) to exploit the full power of it.
26665 But it's not exactly useless as it is now: go try it on one of your existing
26666 documents of a certain length and be surprised.
26669 \begin_layout Section
26670 Version Control in \SpecialChar LyX
26674 \begin_layout Standard
26677 Lars Gullik Bjønnes
26684 \begin_layout Subsection
26688 \begin_layout Standard
26690 supports some of the most basic RCS/CVS/SVN/GIT commands.
26691 If you need something a bit more sophisticated you will have to do that
26692 manually in a terminal.
26695 \begin_layout Standard
26696 Also note that CVS support is not as good as subversion support, so we advise
26698 A good place to start learning Subversion is the SVN Book
26702 \begin_layout Plain Layout
26703 \begin_inset CommandInset href
26705 target "http://svnbook.red-bean.com/"
26716 In the case of RCS you should read
26717 \begin_inset Quotes eld
26721 \begin_inset Quotes erd
26724 (a man file, read it with
26729 This file describes all the basic features of RCS.
26730 You should especially notice the comment about a RCS directory, and the
26731 notion of a master RCS file (the file ending in
26738 \begin_layout Standard
26739 Before you begin to use the version control features in \SpecialChar LyX
26741 familiar with RCS/CVS/SVN/GIT usage.
26742 The implementation in \SpecialChar LyX
26743 assumes a recent version of the GNU RCS or CVS/SVN
26744 package — no guarantees are made for older versions.
26745 Most of the log messages are not currently displayed after operations —
26746 you can check them in the Messages pane if you are unsure.
26747 Regular users of version control will appreciate the VC toolbar, which
26750 View\SpecialChar menuseparator
26751 Toolbars\SpecialChar menuseparator
26753 \begin_inset space ~
26761 \begin_layout Standard
26762 For introducing your own external commands consult
26763 \begin_inset Flex Code
26766 \begin_layout Plain Layout
26780 \begin_layout Standard
26781 It is strongly recommended to store documents in uncompressed format if
26782 using version control (uncheck
26784 Document\SpecialChar menuseparator
26787 if it is checked): Uncompressed LyX documents are text files and therefore
26788 for merging two different versions by version control systems.
26789 Compressed LyX documents are binary files, which cannot be merged by version
26793 \begin_layout Subsection
26794 RCS commands in \SpecialChar LyX
26798 \begin_layout Standard
26799 The following sections describe the RCS commands supported by \SpecialChar LyX
26801 You can find them in the
26803 File\SpecialChar menuseparator
26805 \begin_inset space ~
26812 was tested against RCS 5.7/5.8.
26815 \begin_layout Subsubsection
26821 \begin_layout Standard
26822 If your document is not under revision control, this is the only item shown
26824 And if it is under revision control, the
26828 item is not visible.
26832 \begin_layout Standard
26833 This command registers your document with RCS (unless you are under the
26834 directory managed by CVS)\SpecialChar endofsentence
26835 You are asked interactively to supply an initial
26836 description of the document.
26837 The document is now set in Read-Only mode and you have to
26840 \begin_inset space ~
26844 \begin_inset space ~
26848 \begin_inset space ~
26853 , before making any changes to it.
26854 A document under revision control has a
26855 \begin_inset Quotes eld
26858 [RCS:<version> <locker>]
26859 \begin_inset Quotes erd
26862 item tagged to the filename in the minibuffer.
26865 \begin_layout Standard
26866 RCS command that is run:
26869 \begin_layout LyX-Code
26872 ci -q -u -i -t-"<initial description>" <file-name>
26875 \begin_layout Standard
26880 to understand the switches.
26884 \begin_layout Subsubsection
26890 \begin_layout Standard
26891 When you are finished editing a file, you check in your changes.
26892 When you do this, you are asked for a description of the changes.
26893 This is stored in the history log.
26894 The version number is bumped, your changes are applied to the master RCS
26895 file, the document is unlocked and set to Read-Only mode.
26898 \begin_layout Itemize
26901 ci -q -u -m"<description>" <file-name>
26904 \begin_layout Subsubsection
26910 \begin_layout Standard
26911 By doing this you lock the document so that only you can edit it.
26912 This will also make the document Read-Write only for you.
26913 You will usually continue editing for a while and when you are finished
26914 you check in your changes.
26915 The status line is changed to reflect that you have locked the file.
26918 \begin_layout Itemize
26921 co -q -l <file-name>
26924 \begin_layout Subsubsection
26927 Revert To Repository Version
26930 \begin_layout Standard
26931 This will discard all changes made to the document since the last check
26933 You get a warning before changes are discarded.
26936 \begin_layout Itemize
26939 co -f -u<version> <file-name>
26942 \begin_layout Subsubsection
26948 \begin_layout Standard
26949 This will create a copy of the current document.
26950 Since RCS does not support copy operations natively, the version history
26951 is not preserved, and the copy is added as a new file.
26952 It requires a clean document without any changes since the last checkin.
26953 You are asked for a file name and a description of the copy operation.
26954 After that the copy is created, both locally and in the repository.
26955 If the parent directories of the copied and original document differ, all
26956 relative paths of included files of the copy are adjusted (like in
26958 File\SpecialChar menuseparator
26963 Finally, the copy is loaded instead of the original document.
26966 \begin_layout Labeling
26967 \labelwidthstring 00.00.0000
26969 \begin_inset space ~
26973 \begin_inset space ~
26977 \begin_inset Newline newline
26981 \begin_inset Flex Code
26984 \begin_layout Plain Layout
26987 \begin_inset Quotes qld
26991 \begin_inset Quotes qld
27000 \begin_inset Flex Code
27003 \begin_layout Plain Layout
27006 \begin_inset Quotes qld
27010 \begin_inset Quotes qld
27019 \begin_inset Newline newline
27023 \begin_inset Flex Code
27026 \begin_layout Plain Layout
27030 \begin_inset Quotes qld
27034 \begin_inset Quotes qld
27045 \begin_layout Subsubsection
27051 \begin_layout Standard
27052 This makes as if the last check in never happened.
27053 No changes are made to the document loaded into \SpecialChar LyX
27054 , but the last version
27055 is removed from the master RCS file.
27058 \begin_layout Itemize
27061 rcs -o<version> <file-name>
27064 \begin_layout Subsubsection
27070 \begin_layout Standard
27071 This shows the complete history of the RCS document.
27076 is shown in a browser.
27084 \begin_layout Subsubsection
27088 \begin_layout Standard
27090 supports RCS version number, author name, date and time of last commit.
27091 All those are extracted from
27093 rlog -r <file-name>
27097 \begin_inset CommandInset ref
27099 reference "subsec:VCS-Revision-Information"
27106 \begin_layout Subsection
27107 CVS commands in \SpecialChar LyX
27111 \begin_layout Standard
27112 A subset of CVS operations is supported by \SpecialChar LyX
27114 You can find the commands in the
27116 File\SpecialChar menuseparator
27118 \begin_inset space ~
27124 The version control system SVN is more powerful, so please use it instead
27125 of CVS if possible.
27128 \begin_layout Subsubsection
27134 \begin_layout Standard
27135 If you start from scratch with CVS you have to create your repository and
27136 checkout the working copy with external tools.
27137 If you're using a client-server setup you may need to login before doing
27138 the first repository checkout.
27141 \begin_layout Standard
27142 If your documents are under revision control and others are using the same
27143 repository problems arise when different changes to the same document at
27144 the same location happen.
27145 Standard CVS repositories don't operate with a file locking mechanism.
27146 This may be surprising, but conflicts only occur if people disagree on
27147 the proper content of the same part of a document.
27148 So, if co-workers are used to communicate regularly, these conflicts occur
27150 If they don't communicate they have a fundamental problem anyway.
27151 Nevertheless some people like to work with so called
27152 \begin_inset Quotes eld
27156 \begin_inset Quotes erd
27160 If they do so the working copy of all files is readonly when checked out
27161 first and the user starts editing after using a special command to make
27162 the working copy writable.
27163 When the changes are checked in the working copy returns to readonly state.
27164 With \SpecialChar LyX
27165 one has to edit the
27166 \begin_inset Flex Code
27169 \begin_layout Plain Layout
27175 file and add the line
27176 \begin_inset Flex Code
27179 \begin_layout Plain Layout
27185 to work with reserved checkouts.
27186 The benefit is the possibility to see who is using a writable copy of some
27188 It's not guaranteed only one user makes a copy writable.
27191 \begin_layout Standard
27193 tries to guess if you're using reserved or non-reserved checkouts.
27194 If your working copy is readonly or it is writable and an additional copy
27195 of your document exists in the CVS/Base sub-directory a reserved otherwise
27196 a non-reserved checkout is assumed.
27197 When a reserved checkout is detected you have to use
27198 \begin_inset Flex Noun
27201 \begin_layout Plain Layout
27207 to make your working copy writable if it's readonly.
27209 \begin_inset Flex Noun
27212 \begin_layout Plain Layout
27218 operation is possible and that makes your working copy readonly again after
27219 transferring your changes to the repository.
27222 \begin_layout Standard
27223 More information about CVS can be found here
27224 \begin_inset Flex URL
27227 \begin_layout Plain Layout
27229 http://www.nongnu.org/cvs
27235 \begin_inset Flex URL
27238 \begin_layout Plain Layout
27240 http://ximbiot.com/cvs
27248 \begin_layout Standard
27253 to understand the sub-commands and the switches mentioned below.
27256 \begin_layout Subsubsection
27262 \begin_layout Standard
27263 If your document is not under revision control, this is the only item shown
27265 And if it is under revision control, the
27269 item is not visible.
27273 \begin_layout Standard
27274 This command registers in CVS your document
27275 \begin_inset Flex Strong
27278 \begin_layout Plain Layout
27286 in the case you have already the documents directory under CVS control
27292 This means you have to create or checkout the archive by yourself using
27294 (In case you forget that step \SpecialChar LyX
27295 registers the document with RCS.)
27298 \begin_layout Standard
27299 Then you are asked interactively to supply an initial description of the
27301 Don't forget that registered file is not yet checked in.
27304 \begin_layout Standard
27305 CVS command that is run:
27307 cvs -q add -m"<entered message>" "<file-name>"
27310 \begin_layout Standard
27315 above and for all other CVS commands is an abbreviation for
27316 \begin_inset Quotes eld
27319 change the current working directory to file location and use the file name
27320 without path component as argument
27321 \begin_inset Quotes erd
27327 \begin_layout Subsubsection
27333 \begin_layout Standard
27334 When you are finished editing a file, you commit your changes.
27335 When you do this and you had changed the document, you are asked for a
27336 description of the changes.
27337 After that changes are written to the repository.
27338 In case you didn't change the document and a reserved checkout is detected
27339 the reservation made on
27340 \begin_inset Flex Noun
27343 \begin_layout Plain Layout
27352 \begin_layout Labeling
27353 \labelwidthstring 00.00.0000
27355 \begin_inset space ~
27359 \begin_inset space ~
27363 \begin_inset Newline newline
27367 \begin_inset Flex Code
27370 \begin_layout Plain Layout
27373 -q commit -m"<description>" "<file-name>"
27379 \begin_inset Newline newline
27383 \begin_inset Flex Code
27386 \begin_layout Plain Layout
27397 \begin_layout Subsubsection
27403 \begin_layout Standard
27404 When you are sharing a repository with others, you may have to incorporate
27405 their changes into your working copy.
27408 \begin_layout Standard
27411 cvs -q update "<file-name>"
27414 \begin_layout Standard
27415 If a readonly checkout is detected the working copy is made writable and
27419 \begin_layout Standard
27422 cvs -q edit "<file-name>"
27425 \begin_layout Subsubsection
27428 Revert To Repository Version
27431 \begin_layout Standard
27432 This will discard all changes made to the document since the last check
27434 You get a warning before changes are discarded.
27435 Firstly the file is deleted, secondly CVS update command is run.
27438 \begin_layout Standard
27441 cvs -q update "<file-name>"
27444 \begin_layout Standard
27445 If a reserved checkout is detected and the working copy has no changes only
27446 the reservation is undone.
27449 \begin_layout Standard
27452 cvs -q unedit "<file-name>"
27455 \begin_layout Subsubsection
27461 \begin_layout Standard
27462 This will create a copy of the current document.
27463 Since CVS does not support copy operations natively, the version history
27464 is not preserved, and the copy is added as a new file.
27465 It requires a clean document without any changes since the last checkin.
27466 You are asked for a file name and a description of the copy operation.
27467 After that the copy is created, both locally and in the repository.
27468 If the parent directories of the copied and original document differ, all
27469 relative paths of included files of the copy are adjusted (like in
27471 File\SpecialChar menuseparator
27476 Finally, the copy is loaded instead of the original document.
27479 \begin_layout Labeling
27480 \labelwidthstring 00.00.0000
27482 \begin_inset space ~
27486 \begin_inset space ~
27490 \begin_inset Newline newline
27494 \begin_inset Flex Code
27497 \begin_layout Plain Layout
27504 \begin_inset Flex Code
27507 \begin_layout Plain Layout
27514 \begin_inset Newline newline
27518 \begin_inset Flex Code
27521 \begin_layout Plain Layout
27522 cvs -q add "<new-file-name>"
27530 \begin_layout Subsubsection
27536 \begin_layout Standard
27537 This will rename the current document.
27538 Since CVS does not support rename operations natively, the version history
27539 is not preserved, the renamed document is added as a new file, and the
27540 original document is deleted.
27541 It requires a clean document without any changes since the last checkin.
27542 You are asked for a file name and a description of the rename operation.
27543 After that the document is renamed, both locally and in the repository.
27544 If the parent directories of the new and old file names differ, all relative
27545 paths of included files are adjusted (like in
27547 File\SpecialChar menuseparator
27552 Finally, the document is reloaded using the new name.
27555 \begin_layout Labeling
27556 \labelwidthstring 00.00.0000
27558 \begin_inset space ~
27562 \begin_inset space ~
27566 \begin_inset Newline newline
27570 \begin_inset Flex Code
27573 \begin_layout Plain Layout
27580 \begin_inset Flex Code
27583 \begin_layout Plain Layout
27590 \begin_inset Newline newline
27594 \begin_inset Flex Code
27597 \begin_layout Plain Layout
27598 cvs -q add "<new-file-name>"
27604 \begin_inset Newline newline
27608 \begin_inset Flex Code
27611 \begin_layout Plain Layout
27612 cvs -q remove "<file-name>"
27620 \begin_layout Subsubsection
27621 Update of the local directory checkout from repository
27624 \begin_layout Standard
27625 Once your documents gets more complex, containing sub-documents and pictures,
27627 \begin_inset Flex Code
27630 \begin_layout Plain Layout
27636 files and so on using version control becomes more complicated.
27638 supports updating the whole tree in which resides the document.
27639 This become especially useful once you cooperate with people which neither
27640 have detailed knowledge about CVS usage nor they have ambition to commit
27641 additional material to the repository.
27642 You have to organize the files structure so that all external files are
27643 in the same directory or subdirectories of the document.
27644 It's good practice anyway to store multipart documents in an extra directory.
27647 \begin_layout Standard
27649 \begin_inset Flex Code
27652 \begin_layout Plain Layout
27653 Update local directory from repository
27658 command updates the whole directory.
27659 If local changes are detected user is warned before update starts.
27660 In case of merge conflicts both versions of the conflicting document parts
27661 are placed in the final document.
27662 You have to review and correct the result of the merge.
27663 You'll find the conflicts enclosed in pairs of
27664 \begin_inset Flex Code
27667 \begin_layout Plain Layout
27674 \begin_inset Flex Code
27677 \begin_layout Plain Layout
27684 \begin_inset Flex Code
27687 \begin_layout Plain Layout
27694 The first part is your version as before the update operation with the
27695 document name prepended.
27696 The second one is the repository version with the version number after
27698 \begin_inset Flex Code
27701 \begin_layout Plain Layout
27710 \begin_layout Labeling
27711 \labelwidthstring 00.00.0000
27713 \begin_inset space ~
27717 \begin_inset space ~
27721 \begin_inset Newline newline
27725 \begin_inset Flex Code
27728 \begin_layout Plain Layout
27736 (Ask if changes are detected.)
27737 \begin_inset Newline newline
27741 \begin_inset Flex Code
27744 \begin_layout Plain Layout
27745 cd $path; cvs -q update
27755 \begin_layout Standard
27757 \begin_inset Flex Code
27760 \begin_layout Plain Layout
27766 stands for the path to the document.
27769 \begin_layout Subsubsection
27775 \begin_layout Standard
27776 This shows the complete history of the CVS document.
27779 cvs log "<file-name>"
27781 is shown in a browser.
27784 \begin_layout Subsubsection
27788 \begin_layout Standard
27790 supports CVS version number, author name, date and time of last commit.
27791 All those are extracted from
27793 cvs log -r <file-name>
27797 \begin_inset CommandInset ref
27799 reference "subsec:VCS-Revision-Information"
27806 \begin_layout Subsection
27807 SVN commands in \SpecialChar LyX
27811 \begin_layout Standard
27812 SVN is now partially supported by \SpecialChar LyX
27814 You can find the commands in the
27816 File\SpecialChar menuseparator
27818 \begin_inset space ~
27824 Please note that if you use password protected access to repository via
27825 ssh, you will be asked in terminal window.
27827 was tested against SVN 1.5, 1.6, 1.7 and 1.8
27831 \begin_layout Plain Layout
27832 Most of the commands will work with 1.4 too, see
27833 \begin_inset CommandInset ref
27835 reference "subsec:SVN-Repo-Update"
27840 There seems to be currently unresolved permissions problem under SVN 1.8
27841 with reverting changes when file is locked.
27849 \begin_layout Subsubsection
27855 \begin_layout Standard
27856 If your document is not under revision control, this is the only item shown
27858 And if it is under revision control, the
27862 item is not visible.
27865 \begin_layout Standard
27866 This command registers in SVN your document ONLY in case you have already
27867 the documents directory under SVN control (in particular
27872 This means you have to checkout the archive by yourself.
27875 \begin_layout Standard
27876 Then you are asked interactively to supply an initial description of the
27878 Don't forget that registered file is not yet commited.
27881 \begin_layout Standard
27882 SVN command that is run:
27885 \begin_inset Quotes qld
27889 \begin_inset Quotes qld
27895 \begin_layout Standard
27900 to understand the switches.
27903 \begin_layout Subsubsection
27909 \begin_layout Standard
27910 When you are finished editing a file, you commit your changes.
27911 When you do this, you are asked for a description of the changes.
27912 After that changes are commited.
27915 \begin_layout Standard
27920 \begin_layout Plain Layout
27921 In case locking is not enabled.
27923 \begin_inset CommandInset ref
27925 reference "subsec:SVN-File-Locking"
27936 svn commit -q -m"<description>" <file-name>
27939 \begin_layout Subsubsection
27945 \begin_layout Standard
27946 Updates the changes of this file from the repository.
27947 Be sure you understand SVN merging and conflicts resolving before using
27948 this function, because all conflicts has to be resolved manually by you!
27951 \begin_layout Standard
27956 \begin_layout Plain Layout
27964 svn update --non-interactive
27965 \begin_inset Quotes qld
27969 \begin_inset Quotes qld
27975 \begin_layout Subsubsection
27978 Revert To Repository Version
27981 \begin_layout Standard
27982 This will discard all changes made to the document since the last check
27984 You get a warning before changes are discarded.
27987 \begin_layout Standard
27991 \begin_inset Quotes qld
27995 \begin_inset Quotes qld
28001 \begin_layout Subsubsection
28007 \begin_layout Standard
28008 This will create a copy of the current document including the version history.
28009 It requires a clean document without any changes since the last checkin.
28010 You are asked for a file name and a description of the copy operation.
28011 After that the copy is created, both locally and in the repository.
28012 If the parent directories of the copied and original document differ, all
28013 relative paths of included files of the copy are adjusted (like in
28015 File\SpecialChar menuseparator
28020 Finally, the copy is loaded instead of the original document.
28023 \begin_layout Labeling
28024 \labelwidthstring 00.00.0000
28026 \begin_inset space ~
28030 \begin_inset space ~
28034 \begin_inset Newline newline
28038 \begin_inset Flex Code
28041 \begin_layout Plain Layout
28045 \begin_inset Quotes qld
28049 \begin_inset Quotes qld
28053 \begin_inset Quotes qld
28057 \begin_inset Quotes qld
28066 \begin_inset Newline newline
28070 \begin_inset Flex Code
28073 \begin_layout Plain Layout
28082 \begin_layout Subsubsection
28088 \begin_layout Standard
28089 This will rename the current document including the version history.
28090 It requires a clean document without any changes since the last checkin.
28091 You are asked for a file name and a description of the rename operation.
28092 After that the document is renamed, both locally and in the repository.
28093 If the parent directories of the new and old file names differ, all relative
28094 paths of included files are adjusted (like in
28096 File\SpecialChar menuseparator
28101 Finally, the document is reloaded using the new name.
28104 \begin_layout Labeling
28105 \labelwidthstring 00.00.0000
28107 \begin_inset space ~
28111 \begin_inset space ~
28115 \begin_inset Newline newline
28119 \begin_inset Flex Code
28122 \begin_layout Plain Layout
28126 \begin_inset Quotes qld
28130 \begin_inset Quotes qld
28134 \begin_inset Quotes qld
28138 \begin_inset Quotes qld
28147 \begin_inset Newline newline
28151 \begin_inset Flex Code
28154 \begin_layout Plain Layout
28163 \begin_layout Subsubsection
28164 \begin_inset CommandInset label
28166 name "subsec:SVN-Repo-Update"
28170 Update of the local directory checkout from repository
28174 \begin_layout Plain Layout
28175 Note that this command will work only with subversion
28176 \begin_inset Formula $\geqq1.5$
28187 \begin_layout Standard
28188 All the commands above have one shortcoming – they deal with the current
28190 Once your document contains pictures, includes external
28191 \begin_inset Flex Code
28194 \begin_layout Plain Layout
28200 files and so on administration becomes more complicated.
28202 now supports updating the whole tree in which resides the document
28206 \begin_layout Plain Layout
28207 One need to organize the files structure so that all external files are
28208 in the same directory or subdirectories of the document.
28215 This become especially useful once you cooperate with people which neither
28216 know about subversion management nor they have ambition to commit additional
28217 material to the repository.
28221 \begin_layout Standard
28222 \begin_inset Flex Code
28225 \begin_layout Plain Layout
28226 Update local directory from repository
28231 command updates the whole directory and in case of merge conflicts local
28232 version of the files are left, so no unintended data loss occurs.
28233 If local changes are detected user is warned before update starts.
28236 \begin_layout Labeling
28237 \labelwidthstring 00.00.0000
28239 \begin_inset space ~
28243 \begin_inset space ~
28247 \begin_inset Newline newline
28251 \begin_inset Flex Code
28254 \begin_layout Plain Layout
28260 (Ask if changes are detected.)
28261 \begin_inset Newline newline
28265 \begin_inset Flex Code
28268 \begin_layout Plain Layout
28269 svn update --accept mine-full $path
28277 \begin_layout Standard
28279 \begin_inset Flex Code
28282 \begin_layout Plain Layout
28288 stands for the path to the document.
28291 \begin_layout Subsubsection
28297 \begin_layout Standard
28298 This shows the complete history of the SVN document.
28302 \begin_inset Quotes qld
28306 \begin_inset Quotes qld
28311 is shown in a browser.
28314 \begin_layout Subsubsection
28316 \begin_inset CommandInset label
28318 name "subsec:SVN-File-Locking"
28325 \begin_layout Standard
28326 The file exchange through various revision control systems brings the problem
28327 of merge conflicts in case two different users try to edit the same (parts
28329 When such a conflict happens it needs manual resolving and one reasonable
28330 alternative is to provide some kind of locking mechanism, which guarantees
28331 that only one user is allowed to edit file at the given time.
28334 \begin_layout Standard
28335 SVN has two such mechanisms to provide mutual exclusivity for file access
28336 – locks and automatic setting of write permissions (see sec.
28338 \begin_inset CommandInset ref
28340 reference "subsec:Automatical-Locking-Property"
28345 \begin_inset Flex Code
28348 \begin_layout Plain Layout
28358 \begin_layout Plain Layout
28359 \begin_inset Flex URL
28362 \begin_layout Plain Layout
28364 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
28375 If this property is detected for a given document \SpecialChar LyX
28376 starts to use SVN locks
28377 for document editing automatically and the whole check-in/out mechanism
28378 switches to the same regimen as for RCS.
28379 This in particular means there are two different modes of file use in \SpecialChar LyX
28383 \begin_layout Itemize
28385 The loaded file is in the read-only mode.
28386 For editing on needs to check-out.
28391 consists of updating from the repository and gaining write lock.
28392 If the lock is not possible to obtain, we remain in unlocked state.
28395 \begin_layout Itemize
28397 The loaded file is in the
28398 \begin_inset Quotes els
28402 \begin_inset Quotes ers
28406 No other user is allowed to edit the file.
28411 consists of commiting changes and releasing write-lock.
28412 If no changes have been made to the document, no commit will be produced
28416 \begin_layout Plain Layout
28417 Don't be puzzled by the fact that you will be asked for commit message anyway.
28422 and only the write-lock will be released.
28425 \begin_layout Standard
28429 \begin_layout Labeling
28430 \labelwidthstring 00.00.0000
28433 svn commit -q -m"<description>" "<file-name>"
28434 \begin_inset Newline newline
28437 svn unlock "<file-name>"
28440 \begin_layout Labeling
28441 \labelwidthstring 00.00.0000
28444 svn update "<file-name>"
28445 \begin_inset Newline newline
28448 svn lock "<file-name>"
28451 \begin_layout Subsubsection
28454 \begin_inset CommandInset label
28456 name "subsec:Automatical-Locking-Property"
28462 Automatic Locking Property
28465 \begin_layout Standard
28466 The above mentioned automatic setting of write permissions of the .lyx file
28469 File\SpecialChar menuseparator
28471 \begin_inset space ~
28474 Control\SpecialChar menuseparator
28475 Use Locking Property
28478 This command is active only when the file is not locked on the svn server
28480 you need to check-out before proceeding).
28483 \begin_layout Labeling
28484 \labelwidthstring 00.00.0000
28486 \begin_inset space ~
28492 \begin_layout Labeling
28493 \labelwidthstring 00.00.0000
28496 svn propset svn:needs-lock ON "<file-name>"
28499 \begin_layout Labeling
28500 \labelwidthstring 00.00.0000
28503 svn propdel svn:needs-lock "<file-name>"
28506 \begin_layout Subsubsection
28507 \begin_inset CommandInset label
28509 name "subsec:VCS-Revision-Information"
28513 Revision Information in Documents
28516 \begin_layout Standard
28517 There are more possibilities how to activate revision information in our
28521 \begin_layout Itemize
28527 \begin_layout Itemize
28528 tree revision information (
28529 \begin_inset Flex Code
28532 \begin_layout Plain Layout
28539 The result is the output of the
28540 \begin_inset Flex Code
28543 \begin_layout Plain Layout
28549 command, the following table gives you an idea, how to read the results.
28552 \begin_layout Standard
28554 \begin_inset Tabular
28555 <lyxtabular version="3" rows="6" columns="2">
28556 <features tabularvalignment="middle">
28557 <column alignment="left" valignment="top">
28558 <column alignment="left" valignment="top">
28560 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
28563 \begin_layout Plain Layout
28571 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
28574 \begin_layout Plain Layout
28584 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
28587 \begin_layout Plain Layout
28593 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
28596 \begin_layout Plain Layout
28597 mixed revision working copy
28604 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
28607 \begin_layout Plain Layout
28613 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
28616 \begin_layout Plain Layout
28617 modified working copy
28624 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
28627 \begin_layout Plain Layout
28633 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
28636 \begin_layout Plain Layout
28637 switched working copy
28644 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
28647 \begin_layout Plain Layout
28653 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
28656 \begin_layout Plain Layout
28657 partial working copy, from a sparse checkout
28664 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
28667 \begin_layout Plain Layout
28673 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
28676 \begin_layout Plain Layout
28677 mixed revision, modified, switched working copy
28690 \begin_layout Itemize
28691 file revision information.
28692 The result comes from parsing the output of
28693 \begin_inset Flex Code
28696 \begin_layout Plain Layout
28698 \begin_inset space ~
28702 \begin_inset space ~
28706 \begin_inset space ~
28715 Supported flags are:
28719 \begin_layout Itemize
28720 version number of the last commit (
28721 \begin_inset Flex Code
28724 \begin_layout Plain Layout
28733 \begin_layout Itemize
28734 author of the last commit (
28735 \begin_inset Flex Code
28738 \begin_layout Plain Layout
28747 \begin_layout Itemize
28748 date of the last commit (
28749 \begin_inset Flex Code
28752 \begin_layout Plain Layout
28761 \begin_layout Itemize
28762 time of the last commit (
28763 \begin_inset Flex Code
28766 \begin_layout Plain Layout
28776 \begin_layout Standard
28777 You can obtain this info via InsetInfo (
28778 \change_inserted 5863208 1564400022
28781 Insert\SpecialChar menuseparator
28782 Field\SpecialChar menuseparator
28783 Version Control Revision
28784 \change_deleted 5863208 1564399852
28789 \begin_inset Flex Code
28792 \begin_layout Plain Layout
28793 info-insert buffer vcs-date
28801 The information will be available only when you have the file stored under
28802 svn managment (i.e.
28804 \begin_inset Flex Code
28807 \begin_layout Plain Layout
28813 directory is available with your document).
28817 \begin_layout Itemize
28818 Another—a hacking one—possibility is to use svn keywords
28822 \begin_layout Plain Layout
28823 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
28829 In short – you set file keywords property (e.g.
28832 svn propset svn:keywords 'Rev' file.lyx
28834 ) and then paste keyword \SpecialChar TeX
28839 \begin_layout Plain Layout
28840 This is an easy way how to ensure that \SpecialChar LyX
28841 won't break the line in the middle
28847 tag in your document (e.g.
28849 \begin_inset Flex Code
28852 \begin_layout Plain Layout
28859 This way svn client will automatically substitute revision number (e.g.
28861 \begin_inset Flex Code
28864 \begin_layout Plain Layout
28870 ) after each update and commit.
28871 There are more problems with this approach.
28872 Firstly, the '$' character is used in \SpecialChar TeX
28873 world for math equations, so any
28874 occurence of math formula
28875 \begin_inset Formula $Rev$
28879 \begin_inset Formula $Rev:59$
28882 in your \SpecialChar LyX
28884 Similarly for other keywords like Id, Date, Author, etc.
28885 Secondly svn output is dependent on your locales, so its very easy that
28886 svn would produce some problematic strings once Date is used.
28887 Thirdly you get the whole 'Rev: 59' string in your document instead of
28889 Until subversion implements user's custom keywords it will be hard to use
28890 this approach reliably or let \SpecialChar LyX
28891 to support it directly.
28894 \begin_layout Subsection
28895 SVN and Windows Environment
28898 \begin_layout Quote
28899 My inclination is to say that if the user cannot figure out the command
28900 line operations on their own fairly quickly, they would be well advised
28901 to use TortoiseSVN.
28907 \begin_layout Subsubsection
28911 \begin_layout Standard
28912 In addition to installing \SpecialChar LyX
28913 , and having access to a Subversion repository,
28914 the user will need to install the Subversion client program.
28915 A Windows installer for the client program is available from
28916 \begin_inset CommandInset href
28919 target "http://www.collab.net/nonav/downloads/subversion/"
28925 The user may also want to install
28926 \begin_inset CommandInset href
28929 target "http://tortoisesvn.tigris.org/"
28934 , which integrates Subversion operations into the context (rightclick) menu
28935 of Windows Explorer.
28936 Operations done outside \SpecialChar LyX
28937 will typically be more convenient using the Explorer
28939 Note that TortoiseSVN is not a replacement for the client program, which
28940 is what \SpecialChar LyX
28944 \begin_layout Subsubsection
28945 Bringing a document under Subversion control
28948 \begin_layout Standard
28949 Before a \SpecialChar LyX
28950 document can be brought under version control in Subversion, its
28951 parent directory needs to be under version control.
28952 If the document is being added to a project already in the repository,
28953 this is accomplished by checking the project out to the directory where
28954 the new document will be placed.
28955 If the project itself is not yet under version control (for instance, if
28956 this document starts a new project), the directory must be imported into
28958 This is done outside \SpecialChar LyX
28960 Both import and checkout are easily accomplished from the Explorer context
28961 menu using TortoiseSVN, or alternatively can be done using the command
28962 line client at a DOS prompt.
28963 The procedure for importing the project using TortoiseSVN is described
28964 below, assuming an existing repository and a new project being started
28972 For information on using the Subversion client program, run
28979 \begin_layout Enumerate
28986 in Windows Explorer, right click it, and select
28988 TortoiseSVN\SpecialChar menuseparator
28992 If necessary, adjust the URL for the repository, then click OK.
28995 \begin_layout Enumerate
28996 Right click the level of the repository under which you want to place the
28997 new project folder (typically the top level) and click
29001 Supply a name for the project folder and click OK.
29002 Add a message for the log file if desired, then click OK again.
29003 The new project folder should appear in the repository.
29004 Finally, click OK again to exit the repository browser.
29007 \begin_layout Enumerate
29008 Once again right click
29014 , this time selecting SVN Checkout\SpecialChar ldots
29015 Select the URL of the project folder
29016 you just created in the repository, and set the checkout directory to
29024 You will be warned about a non-empty folder; click OK to proceed.
29025 You should now have a
29036 \begin_layout Enumerate
29037 Create or open your document in \SpecialChar LyX
29040 File\SpecialChar menuseparator
29042 \begin_inset space ~
29045 Control\SpecialChar menuseparator
29049 Add a log message and click OK to commit the document to version control.
29052 \begin_layout Standard
29053 From this point onward, you should have full functionality in the
29055 File\SpecialChar menuseparator
29057 \begin_inset space ~
29063 You also have the option of checking the document in and out, viewing its
29065 using the TortoiseSVN context menu in Windows Explorer or the Subversion
29066 client program from a command prompt.
29069 \begin_layout Subsubsection
29070 SSH tunnel used with SVN under Windows
29073 \begin_layout Standard
29074 Compared with Linux setting up an svn client to communicate over ssh under
29075 Windows is a rather troublesome task.
29076 We will at least offer some hints how to setup the client side but prior
29077 knowledge about ssh and the Windows command line is needed, also be prepared
29078 for a great deal of frustration\SpecialChar ldots
29082 \begin_layout Enumerate
29083 Get an svn client for windows, as described in the previous sections.
29084 When it is a fresh install run some svn command (e.g.
29086 \begin_inset Flex Code
29089 \begin_layout Plain Layout
29095 ) to create config files, which you will need to change later on.
29098 \begin_layout Enumerate
29099 Choose an ssh client for Windows.
29100 There are several possibilities, we will use the one from Putty tools
29104 \begin_layout Plain Layout
29105 \begin_inset Flex URL
29108 \begin_layout Plain Layout
29110 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
29121 You will need to set the connection up so that the client doesn't ask for
29122 any password from you.
29123 To keep things easy we will use only keys without any additional password
29128 \begin_layout Enumerate
29130 \begin_inset Flex Code
29133 \begin_layout Plain Layout
29140 Save your private .ppk key file and put the public one on the server side.
29141 If the SVN server runs on Linux, note that the format of the public key
29142 is not compatible with Linux openssh and you will need to direcly copy-paste
29144 \begin_inset Quotes eld
29149 Public key for pasting into OpenSSH authorized_keys file
29152 \begin_inset Quotes erd
29155 edit field into the server's
29156 \begin_inset Flex Code
29159 \begin_layout Plain Layout
29160 ~/.ssh/authorized_keys
29166 \begin_inset Flex Code
29169 \begin_layout Plain Layout
29178 \begin_layout Enumerate
29180 \begin_inset Flex Code
29183 \begin_layout Plain Layout
29190 In the SVN config file
29194 \begin_layout Plain Layout
29195 Exact path depends on Windows version, usually somewhere around
29196 \begin_inset Flex Code
29199 \begin_layout Plain Layout
29202 Documents and Settings
29216 \begin_inset Flex Code
29219 \begin_layout Plain Layout
29234 , section [tunnels], setup ssh command, e.g.
29236 \begin_inset Flex Code
29239 \begin_layout Plain Layout
29240 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
29249 \begin_layout Plain Layout
29250 It will usually take a lot of time to get exact command right and it depends
29252 For example do not have some remote server saved as a default session in
29254 If things fail, try to connect via plink without SVN first.
29263 \begin_layout Enumerate
29264 Checkout the SVN archive, e.
29265 \begin_inset space \thinspace{}
29269 \begin_inset Newline newline
29273 \begin_inset Flex Code
29276 \begin_layout Plain Layout
29277 svn co svn+ssh://user@server/repository_path
29285 \begin_layout Subsubsection
29286 End-of-Line Conversions
29289 \begin_layout Standard
29290 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
29292 use different line endings inside the .lyx files.
29293 This is not a problem as far as \SpecialChar LyX
29294 functionality is concerned, but the commit
29295 diffs will be huge and merge-conflicts prone.
29296 Fortunately SVN itself knows
29300 \begin_layout Plain Layout
29301 \begin_inset Flex URL
29304 \begin_layout Plain Layout
29306 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
29316 how to deal with CR/LF problems when switching .lyx files to the
29317 \begin_inset Flex Code
29320 \begin_layout Plain Layout
29330 \begin_layout Plain Layout
29332 \begin_inset Flex Code
29335 \begin_layout Plain Layout
29336 svn propset svn:eol-style native FILE_NAME
29349 \begin_layout Subsection
29350 GIT commands in \SpecialChar LyX
29354 \begin_layout Standard
29355 A minimal subset of GIT commands is now supported by \SpecialChar LyX
29357 You can find the commands in the
29359 File\SpecialChar menuseparator
29361 \begin_inset space ~
29367 Please note that if you use password protected access to repository via
29368 ssh, you will be asked in terminal window.
29370 was tested against GIT 1.7.
29374 \begin_layout Plain Layout
29375 Windows users please note that you need to ensure that git is on the path.
29376 This can be set from within \SpecialChar LyX
29379 Tools\SpecialChar menuseparator
29380 Preferences\SpecialChar menuseparator
29381 Paths\SpecialChar menuseparator
29392 \begin_layout Standard
29393 One big difference of GIT and the other supported version control systems
29394 is the distributed nature of GIT: With traditional version control systems
29395 there is one central server which hosts the repository.
29396 Users commit their changes to the server, and get updates made by other
29398 With GIT, users commit to a local repository.
29399 The local repository can be synchronized with one or more remote repositories
29401 \begin_inset Flex Code
29404 \begin_layout Plain Layout
29411 \begin_inset Flex Code
29414 \begin_layout Plain Layout
29422 does not interact in any way with remote GIT repositories.
29423 It works exclusively with the local repository in a very similar way as
29424 with a central CVS or SVN repository.
29425 If you use remote GIT repositories you need to do the
29426 \begin_inset Flex Code
29429 \begin_layout Plain Layout
29436 \begin_inset Flex Code
29439 \begin_layout Plain Layout
29445 operations with your favourite GIT client.
29448 \begin_layout Subsubsection
29454 \begin_layout Standard
29455 If your document is not under revision control, this is the only item shown
29457 And if it is under revision control, the
29461 item is not visible.
29464 \begin_layout Standard
29465 This command registers in GIT your document ONLY in case you have already
29466 the documents directory under GIT control (in particular
29471 This means you have to checkout the archive by yourself.
29474 \begin_layout Standard
29475 Then you are asked interactively to supply an initial description of the
29477 Don't forget that registered file is not yet committed.
29480 \begin_layout Standard
29481 GIT command that is run:
29484 \begin_inset Quotes qld
29488 \begin_inset Quotes qld
29494 \begin_layout Standard
29499 to understand the switches.
29502 \begin_layout Subsubsection
29508 \begin_layout Standard
29509 When you are finished editing a file, you commit your changes.
29510 When you do this, you are asked for a description of the changes.
29511 After that changes are committed.
29514 \begin_layout Standard
29517 git commit -q -m"<description>" <file-name>
29520 \begin_layout Subsubsection
29523 Revert To Repository Version
29526 \begin_layout Standard
29527 This will discard all changes made to the document since the last check
29529 You get a warning before changes are discarded.
29532 \begin_layout Standard
29536 \begin_inset Quotes qld
29540 \begin_inset Quotes qld
29546 \begin_layout Subsubsection
29552 \begin_layout Standard
29553 This will rename the current document including the version history.
29554 It requires a clean document without any changes since the last checkin.
29555 You are asked for a file name and a description of the rename operation.
29556 After that the document is renamed, both locally and in the repository.
29557 If the parent directories of the new and old file names differ, all relative
29558 paths of included files are adjusted (like in
29560 File\SpecialChar menuseparator
29565 Finally, the document is reloaded using the new name.
29568 \begin_layout Labeling
29569 \labelwidthstring 00.00.0000
29571 \begin_inset space ~
29575 \begin_inset space ~
29579 \begin_inset Newline newline
29583 \begin_inset Flex Code
29586 \begin_layout Plain Layout
29590 \begin_inset Quotes qld
29594 \begin_inset Quotes qld
29598 \begin_inset Quotes qld
29602 \begin_inset Quotes qld
29611 \begin_inset Newline newline
29615 \begin_inset Flex Code
29618 \begin_layout Plain Layout
29627 \begin_layout Subsubsection
29633 \begin_layout Standard
29634 This shows the complete history of the GIT document.
29638 \begin_inset Quotes qld
29642 \begin_inset Quotes qld
29647 is shown in a browser.
29650 \begin_layout Subsubsection
29654 \begin_layout Standard
29656 supports GIT hash number of the last commit to the file,
29657 \change_inserted 1119979965 1564297456
29658 its abbreviated form,
29660 author name, date and time of last commit.
29661 All those are extracted from
29663 git log -n 1 --pretty=format:%H%n
29664 \change_inserted 1119979965 1564297427
29670 Tree version information is obtained via
29672 git describe --abbrev --dirty --long
29676 \begin_inset CommandInset ref
29678 reference "subsec:VCS-Revision-Information"
29685 \begin_layout Subsection
29689 \begin_layout Standard
29690 With the recent addition of the
29691 \begin_inset Flex Code
29694 \begin_layout Plain Layout
29700 function \SpecialChar LyX
29701 power users are allowed to create their own commands for revision
29705 \begin_layout Standard
29706 As an example you can see how two TortoiseSVN commands could be integrated
29710 \begin_layout Description
29712 \begin_inset Flex Code
29715 \begin_layout Plain Layout
29716 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
29724 \begin_layout Description
29726 \begin_inset Flex Code
29729 \begin_layout Plain Layout
29730 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
29738 \begin_layout Subsection
29739 Version control and Document comparison
29742 \begin_layout Standard
29743 One of the typical uses of version control is to inspect the changes between
29744 revisions, usually by creating
29745 \begin_inset Flex Code
29748 \begin_layout Plain Layout
29755 While this is useful for plain text files, it is much less useful in the
29756 case of \SpecialChar LyX
29757 files, which have more a complicated structure.
29758 Hence we provide binding to the Document comparison feature.
29759 There are two ways of calling this feature – either by direct call of
29760 \begin_inset Flex Code
29763 \begin_layout Plain Layout
29770 function (for details see \SpecialChar LyX
29771 functions manual) or by the toolbar icon
29784 One can either compare two chosen revisions of the document or he can simply
29785 compare the current version of edited text with older revisions (where
29787 \begin_inset Flex Noun
29790 \begin_layout Plain Layout
29796 ' revisions back means comparison of the edited file with last commited
29801 \begin_layout Standard
29802 This feature is supported for SVN and RCS though due to the more complicated
29803 versioning scheme of RCS there is a constraint – when addressing the revisions
29804 in dialog, numbers always point to the last number in RCS revision number,
29807 We don't currently support GIT addressing of revisions, one can just compare
29808 edited document with its revision X steps backs, where X is addressed as
29810 \begin_inset Flex Code
29813 \begin_layout Plain Layout
29822 \begin_layout Section
29823 Literate Programming
29826 \begin_layout Standard
29831 (kayvan@sylvan.com)
29835 original documentation written by
29837 Edmar Wienskoski Jr.
29840 (edmar-w-jr@technologist.com)
29843 \begin_layout Subsection
29847 \begin_layout Standard
29848 The main purpose of this documentation is to show you how to use \SpecialChar LyX
29850 programming, where it is assumed that you are familiar with this programming
29851 technique, and know what
29852 \begin_inset Quotes eld
29856 \begin_inset Quotes erd
29860 \begin_inset Quotes eld
29864 \begin_inset Quotes erd
29868 If that is not the case, please follow the web links provided in the following
29870 There is a lot of good documentation out there covering old development
29871 history to the latest tools tips.
29874 \begin_layout Standard
29875 It is also assumed that you are familiar with \SpecialChar LyX
29876 itself to a point that you
29877 are comfortable changing your \SpecialChar LyX
29878 preferences, and X resources file.
29879 If that is not the case please refer to other \SpecialChar LyX
29880 documentation to cover your
29884 \begin_layout Subsection
29885 Literate Programming
29888 \begin_layout Standard
29889 From the Literate Programming FAQ:
29892 \begin_layout Quotation
29893 Literate programming is the combination of documentation and source together
29894 in a fashion suited for reading by human beings.
29895 In fact, literate programs should be enjoyable reading, even inviting!
29896 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
29897 and documentation in a single file.
29898 Literate programming tools then parse the file to produce either readable
29899 documentation or compilable source.
29900 The WEB style of literate programming was created by D.
29901 \begin_inset space \thinspace{}
29905 Knuth during the development of his \SpecialChar TeX
29906 typesetting software.
29910 \begin_layout Standard
29911 Another excerpt says:
29914 \begin_layout Quotation
29917 How is literate programming different from verbose commenting?
29920 \begin_layout Quotation
29921 There are three distinguishing characteristics.
29922 In order of importance, they are:
29926 \begin_layout Itemize
29927 flexible order of elaboration
29930 \begin_layout Itemize
29931 automatic support for browsing
29934 \begin_layout Itemize
29935 typeset documentation, especially diagrams and mathematics
29939 \begin_layout Standard
29940 Now that I sparked your curiosity, take a look in the references.
29943 \begin_layout Subsubsection
29947 \begin_layout Standard
29948 The complete Literate Programming FAQ can be found at:
29951 \begin_layout Quote
29952 Literate Programming FAQ
29953 \begin_inset Flex URL
29956 \begin_layout Plain Layout
29958 http://www.literateprogramming.com/lpfaq.pdf
29966 \begin_layout Standard
29967 The FAQ lists 23 (twenty three!) different literate programming tools.
29968 Where some are specialized or
29969 \begin_inset Quotes eld
29973 \begin_inset Quotes erd
29976 for particular programming languages, while other have general scope.
29981 for my own use for several reasons:
29984 \begin_layout Itemize
29985 It can generate the documentation either in \SpecialChar LaTeX
29989 \begin_layout Itemize
29990 It has a open architecture, i.
29991 \begin_inset space \thinspace{}
29995 \begin_inset space \space{}
29998 it is easy to plug in new filters
30002 \begin_layout Plain Layout
30007 are programs that read a given data stream and output a manipulated data
30009 That way, a WEB file (consisting of literate code) can be turned into a
30010 file consisting only of C program code or \SpecialChar LaTeX
30016 and to perform special processing that you may need.
30020 \begin_layout Itemize
30021 There is a good selection of filters available already (the HTML is one
30025 \begin_layout Itemize
30029 \begin_layout Standard
30030 The Noweb web page can be found at:
30033 \begin_layout Quote
30035 \begin_inset Flex URL
30038 \begin_layout Plain Layout
30040 https://www.cs.tufts.edu/~nr/noweb/
30048 \begin_layout Standard
30049 Starting from there you can reach many other interesting links and even
30050 some literate program examples.
30053 \begin_layout Subsection
30055 and Literate Programming with Noweb
30058 \begin_layout Standard
30059 The \SpecialChar LyX
30060 support for Literate Programming is provided by using the generic \SpecialChar LyX
30062 converters mechanism.
30063 This support is provided in a
30064 \begin_inset Quotes eld
30068 \begin_inset Quotes erd
30072 \begin_inset space \thinspace{}
30076 \begin_inset space \space{}
30079 you will be able to use this new \SpecialChar LyX
30080 feature with some other literate programming
30081 tool of your choice by just changing your \SpecialChar LyX
30085 \begin_layout Subsubsection
30086 Generating documents and code (weaving and tangling)
30089 \begin_layout Paragraph
30090 Using the noweb module
30093 \begin_layout Standard
30094 If you have installed Noweb and \SpecialChar LyX
30095 successfully, whenever you open a new document,
30096 after you have chosen its document class, use the
30098 Document\SpecialChar menuseparator
30102 \begin_inset Quotes eld
30106 \begin_inset Quotes erd
30110 If Noweb is correctly installed, when you click on the
30111 \begin_inset Quotes eld
30115 \begin_inset Quotes erd
30118 link, you will see the
30119 \begin_inset Quotes eld
30123 \begin_inset Quotes erd
30126 module in the available list and you can add it to your document.
30129 \begin_layout Paragraph
30133 \begin_layout Standard
30135 enables you to write code with a custom inset named
30136 \begin_inset Flex Noun
30139 \begin_layout Plain Layout
30146 Noweb delimits chunks like this:
30149 \begin_layout LyX-Code
30153 \begin_layout LyX-Code
30157 \begin_layout LyX-Code
30161 \begin_layout LyX-Code
30165 \begin_layout LyX-Code
30169 \begin_layout Standard
30170 The problem is that whatever is written in between the << and the
30174 must be taken literally, i.
30175 \begin_inset space \thinspace{}
30179 \begin_inset space \space{}
30183 should be prevented from making any special interpretation of what has
30185 This is also handled by
30186 \begin_inset Flex Noun
30189 \begin_layout Plain Layout
30195 , that works like a normal text inset but has a free spacing capability.
30198 \begin_layout Standard
30199 As a special note, you can also use the
30200 \begin_inset Quotes eld
30204 \begin_inset Quotes erd
30207 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
30211 \begin_layout LyX-Code
30215 \begin_layout LyX-Code
30216 def some_function(args):
30219 \begin_layout LyX-Code
30220 "This is the doc string for this function."
30223 \begin_layout LyX-Code
30224 print "My args: ", args
30227 \begin_layout LyX-Code
30228 @ %def some_function
30231 \begin_layout Standard
30232 For an example of this usage and the resulting cross-reference output, look
30233 at the Literate python program in
30235 LIBDIR/examples/listerrors.lyx
30237 which should make this all clear.
30240 \begin_layout Paragraph
30241 Generating the documentation
30244 \begin_layout Standard
30245 At this point you already have a new document file with a proper document
30246 class, and with some code and text on it.
30247 How do I print it? The answer is simple, you select
30249 View\SpecialChar menuseparator
30253 Just like you would do for a plain document.
30254 No special procedure is required.
30257 \begin_layout Standard
30258 To help orientate you, I will now explain what happens inside \SpecialChar LyX
30262 \begin_layout Enumerate
30265 Update\SpecialChar menuseparator
30268 menu option is chosen, a \SpecialChar LaTeX
30274 \begin_layout Standard
30275 If the document is of any literate class the generated file will be named
30276 with an extension name defined by the
30277 \begin_inset Quotes eld
30281 \begin_inset Quotes erd
30284 format (defined in the Preferences panel), otherwise the file will have
30293 \begin_layout Enumerate
30294 Note that the only difference so far is in the name of the file, no special
30295 processing is required by \SpecialChar LyX
30297 Given that you formatted the code using the
30298 \begin_inset Flex Noun
30301 \begin_layout Plain Layout
30307 inset that, by itself, takes care of the business.
30310 \begin_layout Enumerate
30311 If the document is of any literate class \SpecialChar LyX
30312 will then use the internal \SpecialChar LyX
30314 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
30319 \begin_layout Plain Layout
30320 The converters are defined in the
30322 Tools\SpecialChar menuseparator
30326 \begin_inset Quotes eld
30330 \begin_inset Quotes erd
30342 manual for general information about converters.
30347 to generate the \SpecialChar LaTeX
30352 \begin_layout Standard
30353 Otherwise it will just skip this step.
30357 \begin_layout Enumerate
30358 Finally, \SpecialChar LaTeX
30359 is invoked and the regular post processing continues as in a plain
30363 \begin_layout Standard
30364 Independence from a particular
30365 \begin_inset Quotes eld
30369 \begin_inset Quotes erd
30372 is easily achieved by changing the commands that are run by the various
30376 \begin_layout Paragraph
30377 Generating the code
30380 \begin_layout Standard
30381 When the build menu option is chosen or the corresponding button in the
30382 toolbar is pressed, a \SpecialChar LaTeX
30383 file is generated just like step 1 above.
30384 Next, \SpecialChar LyX
30390 This converter needs to be defined by the user and is not installed by
30391 default, though the Program format is.
30392 This converter (like any other converter) will have two parts:
30395 \begin_layout Enumerate
30396 The converter program itself.
30397 This program performs the conversion from the one format to the other (in
30398 this case, from the Noweb format to the Program pseudo-format).
30401 \begin_layout Enumerate
30402 The error log parser.
30403 This is a program whose sole purpose is to rewrite error messages in a
30404 format that \SpecialChar LyX
30406 This makes it possible for \SpecialChar LyX
30407 to place error boxes in the right places in
30411 \begin_layout Standard
30412 The first part, the
30413 \begin_inset Quotes eld
30417 \begin_inset Quotes erd
30420 setting, should be set to
30423 \begin_layout LyX-Code
30431 \begin_layout Standard
30432 This basically means that \SpecialChar LyX
30434 \begin_inset Quotes eld
30438 \begin_inset Quotes erd
30441 (a program or script) with the name of the Noweb file (normally a file
30442 in the \SpecialChar LyX
30443 temp directory) and the directory path of the original \SpecialChar LyX
30448 \begin_layout Standard
30449 This is an implementation of
30450 \begin_inset Quotes eld
30454 \begin_inset Quotes erd
30457 that you can place in a directory on your path:
30460 \begin_layout LyX-Code
30466 \begin_layout LyX-Code
30472 \begin_layout LyX-Code
30475 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
30478 \begin_layout Standard
30479 The next part of the converter setting is the
30480 \begin_inset Quotes eld
30484 \begin_inset Quotes erd
30487 which is to be set to
30490 \begin_layout LyX-Code
30493 parselog=$$s/scripts/listerrors
30496 \begin_layout Standard
30497 This will run any errors that are generated by the
30498 \begin_inset Quotes eld
30502 \begin_inset Quotes erd
30505 process through the
30506 \begin_inset Quotes eld
30510 \begin_inset Quotes erd
30516 \begin_layout Standard
30517 The build will normally take place in \SpecialChar LyX
30518 's temporary directory, so the files
30519 produced by the conversion will be in that directory.
30521 will copy out what it regards as the `main' file, but the
30525 conversion may produce several files, and so most of these would then be
30526 deleted when \SpecialChar LyX
30528 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
30529 the build-script chunk can place the generated files in that location.
30532 \begin_layout Paragraph
30533 Build instructions in the document
30536 \begin_layout Standard
30537 The last piece of the integration between \SpecialChar LyX
30539 \begin_inset Quotes eld
30543 \begin_inset Quotes erd
30547 Generally, the instructions for building your program should be embedded
30548 in a chunk of its own.
30550 \begin_inset Quotes eld
30554 \begin_inset Quotes erd
30557 above uses the notangle command to look for this chunk (called
30558 \begin_inset Quotes eld
30562 \begin_inset Quotes erd
30565 ) and runs its contents through
30566 \begin_inset Quotes eld
30570 \begin_inset Quotes erd
30576 \begin_layout Standard
30577 Typically, such a chunk would look something like this:
30580 \begin_layout LyX-Code
30584 \begin_layout LyX-Code
30586 \begin_inset Newline newline
30589 if [ -z "${NOWEB_SOURCE}" ]
30590 \begin_inset Newline newline
30596 \begin_layout LyX-Code
30597 NOWEB_SOURCE=myfile.nw
30598 \begin_inset Newline newline
30602 \begin_inset Newline newline
30606 code to extract files ...
30607 use NOWEB_OUTPUT_DIR here ...]
30608 \begin_inset Newline newline
30612 code to compile files ...]
30613 \begin_inset Newline newline
30619 \begin_layout Standard
30622 LIBDIR/examples/listerrors.lyx
30626 LIBDIR/examples/Literate.lyx
30628 which implement two versions of the
30629 \begin_inset Quotes eld
30633 \begin_inset Quotes erd
30636 program for some illustrations of how all of these pieces go together or
30639 LIBDIR/examples/noweb2lyx.lyx.
30642 Interestingly, these three files show off the language-indepence of the
30644 literate programming support since they are written in Python, C and Perl
30648 \begin_layout Subsubsection
30649 Configuring \SpecialChar LyX
30653 \begin_layout Standard
30654 All the Literate Programming support is configured by the
30656 Tools\SpecialChar menuseparator
30660 \begin_inset Quotes eld
30664 \begin_inset Quotes erd
30668 The important parts are:
30671 \begin_layout Description
30673 \begin_inset space ~
30677 \begin_inset Quotes eld
30681 \begin_inset Quotes erd
30685 \begin_inset space ~
30688 format Set up via the File Formats tab, this is where the Noweb-specific
30698 , the file extension is set to
30703 This tells \SpecialChar LyX
30704 to create a file with a
30708 extension in the first step of the conversion process.
30711 \begin_layout Description
30713 \begin_inset space ~
30721 \begin_inset space ~
30724 format This is an empty format whose sole purpose is to be the endpoint
30725 of a conversion (which then allows us to set up a converter for it).
30728 \begin_layout Description
30738 This converter performs the
30739 \begin_inset Quotes eld
30743 \begin_inset Quotes erd
30746 of the literate document.
30747 For Noweb, it is set to
30748 \begin_inset Quotes eld
30753 noweave -delay -index $$i > $$o
30756 \begin_inset Quotes erd
30762 \begin_layout Description
30772 \begin_inset Quotes eld
30776 \begin_inset Quotes erd
30780 As stated above, the Converter is set to
30781 \begin_inset Quotes eld
30789 \begin_inset Quotes erd
30792 , with Flags set to
30793 \begin_inset Newline newline
30797 \begin_inset Quotes eld
30802 parselog=$$s/scripts/listerrors
30805 \begin_inset Quotes erd
30811 \begin_layout Subsubsection
30815 \begin_layout Standard
30816 There is also a new function implemented in the \SpecialChar LyX
30818 \begin_inset Quotes eld
30821 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
30825 \begin_layout Standard
30826 When debugging code with ddd/gdb, it is possible to invoke a text editor
30827 at the current execution position with a single key stroke.
30828 The default ddd configuration for that is shift-ctrl-V.
30829 It happens that you can define the editor command line invocation in ddd
30832 Edit\SpecialChar menuseparator
30833 Preferences\SpecialChar menuseparator
30836 dialog and changing the "Edit Sources" entry.
30839 \begin_layout Standard
30840 I take advantage of the newly created \SpecialChar LyX
30841 server function and this ddd feature,
30843 \begin_inset Quotes eld
30847 \begin_inset Quotes erd
30853 \begin_layout LyX-Code
30854 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
30857 \begin_layout Standard
30858 With this, whenever you are using ddd and find a point in the program that
30859 you want to edit, you just press shift-ctrl-V (in the ddd window), and
30860 ddd will forward this information to \SpecialChar LyX
30861 through the \SpecialChar LyX
30862 server and then the
30864 window will show the same file with the cursor at the same position ddd
30866 No more guessing or long scrolling to locate a point in the program back
30870 \begin_layout Standard
30871 Note however that you must enable the \SpecialChar LyX
30872 server to get this feature working
30873 (it is disabled by default).
30875 \begin_inset space ~
30879 \begin_inset CommandInset ref
30881 reference "sec:Starting-the-Server"
30885 explains how to do that.
30888 \begin_layout Subsubsection
30892 \begin_layout Standard
30893 There are six new buttons that can be added to your \SpecialChar LyX
30895 Four of these buttons are short cuts to layout styles:
30913 , one for the custom inset
30918 The last one is a short cut to the
30919 \begin_inset Quotes eld
30923 \begin_inset Quotes erd
30930 \begin_layout Standard
30932 has a range of buttons that are available for tool bar customization.
30933 In my toolbar I like to combine the six short cuts above with two more:
30938 \SpecialChar menuseparator
30943 \SpecialChar menuseparator
30950 Document\SpecialChar menuseparator
30951 View\SpecialChar menuseparator
30955 Here is how it looks like:
30958 \begin_layout LyX-Code
30962 \begin_layout LyX-Code
30966 \begin_layout LyX-Code
30967 Icon "layout Standard"
30970 \begin_layout LyX-Code
30971 Icon "layout Section"
30974 \begin_layout LyX-Code
30975 Icon "layout \SpecialChar LaTeX
30979 \begin_layout LyX-Code
30980 Icon "layout \SpecialChar LyX
30984 \begin_layout LyX-Code
30985 Icon "flex.insert Chunk"
30988 \begin_layout LyX-Code
30992 \begin_layout LyX-Code
30996 \begin_layout LyX-Code
30997 Icon "buffer-typeset"
31000 \begin_layout LyX-Code
31001 Icon "build-program"
31004 \begin_layout LyX-Code
31008 \begin_layout LyX-Code
31012 \begin_layout LyX-Code
31016 \begin_layout LyX-Code
31020 \begin_layout LyX-Code
31024 \begin_layout Subsubsection
31025 Colors customization
31028 \begin_layout Standard
31029 There are a number of colors in \SpecialChar LyX
31030 that can be customized in
31035 One of the things that bothers people is the \SpecialChar LaTeX
31037 The default color is red, since the chunks uses \SpecialChar LaTeX
31038 font, and there is a lot
31039 of chunks in literate documents, you may get tired of seeing everything
31041 You can change it by going to the tabs
31050 \begin_layout Standard
31051 The next thing is the visible presence of the newline character in the screen.
31052 You can choose the color of this particular character and make it blend
31054 I recommend you choosing a color that is close to the background but not
31055 equal, that way you still can see it is there, but it is not bothering
31059 \begin_layout Subsection
31064 \begin_layout Standard
31074 \change_deleted 564990737 1671643409
31080 \change_inserted 564990737 1671643443
31084 File\SpecialChar menuseparator
31085 Open Example\SpecialChar menuseparator
31086 Modules\SpecialChar menuseparator
31093 \change_deleted 564990737 1671643461
31094 the Sweave manual (menu
31096 Help\SpecialChar menuseparator
31100 \change_inserted 564990737 1671643461
31104 Help\SpecialChar menuseparator
31105 Specific Manuals\SpecialChar menuseparator
31114 \begin_layout Chapter
31116 \change_deleted 564990737 1671355343
31120 \begin_layout Standard
31122 \change_deleted 564990737 1671355343
31123 You can do everything with \SpecialChar LyX
31124 that you can do with \SpecialChar LaTeX
31126 However, \SpecialChar LyX
31127 cannot support every \SpecialChar LaTeX
31129 But you can always use \SpecialChar TeX
31131 This chapter shows you some more special things you might want to use.
31132 For other special things you can do with figures, tables, floats, boxes
31133 and notes, have a look at the
31136 \begin_inset space ~