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
40 \maintain_unincluded_children no
42 \language_package default
45 \font_roman "lmodern" "default"
46 \font_sans "lmss" "default"
47 \font_typewriter "lmtt" "default"
48 \font_math "auto" "auto"
49 \font_default_family default
50 \use_non_tex_fonts false
54 \font_typewriter_osf false
55 \font_sf_scale 100 100
56 \font_tt_scale 100 100
58 \use_dash_ligatures true
60 \default_output_format pdf2
62 \bibtex_command default
63 \index_command default
67 \pdf_title "LyX's Additional Features manual"
68 \pdf_author "LyX Team"
69 \pdf_subject "LyX's additional features documentation"
70 \pdf_keywords "LyX, Documentation, Additional"
72 \pdf_bookmarksnumbered true
73 \pdf_bookmarksopen false
74 \pdf_bookmarksopenlevel 1
79 \pdf_pdfusetitle false
80 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
83 \use_package amsmath 1
84 \use_package amssymb 1
87 \use_package mathdots 1
88 \use_package mathtools 1
90 \use_package stackrel 1
91 \use_package stmaryrd 1
92 \use_package undertilde 1
94 \cite_engine_type default
98 \paperorientation portrait
104 \notefontcolor #0000ff
111 \paragraph_separation indent
112 \paragraph_indentation default
114 \math_indentation default
115 \math_numbering_side default
116 \quotes_style english
120 \paperpagestyle headings
122 \tracking_changes true
123 \output_changes false
125 \postpone_fragile_content false
129 \docbook_table_output 0
130 \docbook_mathml_prefix 1
131 \author -712698321 "Jürgen Spitzmüller"
134 \author 244031559 "Yuriy"
135 \author 564990737 "John Lyx"
136 \author 630872221 "Jean-Pierre Chrétien" jeanpierre.chretien@free.fr
137 \author 1075283030 "Thibaut"
138 \author 1119979965 "Joel A. Kulesza"
144 Additional \SpecialChar LyX
148 \begin_layout Subtitle
150 \change_deleted 630872221 1622909155
152 \change_inserted 630872221 1622909155
159 by the \SpecialChar LyX
164 \begin_layout Plain Layout
166 Principal maintainer of this file is
168 Richard Kimberly Heck
171 If you have comments or error corrections, please send them to the \SpecialChar LyX
174 \begin_inset Flex Code
177 \begin_layout Plain Layout
178 <lyx-docs@lists.lyx.org>
191 \begin_layout Standard
192 \begin_inset CommandInset toc
193 LatexCommand tableofcontents
200 \begin_layout Chapter
204 \begin_layout Standard
205 This manual is essentially Part II of the
207 User's Guide\SpecialChar endofsentence
210 The reason for separating the two documents is simple: the
214 is already quite lengthy, and it contains information on all of the basic
215 features one needs to know in order to prepare most documents.
216 However, the \SpecialChar LyX
217 Team has worked to make \SpecialChar LyX
218 extensible through various configuration
219 files and external packages.
220 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
222 create a layout file (or module) for it without having to alter \SpecialChar LyX
224 We've already had contributions of several new features this way, and some
225 of them are documented here.
226 There are also some more `advanced' features, such as how to control the
227 presentation of bibliographies and how to work with multi-part documents,
228 that are not covered in the
232 and are discussed here.
235 \begin_layout Standard
236 This manual also documents some special features, like fax support
237 \change_deleted 244031559 1603802929
239 \change_inserted 244031559 1603802931
243 \change_deleted 244031559 1603802954
246 , which require additional software to work properly.
247 There is also a chapter on \SpecialChar LyX
249 And lastly, there's a chapter of \SpecialChar LaTeX
250 tools and tips, things you can use to
251 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
253 After all, \SpecialChar LyX
258 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
262 \begin_layout Standard
263 If you haven't read the
267 yet, you are definitely in the wrong manual.
272 is the first place to go, since it describes the notation and format of
274 You should also be thoroughly familiar with the
278 and all of the basic features of \SpecialChar LyX
279 before attempting to read this one.
282 \begin_layout Standard
283 Since many of the topics in this manual depend heavily on \SpecialChar LyX
285 with \SpecialChar LaTeX
286 , this first chapter covers the inner workings of \SpecialChar LyX
289 to generate exactly the \SpecialChar LaTeX
291 It is obviously for more seasoned \SpecialChar LyX
295 \begin_layout Chapter
297 and \SpecialChar LaTeX
301 \begin_layout Section
303 Uses \SpecialChar LaTeX
307 \begin_layout Standard
308 This chapter is for both \SpecialChar TeX
309 -nicians and the \SpecialChar LaTeX
311 In it, we'll explain how \SpecialChar LyX
312 and \SpecialChar LaTeX
313 work together to produce printable output.
314 This is the only place in any of the manuals where we assume you know something
315 about \SpecialChar LaTeX
319 \begin_layout Standard
320 At one time, \SpecialChar LyX
322 \begin_inset Quotes eld
325 WYSIWYM frontend to \SpecialChar LaTeX
327 \begin_inset Quotes erd
330 but that's no longer true.
331 There are frontends to \SpecialChar LaTeX
336 \begin_layout Plain Layout
337 Some familar ones are \SpecialChar TeX
338 maker and kile, on Linux, and \SpecialChar TeX
340 There are also the \SpecialChar LaTeX
341 modes for vi and emacs, of course.
346 These are basically text editors with the ability to run \SpecialChar LaTeX
348 errors in the file you're editing.
349 Although \SpecialChar LyX
358 run \SpecialChar LaTeX
359 , and it also indicates errors in the file, it also does much, much
361 For one thing, you don't need to know \SpecialChar LaTeX
362 to use \SpecialChar LyX
365 has added its own extensions to \SpecialChar LaTeX
367 Try the following sometime: select
368 \begin_inset Flex Noun
371 \begin_layout Plain Layout
372 Export\SpecialChar menuseparator
379 \begin_inset Flex Noun
382 \begin_layout Plain Layout
389 \begin_inset Flex Noun
392 \begin_layout Plain Layout
393 View\SpecialChar menuseparator
403 ), then look at the preamble of the resulting
404 \begin_inset Flex Code
407 \begin_layout Plain Layout
414 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
416 These macros are defined automatically, according to the features you use
420 \begin_layout Standard
421 There are several commands that automatically invoke \SpecialChar LaTeX
426 \begin_layout Itemize
427 \begin_inset Flex Noun
430 \begin_layout Plain Layout
431 Document\SpecialChar menuseparator
440 \begin_layout Itemize
441 \begin_inset Flex Noun
444 \begin_layout Plain Layout
445 Document\SpecialChar menuseparator
454 \begin_layout Standard
455 They will only invoke \SpecialChar LaTeX
456 if the file has changed since the last time \SpecialChar LaTeX
462 \begin_layout Standard
463 When \SpecialChar LyX
464 runs \SpecialChar LaTeX
465 on the file you're editing, it performs these steps:
468 \begin_layout Enumerate
469 Convert the document to \SpecialChar LaTeX
470 and save to a file with the extension
471 \begin_inset Flex Code
474 \begin_layout Plain Layout
481 \begin_inset Flex Code
484 \begin_layout Plain Layout
493 \begin_layout Enumerate
494 Run \SpecialChar LaTeX
496 \begin_inset Flex Code
499 \begin_layout Plain Layout
505 file (maybe several times), and run any other commands (such as
506 \begin_inset Flex Code
509 \begin_layout Plain Layout
516 \begin_inset Flex Code
519 \begin_layout Plain Layout
525 ) needed to compile the \SpecialChar LaTeX
529 \begin_layout Enumerate
530 If there are any errors, show the error log.
533 \begin_layout Standard
534 If you have run \SpecialChar LaTeX
536 \begin_inset Flex Noun
539 \begin_layout Plain Layout
540 View\SpecialChar menuseparator
547 then runs a DVI viewer to display the DVI-file.
549 \begin_inset Flex Noun
552 \begin_layout Plain Layout
553 View\SpecialChar menuseparator
560 performs further steps:
563 \begin_layout Enumerate
565 \begin_inset Flex Code
568 \begin_layout Plain Layout
574 to convert the DVI file to PostScript.
577 \begin_layout Enumerate
578 Run a PostScript viewer, such as
579 \begin_inset Flex Code
582 \begin_layout Plain Layout
588 , to display the PostScript file.
591 \begin_layout Standard
593 does similar things when viewing, or exporting, other formats.
596 \begin_layout Section
597 Translating \SpecialChar LaTeX
598 files into \SpecialChar LyX
602 \begin_layout Standard
603 You can import a \SpecialChar LaTeX
604 file into \SpecialChar LyX
606 \begin_inset Flex Noun
609 \begin_layout Plain Layout
610 File\SpecialChar menuseparator
611 Import\SpecialChar menuseparator
617 command in \SpecialChar LyX
619 This will call a program named
620 \begin_inset Flex Code
623 \begin_layout Plain Layout
629 which will create a file
630 \begin_inset Flex Code
633 \begin_layout Plain Layout
640 \begin_inset Flex Code
643 \begin_layout Plain Layout
651 will then open that file.
655 \begin_layout Plain Layout
656 \begin_inset Flex Code
659 \begin_layout Plain Layout
665 can also be run from the command line, of course.
673 \begin_layout Standard
674 \begin_inset Flex Code
677 \begin_layout Plain Layout
683 will translate most legal \SpecialChar LaTeX
684 , but not everything.
685 It will put things it doesn't understand into \SpecialChar TeX
686 code, so after translating
688 \begin_inset Flex Code
691 \begin_layout Plain Layout
697 , you can look for \SpecialChar TeX
698 code and hand-edit it until it looks right.
701 \begin_layout Standard
702 If you don't know what \SpecialChar TeX
703 code is, read the next section.
706 \begin_layout Section
707 \begin_inset CommandInset label
709 name "sec:Inserting-TeX-Code"
713 Inserting \SpecialChar TeX
714 Code into \SpecialChar LyX
718 \begin_layout Standard
719 Anything you can do in \SpecialChar LaTeX
720 you can do in \SpecialChar LyX
721 , for a very simple reason: You can
722 always insert \SpecialChar TeX
723 code into any \SpecialChar LyX
726 cannot, and will never be able to, display every possible \SpecialChar LaTeX
728 If ever you need to insert \SpecialChar LaTeX
729 commands into your \SpecialChar LyX
730 document, you can use the
732 \begin_inset Flex Code
735 \begin_layout Plain Layout
742 box, which you can insert into your document with
743 \begin_inset Flex Noun
746 \begin_layout Plain Layout
747 Insert\SpecialChar menuseparator
757 or the keyboard shortcut
766 \begin_layout Standard
767 Here's an example of inserting \SpecialChar LaTeX
768 commands in a \SpecialChar LyX
770 The code looks like this:
773 \begin_layout LyX-Code
777 \begin_inset Newline newline
783 \begin_inset Newline newline
786 This is an example of a minipage environment.
788 \begin_inset Newline newline
791 can put nearly everything in it, even (non-floating)
792 \begin_inset Newline newline
797 \begin_inset Newline newline
803 \begin_inset Newline newline
807 \begin_inset Newline newline
813 \begin_inset Newline newline
819 \begin_inset Newline newline
825 \begin_inset Newline newline
830 \begin_inset Newline newline
836 \begin_inset Newline newline
842 \begin_inset Newline newline
848 \begin_inset Newline newline
856 \begin_layout LyX-Code
860 \begin_layout Standard
862 \begin_inset Flex Code
865 \begin_layout Plain Layout
872 box containing this text is directly after this paragraph.
873 Those of you reading the manual in \SpecialChar LyX
874 will only see the \SpecialChar TeX
876 Those reading a printed version of the manuals will see the actual results:
877 \begin_inset VSpace bigskip
883 \begin_layout Standard
887 \begin_layout Plain Layout
894 \begin_layout Plain Layout
901 \begin_layout Plain Layout
903 This is an example of a minipage environment.
904 You can put nearly everything in it, even (non-floating) figures and tables.
908 \begin_layout Plain Layout
915 \begin_layout Plain Layout
920 \begin_layout Plain Layout
927 \begin_layout Plain Layout
934 \begin_layout Plain Layout
941 \begin_layout Plain Layout
947 \begin_layout Plain Layout
954 \begin_layout Plain Layout
961 \begin_layout Plain Layout
968 \begin_layout Plain Layout
978 \begin_inset VSpace bigskip
984 \begin_layout Standard
985 In addition to using \SpecialChar TeX
986 code, you can also create a separate file containing
987 some complex \SpecialChar LaTeX
988 structure and then use
989 \begin_inset Flex Noun
992 \begin_layout Plain Layout
993 Insert\SpecialChar menuseparator
1003 to include your file (you should select the type
1004 \begin_inset Flex Code
1007 \begin_layout Plain Layout
1014 We recommend that you only do this if you have a
1015 \begin_inset Flex Code
1018 \begin_layout Plain Layout
1029 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1033 \begin_layout Standard
1034 There are a few last points to emphasize:
1037 \begin_layout Itemize
1043 check if your \SpecialChar LaTeX
1047 \begin_layout Itemize
1048 Beware of reinventing the wheel.
1051 \begin_layout Standard
1052 On that last point, \SpecialChar LyX
1053 does have quite a few features tucked into it, and
1055 Be sure to check the manuals to make sure that \SpecialChar LyX
1056 doesn't have such-and-such
1057 feature before you decide you have to do it by hand.
1058 Moreover, there are numerous \SpecialChar LaTeX
1059 packages out there to do all sorts of things,
1060 from labels to envelopes to fancy multipage tables.
1062 \change_inserted 244031559 1603815732
1064 \begin_inset CommandInset href
1067 target "https://www.ctan.org/"
1073 \change_deleted 244031559 1603815732
1075 \begin_inset CommandInset href
1078 target "http://www.ctan.org/"
1088 \begin_layout Standard
1089 If you do need to do some wild and fancy things within your document, be
1090 sure to check out a good \SpecialChar LaTeX
1091 book for assistance.
1092 There are a number of them listed in the bibliography of the
1099 \begin_layout Section
1101 and the \SpecialChar LaTeX
1105 \begin_layout Subsection
1106 About the \SpecialChar LaTeX
1110 \begin_layout Standard
1111 If you already know \SpecialChar LaTeX
1112 , there is no need to explain here what the preamble
1114 If you don't, the following will give you some ideas—we recommend again
1115 that you consult a \SpecialChar LaTeX
1116 book for further information.
1117 In any case, you should read the points below, because they explain what
1118 you can do and what you don't need to do in the \SpecialChar LaTeX
1119 preamble of a \SpecialChar LyX
1123 \begin_layout Standard
1124 The \SpecialChar LaTeX
1125 preamble comes at the very beginning of a document,
1133 \begin_layout Itemize
1134 Declare the document class.
1136 \begin_inset Newline newline
1140 already does this for you.
1141 If you're a seasoned \SpecialChar LaTeX
1142 -nician, and you have a custom document class you
1143 want to use, check out the
1145 Customization Manual
1147 for information on how to make \SpecialChar LyX
1151 \begin_layout Itemize
1152 Declare the usage of packages.
1154 \begin_inset Newline newline
1158 packages provide special commands, which are only available within a document
1159 when the package has been declared in the preamble.
1160 In addition to providing special commands, the inclusion of a package can
1161 change the document.
1162 For example, the package
1163 \begin_inset Flex Code
1166 \begin_layout Plain Layout
1172 forces all paragraphs to be indented.
1173 There are other packages for labels, envelopes, margins, etc.
1177 \begin_layout Itemize
1178 Set counters, variables, lengths and widths.
1180 \begin_inset Newline newline
1183 There are several \SpecialChar LaTeX
1184 counters and variables that
1188 be set globally from within the preamble in order to have the desired effect.
1189 (There are variables that you can set and reset inside the document, too.)
1190 Margins are a good example of something that must be set in the preamble.
1191 Another example is the label format for lists.
1192 You can actually set these just about anywhere, but it's best to do it
1193 just once, inside the preamble.
1196 \begin_layout Itemize
1197 Declare user defined commands (with
1198 \begin_inset Flex Code
1201 \begin_layout Plain Layout
1210 \begin_inset Flex Code
1213 \begin_layout Plain Layout
1222 \begin_inset Newline newline
1225 These are abbreviations for \SpecialChar LaTeX
1226 commands which appear very often inside a document.
1227 Although the preamble is a good place to declare such commands, they
1231 be declared anywhere (before they are used for the first time, of course).
1232 This can be useful if there is a lot of raw \SpecialChar LaTeX
1233 code in your document, which
1234 normally should not be the case.
1237 \begin_layout Standard
1239 adds its own set of definitions to the preamble of the
1240 \begin_inset Flex Code
1243 \begin_layout Plain Layout
1250 This makes \SpecialChar LaTeX
1251 files generated by \SpecialChar LyX
1255 \begin_layout Subsection
1256 Changing the Preamble
1259 \begin_layout Standard
1260 The commands which \SpecialChar LyX
1261 adds to the preamble of a \SpecialChar LaTeX
1262 file are fixed; you can't
1263 change them without patching \SpecialChar LyX
1265 You can, however, add your own stuff to the preamble by selecting
1266 \begin_inset Flex Noun
1269 \begin_layout Plain Layout
1272 \begin_inset space ~
1281 \begin_inset Flex Noun
1284 \begin_layout Plain Layout
1285 Document\SpecialChar menuseparator
1293 adds anything in the
1294 \begin_inset Flex Noun
1297 \begin_layout Plain Layout
1303 dialog to its own built-in preamble.
1304 Before adding your own declarations in the preamble, you should make sure
1305 that \SpecialChar LyX
1306 doesn't already support what you want to do.
1307 (Remember what we said about reinventing the wheel?) Also,
1309 make sure your preamble code is correct
1313 doesn't check it for you.
1314 If there is an error, you're likely to get an error like
1315 \begin_inset Quotes eld
1319 \begin_inset Flex Code
1322 \begin_layout Plain Layout
1331 \begin_inset Quotes erd
1335 If you see this error, check your preamble.
1338 \begin_layout Subsection
1342 \begin_layout Standard
1343 Here are some examples of what you can add to a preamble, and what they
1347 \begin_layout Subsubsection
1351 \begin_layout Standard
1352 There are two variables under \SpecialChar LaTeX
1353 that control page position:
1354 \begin_inset Flex Code
1357 \begin_layout Plain Layout
1366 \begin_inset Flex Code
1369 \begin_layout Plain Layout
1378 Their names should be self-explanatory.
1379 These variables are useful if you think for a moment about computer labels.
1380 Sometimes, the size of a print medium and the area of the medium that you
1381 can actually print on aren't the same.
1383 \begin_inset Flex Code
1386 \begin_layout Plain Layout
1395 \begin_inset Flex Code
1398 \begin_layout Plain Layout
1409 \begin_layout Standard
1410 The default values for
1411 \begin_inset Flex Code
1414 \begin_layout Plain Layout
1423 \begin_inset Flex Code
1426 \begin_layout Plain Layout
1435 \begin_inset space \thinspace{}
1439 \begin_inset space \thinspace{}
1443 \begin_inset space \space{}
1446 the page isn't shifted.
1447 Unfortunately, some DVI drivers always seem to shift the page.
1448 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1449 If you're using \SpecialChar LyX
1450 on a system that you don't personally maintain, and your
1451 sysadmin is a doofus,
1452 \begin_inset Flex Code
1455 \begin_layout Plain Layout
1464 \begin_inset Flex Code
1467 \begin_layout Plain Layout
1476 Suppose your left and top margins are always 0.5
1477 \begin_inset space \thinspace{}
1481 You can add this to the preamble:
1484 \begin_layout LyX-Code
1492 \begin_layout LyX-Code
1500 \begin_layout Standard
1501 and your margins should now be correct.
1504 \begin_layout Subsubsection
1508 \begin_layout Standard
1509 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1510 There's a rather nice package, available at your nearest CTAN archive,
1511 for printing sheets of labels:
1512 \begin_inset Flex Code
1515 \begin_layout Plain Layout
1522 Now, your system may not have this package installed by default.
1523 We leave that up to you to check.
1524 You'll also want to read the documentation for it; we're not going to do
1526 Since this is an example, however, we'll give you an example of how you
1530 \begin_layout Standard
1531 First, make sure you're using the
1532 \begin_inset Flex Code
1535 \begin_layout Plain Layout
1542 Next, you need to put the following in your preamble:
1545 \begin_layout LyX-Code
1551 \begin_layout LyX-Code
1557 \begin_layout LyX-Code
1563 \begin_layout LyX-Code
1569 \begin_layout LyX-Code
1575 \begin_layout LyX-Code
1581 \begin_layout LyX-Code
1587 \begin_layout Standard
1588 This sets things up for Avery label sheets, stock #5360.
1589 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1592 \begin_inset Flex Code
1595 \begin_layout Plain Layout
1604 \begin_inset Flex Code
1607 \begin_layout Plain Layout
1615 around each label text.
1616 This and other special features of
1617 \begin_inset Flex Code
1620 \begin_layout Plain Layout
1626 are explained in its documentation.
1629 \begin_layout Standard
1630 Someday, someone may write a \SpecialChar LyX
1631 layout file to support this package directly.
1632 Maybe that someone is you.
1635 \begin_layout Subsubsection
1636 Example #3: Paragraph Indentation
1639 \begin_layout Standard
1640 Americans are trained to indent the first line of
1645 As with all of their other weird quirks, most Americans will whine and
1646 moan until they can have their way and indent the first line of all paragraphs.
1655 \begin_layout Standard
1656 Of course, this behavior isn't standard typography.
1657 In books, you typically only indent the first line of a paragraph
1661 it follows another one.
1662 The idea behind indenting the first line of a paragraph is to distinguish
1663 neighboring paragraphs from one another.
1664 If there is no previous paragraph—for example, if it follows a figure or
1665 is the first paragraph in a section—then there is no need for indentation.
1669 \begin_layout Standard
1670 If you're a typical American (we're still joking!), though, you don't care
1671 about such esoteric things; you want your indentation! Add this to the
1675 \begin_layout LyX-Code
1678 usepackage{indentfirst}
1681 \begin_layout Standard
1682 If your \SpecialChar TeX
1683 distribution isn't braindead, you'll have this package, and all
1684 of your paragraphs will get the indentation the Founding Fathers intended
1688 \begin_layout Subsubsection
1689 Example #4: This Document
1692 \begin_layout Standard
1693 You can also check out the preamble of this document to get an idea of some
1694 of the advanced things you can do.
1697 \begin_layout Section
1699 and \SpecialChar LaTeX
1703 \begin_layout Standard
1704 When \SpecialChar LyX
1705 calls \SpecialChar LaTeX
1706 , it tells \SpecialChar LaTeX
1707 to blithely ignore any errors and keep going.
1708 It then uses the logfile from the \SpecialChar LaTeX
1709 run to do a post-mortem.
1710 After analyzing the logfile, \SpecialChar LyX
1711 displays a dialog listing the errors.
1712 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1714 where the error occurred.
1718 \begin_layout Plain Layout
1720 Analyzing the logfile is a tough job, and \SpecialChar LyX
1721 doesn't always go to the right
1723 There are also cases where \SpecialChar LaTeX
1724 reports the error on one line, but the actual
1726 This is not unlike forgetting a closing brace in a program: You'll get
1727 an error, but only later.
1735 \begin_layout Standard
1736 Some folks also like to look at the log file directly: It is available from
1738 \begin_inset Flex Noun
1741 \begin_layout Plain Layout
1742 Document\SpecialChar menuseparator
1744 \begin_inset space ~
1753 There are some fairly common error messages and warnings.
1754 We'll cover those here.
1755 You should look at a good \SpecialChar LaTeX
1756 book for a complete listing.
1759 \begin_layout Itemize
1760 \begin_inset Flex Code
1763 \begin_layout Plain Layout
1770 \begin_inset Newline newline
1773 Anything beginning with these words is a warning message for the purpose
1775 \begin_inset Quotes eld
1779 \begin_inset Quotes erd
1782 the \SpecialChar LaTeX
1784 You'll get messages like this if you added or changed cross-references
1785 or bibliography entries, in which case, \SpecialChar LaTeX
1786 is trying to tell you that you
1787 need to make another run.
1788 You can by-and-large ignore these.
1791 \begin_layout Itemize
1792 \begin_inset Flex Code
1795 \begin_layout Plain Layout
1802 \begin_inset Newline newline
1805 Another warning message, this time about fonts which \SpecialChar LaTeX
1807 The rest of the message will often say something about a replacement font
1808 that \SpecialChar LaTeX
1810 You can safely ignore these, too.
1813 \begin_layout Itemize
1814 \begin_inset Flex Code
1817 \begin_layout Plain Layout
1826 \begin_inset Newline newline
1835 It seems to generate at least one of these messages for just about any
1837 They are warnings about lines that were too long and run past the right
1839 This happens if \SpecialChar LaTeX
1840 does not find a reasonable way to break the lines (notoriously
1841 often with typewriter font, since this does not allow for automatic break
1843 In many cases, this is unnoticeable in the final output.
1844 (It can be just a point or two.) Sometimes, however, the lines run rather
1845 visibly into the margin; something you will not want to have in your final
1848 \begin_inset Newline newline
1851 There are several global ways to try to minimize the overfull lines.
1854 Enable micro-typographic extensions
1858 Document\SpecialChar menuseparator
1859 Settings\SpecialChar menuseparator
1862 might already improve things a lot.
1863 Furthermore, \SpecialChar LaTeX
1864 code such as the following in
1866 Document\SpecialChar menuseparator
1867 Settings\SpecialChar menuseparator
1870 usually reduces the overfull lines drastically (we use this in the preamble
1875 \begin_layout LyX-Code
1879 \begin_inset Newline newline
1885 \begin_inset Newline newline
1890 emergencystretch 1.5em
1891 \begin_inset Newline newline
1899 \begin_layout Standard
1900 In some cases, however, you eventually have to rewrite the text to get the
1901 line breaking right.
1905 \begin_layout Plain Layout
1906 For more information, see
1907 \begin_inset Flex URL
1910 \begin_layout Plain Layout
1912 http://www.tex.ac.uk/FAQ-overfull.html
1925 \begin_layout Standard
1926 In any case, you should check the respective lines, at least for the final
1927 version of your document.
1928 Your eyes will tell you if there's a problem with something that's too
1933 \begin_layout Plain Layout
1934 You can also enable the `draft' option in
1935 \begin_inset Flex Noun
1938 \begin_layout Plain Layout
1939 Document\SpecialChar menuseparator
1945 , and then \SpecialChar LaTeX
1946 will draw a black box in the margin of lines that are overfull.
1955 \begin_layout Itemize
1956 \begin_inset Flex Code
1959 \begin_layout Plain Layout
1968 \begin_inset Newline newline
1971 Not quite as common as its cousin.
1972 This happens again if \SpecialChar LaTeX
1973 does not find a reasonable break point and consequently
1974 generates too loose lines.
1975 As with the overfull lines, you should check if this is a visible problem.
1978 \begin_layout Itemize
1979 \begin_inset Flex Code
1982 \begin_layout Plain Layout
1991 \begin_inset Flex Code
1994 \begin_layout Plain Layout
2003 \begin_inset Newline newline
2006 Warnings about troubles breaking the page.
2007 Once again, just look at the output.
2008 Your eyes will tell you where something has gone wrong.
2011 \begin_layout Itemize
2012 \begin_inset Flex Code
2015 \begin_layout Plain Layout
2017 \begin_inset Quotes els
2021 \begin_inset Quotes ers
2030 \begin_inset Newline newline
2034 \begin_inset Quotes eld
2038 \begin_inset Quotes erd
2041 isn't installed on this system.
2042 This usually appears because some package your document needs isn't installed.
2043 If you didn't touch the preamble or didn't use the
2044 \begin_inset Flex Code
2047 \begin_layout Plain Layout
2055 command, then one of the packages \SpecialChar LyX
2056 tried to load is missing.
2058 \begin_inset Flex Noun
2061 \begin_layout Plain Layout
2062 Help\SpecialChar menuseparator
2069 to get a list of packages that \SpecialChar LyX
2071 This file is updated whenever you reconfigure \SpecialChar LyX
2073 \begin_inset Flex Noun
2076 \begin_layout Plain Layout
2077 Tools\SpecialChar menuseparator
2083 ) and tells you which packages have been detected and what they do.
2084 \begin_inset Newline newline
2088 \begin_inset Flex Code
2091 \begin_layout Plain Layout
2099 command and the package in question isn't installed, then you'll need to
2100 install it yourself.
2103 \begin_layout Itemize
2104 \begin_inset Flex Code
2107 \begin_layout Plain Layout
2108 LaTeX Error: Unknown option
2114 \begin_inset Newline newline
2117 Error messages beginning with this are trying to tell you that you specified
2118 a bad or undefined option to a package.
2119 Check the package's documentation.
2122 \begin_layout Itemize
2123 \begin_inset Flex Code
2126 \begin_layout Plain Layout
2127 Undefined control sequence
2133 \begin_inset Newline newline
2136 If you've inserted \SpecialChar LaTeX
2137 code into your document, but made a typo, you'll get
2139 You may have forgotten to load a package.
2140 In any case, this error message usually means that you used an undefined
2145 \begin_layout Standard
2146 There are other error and warning messages.
2147 Some are self-explanatory.
2148 These are usually \SpecialChar LaTeX
2150 Others are downright cryptic.
2151 These are usually \SpecialChar TeX
2152 error messages, and we really have
2156 what they mean or how to decipher them.
2160 \begin_layout Standard
2161 There's a general sequence you should follow if you get error messages:
2164 \begin_layout Enumerate
2165 Look at the \SpecialChar LaTeX
2166 code you inserted for typos.
2169 \begin_layout Enumerate
2170 If there are no typos, check that you used the command(s) correctly.
2173 \begin_layout Enumerate
2174 If you get a bunch of error boxes piled up at the very top of the document—and
2175 especially if you see a
2176 \begin_inset Quotes eld
2180 \begin_inset Flex Code
2183 \begin_layout Plain Layout
2192 \begin_inset Quotes erd
2195 error—it means that there are errors in the preamble.
2196 Start debugging your preamble.
2199 \begin_layout Enumerate
2200 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2202 document, the first suspect is your \SpecialChar LaTeX
2203 distribution itself.
2204 Check for missing packages and install them.
2207 \begin_layout Enumerate
2208 Okay, so there are no missing packages.
2209 Did you use any of the fine-tuning options in \SpecialChar LyX
2210 ? Specifically, did you
2214 any of them, like trying to manually insert lots of
2215 \begin_inset Flex Code
2218 \begin_layout Plain Layout
2220 \change_deleted 177693 1654669036
2222 \change_inserted 177693 1654669038
2226 \begin_inset space ~
2230 \change_deleted 177693 1654669040
2232 \change_inserted 177693 1654669041
2241 \begin_inset Flex Code
2244 \begin_layout Plain Layout
2251 \begin_inset Flex Code
2254 \begin_layout Plain Layout
2260 ? Did you try to kludge something together with these instead of using the
2261 appropriate paragraph environment?
2264 \begin_layout Enumerate
2265 All right, you didn't use any of the fine-tuning options, you played by
2267 Did you try to pull a fancy maneuver? Did you do something funky inside
2268 a table or an equation, like inserting a graphic into a table cell?
2271 \begin_layout Enumerate
2272 Do you have long sections of text where \SpecialChar LaTeX
2273 cannot find a place to break a
2274 line? By default, \SpecialChar LaTeX
2275 is rather strict about how much extra inter-word spacing
2276 it will add in order to break a line.
2277 Preferably, you should rework the paragraph to avoid the problem.
2280 \begin_layout Enumerate
2281 Did you go overboard with the nesting? \SpecialChar LyX
2282 (currently) doesn't check to make
2283 sure you're in the limits for nesting environments.
2284 If you nested a bunch of environments to the
2285 \begin_inset Formula $17^{\mathrm{th}}$
2288 level, that's the problem.
2289 (The limit in \SpecialChar LaTeX
2293 \begin_layout Enumerate
2294 Okay, you didn't get any error messages, but your output looks awful.
2295 If you have a table or figure that's too wide or long for the page, you
2300 \begin_layout Enumerate
2301 rescale the figure so it fits.
2304 \begin_layout Enumerate
2305 trim down the table so it fits.
2309 \begin_layout Enumerate
2310 If something else is wrong with the output, and you didn't try to pull anything
2311 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2314 \begin_layout Standard
2315 If all this doesn't help—well, then
2319 you might have found a bug in \SpecialChar LyX
2324 \begin_layout Chapter
2326 \change_inserted 564990737 1670439508
2330 \begin_layout Section
2332 \change_inserted 564990737 1670439533
2333 \begin_inset CommandInset label
2335 name "sec:Collections"
2342 \begin_layout Subsection
2343 AMS \SpecialChar LaTeX
2347 \begin_layout Standard
2354 Richard Kimberly Heck
2357 \begin_layout Standard
2358 \begin_inset VSpace bigskip
2364 \begin_layout Standard
2366 The AMS \SpecialChar LaTeX
2367 layouts are set up to conform to suggested styles for mathematical
2368 papers to be submitted to American Mathematical Society publications.
2369 The layouts are not tailored to a specific journal, but easily can be.
2370 You should refer to the AMS documentation for specific instructions for
2371 each journal (usually it will entail only changing a single line in the
2374 That documentation is available on the Web at
2375 \begin_inset Flex URL
2378 \begin_layout Plain Layout
2386 \begin_inset Flex URL
2389 \begin_layout Plain Layout
2391 ftp://ftp.ams.org/pub/tex/amslatex/
2397 These layouts are appropriate, and useful, for any mathematical writing.
2401 \begin_layout Standard
2402 There are two basic AMS \SpecialChar LaTeX
2406 \begin_layout Itemize
2407 amsart: The standard AMS article format.
2410 \begin_layout Itemize
2411 amsbook: the standard AMS book (really, monograph) format.
2415 \begin_layout Standard
2416 The layouts themselves contain only the minimum necessary to use the AMS
2418 They do not, in particular, contain any of the `theorem' environments used
2419 for setting theorems, lemmas, and the like.
2420 These are contained, instead, in the
2421 \begin_inset Flex Code
2424 \begin_layout Plain Layout
2430 module, which is loaded by default when you select one of the AMS classes.
2431 (It can also be used with other classes and can be removed, if you would
2432 rather use something else.) Less commonly used environments are in the
2433 \begin_inset Flex Code
2436 \begin_layout Plain Layout
2437 Theorems (AMS-Extended)
2442 module, which must be loaded manually.
2445 \begin_layout Standard
2446 By default, theorems and the like are numbered consecutively throughout
2447 the document, but this may be modified by loading the module
2448 \begin_inset Flex Code
2451 \begin_layout Plain Layout
2452 Theorems (Order by Section)
2457 or, if you are using
2458 \begin_inset Flex Code
2461 \begin_layout Plain Layout
2468 \begin_inset Flex Code
2471 \begin_layout Plain Layout
2472 Theorems (Order by Chapter)
2478 These will number the results as
2479 \begin_inset Formula $n.m$
2482 , where the first number refers to the section (or chapter) and the second
2483 refers to the total number of results so far in that section (or chapter).
2484 Many environments are also available unnumbered.
2485 These are indicated by an asterisk at the end.
2486 If you happen to want
2490 unnumbered results, the module
2491 \begin_inset Flex Code
2494 \begin_layout Plain Layout
2500 provides that option.
2503 \begin_layout Standard
2504 Note that these modules do not
2508 to be used with the AMS classes.
2509 It is perfectly possible to use the
2510 \begin_inset Flex Code
2513 \begin_layout Plain Layout
2519 module, and the others mentioned, with other classes, such as
2520 \begin_inset Flex Code
2523 \begin_layout Plain Layout
2530 \begin_inset Flex Code
2533 \begin_layout Plain Layout
2540 \begin_inset Flex Code
2543 \begin_layout Plain Layout
2552 \begin_layout Subsubsection
2553 What these layouts provide
2556 \begin_layout Standard
2557 There is a long list of included environments provided by these layouts.
2558 In AMS-\SpecialChar LaTeX
2559 , there is, in fact, an opportunity to define an unlimited variety
2560 of `theorem' environments.
2561 However, the AMS recommends the environments that are available in \SpecialChar LyX
2566 \begin_layout Standard
2567 The following environments—as well as the standard environments, such as
2569 \begin_inset Flex Noun
2572 \begin_layout Plain Layout
2579 \begin_inset Flex Noun
2582 \begin_layout Plain Layout
2589 \begin_inset Flex Noun
2592 \begin_layout Plain Layout
2599 \begin_inset Flex Noun
2602 \begin_layout Plain Layout
2609 \begin_inset Flex Noun
2612 \begin_layout Plain Layout
2619 \begin_inset Flex Code
2622 \begin_layout Plain Layout
2629 \begin_inset Flex Code
2632 \begin_layout Plain Layout
2641 \begin_layout Description
2642 Address This should be the author's permanent address.
2645 \begin_layout Description
2647 \begin_inset space ~
2650 Address This should be the author's temporary address at the time of submission,
2651 if different from the Address.
2654 \begin_layout Description
2655 Email Author's e-mail address
2658 \begin_layout Description
2659 URL Author's Web address, if desired.
2662 \begin_layout Description
2663 Keywords Key words or phrases used to identify specific topics discussed
2667 \begin_layout Description
2668 Subjectclass These refer to the AMS Subject Classifications, published and
2671 Mathematical Reviews
2674 These are also available online at the AMS cites listed above.
2677 \begin_layout Description
2681 \begin_layout Description
2685 \begin_layout Description
2689 \begin_layout Standard
2690 The following environments are provided by both the
2691 \begin_inset Flex Code
2694 \begin_layout Plain Layout
2701 \begin_inset Flex Code
2704 \begin_layout Plain Layout
2710 modules, in the latter case in both starred (unnumbered) and unstarred
2711 (numbered) versions.
2712 These same environments are provided only in the starred versions by the
2714 \begin_inset Flex Code
2717 \begin_layout Plain Layout
2726 \begin_layout Theorem
2727 This is typically used for the statements of major results.
2731 \begin_layout Corollary*
2732 This is used for statements which follow fairly directly from previous statement
2734 Again, these can be major results.
2739 These are smaller results needed to prove other statements.
2742 \begin_layout Proposition
2743 These are less major results which (hopefully) add to the general theory
2747 \begin_layout Conjecture
2748 These are statements provided without justification, which the author does
2749 not know how to prove, but which seem to be true (to the author, at least).
2752 \begin_layout Definition*
2753 Guess what this is for.
2754 The font is different for this environment than for the previous ones.
2758 \begin_layout Example*
2759 Used for examples illustrating proven results.
2762 \begin_layout Problem
2763 It's not really known what this is for.
2764 You should figure it out.
2767 \begin_layout Exercise*
2768 Write a description for this one.
2771 \begin_layout Remark
2772 This environment is also a type of theorem, usually a lesser sort of observation.
2775 \begin_layout Claim*
2776 Often used in the course of giving a proof of a larger result.
2780 Generally, these are used to break up long arguments, using specific instances
2786 The numbering scheme for cases is on its own, not together with other numbered
2792 At the end of this environment, a QED symbol (usually a square, but it can
2793 vary with different styles) is placed.
2794 If you want to have other environments within this one—for example, Case
2795 environments—and have the QED symbol appear only after them, then the other
2796 environments need to be nested within the proof environment.
2799 Nesting Environments
2805 for information on nesting.
2808 \begin_layout Standard
2809 And these environments are provided by
2810 \begin_inset Flex Code
2813 \begin_layout Plain Layout
2814 Theorems (AMS-Extended)
2822 \begin_layout Criterion*
2823 A required condition.
2826 \begin_layout Algorithm*
2827 A general procedure to be used.
2830 \begin_layout Axiom*
2831 This is a property or statement taken as true within the system being discussed.
2834 \begin_layout Condition*
2835 Sometimes used to state a condition assumed within the present context of
2840 Similar to a Remark.
2843 \begin_layout Notation*
2844 Used for the explanation of, yes, notation.
2847 \begin_layout Summary
2848 Do we really need to tell you?
2851 \begin_layout Acknowledgement*
2855 \begin_layout Conclusion*
2856 Sometimes used at the end of a long train of argument.
2860 Used in a way similar to Proposition, though perhaps lower on the scale.
2863 \begin_layout Standard
2864 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
2867 They need to be available on your system in order to use these environments.
2870 \begin_layout Subsection
2874 \begin_layout Standard
2880 \begin_layout Subsubsection
2884 \begin_layout Standard
2885 The \SpecialChar LyX
2888 article (koma-script)
2892 report (koma-script)
2910 correspond to the \SpecialChar LaTeX
2928 \begin_inset space ~
2931 of the Koma-Script family.
2932 They are replacements for the standard document classes
2948 , resp., and fit better to European typography conventions in a number of
2952 \begin_layout Itemize
2953 Standard character size is 11pt in
2955 article (koma-script)
2959 report (koma-script)
2967 letter (koma-script)
2972 \begin_layout Itemize
2973 Headings, labels of the description environment, and a number of elements
2976 letter (koma-script)
2978 document class are set in a bold sans serif font.
2982 \begin_layout Plain Layout
2983 There is a big difference between the bold sans serif old cm fonts and new
2984 ec fonts, especially in the appearance of headings.
2985 In comparison, the ec bold sans serif fonts look a bit thin.
2986 Here the \SpecialChar LaTeX
2995 helps to produce the
2996 \begin_inset Quotes eld
3000 \begin_inset Quotes erd
3003 appearance when using the ec fonts.
3008 The numbering of chapter headings is made in the same way as the numbering
3009 of section headings, that is without the extra line
3010 \begin_inset Quotes eld
3013 Chapter\SpecialChar ldots
3015 \begin_inset Quotes erd
3019 In addition, the appearance of the headings can be modified by using a
3020 number of options (in \SpecialChar LyX
3021 to be entered in the field
3024 \begin_inset space ~
3031 Layout\SpecialChar menuseparator
3038 \begin_layout Itemize
3039 The main means in the Koma-Script document classes to design the type area
3048 (in \SpecialChar LyX
3049 to be entered in the extra class options field in the dialog
3051 Document\SpecialChar menuseparator
3055 They make a clearer modification of page margins possible as do the options
3058 Document\SpecialChar menuseparator
3065 \begin_layout Itemize
3066 The \SpecialChar LaTeX
3067 document classes of the Koma-Script family define a number of additional
3069 Those part of it which makes sense in \SpecialChar LyX
3070 is implemented in corresponding
3074 \begin_layout Standard
3075 Detailed descriptions of the \SpecialChar LaTeX
3076 document classes of the Koma-Script family
3077 can be found in the Koma-Script documentation
3088 \begin_layout Subsubsection
3089 article (koma-script), report (koma-script), and book (koma-script)
3092 \begin_layout Standard
3093 The document classes
3095 article (koma-script)
3099 report (koma-script)
3109 are implemented in the layout files
3122 They contain all the paragraph types of the corresponding standard document
3135 , resp., partly modified, with the exception of the \SpecialChar LyX
3140 -type, which is replaced by the new
3144 -type having the same functionality.
3149 -Type there is a number of new paragraph types added.
3156 letter (koma-script)
3161 \begin_layout Itemize
3170 : are equivalents to
3178 , resp., additionally inserting an entry in the table of contents.
3187 are not contained in
3189 article (koma-script)
3194 \begin_layout Itemize
3211 , resp., additionally clearing running heads.
3218 article (koma-script)
3224 \begin_layout Plain Layout
3237 report (koma-script)
3239 , but since this is identical to
3243 , is has not been implemented in \SpecialChar LyX
3252 \begin_layout Itemize
3257 : generates a heading directly above the following paragraph in the standard
3258 character size without affecting the structure of the document.
3261 \begin_layout Itemize
3270 are special captions which respect the different space settings needed
3271 for captions placed above or below an element (if you follow strict typographic
3272 rules, you might want to place table captions always above the table).
3273 You can also use the class option
3290 You need at least Koma-Script version 2.8q to use this.
3293 \begin_layout Itemize
3298 : can be used to set a bonmot, e.
3299 \begin_inset space \thinspace{}
3303 \begin_inset space \space{}
3306 at the beginning of a chapter.
3307 If you use the optional argument (
3309 Insert\SpecialChar menuseparator
3311 \begin_inset space ~
3316 ), you can insert the dictum's author there.
3317 Dictum and author are separated by a line.
3318 You need at least Koma-Script version 2.8q to use this.
3325 article (koma-script)
3330 \begin_layout Standard
3331 The following types, together with the standard types
3343 , form the title area of the document.
3344 They must be entered ahead of the first
3345 \begin_inset Quotes eld
3349 \begin_inset Quotes erd
3356 \begin_layout Plain Layout
3357 The corresponding \SpecialChar LaTeX
3358 commands must appear before the
3369 When such a type is used more than once, the latter usage overwrites the
3370 former one, that means, for every type only the latest usage is valid.
3371 The order of the different types however has, like
3383 , no effect on the appearance of the produced document.
3386 \begin_layout Itemize
3391 : produces a centered paragraph above the ordinary title (
3403 ) for the subject of the document.
3406 \begin_layout Itemize
3411 : produces a centered paragraph below the ordinary title (
3423 ) for the publishers' name.
3426 \begin_layout Itemize
3433 report (koma-script)
3439 produces a centered paragraph on its own page behind the title page, or
3442 article (koma-script)
3444 produces a centered paragraph below the ordinary title (
3463 \begin_layout Itemize
3468 : produces a left aligned paragraph above the ordinary title (
3484 ) for a document`s head.
3487 \begin_layout Itemize
3492 : produces in a double-sided print in
3494 report (koma-script)
3500 a left-aligned paragraph at the top of the title page`s back or has no
3501 effect in a single-sided print or in
3503 article (koma-script)
3508 \begin_layout Itemize
3513 : produces in a double-sided print in
3515 report (koma-script)
3521 a left-aligned paragraph at the bottom of the title page`s back or has
3522 no effect in a single-sided print or in
3524 article (koma-script)
3529 \begin_layout Itemize
3534 : produces a special
3535 \begin_inset Quotes eld
3539 \begin_inset Quotes erd
3542 page ahead of the actual document containing a paragraph without special
3546 \begin_layout Standard
3547 The layout files for the document classes
3549 article (koma-script)
3553 report (koma-script)
3564 This is thought of as a place to define your own types.
3569 in your personal layout directory and edit the file!
3572 \begin_layout Subsubsection
3573 letter (koma-script)
3576 \begin_layout Description
3577 Note: This section discusses the obsolete
3579 KOMA-Script-Letter (v.
3580 \begin_inset space ~
3585 , which is not even included anymore in recent KOMA releases.
3586 Please refer to the next section for the current KOMA-Script-Letter class
3588 \begin_inset space ~
3594 \begin_layout Standard
3598 letter (koma-script)
3600 is implemented in the layout file
3605 It contains all the paragraph types of the corresponding standard document
3610 , partly modified, with the exception of the \SpecialChar LyX
3624 type, which is replaced by the new
3629 In addition, it contains, in contrast to the standard document class, the
3648 Furthermore, there are a number of new letter specific types.
3651 \begin_layout Standard
3652 The appearance of the letter produced by this document class can be controlled
3653 by a number of \SpecialChar LaTeX
3654 commands, which you can put in the \SpecialChar LaTeX
3659 \begin_layout Plain Layout
3660 For example, the standard appearance of the letter`s heading, consisting
3661 of name and address, is quite self-willed.
3663 \begin_inset Quotes eld
3667 \begin_inset Quotes erd
3670 heading is produced by the following \SpecialChar LaTeX
3671 commands in the preamble:
3674 \begin_layout LyX-Code
3684 \begin_layout LyX-Code
3700 \begin_layout LyX-Code
3710 \begin_layout LyX-Code
3730 A detailed German description of such \SpecialChar LaTeX
3731 commands can be found in the Koma-Script
3737 With it, the letter's author can produce his personal letter layout.
3740 \begin_layout Standard
3749 define the beginning of the letter and must be used in every letter.
3750 To emphasize them in the \SpecialChar LyX
3751 document class, they are marked with the letter
3761 \begin_inset space ~
3765 It is possible to write any number of letters in one file.
3770 type produces a new letter using the same addressee and a
3774 type produces a new addressee.
3791 are ordinary paragraph types and can also be used several times in one
3792 and the same letter.
3795 \begin_layout Itemize
3800 : produces a paragraph for the addressee and implicitly defines the beginning
3804 \begin_layout Itemize
3809 : produces a paragraph for the form of address and implicitly produces a
3813 \begin_layout Itemize
3818 : produces a paragraph for a close.
3821 \begin_layout Itemize
3826 : produces a paragraph for a postscript.
3829 \begin_layout Itemize
3834 : produces a paragraph for a distribution list.
3837 \begin_layout Itemize
3842 : produces a paragraph for enclosures.
3845 \begin_layout Standard
3886 are input types provided with a label to enter information, which will
3887 be processed by the document class.
3891 \begin_layout Plain Layout
3892 It could be seen as a matter of inconsequence, that the types
3900 described above are not such input types as well.
3901 Because of the special meaning of those types, however, I have implemented
3902 them as ordinary paragraph types with a one letter mark in the left margin.
3903 Moreover, it would affect my feeling of symmetry, if the
3911 type had such a serious different appearance.
3916 The types must be used ahead of the corresponding
3923 \begin_layout Standard
3924 An implementation of these types in a WYSIWYG fashion does not seem to make
3925 sense, because the real appearance of the produced letter does not only
3926 depend on the usage of the particular type, but also on other factors.
3927 For example, a signature entered in the
3931 type will in the standard behavior appear in the produced letter only,
3932 when in the same letter also a
3937 The entered value of the
3941 type will in the standard behavior not appear in the produced letter at
3943 The possibility to design the letter`s heading freely is already indicated
3944 in a footnote above.
3947 \begin_layout Standard
3948 The input types can also be used as empty paragraphs.
3950 \begin_inset space \thinspace{}
3954 \begin_inset space \space{}
3966 type is not used at all, in the standard behavior the value of the
3970 type is used as signature, whereas if an empty
3974 type is used, no signature value is defined.
3977 \begin_layout Standard
3978 By using the input types it is possible to write a letter template, containing
3979 filled input types with your personal dates (name, address, etc.) and empty
3980 input types for other dates you want to enter.
3983 \begin_layout Itemize
3988 : sender's name, in the standard behavior appears as a centered paragraph
3989 in small caps in the letter`s heading.
3992 \begin_layout Itemize
3997 : sender's signature, in the standard behavior appears below the
4006 type is used, the value of the
4010 type appears instead.
4013 \begin_layout Itemize
4018 : sender's address, in the standard behavior appears in a centered paragraph
4019 in the letter`s heading below the sender's name.
4022 \begin_layout Itemize
4027 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
4038 \begin_layout Itemize
4043 : place of the letter`s making.
4046 \begin_layout Itemize
4051 : date of the letter`s making.
4060 , in the standard behavior, produce the place and the date in a right-aligned
4061 line below the addressee's field.
4066 type is used, neither place nor date appear, independent of the value of
4076 type is used, the date of the letter `s production is used.
4079 \begin_layout Itemize
4084 : sender`s back address, in the standard behavior appears above the addressee's
4085 field in a small sans serif font.
4088 \begin_layout Itemize
4093 : special mail information, in the standard behavior appears underlined
4094 above the addressee's field below the back address.
4097 \begin_layout Itemize
4102 : additional information, in the standard behavior appears on right side
4103 below the addressee`s field.
4106 \begin_layout Itemize
4111 : the letter's title, in the standard behavior appears in a big, bold, sans
4112 serif font above the subject.
4115 \begin_layout Itemize
4120 : the letter's subject, in the standard behavior appears in a bold font
4128 \begin_layout Standard
4149 produce a business letter like line above the
4153 line containing the fields
4154 \begin_inset Quotes eld
4158 \begin_inset Quotes erd
4162 \begin_inset Quotes eld
4166 \begin_inset Quotes erd
4170 \begin_inset Quotes eld
4174 \begin_inset Quotes erd
4178 \begin_inset Quotes eld
4182 \begin_inset Quotes erd
4186 \begin_inset Quotes eld
4190 \begin_inset Quotes erd
4194 \begin_inset Quotes eld
4198 \begin_inset Quotes erd
4202 For the date field, the value of the
4208 \begin_inset Quotes eld
4211 business letter types
4212 \begin_inset Quotes erd
4215 is used, the value of the
4219 type however does not appear, but only the \SpecialChar LaTeX
4227 The ordinary output of place and date in a right-aligned line below the
4228 addressee`s field is suppressed.
4229 The types are implemented as input types provided with a label and must
4230 be used ahead of the corresponding
4237 \begin_layout Itemize
4245 \begin_layout Itemize
4253 \begin_layout Itemize
4261 \begin_layout Itemize
4269 \begin_layout Itemize
4277 \begin_layout Subsubsection
4278 The new letter class: letter (koma-script v.2)
4281 \begin_layout Standard
4287 \begin_layout Standard
4288 \begin_inset VSpace medskip
4294 \begin_layout Standard
4296 Koma-Script version 2.8 has introduced a new letter class
4300 which supersedes the now unsupported
4305 It has — on the \SpecialChar LaTeX
4306 side — a completely new interface and is not compatible
4308 Therefore, \SpecialChar LyX
4309 supports both, though it is recommended you use the new class.
4312 \begin_layout Standard
4313 This class covers the same functionality as
4315 letter (koma-script),
4322 (receiver's address, same as
4339 will start a new letter (i.
4340 \begin_inset space \thinspace{}
4344 \begin_inset space \space{}
4347 you can write several letters per document).
4348 New elements are sender's
4364 and the possibility to use a
4370 Insert\SpecialChar menuseparator
4376 \begin_layout Standard
4377 The biggest improvement is, though, that the letter's layout is configurable
4378 to meet almost any needs.
4379 This can be done via the preamble or with a special style file (Letter
4380 Class Option, extension
4384 ), that will be read in as a class option.
4388 \begin_layout Plain Layout
4389 The KOMA package comes with some default
4394 There is, for instance, a
4398 file that follows german typesetting rules, or a
4402 that provides the default layout of the old
4407 The latter can be loaded with the class option
4413 Layout\SpecialChar menuseparator
4414 Document\SpecialChar menuseparator
4426 template that is included in \SpecialChar LyX
4428 A detailed description is to be found in the Koma-Script documentation
4436 \begin_layout Subsubsection
4440 \begin_layout Standard
4441 Visualizing the Koma-Script document classes in \SpecialChar LyX
4442 , the \SpecialChar LyX
4443 internals cause some
4447 \begin_layout Itemize
4448 The chapter number of a
4452 type appears on a line of its own above the chapter heading instead of
4453 appearing in the same line ahead of it.
4454 The cause for that is the \SpecialChar LyX
4455 internal behavior for the labeltype
4462 \begin_layout Itemize
4463 The headings of the types
4472 \begin_inset Quotes eld
4476 \begin_inset Quotes erd
4480 table of contents, but not in the \SpecialChar LyX
4483 Document\SpecialChar menuseparator
4485 \begin_inset space ~
4489 \begin_inset space ~
4497 \begin_layout Itemize
4502 document class appear in a skip separation mode, not indented.
4503 This is the standard behavior, no special \SpecialChar LaTeX
4504 commands are needed for that.
4507 Document\SpecialChar menuseparator
4510 dialog the corresponding radio button indicates
4519 value always has the effect that extra \SpecialChar LaTeX
4520 commands are inserted in the document
4521 to produce the gap, which is not what is wanted in this case.
4524 \begin_layout Subsection
4526 \change_inserted 564990737 1670924924
4528 \begin_inset space \thinspace{}
4532 \begin_inset space \space{}
4536 \change_deleted 564990737 1670924933
4537 Article (mwart), book (mwbk) and report (mwrep)
4538 \begin_inset Argument status
4541 \begin_layout Plain Layout
4556 \begin_layout Standard
4562 \begin_layout Standard
4563 The \SpecialChar LyX
4580 correspond to the \SpecialChar LaTeX
4594 They are replacements for the standard document classes
4606 , resp., and fit better to Polish typography conventions in a number of points.
4610 \begin_layout Standard
4614 \begin_layout Itemize
4615 Unnumbered titles (with star, e.
4616 \begin_inset space \thinspace{}
4620 \begin_inset space \space{}
4627 ) are added into table of contents,
4630 \begin_layout Itemize
4631 Additional page styles:
4635 \begin_layout Description
4636 uheadings header with separated lines,
4639 \begin_layout Description
4640 myheadings custom header, contents headers via commands:
4655 \begin_layout Description
4656 myuheadings custom header with separated lines,
4659 \begin_layout Description
4660 outer page number is placed on outer side of page
4664 \begin_layout Itemize
4669 \begin_layout Description
4670 rmheadings serif titles — default,
4673 \begin_layout Description
4674 sfheadings sansserif titles,
4677 \begin_layout Description
4678 authortitle on title page first placed is author next title — default,
4681 \begin_layout Description
4682 titleauthor on title page first placed is title next author,
4685 \begin_layout Description
4686 withmarginpar reserve place on page for margins.
4690 \begin_layout Section
4692 \change_inserted 564990737 1670439534
4696 \begin_layout Standard
4698 \change_inserted 564990737 1670794710
4699 See also the document classes in the Collections (section
4700 \begin_inset space ~
4704 \begin_inset CommandInset ref
4706 reference "sec:Collections"
4713 \begin_layout Subsection
4715 \change_inserted 564990737 1670794716
4721 \begin_layout Standard
4723 \change_inserted 564990737 1670794716
4730 ; updated by the \SpecialChar LyX
4734 \begin_layout Subsubsection
4736 \change_inserted 564990737 1670794716
4742 \begin_layout Standard
4744 \change_inserted 564990737 1670794716
4747 This section describes how \SpecialChar LyX
4748 can be used to write articles for submission
4749 to the scientific journal
4751 Astronomy and Astrophysics
4754 \begin_inset CommandInset href
4757 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
4762 ) using Version 9.1 of the document class
4766 ; information about it is available at
4767 \begin_inset Flex URL
4770 \begin_layout Plain Layout
4772 \change_inserted 564990737 1670794716
4774 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
4784 \begin_layout Standard
4786 \change_inserted 564990737 1670794716
4789 A manual comes together with the package and should be consulted before
4790 installing this document class as described in the
4792 Installing New Document Classe
4802 \begin_layout Standard
4804 \change_inserted 564990737 1670794716
4807 \begin_inset Note Greyedout
4810 \begin_layout Plain Layout
4812 \change_inserted 564990737 1670794716
4815 Please note that the publisher of the journal was changed from Springer
4816 to EDP Sciences starting January 1, 2001.
4817 That change also involved some slight changes to the style files, namely
4818 the removal of the thesaurus command.
4819 If you have an older version installed, please upgrade.
4820 For information about compatibility with the old (version 4) layout, please
4821 refer to the comments in
4824 Dir/layouts/aapaper.layout
4834 \begin_layout Subsubsection
4836 \change_inserted 564990737 1670794716
4842 \begin_layout Standard
4844 \change_inserted 564990737 1670794716
4847 It is recommended you start from the template
4856 ile\SpecialChar menuseparator
4858 \begin_inset space ~
4866 \begin_inset space ~
4872 If you are not using the template, note the following settings:
4875 \begin_layout Itemize
4877 \change_inserted 564990737 1670794716
4889 ocument\SpecialChar menuseparator
4894 ettings\SpecialChar menuseparator
4896 \begin_inset space ~
4901 dialog (OK, that one was obvious).
4904 \begin_layout Itemize
4906 \change_inserted 564990737 1670794716
4912 \begin_inset space ~
4924 \begin_inset space ~
4929 dialog: leave it set to
4934 The whole layout is done by the macros, you shouldn't change anything.
4937 \begin_layout Subsubsection
4939 \change_inserted 564990737 1670794716
4945 \begin_layout Standard
4947 \change_inserted 564990737 1670794716
4950 First thing to enter is the header information.
4951 It consists of five entries, of which one is optional.
4955 \begin_layout Itemize
4957 \change_inserted 564990737 1670794716
4966 \begin_layout Itemize
4968 \change_inserted 564990737 1670794716
4977 \begin_layout Itemize
4979 \change_inserted 564990737 1670794716
4988 \begin_layout Itemize
4990 \change_inserted 564990737 1670794716
4999 \begin_layout Itemize
5001 \change_inserted 564990737 1670794716
5010 Received: <date>; Accepted <date>
5013 \begin_layout Standard
5015 \change_inserted 564990737 1670794716
5018 Although the order of the single header entries doesn't matter it is advised
5019 to keep the above sequence, just to get the best optics and meets the layout
5020 of the real document.
5023 \begin_layout Standard
5025 \change_inserted 564990737 1670794716
5028 If you want to place footnotes in the header block, e.
5029 \begin_inset space \thinspace{}
5033 \begin_inset space \space{}
5036 to state your present address, just use the standard footnote via the menu
5042 nsert\SpecialChar menuseparator
5051 will automagically use the term
5060 \begin_layout Standard
5062 \change_inserted 564990737 1670794716
5065 In addition to these topics, the macros use three additional \SpecialChar LaTeX
5067 have no counterpart in \SpecialChar LyX
5071 \begin_layout Itemize
5073 \change_inserted 564990737 1670794716
5081 to separate different names for more than one author and institute, respectivel
5085 \begin_layout Itemize
5087 \change_inserted 564990737 1670794716
5095 to mark corresponding author/institute pairs.
5096 The institutes are numbered sequentially as they appear in the
5100 field, so you have to put a marker to each author.
5103 \begin_layout Itemize
5105 \change_inserted 564990737 1670794716
5113 to supply an email address for fast contact.
5116 \begin_layout Standard
5118 \change_inserted 564990737 1670794716
5121 In all cases, the appropriate command has to be entered as \SpecialChar TeX
5122 code in \SpecialChar LyX
5124 See the examples in the template and in the file
5136 \begin_layout Subsubsection
5138 \change_inserted 564990737 1670794716
5144 \begin_layout Standard
5146 \change_inserted 564990737 1670794716
5149 The abstract should immediately follow the header block and must contain
5159 \begin_layout Enumerate
5161 \change_inserted 564990737 1670794716
5167 (optional) {} leave it empty if necessary
5170 \begin_layout Enumerate
5172 \change_inserted 564990737 1670794716
5181 \begin_layout Enumerate
5183 \change_inserted 564990737 1670794716
5192 \begin_layout Enumerate
5194 \change_inserted 564990737 1670794716
5203 \begin_layout Enumerate
5205 \change_inserted 564990737 1670794716
5211 (optional) {} leave it empty if necessary
5214 \begin_layout Standard
5216 \change_inserted 564990737 1670794716
5220 This structure not shown in
5227 \begin_layout Subsubsection
5229 \change_inserted 564990737 1670794716
5232 Supported environments
5235 \begin_layout Standard
5237 \change_inserted 564990737 1670794716
5240 The A&A paper layout supports the following environments for structuring
5244 \begin_layout Itemize
5246 \change_inserted 564990737 1670794716
5253 \begin_layout Itemize
5255 \change_inserted 564990737 1670794716
5262 \begin_layout Itemize
5264 \change_inserted 564990737 1670794716
5271 \begin_layout Itemize
5273 \change_inserted 564990737 1670794716
5280 \begin_layout Itemize
5282 \change_inserted 564990737 1670794716
5289 \begin_layout Itemize
5291 \change_inserted 564990737 1670794716
5298 \begin_layout Itemize
5300 \change_inserted 564990737 1670794716
5307 \begin_layout Itemize
5309 \change_inserted 564990737 1670794716
5316 \begin_layout Itemize
5318 \change_inserted 564990737 1670794716
5325 \begin_layout Itemize
5327 \change_inserted 564990737 1670794716
5334 \begin_layout Itemize
5336 \change_inserted 564990737 1670794716
5343 \begin_layout Itemize
5345 \change_inserted 564990737 1670794716
5353 \begin_layout Subsubsection
5355 \change_inserted 564990737 1670794716
5358 Commands not supported by \SpecialChar LyX
5362 \begin_layout Standard
5364 \change_inserted 564990737 1670794716
5367 Some commands are not yet supported by the
5371 layout for \SpecialChar LyX
5373 Some have already been mentioned.
5374 For the sake of completeness, they are listed all together here:
5377 \begin_layout Itemize
5379 \change_inserted 564990737 1670794716
5388 \begin_layout Itemize
5390 \change_inserted 564990737 1670794716
5399 \begin_layout Itemize
5401 \change_inserted 564990737 1670794716
5410 \begin_layout Itemize
5412 \change_inserted 564990737 1670794716
5421 \begin_layout Itemize
5423 \change_inserted 564990737 1670794716
5432 \begin_layout Standard
5434 \change_inserted 564990737 1670794716
5437 If you want to use any of these commands, you have to enter them yourself.
5440 Do not forget to use
5446 nsert\SpecialChar menuseparator
5449 \begin_inset space ~
5458 \begin_layout Subsubsection
5460 \change_inserted 564990737 1670794716
5463 Figure and Table Floats
5466 \begin_layout Standard
5468 \change_inserted 564990737 1670794716
5472 provides support for the necessary float environments
5474 figure, figure*, table
5480 , therefore we won't tell much about it here.
5484 \begin_inset space ~
5490 Just remember that tables should be left-aligned.
5491 For that, select the table and change the alignment in
5496 dit\SpecialChar menuseparator
5502 \begin_inset space ~
5508 \begin_layout Standard
5510 \change_inserted 564990737 1670794716
5513 There is only one special thing: the figures with a caption beside the figure.
5514 To create such a figure, you have to do the following:
5517 \begin_layout Enumerate
5519 \change_inserted 564990737 1670794716
5522 Create a wide figure float:
5527 nsert\SpecialChar menuseparator
5532 t\SpecialChar menuseparator
5535 , then, from within the float, use the menu
5540 dit\SpecialChar menuseparator
5546 \begin_inset space ~
5557 \begin_inset space ~
5569 \begin_layout Enumerate
5571 \change_inserted 564990737 1670794716
5574 Enter your caption text.
5577 \begin_layout Enumerate
5579 \change_inserted 564990737 1670794716
5586 to move the cursor above the caption.
5589 \begin_layout Enumerate
5591 \change_inserted 564990737 1670794716
5597 \begin_layout Enumerate
5599 \change_inserted 564990737 1670794716
5602 Position the cursor after the figure and insert a horizontal fill by using
5608 nsert\SpecialChar menuseparator
5613 rmatting\SpecialChar menuseparator
5619 \begin_inset space ~
5628 dialog and select the
5642 \begin_layout Enumerate
5644 \change_inserted 564990737 1670794716
5647 Switch to \SpecialChar LaTeX
5651 \begin_inset space ~
5659 \begin_layout Enumerate
5661 \change_inserted 564990737 1670794716
5672 Do not close the brace!
5675 \begin_layout Enumerate
5677 \change_inserted 564990737 1670794716
5680 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
5685 \begin_inset space ~
5697 \begin_layout Standard
5699 \change_inserted 564990737 1670794716
5702 Also, refer to the figures in the file
5713 \begin_layout Subsubsection
5715 \change_inserted 564990737 1670794716
5721 \begin_layout Standard
5723 \change_inserted 564990737 1670794716
5726 For submission, the paper has to be formatted in a special double-spacing
5728 For this purpose, you have to add the option
5739 \begin_inset space ~
5749 ocument\SpecialChar menuseparator
5754 ettings\SpecialChar menuseparator
5756 \begin_inset space ~
5765 \begin_layout Subsubsection
5767 \change_inserted 564990737 1670794716
5773 \begin_layout Standard
5775 \change_inserted 564990737 1670794716
5782 was written with \SpecialChar LyX
5784 It is the example paper from the original macro package,
5789 \begin_inset CommandInset href
5792 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
5797 , but translated to \SpecialChar LyX
5798 using the older unstructured abstract type.
5799 Use it for inspiration, and compare the \SpecialChar LaTeX
5804 with the \SpecialChar LyX
5808 \begin_layout Subsection
5813 \begin_layout Standard
5819 \begin_layout Subsubsection
5823 \begin_layout Standard
5825 is a set of macros produced by the American Astronomical Society to
5826 facilitate electronic manuscript submission to the three journals they
5827 publish: the Astrophysical Journal (including the Letters and Supplement),
5828 the Astronomical Journal, and the Publications of the Astronomical Society
5831 has proven to be an excellent tool for generating these documents, especially
5832 given its equation, citation, and figure handling capabilities.
5834 requires version 5.0 (or higher) of these macros; preferably 6.0, which
5835 is the version described here, or higher.
5836 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
5837 2.09 and are fundamentally
5838 incompatible with \SpecialChar LyX
5840 The AAS\SpecialChar TeX
5841 package may be downloaded from the AAS\SpecialChar TeX
5845 \begin_layout Standard
5846 \begin_inset VSpace medskip
5852 \begin_layout Standard
5854 \begin_inset Flex URL
5857 \begin_layout Plain Layout
5859 https://aas.org/aastex/aastex-downloads
5867 \begin_layout Standard
5868 \begin_inset VSpace medskip
5874 \begin_layout Standard
5875 A complete user guide is contained in that package and you should familiarize
5876 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
5879 will not reduce the need to figure out all the AAS\SpecialChar TeX
5880 commands, it will only
5881 reduce the drudgery of typing everything in.
5882 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
5884 completely to the requirements of the journal to which you are submitting
5888 \begin_layout Subsubsection
5889 Starting a New Paper
5892 \begin_layout Standard
5893 I strongly suggest that you start with the AAS\SpecialChar TeX
5897 File\SpecialChar menuseparator
5904 , enter the new file name, then choose the
5909 This will show the most common fields found in a manuscript.
5910 Simply overwrite the existing text (including the brackets,
5914 ) with the correct information.
5915 Many of the AAS\SpecialChar TeX
5916 commands and environments can be implemented directly in
5919 For commands such as these, the \SpecialChar LaTeX
5920 code must be entered directly and marked
5922 Such commands are referred to as \SpecialChar TeX
5923 code, or Evil Red Text.
5924 I tried to minimize the amount of \SpecialChar TeX
5925 code needed in an AAS\SpecialChar TeX
5929 \begin_layout Subsubsection
5930 Finishing Your Paper
5933 \begin_layout Standard
5934 When the paper is finished to your satisfaction and previews/prints correctly,
5936 \begin_inset Quotes eld
5940 \begin_inset Quotes erd
5943 actions which need to be done before you submit it to the journals.
5947 \begin_layout Enumerate
5948 Export your paper as a \SpecialChar LaTeX
5951 File\SpecialChar menuseparator
5952 Export\SpecialChar menuseparator
5960 \begin_layout Enumerate
5965 file with your favorite text editor
5969 \begin_layout Enumerate
5970 remove the comment lines before the
5979 \begin_layout Enumerate
5984 usepackage...{fontenc}
5986 line if it appears (usually just after
6001 \begin_layout Enumerate
6002 remove everything between (and including) the
6014 commands, except for any commands you specifically put into the \SpecialChar LaTeX
6016 (which should appear immediately after the
6017 \begin_inset Quotes eld
6020 User specified \SpecialChar LaTeX
6022 \begin_inset Quotes erd
6033 \begin_layout Enumerate
6034 Run the resulting file through \SpecialChar LaTeX
6035 to make sure it still processes correctly.
6038 \begin_layout Enumerate
6039 Reread the journal requirements to make sure your filenames and formats
6043 \begin_layout Enumerate
6047 \begin_layout Subsubsection
6048 Comments On Specific Commands
6051 \begin_layout Standard
6052 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
6059 ) gives a good description of each.
6060 Thus it's probably easiest for me to go down the list as found in the guide
6061 and offer comments where necessary.
6062 So let's begin \SpecialChar ldots
6066 \begin_layout Paragraph
6067 Things that work as expected
6070 \begin_layout Standard
6071 Because they work as you might expect, I simply list them and the section
6172 begin{thebibliography}
6180 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6181 graphicx figure commands (2.14.1),
6205 (2.15.4, amongst other places),
6232 \begin_layout Standard
6233 The following style options also work correctly:
6254 Simply put them in the
6260 Layout\SpecialChar menuseparator
6266 \begin_layout Paragraph
6267 Things that work, but require more comment
6270 \begin_layout Standard
6271 The following items work, but require a little more discussion:
6274 \begin_layout Itemize
6275 These items are reserved for use by the journal editors, but you can put
6276 them into the \SpecialChar LaTeX
6277 preamble if you feel compelled to do so:
6310 \begin_layout Itemize
6311 These items may be placed in the \SpecialChar LaTeX
6312 preamble, and are included as blanks in
6334 \begin_layout Itemize
6341 (2.3) – can only be used
6342 \begin_inset Quotes eld
6346 \begin_inset Quotes erd
6349 , not in the middle of a paragraph.
6350 Use \SpecialChar TeX
6351 code if you need to embed it.
6354 \begin_layout Itemize
6361 (2.3) – will have extra {} after it.
6362 This should not cause an error.
6365 \begin_layout Itemize
6372 (2.6) – can only be used
6373 \begin_inset Quotes eld
6377 \begin_inset Quotes erd
6380 , not in the middle of a paragraph.
6381 Use \SpecialChar TeX
6382 code if you need to embed it.
6385 \begin_layout Itemize
6392 (2.8) – can't insert a cross-reference tag, you must type the tag name by
6396 \begin_layout Itemize
6410 \begin_layout Itemize
6417 (2.9) – will have extra {} after it.
6418 This should not cause an error.
6421 \begin_layout Itemize
6428 (2.11) – will have extra {} after it.
6429 This should not cause an error.
6432 \begin_layout Itemize
6439 (2.14.2) – you can insert an optional filename argument by placing the cursor
6440 at the beginning of the text and selecting
6442 Insert\SpecialChar menuseparator
6447 \begin_inset Quotes eld
6451 \begin_inset Quotes erd
6454 inserts an optional argument of the type needed by
6461 Hopefully it will be renamed someday.
6464 \begin_layout Itemize
6477 for the catalog ID optional parameter
6480 \begin_layout Itemize
6493 for the catalog ID optional parameter
6496 \begin_layout Paragraph
6497 Things not implemented, use \SpecialChar TeX
6501 \begin_layout Standard
6512 setcounter{equation}
6514 (2.12), Journal name abbreviations (2.13.4),
6550 (2.15.4, insert it as the first element in the lefthand cell after where
6552 Don't use any of \SpecialChar LyX
6553 's rules in the table),
6565 (2.15.5), much of Misc (2.17, except
6616 \begin_layout Paragraph
6617 Things that cannot be implemented
6620 \begin_layout Standard
6622 at least in any meaningful sort of way, so I suggest ignoring them.
6623 They are the references environment (2.13.3), and the deluxetable environment
6625 If you really, really need to use deluxetable, I suggest editing it in
6626 a separate file with a text editor, then using
6628 Insert\SpecialChar menuseparator
6630 \begin_inset space ~
6635 to include it in your \SpecialChar LyX
6641 file to see an example of this.
6644 \begin_layout Subsubsection
6645 FAQs, Tips, Tricks, and Other Ruminations
6648 \begin_layout Paragraph
6649 Getting \SpecialChar LyX
6650 and AAS\SpecialChar TeX
6654 \begin_layout Standard
6655 It can be a bit tricky to get \SpecialChar LyX
6656 to recognize a new layout and document class.
6657 When all else fails, do this:
6660 \begin_layout Enumerate
6661 Make certain that \SpecialChar LaTeX
6662 can find AAS\SpecialChar TeX
6664 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
6666 directory completely unrelated to \SpecialChar LaTeX
6667 or AAS\SpecialChar TeX
6668 and run \SpecialChar LaTeX
6676 \begin_layout Enumerate
6681 appears in \SpecialChar LyX
6689 \begin_layout Enumerate
6692 Tools\SpecialChar menuseparator
6696 , then restart \SpecialChar LyX
6700 \begin_layout Enumerate
6701 Open a regular new file, not from a template.
6702 Does AAS\SpecialChar TeX
6703 appear in the class list in
6705 Document\SpecialChar menuseparator
6711 \begin_layout Standard
6712 If you get a warning from an existing AAS\SpecialChar TeX
6713 document about not being able
6714 to find the AAS\SpecialChar TeX
6715 layout or a message about
6716 \begin_inset Quotes eld
6719 You should not mix title layouts with normal ones
6720 \begin_inset Quotes erd
6723 , things haven't been installed correctly.
6726 \begin_layout Paragraph
6728 error processing a table
6731 \begin_layout Standard
6733 , by default, attempts to center the table caption/title.
6734 This seems to produce a bad interaction in AAS\SpecialChar TeX
6735 so you should click somewhere
6736 in the caption/title, then select
6738 Edit\SpecialChar menuseparator
6740 \begin_inset space ~
6754 This took care of it for me.
6757 \begin_layout Paragraph
6761 \begin_layout Standard
6762 A couple of things: 1) I have noticed some funny spacing in the reference
6763 entries in the text.
6764 When you enter the bibliography item data, make sure their is
6768 space between the last author and the parenthesis setting off the year;
6772 \begin_inset space \thinspace{}
6776 \begin_inset space \space{}
6790 2) Entering the references at all is not obvious.
6791 The easiest thing is to start typing your first reference at the end of
6792 the document, then mark it as type
6797 That will put a small gray box in front of what you just typed.
6798 Click on the box to fill in the rest of the information.
6799 For new references, go to the end of an existing reference and press return.
6800 That will create a new line with its own box, etc.
6803 \begin_layout Paragraph
6807 \begin_layout Standard
6808 Even though AAS\SpecialChar TeX
6809 provides its own figure commands (
6815 , for example), I much prefer \SpecialChar LaTeX
6816 's standard figure commands (with the default
6825 \begin_inset space ~
6828 commands as \SpecialChar TeX
6829 code into a Figure Float box if you desire, but I never have
6830 much luck getting the layout right.
6831 With the standard graphics, \SpecialChar LyX
6836 usepackage{graphicx}
6838 command into the \SpecialChar LaTeX
6839 preamble and handle the figures in the standard \SpecialChar LaTeX2e
6841 interspersing the figures in the text.
6842 I believe ApJ accepts figures exactly this way now; AJ might still use
6844 \begin_inset Quotes eld
6847 stack everything at the end
6848 \begin_inset Quotes erd
6854 \begin_layout Paragraph
6855 Things I could have done, but didn't
6858 \begin_layout Standard
6860 \begin_inset Quotes eld
6864 \begin_inset Quotes erd
6867 things I could have implemented, but chose not to.
6868 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
6870 even though it is double-spaced in the paper manuscript.
6871 Also, I chose not to make separate layouts for the preprint and preprint2
6873 Since I assume you will spend most of your time in the plain manuscript
6874 mode anyway, I decided not to chew up more disk space with this.
6878 \begin_layout Subsubsection
6882 \begin_layout Standard
6883 Your mileage may vary.
6884 I've now had papers published by both ApJ and AJ that have had 98% of the
6885 effort done in \SpecialChar LyX
6886 ; the last 2% was the \SpecialChar LaTeX
6887 post-processing and a few cleanups.
6888 I have had no trouble with the submission process, and I'm sure the journals
6889 were never aware that there might be a difference.
6890 So, go forth and publish!
6893 \begin_layout Subsection
6895 \change_inserted 564990737 1671042028
6901 \begin_layout Standard
6903 \change_inserted 564990737 1671042028
6909 \begin_inset space \thinspace{}
6919 This provides the following additional environments:
6922 \begin_inset space ~
6930 \begin_inset space ~
6938 \begin_inset space ~
6961 is available in the menu
6966 ile\SpecialChar menuseparator
6968 \begin_inset space ~
6976 \begin_inset space ~
6982 It has been customized with further environments and contains all the informati
6984 However, the documentation is also available from
6985 \begin_inset CommandInset href
6988 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
6996 \begin_layout Subsection
6998 \change_inserted 564990737 1671042046
7004 \begin_layout Standard
7006 \change_inserted 564990737 1671042046
7012 \begin_inset space \thinspace{}
7017 provides an alternative to the
7022 It provides similar functionality, but you might prefer this layout with
7023 sans serif sections, headings, and more.
7026 \begin_layout Subsection
7031 \begin_layout Standard
7037 \begin_layout Standard
7038 \begin_inset VSpace bigskip
7044 \begin_layout Standard
7049 \begin_inset space ~
7054 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
7056 \begin_inset Formula $\beta$
7059 release of May, 1999) class.
7062 \begin_layout Standard
7068 textclass, which works with Rev\SpecialChar TeX
7070 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
7072 That means that it doesn't interact very well with \SpecialChar LyX
7073 , which requires \SpecialChar LaTeX2e
7075 it has been kludged to work.
7076 Since Rev\SpecialChar TeX
7077 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
7084 \begin_inset space ~
7089 textclass should also be pretty easy to use.
7092 \begin_layout Standard
7093 These documents are supposed to be used in
7097 to the Rev\SpecialChar TeX
7098 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
7100 and assume you'll know what to put in the preamble if necessary.
7103 \begin_layout Subsubsection
7107 \begin_layout Standard
7108 All you need to do is install Rev\SpecialChar TeX
7109 4, as described in the package's README
7111 The package can be found at The Rev\SpecialChar TeX
7113 \begin_inset Flex URL
7116 \begin_layout Plain Layout
7118 http://publish.aps.org/revtex4/
7124 Install it somewhere that \SpecialChar LaTeX
7126 Test it by trying to \SpecialChar LaTeX
7127 a short Rev\SpecialChar TeX
7128 4 document in some random directory (i.
7129 \begin_inset space \thinspace{}
7133 \begin_inset space \space{}
7136 not the directory where you installed the class file.) Then, if you reconfigure
7138 , it will find the class file and let you use the Rev\SpecialChar TeX
7142 \begin_layout Standard
7143 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
7152 \begin_inset space ~
7157 template, found in the templates directory.
7160 \begin_layout Subsubsection
7164 \begin_layout Standard
7165 Optional arguments to
7172 \begin_inset Quotes eld
7176 \begin_inset Quotes erd
7180 \begin_inset Quotes eld
7184 \begin_inset Quotes erd
7190 \begin_inset space ~
7198 \begin_inset space ~
7204 Remember that in Rev\SpecialChar TeX
7205 , at least one optional argument is required!
7208 \begin_layout Standard
7209 Other preamble matter, like
7216 \begin_inset space ~
7223 \begin_inset space ~
7228 dialog, also as usual.
7231 \begin_layout Subsubsection
7235 \begin_layout Standard
7236 The layouts basically correspond to the commands in Rev\SpecialChar TeX
7238 For example, the Email layout corresponds to
7245 Note that (at least as of Rev\SpecialChar TeX
7254 layouts are exactly equivalent, so you shouldn't need to use both.
7258 \begin_layout Plain Layout
7259 In case you're curious, both were included so that
7263 would be able to translate both
7283 \begin_layout Subsubsection
7287 \begin_layout Standard
7288 There are a couple of important unique aspects of Rev\SpecialChar TeX
7290 bugs that will be even more confusing in \SpecialChar LyX
7294 \begin_layout Standard
7295 In Rev\SpecialChar TeX
7313 The \SpecialChar LyX
7314 equivalent is that there is a separate Thanks layout.
7319 write footnotes in the
7323 layout, or weird things may happen.
7324 See the Rev\SpecialChar TeX
7325 4 documentation for more details.
7328 \begin_layout Standard
7332 \begin_inset space ~
7340 \begin_inset space ~
7349 layouts must be placed
7357 layout and the corresponding
7374 , the \SpecialChar LaTeX
7378 \begin_layout Subsection
7380 \change_inserted 564990737 1671042072
7386 \begin_layout Standard
7388 \change_inserted 564990737 1671042072
7395 classes were replaced in 2013 with a completely new
7400 This package provides a \SpecialChar LaTeX
7401 class and templates for books to be published
7402 at Springer Gabler Research, Springer Vieweg Research, Springer Spektrum
7403 Research, Springer VS Research, or Springer VS Forschung.
7404 The documentation is available in German from
7405 \begin_inset CommandInset href
7408 target "http://mirrors.ctan.org/macros/latex/contrib/springer/sr-vorl/sr-vorl.pdf"
7416 \begin_layout Section
7418 \change_inserted 564990737 1670439560
7422 \begin_layout Standard
7424 \change_inserted 564990737 1670439581
7425 See also the document classes in the Collections (section
7426 \begin_inset space ~
7430 \begin_inset CommandInset ref
7432 reference "sec:Collections"
7439 \begin_layout Subsection
7443 \begin_layout Standard
7449 \begin_layout Subsubsection
7453 \begin_layout Standard
7454 Memoir is a very powerful and constantly evolving class.
7455 It has been designed with regard to fictional and non-fictional literature.
7456 Its aim is to let the user have maximum control over the typesetting of
7458 Memoir is based on the standard book class, but it can also emulate the
7459 article class (see below).
7462 \begin_layout Standard
7463 Peter Wilson, the developer of Memoir, is known as the author of lots of
7464 useful packages in the \SpecialChar LaTeX
7466 Most of them have been merged with Memoir.
7467 Therefore, it is much easier to layout the table of contents, appendices,
7468 chapter designs and such.
7470 , though, does not support all of these goodies natively.
7471 Some of them might be added to forthcoming releases
7475 \begin_layout Plain Layout
7476 You are invited to send suggestions to
7477 \begin_inset Flex URL
7480 \begin_layout Plain Layout
7482 lyx-devel@lists.lyx.org
7492 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
7494 Of course you can still use all features with the help of some native \SpecialChar LaTeX
7496 commands (\SpecialChar TeX
7501 \begin_layout Plain Layout
7506 \begin_layout Plain Layout
7516 \begin_inset space ~
7520 \begin_inset CommandInset ref
7522 reference "sec:Inserting-TeX-Code"
7532 In this section, we can only list those features that are natively supported
7535 For detailed descriptions (and for the rest of features) we recommend you
7536 have a look at the detailed manual of the Memoir class
7540 \begin_layout Plain Layout
7545 \begin_layout Plain Layout
7555 \begin_inset Flex URL
7558 \begin_layout Plain Layout
7560 CTAN:/macros/latex/memoir/memman.pdf
7570 , which is not only a user guide for the class, but also both a comprehensive
7571 description on good typesetting and a superb example for good typesetting
7575 \begin_layout Subsubsection
7576 Basic features and restrictions
7579 \begin_layout Standard
7580 Memoir supports basically all features of the standard book classes.
7581 There are, however, some differences, as follows:
7584 \begin_layout Description
7586 \begin_inset space ~
7589 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
7592 \begin_layout Description
7594 \begin_inset space ~
7597 style: The fancy page style is not supported, due to a command clash between
7598 Memoir and the fancyhdr package (they both define a command with the same
7599 name, which confuses \SpecialChar LaTeX
7601 Instead, Memoir comes with a number of its own page styles (see
7603 Document\SpecialChar menuseparator
7604 Settings\SpecialChar menuseparator
7606 \begin_inset space ~
7612 If you want to use these for the chapter pages, you have to use the command
7619 in the main text or in preamble (e.
7620 \begin_inset space \thinspace{}
7624 \begin_inset space \space{}
7631 chapterstyle{companion}
7636 \begin_layout Description
7637 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
7638 optional argument in the standard classes.
7639 With this, you can specify an alternative version of the title for the
7640 table of contents and the headers (for instance, if the title is too long).
7642 , you can do this via
7644 Insert\SpecialChar menuseparator
7646 \begin_inset space ~
7651 at the beginning of a chapter/section.
7652 Memoir features a second optional argument and thus separates the table
7653 of contents from the header.
7654 You can define three variants of a title with this: one for the main text,
7655 one for the table of contents, and one for the headers.
7657 makes these available in form of specific
7668 \begin_layout Description
7669 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
7670 of contents, the list of figures and the list of table start a new page
7672 Memoir does not follow this route.
7673 You have to insert a page break yourself, if you want to have one.
7676 \begin_layout Description
7677 Titlepage: For some unknown reason, Memoir uses pagination on the title
7678 page (in the standard classes, title pages are
7679 \begin_inset Quotes eld
7683 \begin_inset Quotes erd
7687 If you want an empty title page, type
7691 aliaspagestyle{title}{empty}
7696 \begin_layout Description
7697 Article: With the class option
7703 Document\SpecialChar menuseparator
7704 Settings\SpecialChar menuseparator
7705 Class Settings\SpecialChar menuseparator
7707 \begin_inset space ~
7712 ), you can emulate article style.
7713 That is, counters (footnotes, figures, tables etc.) will not be reset on
7714 new chapters, chapters don't start a new page (but are—in contrary to
7715 \begin_inset Quotes eld
7719 \begin_inset Quotes erd
7722 article classes—still allowed), parts, though, use their own page, as in
7726 \begin_layout Description
7727 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
7728 font commands, which have been used in the old \SpecialChar LaTeX
7730 \begin_inset space \thinspace{}
7734 \begin_inset space \space{}
7750 It produces an error and stops \SpecialChar LaTeX
7751 whenever such a command appears.
7756 reallows the commands and spits out warnings instead (which does at least
7757 not stop \SpecialChar LaTeX
7759 Since a lot of packages and particularly Bib\SpecialChar TeX
7760 style files are still using
7761 those commands, we have decided to use this option by default.
7764 \begin_layout Subsubsection
7768 \begin_layout Standard
7769 We will only describe the features supported by \SpecialChar LyX
7770 (which is not much currently).
7771 Please consult the Memoir manual
7775 \begin_layout Plain Layout
7780 \begin_layout Plain Layout
7790 \begin_inset Flex URL
7793 \begin_layout Plain Layout
7795 CTAN:/macros/latex/memoir/memman.pdf
7808 \begin_layout Description
7809 Abstract: You may wonder why an abstract is an extra feature.
7810 Well, it is in book class.
7811 Usually books don't have abstracts.
7812 Memoir, however, has.
7813 You can use it wherever and how often you like.
7816 \begin_layout Description
7817 Chapterprecis: You may know this older typesetting style: The contents of
7818 a chapter are summarized below the title and also in the table of contents
7820 \begin_inset space \thinspace{}
7824 \begin_inset space \space{}
7829 Our hero arrives in Troia; he loses some friends; he finds others
7832 Chapterprecis does exactly this.
7833 It is therefore only sensible below a chapter.
7836 \begin_layout Description
7837 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
7838 The epigraph environment provides an elegant way of typesetting such a
7840 The motto itself (text) and its (optional) author (source) are divided
7842 The author (source) can be inserted via
7844 Insert\SpecialChar menuseparator
7851 \begin_layout Description
7852 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
7853 complex figurative poems).
7855 can only support a few of them.
7856 One is poemtitle, which is a centered title for poems, which will also
7857 be added to the table of contents (verse is the standard environment for
7859 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
7861 because they have to be nested inside regular verse environments, which
7862 is not possible with \SpecialChar LyX
7866 \begin_layout Description
7867 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
7870 \begin_layout Section
7872 \change_inserted 564990737 1670439605
7876 \begin_layout Section
7878 \change_inserted 564990737 1671041968
7882 \begin_layout Subsection
7884 \change_inserted 564990737 1671041970
7890 \begin_layout Standard
7892 \change_inserted 564990737 1671041970
7903 document class for writing letters according to the
7905 Deutsches Institut für Normung
7917 ile\SpecialChar menuseparator
7919 \begin_inset space ~
7927 \begin_inset space ~
7932 offers guidance on its use.
7933 The documentation is available from
7934 \begin_inset CommandInset href
7937 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
7945 \begin_layout Section
7947 \change_inserted 564990737 1670439660
7951 \begin_layout Subsection
7954 Foil\SpecialChar TeX
7958 \begin_inset CommandInset label
7967 \begin_layout Standard
7973 \begin_layout Subsubsection
7977 \begin_layout Standard
7978 This section describes how to use \SpecialChar LyX
7979 to make slides for overhead projectors.
7980 There are two document classes that can do this: the default slides class
7983 Foil\SpecialChar TeX
7987 This section documents the latter.
7990 \begin_layout Standard
7991 I'm going to say this again, nice and clear, so that there's no misunderstanding
7995 \begin_layout Standard
7996 \begin_inset VSpace bigskip
8002 \begin_layout Standard
8006 This section documents the class
8007 \begin_inset Quotes eld
8015 \begin_inset Quotes erd
8023 \begin_layout Standard
8024 \begin_inset VSpace bigskip
8030 \begin_layout Standard
8031 If you're looking for the documentation for
8032 \begin_inset Quotes eld
8040 \begin_inset Quotes erd
8044 \begin_inset space ~
8048 \begin_inset CommandInset ref
8050 reference "sec:slitex"
8055 If your machine doesn't have the
8063 installed, you'll probably have to use the default
8067 class, which isn't quite as good as
8072 \begin_layout Standard
8077 class is designed for use with version
8078 \begin_inset space ~
8086 class file which is now an integral part of \SpecialChar LaTeX2e
8090 \begin_layout Subsubsection
8094 \begin_layout Standard
8095 Obviously, to use this document class, you need to select
8106 \begin_inset space ~
8112 There are some settings in the
8115 \begin_inset space ~
8120 dialog that you should know about that are specific to this class:
8123 \begin_layout Itemize
8124 Don't change the options
8135 \begin_inset space ~
8141 They're ignored by the
8148 \begin_layout Itemize
8149 The default font size is 20
8150 \begin_inset space \thinspace{}
8153 pt with the other options being 17
8154 \begin_inset space \thinspace{}
8158 \begin_inset space \thinspace{}
8162 \begin_inset space \thinspace{}
8168 \begin_layout Itemize
8177 but all math equations are still typeset in the usual roman font.
8180 \begin_layout Itemize
8183 Foil\SpecialChar TeX
8186 supports A4 and Letter paper sizes as well as a special size for working
8188 \begin_inset space \thinspace{}
8192 It doesn't support A5, B5, legal or executive paper sizes.
8195 \begin_layout Itemize
8196 Don't bother changing the
8200 settings because they are ignored anyway.
8201 All floats appear where they are defined in the text.
8204 \begin_layout Itemize
8209 setting behaves a bit differently for this class.
8212 Foil\SpecialChar TeX
8215 provides extensive footer and header capabilities including a user-defined
8218 \begin_inset space ~
8222 \begin_inset CommandInset ref
8224 reference "sec:foilfoot"
8229 The title page is treated differently to all other pages in the document
8238 has the logo centered at the bottom of the page (if one is defined).
8239 The possible page style choices and what they do are as follows:
8243 \begin_layout Labeling
8244 \labelwidthstring MMMMMMM
8251 The final output contains no page numbers, or other headers or footers
8252 (except footnotes of course).
8256 \begin_layout Labeling
8257 \labelwidthstring MMMMMMM
8264 The final output contains page numbers centered at the bottom of the page.
8265 No other headings or footers (other than footnotes).
8268 \begin_layout Labeling
8269 \labelwidthstring MMMMMMM
8274 Page numbers in lower right corner.
8275 Additional headers and footers are also shown.
8276 This is also the default.
8279 \begin_layout Labeling
8280 \labelwidthstring MMMMMMM
8285 Gives you access to the
8289 package although its use with
8291 Foil\SpecialChar TeX
8294 is discouraged by the writer of the
8296 Foil\SpecialChar TeX
8299 package because of some potential page layout clashes.
8303 \begin_layout Paragraph
8307 \begin_layout Standard
8308 The following options may be used in the extra class options in the
8310 Document\SpecialChar menuseparator
8316 \begin_layout Labeling
8317 \labelwidthstring MMMMMMx
8322 This sets up the page layout for 7.33
8323 \begin_inset space \thinspace{}
8327 \begin_inset space \thinspace{}
8330 in paper, which is about the same aspect ratio as a 35
8331 \begin_inset space \thinspace{}
8334 mm slide, making it a bit easier to work with this medium.
8337 \begin_layout Labeling
8338 \labelwidthstring MMMMMMx
8343 Places a rule across the page below the header on every page except the
8347 \begin_layout Labeling
8348 \labelwidthstring MMMMMMx
8353 Places a rule across the page above the footer on every page except the
8357 \begin_layout Labeling
8358 \labelwidthstring MMMMMMx
8363 This is automatically set each time you create a new
8370 Foil\SpecialChar TeX
8373 to use the dvips driver to rotate those pages that are set as landscape
8377 \begin_layout Labeling
8378 \labelwidthstring MMMMMMx
8383 Simply changes the page dimensions to those of a landscape page but doesn't
8385 Thus if you use this option you need to use an external program to rotate
8386 each page or feed your paper through your printer as landscape.
8387 Note that this option effectively reverses the roles of the
8395 environments (don't worry these are described in the next section).
8398 \begin_layout Labeling
8399 \labelwidthstring MMMMMMx
8404 Equation numbers on the left.
8407 \begin_layout Labeling
8408 \labelwidthstring MMMMMMx
8413 Flush-left equations.
8416 \begin_layout Subsubsection
8417 Supported Environments
8420 \begin_layout Standard
8421 Most of the environments commonly supported in other classes are also supported
8427 There are several additional environments provided by
8429 Foil\SpecialChar TeX
8432 as well as a couple added by \SpecialChar LyX
8434 The following environments are shared with other classes:
8437 \begin_layout Standard
8438 \begin_inset Flex Multiple Columns
8441 \begin_layout Itemize
8447 \begin_layout Itemize
8453 \begin_layout Itemize
8459 \begin_layout Itemize
8465 \begin_layout Itemize
8471 \begin_layout Itemize
8478 \begin_layout Itemize
8484 \begin_layout Itemize
8490 \begin_layout Itemize
8496 \begin_layout Itemize
8502 \begin_layout Itemize
8508 \begin_layout Itemize
8514 \begin_layout Itemize
8520 \begin_layout Itemize
8526 \begin_layout Itemize
8537 \begin_layout Standard
8538 That is, all the major environments apart from the sectioning environments.
8539 Since foils are essentially self-contained sections, with a title and body,
8542 Foil\SpecialChar TeX
8545 provides specific commands for starting new foils and these are:
8548 \begin_layout Itemize
8554 \begin_layout Itemize
8560 \begin_layout Standard
8562 also provides slightly modified versions of these two environments called:
8565 \begin_layout Itemize
8571 \begin_layout Itemize
8577 \begin_layout Standard
8578 and the differences will be explained in the next section.
8581 \begin_layout Standard
8582 Since foils are often used in presenting ideas or new theorems and such
8585 Foil\SpecialChar TeX
8588 also provides a comprehensive box of goodies for presenting them:
8591 \begin_layout Standard
8592 \begin_inset Flex Multiple Columns
8595 \begin_layout Itemize
8601 \begin_layout Itemize
8607 \begin_layout Itemize
8613 \begin_layout Itemize
8619 \begin_layout Itemize
8625 \begin_layout Itemize
8631 \begin_layout Itemize
8637 \begin_layout Itemize
8643 \begin_layout Itemize
8649 \begin_layout Itemize
8655 \begin_layout Itemize
8666 \begin_layout Standard
8667 The starred versions are unnumbered while the unstarred versions are numbered.
8668 There are also two list environments added by \SpecialChar LyX
8672 \begin_layout Itemize
8678 \begin_layout Itemize
8684 \begin_layout Standard
8687 Foil\SpecialChar TeX
8690 provides some powerful header and footer capabilities that are best set
8691 in the preamble although they may be set at any point in a document.
8692 If you want to change these settings in your document the best place to
8693 do so is at the very top of a foil, i.
8694 \begin_inset space \thinspace{}
8700 \begin_inset space \space{}
8705 straight after the foilhead.
8708 \begin_layout Standard
8709 For this purpose, the following command styles are provided [
8716 \begin_layout Standard
8717 \begin_inset Flex Multiple Columns
8720 \begin_layout Itemize
8724 \begin_inset space ~
8730 \begin_layout Itemize
8736 \begin_layout Itemize
8740 \begin_inset space ~
8746 \begin_layout Itemize
8750 \begin_inset space ~
8756 \begin_layout Itemize
8760 \begin_inset space ~
8767 \begin_layout Plain Layout
8768 \begin_inset space ~
8780 \begin_layout Standard
8781 There are also a few commands provided by
8783 Foil\SpecialChar TeX
8786 that aren't directly supported by \SpecialChar LyX
8787 but I'll tell you what they do and how
8788 to use them in section
8789 \begin_inset space ~
8793 \begin_inset CommandInset ref
8795 reference "sec:unsuppfoils"
8802 \begin_layout Subsubsection
8803 Building a Set of Foils
8806 \begin_layout Standard
8807 This section will give a simple introduction to using the different environments
8808 to build a set of foils.
8809 If you want to see an example set of foils, take a look at the
8813 file you find in \SpecialChar LyX
8821 \begin_layout Paragraph
8822 Give It a Title Page
8825 \begin_layout Standard
8826 Unlike other classes that provide
8846 creates the title on a page of its own.
8847 If you leave out the
8851 environment \SpecialChar LaTeX
8852 will substitute the current date (every time you regenerate
8856 \begin_layout Paragraph
8860 \begin_layout Standard
8861 As I mentioned earlier, there are four ways of starting a new foil.
8862 For portrait foils you should use
8871 The difference between these two environments is the amount of space between
8872 the title of the foil (the foilhead) and the body of the foil.
8875 \begin_layout Standard
8876 Landscape foils are generated using the
8885 Again the only difference is the spacing between foilhead and body.
8886 Both of the short versions have 0.5
8887 \begin_inset space ~
8890 inches less separation between the foilhead and the body.
8894 \begin_layout Standard
8895 One problem with the support for landscape foils is the requirement that
8900 driver to generate the PostScript output otherwise the foils won't be rotated.
8901 It is possible to get landscape foils even if you haven't got the
8905 driver provided you can feed your foils sideways through your printer ;-)
8908 \begin_layout Paragraph
8909 Theorems, Lemmas, Proofs and more
8912 \begin_layout Standard
8913 You can't have two of the same type of these environments directly following
8915 If you use a normal paragraph break, , you will just be extending the previous
8916 environment as if you had merged the two environments together.
8917 Rather than that, you need to insert a so-called separator.
8918 Please refer to the section entitled
8929 \begin_layout Paragraph
8933 \begin_layout Standard
8934 You get all the commonly supported list styles found in other classes as
8935 well as two new ones.
8936 I'll only describe the new ones here.
8937 If you want to find out more about the other list environments check out
8943 If you intend to use itemized lists you might also want to read about the
8947 \begin_inset space ~
8951 \begin_inset space ~
8956 dialog described above in section
8957 \begin_inset space ~
8961 \begin_inset CommandInset ref
8963 reference "sec:bullet"
8970 \begin_layout Standard
8971 The two new list styles,
8979 , are designed to make it easier for you to create lists of do's and don'ts
8980 or right and wrong by providing dedicated environments that use a tick
8981 or a cross as the label of the list.
8982 These lists are in fact dedicated variants of the
8987 They do however require that you have the
8994 \begin_layout Paragraph
8998 \begin_layout Standard
9001 Foil\SpecialChar TeX
9004 redefines the floating tables and figures so that they appear exactly where
9005 they are in the text rather than pushing them to the top of the page or
9006 to some user specified location.
9007 In fact if you change the float placement settings they are simply ignored.
9010 \begin_layout Paragraph
9011 Page Headers and Footers
9012 \begin_inset CommandInset label
9021 \begin_layout Standard
9025 \begin_inset space ~
9034 are two commands used to control the left-footer text string.
9035 The first is meant to allow you to include a graphic logo on your foils
9037 \begin_inset Quotes eld
9042 Foil\SpecialChar TeX
9046 \begin_inset Quotes erd
9050 While the second is meant to provide a classification for the audience,
9054 \begin_inset space \thinspace{}
9060 \begin_inset space \space{}
9064 It is empty by default.
9067 \begin_layout Standard
9068 The remaining page corners can be filled by
9071 \begin_inset space ~
9076 (which defaults to page numbers),
9079 \begin_inset space ~
9087 \begin_inset space ~
9095 \begin_layout Subsubsection
9098 Foil\SpecialChar TeX
9102 \begin_inset CommandInset label
9104 name "sec:unsuppfoils"
9111 \begin_layout Standard
9112 All the commands mentioned below need to be set in a
9122 within another environment.
9125 \begin_layout Paragraph
9129 \begin_layout Standard
9130 All lengths are adjusted using the
9153 should be replaced by the name given to the length you want to change and
9158 is the length value.
9159 All lengths should be specified in units of length such as inches (
9171 ) or relative to some document or font-based length such as
9181 \begin_layout Standard
9182 It's possible to change the spacing between a foilhead and the body of the
9183 foil by adjusting the length specified by
9190 For example, to make
9195 \begin_inset space \space{}
9198 in closer to their bodies put the following in the preamble:
9204 foilheadskip}{-0.5in}
9207 \begin_layout Standard
9208 The spacings around floats can be adjusted by setting these lengths:
9211 \begin_layout Labeling
9212 \labelwidthstring MMMMMMMMMMM
9219 Separation between the text and the top of the float
9222 \begin_layout Labeling
9223 \labelwidthstring MMMMMMMMMMM
9230 Separation between the float and the caption
9233 \begin_layout Labeling
9234 \labelwidthstring MMMMMMMMMMM
9241 Separation between the caption and the following text
9244 \begin_layout Labeling
9245 \labelwidthstring MMMMMMMMMMM
9252 You can make the captions narrower than the surrounding text by adjusting
9254 Best done relative to
9263 \begin_layout Standard
9264 There are also several title page related lengths that you may find useful
9265 if you have a long title or several authors:
9268 \begin_layout Labeling
9269 \labelwidthstring MMMMMMMMMMM
9276 Separation from headers to
9281 \begin_layout Labeling
9282 \labelwidthstring MMMMMMMMMMM
9300 \begin_layout Labeling
9301 \labelwidthstring MMMMMMMMMMM
9315 \begin_layout Labeling
9316 \labelwidthstring MMMMMMMMMMM
9332 \begin_layout Labeling
9333 \labelwidthstring MMMMMMMMMMM
9349 \begin_layout Standard
9350 The last length related command affects all the list environments.
9361 a list environment then all the vertical spacing between the list items
9363 Note that this is a command not a length so it doesn't require
9369 like the stuff mentioned above.
9372 \begin_layout Paragraph
9376 \begin_layout Standard
9389 commands control whether the logo in the
9393 definition appear on a given page.
9400 in the preamble then none of the foils will have the logo on them.
9401 If you don't want the logo on a particular page place the
9407 directly after the foilhead of that page and the
9413 directly after the next foilhead.
9416 \begin_layout Standard
9417 If you decide to use the
9421 page style setting in the
9424 \begin_inset space ~
9429 dialog you should probably add
9439 to your preamble so headers and footers on landscape pages are correctly
9440 placed when rotated.
9441 This is due to some clashes between the page layouts provided by the
9452 \begin_layout Subsection
9459 \begin_inset CommandInset label
9468 \begin_layout Standard
9476 \begin_layout Subsubsection
9480 \begin_layout Standard
9481 This section describes how to use \SpecialChar LyX
9482 to make slides for overhead projectors.
9483 There are two document classes that can do this: the default slides class
9486 Foil\SpecialChar TeX
9490 This section documents the former.
9493 \begin_layout Standard
9494 I'm going to say this again, nice and clear, so that there's no misunderstanding
9498 \begin_layout Standard
9499 \begin_inset VSpace bigskip
9505 \begin_layout Standard
9509 This section documents the class
9510 \begin_inset Quotes eld
9518 \begin_inset Quotes erd
9526 \begin_layout Standard
9527 \begin_inset VSpace bigskip
9533 \begin_layout Standard
9534 If you're looking for the documentation for
9535 \begin_inset Quotes eld
9540 slides (Foil\SpecialChar TeX
9544 \begin_inset Quotes erd
9548 \begin_inset space ~
9552 \begin_inset CommandInset ref
9554 reference "sec:foiltex"
9564 \begin_inset Quotes eld
9569 slides (Foil\SpecialChar TeX
9573 \begin_inset Quotes erd
9576 ] is actually somewhat better than the default
9584 \begin_layout Plain Layout
9586 or so I've been told repeatedly by its advocates.
9587 Having never used it, I have no idea if this claim is true or not.
9592 which this section documents.
9595 \begin_layout Standard
9596 This class is the \SpecialChar LaTeX2e
9597 improvement of the old
9603 Every \SpecialChar LaTeX2e
9604 distribution includes this class [which I'll just refer to as
9605 \begin_inset Quotes eld
9613 \begin_inset Quotes erd
9616 from now on], so you're bound to have it.
9617 As I noted earlier, there are other classes, such as
9621 , which also produce slides for overhead projectors and do a better job
9623 However, there are some things which
9627 can do which the others can't, such as generate overlays.
9628 Read on to learn more!
9631 \begin_layout Subsubsection
9633 \begin_inset CommandInset label
9635 name "sec:slidesetup"
9642 \begin_layout Standard
9643 Obviously, to use this document class, you need to select
9644 \begin_inset Quotes eld
9652 \begin_inset Quotes erd
9655 from the class list in the
9657 Document\SpecialChar menuseparator
9661 There are some other special things you should know about this class:
9664 \begin_layout Itemize
9665 Don't bother changing the options
9670 They're not supported by the
9677 \begin_layout Itemize
9681 \begin_inset space ~
9686 behaves a bit differently for this class.
9687 The possible choices and what they do are as follows:
9691 \begin_layout Description
9696 The final output contains page numbers in the lower right corner.
9699 \begin_layout Description
9708 , but also prints out any time markers you've put in.
9709 This is the default.
9712 \begin_layout Description
9717 The final output contains no page numbers, time markers, or alignment markers.
9721 \begin_layout Itemize
9726 class has an extra option:
9732 \begin_inset Quotes eld
9740 \begin_inset Quotes erd
9743 in the extra class options.
9747 \begin_layout Standard
9748 Using this options allows you to add time markers to
9754 \begin_inset space ~
9758 \begin_inset CommandInset ref
9760 reference "sec:slideNote"
9768 \begin_layout Standard
9769 You can also use the template file
9770 \begin_inset Quotes eld
9778 \begin_inset Quotes erd
9781 to automatically set up a document to use the
9787 File\SpecialChar menuseparator
9789 \begin_inset space ~
9793 \begin_inset space ~
9798 to open your new document].
9799 The template file also contains some examples of the special paragraph
9800 environments used by this class.
9801 I'll describe those next.
9804 \begin_layout Subsubsection
9805 Paragraph Environments
9808 \begin_layout Paragraph
9809 Supported Environments
9812 \begin_layout Standard
9813 The first thing you'll notice when you start up a new
9817 document is the font size and type: it's the equivalent of the size
9818 \begin_inset Quotes eld
9826 \begin_inset Quotes erd
9832 \begin_inset space ~
9838 This is also what's used in the output.
9840 \begin_inset Quotes eld
9844 \begin_inset Quotes erd
9847 to remind you that this is a slide.
9848 Your final slides will use a larger font; ergo, you'll have less space.
9849 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
9852 \begin_layout Standard
9853 The next thing that becomes obvious is the changes to the paragraph environment
9854 pull-down box [at the far-left end of the toolbar].
9855 Most of the paragraph environments you're used to seeing are missing.
9856 There are also five new ones.
9861 class itself only supports certain paragraph environments:
9864 \begin_layout Itemize
9870 \begin_layout Itemize
9876 \begin_layout Itemize
9882 \begin_layout Itemize
9888 \begin_layout Itemize
9894 \begin_layout Itemize
9900 \begin_layout Itemize
9906 \begin_layout Itemize
9912 \begin_layout Itemize
9918 \begin_layout Itemize
9925 \begin_layout Standard
9926 All of the other standard environments, including the section-heading environmen
9927 ts, aren't used in the
9934 \begin_layout Standard
9935 On the other hand, you'll notice the following new environments:
9938 \begin_layout Itemize
9944 \begin_layout Itemize
9950 \begin_layout Itemize
9956 \begin_layout Itemize
9962 \begin_layout Itemize
9968 \begin_layout Standard
9969 These five are kind of quirky, due to a
9970 \begin_inset Quotes eld
9974 \begin_inset Quotes erd
9979 You see, \SpecialChar LyX
9980 doesn't permit you to nest any other paragraph environment into
9981 an empty environment.
9982 Now, that's fine and dandy, but it means that you wouldn't be able to start
9983 a slide with anything except plain text.
9984 To deal with this, I've performed a little
9985 \begin_inset Quotes eld
9990 \begin_inset Quotes erd
9996 \begin_layout Paragraph
9997 Quirks of the New Environments
9998 \begin_inset CommandInset label
10000 name "sec:slideQuirk"
10007 \begin_layout Standard
10008 All five of the new paragraph environments are somewhat quirky due to inherent
10009 limitiations in the current version of \SpecialChar LyX
10011 As I just mentioned, \SpecialChar LyX
10012 forbids environments that begin with another environment.
10013 To get around this, the
10017 environment isn't a paragraph environment as described in the
10025 \begin_layout Standard
10026 You should consider
10039 \begin_inset Quotes eld
10042 pseudo-environments.
10043 \begin_inset Quotes erd
10046 They look like a section heading or a
10047 \begin_inset Quotes eld
10055 \begin_inset Quotes erd
10058 but really begin a [and, if necessary, end the previous] paragraph environment.
10068 \begin_inset Quotes eld
10072 \begin_inset Quotes erd
10075 These two perform some action.
10078 \begin_layout Standard
10079 A common feature of all five environments,
10099 , is a rather long-ish label.
10100 The text following this label — ordinarily the contents of the paragraph
10101 environment — is utterly irrelevant for
10123 completely ignores it.
10124 In fact, you can leave these five environments completely empty.
10128 \begin_layout Standard
10133 to put any text after the rather long-ish label, you might want to.
10134 This could be a short description of the contents of the
10139 In that case, enter your descriptive comment and hit
10143 as you normally would.
10146 \begin_layout Standard
10147 If, on the other hand, you don't want to enter any descriptive text, you'll
10148 hit another \SpecialChar LyX
10151 , like nature, abhors a vacuum, and will not let you start a new paragraph
10152 environment until you put something in the old one.
10156 \begin_layout Itemize
10157 Start entering the text that will
10185 \begin_layout Itemize
10186 Now move to the beginning of that paragraph.
10190 \begin_layout Itemize
10199 \begin_layout Itemize
10200 Finally, change this new, empty paragraph to a
10224 \begin_layout Standard
10225 Some future version of \SpecialChar LyX
10226 will, hopefully, resolve this quirkiness\SpecialChar ldots
10230 \begin_layout Subsubsection
10231 Making a Presentation with
10244 \begin_layout Paragraph
10252 \begin_layout Standard
10253 If you're expecting this section to teach you how to actually make a presentatio
10254 n, you'll be sorely disappointed.
10255 Naturally, I'll describe all of the ways the
10259 class can assist you in preparing the materials for a presentation.
10260 Filling in the contents, however, is up to you.
10265 the \SpecialChar LyX
10269 \begin_layout Standard
10274 environment [in the manner described in section
10275 \begin_inset space ~
10279 \begin_inset CommandInset ref
10281 reference "sec:slideQuirk"
10285 ] tells \SpecialChar LyX
10286 to begin a new slide [duh].
10287 The label for this environment/
10288 \begin_inset Quotes erd
10292 \begin_inset Quotes erd
10296 \begin_inset Quotes eld
10300 \begin_inset Quotes erd
10303 in cool blue, followed by the label,
10304 \begin_inset Quotes eld
10308 \begin_inset Quotes erd
10312 Any text or paragraph environments that follow this one go on the new slide.
10316 \begin_layout Standard
10317 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
10319 (this can be specified in the
10324 In fact, you'll want to, once you finish entering the contents of one slide.
10325 If you've entered more text than can physically fit on a slide, the extra
10326 overflows onto a new slide.
10327 I don't recommend doing this, however, since the overflow slide won't have
10328 any page number on it.
10329 Furthermore, it may interfere with any
10333 you've made to accompany the oversized
10340 \begin_layout Standard
10349 environments work the same way as the
10354 They both create an
10355 \begin_inset Quotes eld
10359 \begin_inset Quotes erd
10362 followed by a label [
10363 \begin_inset Quotes eld
10367 \begin_inset Quotes erd
10371 \begin_inset Quotes eld
10375 \begin_inset Quotes erd
10379 The color is a stunning magenta instead of blue, and the
10380 \begin_inset Quotes eld
10384 \begin_inset Quotes erd
10387 will look different, in style and in length.
10388 The label fonts of all three also differ from one another.
10391 \begin_layout Standard
10396 , if the contents of a
10404 exceed the physical size of a slide or sheet of paper, the extra will overflow
10406 Again, you should avoid this.
10407 It defeats the whole purpose of
10418 \begin_layout Paragraph
10428 \begin_layout Standard
10433 is a slide that sits atop another slide.
10434 Perhaps you wish to discuss a figure on the main
10438 before displaying the text associated with it.
10439 One way to accomplish this is tape a flap of dark paper over the part of
10444 you want to display later.
10445 This method fails, however, if you wish to overlap one graph with another,
10447 You would then have to fumble while speaking to align the two separate,
10452 s to align the two graphs.
10457 environment in both cases makes life much easier.
10460 \begin_layout Standard
10465 receives the page number of its
10466 \begin_inset Quotes eld
10470 \begin_inset Quotes erd
10478 \begin_inset Quotes eld
10486 \begin_inset Quotes erd
10493 \begin_layout Plain Layout
10494 Presumably, mutliple
10499 \begin_inset Quotes eld
10507 \begin_inset Quotes erd
10511 \begin_inset Quotes eld
10519 \begin_inset Quotes erd
10523 \begin_inset Quotes eld
10531 \begin_inset Quotes erd
10535 \begin_inset space ~
10538 appended to the page number of the parent
10548 Clearly, you want the contents of both the
10556 to each fit on a single physical slide! You should probably consider an
10562 \begin_inset Quotes eld
10566 \begin_inset Quotes erd
10574 Indeed, the \SpecialChar LyX
10579 class provides a visual cue for this: the label at the start of an
10583 is shorter than that at the start of a
10588 Lastly, when you generate printable output, you'll find alignment markers
10589 in all four corners of both the
10593 page and its parent
10598 These will assist you in lining up the two physical slides.
10601 \begin_layout Standard
10602 The major problem in overlaying two slides is aligning the contents of the
10603 two transparencies.
10604 How much space should you leave for that graph on the second slide? Worse
10605 still, what if you want a graph and a sentence on second slide, but there
10606 is text on the main transparency that goes in between them? You could try
10607 and insert vertical space of the right size.
10608 The better way is to use
10619 \begin_layout Standard
10620 As their names imply,
10628 are two command-like paragraph environments that make all subsequent text
10629 invisible and visible, respectively.
10631 \begin_inset space ~
10635 \begin_inset CommandInset ref
10637 reference "sec:slideQuirk"
10641 that you don't place anything
10645 these two environments, however.
10650 , it inserts a centered, sky-blue label into the page reading
10651 \begin_inset Quotes eld
10654 <Invisible Text Follows>
10655 \begin_inset Quotes erd
10659 For paragraphs following this label, the parts of the
10667 ; it doesn't matter which] where they would be contain instead blank space.
10671 \begin_layout Standard
10676 , the corresponding centered label is
10677 \begin_inset Quotes eld
10680 <Visible Text Follows>
10681 \begin_inset Quotes erd
10685 Paragraphs following this label behave normally.
10686 Note that the beginning of a new
10698 automatically shuts off an
10703 It's therefore not necessary to use
10714 \begin_layout Standard
10715 By now, it should be obvious how to create overlay transparencies using
10716 the proper combination of
10735 \begin_layout Enumerate
10740 , including everything that will appear on it, whether on the main slide
10748 \begin_layout Enumerate
10749 Before each figure or paragraph that will appear only on the
10758 If necessary, insert a
10762 environment after the
10769 \begin_layout Enumerate
10774 immediately following the
10781 \begin_layout Enumerate
10782 Copy the contents of this
10793 \begin_layout Enumerate
10798 , change all of the
10809 \begin_layout Standard
10811 You've just made an
10818 \begin_layout Standard
10819 There's one problem with the way I've designed the \SpecialChar LyX
10824 class: you can't make text in the middle of a paragraph invisible, nor
10825 make text in the middle of an invisible paragraph visible again.
10826 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
10831 \begin_layout Plain Layout
10832 The commands of interest are:
10835 \begin_layout Itemize
10840 invisible \SpecialChar ldots
10844 \begin_layout Itemize
10849 visible \SpecialChar ldots
10853 \begin_layout Plain Layout
10855 and need to be marked as \SpecialChar TeX
10858 \begin_inset Quotes eld
10862 \begin_inset Quotes erd
10865 you wish to change goes in between the brackets [and after the
10878 If you don't know how to mark text as \SpecialChar TeX
10879 , see the appropriate section of
10892 \begin_layout Paragraph
10902 \begin_inset CommandInset label
10904 name "sec:slideNote"
10911 \begin_layout Standard
10920 is associated with a
10921 \begin_inset Quotes eld
10925 \begin_inset Quotes erd
10933 Here, too, the \SpecialChar LyX
10938 class provides visual cues.
10943 is shorter than that of a
10947 [yet longer than that of an
10951 ] and, like the label of an
10955 is shockingly magenta.
10956 Additionally, the printed
10960 has the page number of its
10961 \begin_inset Quotes eld
10965 \begin_inset Quotes erd
10973 \begin_inset Quotes eld
10981 \begin_inset Quotes erd
10985 \begin_inset Quotes eld
10993 \begin_inset Quotes erd
10997 \begin_inset Quotes eld
11005 \begin_inset Quotes erd
11009 You can have multiple
11013 s associated with a single
11025 , you'll probably want to break up long
11029 s so that they fit on a single sheet of paper.
11032 \begin_layout Standard
11037 is obvious: it contains anything additional you might want to say about
11043 It could also be used as a sheet of reminders for a particular
11048 In the case of the latter, you might want to make use of time markers.
11049 Currently, the \SpecialChar LyX
11055 \begin_inset Quotes eld
11059 \begin_inset Quotes erd
11062 support for time markers, a
11064 Sli\SpecialChar TeX
11068 So, you'll have to resort to using the \SpecialChar LaTeX
11072 \begin_layout Standard
11073 To use time markers, you'll need to specify the extra class option
11074 \begin_inset Quotes eld
11082 \begin_inset Quotes erd
11086 \begin_inset space ~
11090 \begin_inset CommandInset ref
11092 reference "sec:slidesetup"
11097 This option turns on timing marks, which will appear in the lower-left-hand
11103 To set what appears in the time marker, you use the \SpecialChar LaTeX
11105 \begin_inset Quotes eld
11115 \begin_inset Quotes erd
11119 \begin_inset Quotes eld
11129 \begin_inset Quotes erd
11133 The arguments of both commands are time measured in seconds.
11135 \begin_inset Quotes eld
11145 \begin_inset Quotes erd
11148 sets the time marker to a given time.
11150 \begin_inset Quotes eld
11160 \begin_inset Quotes erd
11163 increments the time marker by the specified amount.
11164 Using time markers and
11168 s in this fashion, you can remind yourself how much time to spend on a particula
11176 \begin_layout Standard
11177 There's one last feature to describe.
11178 Clearly, you'd like to print out all of your
11186 s on transparencies while printing all of your
11203 with which it is associated.
11204 What's a person to do?
11207 \begin_layout Standard
11208 Luckily, there are two \SpecialChar LaTeX
11209 commands that allow you to select what to print
11211 Both must be placed into the preamble of your document.
11213 \begin_inset Quotes eld
11225 \begin_inset Quotes erd
11228 will cause the output to contain only the
11237 Correspondingly, the command
11238 \begin_inset Quotes eld
11250 \begin_inset Quotes erd
11253 prevents the output of anything but
11258 I'd advise placing both commands in the preamble and initially comment
11260 You can then preview your entire presentation as you write.
11261 When you're done writing, you can then uncomment one of the two to select
11262 what you want to print.
11263 I like to uncomment
11264 \begin_inset Quotes eld
11276 \begin_inset Quotes erd
11279 , print to a file with
11280 \begin_inset Quotes eld
11288 \begin_inset Quotes erd
11291 in its name, comment it back out, then uncomment
11292 \begin_inset Quotes eld
11304 \begin_inset Quotes erd
11308 \begin_inset Quotes eld
11316 \begin_inset Quotes erd
11320 I can then send either file to a printer, loading transparencies or plain
11321 paper as appropriate.
11324 \begin_layout Standard
11325 You can also provide other arguments to the
11326 \begin_inset Quotes eld
11336 \begin_inset Quotes erd
11340 \begin_inset Quotes eld
11350 \begin_inset Quotes erd
11354 See a good \SpecialChar LaTeX
11358 \begin_layout Subsubsection
11363 Class Template File
11366 \begin_layout Standard
11367 I have also provided a template file,
11368 \begin_inset Quotes eld
11376 \begin_inset Quotes erd
11384 To use it, begin your new presentation with
11386 File\SpecialChar menuseparator
11388 \begin_inset space ~
11392 \begin_inset space ~
11398 Your new \SpecialChar LyX
11399 presentation file will contain an example
11420 additionally contain an example of the use of
11429 Lastly, the preamble will contain:
11432 \begin_layout LyX-Code
11433 % Uncomment to print out only slides and overlays
11436 \begin_layout LyX-Code
11440 \begin_layout LyX-Code
11446 \begin_inset Newline newline
11452 \begin_layout LyX-Code
11453 % Uncomment to print out only notes
11456 \begin_layout LyX-Code
11460 \begin_layout LyX-Code
11468 \begin_layout Standard
11469 One final thing: I created this class to support the \SpecialChar LaTeX2e
11471 \begin_inset Quotes eld
11476 Sli\SpecialChar TeX
11480 \begin_inset Quotes erd
11483 class, one of the built-in \SpecialChar LaTeX2e
11485 Neither I nor the rest of the \SpecialChar LyX
11486 Team endorse or oppose the use of this built-in
11488 It's here if you want it or need it.
11489 There exist other \SpecialChar LaTeX2e
11490 classes for creating presentations, such as the
11495 \begin_inset space ~
11499 \begin_inset CommandInset ref
11501 reference "sec:foiltex"
11506 \begin_inset Quotes eld
11514 \begin_inset Quotes erd
11517 package [present on some \SpecialChar TeX
11519 The latter is not yet supported under \SpecialChar LyX
11524 \begin_layout Plain Layout
11525 Perhaps you can take on the task\SpecialChar ldots
11531 I know nothing about these other classes.
11532 Try them out to see what sort of alternative they provide.
11535 \begin_layout Section
11537 \change_inserted 564990737 1670439661
11541 \begin_layout Subsection
11543 \change_inserted 564990737 1670439661
11547 \begin_layout Standard
11549 \change_inserted 564990737 1670439661
11558 document class for preparing reports.
11563 document class, this provides parts, chapters and sections but does not
11564 provide the paragraph styles needed for a book; like the
11568 document class, it provides the abstract paragraph style.
11569 In two-sided mode, it does not start a new chapter on the right hand page.
11572 \begin_layout Standard
11574 \change_inserted 564990737 1670439674
11579 document classes are described in the Collections (section
11580 \begin_inset space ~
11584 \begin_inset CommandInset ref
11586 reference "sec:Collections"
11593 \begin_layout Section
11595 \change_inserted 564990737 1670439674
11599 \begin_layout Subsection
11603 \begin_layout Standard
11609 \begin_layout Subsubsection
11613 \begin_layout Standard
11614 Broadway is for writing plays.
11615 The format is more decorative than Hollywood, and much less standardized.
11616 This format should be suitable for workshops.
11619 \begin_layout Subsubsection
11623 \begin_layout Standard
11624 The same as in Hollywood.
11627 \begin_layout Subsubsection
11631 \begin_layout Standard
11636 names as labels then cross-reference the label to insert the name.
11637 The cross-reference dialog will show the current cast of characters.
11640 \begin_layout Subsubsection
11641 Paper size and Margins
11644 \begin_layout Standard
11645 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
11648 \begin_layout Subsubsection
11652 \begin_layout Standard
11653 The following environments are available.
11654 You can use broadway.bind to get the bind keys shown at the right.
11657 \begin_layout Itemize
11661 \begin_inset Newline newline
11666 You should not have to use this, but it is here for anything that does not
11670 \begin_layout Itemize
11674 \begin_inset space \hfill{}
11678 \begin_inset Newline newline
11683 Used to describe stage setting and the action.
11684 First use of speaker names in all CAPs.
11687 \begin_layout Itemize
11691 \begin_inset space \hfill{}
11695 \begin_inset Newline newline
11700 Automatically numbered.
11701 On screen it will be arabic, but will print as Roman.
11704 \begin_layout Itemize
11708 \begin_inset space \hfill{}
11712 \begin_inset Newline newline
11722 It is just centered text.
11725 \begin_layout Itemize
11729 \begin_inset space \hfill{}
11733 \begin_inset Newline newline
11738 Not automatically numbered.
11739 You supply the number.
11740 This is because I couldn't figure out how.
11743 \begin_layout Itemize
11747 \begin_inset space \hfill{}
11751 \begin_inset Newline newline
11756 A special case of Narrative to describe the setting and action as the curtain
11760 \begin_layout Itemize
11764 \begin_inset space \hfill{}
11768 \begin_inset Newline newline
11773 The speaker's (actor's) title, centered in all CAPS.
11776 \begin_layout Itemize
11780 \begin_inset space \hfill{}
11784 \begin_inset Newline newline
11789 Instructions to the speaker.
11790 The parentheses are automatically inserted.
11791 The ( will appear on screen, but both will be in the printed play.
11792 This environment is only used within
11799 \begin_layout Itemize
11803 \begin_inset space \hfill{}
11807 \begin_inset Newline newline
11812 What the Speaker says.
11815 \begin_layout Itemize
11819 \begin_inset space \hfill{}
11823 \begin_inset Newline newline
11828 The curtain comes down.
11831 \begin_layout Itemize
11835 \begin_inset space \hfill{}
11841 \begin_layout Itemize
11845 \begin_inset space \hfill{}
11851 \begin_layout Itemize
11855 \begin_inset space \hfill{}
11861 \begin_layout Standard
11865 \begin_layout Subsection
11866 Hollywood (Hollywood spec scripts)
11869 \begin_layout Standard
11875 \begin_layout Subsubsection
11879 \begin_layout Standard
11880 Getting the format of a Hollywood script right is a
11881 \begin_inset Quotes eld
11885 \begin_inset Quotes erd
11888 It is designed to make the readers focus on content and to be easy and
11889 familiar for the actors to read.
11890 Each page of a script should be one minute of film.
11891 Nothing goes in a script that you cannot see or hear on screen.
11892 The courier 12 pt font should be used throughout.
11896 \begin_layout Subsubsection
11900 \begin_layout Standard
11901 Speakers' lines should NEVER break in mid-sentence.
11902 If a speaker's lines continue over a page break, repeat the
11906 title followed by (Cont'd).
11909 \begin_layout Subsubsection
11913 \begin_layout Standard
11918 names as labels then cross-reference the label to insert the name.
11919 The cross-reference dialog will show the current cast of characters.
11920 You can use this to insert the speaker name in narratives also.
11923 \begin_layout Subsubsection
11924 Paper size and Margins
11927 \begin_layout Standard
11928 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
11931 \begin_layout Subsubsection
11935 \begin_layout Standard
11936 The following environments are available.
11937 You can use hollywood.bind to get the bind keys shown at the right.
11940 \begin_layout Itemize
11944 \begin_inset Newline newline
11949 Used where nothing else works.
11953 \begin_layout Itemize
11959 \begin_inset space \hfill{}
11967 \begin_inset Newline newline
11970 Usually followed by something like
11971 \begin_inset Quotes eld
11974 on Sally waking up.
11975 \begin_inset Quotes erd
11981 \begin_layout Itemize
11985 \begin_inset space \hfill{}
11989 \begin_inset Newline newline
11994 Introduces a new INTERIOR camera set-up.
11995 Always followed by DAY or NIGHT, or something similar to define the lighting
11997 Everthing on this line in CAPS.
12000 \begin_layout Itemize
12004 \begin_inset space \hfill{}
12008 \begin_inset Newline newline
12013 Introduces a new EXTERIOR camera set-up.
12014 Everthing on this line in CAPS.
12017 \begin_layout Itemize
12021 \begin_inset space \hfill{}
12025 \begin_inset Newline newline
12030 The character speaking.
12033 \begin_layout Itemize
12037 \begin_inset space \hfill{}
12041 \begin_inset Newline newline
12046 Instructions to the speaker.
12047 The () are automatically inserted.
12050 \begin_layout Itemize
12054 \begin_inset space \hfill{}
12058 \begin_inset Newline newline
12070 \begin_layout Itemize
12074 \begin_inset space \hfill{}
12078 \begin_inset Newline newline
12083 Camera movement instruction.
12085 \begin_inset space \thinspace{}
12089 \begin_inset space \space{}
12095 \begin_layout Itemize
12099 \begin_inset space \hfill{}
12105 \begin_layout Itemize
12109 \begin_inset space \hfill{}
12115 \begin_layout Itemize
12119 \begin_inset space \hfill{}
12125 \begin_layout Itemize
12129 \begin_inset space \hfill{}
12135 \begin_layout Subsubsection
12139 \begin_layout Itemize
12143 \begin_layout Itemize
12147 \begin_layout Itemize
12149 \begin_inset space \thinspace{}
12156 \begin_layout Itemize
12161 \begin_layout Itemize
12162 PAN — camera movement
12165 \begin_layout Itemize
12166 INSERT — cut to close-up of
12169 \begin_layout Chapter
12171 \change_inserted 564990737 1671185876
12175 \begin_layout Section
12176 Multiple Text Columns
12179 \begin_layout Standard
12180 This feature is independent of the option
12182 Two-column document
12184 in the document settings under
12189 If you want to have 2
12190 \begin_inset space ~
12193 columns for the whole document, it is recommended to use the
12195 Two-column document
12198 For all other cases use this feature.
12201 \begin_layout Standard
12202 To use multiple text columns in your document, you have to load the module
12209 Document\SpecialChar menuseparator
12210 Settings\SpecialChar menuseparator
12213 ) and must have the \SpecialChar LaTeX
12215 \begin_inset Flex Code
12218 \begin_layout Plain Layout
12227 \begin_layout Standard
12228 Footnotes within multiple columns will be placed at the bottom of the page
12229 and not under each column.
12230 Within the different columns you can use everything, with the limitation
12231 that for floats you need to use the float option
12238 \begin_layout Subsection
12242 \begin_layout Standard
12243 If you want to have 2
12244 \begin_inset space ~
12247 columns in your text, insert a multicolumn inset via the menu
12249 Insert\SpecialChar menuseparator
12251 \begin_inset space ~
12254 Insets\SpecialChar menuseparator
12256 \begin_inset space ~
12261 where the columns should start.
12262 Write all text that should be printed in 2
12263 \begin_inset space ~
12266 columns into this inset.
12269 \begin_layout Standard
12270 Here is an example:
12273 \begin_layout Standard
12275 \begin_inset Flex Multiple Columns
12278 \begin_layout Plain Layout
12283 The Adventure of the Empty House
12286 \begin_inset Newline newline
12289 by Sir Arthur Conan Doyle
12292 \begin_layout Plain Layout
12295 It was in the spring of the year 1894 that all London was interested, and
12296 the fashionable world dismayed, by the murder of the Honourable Ronald
12297 Adair under most unusual and inexplicable circumstances.
12298 The public has already learned those particulars of the crime which came
12299 out in the police investigation, but a good deal was suppressed upon that
12300 occasion, since the case for the prosecution was so overwhelmingly strong
12301 that it was not necessary to bring forward all the facts.
12302 Only now, at the end of nearly ten years, am I allowed to supply those
12303 missing links which make up the whole of that remarkable chain.
12304 The crime was of interest in itself, but that interest was as nothing to
12305 me compared to the inconceivable sequel, which afforded me the greatest
12306 shock and surprise of any event in my adventurous life.
12307 Even now, after this long interval, I find myself thrilling as I think
12308 of it, and feeling once more that sudden flood of joy, amazement, and increduli
12309 ty which utterly submerged my mind.
12310 Let me say to that public, which has shown some interest in those glimpses
12311 which I have occasionally given them of the thoughts and actions of a very
12312 remarkable man, that they are not to blame me if I have not shared my knowledge
12313 with them, for I should have considered it my first duty to do so, had
12314 I not been barred by a positive prohibition from his own lips, which was
12315 only withdrawn upon the third of last month.
12323 \begin_layout Standard
12324 To get 3 or more columns, set the cursor into the multicolumn inset and
12327 Insert\SpecialChar menuseparator
12329 \begin_inset space ~
12333 \begin_inset space ~
12339 The number of the desired columns is written into that inset (for 3
12340 \begin_inset space ~
12344 \begin_inset Quotes eld
12348 \begin_inset Quotes erd
12352 \begin_inset Newline newline
12355 Here is an example with 3
12356 \begin_inset space ~
12362 \begin_layout Standard
12363 \begin_inset Flex Multiple Columns
12366 \begin_layout Plain Layout
12369 \begin_inset Argument 1
12372 \begin_layout Plain Layout
12379 It can be imagined that my close intimacy with Sherlock Holmes had interested
12380 me deeply in crime, and that after his disappearance I never failed to
12381 read with care the various problems which came before the public.
12382 And I even attempted, more than once, for my own private satisfaction,
12383 to employ his methods in their solution, though with indifferent success.
12384 There was none, however, which appealed to me like this tragedy of Ronald
12386 As I read the evidence at the inquest, which led up to a verdict of willful
12387 murder against some person or persons unknown, I realized more clearly
12388 than I had ever done the loss which the community had sustained by the
12389 death of Sherlock Holmes.
12390 There were points about this strange business which would, I was sure,
12391 have specially appealed to him, and the efforts of the police would have
12392 been supplemented, or more probably anticipated, by the trained observation
12393 and the alert mind of the first criminal agent in Europe.
12394 All day, as I drove upon my round, I turned over the case in my mind and
12395 found no explanation which appeared to me to be adequate.
12396 At the risk of telling a twice-told tale, I will recapitulate the facts
12397 as they were known to the public at the conclusion of the inquest.
12405 \begin_layout Standard
12406 You can have up to 10
12407 \begin_inset space ~
12410 columns if you want to, but that might not be very pleasant for the readers
12414 \begin_layout Standard
12415 \begin_inset Newpage newpage
12421 \begin_layout Subsection
12422 Columns inside Columns
12425 \begin_layout Standard
12426 You can also have columns inside columns:
12429 \begin_layout Standard
12430 \begin_inset Flex Multiple Columns
12433 \begin_layout Plain Layout
12436 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
12437 at that time governor of one of the Australian colonies.
12438 Adair's mother had returned from Australia to undergo the operation for
12439 cataract, and she, her son Ronald, and her daughter Hilda were living together
12443 \begin_layout Plain Layout
12444 \begin_inset Flex Multiple Columns
12447 \begin_layout Plain Layout
12450 The youth moved in the best society
12451 \begin_inset space ~
12454 – had, so far as was known, no enemies and no particular vices.
12455 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
12456 had been broken off by mutual consent some months before, and there was
12457 no sign that it had left any very profound feeling behind it.
12458 For the rest {sic} the man's life moved in a narrow and conventional circle,
12459 for his habits were quiet and his nature unemotional.
12460 Yet it was upon this easy-going young aristocrat that death came, in most
12461 strange and unexpected form, between the hours of ten and eleven-twenty
12462 on the night of March 30, 1894.
12470 \begin_layout Plain Layout
12473 Ronald Adair was fond of cards
12474 \begin_inset space ~
12477 – playing continually, but never for such stakes as would hurt him.
12478 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
12479 It was shown that, after dinner on the day of his death, he had played
12480 a rubber of whist at the latter club.
12481 He had also played there in the afternoon.
12486 The evidence of those who had played with him
12487 \begin_inset space ~
12491 Murray, Sir John Hardy, and Colonel Moran
12492 \begin_inset space ~
12495 – showed that the game was whist, and that there was a fairly equal fall
12497 Adair might have lost five pounds, but not more.
12498 His fortune was a considerable one, and such a loss could not in any way
12500 He had played nearly every day at one club or other, but he was a cautious
12501 player, and usually rose a winner.
12502 It came out in evidence that, in partnership with Colonel Moran, he had
12503 actually won as much as four hundred and twenty pounds in a sitting, some
12504 weeks before, from Godfrey Milner and Lord Balmoral.
12505 So much for his recent history as it came out at the inquest.
12513 \begin_layout Subsection
12517 \begin_layout Standard
12518 The examples in this section show some more special features of multiple
12522 \begin_layout Standard
12523 For more features of multiple columns, have a look at the
12524 \begin_inset CommandInset href
12526 name "documentation"
12527 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
12532 of the \SpecialChar LaTeX
12534 \begin_inset Flex Code
12537 \begin_layout Plain Layout
12546 \begin_layout Subsubsection
12550 \begin_layout Standard
12551 To add a preface text for multiple columns, set the cursor into the multicolumn
12552 inset and use the menu
12554 Insert\SpecialChar menuseparator
12558 Write your preface text into that inset.
12559 \begin_inset Newline newline
12562 This is an example with some preface text:
12565 \begin_layout Standard
12566 \begin_inset VSpace bigskip
12572 \begin_layout Standard
12573 \begin_inset Flex Multiple Columns
12576 \begin_layout Plain Layout
12577 \begin_inset Argument 2
12580 \begin_layout Plain Layout
12581 And the story continues and continues and continues and continues\SpecialChar ldots
12589 On the evening of the crime, he returned from the club exactly at ten.
12590 His mother and sister were out spending the evening with a relation.
12591 The servant deposed that she heard him enter the front room on the second
12592 floor, generally used as his sitting-room.
12593 She had lit a fire there, and as it smoked she had opened the window.
12594 No sound was heard from the room until eleven-twenty, the hour of the return
12595 of Lady Maynooth and her daughter.
12596 Desiring to say good-night, she attempted to enter her son's room.
12597 The door was locked on the inside, and no answer could be got to their
12598 cries and knocking.
12599 Help was obtained, and the door forced.
12600 The unfortunate young man was found lying near the table.
12601 His head had been horribly mutilated by an expanding revolver bullet, but
12602 no weapon of any sort was to be found in the room.
12610 \begin_layout Standard
12611 You can also use a section heading as the preface if you use a section command
12612 as \SpecialChar TeX
12614 For example the command
12617 \begin_layout LyX-Code
12620 subsection{subsection title}
12623 \begin_layout Standard
12624 creates a subsection.
12625 In this example the preface is a subsubsection:
12628 \begin_layout Standard
12629 \begin_inset Flex Multiple Columns
12632 \begin_layout Plain Layout
12633 \begin_inset Argument 2
12636 \begin_layout Plain Layout
12640 \begin_layout Plain Layout
12649 This is a subsubsection heading as a preface
12653 \begin_layout Plain Layout
12667 A minute examination of the circumstances served only to make the case more
12669 In the first place, no reason could be given why the young man should have
12670 fastened the door upon the inside.
12671 There was the possibility that the murderer had done this, and had afterwards
12672 escaped by the window.
12673 The drop was at least twenty feet, however, and a bed of crocuses in full
12675 Neither the flowers nor the earth showed any sign of having been disturbed,
12676 nor were there any marks upon the narrow strip of grass which separated
12677 the house from the road.
12678 Apparently, therefore, it was the young man himself who had fastened the
12680 But how did he come by his death? No one could have climbed up to the window
12681 without leaving traces.
12682 Suppose a man had fired through the window, he would indeed be a remarkable
12683 shot who could with a revolver inflict so deadly a wound.
12684 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
12685 a hundred yards of the house.
12686 No one had heard a shot.
12694 \begin_layout Standard
12695 If there is less vertical space than 6
12696 \begin_inset space ~
12699 text lines is left on the page at the beginning of the multiple columns,
12700 a page break will be inserted before the multiple columns.
12701 Depending on the number of lines of the preface text, you might want to
12703 This is done by setting the cursor into the mulitcolumn inset behind the
12704 preface (if there is any) and using the menu
12706 Insert\SpecialChar menuseparator
12708 \begin_inset space ~
12712 \begin_inset space ~
12716 \begin_inset space ~
12722 Insert into that inset the amount of space like e.
12723 \begin_inset space \thinspace{}
12727 \begin_inset space \space{}
12731 \begin_inset Quotes eld
12735 \begin_inset Quotes erd
12739 \begin_inset Newline newline
12742 In this example the space is set to 7
12743 \begin_inset space ~
12746 text lines by using
12747 \begin_inset Flex Code
12750 \begin_layout Plain Layout
12759 \begin_inset Flex Code
12762 \begin_layout Plain Layout
12770 needs to be inserted as \SpecialChar TeX
12774 \begin_layout Standard
12775 \begin_inset Flex Multiple Columns
12778 \begin_layout Plain Layout
12779 \begin_inset Argument 3
12782 \begin_layout Plain Layout
12787 \begin_layout Plain Layout
12803 On the evening of the crime, he returned from the club exactly at ten.
12804 His mother and sister were out spending the evening with a relation.
12805 The servant deposed that she heard him enter the front room on the second
12806 floor, generally used as his sitting-room.
12807 She had lit a fire there, and as it smoked she had opened the window.
12808 No sound was heard from the room until eleven-twenty, the hour of the return
12809 of Lady Maynooth and her daughter.
12810 Desiring to say good-night, she attempted to enter her son's room.
12811 The door was locked on the inside, and no answer could be got to their
12812 cries and knocking.
12813 Help was obtained, and the door forced.
12814 The unfortunate young man was found lying near the table.
12815 His head had been horribly mutilated by an expanding revolver bullet, but
12816 no weapon of any sort was to be found in the room.
12824 \begin_layout Subsubsection
12828 \begin_layout Standard
12829 The amount of space before and after multiple columns can be changed by
12830 changing the length
12831 \begin_inset Flex Code
12834 \begin_layout Plain Layout
12843 For example the command
12846 \begin_layout LyX-Code
12854 \begin_layout Standard
12855 in \SpecialChar TeX
12856 Code changes its value to 3
12857 \begin_inset space \thinspace{}
12861 The change must be made before the multiple columns' start.
12862 The predefined value is 13
12863 \begin_inset space \thinspace{}
12869 \begin_layout Standard
12871 \begin_inset Flex Code
12874 \begin_layout Plain Layout
12883 \begin_inset space \thinspace{}
12889 \begin_layout Standard
12893 \begin_layout Plain Layout
12899 multicolsep}{2.5cm}
12907 \begin_layout Standard
12908 \begin_inset Flex Multiple Columns
12911 \begin_layout Plain Layout
12914 All day I turned these facts over in my mind, endeavouring to hit upon some
12915 theory which could reconcile them all, and to find that line of least resistanc
12916 e which my poor friend had declared to be the starting-point of every investigat
12918 I confess that I made little progress.
12919 In the evening I strolled across the Park, and found myself about six o'clock
12920 at the Oxford Street end of Park Lane.
12921 A group of loafers upon the pavements, all staring up at a particular window,
12922 directed me to the house which I had come to see.
12923 A tall, thin man with coloured glasses, whom I strongly suspected of being
12924 a plain-clothes detective, was pointing out some theory of his own, while
12925 the others crowded round to listen to what he said.
12926 I got as near him as I could, but his observations seemed to me to be absurd,
12927 so I withdrew again in some disgust.
12928 As I did so I struck against an elderly, deformed man, who had been behind
12929 me, and I knocked down several books which he was carrying.
12937 \begin_layout Standard
12938 \begin_inset Note Greyedout
12941 \begin_layout Plain Layout
12946 The values you set with
12947 \begin_inset Flex Code
12950 \begin_layout Plain Layout
12958 will be used for all following multiple columns until you change them again.
12966 \begin_layout Standard
12970 \begin_layout Plain Layout
12982 \begin_inset Note Note
12985 \begin_layout Plain Layout
12986 go back to the default
12994 \begin_layout Standard
12995 \begin_inset Newpage newpage
13001 \begin_layout Subsubsection
13005 \begin_layout Standard
13006 A column break can be forced by inserting the command
13007 \begin_inset Flex Code
13010 \begin_layout Plain Layout
13018 as \SpecialChar TeX
13019 Code to that position in the text where the column should be broken.
13020 Note that this leads in most cases to whitespace in the text.
13021 \begin_inset Newline newline
13024 Here is an example:
13027 \begin_layout Standard
13028 \begin_inset Flex Multiple Columns
13031 \begin_layout Plain Layout
13034 \begin_inset Quotes eld
13037 You're surprised to see me, sir,
13038 \begin_inset Quotes erd
13041 said he, in a strange, croaking voice.
13044 \begin_layout Plain Layout
13047 I acknowledged that I was.
13050 \begin_layout Plain Layout
13053 \begin_inset Quotes eld
13056 Well, I've a conscience, sir, and when I chanced to see you go into this
13057 house, as I came hobbling after you, I thought to myself, I'll just step
13058 in and see that kind gentleman, and tell him that if I was a bit gruff
13059 in my manner there was not any harm meant, and that I am much obliged to
13060 him for picking up my books.
13061 \begin_inset Quotes erd
13067 \begin_layout Plain Layout
13070 \begin_inset Quotes eld
13073 You make too much of a trifle,
13074 \begin_inset Quotes erd
13079 \begin_inset Quotes eld
13082 May I ask how you knew who I was?
13083 \begin_inset Quotes erd
13086 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
13090 \begin_layout Plain Layout
13102 \begin_layout Plain Layout
13105 \begin_inset Quotes eld
13108 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
13109 you'll find my little bookshop at the corner of Church Street, and very
13110 happy to see you, I am sure.
13111 Maybe you collect yourself, sir.
13115 \begin_inset space ~
13129 \begin_inset space ~
13132 – a bargain, every one of them.
13133 With five volumes you could just fill that gap on that second shelf.
13134 It looks untidy, does it not, sir?
13135 \begin_inset Quotes erd
13146 \begin_layout Subsubsection
13150 \begin_layout Standard
13151 The width of the columns is automatically calculated, but you can modify
13152 the space between the columns.
13153 This is done by changing the length
13154 \begin_inset Flex Code
13157 \begin_layout Plain Layout
13166 Its predefined value is 10
13167 \begin_inset space \thinspace{}
13171 Here is an example where
13172 \begin_inset Flex Code
13175 \begin_layout Plain Layout
13184 \begin_inset space \thinspace{}
13190 \begin_layout Standard
13194 \begin_layout Plain Layout
13208 \begin_layout Standard
13209 \begin_inset Flex Multiple Columns
13212 \begin_layout Plain Layout
13215 My observations of No.
13216 \begin_inset space \space{}
13219 427 Park Lane did little to clear up the problem in which I was interested.
13220 The house was separated from the street by a low wall and railing, the
13221 whole not more than five feet high.
13222 It was perfectly easy, therefore, for anyone to get into the garden, but
13223 the window was entirely inaccessible, since there was no water pipe or
13224 anything which could help the most active man to climb it.
13225 More puzzled than ever, I retraced my steps to Kensington.
13226 I had not been in my study five minutes when the maid entered to say that
13227 a person desired to see me.
13228 To my astonishment it was none other than my strange old book collector,
13229 his sharp, wizened face peering out from a frame of white hair, and his
13230 precious volumes, a dozen of them at least, wedged under his right arm.
13238 \begin_layout Standard
13242 \begin_layout Plain Layout
13254 \begin_inset Note Note
13257 \begin_layout Plain Layout
13258 go back to the default
13266 \begin_layout Subsubsection
13270 \begin_layout Standard
13271 Between the columns a rule with a width of the length
13272 \begin_inset Flex Code
13275 \begin_layout Plain Layout
13284 If this rule width is set to 0
13285 \begin_inset space \thinspace{}
13288 pt (this is the default), the rule is suppressed.
13289 In the following example the rule is 2
13290 \begin_inset space \thinspace{}
13296 \begin_layout Standard
13300 \begin_layout Plain Layout
13306 columnseprule}{2pt}
13314 \begin_layout Standard
13315 \begin_inset Flex Multiple Columns
13318 \begin_layout Plain Layout
13321 \begin_inset Quotes eld
13324 You're surprised to see me, sir,
13325 \begin_inset Quotes erd
13328 said he, in a strange, croaking voice.
13331 \begin_layout Plain Layout
13334 I acknowledged that I was.
13337 \begin_layout Plain Layout
13340 \begin_inset Quotes eld
13343 Well, I've a conscience, sir, and when I chanced to see you go into this
13344 house, as I came hobbling after you, I thought to myself, I'll just step
13345 in and see that kind gentleman, and tell him that if I was a bit gruff
13346 in my manner there was not any harm meant, and that I am much obliged to
13347 him for picking up my books.
13348 \begin_inset Quotes erd
13354 \begin_layout Plain Layout
13357 \begin_inset Quotes eld
13360 You make too much of a trifle,
13361 \begin_inset Quotes erd
13366 \begin_inset Quotes eld
13369 May I ask how you knew who I was?
13370 \begin_inset Quotes erd
13376 \begin_layout Plain Layout
13379 \begin_inset Quotes eld
13382 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
13383 you'll find my little bookshop at the corner of Church Street, and very
13384 happy to see you, I am sure.
13385 Maybe you collect yourself, sir.
13389 \begin_inset space ~
13403 \begin_inset space ~
13406 – a bargain, every one of them.
13407 With five volumes you could just fill that gap on that second shelf.
13408 It looks untidy, does it not, sir?
13409 \begin_inset Quotes erd
13420 \begin_layout Standard
13421 \begin_inset VSpace defskip
13427 \begin_layout Standard
13428 The rule can be colored by redefining the command
13429 \begin_inset Flex Code
13432 \begin_layout Plain Layout
13441 This is done by inserting the command
13444 \begin_layout LyX-Code
13449 columnseprulecolor}{
13454 \begin_layout Standard
13455 as \SpecialChar TeX
13456 Code before the multicolumn inset.
13458 \begin_inset Flex Code
13461 \begin_layout Plain Layout
13467 in this command by a color of your choice.
13468 You can use all pre- and self-defined colors.
13476 \begin_inset space ~
13481 for more information about pre- and self-defined colors.
13482 To go back to the default color insert the command
13485 \begin_layout LyX-Code
13490 columnseprulecolor}{
13495 \begin_layout Standard
13496 Here is the example with a cyan rule and 1
13497 \begin_inset space \thinspace{}
13500 cm column separation:
13503 \begin_layout Standard
13507 \begin_layout Plain Layout
13516 \begin_layout Plain Layout
13522 columnseprulecolor}{
13532 \begin_layout Standard
13533 \begin_inset Flex Multiple Columns
13536 \begin_layout Plain Layout
13539 \begin_inset Quotes eld
13542 You're surprised to see me, sir,
13543 \begin_inset Quotes erd
13546 said he, in a strange, croaking voice.
13549 \begin_layout Plain Layout
13552 I acknowledged that I was.
13555 \begin_layout Plain Layout
13558 \begin_inset Quotes eld
13561 Well, I've a conscience, sir, and when I chanced to see you go into this
13562 house, as I came hobbling after you, I thought to myself, I'll just step
13563 in and see that kind gentleman, and tell him that if I was a bit gruff
13564 in my manner there was not any harm meant, and that I am much obliged to
13565 him for picking up my books.
13566 \begin_inset Quotes erd
13572 \begin_layout Plain Layout
13575 \begin_inset Quotes eld
13578 You make too much of a trifle,
13579 \begin_inset Quotes erd
13584 \begin_inset Quotes eld
13587 May I ask how you knew who I was?
13588 \begin_inset Quotes erd
13594 \begin_layout Plain Layout
13597 \begin_inset Quotes eld
13600 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
13601 you'll find my little bookshop at the corner of Church Street, and very
13602 happy to see you, I am sure.
13603 Maybe you collect yourself, sir.
13607 \begin_inset space ~
13621 \begin_inset space ~
13624 – a bargain, every one of them.
13625 With five volumes you could just fill that gap on that second shelf.
13626 It looks untidy, does it not, sir?
13627 \begin_inset Quotes erd
13638 \begin_layout Standard
13642 \begin_layout Plain Layout
13648 columnseprule}{0pt}
13651 \begin_layout Plain Layout
13657 columnseprulecolor}{
13665 \begin_inset Note Note
13668 \begin_layout Plain Layout
13669 go back to the default
13677 \begin_layout Section
13679 \change_inserted 564990737 1671270380
13683 \begin_layout Subsection
13685 \change_inserted 564990737 1671270398
13687 \change_deleted 564990737 1671270396
13693 \begin_layout Standard
13696 as well as any other text processor uses by default rectangular paragraphs.
13697 For special cases like for example posters, invitation cards or poems you
13698 can modify the paragraph shape to one of your choice.
13699 This can be done by using the \SpecialChar LaTeX
13701 \begin_inset Flex Code
13704 \begin_layout Plain Layout
13710 which is loaded by using in the document settings the module
13712 Custom paragraph shapes
13717 \begin_layout Subsubsection
13721 \begin_layout Standard
13726 provides the following shapes:
13729 \begin_layout Standard
13730 \begin_inset Tabular
13731 <lyxtabular version="3" rows="13" columns="3">
13732 <features booktabs="true" islongtable="true" longtabularalignment="center">
13733 <column alignment="left" valignment="middle" width="16col%">
13734 <column alignment="left" valignment="middle" width="40col%">
13735 <column alignment="left" valignment="middle" width="35col%">
13736 <row endhead="true">
13737 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
13740 \begin_layout Plain Layout
13749 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
13752 \begin_layout Plain Layout
13761 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
13764 \begin_layout Plain Layout
13774 <row interlinespace="default">
13775 <cell alignment="left" valignment="top" usebox="none">
13778 \begin_layout Plain Layout
13786 <cell alignment="left" valignment="top" usebox="none">
13789 \begin_layout Plain Layout
13792 Circle with circular hole (in the size of a CD/DVD)
13797 <cell alignment="left" valignment="top" usebox="none">
13800 \begin_layout Plain Layout
13803 Cannot be scaled, take care there is not too much text
13809 <row interlinespace="default">
13810 <cell alignment="left" valignment="top" usebox="none">
13813 \begin_layout Plain Layout
13821 <cell alignment="left" valignment="top" usebox="none">
13824 \begin_layout Plain Layout
13832 <cell alignment="left" valignment="top" usebox="none">
13835 \begin_layout Plain Layout
13838 Fragile, calculation might fail
13844 <row interlinespace="default">
13845 <cell alignment="left" valignment="top" usebox="none">
13848 \begin_layout Plain Layout
13856 <cell alignment="left" valignment="top" usebox="none">
13859 \begin_layout Plain Layout
13862 Rhomboid (symbolizing a
13863 \begin_inset Quotes eld
13867 \begin_inset Quotes erd
13875 <cell alignment="left" valignment="top" usebox="none">
13878 \begin_layout Plain Layout
13887 <row interlinespace="default">
13888 <cell alignment="left" valignment="top" usebox="none">
13891 \begin_layout Plain Layout
13899 <cell alignment="left" valignment="top" usebox="none">
13902 \begin_layout Plain Layout
13910 <cell alignment="left" valignment="top" usebox="none">
13913 \begin_layout Plain Layout
13922 <row interlinespace="default">
13923 <cell alignment="left" valignment="top" usebox="none">
13926 \begin_layout Plain Layout
13934 <cell alignment="left" valignment="top" usebox="none">
13937 \begin_layout Plain Layout
13945 <cell alignment="left" valignment="top" usebox="none">
13948 \begin_layout Plain Layout
13957 <row interlinespace="default">
13958 <cell alignment="left" valignment="top" usebox="none">
13961 \begin_layout Plain Layout
13969 <cell alignment="left" valignment="top" usebox="none">
13972 \begin_layout Plain Layout
13975 Nut for bolt (hexagon with circular hole)
13980 <cell alignment="left" valignment="top" usebox="none">
13983 \begin_layout Plain Layout
13992 <row interlinespace="default">
13993 <cell alignment="left" valignment="top" usebox="none">
13996 \begin_layout Plain Layout
14004 <cell alignment="left" valignment="top" usebox="none">
14007 \begin_layout Plain Layout
14015 <cell alignment="left" valignment="top" usebox="none">
14018 \begin_layout Plain Layout
14027 <row interlinespace="default">
14028 <cell alignment="left" valignment="top" usebox="none">
14031 \begin_layout Plain Layout
14039 <cell alignment="left" valignment="top" usebox="none">
14042 \begin_layout Plain Layout
14050 <cell alignment="left" valignment="top" usebox="none">
14053 \begin_layout Plain Layout
14062 <row interlinespace="default">
14063 <cell alignment="left" valignment="top" usebox="none">
14066 \begin_layout Plain Layout
14074 <cell alignment="left" valignment="top" usebox="none">
14077 \begin_layout Plain Layout
14085 <cell alignment="left" valignment="top" usebox="none">
14088 \begin_layout Plain Layout
14097 <row interlinespace="default">
14098 <cell alignment="left" valignment="top" usebox="none">
14101 \begin_layout Plain Layout
14109 <cell alignment="left" valignment="top" usebox="none">
14112 \begin_layout Plain Layout
14115 Normal/reversed rain drop
14120 <cell alignment="left" valignment="top" usebox="none">
14123 \begin_layout Plain Layout
14126 Fragile, calculation might fail
14132 <row interlinespace="default">
14133 <cell alignment="left" valignment="top" usebox="none">
14136 \begin_layout Plain Layout
14145 <cell alignment="left" valignment="top" usebox="none">
14148 \begin_layout Plain Layout
14151 The \SpecialChar TeX
14157 <cell alignment="left" valignment="top" usebox="none">
14160 \begin_layout Plain Layout
14169 <row interlinespace="default">
14170 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
14173 \begin_layout Plain Layout
14177 \begin_inset Newline newline
14185 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
14188 \begin_layout Plain Layout
14191 Triangles in different orientations
14196 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
14199 \begin_layout Plain Layout
14215 \begin_layout Standard
14216 To use a shape for your paragraph, simply select it in \SpecialChar LyX
14218 for environments in the toolbar.
14221 \begin_layout Standard
14222 \begin_inset Newpage newpage
14228 \begin_layout Standard
14229 Here is an example paragraph in the shape of a nut:
14232 \begin_layout Standard
14233 \begin_inset VSpace bigskip
14242 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14243 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14245 At vero eos et accusam et justo duo dolores et ea rebum.
14246 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
14248 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14249 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14253 \begin_layout Standard
14254 \begin_inset VSpace bigskip
14260 \begin_layout Standard
14261 \begin_inset Note Greyedout
14264 \begin_layout Plain Layout
14273 paragraphs cannot run over a page break.
14281 \begin_layout Standard
14282 \begin_inset VSpace bigskip
14288 \begin_layout Standard
14290 \begin_inset Flex Code
14293 \begin_layout Plain Layout
14299 takes care that the shape will always be preserved, no matter how much
14300 text is in the paragraph.
14301 Therefore the paragraph size changes with the amount of contained text.
14302 This can lead to paragraph sizes exceeding the page margins.
14303 To demonstrate the size scaling, here is the same example paragraph but
14304 with twice as much text:
14307 \begin_layout Standard
14308 \begin_inset Newpage newpage
14317 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14318 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14320 At vero eos et accusam et justo duo dolores et ea rebum.
14321 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
14323 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14324 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14326 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14327 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14329 At vero eos et accusam et justo duo dolores et ea rebum.
14330 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
14332 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14333 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14337 \begin_layout Standard
14338 \begin_inset VSpace bigskip
14344 \begin_layout Standard
14345 An exception is the shape
14350 It cannot be scaled because it must fit the size of a CD/DVD.
14351 Therefore the amount of text that fits into the shape is limited.
14352 \begin_inset Newline newline
14363 shape are fragile, meaning that the calculation of their size can fail,
14364 depending on the amount of text.
14365 You will then get the \SpecialChar LaTeX
14367 \begin_inset Quotes eld
14370 Arithmetic overflow
14371 \begin_inset Quotes erd
14375 In this case one can try to remove or add some text; if nothing works one
14376 has to use another shape.
14379 \begin_layout Standard
14380 \begin_inset VSpace bigskip
14386 \begin_layout Standard
14387 For shapes with tips you will maybe see that \SpecialChar LaTeX
14388 's hyphenation routine fails
14389 for text in the tips.
14390 Therefore it is often necessary to add hyphenation points
14395 arg "specialchar-insert hyphenation"
14400 ) to the corresponding text parts.
14403 \begin_layout Standard
14404 \begin_inset VSpace bigskip
14410 \begin_layout Standard
14411 Shapepar paragraphs are either always centered or placed on the page so
14412 that their left border touches the left page margin.
14413 You can therefore not use the paragraph dialog to align such paragraphs.
14414 A solution is to put the paragraph into a minipage or parbox and align
14416 The problem is hereby to find the right width for the box.
14417 Because if it is too wide and you center the box, the paragraph is not
14418 centered too because it sticks at the left side of the box.
14419 So you might have to play a bit with the width until it fits.
14420 Here are two heart-shaped paragraphs, the first one is not aligned, the
14421 second one is right-aligned:
14424 \begin_layout Standard
14425 \begin_inset Newpage newpage
14431 \begin_layout Heart
14435 Lo\SpecialChar softhyphen
14436 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14437 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14439 At vero eos et accusam et justo duo dolores et ea rebum.
14440 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
14444 \begin_layout Standard
14445 \begin_inset VSpace bigskip
14451 \begin_layout Standard
14454 \begin_inset Box Frameless
14464 height_special "totalheight"
14469 backgroundcolor "none"
14472 \begin_layout Heart
14476 Lo\SpecialChar softhyphen
14477 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14478 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14480 At vero eos et accusam et justo duo dolores et ea rebum.
14481 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
14490 \begin_layout Subsubsection
14494 \begin_layout Standard
14495 You can define any shape you want.
14496 Doing this manually is a lot of work because every coordinate must be specified.
14497 But there is a way to let the computer calculate the coordinates:
14500 \begin_layout Enumerate
14501 Install the program
14502 \begin_inset CommandInset href
14505 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
14513 \begin_layout Enumerate
14520 TeX/LaTeX\SpecialChar menuseparator
14521 Settings\SpecialChar menuseparator
14524 and select the font size you are using in your document.
14525 For example this document uses the size 12
14526 \begin_inset space \thinspace{}
14532 \begin_layout Enumerate
14536 \begin_layout Enumerate
14539 TeX/LaTeX\SpecialChar menuseparator
14542 to export the shape to coordinates.
14543 In the appearing dialog use either the outline of your shape for the coordinate
14544 s or the path itself.
14548 \begin_layout Plain Layout
14549 For more information see
14550 \begin_inset CommandInset href
14552 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
14565 \begin_layout Standard
14566 The coordinates are written into a \SpecialChar TeX
14568 To use it for your \SpecialChar LyX
14572 \begin_layout Enumerate
14573 Place the cursor before the first character of your paragraph (or into a
14577 \begin_layout Enumerate
14578 Open in \SpecialChar LyX
14581 Insert\SpecialChar menuseparator
14582 File\SpecialChar menuseparator
14584 \begin_inset space ~
14589 , select the file and use
14598 \begin_layout Standard
14599 \begin_inset VSpace defskip
14605 \begin_layout Standard
14606 \begin_inset Note Greyedout
14609 \begin_layout Plain Layout
14614 : The changed shape only applies to the current paragraph; everything is
14615 reset to normal for the next paragraph.
14616 Therefore the shape definition file must be input into every paragraph
14617 with the desired shape.
14625 \begin_layout Standard
14626 \begin_inset VSpace bigskip
14632 \begin_layout Standard
14633 Here is an example:
14636 \begin_layout Standard
14637 \begin_inset VSpace bigskip
14643 \begin_layout Standard
14644 \begin_inset CommandInset include
14646 filename "SpecialParagraphShape.tex"
14653 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14654 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14656 At vero eos et accusam et justo duo dolores et ea rebum.
14657 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
14659 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14660 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14664 \begin_layout Standard
14665 \begin_inset VSpace bigskip
14671 \begin_layout Standard
14676 to draw complexer shapes in
14680 you can draw the shape in a program of your choice and import the resulting
14686 Then you only need to draw a line or spline along the outline of the image.
14689 \begin_layout Standard
14690 \begin_inset VSpace bigskip
14696 \begin_layout Standard
14699 Custom paragraph shapes
14701 also provides the two commands
14709 which can be used to define custom shapes coordinate by coordinate.
14713 \begin_layout Plain Layout
14714 These commands are internally used for all shapes described here.
14719 For information how these styles are used and about further customization
14720 possibilities, have a look at the
14721 \begin_inset CommandInset href
14723 name "documentation"
14724 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
14730 \begin_inset Flex Code
14733 \begin_layout Plain Layout
14742 \begin_layout Chapter
14744 \change_deleted 564990737 1671304317
14748 \change_inserted 564990737 1671304322
14750 \change_deleted 564990737 1671304331
14751 ies with Bib\SpecialChar TeX
14757 \begin_layout Standard
14758 The most basic information about how to use Bib\SpecialChar TeX
14763 with \SpecialChar LyX
14764 is contained in the section
14766 Bibliography databases
14773 The following subsections explain special bibliography features supported
14774 by \SpecialChar LyX
14778 \begin_layout Section
14779 Alternative Citation Styles
14782 \begin_layout Standard
14783 Standard Bib\SpecialChar TeX
14785 \begin_inset space \thinspace{}
14789 \begin_inset space \space{}
14793 \begin_inset Quotes eld
14797 \begin_inset Quotes erd
14800 ) to refer to a cited work.
14801 However, in many scientific disciplines, other citation styles are in use.
14802 The most common one is the author-year style (e.
14803 \begin_inset space \thinspace{}
14807 \begin_inset space \space{}
14811 \begin_inset Quotes eld
14815 \begin_inset Quotes erd
14820 supports three packages that provide this style,
14821 \begin_inset Flex Code
14824 \begin_layout Plain Layout
14831 \begin_inset Flex Code
14834 \begin_layout Plain Layout
14841 \begin_inset Flex Code
14844 \begin_layout Plain Layout
14851 Each of these packages has their pros and cons, which cannot be listed
14853 If you only want to have simple author-year (or author-numerical) style,
14854 or if you want to use one of the countless style files for
14855 \begin_inset Flex Code
14858 \begin_layout Plain Layout
14864 , then the established
14865 \begin_inset Flex Code
14868 \begin_layout Plain Layout
14874 package is probably your choice.
14875 If you look for specific citation styles common in law studies, you might
14877 \begin_inset Flex Code
14880 \begin_layout Plain Layout
14887 If you want to have full control over the formatting or look for advanced
14888 features such as ibidem, footnote citations, full title citations, advanced
14889 date formats (such as 400 BC) or full localization to other languages than
14890 English, you should definitely consider
14891 \begin_inset Flex Code
14894 \begin_layout Plain Layout
14900 , which exceeds all other packages in terms of features, but is also quite
14901 heavy and more resource-hungry.
14904 \begin_layout Standard
14905 The handling of these packages in \SpecialChar LyX
14906 is basically the same.
14908 \begin_inset Flex Noun
14911 \begin_layout Plain Layout
14912 Document\SpecialChar menuseparator
14919 \begin_inset Flex Noun
14922 \begin_layout Plain Layout
14929 \begin_inset Flex Noun
14932 \begin_layout Plain Layout
14939 \begin_inset Flex Noun
14942 \begin_layout Plain Layout
14949 \begin_inset Flex Noun
14952 \begin_layout Plain Layout
14959 \begin_inset Flex Noun
14962 \begin_layout Plain Layout
14963 Biblatex (Natbib mode)
14969 \begin_inset Flex Noun
14972 \begin_layout Plain Layout
14979 \begin_inset Flex Noun
14982 \begin_layout Plain Layout
14989 \begin_inset space ~
14992 6.5.3 in the User's Guide for more information on these choices).
14993 With all these packages, you will get some extra features in the citation
14994 dialog and you can select the style of the reference (
14995 \begin_inset Quotes eld
14999 \begin_inset Quotes erd
15003 \begin_inset Quotes eld
15007 \begin_inset Quotes erd
15011 \begin_inset Quotes eld
15015 \begin_inset Quotes erd
15019 \begin_inset Quotes eld
15023 \begin_inset Quotes erd
15027 Note that either package needs specifically designed style files.
15028 They all ship their own, but there are lots of additional style files,
15029 and there is even an interactive style file builder
15033 \begin_layout Plain Layout
15035 \begin_inset Flex URL
15038 \begin_layout Plain Layout
15040 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
15051 \begin_inset Flex Code
15054 \begin_layout Plain Layout
15063 \begin_layout Section
15064 Subdivided Bibliographies
15067 \begin_layout Standard
15068 Sometimes you might need to divide your bibliography into several sections.
15069 If you are for instance a historian, the possibility to separate sources
15070 and scientific works is most likely a
15071 \begin_inset Quotes eld
15075 \begin_inset Quotes erd
15079 Unfortunately, Bib\SpecialChar TeX
15080 itself does not allow you to do this.
15081 But with the help of some \SpecialChar LaTeX
15082 packages, Bib\SpecialChar TeX
15083 can be extended to fit your needs.
15086 \begin_layout Standard
15088 provides native support for one of these packages,
15096 \begin_layout Plain Layout
15098 \begin_inset Flex URL
15101 \begin_layout Plain Layout
15103 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
15113 The advantage of this package (compared to other packages such as
15117 ) is that you don't need to define new citation commands.
15118 Instead, you need to prepare different bibliographic databases which include
15119 the entries for the different sections of the bibliography.
15120 For example: If you want to divide your bibliography into the sections
15122 \begin_inset Quotes eld
15126 \begin_inset Quotes erd
15130 \begin_inset Quotes eld
15134 \begin_inset Quotes erd
15137 , you first need to create two bibliographic databases, e.
15138 \begin_inset space \thinspace{}
15142 \begin_inset space \space{}
15146 \begin_inset Flex Code
15149 \begin_layout Plain Layout
15156 \begin_inset Flex Code
15159 \begin_layout Plain Layout
15169 \begin_layout Standard
15171 \begin_inset Flex Noun
15174 \begin_layout Plain Layout
15175 Document\SpecialChar menuseparator
15182 \begin_inset Flex Noun
15185 \begin_layout Plain Layout
15192 \begin_inset Flex Noun
15195 \begin_layout Plain Layout
15196 Subdivided bibliography
15202 Now you can insert multiple Bib\SpecialChar TeX
15203 bibliographies, one for each section of
15205 Returning to our example: Insert the Bib\SpecialChar TeX
15207 \begin_inset Flex Code
15210 \begin_layout Plain Layout
15216 and a second one for the database
15217 \begin_inset Flex Code
15220 \begin_layout Plain Layout
15227 You are free to use the same or different styles for each section.
15228 Additionally, you can choose if the bibliography section should contain
15230 \begin_inset Quotes eld
15233 all cited references
15234 \begin_inset Quotes erd
15237 of the specified database(s) (which is the default),
15238 \begin_inset Quotes eld
15241 all uncited references
15242 \begin_inset Quotes erd
15246 \begin_inset Quotes eld
15250 \begin_inset Quotes erd
15254 This might be useful if you would like to separate your bibliography into
15256 \begin_inset Quotes eld
15260 \begin_inset Quotes erd
15264 \begin_inset Quotes eld
15268 \begin_inset Quotes erd
15272 \begin_inset Quotes eld
15276 \begin_inset Quotes erd
15280 The titles for the sections can be added as ordinary sections or subsections.
15282 \begin_inset Flex Code
15285 \begin_layout Plain Layout
15291 removes the bibliography title, you have to manually re-add that, too (as
15292 a chapter* or section*, for instance).
15295 \begin_layout Standard
15300 , the procedure is a bit different.
15309 , the aforementioned
15310 \begin_inset Flex Noun
15313 \begin_layout Plain Layout
15314 Subdivided bibliography
15319 option is disabled if you use
15328 provides its own means to generate subdivided bibliographies.
15329 You can either add keywords to bibliography entries via the
15330 \begin_inset Flex Code
15333 \begin_layout Plain Layout
15339 entry option and then filter bibliography sections by keyword (by adding
15341 \begin_inset Flex Code
15344 \begin_layout Plain Layout
15351 \begin_inset Flex Noun
15354 \begin_layout Plain Layout
15360 field of the dialog that opens if you left-click on the
15361 \begin_inset Flex Noun
15364 \begin_layout Plain Layout
15365 Biblatex Generated Bibliography
15370 button), or you can filter by entry types (such as
15379 \begin_inset space \thinspace{}
15384 \begin_inset Flex Code
15387 \begin_layout Plain Layout
15394 \begin_inset Flex Code
15397 \begin_layout Plain Layout
15404 \begin_inset Flex Noun
15407 \begin_layout Plain Layout
15413 field, or you can create so-called
15414 \begin_inset Quotes eld
15417 Bibliography Categories
15418 \begin_inset Quotes erd
15421 to which you can assign individual entries.
15422 Please refer to the Biblatex manual, section
15424 Subdivided Bibliographies
15429 \begin_layout Section
15430 Multiple Bibliographies
15431 \begin_inset CommandInset label
15433 name "subsec:Multiple-Bibliographies"
15440 \begin_layout Standard
15441 Multiple bibliographies, e.
15442 \begin_inset space \thinspace{}
15446 \begin_inset space \space{}
15449 a bibliography for each part, chapter, section, subsection or child (sub-documen
15450 t) of the document, are also supported by \SpecialChar LyX
15452 In order to enable it, go to
15453 \begin_inset Flex Noun
15456 \begin_layout Plain Layout
15457 Document\SpecialChar menuseparator
15458 Settings\SpecialChar menuseparator
15464 and select the relevant unit (e.
15465 \begin_inset space \thinspace{}
15469 \begin_inset Quotes eld
15473 \begin_inset Quotes erd
15477 \begin_inset Flex Noun
15480 \begin_layout Plain Layout
15481 Multiple Bibliographies
15487 Then add a Bib(la)\SpecialChar TeX
15488 bibliography to each unit (e.
15489 \begin_inset space \thinspace{}
15492 g., section) of your document.
15493 In the output, a separate bibliography, containing only the references
15494 done in the current unit is generated.
15497 \begin_layout Standard
15498 If you use Bib\SpecialChar TeX
15500 \begin_inset Flex Code
15503 \begin_layout Plain Layout
15510 \begin_inset Flex Code
15513 \begin_layout Plain Layout
15519 package is used to create multiple bibliographies.
15520 The former package is used if you select
15521 \begin_inset Quotes eld
15525 \begin_inset Quotes erd
15533 \begin_inset Flex Noun
15536 \begin_layout Plain Layout
15537 Sectioned Bibliography
15543 In all other cases,
15544 \begin_inset Flex Code
15547 \begin_layout Plain Layout
15557 \begin_layout Plain Layout
15558 An alternative approach, if you are willing to use some
15559 \begin_inset Flex Noun
15562 \begin_layout Plain Layout
15570 \begin_inset space ~
15574 \begin_inset CommandInset ref
15576 reference "sec:Inserting-TeX-Code"
15581 \begin_inset Flex Code
15584 \begin_layout Plain Layout
15596 \begin_inset Flex Code
15599 \begin_layout Plain Layout
15605 is used, \SpecialChar LyX
15606 encloses the specified units in
15607 \begin_inset Flex Code
15610 \begin_layout Plain Layout
15617 \begin_inset Flex Code
15620 \begin_layout Plain Layout
15629 \begin_inset Flex Code
15632 \begin_layout Plain Layout
15640 in order to create the units.
15641 Note that this approach has some limitations.
15642 First, every citation reference has to be inside some
15643 \begin_inset Flex Code
15646 \begin_layout Plain Layout
15653 So citations outside a defined unit (e.
15654 \begin_inset space \thinspace{}
15657 g., before the first section if you use
15658 \begin_inset Quotes eld
15662 \begin_inset Quotes erd
15666 \begin_inset Quotes eld
15670 \begin_inset Quotes erd
15674 You can also create your own units by entering
15675 \begin_inset Flex Code
15678 \begin_layout Plain Layout
15687 \begin_inset Flex Code
15690 \begin_layout Plain Layout
15698 as \SpecialChar TeX
15699 code (for instance to work around the mentioned limitation).
15701 \begin_inset Flex Code
15704 \begin_layout Plain Layout
15710 s cannot be nested.
15711 A second limitation is that
15712 \begin_inset Flex Code
15715 \begin_layout Plain Layout
15721 always processes all references of a bibliography database, even if they
15723 This can result in odd labels (e.
15724 \begin_inset space \thinspace{}
15729 \begin_inset Quotes eld
15733 \begin_inset Quotes erd
15736 if two works of this author from 2014 are in the database, even if only
15740 \begin_layout Standard
15746 \begin_inset Flex Code
15749 \begin_layout Plain Layout
15755 option is used instead.
15756 If you need specific units, you can start them with the \SpecialChar TeX
15758 \begin_inset Flex Code
15761 \begin_layout Plain Layout
15770 \begin_inset Flex Code
15773 \begin_layout Plain Layout
15782 If you also want to control the end of the unit, use the environment
15783 \begin_inset Flex Code
15786 \begin_layout Plain Layout
15796 \begin_inset Flex Code
15799 \begin_layout Plain Layout
15809 \begin_inset Flex Code
15812 \begin_layout Plain Layout
15818 s cannot be nested.
15819 In addition to the individual bibliography of the current unit,
15823 also provides an easy way to output all bibliographies, subsequently, at
15825 \begin_inset space \thinspace{}
15828 g., at the end of the document).
15830 \begin_inset Quotes eld
15833 all reference units
15834 \begin_inset Quotes erd
15837 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
15839 Please refer to the
15843 manual for more information on this topic.
15846 \begin_layout Chapter
15850 \begin_layout Section
15851 Multipart Documents
15854 \begin_layout Subsection
15858 \begin_layout Standard
15859 When you are working on a large file with many sections, it is often convenient
15860 to break up the document into several files, or perhaps you have something
15861 where a table may change from time to time, but the preceding text does
15863 In these cases, you should seriously consider using multipart documents.
15864 For example, scientific papers often have five major sections: the introduction
15865 , observations, results, discussion, and conclusion.
15866 Each of these could be its own separate \SpecialChar LyX
15868 \begin_inset Quotes eld
15872 \begin_inset Quotes erd
15875 file which contains the title, authors, abstract, references, etc., plus
15876 the five included files.
15877 It is important to note that each of these files is a full \SpecialChar LyX
15879 can be formatted and printed on its own, as well as included in a master
15881 Each of these files must have the same document class, however—don't attempt
15882 to mix book classes with article classes.
15883 You may also include \SpecialChar LaTeX
15884 files; however, these files must not have their own
15886 \begin_inset space \thinspace{}
15890 \begin_inset space \space{}
15893 everything up to and including the
15894 \begin_inset Flex Code
15897 \begin_layout Plain Layout
15905 line as well as the
15906 \begin_inset Flex Code
15909 \begin_layout Plain Layout
15917 line must be deleted) or else errors will be generated when you try to
15921 \begin_layout Standard
15923 allows you to include files quite easily with
15924 \begin_inset Flex Noun
15927 \begin_layout Plain Layout
15928 Insert\SpecialChar menuseparator
15930 \begin_inset space ~
15939 When you click on this selection a small box is inserted into the file
15940 at the current cursor location.
15941 Clicking on the box raises a dialog which allows you to select the file
15942 to be included, and the method of its inclusion.
15946 \begin_layout Standard
15947 The file selection box should by now be obvious.
15948 The three inclusion methods are
15949 \begin_inset Quotes eld
15953 \begin_inset Quotes erd
15957 \begin_inset Quotes eld
15961 \begin_inset Quotes erd
15965 \begin_inset Quotes eld
15969 \begin_inset Quotes erd
15974 \begin_inset Quotes eld
15978 \begin_inset Quotes erd
15982 \begin_inset Quotes eld
15986 \begin_inset Quotes erd
15989 are similar in many ways, but there are also some notable differences:
15992 \begin_layout Enumerate
15994 \begin_inset Quotes eld
15998 \begin_inset Quotes erd
16001 are typeset beginning on a new page, while files that are
16002 \begin_inset Quotes eld
16006 \begin_inset Quotes erd
16009 are typeset starting on the current page.
16012 \begin_layout Enumerate
16013 \begin_inset Quotes eld
16017 \begin_inset Quotes erd
16020 files cannot themselves
16021 \begin_inset Quotes eld
16025 \begin_inset Quotes erd
16029 \begin_inset Quotes eld
16033 \begin_inset Quotes erd
16038 \begin_inset Quotes eld
16042 \begin_inset Quotes erd
16045 , on the other hand, infinite sub-inputting is possible.
16048 \begin_layout Enumerate
16049 \begin_inset Quotes eld
16053 \begin_inset Quotes erd
16056 allow for the output of only selected
16057 \begin_inset Quotes eld
16061 \begin_inset Quotes erd
16064 files, while maintaining the actual counters (pagination etc.) and references
16065 (please refer to the section
16068 \begin_inset space ~
16076 \begin_inset space ~
16081 manual for details).
16084 \begin_layout Standard
16086 \begin_inset Quotes eld
16090 \begin_inset Quotes erd
16093 is the preferred method for chapters that are outsourced to child documents,
16095 \begin_inset Quotes eld
16099 \begin_inset Quotes erd
16102 is more suitable for arbitrary file inheritance.
16105 \begin_layout Standard
16107 \begin_inset Quotes eld
16111 \begin_inset Quotes erd
16114 included file allows you to include a file typeset exactly as it appears
16116 \begin_inset space \thinspace{}
16120 \begin_inset space \space{}
16124 \begin_inset Flex Code
16127 \begin_layout Plain Layout
16133 mode, with the characters set in a fixed-width typewriter font.
16134 Normally, spaces in this file are invisible, though two consecutive spaces
16135 are conserved, unlike \SpecialChar LyX
16136 's normal treatment of spaces.
16137 However, setting the
16138 \begin_inset Flex Noun
16141 \begin_layout Plain Layout
16143 \begin_inset space ~
16147 \begin_inset space ~
16151 \begin_inset space ~
16159 checkbox typesets a mark to unambiguously define the presence of a space.
16163 \begin_layout Standard
16164 Generally, the master file is converted into a full \SpecialChar LaTeX
16165 file before typesetting,
16166 while the included files are converted to \SpecialChar LaTeX
16167 files that do not have all the
16168 preamble information.
16171 \begin_layout Subsection
16172 Cross-References Between Files
16175 \begin_layout Standard
16176 \begin_inset Box Shadowbox
16186 height_special "totalheight"
16191 backgroundcolor "none"
16194 \begin_layout Plain Layout
16195 This section is somewhat out of date.
16196 Need to describe default master documents and how children are opened when
16206 \begin_layout Standard
16207 It is possible to set up cross-references between the different files.
16208 First, open all the files in question: let's call them A and B in a two
16209 file example, where B is included in A.
16210 Let's say you insert a label in A, then want to reference it in B.
16211 Open the cross-reference dialog whilst in document B, and you can select
16213 \begin_inset Quotes eld
16217 \begin_inset Quotes erd
16223 \begin_layout Subsection
16224 Bibliography Lists in all Subdocuments
16227 \begin_layout Standard
16228 If you work with child documents, you might want to have only one main bibliogra
16229 phy at the end, but still be able to have a selected bibliography for the
16230 child if you output it on its own.
16231 Here is how to achieve this.
16234 \begin_layout Standard
16235 For the main document, you just insert a bibliography inset at the place
16236 where the main bibliography has to appear (within the master file or within
16238 If the bibliography inset is in the master file, the references will be
16239 inherited by all children, so they are available in the citation dialog
16243 \begin_layout Standard
16244 For child-specific bibliographies, insert bibliography insets within the
16245 child documents, at the place where the bibliography should appear when
16246 the child is compiled separately.
16247 However, the trick is to insert them into a branch (
16249 Insert\SpecialChar menuseparator
16250 Branch\SpecialChar menuseparator
16251 Insert New Branch...
16254 \begin_inset space \thinspace{}
16259 \begin_inset Quotes eld
16263 \begin_inset Quotes erd
16267 Within the children, activate the branch (
16269 Document\SpecialChar menuseparator
16270 Settings...\SpecialChar menuseparator
16274 Within the master, deactivate the branch (
16276 Document\SpecialChar menuseparator
16277 Settings...\SpecialChar menuseparator
16281 Now the child's bibliography will be ignored by the master, but considered
16285 \begin_layout Standard
16286 If you need multiple bibliographies (e.
16287 \begin_inset space \thinspace{}
16290 g., one per child in the
16294 ), please refer to sec.
16295 \begin_inset space ~
16299 \begin_inset CommandInset ref
16301 reference "subsec:Multiple-Bibliographies"
16308 \begin_layout Section
16313 \begin_layout Standard
16314 Users sometimes need to be able to
16315 \begin_inset Quotes eld
16319 \begin_inset Quotes erd
16323 file together with all the images (and other files) on which it depends,
16324 either for sending to a publisher or for sharing with a co-author.
16326 includes a Python script (
16327 \begin_inset Flex Code
16330 \begin_layout Plain Layout
16336 ) that automates this process.
16337 To use it, you must have either the
16338 \begin_inset Flex Code
16341 \begin_layout Plain Layout
16348 \begin_inset Flex Code
16351 \begin_layout Plain Layout
16357 python modules installed on your system.
16358 By default, the script prefers the
16359 \begin_inset Flex Code
16362 \begin_layout Plain Layout
16369 \begin_inset Flex Code
16372 \begin_layout Plain Layout
16378 format on Unix-like systems and the
16379 \begin_inset Flex Code
16382 \begin_layout Plain Layout
16391 \begin_layout Standard
16393 's configuration process will set the script up to export a `\SpecialChar LyX
16395 and this format will then be available under
16396 \begin_inset Flex Code
16399 \begin_layout Plain Layout
16400 File\SpecialChar menuseparator
16409 \begin_layout Standard
16410 Independently of the platform, the generation of a particular archive format
16411 can be forced by adding either the
16412 \begin_inset Flex Code
16415 \begin_layout Plain Layout
16422 \begin_inset Flex Code
16425 \begin_layout Plain Layout
16432 \begin_inset Flex Code
16435 \begin_layout Plain Layout
16442 \begin_inset Flex Code
16445 \begin_layout Plain Layout
16451 format) switch to the
16452 \begin_inset Flex Code
16455 \begin_layout Plain Layout
16457 \SpecialChar menuseparator
16465 \begin_inset Flex Code
16468 \begin_layout Plain Layout
16469 Tools\SpecialChar menuseparator
16470 Preferences\SpecialChar menuseparator
16471 File Handling\SpecialChar menuseparator
16478 (Make sure you add the switch after the script name, not before it.)
16481 \begin_layout Section
16482 Fancy Headers and Footers
16485 \begin_layout Standard
16486 The default page layout is rather plain; for an
16487 \begin_inset Flex Code
16490 \begin_layout Plain Layout
16496 document class, all you get is a centered page number at the bottom of
16498 This document uses KOMA-script's book class, so it appears to be a bit
16500 But to really put on a show, you need to set the document page style to
16502 \begin_inset Quotes eld
16506 \begin_inset Quotes erd
16509 , as mentioned in the
16514 This section describes the \SpecialChar LaTeX
16515 code you need to insert in your \SpecialChar LaTeX
16517 order to get the desired effects.
16520 \begin_layout Standard
16521 For more information on fancy headers, see the
16522 \begin_inset Flex Code
16525 \begin_layout Plain Layout
16531 package documentation.
16533 \begin_inset Flex URL
16536 \begin_layout Plain Layout
16538 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
16546 \begin_layout Standard
16547 The page header is divided into three fields, not surprisingly labeled
16548 \begin_inset Quotes eld
16552 \begin_inset Quotes erd
16556 \begin_inset Quotes eld
16560 \begin_inset Quotes erd
16564 \begin_inset Quotes eld
16568 \begin_inset Quotes erd
16572 The footer is also divided into these three fields.
16573 The \SpecialChar LaTeX
16574 commands to set these fields in the simplest manner are
16575 \begin_inset Flex Code
16578 \begin_layout Plain Layout
16587 \begin_inset Flex Code
16590 \begin_layout Plain Layout
16599 \begin_inset Flex Code
16602 \begin_layout Plain Layout
16611 \begin_inset Flex Code
16614 \begin_layout Plain Layout
16623 Suppose you wish to put your name in the upper left hand corner of each
16625 Simply insert the following command in the preamble:
16628 \begin_layout Standard
16637 \begin_layout Standard
16638 You will now see your name in the upper left.
16639 If a field has a default entry that you would like to get rid of (often
16640 the page number appears in the central footer) simply include a command
16641 with a blank argument, e.
16642 \begin_inset space \thinspace{}
16648 \begin_layout Standard
16656 \begin_layout Standard
16657 Let's get really fancy: lets put the section number with the word
16658 \begin_inset Quotes eld
16662 \begin_inset Quotes erd
16666 \begin_inset space \thinspace{}
16670 \begin_inset space \space{}
16673 Section 3) in the upper left, the page number (e.
16674 \begin_inset space \thinspace{}
16678 \begin_inset space \space{}
16681 Page 4) in the upper right, your name in the lower left, and the date in
16683 The following commands should now appear in the preamble:
16686 \begin_layout Standard
16696 \begin_layout Standard
16704 \begin_layout Standard
16714 \begin_layout Standard
16723 \begin_layout Standard
16731 \begin_layout Standard
16741 \begin_layout Standard
16743 \begin_inset Flex Code
16746 \begin_layout Plain Layout
16755 \begin_inset Flex Code
16758 \begin_layout Plain Layout
16766 access \SpecialChar LaTeX
16767 's section and page counters, and so print out the current section
16770 \begin_inset Flex Code
16773 \begin_layout Plain Layout
16781 simply prints out today's date.
16784 \begin_layout Standard
16785 The thicknesses of the horizontal rules drawn beneath the header and above
16786 the footer can also be modified.
16787 If you don't want one of the rules, set its thickness to 0.
16788 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
16794 \begin_inset Flex Code
16797 \begin_layout Plain Layout
16802 headrulewidth}{0.4pt}
16808 \begin_inset Flex Code
16811 \begin_layout Plain Layout
16816 footrulewidth}{0.4pt}
16821 to set the thicknesses.
16824 \begin_layout Standard
16825 You can switch the header/footer settings on and off for individual pages
16826 using commands like
16827 \begin_inset Flex Code
16830 \begin_layout Plain Layout
16833 thispagestyle{empty}
16839 \begin_inset Flex Code
16842 \begin_layout Plain Layout
16845 thispagestyle{plain}
16851 \begin_inset Flex Code
16854 \begin_layout Plain Layout
16857 thispagestyle{fancy}
16863 Simply insert them in the text on the page you want changed and mark them
16864 as \SpecialChar TeX
16866 In fact, title pages are marked as plain by default, while following pages
16867 are marked fancy when using the global fancy setting.
16870 \begin_layout Standard
16871 As a final example, it is possible to include an image in the header or
16873 Suppose you want to put a company logo in the upper lefthand corner.
16874 You might try something like
16877 \begin_layout Standard
16886 includegraphics{logo.eps}}}
16889 \begin_layout Standard
16891 (you may need to preface this with
16892 \begin_inset Flex Code
16895 \begin_layout Plain Layout
16898 usepackage{graphics}
16903 if you don't include graphics elsewhere in your document).
16906 \begin_layout Section
16907 Itemize Bullet Selection
16908 \begin_inset CommandInset label
16917 \begin_layout Standard
16923 \begin_layout Subsection
16927 \begin_layout Standard
16929 provides 216 bullet shapes that can be accessed from a simple dialog.
16930 Using this dialog you can easily specify what bullet shape to use at each
16931 level of an itemized list.
16932 These settings are document-wide so you won't be able to specify different
16933 sets of bullets for different paragraphs.
16937 \begin_layout Plain Layout
16938 Well, actually you can but you'll have to do it by hand.
16946 \begin_layout Subsection
16950 \begin_layout Standard
16951 Open the dialog by selecting the
16952 \begin_inset Flex Noun
16955 \begin_layout Plain Layout
16956 Document\SpecialChar menuseparator
16962 menu item and then select the
16963 \begin_inset Flex Noun
16966 \begin_layout Plain Layout
16975 \begin_layout Standard
16976 The dialog provides you with a table of bullet shapes.
16977 A column of buttons on the left of the table provides access to the six
16978 different panels of bullet shapes.
16979 The row of buttons across the top is used to select which bullet depth
16982 \change_deleted 244031559 1603875981
16983 A text entry under the table shows the currently selected bullet shape's
16985 equivalent and this can be edited if desired.
16986 If you do modify the text you will also need to specify any needed packages
16987 in the \SpecialChar LaTeX
16993 \begin_layout Standard
16994 The six panels are divided up by the packages they require.
16995 The following table shows the mappings from button name to \SpecialChar LaTeX
16999 \begin_layout Standard
17001 \begin_inset Tabular
17002 <lyxtabular version="3" rows="7" columns="2">
17003 <features tabularvalignment="middle">
17004 <column alignment="center" valignment="top" width="0pt">
17005 <column alignment="center" valignment="top" width="0pt">
17007 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
17010 \begin_layout Plain Layout
17025 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
17028 \begin_layout Plain Layout
17045 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
17048 \begin_layout Plain Layout
17063 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
17066 \begin_layout Plain Layout
17075 base \SpecialChar LaTeX
17083 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
17086 \begin_layout Plain Layout
17101 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
17104 \begin_layout Plain Layout
17121 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
17124 \begin_layout Plain Layout
17139 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
17142 \begin_layout Plain Layout
17159 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
17162 \begin_layout Plain Layout
17177 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
17180 \begin_layout Plain Layout
17197 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
17200 \begin_layout Plain Layout
17215 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
17218 \begin_layout Plain Layout
17235 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
17238 \begin_layout Plain Layout
17253 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
17256 \begin_layout Plain Layout
17279 \begin_layout Standard
17281 doesn't stop you using bullets from packages you don't have.
17282 If you get errors from \SpecialChar LaTeX
17283 when you try to view or print the file, then it
17284 is likely you are missing a package.
17288 \begin_layout Plain Layout
17290 doesn't restrict your use since you may be editing locally and exporting
17299 \begin_layout Subsection
17303 \begin_layout Standard
17304 Select which bullet depth you want to change then select the bullet shape
17306 Any changes will not be visible in \SpecialChar LyX
17307 , but are visible when viewing the document.
17310 \begin_layout Standard
17311 You can reset a bullet shape to the default simply by clicking your right
17312 mouse button on the appropriate bullet depth button.
17316 \begin_layout Plain Layout
17321 want to have multiple sets of paragraphs with different sets of bullets
17322 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
17324 The bullet selection dialog can help though because it provides you with
17325 the \SpecialChar LaTeX
17326 code for a wide range of bullet shapes.
17327 To make your own custom paragraphs you have the following options:
17330 \begin_layout Plain Layout
17334 \begin_layout Plain Layout
17350 \begin_layout Plain Layout
17354 \begin_layout Plain Layout
17376 \begin_layout Itemize
17377 Use the \SpecialChar LaTeX
17379 \begin_inset Flex Code
17382 \begin_layout Plain Layout
17390 to specify a new bullet shape for a given depth.
17391 You'll also need to save the current bullet shape so you can restore it
17393 In this itemized list the following \SpecialChar LaTeX
17394 code was used to change the bullet
17395 used for the first depth.
17399 \begin_layout LyX-Code
17409 \begin_layout LyX-Code
17426 \begin_layout Itemize
17427 Note that the itemize depth is specified in Roman numerals as part of the
17437 \begin_layout Itemize
17438 \begin_inset Argument item:1
17441 \begin_layout Plain Layout
17445 \begin_layout Plain Layout
17463 Specify each individual entry by starting each item with the bullet shape
17465 \begin_inset Quotes eld
17469 \begin_inset Quotes erd
17472 inset (available at
17474 Insert\SpecialChar menuseparator
17478 \begin_inset Flex Noun
17481 \begin_layout Plain Layout
17489 For example, this item was started with
17490 \begin_inset Flex Code
17493 \begin_layout Plain Layout
17508 \begin_layout Plain Layout
17512 \begin_layout Plain Layout
17528 \begin_layout Plain Layout
17529 You'll also need to revert the labelitem back to its previous setting for
17530 the global bullet shape settings to remain in effect.
17531 The way used here was:
17534 \begin_layout LyX-Code
17549 \begin_layout Chapter
17551 and the World Wide Web
17554 \begin_layout Standard
17556 has long supported the export of documents to various web-friendly formats,
17558 Before version 2.0, however, HTML export was always accomplished by the
17559 use of external converters.
17563 \begin_layout Plain Layout
17564 For details on the use of external converters with \SpecialChar LyX
17569 section of the Customization manual.
17574 These fall into two large groups: there are converters that use \SpecialChar LaTeX
17576 intermediate format, such as
17577 \begin_inset Flex Code
17580 \begin_layout Plain Layout
17587 \begin_inset Flex Code
17590 \begin_layout Plain Layout
17597 \begin_inset Flex Code
17600 \begin_layout Plain Layout
17606 , relying upon \SpecialChar LyX
17607 to produce the \SpecialChar LaTeX
17608 ; and there is a converter that works directly
17609 on \SpecialChar LyX
17611 \begin_inset Flex Code
17614 \begin_layout Plain Layout
17622 All of these have different advantages and disadvantages.
17626 \begin_layout Standard
17627 The \SpecialChar LaTeX
17628 -based converters have the advantage that, in principle, they know everythin
17629 g about the exported document that \SpecialChar LaTeX
17631 Such converters do not care, for example, if a certain block of code was
17632 produced by \SpecialChar LyX
17633 or was Evil Red Text.
17634 These converters know about
17635 \begin_inset Flex Code
17638 \begin_layout Plain Layout
17644 files, counters, and references, and can often make use of the
17645 \begin_inset Flex Code
17648 \begin_layout Plain Layout
17654 files generated by Bib\SpecialChar TeX
17656 On the other hand, \SpecialChar LaTeX
17657 is a very hard language to parse—it is sometimes said
17658 that only \SpecialChar TeX
17659 itself understands \SpecialChar TeX
17660 —and \SpecialChar LaTeX
17661 -based converters will often choke on
17662 what seem to be quite simple constructs; complex ones can throw them completely
17663 , and as of this writing, for example, the
17667 manual will not export with
17668 \begin_inset Flex Code
17671 \begin_layout Plain Layout
17677 , though the others will.
17678 The other issue concerns how math is handled.
17679 These converters typically convert the formulae into little pictures that
17680 are then linked from the HTML document.
17681 Since these are actually generated by \SpecialChar LaTeX
17682 , they are accurate.
17683 But they do not scale well, and just getting them to look as if they are
17684 actually meant to be in your document—so that the font sizes seem to be
17685 roughly the same—can be a challenge.
17688 \begin_layout Standard
17690 \begin_inset Flex Code
17693 \begin_layout Plain Layout
17701 \begin_inset CommandInset href
17703 name "http://pinchito.es/elyxer/"
17704 target "http://pinchito.es/elyxer/"
17709 ) solves some of these problems.
17710 In particular, the formulae it produces scale perfectly, since it renders
17711 math using a combination of HTML and CSS rather than converting the formulae
17713 But even moderately complex formula are rendered less well than with
17714 \begin_inset Flex Code
17717 \begin_layout Plain Layout
17723 ; this reflects the limitations of HTML.
17727 \begin_layout Plain Layout
17729 \begin_inset Flex Code
17732 \begin_layout Plain Layout
17739 can also use jsMath and MathJax for equations, but this setting is only
17740 available globally and requires one to have access to a server that runs
17746 More importantly (as of version 1.1.1, at least),
17747 \begin_inset Flex Code
17750 \begin_layout Plain Layout
17757 has limited support for math macros and no support for user-defined paragraph
17758 or character styles.
17759 These limitations make
17760 \begin_inset Flex Code
17763 \begin_layout Plain Layout
17770 unsuitable for many of the documents \SpecialChar LyX
17772 In principle, of course, these problems could be solved, but the \SpecialChar LyX
17774 have decided to follow a different path and have made \SpecialChar LyX
17776 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
17777 , DocBook, and plaintext.
17780 \begin_layout Standard
17781 As of this writing, XHTML output remains under development and should probably
17783 \begin_inset Quotes eld
17787 \begin_inset Quotes erd
17794 \begin_layout Plain Layout
17796 \begin_inset Flex Code
17799 \begin_layout Plain Layout
17800 development/HTML/HTML.notes
17805 , which can be found in the \SpecialChar LyX
17807 \begin_inset CommandInset href
17809 name "accessed online"
17810 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
17815 , usually contains up-to-date information about the state of XHTML output.
17816 See also the list of XHTML bugs on
17817 \begin_inset CommandInset href
17819 name "the bug tracker"
17820 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"
17830 Still, the developers have chosen this approach because it has several
17831 potential advantages over the other two.
17834 \begin_layout Standard
17835 These advantages are primarily due to the fact that the XHTML output routines,
17836 since they are part of \SpecialChar LyX
17837 , know everything \SpecialChar LyX
17838 knows about the document being
17843 \begin_layout Plain Layout
17844 Another advantage is that, since these routines are internal to \SpecialChar LyX
17846 immune to changes in \SpecialChar LyX
17847 's file format, or to changes in the semantics of
17853 So they know about the table of contents (as displayed in the outline),
17854 about the counters associated with different paragraph styles, and about
17855 user-defined styles.
17856 The XHTML output routines know what \SpecialChar LyX
17857 knows about internationalization,
17858 too, so they will output
17859 \begin_inset Quotes eld
17863 \begin_inset Quotes erd
17867 \begin_inset Quotes eld
17875 \begin_inset Quotes erd
17878 , depending upon the language in effect at the time.
17882 \begin_layout Standard
17883 Quite generally, the output routines know what \SpecialChar LyX
17884 knows about document layout,
17885 that is, about how the document is to be rendered on screen.
17886 We use this information when we output the document as XHTML.
17887 In particular, \SpecialChar LyX
17892 generates CSS style information corresponding to the layout information
17893 it uses to render the document on screen: if section headings are supposed
17894 to be sans-serif and bold as seen in \SpecialChar LyX
17895 , then (by default) they will be sans-seri
17896 f and bold when viewed in a web browser, too.
17897 And this is true not just for pre-defined styles, like Section, but for
17898 any style, including user-defined styles.
17899 Indeed, the XHTML output routines make no distinction between user-defined
17901 \change_deleted 244031559 1603876931
17903 \change_inserted 244031559 1603876940
17906 styles and \SpecialChar LyX
17907 's own pre-defined styles: in each case, everything \SpecialChar LyX
17909 the styles is contained in the layout files.
17910 And much the same is true as regards pre-defined textual insets, such as
17911 footnotes, and various custom insets.
17915 \begin_layout Standard
17916 The result is that XHTML output can be customized and extended in exactly
17917 the same way \SpecialChar LaTeX
17918 output can be customized and extended: through layout files
17920 See chapter five of the
17924 manual for the details.
17927 \begin_layout Standard
17928 The remainder of this chapter contains more detailed information on XHTML
17929 output, its limitations, and ways to work around those limitations.
17932 \begin_layout Section
17933 Math Output in XHTML
17936 \begin_layout Standard
17938 offers four choices for how math is rendered.
17939 These have various advantages and disadvantages:
17942 \begin_layout Itemize
17944 \begin_inset Newline newline
17947 MathML is a dialect of XML designed specifically for mathematics on the
17948 web, and it typically renders very well in browsers that support it.
17949 The disadvantage is that not all browsers support MathML, and support is
17950 not complete even in the Gecko-based browsers, such as Firefox.
17951 \begin_inset Newline newline
17954 If \SpecialChar LyX
17955 is unable to render a formula as MathML—for example, if the formula
17957 \begin_inset Flex Code
17960 \begin_layout Plain Layout
17966 package or ERT—then it will instead output the formula as an image.
17970 \begin_layout Itemize
17972 \begin_inset Newline newline
17975 As mentioned above,
17976 \begin_inset Flex Code
17979 \begin_layout Plain Layout
17985 outputs math as HTML, styled by CSS.
17989 \begin_layout Plain Layout
17991 has borrowed some of the CSS for its HTML output from
17992 \begin_inset Flex Code
17995 \begin_layout Plain Layout
18006 For simple formulae, this can work quite well, though with more complicated
18007 formulae it tends to break down.
18008 Still, this method has the advantage that it is very widely supported and
18009 so it may be appropriate for documents that contain only a little, fairly
18011 \begin_inset Newline newline
18014 If Lyx is unable to render a formula as HTML—for example, if the formula
18016 \begin_inset Flex Code
18019 \begin_layout Plain Layout
18025 package or ERT—then it will instead output the formula as an image.
18029 \begin_layout Itemize
18031 \begin_inset Newline newline
18035 \begin_inset Flex Code
18038 \begin_layout Plain Layout
18045 will output formulae as images, the very same images, in fact, that are
18046 used for instant preview.
18050 \begin_layout Plain Layout
18051 Instant preview does
18055 have to be on for images to be output, however.
18060 The advantage to this method is that the images are simply generated by
18062 , so they are very accurate.
18063 The disadvantage, as mentioned earlier, is that these are bitmapped images,
18064 so they do not scale terribly well, and one cannot copy them, etc.
18065 \begin_inset Newline newline
18068 The size of the images can be controlled by setting the
18069 \begin_inset Quotes eld
18072 Math Images Scaling
18073 \begin_inset Quotes erd
18077 \begin_inset Flex Noun
18080 \begin_layout Plain Layout
18081 Document\SpecialChar menuseparator
18082 Settings\SpecialChar menuseparator
18092 \begin_layout Plain Layout
18093 For those who want to know, this controls the resolution of the image in
18094 dots per inch and is based upon a default of 75 dpi.
18100 \begin_inset Newline newline
18103 If \SpecialChar LyX
18104 for some reason fails to create an image for a formula (e.g., if a required
18106 package is not installed), then it will fall back to outputing the raw
18111 \begin_layout Itemize
18114 \begin_inset Newline newline
18117 Finally, \SpecialChar LyX
18118 will happily output math as \SpecialChar LaTeX
18120 As well as being the output of last resort, this method can be used with
18122 \begin_inset CommandInset href
18125 target "http://www.math.union.edu/~dpvc/jsMath/"
18130 , which uses JavaScript to render \SpecialChar LaTeX
18131 embedded in HTML documents.
18133 wraps the \SpecialChar LaTeX
18135 \begin_inset Flex Code
18138 \begin_layout Plain Layout
18144 (for inline formulas) or
18145 \begin_inset Flex Code
18148 \begin_layout Plain Layout
18154 (for displayed formulas) with
18155 \begin_inset Flex Code
18158 \begin_layout Plain Layout
18164 , as is required for jsMath.
18167 \begin_layout Standard
18168 One of these output methods must be selected under
18169 \begin_inset Flex Noun
18172 \begin_layout Plain Layout
18173 Document\SpecialChar menuseparator
18174 Settings\SpecialChar menuseparator
18181 By default, \SpecialChar LyX
18183 This is a document-wide setting, therefore.
18186 \begin_layout Standard
18187 Eventually, \SpecialChar LyX
18188 will offer the user the option to select an alternate output
18189 method for a particular inset, say, one that isn't being rendered very
18194 \begin_layout Plain Layout
18195 That said, since \SpecialChar LyX
18196 falls back to images if the inset contains ERT, then one
18197 can force output as an image by putting some harmless ERT into the math,
18199 \begin_inset Formula $a=b\relax$
18210 \begin_layout Section
18211 Bibliography and Citations
18214 \begin_layout Standard
18215 XHTML output fully supports bibliographies and citations.
18219 \begin_layout Standard
18220 Citation labels are generated by the same machinery that generates \SpecialChar LyX
18222 labels, so the labels will look in the output much as they do in \SpecialChar LyX
18225 If you are using numerical citations, then \SpecialChar LyX
18226 will output numerical labels,
18227 such as [1] or [17], rather than simply showing the citation key in square
18228 brackets, as it does on-screen.
18229 If you are using author-year citations, then \SpecialChar LyX
18230 will add lowercase letters
18231 to the years, just as Bib\SpecialChar TeX
18232 does, if it finds more than one citation for
18233 a given author-year combination.
18234 The labels will be printed with the bibliography entries.
18235 Note that there is, at present, no way to customize the appearance of the
18236 labels, for example, to choose between square brackets and parentheses.
18239 \begin_layout Standard
18240 Bibliography output is handled by the same machinery that handles the presentati
18241 on of reference information in the citation dialog, so you will see in the
18242 XHTML output pretty much what you would see if you were to look at a given
18243 entry in the citation dialog.
18244 The formatting can be customized in your layout file or, preferably, in
18250 manual for the details.
18253 \begin_layout Standard
18254 The main defect at present is that cross-referenced information is printed
18255 with every entry with which it is associated.
18256 So you can see things like this:
18259 \begin_layout Quote
18261 \begin_inset Quotes eld
18264 Context and Logical Form
18265 \begin_inset Quotes erd
18270 Language in Context: Selected Essays
18272 (Oxford: Oxford University Press, 2007), pp.
18276 \begin_layout Quote
18278 \begin_inset Quotes eld
18281 Semantics in Context
18282 \begin_inset Quotes erd
18287 Language in Context: Selected Essays
18289 (Oxford: Oxford University Press, 2007), pp.
18293 \begin_layout Standard
18294 This should be fixed before long.
18297 \begin_layout Standard
18298 There is no support at present for sectioned bibliographies.
18299 If you have multiple bibliographies, then \SpecialChar LyX
18300 will print the same bibliography
18304 \begin_layout Section
18308 \begin_layout Standard
18310 will happily export indexes as XHTML, but with certain limitations at the
18314 \begin_layout Standard
18315 Index export will be most reliable when you do not attempt to use the fancy
18316 constructs that are described in the section on indexes in the
18324 \begin_layout Plain Layout
18325 The main issue here is that \SpecialChar LyX
18326 itself does not really handle these.
18327 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
18333 We'll describe how they are handled using the subsection headings from
18337 \begin_layout Itemize
18338 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
18339 makes an effort to support these,
18340 but the entries must be separated by
18341 \begin_inset Quotes eld
18345 \begin_inset Quotes erd
18348 , that is, there must be spaces around the exclamation point.
18349 This is because it is otherwise too difficult to check for escaped exclamation
18350 points, ones in math, and so forth.
18353 \begin_layout Itemize
18354 Page Ranges: There is no support at all for page ranges, since these make
18355 no sense with XHMTL.
18356 Instead, you will just get two index entries, one at either end.
18359 \begin_layout Itemize
18360 Cross-referencing: There is no support for cross-referencing.
18361 If \SpecialChar LyX
18362 finds an entry containing the
18363 \begin_inset Quotes eld
18366 |see\SpecialChar ldots
18368 \begin_inset Quotes erd
18371 construct, it is just dropped, and the rest is treated as an ordinary index
18375 \begin_layout Itemize
18376 Index Entry Order: \SpecialChar LyX
18377 does support attempts to fix the sorting order.
18378 It will take what is before the first `@' it finds and use that for sorting,
18379 taking what follows the first `@' to be the actual entry.
18380 At present, \SpecialChar LyX
18381 does not check for escaped `@', so do not try to index email
18385 \begin_layout Itemize
18386 Index Entry Layout: You can format entries by using the text style dialog,
18387 or by using any other method available within \SpecialChar LyX
18389 There is no support for constructs like:
18390 \begin_inset Quotes eld
18394 \begin_inset Quotes erd
18398 Indeed, if \SpecialChar LyX
18399 finds a pipe symbol, `|', in an entry, it will delete it and
18400 everything that follows it.
18403 \begin_layout Itemize
18404 Multiple Indexes: There is no support for multiple indexes.
18405 Rather, all index entries will be printed as one large index.
18406 To avoid our printing several versions of the index, we print only the
18407 main index, so make sure you have one.
18410 \begin_layout Section
18411 Nomenclature and Glossary
18414 \begin_layout Standard
18415 There is at present no support for glossaries.
18416 Adding it would be fairly trivial, and welcome.
18419 \begin_layout Chapter
18421 \change_inserted 1075283030 1616534180
18425 \begin_layout Standard
18427 \change_inserted 1075283030 1616534386
18428 Apart from HTML, \SpecialChar LyX
18429 can generate documents in the DocBook XML vocabulary.
18430 With versions 2.3 and before, only select templates could be used to generate
18431 DocBook documents (only version 4).
18432 Starting with \SpecialChar LyX
18433 2.4, most \SpecialChar LyX
18434 layouts can generate valid DocBook documents (only
18436 This feature is built into \SpecialChar LyX
18437 and does not require the use of external tools.
18440 \begin_layout Standard
18442 \change_inserted 1075283030 1616534437
18443 The result is that the DocBook output can be customized and extended in
18444 exactly the same way \SpecialChar LaTeX
18445 output can be customized and extended: through layout
18447 See chapter five of the
18451 manual for the details.
18454 \begin_layout Standard
18456 \change_inserted 1075283030 1616534475
18457 Most \SpecialChar LyX
18458 features are supported with DocBook, like math output.
18461 \begin_layout Itemize
18463 \change_inserted 1075283030 1616534741
18464 Math output is performed mostly in MathML (the major exception being constructio
18465 ns not supported by \SpecialChar LyX
18468 All formulae are also available in raw \SpecialChar TeX
18469 in the DocBook output for further
18473 \begin_layout Itemize
18475 \change_inserted 1075283030 1616534852
18476 Bibliographies and citations are implemented, including with an external
18478 Bibliography entries are not prerendered when the detailed information
18479 are available, but rather output with the standard DocBook constructs.
18480 The external DocBook processor is expected to handle the rendering of entries.
18483 \begin_layout Itemize
18485 \change_inserted 1075283030 1616534863
18486 Indexes are supported, including multiple indices.
18491 ), page ranges, and cross-references (
18495 ) are supported, with the exception of the same symbols escaped.
18504 ) are not supported.
18505 There is no support for escaping of index entries.
18508 \begin_layout Itemize
18510 \change_inserted 1075283030 1616534884
18511 Glossaries are implemented.
18514 \begin_layout Standard
18516 \change_inserted 1075283030 1616534894
18517 Two major parameters can be set at the document level.
18520 \begin_layout Itemize
18522 \change_inserted 1075283030 1616534948
18523 Format for tables: \SpecialChar LyX
18524 can generate tables either as HTML (default value) or
18525 CALS, depending on the user's requirements.
18526 Most DocBook processors accept both formats.
18529 \begin_layout Itemize
18531 \change_inserted 1075283030 1616535006
18532 MathML prefix: in DocBook, MathML is included within its own name space,
18534 The implication is that there must be an indication of the tags belonging
18535 to the MathML standard.
18536 Three choices are offered:
18540 \begin_layout Itemize
18542 \change_inserted 1075283030 1616535044
18543 Inline: the MathML name space is defined for each formula (using the
18547 attribute on each formula)
18550 \begin_layout Itemize
18552 \change_inserted 1075283030 1616535090
18557 prefix (default): the MathML name space is defined at the document level
18562 attribute on the root element).
18563 Each MathML is prefixed with
18572 \begin_layout Itemize
18574 \change_inserted 1075283030 1616620405
18579 prefix: similar to the
18588 \begin_layout Standard
18590 \change_inserted 1075283030 1616620470
18591 This option is especially useful if you want \SpecialChar LyX
18592 to match your personal style
18593 or to work with buggy software that only accepts one prefix for MathML.
18599 \begin_layout Chapter
18600 The \SpecialChar LyX
18604 \begin_layout Section
18608 \begin_layout Standard
18609 The `\SpecialChar LyX
18610 server' allows other programs to talk to \SpecialChar LyX
18611 , invoke \SpecialChar LyX
18612 commands, and retrieve
18613 information about the \SpecialChar LyX
18615 This is only intended for advanced users, but they should find it useful.
18616 It is by writing to the \SpecialChar LyX
18617 server, for example, that bibliography managers,
18618 such as JabRef, are able to
18619 \begin_inset Quotes eld
18623 \begin_inset Quotes erd
18626 citations to \SpecialChar LyX
18630 \begin_layout Section
18631 Starting the \SpecialChar LyX
18633 \begin_inset CommandInset label
18635 name "sec:Starting-the-Server"
18642 \begin_layout Standard
18643 The \SpecialChar LyX
18644 server works through the use of a pair of named pipes.
18645 These are usually located in
18646 \begin_inset Flex Code
18649 \begin_layout Plain Layout
18655 , (except on Windows, where
18659 named pipes are special objects located in
18660 \begin_inset Flex Code
18663 \begin_layout Plain Layout
18675 ) and have the names
18676 \begin_inset Quotes eld
18680 \begin_inset Flex Code
18683 \begin_layout Plain Layout
18690 \begin_inset Quotes erd
18694 \begin_inset Quotes eld
18698 \begin_inset Flex Code
18701 \begin_layout Plain Layout
18708 \begin_inset Quotes erd
18712 External programs write into
18713 \begin_inset Flex Code
18716 \begin_layout Plain Layout
18722 and read back data from
18723 \begin_inset Flex Code
18726 \begin_layout Plain Layout
18733 The stem of the pipe names can be defined in the
18734 \begin_inset Flex Noun
18737 \begin_layout Plain Layout
18738 Tools\SpecialChar menuseparator
18744 dialog, for example
18745 \begin_inset Flex Code
18748 \begin_layout Plain Layout
18749 "/home/myhome/lyxpipe"
18755 \begin_inset Flex Code
18758 \begin_layout Plain Layout
18772 on Windows (where any working path instead of lyxpipe can be used, for
18774 \begin_inset Flex Code
18777 \begin_layout Plain Layout
18800 configure this manually in order for the server to start.
18803 \begin_layout Standard
18806 \begin_inset Flex Code
18809 \begin_layout Plain Layout
18816 \begin_inset Flex Code
18819 \begin_layout Plain Layout
18825 ' to create the pipes.
18826 If one of the pipes already exists, \SpecialChar LyX
18827 will assume that another \SpecialChar LyX
18829 is already running and will not start the server.
18830 On POSIX (Unix like) systems, if for some other reason, an unused
18831 \begin_inset Quotes eld
18835 \begin_inset Quotes erd
18838 pipe is left in existence when \SpecialChar LyX
18839 closes, then \SpecialChar LyX
18840 will try to delete it.
18841 If this fails for some reason, you will need to delete the pipes manually
18842 and then restart \SpecialChar LyX
18844 On Windows, pipes are deleted by the OS on program termination or crash,
18846 \begin_inset Quotes eld
18850 \begin_inset Quotes erd
18853 pipes should not be possible.
18856 \begin_layout Standard
18857 To have several \SpecialChar LyX
18858 processes with servers at the same time, you have to use
18859 different configurations, perhaps by using separate user directories, each
18861 \begin_inset Flex Code
18864 \begin_layout Plain Layout
18870 file, for each process.
18873 \begin_layout Standard
18874 If you are developing a client program, you might find it useful to enable
18875 debugging information from the \SpecialChar LyX
18877 Do this by starting \SpecialChar LyX
18879 \begin_inset Flex Code
18882 \begin_layout Plain Layout
18891 \begin_layout Standard
18892 You can find a complete example client written in C++ in the source distribution
18894 \begin_inset Flex Code
18897 \begin_layout Plain Layout
18898 development/lyxserver/server_monitor.cpp
18906 \begin_layout Standard
18907 Another useful tool is the command-line based client found in
18908 \begin_inset Flex Code
18911 \begin_layout Plain Layout
18912 src/client/lyxclient
18920 \begin_layout Section
18921 Normal communication
18924 \begin_layout Standard
18925 To issue a \SpecialChar LyX
18926 call, the client writes a line of ASCII text into the input
18928 This line has the following format:
18931 \begin_layout Quote
18945 \begin_layout Description
18946 clientname is a name that the client can choose arbitrarily.
18947 Its only use is that \SpecialChar LyX
18948 will echo it if it sends an answer—so a client can
18949 dispatch results from different requesters.
18952 \begin_layout Description
18953 function is the function you want \SpecialChar LyX
18955 It is the same as the commands you'd use in the minibuffer.
18958 \begin_layout Description
18959 argument is an optional argument which is meaningful only to some functions
18961 \begin_inset Quotes eld
18965 \begin_inset Quotes erd
18968 LFUN will insert the argument as text at the cursor position).
18971 \begin_layout Standard
18972 The answer from \SpecialChar LyX
18973 will arrive in the output pipe and be of the form
18976 \begin_layout Quote
18990 \begin_layout Standard
18999 are just echoed from the command request, while
19003 is more or less useful information filled according to how the command
19004 execution worked out.
19005 Some commands, such as
19006 \begin_inset Quotes eld
19010 \begin_inset Quotes erd
19013 , will return information about the internal state of \SpecialChar LyX
19015 return an empty data-response.
19016 This means that the command execution went fine.
19019 \begin_layout Standard
19020 In case of errors, the response from \SpecialChar LyX
19021 will have this form
19024 \begin_layout Quote
19038 \begin_layout Standard
19043 should contain an explanation of why the command failed.
19046 \begin_layout Standard
19050 \begin_layout LyX-Code
19051 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
19052 \begin_inset Newline newline
19055 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
19056 \begin_inset Newline newline
19059 read a <~/.lyxpipe.out
19060 \begin_inset Newline newline
19066 \begin_layout Subsection
19067 AppleScript (Mac OS X)
19070 \begin_layout Standard
19071 Since \SpecialChar LyX
19072 2.1, \SpecialChar LyX
19073 supports basic interactions with AppleScript for normal communicatio
19074 n through the command run.
19075 This command takes a direct argument (the
19079 to perform) and an optional argument.
19080 It either returns the output of the function or triggers an error with
19081 the error message and code.
19084 \begin_layout Standard
19088 \begin_layout LyX-Code
19089 tell application "\SpecialChar LyX
19093 \begin_layout LyX-Code
19097 \begin_layout LyX-Code
19098 -- Stores the current file name into f
19101 \begin_layout LyX-Code
19102 set f to (run "server-get-filename" with argument "")
19105 \begin_layout LyX-Code
19106 on error the error_message number the error_number
19109 \begin_layout LyX-Code
19110 display dialog "Error: " & the error_number & ".
19114 \begin_layout LyX-Code
19115 & the error_message buttons {"OK"} default button 1
19118 \begin_layout LyX-Code
19122 \begin_layout LyX-Code
19126 \begin_layout Section
19130 \begin_layout Standard
19132 can notify clients of events going on asynchronously.
19133 Currently it will only do this if the user binds a key sequence with the
19135 \begin_inset Quotes eld
19139 \begin_inset Quotes erd
19143 The format of the string \SpecialChar LyX
19144 sends is as follows:
19147 \begin_layout Quote
19148 \begin_inset Flex Code
19151 \begin_layout Plain Layout
19162 \begin_layout Standard
19167 is the printed representation of the key sequence that was actually typed
19171 \begin_layout Standard
19172 This mechanism can be used to extend \SpecialChar LyX
19173 's command set and implement macros.
19174 Bind some key sequence to
19175 \begin_inset Quotes eld
19179 \begin_inset Quotes erd
19183 Then start a client that listens on the output pipe, dispatches the command
19184 according to the sequence, and starts a function that may use \SpecialChar LyX
19187 requests to issue a command or a series of commands to \SpecialChar LyX
19191 \begin_layout Section
19192 The simple \SpecialChar LyX
19196 \begin_layout Standard
19198 implements a simple protocol that can be used for session management.
19199 All messages are of the form
19202 \begin_layout Quote
19212 \begin_layout Standard
19218 \begin_inset Quotes eld
19222 \begin_inset Quotes erd
19226 \begin_inset Quotes eld
19230 \begin_inset Quotes erd
19235 \begin_inset Quotes eld
19239 \begin_inset Quotes erd
19242 is received from a client, \SpecialChar LyX
19243 will report back to inform the client that
19244 it's listening to it's messages, while
19245 \begin_inset Quotes eld
19249 \begin_inset Quotes erd
19252 sent from \SpecialChar LyX
19253 will inform clients that \SpecialChar LyX
19257 \begin_layout Section
19258 Reverse DVI/PDF search
19261 \begin_layout Standard
19262 Some DVI/PDF viewers
19266 \begin_layout Plain Layout
19267 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
19268 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
19277 facility (also called
19282 This means that you can tell \SpecialChar LyX
19283 to put the cursor to a specific line in the
19284 document by clicking at the respective position in the DVI/PDF output.
19285 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
19287 This is done via the \SpecialChar LyX
19288 server either by using the named pipe (
19292 ), or the UNIX domain socket (
19296 ) that \SpecialChar LyX
19297 creates in its temporary directory (this is the way the
19298 \begin_inset Flex Code
19301 \begin_layout Plain Layout
19307 program communicates with \SpecialChar LyX
19309 In some cases, you need a helper script that mediates between the viewer
19310 and \SpecialChar LyX
19311 , in others, the viewer can communicate with \SpecialChar LyX
19313 This depends on the selected viewer and on your operating system.
19314 The same applies to the way viewers need to be configured and the way the
19315 reverse search is actually performed.
19316 In what follows, we will thus describe how to setup reverse search for
19318 Before we turn to this, though, we will explain what needs to be done generally
19319 to enable reverse search in the DVI/PDF output.
19322 \begin_layout Subsection
19324 \begin_inset CommandInset label
19326 name "subsec:rev-search"
19333 \begin_layout Standard
19334 In most cases \SpecialChar LyX
19335 will do the work for you by pressing the following button
19339 arg "buffer-toggle-output-sync"
19343 Alternatively, you can also enable the feature by checking
19345 Synchronize with Output
19348 \begin_inset Flex Noun
19351 \begin_layout Plain Layout
19352 Document\SpecialChar menuseparator
19353 Settings\SpecialChar menuseparator
19360 In such a case \SpecialChar LyX
19361 will automatically insert the necessary Sync\SpecialChar TeX
19363 PDF) or load the srcltx package (for DVI) respectively.
19364 This option can be easily reached also on
19365 \begin_inset Flex Code
19368 \begin_layout Plain Layout
19377 \begin_layout Standard
19378 If you need a different setting, you can select or input a custom macro
19379 from the drop down box just below
19380 \begin_inset Flex Noun
19383 \begin_layout Plain Layout
19384 Document\SpecialChar menuseparator
19385 Settings\SpecialChar menuseparator
19386 Output\SpecialChar menuseparator
19387 Synchronize with Output
19395 \begin_layout Standard
19396 Note that the method
19397 \begin_inset Flex Code
19400 \begin_layout Plain Layout
19408 enables gzip compression.
19409 If your viewer does not support it, you should instead use
19410 \begin_inset Flex Code
19413 \begin_layout Plain Layout
19424 \begin_layout Standard
19425 Please also note that including the
19426 \begin_inset Flex Code
19429 \begin_layout Plain Layout
19436 \begin_inset Flex Code
19439 \begin_layout Plain Layout
19445 sometimes has an undesired impact on the typesetting.
19446 Thus, you should switch output synchronization off for the final typesetting
19448 \begin_inset Flex Code
19451 \begin_layout Plain Layout
19458 \begin_inset Flex Code
19461 \begin_layout Plain Layout
19471 \begin_layout Standard
19472 In case you need some more special settings that are not covered by the
19473 automatic settings, read the next section about how to set up output synchroniz
19475 If the automatic setup suits your needs, you can readily jump to section
19476 \begin_inset space ~
19480 \begin_inset CommandInset ref
19482 reference "subsec:configuring-viewers"
19486 , where the necessary configuration steps in your viewer – needed both with
19487 the automatic and the manual setup – are described.
19490 \begin_layout Subsection
19494 \begin_layout Standard
19496 provides several different methods for reverse search.
19497 Some are built-in in the
19498 \begin_inset Flex Code
19501 \begin_layout Plain Layout
19507 program, some are provided by external packages.
19508 Your choice depends on whether your \SpecialChar LaTeX
19509 distribution already provides a given
19510 method (the built-in methods are rather new) and whether your viewer can
19512 The available methods are described in the following.
19515 \begin_layout Subsubsection*
19516 Built-in DVI-search via src-specials (DVI only)
19519 \begin_layout Standard
19520 This method provides the DVI file with the necessary information for reverse
19522 It is available in \SpecialChar LaTeX
19523 since quite some time (any somewhat recent \SpecialChar LaTeX
19525 should include it), and it works reliably.
19526 To enable it, change the
19527 \begin_inset Flex Noun
19530 \begin_layout Plain Layout
19541 \begin_inset Flex Noun
19544 \begin_layout Plain Layout
19555 \begin_inset Flex Noun
19558 \begin_layout Plain Layout
19559 Preferences\SpecialChar menuseparator
19560 File Handling\SpecialChar menuseparator
19567 \begin_inset Flex Code
19570 \begin_layout Plain Layout
19571 latex -src-specials $$i
19577 If this doesn't work, check if your \SpecialChar TeX
19578 engine needs different options (the
19579 syntax might differ in some distributions).
19582 \begin_layout Subsubsection*
19583 External Packages (PDFSync and scrltx)
19586 \begin_layout Standard
19595 provide reverse search facility for PDF output (via pdflatex) and DVI output,
19597 In order to enable it, load the packages in the \SpecialChar LyX
19601 \begin_layout Itemize
19602 \begin_inset Flex Code
19605 \begin_layout Plain Layout
19608 usepackage{pdfsync}
19613 for reverse PDF search,
19616 \begin_layout Itemize
19617 \begin_inset Flex Code
19620 \begin_layout Plain Layout
19623 usepackage[active]{srcltx}
19628 for reverse DVI search.
19631 \begin_layout Standard
19632 If you want to be able to perform both DVI and PDF reverse searches, you
19633 can also insert in the preamble the following lines
19636 \begin_layout LyX-Code
19640 \begin_inset Newline newline
19646 \begin_inset Newline newline
19651 usepackage{pdfsync}
19652 \begin_inset Newline newline
19658 \begin_inset Newline newline
19663 usepackage[active]{srcltx}
19664 \begin_inset Newline newline
19672 \begin_layout Standard
19673 This way, you can preview the file as either DVI or PDF (pdflatex) and the
19674 right package will be used.
19677 \begin_layout Standard
19678 Note that PDFSync might affect the output layout of your document.
19679 It is therefore advised to disable PDFsync for final documents.
19682 \begin_layout Subsubsection*
19683 Built-in reverse search via Sync\SpecialChar TeX
19687 \begin_layout Standard
19689 \begin_inset Flex Code
19692 \begin_layout Plain Layout
19698 have built-in support for both PDF and DVI reverse search.
19701 Sync\SpecialChar TeX
19704 facility is basically the result of the integration of the PDFSync package
19705 to the pdftex program and its merge with the
19710 You need at least \SpecialChar TeX
19711 Live 2008 or a recent Mik\SpecialChar TeX
19712 distribution in order to use
19717 \begin_layout Plain Layout
19718 For some reason, Mik\SpecialChar TeX
19719 does not understand/obey the command \SpecialChar LyX
19721 the preamble when you check the "Enable Forward/Reverse Search" button
19722 in the toolbar and does not generate the necessary info.
19725 \begin_layout Plain Layout
19726 The generation of the required info can be forced by changing the converter
19727 "\SpecialChar LaTeX
19728 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
19729 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
19730 the -synctex=1 switch).
19735 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
19736 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
19737 already provide Sync\SpecialChar TeX
19741 \begin_layout Standard
19742 To enable Sync\SpecialChar TeX
19743 for DVI output, change the
19744 \begin_inset Flex Noun
19747 \begin_layout Plain Layout
19758 \begin_inset Flex Noun
19761 \begin_layout Plain Layout
19766 (plain) -> DraftDVI
19772 \begin_inset Flex Noun
19775 \begin_layout Plain Layout
19776 Preferences\SpecialChar menuseparator
19777 File Handling\SpecialChar menuseparator
19784 \begin_inset Flex Code
19787 \begin_layout Plain Layout
19788 latex -synctex=1 $$i
19793 , and for PDF output, change the
19794 \begin_inset Flex Noun
19797 \begin_layout Plain Layout
19802 (pdflatex) -> PDF (pdflatex)
19808 \begin_inset Flex Code
19811 \begin_layout Plain Layout
19812 pdflatex -synctex=1 $$i
19818 Should your viewer not be considered in the following description, or in
19819 case of missing success, please check the documentation of your viewer
19820 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
19825 \begin_layout Plain Layout
19826 Note that the option
19827 \begin_inset Flex Code
19830 \begin_layout Plain Layout
19836 option enables gzip compression.
19837 If your viewer does not support it, you should instead use
19838 \begin_inset Flex Code
19841 \begin_layout Plain Layout
19855 \begin_layout Subsection
19856 Configuring and using specific viewers
19857 \begin_inset CommandInset label
19859 name "subsec:configuring-viewers"
19866 \begin_layout Subsubsection*
19867 Xdvi (all platforms)
19870 \begin_layout Standard
19872 \begin_inset Flex Code
19875 \begin_layout Plain Layout
19881 , you don't need to do anything else for performing a reverse DVI search,
19882 as \SpecialChar LyX
19883 already provides the necessary hooks for automatically using the
19884 \begin_inset Flex Code
19887 \begin_layout Plain Layout
19894 Just setup your document as described above (reverse search is triggered
19895 by Ctrl-click or Alt-click on Mac OSX, respectively).
19898 \begin_layout Standard
19899 However, if for whatever reason you want to use the named pipe instead of
19900 the socket for communicating with \SpecialChar LyX
19901 , simply change the DVI viewer in
19902 \begin_inset Flex Noun
19905 \begin_layout Plain Layout
19906 Preferences\SpecialChar menuseparator
19907 File Handling\SpecialChar menuseparator
19917 \begin_layout Plain Layout
19918 On Mac OSX you have to use
19919 \begin_inset Flex Code
19922 \begin_layout Plain Layout
19923 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
19934 \begin_inset Flex Code
19937 \begin_layout Plain Layout
19938 xdvi -editor "lyxeditor.sh %f %l"
19944 \begin_inset Flex Code
19947 \begin_layout Plain Layout
19953 is a suitable script.
19954 For example, a minimal shell script is the following one:
19957 \begin_layout LyX-Code
19959 \begin_inset Newline newline
19962 LYXPIPE="/path/to/lyxpipe"
19963 \begin_inset Newline newline
19966 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
19967 \begin_inset Newline newline
19970 echo "$COMMAND" > "${LYXPIPE}".in || exit
19971 \begin_inset Newline newline
19974 read TMP < "${LYXPIPE}".out || exit
19977 \begin_layout Standard
19979 \begin_inset Flex Code
19982 \begin_layout Plain Layout
19988 is the LyXServer pipe path specified in
19989 \begin_inset Flex Noun
19992 \begin_layout Plain Layout
19993 Preferences\SpecialChar menuseparator
20003 \begin_layout Plain Layout
20005 \begin_inset Flex Code
20008 \begin_layout Plain Layout
20014 folder of a source distribution you can find a
20015 \begin_inset Flex Code
20018 \begin_layout Plain Layout
20024 script which is able to locate the
20028 based on your preferences.
20036 \begin_layout Subsubsection*
20040 \begin_layout Standard
20042 \begin_inset Flex Code
20045 \begin_layout Plain Layout
20046 /Applications/MacDviX_Folder/calleditor.script
20051 , add the following lines:
20054 \begin_layout LyX-Code
20055 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
20056 \begin_inset Newline newline
20062 \begin_layout Standard
20063 Modify the lines accordingly if you install \SpecialChar LyX
20064 somewhere else than in the
20065 Applications folder.
20068 \begin_layout Standard
20069 Reverse search is triggered by Alt-click (OPTION-click).
20072 \begin_layout Subsubsection*
20076 \begin_layout Standard
20078 \begin_inset Flex Code
20081 \begin_layout Plain Layout
20082 open -a Skim.app $$i
20087 to the viewer setting in
20088 \begin_inset Flex Noun
20091 \begin_layout Plain Layout
20092 Preferences\SpecialChar menuseparator
20093 File Handling\SpecialChar menuseparator
20094 File formats\SpecialChar menuseparator
20101 \begin_inset Flex Noun
20104 \begin_layout Plain Layout
20105 Skim\SpecialChar menuseparator
20106 Preferences\SpecialChar menuseparator
20113 \begin_inset Flex Noun
20116 \begin_layout Plain Layout
20122 preset and enter command
20123 \begin_inset Flex Noun
20126 \begin_layout Plain Layout
20127 /Applications/\SpecialChar LyX
20128 .app/Contents/MacOS/lyxeditor
20136 \begin_layout Standard
20137 Reverse search is triggered by COMMAND-SHIFT-click
20140 \begin_layout Subsubsection*
20144 \begin_layout Standard
20145 Reverse search with evince does not work out of the box, but it can be achieved
20146 by means of some third party helper scripts.
20148 \begin_inset CommandInset href
20150 target "https://wiki.lyx.org/LyX/SyncTeX"
20158 \begin_layout Subsubsection*
20162 \begin_layout Standard
20164 \begin_inset Flex Noun
20167 \begin_layout Plain Layout
20168 Settings\SpecialChar menuseparator
20169 Configure Okular\SpecialChar menuseparator
20176 \begin_inset Quotes erd
20180 This inserts the appropriate command (
20181 \begin_inset Flex Code
20184 \begin_layout Plain Layout
20193 \begin_layout Standard
20194 Reverse search is triggered by SHIFT-click.
20196 \change_inserted -712698321 1578211026
20197 Note that this only works if Okular is in
20198 \begin_inset Quotes eld
20202 \begin_inset Quotes erd
20206 \begin_inset space \thinspace{}
20209 e., the hand symbol is clicked).
20214 \begin_layout Subsubsection*
20218 \begin_layout Standard
20219 Qpdfview supports Sync\SpecialChar TeX
20220 since version 0.3.5.
20222 \begin_inset Flex Noun
20225 \begin_layout Plain Layout
20226 Edit\SpecialChar menuseparator
20227 Settings\SpecialChar menuseparator
20233 , click on the input field of the
20234 \begin_inset Quotes eld
20238 \begin_inset Quotes erd
20241 item and add the command
20242 \begin_inset Flex Code
20245 \begin_layout Plain Layout
20254 \begin_layout Standard
20255 Reverse search is triggered by double-click or, in more recent versions,
20259 \begin_layout Subsubsection*
20263 \begin_layout Standard
20264 Launch yap, choose its
20265 \begin_inset Flex Noun
20268 \begin_layout Plain Layout
20269 View\SpecialChar menuseparator
20275 menu and select the
20276 \begin_inset Quotes eld
20280 \begin_inset Quotes erd
20285 \begin_inset Quotes eld
20288 New\SpecialChar ldots
20290 \begin_inset Quotes erd
20293 button and, in the window that opens, enter
20294 \begin_inset Quotes eld
20299 \begin_inset Quotes erd
20302 (or any other name you like) in the
20303 \begin_inset Quotes eld
20307 \begin_inset Quotes erd
20311 Now click on the button labeled
20312 \begin_inset Quotes eld
20317 \begin_inset Quotes erd
20320 to open a file dialog and navigate to the directory containing the batch
20322 \begin_inset Flex Code
20325 \begin_layout Plain Layout
20333 \begin_inset Flex Code
20336 \begin_layout Plain Layout
20342 and then specify the program arguments as
20343 \begin_inset Flex Code
20346 \begin_layout Plain Layout
20354 \begin_inset Flex Code
20357 \begin_layout Plain Layout
20363 wrapper is used for communicating with \SpecialChar LyX
20371 \begin_layout LyX-Code
20373 \begin_inset Newline newline
20376 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
20385 \begin_inset Newline newline
20399 \begin_layout Standard
20400 Make sure that the \SpecialChar LyX
20401 Server pipe path you specified in \SpecialChar LyX
20403 \begin_inset Flex Code
20406 \begin_layout Plain Layout
20420 , otherwise change the
20421 \begin_inset Flex Code
20424 \begin_layout Plain Layout
20430 wrapper accordingly.
20433 \begin_layout Standard
20434 In yap, reverse search is triggered by double-click.
20437 \begin_layout Subsubsection*
20438 SumatraPDF (Windows)
20441 \begin_layout Standard
20442 In order to use SumatraPDF for inverse search, enter
20443 \begin_inset Flex Code
20446 \begin_layout Plain Layout
20447 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
20452 in the viewer setting in
20453 \begin_inset Flex Noun
20456 \begin_layout Plain Layout
20457 Preferences\SpecialChar menuseparator
20458 File Handling\SpecialChar menuseparator
20459 File formats\SpecialChar menuseparator
20466 \begin_inset Flex Code
20469 \begin_layout Plain Layout
20475 is the previous wrapper.
20476 If SumatraPDF.exe is not in your command PATH, use its full file name.
20479 \begin_layout Standard
20480 Reverse search is triggered by double-click.
20483 \begin_layout Subsubsection*
20487 \begin_layout Standard
20488 First of all, make sure that yap is your default DVI viewer in the Windows
20489 environment, then launch it, choose its
20490 \begin_inset Flex Noun
20493 \begin_layout Plain Layout
20494 View\SpecialChar menuseparator
20500 menu and select the
20501 \begin_inset Quotes eld
20505 \begin_inset Quotes erd
20510 \begin_inset Quotes eld
20513 New\SpecialChar ldots
20515 \begin_inset Quotes erd
20518 button and, in the window that opens, enter
20519 \begin_inset Quotes eld
20524 \begin_inset Quotes erd
20527 (or any other name you like) in the
20528 \begin_inset Quotes eld
20532 \begin_inset Quotes erd
20536 Now click on the button labeled
20537 \begin_inset Quotes eld
20542 \begin_inset Quotes erd
20545 to open a file dialog and navigate to the directory containing the
20546 \begin_inset Flex Code
20549 \begin_layout Plain Layout
20555 program (which is installed by default on Cygwin along with the \SpecialChar LyX
20558 \begin_inset Flex Code
20561 \begin_layout Plain Layout
20567 and then specify the program arguments as
20568 \begin_inset Flex Code
20571 \begin_layout Plain Layout
20578 In this way, you will be using the
20582 for communicating with \SpecialChar LyX
20584 If, for whatever reason, you want to use the
20589 \begin_inset Flex Code
20592 \begin_layout Plain Layout
20598 option and be sure to specify the \SpecialChar LyX
20599 Server pipe path in the \SpecialChar LyX
20603 \begin_layout Standard
20604 In yap, reverse search is triggered by double-click.
20607 \begin_layout Subsubsection*
20608 SumatraPDF (Cygwin)
20611 \begin_layout Standard
20612 In order to use SumatraPDF for inverse search, enter
20613 \begin_inset Flex Code
20616 \begin_layout Plain Layout
20617 SumatraPDF -inverse-search "lyxeditor -g %f %l"
20622 in the viewer setting in
20623 \begin_inset Flex Noun
20626 \begin_layout Plain Layout
20627 Preferences\SpecialChar menuseparator
20628 File Handling\SpecialChar menuseparator
20629 File formats\SpecialChar menuseparator
20636 If SumatraPDF.exe is not in your command PATH, use its full posix path.
20638 \begin_inset Flex Code
20641 \begin_layout Plain Layout
20647 enables communication via the
20653 \begin_inset Flex Code
20656 \begin_layout Plain Layout
20662 option if you want to use the
20666 , and be sure to specify the \SpecialChar LyX
20667 Server pipe path in the \SpecialChar LyX
20671 \begin_layout Standard
20672 Reverse search is triggered by double-click.
20675 \begin_layout Section
20679 \begin_layout Standard
20680 Forward search is, as the name implies, in a sense the
20681 \begin_inset Quotes eld
20685 \begin_inset Quotes erd
20689 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
20691 If forward search is set up (as described in what follows), you can put
20692 the cursor anywhere in your \SpecialChar LyX
20694 \begin_inset Flex Noun
20697 \begin_layout Plain Layout
20698 Navigate\SpecialChar menuseparator
20705 \begin_inset Flex Noun
20708 \begin_layout Plain Layout
20714 in the context menu via right mouse click), and then the viewer will jump
20715 to that position as well.
20716 This implies, of course, that your viewer supports this function.
20719 \begin_layout Standard
20720 To make forward search possible, you first need to provide the generated
20721 output PDF/DVI file with additional information about the \SpecialChar TeX
20723 This can be done via the methods described in the section
20724 \begin_inset CommandInset ref
20726 reference "subsec:rev-search"
20733 \begin_layout Standard
20734 Additionally, you need to configure \SpecialChar LyX
20735 for using your viewers in
20736 \begin_inset Flex Noun
20739 \begin_layout Plain Layout
20740 Tools\SpecialChar menuseparator
20741 Preferences\SpecialChar menuseparator
20742 Output\SpecialChar menuseparator
20749 We provide a range of tested configurations for some viewers, which you
20750 can select from the drop down list.
20751 If none of these configurations suits you, you have to find out and enter
20752 a suitable configuration yourself.
20753 The definition syntax uses the following placeholders:
20756 \begin_layout Itemize
20758 \begin_inset Flex Code
20761 \begin_layout Plain Layout
20770 \begin_layout Itemize
20772 \begin_inset Flex Code
20775 \begin_layout Plain Layout
20781 : name of the (temporary) exported .tex file (without path)
20784 \begin_layout Itemize
20786 \begin_inset Flex Code
20789 \begin_layout Plain Layout
20795 : name of the (temporary) exported .tex file (including path)
20798 \begin_layout Itemize
20800 \begin_inset Flex Code
20803 \begin_layout Plain Layout
20809 : name of the exported output file (either dvi or pdf, depending on which
20810 one exists in the temporary directory)
20813 \begin_layout Standard
20814 Note that only some of the viewers provide full and usable forward search
20815 functionality out of the box, among them yap, xdvi, okular
20819 \begin_layout Plain Layout
20820 You might want to set
20821 \begin_inset Flex Code
20824 \begin_layout Plain Layout
20831 \begin_inset Flex Noun
20834 \begin_layout Plain Layout
20835 Tools\SpecialChar menuseparator
20836 Preferences\SpecialChar menuseparator
20837 File Handling\SpecialChar menuseparator
20839 \begin_inset space ~
20852 , qpdfview, and SumatraPDF
20856 \begin_layout Plain Layout
20857 SumatraPDF can also use DDE commands through the external program CMCDDE
20858 — downloadable from
20859 \begin_inset CommandInset href
20861 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
20872 Others, such as evince
20876 \begin_layout Plain Layout
20877 Forward search with evince can be achieved by means of third party helper
20880 \begin_inset CommandInset href
20882 target "https://wiki.lyx.org/LyX/SyncTeX"
20892 , require some extra tools in order to use forward search.
20893 While many of the widespread PDF viewers (most notably Adobe Reader) do
20894 not support forward search at all, some other viewers – e.
20895 \begin_inset space \thinspace{}
20899 xpdf – allow at least to reload the document and jump to a specific page
20900 of the file, so you can at least navigate
20901 \begin_inset Quotes eld
20905 \begin_inset Quotes erd
20909 This latter functionality is provided by an external call of synctex (see
20910 the predefined example configurations).
20914 \begin_layout Standard
20915 Forward search works both with DVI and PDF output.
20917 simply checks which preview format you have used before (i.
20918 \begin_inset space \thinspace{}
20921 e., which format is already there in the temporary directory) and chooses
20922 the appropriate configuration for the respective format.
20925 \begin_layout Chapter
20927 \change_deleted 564990737 1671097409
20928 Special Document Classes
20933 \begin_layout Section
20935 \change_deleted 564990737 1669742044
20939 \begin_layout Standard
20941 \change_deleted 564990737 1669742044
20947 \begin_layout Subsection
20949 \change_deleted 564990737 1669742044
20953 \begin_layout Standard
20955 \change_deleted 564990737 1669742044
20956 This section describes how \SpecialChar LyX
20957 can be used to write articles for submission
20958 to the scientific journal
20960 Astronomy and Astrophysics
20963 \begin_inset Flex URL
20966 \begin_layout Plain Layout
20968 https://www.aanda.org/
20973 ) using Version 5.01 of the document class
20978 This package can be downloaded from the ftp site
20981 \begin_layout Standard
20983 \change_deleted 564990737 1669742044
20984 \begin_inset VSpace medskip
20990 \begin_layout Standard
20993 \change_deleted 564990737 1669742044
20994 \begin_inset Flex URL
20997 \begin_layout Plain Layout
20999 ftp://ftp.edpsciences.org/pub/aa/readme.html
21007 \begin_layout Standard
21009 \change_deleted 564990737 1669742044
21010 \begin_inset VSpace medskip
21016 \begin_layout Standard
21018 \change_deleted 564990737 1669742044
21019 A manual comes together with that package, and this text is not meant to
21020 replace the original manual but is merely a short guide in how to realize
21021 the correct form of your paper.
21025 \begin_layout Standard
21027 \change_deleted 564990737 1669742044
21028 Please note that the publisher of the journal was changed from Springer
21029 to EDP Sciences starting January 1, 2001.
21030 That change involved also some slight changes to the style files, namely
21031 the removal of the thesaurus command.
21032 The \SpecialChar LyX
21033 class aa supports the newest version of these style files, V 5.01.
21034 If you have an older version installed, please upgrade.
21035 For compatibility, the old (version 4) layout has been kept as
21040 Please refer to the comments in
21043 Dir/layouts/aapaper.layout
21048 \begin_layout Subsection
21050 \change_deleted 564990737 1669742044
21054 \begin_layout Standard
21056 \change_deleted 564990737 1669742044
21057 It is recommended you start from the example template distributed with \SpecialChar LyX
21059 If you are not using a template, note the following settings:
21062 \begin_layout Itemize
21064 \change_deleted 564990737 1669742044
21071 Document\SpecialChar menuseparator
21074 dialog (OK, that one was obvious).
21077 \begin_layout Itemize
21079 \change_deleted 564990737 1669742044
21080 Don't change the option
21083 \begin_inset space ~
21093 The whole layout is done by the macros, you shouldn't change anything.
21096 \begin_layout Subsection
21098 \change_deleted 564990737 1669742044
21102 \begin_layout Standard
21104 \change_deleted 564990737 1669742044
21105 First thing to enter is the header information.
21106 It consists of seven entries, of which some are optional.
21110 \begin_layout Itemize
21112 \change_deleted 564990737 1669742044
21120 \begin_layout Itemize
21122 \change_deleted 564990737 1669742044
21130 \begin_layout Itemize
21132 \change_deleted 564990737 1669742044
21140 \begin_layout Itemize
21142 \change_deleted 564990737 1669742044
21150 \begin_layout Itemize
21152 \change_deleted 564990737 1669742044
21157 : [optional] if more than one author: whom to contact for offprint requests.
21160 \begin_layout Itemize
21162 \change_deleted 564990737 1669742044
21167 : [optional] mail address for contacts.
21170 \begin_layout Itemize
21172 \change_deleted 564990737 1669742044
21178 Suggested format is
21180 Received: <date>; Accepted <date>
21183 \begin_layout Standard
21185 \change_deleted 564990737 1669742044
21186 There is no need to issue the
21192 command, this is done automatically by \SpecialChar LyX
21193 when the header is finished.
21194 Although the order of the single header entries doesn't matter it is advised
21195 to keep the above sequence, just to get the best optics and meets the layout
21196 of the real document.
21199 \begin_layout Standard
21201 \change_deleted 564990737 1669742044
21202 If you want to place footnotes in the header block, e.
21203 \begin_inset space \thinspace{}
21207 \begin_inset space \space{}
21210 to state your present address, just use the standard footnote via the menu
21213 Insert\SpecialChar menuseparator
21218 will automagically use the term
21227 \begin_layout Standard
21229 \change_deleted 564990737 1669742044
21232 Edit\SpecialChar menuseparator
21235 , you'll find two insets which are relevant for the titling:
21238 \begin_layout Itemize
21240 \change_deleted 564990737 1669742044
21247 to mark corresponding author\SpecialChar breakableslash
21249 The institutes are numbered sequentially as they appear in the
21253 field, so you have to put a marker to each author.
21256 \begin_layout Itemize
21258 \change_deleted 564990737 1669742044
21263 to supply an email address for fast contact.
21266 \begin_layout Standard
21268 \change_deleted 564990737 1669742044
21269 In addition to these topics, the macros use one additional \SpecialChar LaTeX
21271 has no counterpart in \SpecialChar LyX
21275 \begin_layout Itemize
21277 \change_deleted 564990737 1669742044
21284 to separate different names for more than one author and institute, respectivel
21288 \begin_layout Standard
21290 \change_deleted 564990737 1669742044
21291 The appropriate command has to be entered in \SpecialChar LyX
21292 and marked as \SpecialChar LaTeX
21298 \begin_layout Subsection
21300 \change_deleted 564990737 1669742044
21304 \begin_layout Standard
21306 \change_deleted 564990737 1669742044
21307 The abstract should immediately follow the header block.
21308 With version 5 the abstract environment was changed to a command, and there
21309 is now a restriction to only one paragraph.
21310 In addition, it should contain an entry with the keywords.
21311 This is done via the paragraph style
21316 Refer to the example paper.
21319 \begin_layout Subsection
21321 \change_deleted 564990737 1669742044
21322 Supported environments
21325 \begin_layout Standard
21327 \change_deleted 564990737 1669742044
21328 The A&A paper layout supports the following environments for structuring
21332 \begin_layout Itemize
21334 \change_deleted 564990737 1669742044
21340 \begin_layout Itemize
21342 \change_deleted 564990737 1669742044
21348 \begin_layout Itemize
21350 \change_deleted 564990737 1669742044
21356 \begin_layout Itemize
21358 \change_deleted 564990737 1669742044
21364 \begin_layout Itemize
21366 \change_deleted 564990737 1669742044
21372 \begin_layout Itemize
21374 \change_deleted 564990737 1669742044
21380 \begin_layout Itemize
21382 \change_deleted 564990737 1669742044
21388 \begin_layout Itemize
21390 \change_deleted 564990737 1669742044
21396 \begin_layout Itemize
21398 \change_deleted 564990737 1669742044
21404 \begin_layout Itemize
21406 \change_deleted 564990737 1669742044
21412 \begin_layout Itemize
21414 \change_deleted 564990737 1669742044
21420 \begin_layout Itemize
21422 \change_deleted 564990737 1669742044
21429 \begin_layout Subsection
21431 \change_deleted 564990737 1669742044
21432 Commands not supported by \SpecialChar LyX
21436 \begin_layout Standard
21438 \change_deleted 564990737 1669742044
21439 Some commands are not yet supported by the
21443 layout for \SpecialChar LyX
21445 Some have already been mentioned.
21446 For the sake of completeness, they are listed all together here:
21449 \begin_layout Itemize
21451 \change_deleted 564990737 1669742044
21459 \begin_layout Itemize
21461 \change_deleted 564990737 1669742044
21469 \begin_layout Itemize
21471 \change_deleted 564990737 1669742044
21479 \begin_layout Itemize
21481 \change_deleted 564990737 1669742044
21489 \begin_layout Standard
21491 \change_deleted 564990737 1669742044
21492 If you want to use any of these commands, you have to enter them yourself.
21495 Do not forget to mark them as \SpecialChar LaTeX
21499 \begin_layout Subsection
21501 \change_deleted 564990737 1669742044
21502 Figure and Table Floats
21505 \begin_layout Standard
21507 \change_deleted 564990737 1669742044
21509 provides support for the necessary float environments
21511 figure, figure*, table
21517 , therefore we won't tell much about it here.
21521 \begin_inset space ~
21527 Just remember that tables should be left-aligned.
21528 For that, select the table and change the alignment in
21530 Edit\SpecialChar menuseparator
21532 \begin_inset space ~
21538 \begin_layout Standard
21540 \change_deleted 564990737 1669742044
21541 There is only one special thing: the figures with caption besides the figure.
21542 To create such a figure, you have to do the following:
21545 \begin_layout Enumerate
21547 \change_deleted 564990737 1669742044
21548 Create a wide figure float:
21550 Insert\SpecialChar menuseparator
21551 Float\SpecialChar menuseparator
21554 , then right click in the figure and select
21557 \begin_inset space ~
21565 \begin_layout Enumerate
21567 \change_deleted 564990737 1669742044
21568 Enter your caption text.
21571 \begin_layout Enumerate
21573 \change_deleted 564990737 1669742044
21578 to move the cursor above the caption.
21581 \begin_layout Enumerate
21583 \change_deleted 564990737 1669742044
21587 \begin_layout Enumerate
21589 \change_deleted 564990737 1669742044
21590 Position the cursor behind the figure and insert a horizontal fill:
21592 Insert\SpecialChar menuseparator
21594 \begin_inset space ~
21597 Character\SpecialChar menuseparator
21599 \begin_inset space ~
21607 \begin_layout Enumerate
21609 \change_deleted 564990737 1669742044
21610 Switch to \SpecialChar LaTeX
21614 \begin_inset space ~
21622 \begin_layout Enumerate
21624 \change_deleted 564990737 1669742044
21634 Do not close the brace!
21637 \begin_layout Enumerate
21639 \change_deleted 564990737 1669742044
21640 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
21645 \begin_inset space ~
21657 \begin_layout Standard
21659 \change_deleted 564990737 1669742044
21660 Also, refer to the figures in the example paper.
21663 \begin_layout Subsection
21665 \change_deleted 564990737 1669742044
21669 \begin_layout Standard
21671 \change_deleted 564990737 1669742044
21672 For submission, the paper has to be formated in a special double-spacing
21674 For this purpose, you have to give the option
21678 to the document class.
21679 This must be done using the custom class options field in the
21681 Document\SpecialChar menuseparator
21685 Just enter the string
21692 \begin_layout Subsection
21694 \change_deleted 564990737 1669742044
21698 \begin_layout Standard
21700 \change_deleted 564990737 1669742044
21705 directory contains an example paper written with \SpecialChar LyX
21707 It is the example paper from the original macro package, translated to
21710 Use it for inspiration, and compare the original \SpecialChar LaTeX
21711 code with \SpecialChar LyX
21715 \begin_layout Section
21717 \change_deleted 564990737 1671097429
21721 \begin_layout Standard
21723 \change_deleted 564990737 1671097429
21728 can be used to type letters according to German conventions.
21729 A template file is included in
21731 .../lyx/share/templates
21733 for you to use as a starting point.
21736 \begin_layout Section
21738 \change_deleted 564990737 1671097429
21742 \begin_layout Standard
21744 \change_deleted 564990737 1671097429
21745 See the \SpecialChar LyX
21751 It contains all infos you need.
21754 \begin_layout Section
21756 \change_deleted 564990737 1669755802
21760 \begin_layout Standard
21762 \change_deleted 564990737 1669755802
21765 Panayotis Papasotiriou
21768 \begin_layout Subsection
21770 \change_deleted 564990737 1669755802
21774 \begin_layout Standard
21776 \change_deleted 564990737 1669755802
21777 The ijmpc package is a set of macros that facilitates electronic manuscript
21780 International Journal of Modern Physics C
21783 Similarly, the ijmpd package is for creating manuscripts to be submitted
21786 International Journal of Modern Physics D
21789 Both journals are published by World Scientific.
21790 The corresponding document classes are named
21799 These files, together with instructions for the authors, can be downloaded
21801 \begin_inset Flex URL
21804 \begin_layout Plain Layout
21806 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
21812 \begin_inset Flex URL
21815 \begin_layout Plain Layout
21817 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
21823 Both packages are modified versions of the standard
21824 \begin_inset Quotes eld
21828 \begin_inset Quotes erd
21831 package, and they are almost (but not exactly) identical.
21832 Most of their features are supported by \SpecialChar LyX
21834 I have used \SpecialChar LyX
21835 successfully to write articles submitted to both journals
21836 without any problem.
21839 \begin_layout Subsection
21841 \change_deleted 564990737 1669755802
21845 \begin_layout Standard
21847 \change_deleted 564990737 1669755802
21848 As usual, the easiest way to write a paper is to start with a template.
21851 File\SpecialChar menuseparator
21867 This will give an (almost) empty document that includes the most common
21868 fields found in a manuscript.
21869 Simply overwrite the existing text (including the brackets,
21874 You should keep in mind the following remarks.
21877 \begin_layout Enumerate
21879 \change_deleted 564990737 1669755802
21881 won't let you change the font size and the page style of the document,
21882 because such modifications are not allowed by both packages.
21885 \begin_layout Enumerate
21887 \change_deleted 564990737 1669755802
21888 The language of the document should not be changed.
21889 Before previewing your paper, be sure that the babel package is not used.
21890 To do this, click on
21893 arg "dialog-show document"
21898 \SpecialChar menuseparator
21902 \begin_inset Quotes eld
21906 \begin_inset Quotes erd
21916 \begin_layout Enumerate
21918 \change_deleted 564990737 1669755802
21920 \begin_inset Quotes eld
21924 \begin_inset Quotes erd
21927 style must be used to define keywords.
21930 \begin_layout Enumerate
21932 \change_deleted 564990737 1669755802
21933 The ijmpc package provides a style named
21934 \begin_inset Quotes eld
21937 Classification Codes
21938 \begin_inset Quotes erd
21941 , which can be used to define classification codes, such as PACS numbers.
21942 Note that this facility is not supported by the ijmpd package.
21945 \begin_layout Enumerate
21947 \change_deleted 564990737 1669755802
21948 Several new environments are available:
21949 \begin_inset Quotes eld
21953 \begin_inset Quotes erd
21957 \begin_inset Quotes eld
21961 \begin_inset Quotes erd
21965 \begin_inset Quotes eld
21969 \begin_inset Quotes erd
21973 \begin_inset Quotes eld
21977 \begin_inset Quotes erd
21981 \begin_inset Quotes eld
21985 \begin_inset Quotes erd
21989 \begin_inset Quotes eld
21993 \begin_inset Quotes erd
21997 \begin_inset Quotes eld
22001 \begin_inset Quotes erd
22005 \begin_inset Quotes eld
22009 \begin_inset Quotes erd
22013 \begin_inset Quotes eld
22017 \begin_inset Quotes erd
22021 \begin_inset Quotes eld
22025 \begin_inset Quotes erd
22029 \begin_inset Quotes eld
22033 \begin_inset Quotes erd
22037 \begin_inset Quotes eld
22041 \begin_inset Quotes erd
22045 \begin_inset Quotes eld
22049 \begin_inset Quotes erd
22053 \begin_inset Quotes eld
22057 \begin_inset Quotes erd
22061 Their use is more or less obvious.
22063 supports all these environments; it will use the proper label, text style,
22064 and numbering scheme for each of them.
22067 \begin_layout Enumerate
22069 \change_deleted 564990737 1669755802
22070 Both packages use basic citations; the natbib package should not be used.
22071 In \SpecialChar LyX
22072 , citation references are shown as usual; in the output, citations are
22073 shown as superscripts.
22074 If you want to use a citation as normal text, you should use the
22079 \begin_inset space \thinspace{}
22083 \begin_inset space \space{}
22087 \begin_inset Quotes eld
22091 \begin_inset space \space{}
22101 \begin_inset Quotes erd
22107 \begin_layout Enumerate
22109 \change_deleted 564990737 1669755802
22111 \begin_inset Quotes eld
22115 \begin_inset Quotes erd
22118 section in both packages.
22119 To put acknowledgments, just use the
22120 \begin_inset Quotes eld
22124 \begin_inset Quotes erd
22130 \begin_layout Enumerate
22132 \change_deleted 564990737 1669755802
22133 Appendices may be added to the paper,
22137 the Acknowledgments and
22143 provides a special environment, called
22144 \begin_inset Quotes eld
22148 \begin_inset Quotes erd
22151 which marks the beginning of the appendices.
22152 This environment should be left blank; it just sends a \SpecialChar LaTeX
22153 command, but nothing
22155 In \SpecialChar LyX
22157 \begin_inset Quotes eld
22161 \begin_inset Quotes erd
22164 is printed with blue letters, as a signal that all sections after that
22165 point are appendices.
22166 To write an appendix, use the
22167 \begin_inset Quotes eld
22171 \begin_inset Quotes erd
22176 will number each appendix with capital letters, as required by both journals.
22178 \begin_inset Quotes eld
22182 \begin_inset Quotes erd
22189 be present before the first appendix; if not, all appendices will be numbered
22190 as normal sections in the output.
22193 \begin_layout Enumerate
22195 \change_deleted 564990737 1669755802
22196 The ijmpc and the ijmpd packages use the
22200 command to implement table captions.
22201 As a result, a table created by \SpecialChar LyX
22202 is printed correctly, but its caption
22204 However, you can use some \SpecialChar TeX
22205 code to overcome this problem, so that captions
22206 are printed as expected.
22207 To do so, create a float table as usual, remove the caption, and replace
22208 it with the \SpecialChar TeX
22219 (sic); you must also the \SpecialChar TeX
22224 immediately after the tabular material.
22225 Study the example table included in the template files to see how this
22226 trick is implemented.
22227 Alternatively, If you need table captions, you should implement the whole
22232 file, then include this file to the \SpecialChar LyX
22235 Insert\SpecialChar menuseparator
22236 File\SpecialChar menuseparator
22238 \begin_inset space ~
22244 Details on how to create a table float can be found in the files
22252 , included in the corresponding packages.
22255 \begin_layout Subsection
22257 \change_deleted 564990737 1669755802
22258 Preparing a paper for submission
22261 \begin_layout Standard
22263 \change_deleted 564990737 1669755802
22264 Before you submit your paper you must export the \SpecialChar LyX
22265 document as a \SpecialChar LaTeX
22268 File\SpecialChar menuseparator
22269 Export\SpecialChar menuseparator
22277 \begin_layout Plain Layout
22278 Actually you have the choice between \SpecialChar LaTeX
22279 (plain) and pdflatex.
22280 If you intend to use pdflatex to prepare the paper, you should use the
22281 pdflatex option so that included graphics are converted to PDF format,
22282 ready for use by pdflatex.
22287 , then make the following changes to the resulting
22294 \begin_layout Enumerate
22296 \change_deleted 564990737 1669755802
22297 Remove the comment lines before the
22306 \begin_layout Enumerate
22308 \change_deleted 564990737 1669755802
22309 Remove everything between (and including) the
22321 commands, except for any commands you specifically put into the \SpecialChar LaTeX
22325 \begin_layout Standard
22327 \change_deleted 564990737 1669755802
22332 file should be saved and processed through \SpecialChar LaTeX
22333 as many times as necessary.
22334 You may also want to check the resulting
22343 \begin_layout Section
22345 \change_deleted 564990737 1669801478
22349 \begin_layout Standard
22351 \change_deleted 564990737 1669801478
22357 \begin_layout Subsection
22359 \change_deleted 564990737 1669801478
22363 \begin_layout Standard
22365 \change_deleted 564990737 1669801478
22366 The iopart package provides a document class to create electronic manuscript
22367 submission to the journals published by the Institute of Physics.
22368 Instructions for the authors how to create a paper using the iopart class
22369 can be downloaded together with the iopart package from the site
22370 \begin_inset Flex URL
22373 \begin_layout Plain Layout
22375 ftp://ftp.iop.org/pub/journals/latex2e
22383 \begin_layout Subsection
22385 \change_deleted 564990737 1669801478
22389 \begin_layout Standard
22391 \change_deleted 564990737 1669801478
22392 The easiest way to write a paper is to start with the template
22396 that is available via
22398 File\SpecialChar menuseparator
22401 The template explains how to use the special text environments.
22402 Here are the most important advices:
22405 \begin_layout Itemize
22407 \change_deleted 564990737 1669801478
22408 To be able to compile your document to a PDF, PS, or DVI, ensure that the
22409 no AMS packages are loaded in
22411 Document\SpecialChar menuseparator
22412 Settings\SpecialChar menuseparator
22418 \begin_layout Itemize
22420 \change_deleted 564990737 1669801478
22423 The title environment defines the kind of your paper.
22424 So use one of the following environments for the title:
22428 \begin_layout Itemize
22430 \change_deleted 564990737 1669801478
22439 \begin_layout Itemize
22441 \change_deleted 564990737 1669801478
22450 \begin_layout Itemize
22452 \change_deleted 564990737 1669801478
22458 for a Topical review
22461 \begin_layout Itemize
22463 \change_deleted 564990737 1669801478
22472 \begin_layout Itemize
22474 \change_deleted 564990737 1669801478
22483 \begin_layout Itemize
22485 \change_deleted 564990737 1669801478
22491 for a Paper (same as Title)
22494 \begin_layout Itemize
22496 \change_deleted 564990737 1669801478
22502 for a Preliminary communication
22505 \begin_layout Itemize
22507 \change_deleted 564990737 1669801478
22513 for a Rapid communication
22516 \begin_layout Itemize
22518 \change_deleted 564990737 1669801478
22524 for a Letter to the editor
22528 \begin_layout Itemize
22530 \change_deleted 564990737 1669801478
22533 All title environments except of
22537 can have an optional short title.
22540 \begin_layout Itemize
22542 \change_deleted 564990737 1669801478
22543 There is a general title environment
22547 which is not directly supported by \SpecialChar LyX
22549 This can be used as \SpecialChar TeX
22550 code when your document doesn't fit into one of the
22554 \begin_layout Standard
22556 \change_deleted 564990737 1669801478
22557 For more informations like hints for special table and formula formatting,
22558 look at the IOP author guidelines.
22563 \begin_layout Section
22565 \change_deleted 564990737 1670317155
22569 \begin_layout Standard
22571 \change_deleted 564990737 1670317155
22574 Panayotis Papasotiriou
22577 \begin_layout Subsection
22579 \change_deleted 564990737 1670317155
22583 \begin_layout Standard
22585 \change_deleted 564990737 1670317155
22586 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
22587 that facilitates electronic manuscript submission to the journals they
22589 Most known of them (at least in my domain of interest) are
22591 Astrophysics and Space Science
22597 , but there are many others (see a complete list at
22598 \begin_inset Flex URL
22601 \begin_layout Plain Layout
22603 http://www.wkap.nl/jrnllist.htm/JRNLHOME
22609 The Kluwer package may be downloaded from the site
22610 \begin_inset Flex URL
22613 \begin_layout Plain Layout
22615 http://www.wkap.nl/kaphtml.htm/STYLEFILES
22621 A complete user guide is contained in that package (but it can also be
22622 downloaded separately).
22625 \begin_layout Standard
22627 \change_deleted 564990737 1670317155
22629 supports many features of the package but not everything.
22630 However, the \SpecialChar TeX
22631 code needed is reduced to some
22632 \begin_inset Quotes eld
22636 \begin_inset Quotes erd
22639 commands of the package (see
22640 \begin_inset space ~
22644 \begin_inset CommandInset ref
22646 reference "subsec:kluwer_peculiarities"
22651 I have recently used \SpecialChar LyX
22652 to write an article submitted to the
22654 Astrophysics and Space Science
22656 without any problem.
22659 \begin_layout Subsection
22661 \change_deleted 564990737 1670317155
22665 \begin_layout Standard
22667 \change_deleted 564990737 1670317155
22668 The easiest way to write a paper is to start with the Kluwer template file.
22671 File\SpecialChar menuseparator
22683 This will give an (almost) empty document that includes the most common
22684 fields found in a manuscript and a short description of their use.
22685 As in most templates, simply overwrite the existing text (including the
22690 ) with the correct information.
22693 \begin_layout Subsection
22695 \change_deleted 564990737 1670317155
22696 Preparing a paper for submission
22699 \begin_layout Standard
22701 \change_deleted 564990737 1670317155
22702 As in the AAS\SpecialChar TeX
22703 package, before you submit your paper to a journal you must
22705 \begin_inset Quotes eld
22709 \begin_inset Quotes erd
22715 \begin_layout Enumerate
22717 \change_deleted 564990737 1670317155
22718 Export your paper as a \SpecialChar LaTeX
22720 To do this, click on
22722 File\SpecialChar menuseparator
22723 Export\SpecialChar menuseparator
22731 \begin_layout Enumerate
22733 \change_deleted 564990737 1670317155
22738 file with a text editor and make the following changes
22742 \begin_layout Enumerate
22744 \change_deleted 564990737 1670317155
22745 remove the comment lines before the
22754 \begin_layout Enumerate
22756 \change_deleted 564990737 1670317155
22757 remove everything between (and including) the
22769 commands, except for any commands you specifically put into the \SpecialChar LaTeX
22773 \begin_layout Standard
22775 \change_deleted 564990737 1670317155
22784 \begin_layout Enumerate
22786 \change_deleted 564990737 1670317155
22791 file through \SpecialChar LaTeX
22792 as many times as necessary (usually up to three).
22795 \begin_layout Enumerate
22797 \change_deleted 564990737 1670317155
22803 \begin_inset space \thinspace{}
22807 \begin_inset space \space{}
22814 , and check if everything is OK (it should, if you didn't make any mistake).
22817 \begin_layout Subsection
22819 \change_deleted 564990737 1670317155
22820 \begin_inset Quotes eld
22824 \begin_inset Quotes erd
22827 of the Kluwer package
22828 \begin_inset CommandInset label
22830 name "subsec:kluwer_peculiarities"
22837 \begin_layout Standard
22839 \change_deleted 564990737 1670317155
22840 The Kluwer package has the following
22841 \begin_inset Quotes eld
22845 \begin_inset Quotes erd
22851 \begin_layout Enumerate
22853 \change_deleted 564990737 1670317155
22854 It is possible to write multiple articles in the same \SpecialChar LaTeX
22859 \begin_layout Plain Layout
22860 I can't imagine any good reason to do this.
22866 Each article must be included in the environment
22867 \begin_inset Quotes eld
22871 \begin_inset Quotes erd
22875 Unfortunately, this environment cannot be omitted, even if you write just
22877 Therefore, each article starts with the command
22883 and, obviously, ends with the command
22890 Although this can be implemented in \SpecialChar LyX
22891 , I didn't included it, since it looks
22892 ugly and can confuse the novice user.
22893 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
22896 \begin_inset Quotes eld
22901 \begin_inset Quotes erd
22907 \begin_layout Enumerate
22909 \change_deleted 564990737 1670317155
22910 Information given at the beginning of the article (i.
22911 \begin_inset space \thinspace{}
22915 \begin_inset space \space{}
22918 title, subtitle, author, institution, running title, running author, abstract
22919 and keywords) must be included in an environment called
22920 \begin_inset Quotes eld
22924 \begin_inset Quotes erd
22928 This is not implemented in \SpecialChar LyX
22929 , so you must enter title, subtitle etc.
22930 \begin_inset space ~
22933 between two \SpecialChar TeX
22949 \begin_layout Enumerate
22951 \change_deleted 564990737 1670317155
22952 According to the user manual, the label of each bibliography item must be
22976 \begin_layout Standard
22978 \change_deleted 564990737 1670317155
22983 template takes care of all these
22984 \begin_inset Quotes eld
22988 \begin_inset Quotes erd
22992 If you start a new paper using this template you don't need to do anything
22997 \begin_layout Enumerate
22999 \change_deleted 564990737 1670317155
23000 don't delete the \SpecialChar TeX
23001 code included in the template, and
23004 \begin_layout Enumerate
23006 \change_deleted 564990737 1670317155
23007 copy the example bibliography item included in the template and modify it
23008 as necessary to enter new bibliography items.
23011 \begin_layout Section
23013 \change_deleted 564990737 1671097446
23017 \begin_layout Standard
23019 \change_deleted 564990737 1671097446
23024 provides an alternative to the standard
23029 It provides similar functionality, but you might prefer this layout with
23030 sans serif sections, headings, and more.
23033 \begin_layout Section
23035 \change_deleted 564990737 1671097446
23036 Springer Journals (
23043 \begin_layout Standard
23045 \change_deleted 564990737 1671097446
23051 \begin_layout Subsection
23053 \change_deleted 564990737 1671097446
23057 \begin_layout Standard
23059 \change_deleted 564990737 1671097446
23060 These are the layout files for some of the journal formats used by Springer
23061 Verlag and listed on
23062 \begin_inset Flex URL
23065 \begin_layout Plain Layout
23067 http://www.springer.de/author/tex/help-journals.html
23072 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
23074 It is a modular system: the things common to all journals are implemented
23079 , which journal-specific layout files (such as, e.
23080 \begin_inset space \thinspace{}
23084 \begin_inset space \space{}
23091 for Journal of Geodesy) can include.
23094 \begin_layout Standard
23096 \change_deleted 564990737 1671097446
23097 This means that implementing support for any other Springer journal on this
23098 list is as simple as writing your own
23106 file following the outline given in
23114 \begin_layout Standard
23116 \change_deleted 564990737 1671097446
23117 It is reasonably well tested only for the Journal of Geodesy.
23126 come with the standard \SpecialChar LyX
23128 Install the relevant class file (downloaded from Springer) in a proper
23129 directory, reconfigure \SpecialChar LaTeX
23130 (in the te\SpecialChar TeX
23135 , as root if necessary — doesn't \SpecialChar LyX
23136 take care of this?), reconfigure \SpecialChar LyX
23141 \begin_layout Subsection
23143 \change_deleted 564990737 1671097446
23147 \begin_layout Standard
23149 \change_deleted 564990737 1671097446
23150 A large number of theorem-like styles —
23162 \begin_layout Standard
23164 \change_deleted 564990737 1671097446
23167 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
23168 _Title, Author_Running, Institute,
23169 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
23172 See the Springer class file documentation for details.
23175 \begin_layout Subsection
23177 \change_deleted 564990737 1671097446
23181 \begin_layout Itemize
23183 \change_deleted 564990737 1671097446
23195 \begin_layout Itemize
23197 \change_deleted 564990737 1671097446
23200 Probability Theory and Related Fields
23206 — Jean-Marc Lasgouttes
23209 \begin_layout Standard
23211 \change_deleted 564990737 1671097446
23212 Add your own, it isn't so hard!
23215 \begin_layout Subsection
23217 \change_deleted 564990737 1671097446
23221 \begin_layout Standard
23223 \change_deleted 564990737 1671097446
23224 These files are partly based on the older
23228 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
23230 file from Springer.
23235 layout, are now defunct.
23236 Jean-Marc Lasgouttes helped out big in making me find my way around the
23238 layout file mechanism.
23241 \begin_layout Subsection
23243 \change_deleted 564990737 1671097446
23247 \begin_layout Standard
23249 \change_deleted 564990737 1671097446
23251 But probably less than in the old hacked-\SpecialChar LaTeX
23259 \begin_layout Chapter
23261 Features needing Extra Software
23264 \begin_layout Section
23265 Checking \SpecialChar TeX
23269 \begin_layout Standard
23275 \begin_layout Subsection
23279 \begin_layout Standard
23288 \begin_layout Plain Layout
23293 is not yet available when you are using the \SpecialChar LaTeX
23294 distribution MiK\SpecialChar TeX
23300 , you'll find in the
23307 \begin_inset space ~
23318 \begin_inset Newline newline
23322 \begin_inset CommandInset href
23324 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
23332 \begin_layout Standard
23335 Chk\SpecialChar TeX
23338 package is a program that was written by
23339 \begin_inset Flex Noun
23342 \begin_layout Plain Layout
23344 \begin_inset space ~
23352 in frustration because some constructs in \SpecialChar LaTeX
23353 are sometimes non-intuitive,
23354 and easy to forget.
23355 The program runs over your \SpecialChar LaTeX
23356 file, checks the integrity of the file, and
23357 flags some common errors.
23358 In other technical words, it is
23362 for \SpecialChar LaTeX
23366 \begin_layout Standard
23367 Well, what is a syntax checker doing in \SpecialChar LyX
23368 which is supposed to produce correct
23370 anyways? The answer is simple: Just as
23374 not only checks the
23378 of C programs, but also does
23382 checks for type-errors,
23384 Chk\SpecialChar TeX
23387 catches some common
23391 errors, in addition to the syntactical ones.
23394 Chk\SpecialChar TeX
23397 is capable of detecting several common errors, such as
23400 \begin_layout Itemize
23401 Ellipsis detection:
23402 \begin_inset Newline newline
23405 Use \SpecialChar ldots
23409 \begin_layout Itemize
23410 No space in front of/after parenthesis:
23411 \begin_inset Newline newline
23417 \begin_layout Itemize
23418 Enforcement of normal space after common abbreviations:
23419 \begin_inset Newline newline
23423 \begin_inset space \thinspace{}
23427 \begin_inset space \space{}
23430 is too wide spacing.
23433 \begin_layout Itemize
23434 Enforcement of end-of-sentence space when the last sentence ends with a
23436 \begin_inset Newline newline
23440 And this is wrong spacing.
23443 \begin_layout Itemize
23444 Space in front of labels and similar commands:
23445 \begin_inset Newline newline
23448 The label should stick right up to the text to avoid falling to a wrong
23451 \begin_inset CommandInset label
23461 \begin_layout Plain Layout
23462 This footnote is in danger of falling off to a wrong page
23467 The label is separated too much.
23470 \begin_layout Itemize
23471 Space in front of references, instead of hard spaces:
23472 \begin_inset Newline newline
23475 If you have bad luck, the text will break right between the referenced text
23476 and reference number, and that's a pity.
23478 \begin_inset CommandInset ref
23480 reference "sec:chktex"
23487 \begin_layout Itemize
23489 \begin_inset Quotes eld
23493 \begin_inset Quotes erd
23497 \begin_inset Formula $\times$
23501 \begin_inset Newline newline
23504 2x2 looks cheap compared to
23505 \begin_inset Formula $2\times2$
23511 \begin_layout Standard
23512 and more \SpecialChar ldots
23513 It is an invaluable tool when you are
23514 \begin_inset Quotes eld
23518 \begin_inset Quotes erd
23521 your document before printing, and you should run it right after the obligatory
23522 spelling check, and before you go fine tuning the typesetting.
23525 \begin_layout Subsection
23529 \begin_layout Standard
23530 If you have the program installed, usage is as simple as choosing
23532 Tools\SpecialChar menuseparator
23534 \begin_inset space ~
23540 This will make \SpecialChar LyX
23541 generate a \SpecialChar LaTeX
23542 file of your document, start
23544 Chk\SpecialChar TeX
23547 to check it, and then make \SpecialChar LyX
23549 \begin_inset Quotes eld
23553 \begin_inset Quotes erd
23556 with the warnings from
23558 Chk\SpecialChar TeX
23561 , if there were any.
23562 The warnings will be placed close to the point of the mistake, and you
23563 can quickly find them by using the
23565 Navigate\SpecialChar menuseparator
23568 menu item, or the shortcut key
23577 Open the error boxes by clicking on them with the mouse, or use the shortcut
23586 bindings, or the corresponding
23595 Read the warning and correct the mistake, if it is a mistake.
23596 If you have trouble understanding what the warning is about, you can safely
23598 Remember that there is a hidden layer between the document on screen and
23599 the technical details in invoking
23601 Chk\SpecialChar TeX
23604 , and this gap can make some warnings seem arcane or just plain silly.
23607 \begin_layout Standard
23608 This document is an excellent testing bed for the feature, and it should
23609 provide quite a few warnings for you to fiddle with.
23610 Since computers are only so smart, expect most of the warnings to be false
23614 \begin_layout Subsection
23615 How to fine tune it
23618 \begin_layout Standard
23619 Sometimes, you'll find that
23621 Chk\SpecialChar TeX
23624 makes more noise than suits your mood.
23625 Then you can choose not to use it, wait until your mood changes, or try
23628 Chk\SpecialChar TeX
23631 to get better along with you.
23634 \begin_layout Standard
23637 Chk\SpecialChar TeX
23644 very configurable and extensible, you should not expect to solve all problems
23647 Chk\SpecialChar TeX
23650 in \SpecialChar LyX
23652 Since \SpecialChar LyX
23653 has to generate a somewhat special \SpecialChar LaTeX
23654 file to be able to match the
23655 line numbers from the
23657 Chk\SpecialChar TeX
23664 \begin_layout Plain Layout
23665 You can inspect the specific output from
23671 Document\SpecialChar menuseparator
23674 \begin_inset space ~
23688 to the internal document structure, some of the warnings will not appear
23690 There are two things you can do about this:
23693 \begin_layout Itemize
23696 Chk\SpecialChar TeX
23699 invocation command line in
23700 \begin_inset Flex Noun
23703 \begin_layout Plain Layout
23704 Tools\SpecialChar menuseparator
23705 Preferences\SpecialChar menuseparator
23706 Output\SpecialChar menuseparator
23707 LaTeX\SpecialChar menuseparator
23715 Chk\SpecialChar TeX
23718 installation configuration file (usually with the file
23723 See below to learn what warnings can be enabled and disabled on the command
23727 \begin_layout Itemize
23728 Export your document as a raw \SpecialChar LaTeX
23731 File\SpecialChar menuseparator
23732 Export\SpecialChar menuseparator
23741 Invoked in this way, it can be a hassle to find the corresponding place
23742 in the document inside \SpecialChar LyX
23743 , but with a little patience, you should be able
23747 \begin_layout Standard
23748 Here follows the warning messages that can be enabled and disabled in
23757 to disable a warning, and
23761 to enable a warning.
23762 The emphasized entries are disabled by default, because the default is
23765 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
23770 \begin_layout Standard
23771 Notice that you should only use the options that enable and disable warnings,
23772 because \SpecialChar LyX
23773 relies on some of the other command line parameters to be set
23774 in a specific way to have a chance to communicate with
23781 \begin_layout Enumerate
23785 Command terminated with space.
23788 \begin_layout Enumerate
23791 Non-breaking space (
23792 \begin_inset Quotes eld
23800 \begin_inset Quotes erd
23803 ) should have been used.
23806 \begin_layout Enumerate
23810 You should enclose the previous parenthesis with
23811 \begin_inset Quotes eld
23819 \begin_inset Quotes erd
23825 \begin_layout Enumerate
23828 Italic correction (
23829 \begin_inset Quotes eld
23839 \begin_inset Quotes erd
23842 ) found in non-italic buffer.
23845 \begin_layout Enumerate
23848 Italic correction (
23849 \begin_inset Quotes eld
23859 \begin_inset Quotes erd
23862 ) found more than once.
23865 \begin_layout Enumerate
23869 No italic correction (
23870 \begin_inset Quotes eld
23880 \begin_inset Quotes erd
23886 \begin_layout Enumerate
23890 \begin_inset Quotes eld
23898 \begin_inset Quotes erd
23902 \begin_inset Quotes eld
23910 \begin_inset Quotes erd
23916 \begin_layout Enumerate
23919 Wrong length of dash may have been used.
23922 \begin_layout Enumerate
23926 \begin_inset Quotes eld
23934 \begin_inset Quotes erd
23938 \begin_inset Quotes eld
23946 \begin_inset Quotes erd
23952 \begin_layout Enumerate
23956 \begin_inset Quotes eld
23964 \begin_inset Quotes erd
23970 \begin_layout Enumerate
23974 \begin_inset Quotes eld
23982 \begin_inset Quotes erd
23985 to achieve an ellipsis.
23988 \begin_layout Enumerate
23991 Inter-word spacing (
23992 \begin_inset Quotes eld
24002 \begin_inset Quotes eld
24005 ) should perhaps be used.
24008 \begin_layout Enumerate
24011 Inter-sentence spacing (
24012 \begin_inset Quotes eld
24022 \begin_inset Quotes erd
24025 ) should perhaps be used.
24028 \begin_layout Enumerate
24031 Could not find argument for command.
24034 \begin_layout Enumerate
24038 \begin_inset Quotes eld
24046 \begin_inset Quotes erd
24052 \begin_layout Enumerate
24055 Math mode still on at end of \SpecialChar LaTeX
24059 \begin_layout Enumerate
24063 \begin_inset Quotes eld
24071 \begin_inset Quotes erd
24074 doesn't match the number of
24075 \begin_inset Quotes eld
24083 \begin_inset Quotes erd
24089 \begin_layout Enumerate
24092 You should use either
24095 \begin_inset Quotes eld
24103 \begin_inset Quotes erd
24108 as an alternative to
24109 \begin_inset Quotes eld
24117 \begin_inset Quotes erd
24123 \begin_layout Enumerate
24130 " (ASCII 39) instead of "
24137 \begin_layout Enumerate
24140 User-specified pattern found.
24143 \begin_layout Enumerate
24146 This command might not be intended.
24149 \begin_layout Enumerate
24156 \begin_layout Enumerate
24174 \begin_layout Enumerate
24177 Delete this space to maintain correct page references.
24180 \begin_layout Enumerate
24184 You might wish to put this between a pair of
24185 \begin_inset Quotes eld
24193 \begin_inset Quotes erd
24199 \begin_layout Enumerate
24202 You ought to remove spaces in front of punctuation.
24205 \begin_layout Enumerate
24208 Could not execute \SpecialChar LaTeX
24212 \begin_layout Enumerate
24221 in front of small punctuation.
24224 \begin_layout Enumerate
24232 may look prettier here.
24235 \begin_layout Enumerate
24239 Multiple spaces detected in output.
24242 \begin_layout Enumerate
24245 This text may be ignored.
24248 \begin_layout Enumerate
24254 \begin_inset Quotes eld
24259 to begin quotation, not
24266 \begin_layout Enumerate
24273 to end quotation, not
24276 \begin_inset Quotes eld
24284 \begin_layout Enumerate
24290 \begin_layout Enumerate
24293 You should perhaps use
24294 \begin_inset Quotes eld
24302 \begin_inset Quotes erd
24308 \begin_layout Enumerate
24311 You should put a space in front of/after parenthesis.
24314 \begin_layout Enumerate
24317 You should avoid spaces in front of/after parenthesis.
24320 \begin_layout Enumerate
24324 You should not use punctuation in front of/after quotes.
24327 \begin_layout Enumerate
24330 Double space found.
24333 \begin_layout Enumerate
24336 You should put punctuation outside inner/inside display math mode.
24339 \begin_layout Enumerate
24342 You ought to not use primitive \SpecialChar TeX
24343 in \SpecialChar LaTeX
24347 \begin_layout Enumerate
24350 You should remove spaces in front of
24351 \begin_inset Quotes eld
24359 \begin_inset Quotes erd
24365 \begin_layout Enumerate
24368 \begin_inset Quotes eld
24376 \begin_inset Quotes erd
24379 is normally not followed by
24380 \begin_inset Quotes eld
24388 \begin_inset Quotes erd
24394 \begin_layout Standard
24395 In later versions of \SpecialChar LyX
24396 , we hope to provide a more complete interface to this
24397 tool (and it's smaller cousin
24401 ) to exploit the full power of it.
24402 But it's not exactly useless as it is now: go try it on one of your existing
24403 documents of a certain length and be surprised.
24406 \begin_layout Section
24407 Version Control in \SpecialChar LyX
24411 \begin_layout Standard
24414 Lars Gullik Bjønnes
24421 \begin_layout Subsection
24425 \begin_layout Standard
24427 supports some of the most basic RCS/CVS/SVN/GIT commands.
24428 If you need something a bit more sophisticated you will have to do that
24429 manually in a terminal.
24432 \begin_layout Standard
24433 Also note that CVS support is not as good as subversion support, so we advise
24435 A good place to start learning Subversion is the SVN Book
24439 \begin_layout Plain Layout
24440 \begin_inset CommandInset href
24442 target "http://svnbook.red-bean.com/"
24453 In the case of RCS you should read
24454 \begin_inset Quotes eld
24458 \begin_inset Quotes erd
24461 (a man file, read it with
24466 This file describes all the basic features of RCS.
24467 You should especially notice the comment about a RCS directory, and the
24468 notion of a master RCS file (the file ending in
24475 \begin_layout Standard
24476 Before you begin to use the version control features in \SpecialChar LyX
24478 familiar with RCS/CVS/SVN/GIT usage.
24479 The implementation in \SpecialChar LyX
24480 assumes a recent version of the GNU RCS or CVS/SVN
24481 package — no guarantees are made for older versions.
24482 Most of the log messages are not currently displayed after operations —
24483 you can check them in the Messages pane if you are unsure.
24484 Regular users of version control will appreciate the VC toolbar, which
24487 View\SpecialChar menuseparator
24488 Toolbars\SpecialChar menuseparator
24490 \begin_inset space ~
24498 \begin_layout Standard
24499 For introducing your own external commands consult
24500 \begin_inset Flex Code
24503 \begin_layout Plain Layout
24517 \begin_layout Standard
24518 It is strongly recommended to store documents in uncompressed format if
24519 using version control (uncheck
24521 Document\SpecialChar menuseparator
24524 if it is checked): Uncompressed LyX documents are text files and therefore
24525 for merging two different versions by version control systems.
24526 Compressed LyX documents are binary files, which cannot be merged by version
24530 \begin_layout Subsection
24531 RCS commands in \SpecialChar LyX
24535 \begin_layout Standard
24536 The following sections describe the RCS commands supported by \SpecialChar LyX
24538 You can find them in the
24540 File\SpecialChar menuseparator
24542 \begin_inset space ~
24549 was tested against RCS 5.7/5.8.
24552 \begin_layout Subsubsection
24558 \begin_layout Standard
24559 If your document is not under revision control, this is the only item shown
24561 And if it is under revision control, the
24565 item is not visible.
24569 \begin_layout Standard
24570 This command registers your document with RCS (unless you are under the
24571 directory managed by CVS)\SpecialChar endofsentence
24572 You are asked interactively to supply an initial
24573 description of the document.
24574 The document is now set in Read-Only mode and you have to
24577 \begin_inset space ~
24581 \begin_inset space ~
24585 \begin_inset space ~
24590 , before making any changes to it.
24591 A document under revision control has a
24592 \begin_inset Quotes eld
24595 [RCS:<version> <locker>]
24596 \begin_inset Quotes erd
24599 item tagged to the filename in the minibuffer.
24602 \begin_layout Standard
24603 RCS command that is run:
24606 \begin_layout LyX-Code
24609 ci -q -u -i -t-"<initial description>" <file-name>
24612 \begin_layout Standard
24617 to understand the switches.
24621 \begin_layout Subsubsection
24627 \begin_layout Standard
24628 When you are finished editing a file, you check in your changes.
24629 When you do this, you are asked for a description of the changes.
24630 This is stored in the history log.
24631 The version number is bumped, your changes are applied to the master RCS
24632 file, the document is unlocked and set to Read-Only mode.
24635 \begin_layout Itemize
24638 ci -q -u -m"<description>" <file-name>
24641 \begin_layout Subsubsection
24647 \begin_layout Standard
24648 By doing this you lock the document so that only you can edit it.
24649 This will also make the document Read-Write only for you.
24650 You will usually continue editing for a while and when you are finished
24651 you check in your changes.
24652 The status line is changed to reflect that you have locked the file.
24655 \begin_layout Itemize
24658 co -q -l <file-name>
24661 \begin_layout Subsubsection
24664 Revert To Repository Version
24667 \begin_layout Standard
24668 This will discard all changes made to the document since the last check
24670 You get a warning before changes are discarded.
24673 \begin_layout Itemize
24676 co -f -u<version> <file-name>
24679 \begin_layout Subsubsection
24685 \begin_layout Standard
24686 This will create a copy of the current document.
24687 Since RCS does not support copy operations natively, the version history
24688 is not preserved, and the copy is added as a new file.
24689 It requires a clean document without any changes since the last checkin.
24690 You are asked for a file name and a description of the copy operation.
24691 After that the copy is created, both locally and in the repository.
24692 If the parent directories of the copied and original document differ, all
24693 relative paths of included files of the copy are adjusted (like in
24695 File\SpecialChar menuseparator
24700 Finally, the copy is loaded instead of the original document.
24703 \begin_layout Labeling
24704 \labelwidthstring 00.00.0000
24706 \begin_inset space ~
24710 \begin_inset space ~
24714 \begin_inset Newline newline
24718 \begin_inset Flex Code
24721 \begin_layout Plain Layout
24724 \begin_inset Quotes qld
24728 \begin_inset Quotes qld
24737 \begin_inset Flex Code
24740 \begin_layout Plain Layout
24743 \begin_inset Quotes qld
24747 \begin_inset Quotes qld
24756 \begin_inset Newline newline
24760 \begin_inset Flex Code
24763 \begin_layout Plain Layout
24767 \begin_inset Quotes qld
24771 \begin_inset Quotes qld
24782 \begin_layout Subsubsection
24788 \begin_layout Standard
24789 This makes as if the last check in never happened.
24790 No changes are made to the document loaded into \SpecialChar LyX
24791 , but the last version
24792 is removed from the master RCS file.
24795 \begin_layout Itemize
24798 rcs -o<version> <file-name>
24801 \begin_layout Subsubsection
24807 \begin_layout Standard
24808 This shows the complete history of the RCS document.
24813 is shown in a browser.
24821 \begin_layout Subsubsection
24825 \begin_layout Standard
24827 supports RCS version number, author name, date and time of last commit.
24828 All those are extracted from
24830 rlog -r <file-name>
24834 \begin_inset CommandInset ref
24836 reference "subsec:VCS-Revision-Information"
24843 \begin_layout Subsection
24844 CVS commands in \SpecialChar LyX
24848 \begin_layout Standard
24849 A subset of CVS operations is supported by \SpecialChar LyX
24851 You can find the commands in the
24853 File\SpecialChar menuseparator
24855 \begin_inset space ~
24861 The version control system SVN is more powerful, so please use it instead
24862 of CVS if possible.
24865 \begin_layout Subsubsection
24871 \begin_layout Standard
24872 If you start from scratch with CVS you have to create your repository and
24873 checkout the working copy with external tools.
24874 If you're using a client-server setup you may need to login before doing
24875 the first repository checkout.
24878 \begin_layout Standard
24879 If your documents are under revision control and others are using the same
24880 repository problems arise when different changes to the same document at
24881 the same location happen.
24882 Standard CVS repositories don't operate with a file locking mechanism.
24883 This may be surprising, but conflicts only occur if people disagree on
24884 the proper content of the same part of a document.
24885 So, if co-workers are used to communicate regularly, these conflicts occur
24887 If they don't communicate they have a fundamental problem anyway.
24888 Nevertheless some people like to work with so called
24889 \begin_inset Quotes eld
24893 \begin_inset Quotes erd
24897 If they do so the working copy of all files is readonly when checked out
24898 first and the user starts editing after using a special command to make
24899 the working copy writable.
24900 When the changes are checked in the working copy returns to readonly state.
24901 With \SpecialChar LyX
24902 one has to edit the
24903 \begin_inset Flex Code
24906 \begin_layout Plain Layout
24912 file and add the line
24913 \begin_inset Flex Code
24916 \begin_layout Plain Layout
24922 to work with reserved checkouts.
24923 The benefit is the possibility to see who is using a writable copy of some
24925 It's not guaranteed only one user makes a copy writable.
24928 \begin_layout Standard
24930 tries to guess if you're using reserved or non-reserved checkouts.
24931 If your working copy is readonly or it is writable and an additional copy
24932 of your document exists in the CVS/Base sub-directory a reserved otherwise
24933 a non-reserved checkout is assumed.
24934 When a reserved checkout is detected you have to use
24935 \begin_inset Flex Noun
24938 \begin_layout Plain Layout
24944 to make your working copy writable if it's readonly.
24946 \begin_inset Flex Noun
24949 \begin_layout Plain Layout
24955 operation is possible and that makes your working copy readonly again after
24956 transferring your changes to the repository.
24959 \begin_layout Standard
24960 More information about CVS can be found here
24961 \begin_inset Flex URL
24964 \begin_layout Plain Layout
24966 http://www.nongnu.org/cvs
24972 \begin_inset Flex URL
24975 \begin_layout Plain Layout
24977 http://ximbiot.com/cvs
24985 \begin_layout Standard
24990 to understand the sub-commands and the switches mentioned below.
24993 \begin_layout Subsubsection
24999 \begin_layout Standard
25000 If your document is not under revision control, this is the only item shown
25002 And if it is under revision control, the
25006 item is not visible.
25010 \begin_layout Standard
25011 This command registers in CVS your document
25012 \begin_inset Flex Strong
25015 \begin_layout Plain Layout
25023 in the case you have already the documents directory under CVS control
25029 This means you have to create or checkout the archive by yourself using
25031 (In case you forget that step \SpecialChar LyX
25032 registers the document with RCS.)
25035 \begin_layout Standard
25036 Then you are asked interactively to supply an initial description of the
25038 Don't forget that registered file is not yet checked in.
25041 \begin_layout Standard
25042 CVS command that is run:
25044 cvs -q add -m"<entered message>" "<file-name>"
25047 \begin_layout Standard
25052 above and for all other CVS commands is an abbreviation for
25053 \begin_inset Quotes eld
25056 change the current working directory to file location and use the file name
25057 without path component as argument
25058 \begin_inset Quotes erd
25064 \begin_layout Subsubsection
25070 \begin_layout Standard
25071 When you are finished editing a file, you commit your changes.
25072 When you do this and you had changed the document, you are asked for a
25073 description of the changes.
25074 After that changes are written to the repository.
25075 In case you didn't change the document and a reserved checkout is detected
25076 the reservation made on
25077 \begin_inset Flex Noun
25080 \begin_layout Plain Layout
25089 \begin_layout Labeling
25090 \labelwidthstring 00.00.0000
25092 \begin_inset space ~
25096 \begin_inset space ~
25100 \begin_inset Newline newline
25104 \begin_inset Flex Code
25107 \begin_layout Plain Layout
25110 -q commit -m"<description>" "<file-name>"
25116 \begin_inset Newline newline
25120 \begin_inset Flex Code
25123 \begin_layout Plain Layout
25134 \begin_layout Subsubsection
25140 \begin_layout Standard
25141 When you are sharing a repository with others, you may have to incorporate
25142 their changes into your working copy.
25145 \begin_layout Standard
25148 cvs -q update "<file-name>"
25151 \begin_layout Standard
25152 If a readonly checkout is detected the working copy is made writable and
25156 \begin_layout Standard
25159 cvs -q edit "<file-name>"
25162 \begin_layout Subsubsection
25165 Revert To Repository Version
25168 \begin_layout Standard
25169 This will discard all changes made to the document since the last check
25171 You get a warning before changes are discarded.
25172 Firstly the file is deleted, secondly CVS update command is run.
25175 \begin_layout Standard
25178 cvs -q update "<file-name>"
25181 \begin_layout Standard
25182 If a reserved checkout is detected and the working copy has no changes only
25183 the reservation is undone.
25186 \begin_layout Standard
25189 cvs -q unedit "<file-name>"
25192 \begin_layout Subsubsection
25198 \begin_layout Standard
25199 This will create a copy of the current document.
25200 Since CVS does not support copy operations natively, the version history
25201 is not preserved, and the copy is added as a new file.
25202 It requires a clean document without any changes since the last checkin.
25203 You are asked for a file name and a description of the copy operation.
25204 After that the copy is created, both locally and in the repository.
25205 If the parent directories of the copied and original document differ, all
25206 relative paths of included files of the copy are adjusted (like in
25208 File\SpecialChar menuseparator
25213 Finally, the copy is loaded instead of the original document.
25216 \begin_layout Labeling
25217 \labelwidthstring 00.00.0000
25219 \begin_inset space ~
25223 \begin_inset space ~
25227 \begin_inset Newline newline
25231 \begin_inset Flex Code
25234 \begin_layout Plain Layout
25241 \begin_inset Flex Code
25244 \begin_layout Plain Layout
25251 \begin_inset Newline newline
25255 \begin_inset Flex Code
25258 \begin_layout Plain Layout
25259 cvs -q add "<new-file-name>"
25267 \begin_layout Subsubsection
25273 \begin_layout Standard
25274 This will rename the current document.
25275 Since CVS does not support rename operations natively, the version history
25276 is not preserved, the renamed document is added as a new file, and the
25277 original document is deleted.
25278 It requires a clean document without any changes since the last checkin.
25279 You are asked for a file name and a description of the rename operation.
25280 After that the document is renamed, both locally and in the repository.
25281 If the parent directories of the new and old file names differ, all relative
25282 paths of included files are adjusted (like in
25284 File\SpecialChar menuseparator
25289 Finally, the document is reloaded using the new name.
25292 \begin_layout Labeling
25293 \labelwidthstring 00.00.0000
25295 \begin_inset space ~
25299 \begin_inset space ~
25303 \begin_inset Newline newline
25307 \begin_inset Flex Code
25310 \begin_layout Plain Layout
25317 \begin_inset Flex Code
25320 \begin_layout Plain Layout
25327 \begin_inset Newline newline
25331 \begin_inset Flex Code
25334 \begin_layout Plain Layout
25335 cvs -q add "<new-file-name>"
25341 \begin_inset Newline newline
25345 \begin_inset Flex Code
25348 \begin_layout Plain Layout
25349 cvs -q remove "<file-name>"
25357 \begin_layout Subsubsection
25358 Update of the local directory checkout from repository
25361 \begin_layout Standard
25362 Once your documents gets more complex, containing sub-documents and pictures,
25364 \begin_inset Flex Code
25367 \begin_layout Plain Layout
25373 files and so on using version control becomes more complicated.
25375 supports updating the whole tree in which resides the document.
25376 This become especially useful once you cooperate with people which neither
25377 have detailed knowledge about CVS usage nor they have ambition to commit
25378 additional material to the repository.
25379 You have to organize the files structure so that all external files are
25380 in the same directory or subdirectories of the document.
25381 It's good practice anyway to store multipart documents in an extra directory.
25384 \begin_layout Standard
25386 \begin_inset Flex Code
25389 \begin_layout Plain Layout
25390 Update local directory from repository
25395 command updates the whole directory.
25396 If local changes are detected user is warned before update starts.
25397 In case of merge conflicts both versions of the conflicting document parts
25398 are placed in the final document.
25399 You have to review and correct the result of the merge.
25400 You'll find the conflicts enclosed in pairs of
25401 \begin_inset Flex Code
25404 \begin_layout Plain Layout
25411 \begin_inset Flex Code
25414 \begin_layout Plain Layout
25421 \begin_inset Flex Code
25424 \begin_layout Plain Layout
25431 The first part is your version as before the update operation with the
25432 document name prepended.
25433 The second one is the repository version with the version number after
25435 \begin_inset Flex Code
25438 \begin_layout Plain Layout
25447 \begin_layout Labeling
25448 \labelwidthstring 00.00.0000
25450 \begin_inset space ~
25454 \begin_inset space ~
25458 \begin_inset Newline newline
25462 \begin_inset Flex Code
25465 \begin_layout Plain Layout
25473 (Ask if changes are detected.)
25474 \begin_inset Newline newline
25478 \begin_inset Flex Code
25481 \begin_layout Plain Layout
25482 cd $path; cvs -q update
25492 \begin_layout Standard
25494 \begin_inset Flex Code
25497 \begin_layout Plain Layout
25503 stands for the path to the document.
25506 \begin_layout Subsubsection
25512 \begin_layout Standard
25513 This shows the complete history of the CVS document.
25516 cvs log "<file-name>"
25518 is shown in a browser.
25521 \begin_layout Subsubsection
25525 \begin_layout Standard
25527 supports CVS version number, author name, date and time of last commit.
25528 All those are extracted from
25530 cvs log -r <file-name>
25534 \begin_inset CommandInset ref
25536 reference "subsec:VCS-Revision-Information"
25543 \begin_layout Subsection
25544 SVN commands in \SpecialChar LyX
25548 \begin_layout Standard
25549 SVN is now partially supported by \SpecialChar LyX
25551 You can find the commands in the
25553 File\SpecialChar menuseparator
25555 \begin_inset space ~
25561 Please note that if you use password protected access to repository via
25562 ssh, you will be asked in terminal window.
25564 was tested against SVN 1.5, 1.6, 1.7 and 1.8
25568 \begin_layout Plain Layout
25569 Most of the commands will work with 1.4 too, see
25570 \begin_inset CommandInset ref
25572 reference "subsec:SVN-Repo-Update"
25577 There seems to be currently unresolved permissions problem under SVN 1.8
25578 with reverting changes when file is locked.
25586 \begin_layout Subsubsection
25592 \begin_layout Standard
25593 If your document is not under revision control, this is the only item shown
25595 And if it is under revision control, the
25599 item is not visible.
25602 \begin_layout Standard
25603 This command registers in SVN your document ONLY in case you have already
25604 the documents directory under SVN control (in particular
25609 This means you have to checkout the archive by yourself.
25612 \begin_layout Standard
25613 Then you are asked interactively to supply an initial description of the
25615 Don't forget that registered file is not yet commited.
25618 \begin_layout Standard
25619 SVN command that is run:
25622 \begin_inset Quotes qld
25626 \begin_inset Quotes qld
25632 \begin_layout Standard
25637 to understand the switches.
25640 \begin_layout Subsubsection
25646 \begin_layout Standard
25647 When you are finished editing a file, you commit your changes.
25648 When you do this, you are asked for a description of the changes.
25649 After that changes are commited.
25652 \begin_layout Standard
25657 \begin_layout Plain Layout
25658 In case locking is not enabled.
25660 \begin_inset CommandInset ref
25662 reference "subsec:SVN-File-Locking"
25673 svn commit -q -m"<description>" <file-name>
25676 \begin_layout Subsubsection
25682 \begin_layout Standard
25683 Updates the changes of this file from the repository.
25684 Be sure you understand SVN merging and conflicts resolving before using
25685 this function, because all conflicts has to be resolved manually by you!
25688 \begin_layout Standard
25693 \begin_layout Plain Layout
25701 svn update --non-interactive
25702 \begin_inset Quotes qld
25706 \begin_inset Quotes qld
25712 \begin_layout Subsubsection
25715 Revert To Repository Version
25718 \begin_layout Standard
25719 This will discard all changes made to the document since the last check
25721 You get a warning before changes are discarded.
25724 \begin_layout Standard
25728 \begin_inset Quotes qld
25732 \begin_inset Quotes qld
25738 \begin_layout Subsubsection
25744 \begin_layout Standard
25745 This will create a copy of the current document including the version history.
25746 It requires a clean document without any changes since the last checkin.
25747 You are asked for a file name and a description of the copy operation.
25748 After that the copy is created, both locally and in the repository.
25749 If the parent directories of the copied and original document differ, all
25750 relative paths of included files of the copy are adjusted (like in
25752 File\SpecialChar menuseparator
25757 Finally, the copy is loaded instead of the original document.
25760 \begin_layout Labeling
25761 \labelwidthstring 00.00.0000
25763 \begin_inset space ~
25767 \begin_inset space ~
25771 \begin_inset Newline newline
25775 \begin_inset Flex Code
25778 \begin_layout Plain Layout
25782 \begin_inset Quotes qld
25786 \begin_inset Quotes qld
25790 \begin_inset Quotes qld
25794 \begin_inset Quotes qld
25803 \begin_inset Newline newline
25807 \begin_inset Flex Code
25810 \begin_layout Plain Layout
25819 \begin_layout Subsubsection
25825 \begin_layout Standard
25826 This will rename the current document including the version history.
25827 It requires a clean document without any changes since the last checkin.
25828 You are asked for a file name and a description of the rename operation.
25829 After that the document is renamed, both locally and in the repository.
25830 If the parent directories of the new and old file names differ, all relative
25831 paths of included files are adjusted (like in
25833 File\SpecialChar menuseparator
25838 Finally, the document is reloaded using the new name.
25841 \begin_layout Labeling
25842 \labelwidthstring 00.00.0000
25844 \begin_inset space ~
25848 \begin_inset space ~
25852 \begin_inset Newline newline
25856 \begin_inset Flex Code
25859 \begin_layout Plain Layout
25863 \begin_inset Quotes qld
25867 \begin_inset Quotes qld
25871 \begin_inset Quotes qld
25875 \begin_inset Quotes qld
25884 \begin_inset Newline newline
25888 \begin_inset Flex Code
25891 \begin_layout Plain Layout
25900 \begin_layout Subsubsection
25901 \begin_inset CommandInset label
25903 name "subsec:SVN-Repo-Update"
25907 Update of the local directory checkout from repository
25911 \begin_layout Plain Layout
25912 Note that this command will work only with subversion
25913 \begin_inset Formula $\geqq1.5$
25924 \begin_layout Standard
25925 All the commands above have one shortcoming – they deal with the current
25927 Once your document contains pictures, includes external
25928 \begin_inset Flex Code
25931 \begin_layout Plain Layout
25937 files and so on administration becomes more complicated.
25939 now supports updating the whole tree in which resides the document
25943 \begin_layout Plain Layout
25944 One need to organize the files structure so that all external files are
25945 in the same directory or subdirectories of the document.
25952 This become especially useful once you cooperate with people which neither
25953 know about subversion management nor they have ambition to commit additional
25954 material to the repository.
25958 \begin_layout Standard
25959 \begin_inset Flex Code
25962 \begin_layout Plain Layout
25963 Update local directory from repository
25968 command updates the whole directory and in case of merge conflicts local
25969 version of the files are left, so no unintended data loss occurs.
25970 If local changes are detected user is warned before update starts.
25973 \begin_layout Labeling
25974 \labelwidthstring 00.00.0000
25976 \begin_inset space ~
25980 \begin_inset space ~
25984 \begin_inset Newline newline
25988 \begin_inset Flex Code
25991 \begin_layout Plain Layout
25997 (Ask if changes are detected.)
25998 \begin_inset Newline newline
26002 \begin_inset Flex Code
26005 \begin_layout Plain Layout
26006 svn update --accept mine-full $path
26014 \begin_layout Standard
26016 \begin_inset Flex Code
26019 \begin_layout Plain Layout
26025 stands for the path to the document.
26028 \begin_layout Subsubsection
26034 \begin_layout Standard
26035 This shows the complete history of the SVN document.
26039 \begin_inset Quotes qld
26043 \begin_inset Quotes qld
26048 is shown in a browser.
26051 \begin_layout Subsubsection
26053 \begin_inset CommandInset label
26055 name "subsec:SVN-File-Locking"
26062 \begin_layout Standard
26063 The file exchange through various revision control systems brings the problem
26064 of merge conflicts in case two different users try to edit the same (parts
26066 When such a conflict happens it needs manual resolving and one reasonable
26067 alternative is to provide some kind of locking mechanism, which guarantees
26068 that only one user is allowed to edit file at the given time.
26071 \begin_layout Standard
26072 SVN has two such mechanisms to provide mutual exclusivity for file access
26073 – locks and automatic setting of write permissions (see sec.
26075 \begin_inset CommandInset ref
26077 reference "subsec:Automatical-Locking-Property"
26082 \begin_inset Flex Code
26085 \begin_layout Plain Layout
26095 \begin_layout Plain Layout
26096 \begin_inset Flex URL
26099 \begin_layout Plain Layout
26101 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
26112 If this property is detected for a given document \SpecialChar LyX
26113 starts to use SVN locks
26114 for document editing automatically and the whole check-in/out mechanism
26115 switches to the same regimen as for RCS.
26116 This in particular means there are two different modes of file use in \SpecialChar LyX
26120 \begin_layout Itemize
26122 The loaded file is in the read-only mode.
26123 For editing on needs to check-out.
26128 consists of updating from the repository and gaining write lock.
26129 If the lock is not possible to obtain, we remain in unlocked state.
26132 \begin_layout Itemize
26134 The loaded file is in the
26135 \begin_inset Quotes els
26139 \begin_inset Quotes ers
26143 No other user is allowed to edit the file.
26148 consists of commiting changes and releasing write-lock.
26149 If no changes have been made to the document, no commit will be produced
26153 \begin_layout Plain Layout
26154 Don't be puzzled by the fact that you will be asked for commit message anyway.
26159 and only the write-lock will be released.
26162 \begin_layout Standard
26166 \begin_layout Labeling
26167 \labelwidthstring 00.00.0000
26170 svn commit -q -m"<description>" "<file-name>"
26171 \begin_inset Newline newline
26174 svn unlock "<file-name>"
26177 \begin_layout Labeling
26178 \labelwidthstring 00.00.0000
26181 svn update "<file-name>"
26182 \begin_inset Newline newline
26185 svn lock "<file-name>"
26188 \begin_layout Subsubsection
26191 \begin_inset CommandInset label
26193 name "subsec:Automatical-Locking-Property"
26199 Automatic Locking Property
26202 \begin_layout Standard
26203 The above mentioned automatic setting of write permissions of the .lyx file
26206 File\SpecialChar menuseparator
26208 \begin_inset space ~
26211 Control\SpecialChar menuseparator
26212 Use Locking Property
26215 This command is active only when the file is not locked on the svn server
26217 you need to check-out before proceeding).
26220 \begin_layout Labeling
26221 \labelwidthstring 00.00.0000
26223 \begin_inset space ~
26229 \begin_layout Labeling
26230 \labelwidthstring 00.00.0000
26233 svn propset svn:needs-lock ON "<file-name>"
26236 \begin_layout Labeling
26237 \labelwidthstring 00.00.0000
26240 svn propdel svn:needs-lock "<file-name>"
26243 \begin_layout Subsubsection
26244 \begin_inset CommandInset label
26246 name "subsec:VCS-Revision-Information"
26250 Revision Information in Documents
26253 \begin_layout Standard
26254 There are more possibilities how to activate revision information in our
26258 \begin_layout Itemize
26264 \begin_layout Itemize
26265 tree revision information (
26266 \begin_inset Flex Code
26269 \begin_layout Plain Layout
26276 The result is the output of the
26277 \begin_inset Flex Code
26280 \begin_layout Plain Layout
26286 command, the following table gives you an idea, how to read the results.
26289 \begin_layout Standard
26291 \begin_inset Tabular
26292 <lyxtabular version="3" rows="6" columns="2">
26293 <features tabularvalignment="middle">
26294 <column alignment="left" valignment="top">
26295 <column alignment="left" valignment="top">
26297 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26300 \begin_layout Plain Layout
26308 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26311 \begin_layout Plain Layout
26321 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
26324 \begin_layout Plain Layout
26330 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26333 \begin_layout Plain Layout
26334 mixed revision working copy
26341 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
26344 \begin_layout Plain Layout
26350 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26353 \begin_layout Plain Layout
26354 modified working copy
26361 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
26364 \begin_layout Plain Layout
26370 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26373 \begin_layout Plain Layout
26374 switched working copy
26381 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
26384 \begin_layout Plain Layout
26390 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26393 \begin_layout Plain Layout
26394 partial working copy, from a sparse checkout
26401 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26404 \begin_layout Plain Layout
26410 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26413 \begin_layout Plain Layout
26414 mixed revision, modified, switched working copy
26427 \begin_layout Itemize
26428 file revision information.
26429 The result comes from parsing the output of
26430 \begin_inset Flex Code
26433 \begin_layout Plain Layout
26435 \begin_inset space ~
26439 \begin_inset space ~
26443 \begin_inset space ~
26452 Supported flags are:
26456 \begin_layout Itemize
26457 version number of the last commit (
26458 \begin_inset Flex Code
26461 \begin_layout Plain Layout
26470 \begin_layout Itemize
26471 author of the last commit (
26472 \begin_inset Flex Code
26475 \begin_layout Plain Layout
26484 \begin_layout Itemize
26485 date of the last commit (
26486 \begin_inset Flex Code
26489 \begin_layout Plain Layout
26498 \begin_layout Itemize
26499 time of the last commit (
26500 \begin_inset Flex Code
26503 \begin_layout Plain Layout
26513 \begin_layout Standard
26514 You can obtain this info via InsetInfo (
26515 \change_inserted 5863208 1564400022
26518 Insert\SpecialChar menuseparator
26519 Field\SpecialChar menuseparator
26520 Version Control Revision
26521 \change_deleted 5863208 1564399852
26526 \begin_inset Flex Code
26529 \begin_layout Plain Layout
26530 info-insert buffer vcs-date
26538 The information will be available only when you have the file stored under
26539 svn managment (i.e.
26541 \begin_inset Flex Code
26544 \begin_layout Plain Layout
26550 directory is available with your document).
26554 \begin_layout Itemize
26555 Another—a hacking one—possibility is to use svn keywords
26559 \begin_layout Plain Layout
26560 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
26566 In short – you set file keywords property (e.g.
26569 svn propset svn:keywords 'Rev' file.lyx
26571 ) and then paste keyword \SpecialChar TeX
26576 \begin_layout Plain Layout
26577 This is an easy way how to ensure that \SpecialChar LyX
26578 won't break the line in the middle
26584 tag in your document (e.g.
26586 \begin_inset Flex Code
26589 \begin_layout Plain Layout
26596 This way svn client will automatically substitute revision number (e.g.
26598 \begin_inset Flex Code
26601 \begin_layout Plain Layout
26607 ) after each update and commit.
26608 There are more problems with this approach.
26609 Firstly, the '$' character is used in \SpecialChar TeX
26610 world for math equations, so any
26611 occurence of math formula
26612 \begin_inset Formula $Rev$
26616 \begin_inset Formula $Rev:59$
26619 in your \SpecialChar LyX
26621 Similarly for other keywords like Id, Date, Author, etc.
26622 Secondly svn output is dependent on your locales, so its very easy that
26623 svn would produce some problematic strings once Date is used.
26624 Thirdly you get the whole 'Rev: 59' string in your document instead of
26626 Until subversion implements user's custom keywords it will be hard to use
26627 this approach reliably or let \SpecialChar LyX
26628 to support it directly.
26631 \begin_layout Subsection
26632 SVN and Windows Environment
26635 \begin_layout Quote
26636 My inclination is to say that if the user cannot figure out the command
26637 line operations on their own fairly quickly, they would be well advised
26638 to use TortoiseSVN.
26644 \begin_layout Subsubsection
26648 \begin_layout Standard
26649 In addition to installing \SpecialChar LyX
26650 , and having access to a Subversion repository,
26651 the user will need to install the Subversion client program.
26652 A Windows installer for the client program is available from
26653 \begin_inset CommandInset href
26656 target "http://www.collab.net/nonav/downloads/subversion/"
26662 The user may also want to install
26663 \begin_inset CommandInset href
26666 target "http://tortoisesvn.tigris.org/"
26671 , which integrates Subversion operations into the context (rightclick) menu
26672 of Windows Explorer.
26673 Operations done outside \SpecialChar LyX
26674 will typically be more convenient using the Explorer
26676 Note that TortoiseSVN is not a replacement for the client program, which
26677 is what \SpecialChar LyX
26681 \begin_layout Subsubsection
26682 Bringing a document under Subversion control
26685 \begin_layout Standard
26686 Before a \SpecialChar LyX
26687 document can be brought under version control in Subversion, its
26688 parent directory needs to be under version control.
26689 If the document is being added to a project already in the repository,
26690 this is accomplished by checking the project out to the directory where
26691 the new document will be placed.
26692 If the project itself is not yet under version control (for instance, if
26693 this document starts a new project), the directory must be imported into
26695 This is done outside \SpecialChar LyX
26697 Both import and checkout are easily accomplished from the Explorer context
26698 menu using TortoiseSVN, or alternatively can be done using the command
26699 line client at a DOS prompt.
26700 The procedure for importing the project using TortoiseSVN is described
26701 below, assuming an existing repository and a new project being started
26709 For information on using the Subversion client program, run
26716 \begin_layout Enumerate
26723 in Windows Explorer, right click it, and select
26725 TortoiseSVN\SpecialChar menuseparator
26729 If necessary, adjust the URL for the repository, then click OK.
26732 \begin_layout Enumerate
26733 Right click the level of the repository under which you want to place the
26734 new project folder (typically the top level) and click
26738 Supply a name for the project folder and click OK.
26739 Add a message for the log file if desired, then click OK again.
26740 The new project folder should appear in the repository.
26741 Finally, click OK again to exit the repository browser.
26744 \begin_layout Enumerate
26745 Once again right click
26751 , this time selecting SVN Checkout\SpecialChar ldots
26752 Select the URL of the project folder
26753 you just created in the repository, and set the checkout directory to
26761 You will be warned about a non-empty folder; click OK to proceed.
26762 You should now have a
26773 \begin_layout Enumerate
26774 Create or open your document in \SpecialChar LyX
26777 File\SpecialChar menuseparator
26779 \begin_inset space ~
26782 Control\SpecialChar menuseparator
26786 Add a log message and click OK to commit the document to version control.
26789 \begin_layout Standard
26790 From this point onward, you should have full functionality in the
26792 File\SpecialChar menuseparator
26794 \begin_inset space ~
26800 You also have the option of checking the document in and out, viewing its
26802 using the TortoiseSVN context menu in Windows Explorer or the Subversion
26803 client program from a command prompt.
26806 \begin_layout Subsubsection
26807 SSH tunnel used with SVN under Windows
26810 \begin_layout Standard
26811 Compared with Linux setting up an svn client to communicate over ssh under
26812 Windows is a rather troublesome task.
26813 We will at least offer some hints how to setup the client side but prior
26814 knowledge about ssh and the Windows command line is needed, also be prepared
26815 for a great deal of frustration\SpecialChar ldots
26819 \begin_layout Enumerate
26820 Get an svn client for windows, as described in the previous sections.
26821 When it is a fresh install run some svn command (e.g.
26823 \begin_inset Flex Code
26826 \begin_layout Plain Layout
26832 ) to create config files, which you will need to change later on.
26835 \begin_layout Enumerate
26836 Choose an ssh client for Windows.
26837 There are several possibilities, we will use the one from Putty tools
26841 \begin_layout Plain Layout
26842 \begin_inset Flex URL
26845 \begin_layout Plain Layout
26847 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
26858 You will need to set the connection up so that the client doesn't ask for
26859 any password from you.
26860 To keep things easy we will use only keys without any additional password
26865 \begin_layout Enumerate
26867 \begin_inset Flex Code
26870 \begin_layout Plain Layout
26877 Save your private .ppk key file and put the public one on the server side.
26878 If the SVN server runs on Linux, note that the format of the public key
26879 is not compatible with Linux openssh and you will need to direcly copy-paste
26881 \begin_inset Quotes eld
26886 Public key for pasting into OpenSSH authorized_keys file
26889 \begin_inset Quotes erd
26892 edit field into the server's
26893 \begin_inset Flex Code
26896 \begin_layout Plain Layout
26897 ~/.ssh/authorized_keys
26903 \begin_inset Flex Code
26906 \begin_layout Plain Layout
26915 \begin_layout Enumerate
26917 \begin_inset Flex Code
26920 \begin_layout Plain Layout
26927 In the SVN config file
26931 \begin_layout Plain Layout
26932 Exact path depends on Windows version, usually somewhere around
26933 \begin_inset Flex Code
26936 \begin_layout Plain Layout
26939 Documents and Settings
26953 \begin_inset Flex Code
26956 \begin_layout Plain Layout
26971 , section [tunnels], setup ssh command, e.g.
26973 \begin_inset Flex Code
26976 \begin_layout Plain Layout
26977 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
26986 \begin_layout Plain Layout
26987 It will usually take a lot of time to get exact command right and it depends
26989 For example do not have some remote server saved as a default session in
26991 If things fail, try to connect via plink without SVN first.
27000 \begin_layout Enumerate
27001 Checkout the SVN archive, e.
27002 \begin_inset space \thinspace{}
27006 \begin_inset Newline newline
27010 \begin_inset Flex Code
27013 \begin_layout Plain Layout
27014 svn co svn+ssh://user@server/repository_path
27022 \begin_layout Subsubsection
27023 End-of-Line Conversions
27026 \begin_layout Standard
27027 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
27029 use different line endings inside the .lyx files.
27030 This is not a problem as far as \SpecialChar LyX
27031 functionality is concerned, but the commit
27032 diffs will be huge and merge-conflicts prone.
27033 Fortunately SVN itself knows
27037 \begin_layout Plain Layout
27038 \begin_inset Flex URL
27041 \begin_layout Plain Layout
27043 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
27053 how to deal with CR/LF problems when switching .lyx files to the
27054 \begin_inset Flex Code
27057 \begin_layout Plain Layout
27067 \begin_layout Plain Layout
27069 \begin_inset Flex Code
27072 \begin_layout Plain Layout
27073 svn propset svn:eol-style native FILE_NAME
27086 \begin_layout Subsection
27087 GIT commands in \SpecialChar LyX
27091 \begin_layout Standard
27092 A minimal subset of GIT commands is now supported by \SpecialChar LyX
27094 You can find the commands in the
27096 File\SpecialChar menuseparator
27098 \begin_inset space ~
27104 Please note that if you use password protected access to repository via
27105 ssh, you will be asked in terminal window.
27107 was tested against GIT 1.7.
27111 \begin_layout Plain Layout
27112 Windows users please note that you need to ensure that git is on the path.
27113 This can be set from within \SpecialChar LyX
27116 Tools\SpecialChar menuseparator
27117 Preferences\SpecialChar menuseparator
27118 Paths\SpecialChar menuseparator
27129 \begin_layout Standard
27130 One big difference of GIT and the other supported version control systems
27131 is the distributed nature of GIT: With traditional version control systems
27132 there is one central server which hosts the repository.
27133 Users commit their changes to the server, and get updates made by other
27135 With GIT, users commit to a local repository.
27136 The local repository can be synchronized with one or more remote repositories
27138 \begin_inset Flex Code
27141 \begin_layout Plain Layout
27148 \begin_inset Flex Code
27151 \begin_layout Plain Layout
27159 does not interact in any way with remote GIT repositories.
27160 It works exclusively with the local repository in a very similar way as
27161 with a central CVS or SVN repository.
27162 If you use remote GIT repositories you need to do the
27163 \begin_inset Flex Code
27166 \begin_layout Plain Layout
27173 \begin_inset Flex Code
27176 \begin_layout Plain Layout
27182 operations with your favourite GIT client.
27185 \begin_layout Subsubsection
27191 \begin_layout Standard
27192 If your document is not under revision control, this is the only item shown
27194 And if it is under revision control, the
27198 item is not visible.
27201 \begin_layout Standard
27202 This command registers in GIT your document ONLY in case you have already
27203 the documents directory under GIT control (in particular
27208 This means you have to checkout the archive by yourself.
27211 \begin_layout Standard
27212 Then you are asked interactively to supply an initial description of the
27214 Don't forget that registered file is not yet committed.
27217 \begin_layout Standard
27218 GIT command that is run:
27221 \begin_inset Quotes qld
27225 \begin_inset Quotes qld
27231 \begin_layout Standard
27236 to understand the switches.
27239 \begin_layout Subsubsection
27245 \begin_layout Standard
27246 When you are finished editing a file, you commit your changes.
27247 When you do this, you are asked for a description of the changes.
27248 After that changes are committed.
27251 \begin_layout Standard
27254 git commit -q -m"<description>" <file-name>
27257 \begin_layout Subsubsection
27260 Revert To Repository Version
27263 \begin_layout Standard
27264 This will discard all changes made to the document since the last check
27266 You get a warning before changes are discarded.
27269 \begin_layout Standard
27273 \begin_inset Quotes qld
27277 \begin_inset Quotes qld
27283 \begin_layout Subsubsection
27289 \begin_layout Standard
27290 This will rename the current document including the version history.
27291 It requires a clean document without any changes since the last checkin.
27292 You are asked for a file name and a description of the rename operation.
27293 After that the document is renamed, both locally and in the repository.
27294 If the parent directories of the new and old file names differ, all relative
27295 paths of included files are adjusted (like in
27297 File\SpecialChar menuseparator
27302 Finally, the document is reloaded using the new name.
27305 \begin_layout Labeling
27306 \labelwidthstring 00.00.0000
27308 \begin_inset space ~
27312 \begin_inset space ~
27316 \begin_inset Newline newline
27320 \begin_inset Flex Code
27323 \begin_layout Plain Layout
27327 \begin_inset Quotes qld
27331 \begin_inset Quotes qld
27335 \begin_inset Quotes qld
27339 \begin_inset Quotes qld
27348 \begin_inset Newline newline
27352 \begin_inset Flex Code
27355 \begin_layout Plain Layout
27364 \begin_layout Subsubsection
27370 \begin_layout Standard
27371 This shows the complete history of the GIT document.
27375 \begin_inset Quotes qld
27379 \begin_inset Quotes qld
27384 is shown in a browser.
27387 \begin_layout Subsubsection
27391 \begin_layout Standard
27393 supports GIT hash number of the last commit to the file,
27394 \change_inserted 1119979965 1564297456
27395 its abbreviated form,
27397 author name, date and time of last commit.
27398 All those are extracted from
27400 git log -n 1 --pretty=format:%H%n
27401 \change_inserted 1119979965 1564297427
27407 Tree version information is obtained via
27409 git describe --abbrev --dirty --long
27413 \begin_inset CommandInset ref
27415 reference "subsec:VCS-Revision-Information"
27422 \begin_layout Subsection
27426 \begin_layout Standard
27427 With the recent addition of the
27428 \begin_inset Flex Code
27431 \begin_layout Plain Layout
27437 function \SpecialChar LyX
27438 power users are allowed to create their own commands for revision
27442 \begin_layout Standard
27443 As an example you can see how two TortoiseSVN commands could be integrated
27447 \begin_layout Description
27449 \begin_inset Flex Code
27452 \begin_layout Plain Layout
27453 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
27461 \begin_layout Description
27463 \begin_inset Flex Code
27466 \begin_layout Plain Layout
27467 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
27475 \begin_layout Subsection
27476 Version control and Document comparison
27479 \begin_layout Standard
27480 One of the typical uses of version control is to inspect the changes between
27481 revisions, usually by creating
27482 \begin_inset Flex Code
27485 \begin_layout Plain Layout
27492 While this is useful for plain text files, it is much less useful in the
27493 case of \SpecialChar LyX
27494 files, which have more a complicated structure.
27495 Hence we provide binding to the Document comparison feature.
27496 There are two ways of calling this feature – either by direct call of
27497 \begin_inset Flex Code
27500 \begin_layout Plain Layout
27507 function (for details see \SpecialChar LyX
27508 functions manual) or by the toolbar icon
27521 One can either compare two chosen revisions of the document or he can simply
27522 compare the current version of edited text with older revisions (where
27524 \begin_inset Flex Noun
27527 \begin_layout Plain Layout
27533 ' revisions back means comparison of the edited file with last commited
27538 \begin_layout Standard
27539 This feature is supported for SVN and RCS though due to the more complicated
27540 versioning scheme of RCS there is a constraint – when addressing the revisions
27541 in dialog, numbers always point to the last number in RCS revision number,
27544 We don't currently support GIT addressing of revisions, one can just compare
27545 edited document with its revision X steps backs, where X is addressed as
27547 \begin_inset Flex Code
27550 \begin_layout Plain Layout
27559 \begin_layout Section
27560 Literate Programming
27563 \begin_layout Standard
27568 (kayvan@sylvan.com)
27572 original documentation written by
27574 Edmar Wienskoski Jr.
27577 (edmar-w-jr@technologist.com)
27580 \begin_layout Subsection
27584 \begin_layout Standard
27585 The main purpose of this documentation is to show you how to use \SpecialChar LyX
27587 programming, where it is assumed that you are familiar with this programming
27588 technique, and know what
27589 \begin_inset Quotes eld
27593 \begin_inset Quotes erd
27597 \begin_inset Quotes eld
27601 \begin_inset Quotes erd
27605 If that is not the case, please follow the web links provided in the following
27607 There is a lot of good documentation out there covering old development
27608 history to the latest tools tips.
27611 \begin_layout Standard
27612 It is also assumed that you are familiar with \SpecialChar LyX
27613 itself to a point that you
27614 are comfortable changing your \SpecialChar LyX
27615 preferences, and X resources file.
27616 If that is not the case please refer to other \SpecialChar LyX
27617 documentation to cover your
27621 \begin_layout Subsection
27622 Literate Programming
27625 \begin_layout Standard
27626 From the Literate Programming FAQ:
27629 \begin_layout Quotation
27630 Literate programming is the combination of documentation and source together
27631 in a fashion suited for reading by human beings.
27632 In fact, literate programs should be enjoyable reading, even inviting!
27633 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
27634 and documentation in a single file.
27635 Literate programming tools then parse the file to produce either readable
27636 documentation or compilable source.
27637 The WEB style of literate programming was created by D.
27638 \begin_inset space \thinspace{}
27642 Knuth during the development of his \SpecialChar TeX
27643 typesetting software.
27647 \begin_layout Standard
27648 Another excerpt says:
27651 \begin_layout Quotation
27654 How is literate programming different from verbose commenting?
27657 \begin_layout Quotation
27658 There are three distinguishing characteristics.
27659 In order of importance, they are:
27663 \begin_layout Itemize
27664 flexible order of elaboration
27667 \begin_layout Itemize
27668 automatic support for browsing
27671 \begin_layout Itemize
27672 typeset documentation, especially diagrams and mathematics
27676 \begin_layout Standard
27677 Now that I sparked your curiosity, take a look in the references.
27680 \begin_layout Subsubsection
27684 \begin_layout Standard
27685 The complete Literate Programming FAQ can be found at:
27688 \begin_layout Quote
27689 Literate Programming FAQ
27690 \begin_inset Flex URL
27693 \begin_layout Plain Layout
27695 http://www.literateprogramming.com/lpfaq.pdf
27703 \begin_layout Standard
27704 The FAQ lists 23 (twenty three!) different literate programming tools.
27705 Where some are specialized or
27706 \begin_inset Quotes eld
27710 \begin_inset Quotes erd
27713 for particular programming languages, while other have general scope.
27718 for my own use for several reasons:
27721 \begin_layout Itemize
27722 It can generate the documentation either in \SpecialChar LaTeX
27726 \begin_layout Itemize
27727 It has a open architecture, i.
27728 \begin_inset space \thinspace{}
27732 \begin_inset space \space{}
27735 it is easy to plug in new filters
27739 \begin_layout Plain Layout
27744 are programs that read a given data stream and output a manipulated data
27746 That way, a WEB file (consisting of literate code) can be turned into a
27747 file consisting only of C program code or \SpecialChar LaTeX
27753 and to perform special processing that you may need.
27757 \begin_layout Itemize
27758 There is a good selection of filters available already (the HTML is one
27762 \begin_layout Itemize
27766 \begin_layout Standard
27767 The Noweb web page can be found at:
27770 \begin_layout Quote
27772 \begin_inset Flex URL
27775 \begin_layout Plain Layout
27777 https://www.cs.tufts.edu/~nr/noweb/
27785 \begin_layout Standard
27786 Starting from there you can reach many other interesting links and even
27787 some literate program examples.
27790 \begin_layout Subsection
27792 and Literate Programming with Noweb
27795 \begin_layout Standard
27796 The \SpecialChar LyX
27797 support for Literate Programming is provided by using the generic \SpecialChar LyX
27799 converters mechanism.
27800 This support is provided in a
27801 \begin_inset Quotes eld
27805 \begin_inset Quotes erd
27809 \begin_inset space \thinspace{}
27813 \begin_inset space \space{}
27816 you will be able to use this new \SpecialChar LyX
27817 feature with some other literate programming
27818 tool of your choice by just changing your \SpecialChar LyX
27822 \begin_layout Subsubsection
27823 Generating documents and code (weaving and tangling)
27826 \begin_layout Paragraph
27827 Using the noweb module
27830 \begin_layout Standard
27831 If you have installed Noweb and \SpecialChar LyX
27832 successfully, whenever you open a new document,
27833 after you have chosen its document class, use the
27835 Document\SpecialChar menuseparator
27839 \begin_inset Quotes eld
27843 \begin_inset Quotes erd
27847 If Noweb is correctly installed, when you click on the
27848 \begin_inset Quotes eld
27852 \begin_inset Quotes erd
27855 link, you will see the
27856 \begin_inset Quotes eld
27860 \begin_inset Quotes erd
27863 module in the available list and you can add it to your document.
27866 \begin_layout Paragraph
27870 \begin_layout Standard
27872 enables you to write code with a custom inset named
27873 \begin_inset Flex Noun
27876 \begin_layout Plain Layout
27883 Noweb delimits chunks like this:
27886 \begin_layout LyX-Code
27890 \begin_layout LyX-Code
27894 \begin_layout LyX-Code
27898 \begin_layout LyX-Code
27902 \begin_layout LyX-Code
27906 \begin_layout Standard
27907 The problem is that whatever is written in between the << and the
27911 must be taken literally, i.
27912 \begin_inset space \thinspace{}
27916 \begin_inset space \space{}
27920 should be prevented from making any special interpretation of what has
27922 This is also handled by
27923 \begin_inset Flex Noun
27926 \begin_layout Plain Layout
27932 , that works like a normal text inset but has a free spacing capability.
27935 \begin_layout Standard
27936 As a special note, you can also use the
27937 \begin_inset Quotes eld
27941 \begin_inset Quotes erd
27944 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
27948 \begin_layout LyX-Code
27952 \begin_layout LyX-Code
27953 def some_function(args):
27956 \begin_layout LyX-Code
27957 "This is the doc string for this function."
27960 \begin_layout LyX-Code
27961 print "My args: ", args
27964 \begin_layout LyX-Code
27965 @ %def some_function
27968 \begin_layout Standard
27969 For an example of this usage and the resulting cross-reference output, look
27970 at the Literate python program in
27972 LIBDIR/examples/listerrors.lyx
27974 which should make this all clear.
27977 \begin_layout Paragraph
27978 Generating the documentation
27981 \begin_layout Standard
27982 At this point you already have a new document file with a proper document
27983 class, and with some code and text on it.
27984 How do I print it? The answer is simple, you select
27986 View\SpecialChar menuseparator
27990 Just like you would do for a plain document.
27991 No special procedure is required.
27994 \begin_layout Standard
27995 To help orientate you, I will now explain what happens inside \SpecialChar LyX
27999 \begin_layout Enumerate
28002 Update\SpecialChar menuseparator
28005 menu option is chosen, a \SpecialChar LaTeX
28011 \begin_layout Standard
28012 If the document is of any literate class the generated file will be named
28013 with an extension name defined by the
28014 \begin_inset Quotes eld
28018 \begin_inset Quotes erd
28021 format (defined in the Preferences panel), otherwise the file will have
28030 \begin_layout Enumerate
28031 Note that the only difference so far is in the name of the file, no special
28032 processing is required by \SpecialChar LyX
28034 Given that you formatted the code using the
28035 \begin_inset Flex Noun
28038 \begin_layout Plain Layout
28044 inset that, by itself, takes care of the business.
28047 \begin_layout Enumerate
28048 If the document is of any literate class \SpecialChar LyX
28049 will then use the internal \SpecialChar LyX
28051 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
28056 \begin_layout Plain Layout
28057 The converters are defined in the
28059 Tools\SpecialChar menuseparator
28063 \begin_inset Quotes eld
28067 \begin_inset Quotes erd
28079 manual for general information about converters.
28084 to generate the \SpecialChar LaTeX
28089 \begin_layout Standard
28090 Otherwise it will just skip this step.
28094 \begin_layout Enumerate
28095 Finally, \SpecialChar LaTeX
28096 is invoked and the regular post processing continues as in a plain
28100 \begin_layout Standard
28101 Independence from a particular
28102 \begin_inset Quotes eld
28106 \begin_inset Quotes erd
28109 is easily achieved by changing the commands that are run by the various
28113 \begin_layout Paragraph
28114 Generating the code
28117 \begin_layout Standard
28118 When the build menu option is chosen or the corresponding button in the
28119 toolbar is pressed, a \SpecialChar LaTeX
28120 file is generated just like step 1 above.
28121 Next, \SpecialChar LyX
28127 This converter needs to be defined by the user and is not installed by
28128 default, though the Program format is.
28129 This converter (like any other converter) will have two parts:
28132 \begin_layout Enumerate
28133 The converter program itself.
28134 This program performs the conversion from the one format to the other (in
28135 this case, from the Noweb format to the Program pseudo-format).
28138 \begin_layout Enumerate
28139 The error log parser.
28140 This is a program whose sole purpose is to rewrite error messages in a
28141 format that \SpecialChar LyX
28143 This makes it possible for \SpecialChar LyX
28144 to place error boxes in the right places in
28148 \begin_layout Standard
28149 The first part, the
28150 \begin_inset Quotes eld
28154 \begin_inset Quotes erd
28157 setting, should be set to
28160 \begin_layout LyX-Code
28168 \begin_layout Standard
28169 This basically means that \SpecialChar LyX
28171 \begin_inset Quotes eld
28175 \begin_inset Quotes erd
28178 (a program or script) with the name of the Noweb file (normally a file
28179 in the \SpecialChar LyX
28180 temp directory) and the directory path of the original \SpecialChar LyX
28185 \begin_layout Standard
28186 This is an implementation of
28187 \begin_inset Quotes eld
28191 \begin_inset Quotes erd
28194 that you can place in a directory on your path:
28197 \begin_layout LyX-Code
28203 \begin_layout LyX-Code
28209 \begin_layout LyX-Code
28212 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
28215 \begin_layout Standard
28216 The next part of the converter setting is the
28217 \begin_inset Quotes eld
28221 \begin_inset Quotes erd
28224 which is to be set to
28227 \begin_layout LyX-Code
28230 parselog=$$s/scripts/listerrors
28233 \begin_layout Standard
28234 This will run any errors that are generated by the
28235 \begin_inset Quotes eld
28239 \begin_inset Quotes erd
28242 process through the
28243 \begin_inset Quotes eld
28247 \begin_inset Quotes erd
28253 \begin_layout Standard
28254 The build will normally take place in \SpecialChar LyX
28255 's temporary directory, so the files
28256 produced by the conversion will be in that directory.
28258 will copy out what it regards as the `main' file, but the
28262 conversion may produce several files, and so most of these would then be
28263 deleted when \SpecialChar LyX
28265 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
28266 the build-script chunk can place the generated files in that location.
28269 \begin_layout Paragraph
28270 Build instructions in the document
28273 \begin_layout Standard
28274 The last piece of the integration between \SpecialChar LyX
28276 \begin_inset Quotes eld
28280 \begin_inset Quotes erd
28284 Generally, the instructions for building your program should be embedded
28285 in a chunk of its own.
28287 \begin_inset Quotes eld
28291 \begin_inset Quotes erd
28294 above uses the notangle command to look for this chunk (called
28295 \begin_inset Quotes eld
28299 \begin_inset Quotes erd
28302 ) and runs its contents through
28303 \begin_inset Quotes eld
28307 \begin_inset Quotes erd
28313 \begin_layout Standard
28314 Typically, such a chunk would look something like this:
28317 \begin_layout LyX-Code
28321 \begin_layout LyX-Code
28323 \begin_inset Newline newline
28326 if [ -z "${NOWEB_SOURCE}" ]
28327 \begin_inset Newline newline
28333 \begin_layout LyX-Code
28334 NOWEB_SOURCE=myfile.nw
28335 \begin_inset Newline newline
28339 \begin_inset Newline newline
28343 code to extract files ...
28344 use NOWEB_OUTPUT_DIR here ...]
28345 \begin_inset Newline newline
28349 code to compile files ...]
28350 \begin_inset Newline newline
28356 \begin_layout Standard
28359 LIBDIR/examples/listerrors.lyx
28363 LIBDIR/examples/Literate.lyx
28365 which implement two versions of the
28366 \begin_inset Quotes eld
28370 \begin_inset Quotes erd
28373 program for some illustrations of how all of these pieces go together or
28376 LIBDIR/examples/noweb2lyx.lyx.
28379 Interestingly, these three files show off the language-indepence of the
28381 literate programming support since they are written in Python, C and Perl
28385 \begin_layout Subsubsection
28386 Configuring \SpecialChar LyX
28390 \begin_layout Standard
28391 All the Literate Programming support is configured by the
28393 Tools\SpecialChar menuseparator
28397 \begin_inset Quotes eld
28401 \begin_inset Quotes erd
28405 The important parts are:
28408 \begin_layout Description
28410 \begin_inset space ~
28414 \begin_inset Quotes eld
28418 \begin_inset Quotes erd
28422 \begin_inset space ~
28425 format Set up via the File Formats tab, this is where the Noweb-specific
28435 , the file extension is set to
28440 This tells \SpecialChar LyX
28441 to create a file with a
28445 extension in the first step of the conversion process.
28448 \begin_layout Description
28450 \begin_inset space ~
28458 \begin_inset space ~
28461 format This is an empty format whose sole purpose is to be the endpoint
28462 of a conversion (which then allows us to set up a converter for it).
28465 \begin_layout Description
28475 This converter performs the
28476 \begin_inset Quotes eld
28480 \begin_inset Quotes erd
28483 of the literate document.
28484 For Noweb, it is set to
28485 \begin_inset Quotes eld
28490 noweave -delay -index $$i > $$o
28493 \begin_inset Quotes erd
28499 \begin_layout Description
28509 \begin_inset Quotes eld
28513 \begin_inset Quotes erd
28517 As stated above, the Converter is set to
28518 \begin_inset Quotes eld
28526 \begin_inset Quotes erd
28529 , with Flags set to
28530 \begin_inset Newline newline
28534 \begin_inset Quotes eld
28539 parselog=$$s/scripts/listerrors
28542 \begin_inset Quotes erd
28548 \begin_layout Subsubsection
28552 \begin_layout Standard
28553 There is also a new function implemented in the \SpecialChar LyX
28555 \begin_inset Quotes eld
28558 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
28562 \begin_layout Standard
28563 When debugging code with ddd/gdb, it is possible to invoke a text editor
28564 at the current execution position with a single key stroke.
28565 The default ddd configuration for that is shift-ctrl-V.
28566 It happens that you can define the editor command line invocation in ddd
28569 Edit\SpecialChar menuseparator
28570 Preferences\SpecialChar menuseparator
28573 dialog and changing the "Edit Sources" entry.
28576 \begin_layout Standard
28577 I take advantage of the newly created \SpecialChar LyX
28578 server function and this ddd feature,
28580 \begin_inset Quotes eld
28584 \begin_inset Quotes erd
28590 \begin_layout LyX-Code
28591 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
28594 \begin_layout Standard
28595 With this, whenever you are using ddd and find a point in the program that
28596 you want to edit, you just press shift-ctrl-V (in the ddd window), and
28597 ddd will forward this information to \SpecialChar LyX
28598 through the \SpecialChar LyX
28599 server and then the
28601 window will show the same file with the cursor at the same position ddd
28603 No more guessing or long scrolling to locate a point in the program back
28607 \begin_layout Standard
28608 Note however that you must enable the \SpecialChar LyX
28609 server to get this feature working
28610 (it is disabled by default).
28612 \begin_inset space ~
28616 \begin_inset CommandInset ref
28618 reference "sec:Starting-the-Server"
28622 explains how to do that.
28625 \begin_layout Subsubsection
28629 \begin_layout Standard
28630 There are six new buttons that can be added to your \SpecialChar LyX
28632 Four of these buttons are short cuts to layout styles:
28650 , one for the custom inset
28655 The last one is a short cut to the
28656 \begin_inset Quotes eld
28660 \begin_inset Quotes erd
28667 \begin_layout Standard
28669 has a range of buttons that are available for tool bar customization.
28670 In my toolbar I like to combine the six short cuts above with two more:
28675 \SpecialChar menuseparator
28680 \SpecialChar menuseparator
28687 Document\SpecialChar menuseparator
28688 View\SpecialChar menuseparator
28692 Here is how it looks like:
28695 \begin_layout LyX-Code
28699 \begin_layout LyX-Code
28703 \begin_layout LyX-Code
28704 Icon "layout Standard"
28707 \begin_layout LyX-Code
28708 Icon "layout Section"
28711 \begin_layout LyX-Code
28712 Icon "layout \SpecialChar LaTeX
28716 \begin_layout LyX-Code
28717 Icon "layout \SpecialChar LyX
28721 \begin_layout LyX-Code
28722 Icon "flex.insert Chunk"
28725 \begin_layout LyX-Code
28729 \begin_layout LyX-Code
28733 \begin_layout LyX-Code
28734 Icon "buffer-typeset"
28737 \begin_layout LyX-Code
28738 Icon "build-program"
28741 \begin_layout LyX-Code
28745 \begin_layout LyX-Code
28749 \begin_layout LyX-Code
28753 \begin_layout LyX-Code
28757 \begin_layout LyX-Code
28761 \begin_layout Subsubsection
28762 Colors customization
28765 \begin_layout Standard
28766 There are a number of colors in \SpecialChar LyX
28767 that can be customized in
28772 One of the things that bothers people is the \SpecialChar LaTeX
28774 The default color is red, since the chunks uses \SpecialChar LaTeX
28775 font, and there is a lot
28776 of chunks in literate documents, you may get tired of seeing everything
28778 You can change it by going to the tabs
28787 \begin_layout Standard
28788 The next thing is the visible presence of the newline character in the screen.
28789 You can choose the color of this particular character and make it blend
28791 I recommend you choosing a color that is close to the background but not
28792 equal, that way you still can see it is there, but it is not bothering
28796 \begin_layout Subsection
28801 \begin_layout Standard
28810 is documented in the
28814 example file and in the Sweave manual (menu
28816 Help\SpecialChar menuseparator
28822 \begin_layout Chapter
28826 \begin_layout Standard
28827 You can do everything with \SpecialChar LyX
28828 that you can do with \SpecialChar LaTeX
28830 However, \SpecialChar LyX
28831 cannot support every \SpecialChar LaTeX
28833 But you can always use \SpecialChar TeX
28835 This chapter shows you some more special things you might want to use.
28836 For other special things you can do with figures, tables, floats, boxes
28837 and notes, have a look at the
28840 \begin_inset space ~