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"
133 \author 244031559 "Yuriy"
134 \author 1075283030 "Thibaut"
135 \author 1119979965 "Joel A. Kulesza"
141 Additional \SpecialChar LyX
145 \begin_layout Subtitle
150 by the \SpecialChar LyX
155 \begin_layout Plain Layout
157 Principal maintainer of this file is
159 Richard Kimberly Heck
162 If you have comments or error corrections, please send them to the \SpecialChar LyX
165 \begin_inset Flex Code
168 \begin_layout Plain Layout
169 <lyx-docs@lists.lyx.org>
182 \begin_layout Standard
183 \begin_inset CommandInset toc
184 LatexCommand tableofcontents
191 \begin_layout Chapter
195 \begin_layout Standard
196 This manual is essentially Part II of the
198 User's Guide\SpecialChar endofsentence
201 The reason for separating the two documents is simple: the
205 is already quite lengthy, and it contains information on all of the basic
206 features one needs to know in order to prepare most documents.
207 However, the \SpecialChar LyX
208 Team has worked to make \SpecialChar LyX
209 extensible through various configuration
210 files and external packages.
211 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
213 create a layout file (or module) for it without having to alter \SpecialChar LyX
215 We've already had contributions of several new features this way, and some
216 of them are documented here.
217 There are also some more `advanced' features, such as how to control the
218 presentation of bibliographies and how to work with multi-part documents,
219 that are not covered in the
223 and are discussed here.
226 \begin_layout Standard
227 This manual also documents some special features, like fax support
228 \change_deleted 244031559 1603802929
230 \change_inserted 244031559 1603802931
234 \change_deleted 244031559 1603802954
237 , which require additional software to work properly.
238 There is also a chapter on \SpecialChar LyX
240 And lastly, there's a chapter of \SpecialChar LaTeX
241 tools and tips, things you can use to
242 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
244 After all, \SpecialChar LyX
249 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
253 \begin_layout Standard
254 If you haven't read the
258 yet, you are definitely in the wrong manual.
263 is the first place to go, since it describes the notation and format of
265 You should also be thoroughly familiar with the
269 and all of the basic features of \SpecialChar LyX
270 before attempting to read this one.
273 \begin_layout Standard
274 Since many of the topics in this manual depend heavily on \SpecialChar LyX
276 with \SpecialChar LaTeX
277 , this first chapter covers the inner workings of \SpecialChar LyX
280 to generate exactly the \SpecialChar LaTeX
282 It is obviously for more seasoned \SpecialChar LyX
286 \begin_layout Chapter
288 and \SpecialChar LaTeX
292 \begin_layout Section
294 Uses \SpecialChar LaTeX
298 \begin_layout Standard
299 This chapter is for both \SpecialChar TeX
300 -nicians and the \SpecialChar LaTeX
302 In it, we'll explain how \SpecialChar LyX
303 and \SpecialChar LaTeX
304 work together to produce printable output.
305 This is the only place in any of the manuals where we assume you know something
306 about \SpecialChar LaTeX
310 \begin_layout Standard
311 At one time, \SpecialChar LyX
313 \begin_inset Quotes eld
316 WYSIWYM frontend to \SpecialChar LaTeX
318 \begin_inset Quotes erd
321 but that's no longer true.
322 There are frontends to \SpecialChar LaTeX
327 \begin_layout Plain Layout
328 Some familar ones are \SpecialChar TeX
329 maker and kile, on Linux, and \SpecialChar TeX
331 There are also the \SpecialChar LaTeX
332 modes for vi and emacs, of course.
337 These are basically text editors with the ability to run \SpecialChar LaTeX
339 errors in the file you're editing.
340 Although \SpecialChar LyX
349 run \SpecialChar LaTeX
350 , and it also indicates errors in the file, it also does much, much
352 For one thing, you don't need to know \SpecialChar LaTeX
353 to use \SpecialChar LyX
356 has added its own extensions to \SpecialChar LaTeX
358 Try the following sometime: select
359 \begin_inset Flex Noun
362 \begin_layout Plain Layout
363 Export\SpecialChar menuseparator
370 \begin_inset Flex Noun
373 \begin_layout Plain Layout
380 \begin_inset Flex Noun
383 \begin_layout Plain Layout
384 View\SpecialChar menuseparator
394 ), then look at the preamble of the resulting
395 \begin_inset Flex Code
398 \begin_layout Plain Layout
405 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
407 These macros are defined automatically, according to the features you use
411 \begin_layout Standard
412 There are several commands that automatically invoke \SpecialChar LaTeX
417 \begin_layout Itemize
418 \begin_inset Flex Noun
421 \begin_layout Plain Layout
422 Document\SpecialChar menuseparator
431 \begin_layout Itemize
432 \begin_inset Flex Noun
435 \begin_layout Plain Layout
436 Document\SpecialChar menuseparator
445 \begin_layout Standard
446 They will only invoke \SpecialChar LaTeX
447 if the file has changed since the last time \SpecialChar LaTeX
453 \begin_layout Standard
454 When \SpecialChar LyX
455 runs \SpecialChar LaTeX
456 on the file you're editing, it performs these steps:
459 \begin_layout Enumerate
460 Convert the document to \SpecialChar LaTeX
461 and save to a file with the extension
462 \begin_inset Flex Code
465 \begin_layout Plain Layout
472 \begin_inset Flex Code
475 \begin_layout Plain Layout
484 \begin_layout Enumerate
485 Run \SpecialChar LaTeX
487 \begin_inset Flex Code
490 \begin_layout Plain Layout
496 file (maybe several times), and run any other commands (such as
497 \begin_inset Flex Code
500 \begin_layout Plain Layout
507 \begin_inset Flex Code
510 \begin_layout Plain Layout
516 ) needed to compile the \SpecialChar LaTeX
520 \begin_layout Enumerate
521 If there are any errors, show the error log.
524 \begin_layout Standard
525 If you have run \SpecialChar LaTeX
527 \begin_inset Flex Noun
530 \begin_layout Plain Layout
531 View\SpecialChar menuseparator
538 then runs a DVI viewer to display the DVI-file.
540 \begin_inset Flex Noun
543 \begin_layout Plain Layout
544 View\SpecialChar menuseparator
551 performs further steps:
554 \begin_layout Enumerate
556 \begin_inset Flex Code
559 \begin_layout Plain Layout
565 to convert the DVI file to PostScript.
568 \begin_layout Enumerate
569 Run a PostScript viewer, such as
570 \begin_inset Flex Code
573 \begin_layout Plain Layout
579 , to display the PostScript file.
582 \begin_layout Standard
584 does similar things when viewing, or exporting, other formats.
587 \begin_layout Section
588 Translating \SpecialChar LaTeX
589 files into \SpecialChar LyX
593 \begin_layout Standard
594 You can import a \SpecialChar LaTeX
595 file into \SpecialChar LyX
597 \begin_inset Flex Noun
600 \begin_layout Plain Layout
601 File\SpecialChar menuseparator
602 Import\SpecialChar menuseparator
608 command in \SpecialChar LyX
610 This will call a program named
611 \begin_inset Flex Code
614 \begin_layout Plain Layout
620 which will create a file
621 \begin_inset Flex Code
624 \begin_layout Plain Layout
631 \begin_inset Flex Code
634 \begin_layout Plain Layout
642 will then open that file.
646 \begin_layout Plain Layout
647 \begin_inset Flex Code
650 \begin_layout Plain Layout
656 can also be run from the command line, of course.
664 \begin_layout Standard
665 \begin_inset Flex Code
668 \begin_layout Plain Layout
674 will translate most legal \SpecialChar LaTeX
675 , but not everything.
676 It will put things it doesn't understand into \SpecialChar TeX
677 code, so after translating
679 \begin_inset Flex Code
682 \begin_layout Plain Layout
688 , you can look for \SpecialChar TeX
689 code and hand-edit it until it looks right.
692 \begin_layout Standard
693 If you don't know what \SpecialChar TeX
694 code is, read the next section.
697 \begin_layout Section
698 \begin_inset CommandInset label
700 name "sec:Inserting-TeX-Code"
704 Inserting \SpecialChar TeX
705 Code into \SpecialChar LyX
709 \begin_layout Standard
710 Anything you can do in \SpecialChar LaTeX
711 you can do in \SpecialChar LyX
712 , for a very simple reason: You can
713 always insert \SpecialChar TeX
714 code into any \SpecialChar LyX
717 cannot, and will never be able to, display every possible \SpecialChar LaTeX
719 If ever you need to insert \SpecialChar LaTeX
720 commands into your \SpecialChar LyX
721 document, you can use the
723 \begin_inset Flex Code
726 \begin_layout Plain Layout
733 box, which you can insert into your document with
734 \begin_inset Flex Noun
737 \begin_layout Plain Layout
738 Insert\SpecialChar menuseparator
748 or the keyboard shortcut
757 \begin_layout Standard
758 Here's an example of inserting \SpecialChar LaTeX
759 commands in a \SpecialChar LyX
761 The code looks like this:
764 \begin_layout LyX-Code
768 \begin_inset Newline newline
774 \begin_inset Newline newline
777 This is an example of a minipage environment.
779 \begin_inset Newline newline
782 can put nearly everything in it, even (non-floating)
783 \begin_inset Newline newline
788 \begin_inset Newline newline
794 \begin_inset Newline newline
798 \begin_inset Newline newline
804 \begin_inset Newline newline
810 \begin_inset Newline newline
816 \begin_inset Newline newline
821 \begin_inset Newline newline
827 \begin_inset Newline newline
833 \begin_inset Newline newline
839 \begin_inset Newline newline
847 \begin_layout LyX-Code
851 \begin_layout Standard
853 \begin_inset Flex Code
856 \begin_layout Plain Layout
863 box containing this text is directly after this paragraph.
864 Those of you reading the manual in \SpecialChar LyX
865 will only see the \SpecialChar TeX
867 Those reading a printed version of the manuals will see the actual results:
868 \begin_inset VSpace bigskip
874 \begin_layout Standard
878 \begin_layout Plain Layout
885 \begin_layout Plain Layout
892 \begin_layout Plain Layout
894 This is an example of a minipage environment.
895 You can put nearly everything in it, even (non-floating) figures and tables.
899 \begin_layout Plain Layout
906 \begin_layout Plain Layout
911 \begin_layout Plain Layout
918 \begin_layout Plain Layout
925 \begin_layout Plain Layout
932 \begin_layout Plain Layout
938 \begin_layout Plain Layout
945 \begin_layout Plain Layout
952 \begin_layout Plain Layout
959 \begin_layout Plain Layout
969 \begin_inset VSpace bigskip
975 \begin_layout Standard
976 In addition to using \SpecialChar TeX
977 code, you can also create a separate file containing
978 some complex \SpecialChar LaTeX
979 structure and then use
980 \begin_inset Flex Noun
983 \begin_layout Plain Layout
984 Insert\SpecialChar menuseparator
994 to include your file (you should select the type
995 \begin_inset Flex Code
998 \begin_layout Plain Layout
1005 We recommend that you only do this if you have a
1006 \begin_inset Flex Code
1009 \begin_layout Plain Layout
1020 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1024 \begin_layout Standard
1025 There are a few last points to emphasize:
1028 \begin_layout Itemize
1034 check if your \SpecialChar LaTeX
1038 \begin_layout Itemize
1039 Beware of reinventing the wheel.
1042 \begin_layout Standard
1043 On that last point, \SpecialChar LyX
1044 does have quite a few features tucked into it, and
1046 Be sure to check the manuals to make sure that \SpecialChar LyX
1047 doesn't have such-and-such
1048 feature before you decide you have to do it by hand.
1049 Moreover, there are numerous \SpecialChar LaTeX
1050 packages out there to do all sorts of things,
1051 from labels to envelopes to fancy multipage tables.
1053 \change_inserted 244031559 1603815732
1055 \begin_inset CommandInset href
1058 target "https://www.ctan.org/"
1064 \change_deleted 244031559 1603815732
1066 \begin_inset CommandInset href
1069 target "http://www.ctan.org/"
1079 \begin_layout Standard
1080 If you do need to do some wild and fancy things within your document, be
1081 sure to check out a good \SpecialChar LaTeX
1082 book for assistance.
1083 There are a number of them listed in the bibliography of the
1090 \begin_layout Section
1092 and the \SpecialChar LaTeX
1096 \begin_layout Subsection
1097 About the \SpecialChar LaTeX
1101 \begin_layout Standard
1102 If you already know \SpecialChar LaTeX
1103 , there is no need to explain here what the preamble
1105 If you don't, the following will give you some ideas—we recommend again
1106 that you consult a \SpecialChar LaTeX
1107 book for further information.
1108 In any case, you should read the points below, because they explain what
1109 you can do and what you don't need to do in the \SpecialChar LaTeX
1110 preamble of a \SpecialChar LyX
1114 \begin_layout Standard
1115 The \SpecialChar LaTeX
1116 preamble comes at the very beginning of a document,
1124 \begin_layout Itemize
1125 Declare the document class.
1127 \begin_inset Newline newline
1131 already does this for you.
1132 If you're a seasoned \SpecialChar LaTeX
1133 -nician, and you have a custom document class you
1134 want to use, check out the
1136 Customization Manual
1138 for information on how to make \SpecialChar LyX
1142 \begin_layout Itemize
1143 Declare the usage of packages.
1145 \begin_inset Newline newline
1149 packages provide special commands, which are only available within a document
1150 when the package has been declared in the preamble.
1151 In addition to providing special commands, the inclusion of a package can
1152 change the document.
1153 For example, the package
1154 \begin_inset Flex Code
1157 \begin_layout Plain Layout
1163 forces all paragraphs to be indented.
1164 There are other packages for labels, envelopes, margins, etc.
1168 \begin_layout Itemize
1169 Set counters, variables, lengths and widths.
1171 \begin_inset Newline newline
1174 There are several \SpecialChar LaTeX
1175 counters and variables that
1179 be set globally from within the preamble in order to have the desired effect.
1180 (There are variables that you can set and reset inside the document, too.)
1181 Margins are a good example of something that must be set in the preamble.
1182 Another example is the label format for lists.
1183 You can actually set these just about anywhere, but it's best to do it
1184 just once, inside the preamble.
1187 \begin_layout Itemize
1188 Declare user defined commands (with
1189 \begin_inset Flex Code
1192 \begin_layout Plain Layout
1201 \begin_inset Flex Code
1204 \begin_layout Plain Layout
1213 \begin_inset Newline newline
1216 These are abbreviations for \SpecialChar LaTeX
1217 commands which appear very often inside a document.
1218 Although the preamble is a good place to declare such commands, they
1222 be declared anywhere (before they are used for the first time, of course).
1223 This can be useful if there is a lot of raw \SpecialChar LaTeX
1224 code in your document, which
1225 normally should not be the case.
1228 \begin_layout Standard
1230 adds its own set of definitions to the preamble of the
1231 \begin_inset Flex Code
1234 \begin_layout Plain Layout
1241 This makes \SpecialChar LaTeX
1242 files generated by \SpecialChar LyX
1246 \begin_layout Subsection
1247 Changing the Preamble
1250 \begin_layout Standard
1251 The commands which \SpecialChar LyX
1252 adds to the preamble of a \SpecialChar LaTeX
1253 file are fixed; you can't
1254 change them without patching \SpecialChar LyX
1256 You can, however, add your own stuff to the preamble by selecting
1257 \begin_inset Flex Noun
1260 \begin_layout Plain Layout
1263 \begin_inset space ~
1272 \begin_inset Flex Noun
1275 \begin_layout Plain Layout
1276 Document\SpecialChar menuseparator
1284 adds anything in the
1285 \begin_inset Flex Noun
1288 \begin_layout Plain Layout
1294 dialog to its own built-in preamble.
1295 Before adding your own declarations in the preamble, you should make sure
1296 that \SpecialChar LyX
1297 doesn't already support what you want to do.
1298 (Remember what we said about reinventing the wheel?) Also,
1300 make sure your preamble code is correct
1304 doesn't check it for you.
1305 If there is an error, you're likely to get an error like
1306 \begin_inset Quotes eld
1310 \begin_inset Flex Code
1313 \begin_layout Plain Layout
1322 \begin_inset Quotes erd
1326 If you see this error, check your preamble.
1329 \begin_layout Subsection
1333 \begin_layout Standard
1334 Here are some examples of what you can add to a preamble, and what they
1338 \begin_layout Subsubsection
1342 \begin_layout Standard
1343 There are two variables under \SpecialChar LaTeX
1344 that control page position:
1345 \begin_inset Flex Code
1348 \begin_layout Plain Layout
1357 \begin_inset Flex Code
1360 \begin_layout Plain Layout
1369 Their names should be self-explanatory.
1370 These variables are useful if you think for a moment about computer labels.
1371 Sometimes, the size of a print medium and the area of the medium that you
1372 can actually print on aren't the same.
1374 \begin_inset Flex Code
1377 \begin_layout Plain Layout
1386 \begin_inset Flex Code
1389 \begin_layout Plain Layout
1400 \begin_layout Standard
1401 The default values for
1402 \begin_inset Flex Code
1405 \begin_layout Plain Layout
1414 \begin_inset Flex Code
1417 \begin_layout Plain Layout
1426 \begin_inset space \thinspace{}
1430 \begin_inset space \thinspace{}
1434 \begin_inset space \space{}
1437 the page isn't shifted.
1438 Unfortunately, some DVI drivers always seem to shift the page.
1439 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1440 If you're using \SpecialChar LyX
1441 on a system that you don't personally maintain, and your
1442 sysadmin is a doofus,
1443 \begin_inset Flex Code
1446 \begin_layout Plain Layout
1455 \begin_inset Flex Code
1458 \begin_layout Plain Layout
1467 Suppose your left and top margins are always 0.5
1468 \begin_inset space \thinspace{}
1472 You can add this to the preamble:
1475 \begin_layout LyX-Code
1483 \begin_layout LyX-Code
1491 \begin_layout Standard
1492 and your margins should now be correct.
1495 \begin_layout Subsubsection
1499 \begin_layout Standard
1500 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1501 There's a rather nice package, available at your nearest CTAN archive,
1502 for printing sheets of labels:
1503 \begin_inset Flex Code
1506 \begin_layout Plain Layout
1513 Now, your system may not have this package installed by default.
1514 We leave that up to you to check.
1515 You'll also want to read the documentation for it; we're not going to do
1517 Since this is an example, however, we'll give you an example of how you
1521 \begin_layout Standard
1522 First, make sure you're using the
1523 \begin_inset Flex Code
1526 \begin_layout Plain Layout
1533 Next, you need to put the following in your preamble:
1536 \begin_layout LyX-Code
1542 \begin_layout LyX-Code
1548 \begin_layout LyX-Code
1554 \begin_layout LyX-Code
1560 \begin_layout LyX-Code
1566 \begin_layout LyX-Code
1572 \begin_layout LyX-Code
1578 \begin_layout Standard
1579 This sets things up for Avery label sheets, stock #5360.
1580 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1583 \begin_inset Flex Code
1586 \begin_layout Plain Layout
1595 \begin_inset Flex Code
1598 \begin_layout Plain Layout
1606 around each label text.
1607 This and other special features of
1608 \begin_inset Flex Code
1611 \begin_layout Plain Layout
1617 are explained in its documentation.
1620 \begin_layout Standard
1621 Someday, someone may write a \SpecialChar LyX
1622 layout file to support this package directly.
1623 Maybe that someone is you.
1626 \begin_layout Subsubsection
1627 Example #3: Paragraph Indentation
1630 \begin_layout Standard
1631 Americans are trained to indent the first line of
1636 As with all of their other weird quirks, most Americans will whine and
1637 moan until they can have their way and indent the first line of all paragraphs.
1646 \begin_layout Standard
1647 Of course, this behavior isn't standard typography.
1648 In books, you typically only indent the first line of a paragraph
1652 it follows another one.
1653 The idea behind indenting the first line of a paragraph is to distinguish
1654 neighboring paragraphs from one another.
1655 If there is no previous paragraph—for example, if it follows a figure or
1656 is the first paragraph in a section—then there is no need for indentation.
1660 \begin_layout Standard
1661 If you're a typical American (we're still joking!), though, you don't care
1662 about such esoteric things; you want your indentation! Add this to the
1666 \begin_layout LyX-Code
1669 usepackage{indentfirst}
1672 \begin_layout Standard
1673 If your \SpecialChar TeX
1674 distribution isn't braindead, you'll have this package, and all
1675 of your paragraphs will get the indentation the Founding Fathers intended
1679 \begin_layout Subsubsection
1680 Example #4: This Document
1683 \begin_layout Standard
1684 You can also check out the preamble of this document to get an idea of some
1685 of the advanced things you can do.
1688 \begin_layout Section
1690 and \SpecialChar LaTeX
1694 \begin_layout Standard
1695 When \SpecialChar LyX
1696 calls \SpecialChar LaTeX
1697 , it tells \SpecialChar LaTeX
1698 to blithely ignore any errors and keep going.
1699 It then uses the logfile from the \SpecialChar LaTeX
1700 run to do a post-mortem.
1701 After analyzing the logfile, \SpecialChar LyX
1702 displays a dialog listing the errors.
1703 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1705 where the error occurred.
1709 \begin_layout Plain Layout
1711 Analyzing the logfile is a tough job, and \SpecialChar LyX
1712 doesn't always go to the right
1714 There are also cases where \SpecialChar LaTeX
1715 reports the error on one line, but the actual
1717 This is not unlike forgetting a closing brace in a program: You'll get
1718 an error, but only later.
1726 \begin_layout Standard
1727 Some folks also like to look at the log file directly: It is available from
1729 \begin_inset Flex Noun
1732 \begin_layout Plain Layout
1733 Document\SpecialChar menuseparator
1735 \begin_inset space ~
1744 There are some fairly common error messages and warnings.
1745 We'll cover those here.
1746 You should look at a good \SpecialChar LaTeX
1747 book for a complete listing.
1750 \begin_layout Itemize
1751 \begin_inset Flex Code
1754 \begin_layout Plain Layout
1761 \begin_inset Newline newline
1764 Anything beginning with these words is a warning message for the purpose
1766 \begin_inset Quotes eld
1770 \begin_inset Quotes erd
1773 the \SpecialChar LaTeX
1775 You'll get messages like this if you added or changed cross-references
1776 or bibliography entries, in which case, \SpecialChar LaTeX
1777 is trying to tell you that you
1778 need to make another run.
1779 You can by-and-large ignore these.
1782 \begin_layout Itemize
1783 \begin_inset Flex Code
1786 \begin_layout Plain Layout
1793 \begin_inset Newline newline
1796 Another warning message, this time about fonts which \SpecialChar LaTeX
1798 The rest of the message will often say something about a replacement font
1799 that \SpecialChar LaTeX
1801 You can safely ignore these, too.
1804 \begin_layout Itemize
1805 \begin_inset Flex Code
1808 \begin_layout Plain Layout
1817 \begin_inset Newline newline
1826 It seems to generate at least one of these messages for just about any
1828 They are warnings about lines that were too long and run past the right
1830 This happens if \SpecialChar LaTeX
1831 does not find a reasonable way to break the lines (notoriously
1832 often with typewriter font, since this does not allow for automatic break
1834 In many cases, this is unnoticeable in the final output.
1835 (It can be just a point or two.) Sometimes, however, the lines run rather
1836 visibly into the margin; something you will not want to have in your final
1839 \begin_inset Newline newline
1842 There are several global ways to try to minimize the overfull lines.
1845 Enable micro-typographic extensions
1849 Document\SpecialChar menuseparator
1850 Settings\SpecialChar menuseparator
1853 might already improve things a lot.
1854 Furthermore, \SpecialChar LaTeX
1855 code such as the following in
1857 Document\SpecialChar menuseparator
1858 Settings\SpecialChar menuseparator
1861 usually reduces the overfull lines drastically (we use this in the preamble
1866 \begin_layout LyX-Code
1870 \begin_inset Newline newline
1876 \begin_inset Newline newline
1881 emergencystretch 1.5em
1882 \begin_inset Newline newline
1890 \begin_layout Standard
1891 In some cases, however, you eventually have to rewrite the text to get the
1892 line breaking right.
1896 \begin_layout Plain Layout
1897 For more information, see
1898 \begin_inset Flex URL
1901 \begin_layout Plain Layout
1903 http://www.tex.ac.uk/FAQ-overfull.html
1916 \begin_layout Standard
1917 In any case, you should check the respective lines, at least for the final
1918 version of your document.
1919 Your eyes will tell you if there's a problem with something that's too
1924 \begin_layout Plain Layout
1925 You can also enable the `draft' option in
1926 \begin_inset Flex Noun
1929 \begin_layout Plain Layout
1930 Document\SpecialChar menuseparator
1936 , and then \SpecialChar LaTeX
1937 will draw a black box in the margin of lines that are overfull.
1946 \begin_layout Itemize
1947 \begin_inset Flex Code
1950 \begin_layout Plain Layout
1959 \begin_inset Newline newline
1962 Not quite as common as its cousin.
1963 This happens again if \SpecialChar LaTeX
1964 does not find a reasonable break point and consequently
1965 generates too loose lines.
1966 As with the overfull lines, you should check if this is a visible problem.
1969 \begin_layout Itemize
1970 \begin_inset Flex Code
1973 \begin_layout Plain Layout
1982 \begin_inset Flex Code
1985 \begin_layout Plain Layout
1994 \begin_inset Newline newline
1997 Warnings about troubles breaking the page.
1998 Once again, just look at the output.
1999 Your eyes will tell you where something has gone wrong.
2002 \begin_layout Itemize
2003 \begin_inset Flex Code
2006 \begin_layout Plain Layout
2008 \begin_inset Quotes els
2012 \begin_inset Quotes ers
2021 \begin_inset Newline newline
2025 \begin_inset Quotes eld
2029 \begin_inset Quotes erd
2032 isn't installed on this system.
2033 This usually appears because some package your document needs isn't installed.
2034 If you didn't touch the preamble or didn't use the
2035 \begin_inset Flex Code
2038 \begin_layout Plain Layout
2046 command, then one of the packages \SpecialChar LyX
2047 tried to load is missing.
2049 \begin_inset Flex Noun
2052 \begin_layout Plain Layout
2053 Help\SpecialChar menuseparator
2060 to get a list of packages that \SpecialChar LyX
2062 This file is updated whenever you reconfigure \SpecialChar LyX
2064 \begin_inset Flex Noun
2067 \begin_layout Plain Layout
2068 Tools\SpecialChar menuseparator
2074 ) and tells you which packages have been detected and what they do.
2075 \begin_inset Newline newline
2079 \begin_inset Flex Code
2082 \begin_layout Plain Layout
2090 command and the package in question isn't installed, then you'll need to
2091 install it yourself.
2094 \begin_layout Itemize
2095 \begin_inset Flex Code
2098 \begin_layout Plain Layout
2099 LaTeX Error: Unknown option
2105 \begin_inset Newline newline
2108 Error messages beginning with this are trying to tell you that you specified
2109 a bad or undefined option to a package.
2110 Check the package's documentation.
2113 \begin_layout Itemize
2114 \begin_inset Flex Code
2117 \begin_layout Plain Layout
2118 Undefined control sequence
2124 \begin_inset Newline newline
2127 If you've inserted \SpecialChar LaTeX
2128 code into your document, but made a typo, you'll get
2130 You may have forgotten to load a package.
2131 In any case, this error message usually means that you used an undefined
2136 \begin_layout Standard
2137 There are other error and warning messages.
2138 Some are self-explanatory.
2139 These are usually \SpecialChar LaTeX
2141 Others are downright cryptic.
2142 These are usually \SpecialChar TeX
2143 error messages, and we really have
2147 what they mean or how to decipher them.
2151 \begin_layout Standard
2152 There's a general sequence you should follow if you get error messages:
2155 \begin_layout Enumerate
2156 Look at the \SpecialChar LaTeX
2157 code you inserted for typos.
2160 \begin_layout Enumerate
2161 If there are no typos, check that you used the command(s) correctly.
2164 \begin_layout Enumerate
2165 If you get a bunch of error boxes piled up at the very top of the document—and
2166 especially if you see a
2167 \begin_inset Quotes eld
2171 \begin_inset Flex Code
2174 \begin_layout Plain Layout
2183 \begin_inset Quotes erd
2186 error—it means that there are errors in the preamble.
2187 Start debugging your preamble.
2190 \begin_layout Enumerate
2191 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2193 document, the first suspect is your \SpecialChar LaTeX
2194 distribution itself.
2195 Check for missing packages and install them.
2198 \begin_layout Enumerate
2199 Okay, so there are no missing packages.
2200 Did you use any of the fine-tuning options in \SpecialChar LyX
2201 ? Specifically, did you
2205 any of them, like trying to manually insert lots of
2206 \begin_inset Flex Code
2209 \begin_layout Plain Layout
2211 \begin_inset space ~
2220 \begin_inset Flex Code
2223 \begin_layout Plain Layout
2230 \begin_inset Flex Code
2233 \begin_layout Plain Layout
2239 ? Did you try to kludge something together with these instead of using the
2240 appropriate paragraph environment?
2243 \begin_layout Enumerate
2244 All right, you didn't use any of the fine-tuning options, you played by
2246 Did you try to pull a fancy maneuver? Did you do something funky inside
2247 a table or an equation, like inserting a graphic into a table cell?
2250 \begin_layout Enumerate
2251 Do you have long sections of text where \SpecialChar LaTeX
2252 cannot find a place to break a
2253 line? By default, \SpecialChar LaTeX
2254 is rather strict about how much extra inter-word spacing
2255 it will add in order to break a line.
2256 Preferably, you should rework the paragraph to avoid the problem.
2259 \begin_layout Enumerate
2260 Did you go overboard with the nesting? \SpecialChar LyX
2261 (currently) doesn't check to make
2262 sure you're in the limits for nesting environments.
2263 If you nested a bunch of environments to the
2264 \begin_inset Formula $17^{\mathrm{th}}$
2267 level, that's the problem.
2268 (The limit in \SpecialChar LaTeX
2272 \begin_layout Enumerate
2273 Okay, you didn't get any error messages, but your output looks awful.
2274 If you have a table or figure that's too wide or long for the page, you
2279 \begin_layout Enumerate
2280 rescale the figure so it fits.
2283 \begin_layout Enumerate
2284 trim down the table so it fits.
2288 \begin_layout Enumerate
2289 If something else is wrong with the output, and you didn't try to pull anything
2290 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2293 \begin_layout Standard
2294 If all this doesn't help—well, then
2298 you might have found a bug in \SpecialChar LyX
2303 \begin_layout Chapter
2307 \begin_layout Section
2308 Customizing Bibliographies with Bib\SpecialChar TeX
2312 \begin_layout Standard
2313 The most basic information about how to use Bib\SpecialChar TeX
2318 with \SpecialChar LyX
2319 is contained in the section
2321 Bibliography databases
2328 The following subsections explain special bibliography features supported
2333 \begin_layout Subsection
2334 Alternative Citation Styles
2337 \begin_layout Standard
2338 Standard Bib\SpecialChar TeX
2340 \begin_inset space \thinspace{}
2344 \begin_inset space \space{}
2348 \begin_inset Quotes eld
2352 \begin_inset Quotes erd
2355 ) to refer to a cited work.
2356 However, in many scientific disciplines, other citation styles are in use.
2357 The most common one is the author-year style (e.
2358 \begin_inset space \thinspace{}
2362 \begin_inset space \space{}
2366 \begin_inset Quotes eld
2370 \begin_inset Quotes erd
2375 supports three packages that provide this style,
2376 \begin_inset Flex Code
2379 \begin_layout Plain Layout
2386 \begin_inset Flex Code
2389 \begin_layout Plain Layout
2396 \begin_inset Flex Code
2399 \begin_layout Plain Layout
2406 Each of these packages has their pros and cons, which cannot be listed
2408 If you only want to have simple author-year (or author-numerical) style,
2409 or if you want to use one of the countless style files for
2410 \begin_inset Flex Code
2413 \begin_layout Plain Layout
2419 , then the established
2420 \begin_inset Flex Code
2423 \begin_layout Plain Layout
2429 package is probably your choice.
2430 If you look for specific citation styles common in law studies, you might
2432 \begin_inset Flex Code
2435 \begin_layout Plain Layout
2442 If you want to have full control over the formatting or look for advanced
2443 features such as ibidem, footnote citations, full title citations, advanced
2444 date formats (such as 400 BC) or full localization to other languages than
2445 English, you should definitely consider
2446 \begin_inset Flex Code
2449 \begin_layout Plain Layout
2455 , which exceeds all other packages in terms of features, but is also quite
2456 heavy and more resource-hungry.
2459 \begin_layout Standard
2460 The handling of these packages in \SpecialChar LyX
2461 is basically the same.
2463 \begin_inset Flex Noun
2466 \begin_layout Plain Layout
2467 Document\SpecialChar menuseparator
2474 \begin_inset Flex Noun
2477 \begin_layout Plain Layout
2484 \begin_inset Flex Noun
2487 \begin_layout Plain Layout
2494 \begin_inset Flex Noun
2497 \begin_layout Plain Layout
2504 \begin_inset Flex Noun
2507 \begin_layout Plain Layout
2514 \begin_inset Flex Noun
2517 \begin_layout Plain Layout
2518 Biblatex (Natbib mode)
2524 \begin_inset Flex Noun
2527 \begin_layout Plain Layout
2534 \begin_inset Flex Noun
2537 \begin_layout Plain Layout
2544 \begin_inset space ~
2547 6.5.3 in the User's Guide for more information on these choices).
2548 With all these packages, you will get some extra features in the citation
2549 dialog and you can select the style of the reference (
2550 \begin_inset Quotes eld
2554 \begin_inset Quotes erd
2558 \begin_inset Quotes eld
2562 \begin_inset Quotes erd
2566 \begin_inset Quotes eld
2570 \begin_inset Quotes erd
2574 \begin_inset Quotes eld
2578 \begin_inset Quotes erd
2582 Note that either package needs specifically designed style files.
2583 They all ship their own, but there are lots of additional style files,
2584 and there is even an interactive style file builder
2588 \begin_layout Plain Layout
2590 \begin_inset Flex URL
2593 \begin_layout Plain Layout
2595 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2606 \begin_inset Flex Code
2609 \begin_layout Plain Layout
2618 \begin_layout Subsection
2619 Subdivided Bibliographies
2622 \begin_layout Standard
2623 Sometimes you might need to divide your bibliography into several sections.
2624 If you are for instance a historian, the possibility to separate sources
2625 and scientific works is most likely a
2626 \begin_inset Quotes eld
2630 \begin_inset Quotes erd
2634 Unfortunately, Bib\SpecialChar TeX
2635 itself does not allow you to do this.
2636 But with the help of some \SpecialChar LaTeX
2637 packages, Bib\SpecialChar TeX
2638 can be extended to fit your needs.
2641 \begin_layout Standard
2643 provides native support for one of these packages,
2651 \begin_layout Plain Layout
2653 \begin_inset Flex URL
2656 \begin_layout Plain Layout
2658 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2668 The advantage of this package (compared to other packages such as
2672 ) is that you don't need to define new citation commands.
2673 Instead, you need to prepare different bibliographic databases which include
2674 the entries for the different sections of the bibliography.
2675 For example: If you want to divide your bibliography into the sections
2677 \begin_inset Quotes eld
2681 \begin_inset Quotes erd
2685 \begin_inset Quotes eld
2689 \begin_inset Quotes erd
2692 , you first need to create two bibliographic databases, e.
2693 \begin_inset space \thinspace{}
2697 \begin_inset space \space{}
2701 \begin_inset Flex Code
2704 \begin_layout Plain Layout
2711 \begin_inset Flex Code
2714 \begin_layout Plain Layout
2724 \begin_layout Standard
2726 \begin_inset Flex Noun
2729 \begin_layout Plain Layout
2730 Document\SpecialChar menuseparator
2737 \begin_inset Flex Noun
2740 \begin_layout Plain Layout
2747 \begin_inset Flex Noun
2750 \begin_layout Plain Layout
2751 Subdivided bibliography
2757 Now you can insert multiple Bib\SpecialChar TeX
2758 bibliographies, one for each section of
2760 Returning to our example: Insert the Bib\SpecialChar TeX
2762 \begin_inset Flex Code
2765 \begin_layout Plain Layout
2771 and a second one for the database
2772 \begin_inset Flex Code
2775 \begin_layout Plain Layout
2782 You are free to use the same or different styles for each section.
2783 Additionally, you can choose if the bibliography section should contain
2785 \begin_inset Quotes eld
2788 all cited references
2789 \begin_inset Quotes erd
2792 of the specified database(s) (which is the default),
2793 \begin_inset Quotes eld
2796 all uncited references
2797 \begin_inset Quotes erd
2801 \begin_inset Quotes eld
2805 \begin_inset Quotes erd
2809 This might be useful if you would like to separate your bibliography into
2811 \begin_inset Quotes eld
2815 \begin_inset Quotes erd
2819 \begin_inset Quotes eld
2823 \begin_inset Quotes erd
2827 \begin_inset Quotes eld
2831 \begin_inset Quotes erd
2835 The titles for the sections can be added as ordinary sections or subsections.
2837 \begin_inset Flex Code
2840 \begin_layout Plain Layout
2846 removes the bibliography title, you have to manually re-add that, too (as
2847 a chapter* or section*, for instance).
2850 \begin_layout Standard
2855 , the procedure is a bit different.
2864 , the aforementioned
2865 \begin_inset Flex Noun
2868 \begin_layout Plain Layout
2869 Subdivided bibliography
2874 option is disabled if you use
2883 provides its own means to generate subdivided bibliographies.
2884 You can either add keywords to bibliography entries via the
2885 \begin_inset Flex Code
2888 \begin_layout Plain Layout
2894 entry option and then filter bibliography sections by keyword (by adding
2896 \begin_inset Flex Code
2899 \begin_layout Plain Layout
2906 \begin_inset Flex Noun
2909 \begin_layout Plain Layout
2915 field of the dialog that opens if you left-click on the
2916 \begin_inset Flex Noun
2919 \begin_layout Plain Layout
2920 Biblatex Generated Bibliography
2925 button), or you can filter by entry types (such as
2934 \begin_inset space \thinspace{}
2939 \begin_inset Flex Code
2942 \begin_layout Plain Layout
2949 \begin_inset Flex Code
2952 \begin_layout Plain Layout
2959 \begin_inset Flex Noun
2962 \begin_layout Plain Layout
2968 field, or you can create so-called
2969 \begin_inset Quotes eld
2972 Bibliography Categories
2973 \begin_inset Quotes erd
2976 to which you can assign individual entries.
2977 Please refer to the Biblatex manual, section
2979 Subdivided Bibliographies
2984 \begin_layout Subsection
2985 Multiple Bibliographies
2986 \begin_inset CommandInset label
2988 name "subsec:Multiple-Bibliographies"
2995 \begin_layout Standard
2996 Multiple bibliographies, e.
2997 \begin_inset space \thinspace{}
3001 \begin_inset space \space{}
3004 a bibliography for each part, chapter, section, subsection or child (sub-documen
3005 t) of the document, are also supported by \SpecialChar LyX
3007 In order to enable it, go to
3008 \begin_inset Flex Noun
3011 \begin_layout Plain Layout
3012 Document\SpecialChar menuseparator
3013 Settings\SpecialChar menuseparator
3019 and select the relevant unit (e.
3020 \begin_inset space \thinspace{}
3024 \begin_inset Quotes eld
3028 \begin_inset Quotes erd
3032 \begin_inset Flex Noun
3035 \begin_layout Plain Layout
3036 Multiple Bibliographies
3042 Then add a Bib(la)\SpecialChar TeX
3043 bibliography to each unit (e.
3044 \begin_inset space \thinspace{}
3047 g., section) of your document.
3048 In the output, a separate bibliography, containing only the references
3049 done in the current unit is generated.
3052 \begin_layout Standard
3053 If you use Bib\SpecialChar TeX
3055 \begin_inset Flex Code
3058 \begin_layout Plain Layout
3065 \begin_inset Flex Code
3068 \begin_layout Plain Layout
3074 package is used to create multiple bibliographies.
3075 The former package is used if you select
3076 \begin_inset Quotes eld
3080 \begin_inset Quotes erd
3088 \begin_inset Flex Noun
3091 \begin_layout Plain Layout
3092 Sectioned Bibliography
3099 \begin_inset Flex Code
3102 \begin_layout Plain Layout
3112 \begin_layout Plain Layout
3113 An alternative approach, if you are willing to use some
3114 \begin_inset Flex Noun
3117 \begin_layout Plain Layout
3125 \begin_inset space ~
3129 \begin_inset CommandInset ref
3131 reference "sec:Inserting-TeX-Code"
3136 \begin_inset Flex Code
3139 \begin_layout Plain Layout
3151 \begin_inset Flex Code
3154 \begin_layout Plain Layout
3160 is used, \SpecialChar LyX
3161 encloses the specified units in
3162 \begin_inset Flex Code
3165 \begin_layout Plain Layout
3172 \begin_inset Flex Code
3175 \begin_layout Plain Layout
3184 \begin_inset Flex Code
3187 \begin_layout Plain Layout
3195 in order to create the units.
3196 Note that this approach has some limitations.
3197 First, every citation reference has to be inside some
3198 \begin_inset Flex Code
3201 \begin_layout Plain Layout
3208 So citations outside a defined unit (e.
3209 \begin_inset space \thinspace{}
3212 g., before the first section if you use
3213 \begin_inset Quotes eld
3217 \begin_inset Quotes erd
3221 \begin_inset Quotes eld
3225 \begin_inset Quotes erd
3229 You can also create your own units by entering
3230 \begin_inset Flex Code
3233 \begin_layout Plain Layout
3242 \begin_inset Flex Code
3245 \begin_layout Plain Layout
3254 code (for instance to work around the mentioned limitation).
3256 \begin_inset Flex Code
3259 \begin_layout Plain Layout
3266 A second limitation is that
3267 \begin_inset Flex Code
3270 \begin_layout Plain Layout
3276 always processes all references of a bibliography database, even if they
3278 This can result in odd labels (e.
3279 \begin_inset space \thinspace{}
3284 \begin_inset Quotes eld
3288 \begin_inset Quotes erd
3291 if two works of this author from 2014 are in the database, even if only
3295 \begin_layout Standard
3301 \begin_inset Flex Code
3304 \begin_layout Plain Layout
3310 option is used instead.
3311 If you need specific units, you can start them with the \SpecialChar TeX
3313 \begin_inset Flex Code
3316 \begin_layout Plain Layout
3325 \begin_inset Flex Code
3328 \begin_layout Plain Layout
3337 If you also want to control the end of the unit, use the environment
3338 \begin_inset Flex Code
3341 \begin_layout Plain Layout
3351 \begin_inset Flex Code
3354 \begin_layout Plain Layout
3364 \begin_inset Flex Code
3367 \begin_layout Plain Layout
3374 In addition to the individual bibliography of the current unit,
3378 also provides an easy way to output all bibliographies, subsequently, at
3380 \begin_inset space \thinspace{}
3383 g., at the end of the document).
3385 \begin_inset Quotes eld
3389 \begin_inset Quotes erd
3392 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
3398 manual for more information on this topic.
3401 \begin_layout Section
3405 \begin_layout Subsection
3409 \begin_layout Standard
3410 When you are working on a large file with many sections, it is often convenient
3411 to break up the document into several files, or perhaps you have something
3412 where a table may change from time to time, but the preceding text does
3414 In these cases, you should seriously consider using multipart documents.
3415 For example, scientific papers often have five major sections: the introduction
3416 , observations, results, discussion, and conclusion.
3417 Each of these could be its own separate \SpecialChar LyX
3419 \begin_inset Quotes eld
3423 \begin_inset Quotes erd
3426 file which contains the title, authors, abstract, references, etc., plus
3427 the five included files.
3428 It is important to note that each of these files is a full \SpecialChar LyX
3430 can be formatted and printed on its own, as well as included in a master
3432 Each of these files must have the same document class, however—don't attempt
3433 to mix book classes with article classes.
3434 You may also include \SpecialChar LaTeX
3435 files; however, these files must not have their own
3437 \begin_inset space \thinspace{}
3441 \begin_inset space \space{}
3444 everything up to and including the
3445 \begin_inset Flex Code
3448 \begin_layout Plain Layout
3457 \begin_inset Flex Code
3460 \begin_layout Plain Layout
3468 line must be deleted) or else errors will be generated when you try to
3472 \begin_layout Standard
3474 allows you to include files quite easily with
3475 \begin_inset Flex Noun
3478 \begin_layout Plain Layout
3479 Insert\SpecialChar menuseparator
3481 \begin_inset space ~
3490 When you click on this selection a small box is inserted into the file
3491 at the current cursor location.
3492 Clicking on the box raises a dialog which allows you to select the file
3493 to be included, and the method of its inclusion.
3497 \begin_layout Standard
3498 The file selection box should by now be obvious.
3499 The three inclusion methods are
3500 \begin_inset Quotes eld
3504 \begin_inset Quotes erd
3508 \begin_inset Quotes eld
3512 \begin_inset Quotes erd
3516 \begin_inset Quotes eld
3520 \begin_inset Quotes erd
3525 \begin_inset Quotes eld
3529 \begin_inset Quotes erd
3533 \begin_inset Quotes eld
3537 \begin_inset Quotes erd
3540 are similar in many ways, but there are also some notable differences:
3543 \begin_layout Enumerate
3545 \begin_inset Quotes eld
3549 \begin_inset Quotes erd
3552 are typeset beginning on a new page, while files that are
3553 \begin_inset Quotes eld
3557 \begin_inset Quotes erd
3560 are typeset starting on the current page.
3563 \begin_layout Enumerate
3564 \begin_inset Quotes eld
3568 \begin_inset Quotes erd
3571 files cannot themselves
3572 \begin_inset Quotes eld
3576 \begin_inset Quotes erd
3580 \begin_inset Quotes eld
3584 \begin_inset Quotes erd
3589 \begin_inset Quotes eld
3593 \begin_inset Quotes erd
3596 , on the other hand, infinite sub-inputting is possible.
3599 \begin_layout Enumerate
3600 \begin_inset Quotes eld
3604 \begin_inset Quotes erd
3607 allow for the output of only selected
3608 \begin_inset Quotes eld
3612 \begin_inset Quotes erd
3615 files, while maintaining the actual counters (pagination etc.) and references
3616 (please refer to the section
3619 \begin_inset space ~
3627 \begin_inset space ~
3632 manual for details).
3635 \begin_layout Standard
3637 \begin_inset Quotes eld
3641 \begin_inset Quotes erd
3644 is the preferred method for chapters that are outsourced to child documents,
3646 \begin_inset Quotes eld
3650 \begin_inset Quotes erd
3653 is more suitable for arbitrary file inheritance.
3656 \begin_layout Standard
3658 \begin_inset Quotes eld
3662 \begin_inset Quotes erd
3665 included file allows you to include a file typeset exactly as it appears
3667 \begin_inset space \thinspace{}
3671 \begin_inset space \space{}
3675 \begin_inset Flex Code
3678 \begin_layout Plain Layout
3684 mode, with the characters set in a fixed-width typewriter font.
3685 Normally, spaces in this file are invisible, though two consecutive spaces
3686 are conserved, unlike \SpecialChar LyX
3687 's normal treatment of spaces.
3688 However, setting the
3689 \begin_inset Flex Noun
3692 \begin_layout Plain Layout
3694 \begin_inset space ~
3698 \begin_inset space ~
3702 \begin_inset space ~
3710 checkbox typesets a mark to unambiguously define the presence of a space.
3714 \begin_layout Standard
3715 Generally, the master file is converted into a full \SpecialChar LaTeX
3716 file before typesetting,
3717 while the included files are converted to \SpecialChar LaTeX
3718 files that do not have all the
3719 preamble information.
3722 \begin_layout Subsection
3723 Cross-References Between Files
3726 \begin_layout Standard
3727 \begin_inset Box Shadowbox
3737 height_special "totalheight"
3742 backgroundcolor "none"
3745 \begin_layout Plain Layout
3746 This section is somewhat out of date.
3747 Need to describe default master documents and how children are opened when
3757 \begin_layout Standard
3758 It is possible to set up cross-references between the different files.
3759 First, open all the files in question: let's call them A and B in a two
3760 file example, where B is included in A.
3761 Let's say you insert a label in A, then want to reference it in B.
3762 Open the cross-reference dialog whilst in document B, and you can select
3764 \begin_inset Quotes eld
3768 \begin_inset Quotes erd
3774 \begin_layout Subsection
3775 Bibliography Lists in all Subdocuments
3778 \begin_layout Standard
3779 If you work with child documents, you might want to have only one main bibliogra
3780 phy at the end, but still be able to have a selected bibliography for the
3781 child if you output it on its own.
3782 Here is how to achieve this.
3785 \begin_layout Standard
3786 For the main document, you just insert a bibliography inset at the place
3787 where the main bibliography has to appear (within the master file or within
3789 If the bibliography inset is in the master file, the references will be
3790 inherited by all children, so they are available in the citation dialog
3794 \begin_layout Standard
3795 For child-specific bibliographies, insert bibliography insets within the
3796 child documents, at the place where the bibliography should appear when
3797 the child is compiled separately.
3798 However, the trick is to insert them into a branch (
3800 Insert\SpecialChar menuseparator
3801 Branch\SpecialChar menuseparator
3802 Insert New Branch...
3805 \begin_inset space \thinspace{}
3810 \begin_inset Quotes eld
3814 \begin_inset Quotes erd
3818 Within the children, activate the branch (
3820 Document\SpecialChar menuseparator
3821 Settings...\SpecialChar menuseparator
3825 Within the master, deactivate the branch (
3827 Document\SpecialChar menuseparator
3828 Settings...\SpecialChar menuseparator
3832 Now the child's bibliography will be ignored by the master, but considered
3836 \begin_layout Standard
3837 If you need multiple bibliographies (e.
3838 \begin_inset space \thinspace{}
3841 g., one per child in the
3845 ), please refer to sec.
3846 \begin_inset space ~
3850 \begin_inset CommandInset ref
3852 reference "subsec:Multiple-Bibliographies"
3859 \begin_layout Section
3864 \begin_layout Standard
3865 Users sometimes need to be able to
3866 \begin_inset Quotes eld
3870 \begin_inset Quotes erd
3874 file together with all the images (and other files) on which it depends,
3875 either for sending to a publisher or for sharing with a co-author.
3877 includes a Python script (
3878 \begin_inset Flex Code
3881 \begin_layout Plain Layout
3887 ) that automates this process.
3888 To use it, you must have either the
3889 \begin_inset Flex Code
3892 \begin_layout Plain Layout
3899 \begin_inset Flex Code
3902 \begin_layout Plain Layout
3908 python modules installed on your system.
3909 By default, the script prefers the
3910 \begin_inset Flex Code
3913 \begin_layout Plain Layout
3920 \begin_inset Flex Code
3923 \begin_layout Plain Layout
3929 format on Unix-like systems and the
3930 \begin_inset Flex Code
3933 \begin_layout Plain Layout
3942 \begin_layout Standard
3944 's configuration process will set the script up to export a `\SpecialChar LyX
3946 and this format will then be available under
3947 \begin_inset Flex Code
3950 \begin_layout Plain Layout
3951 File\SpecialChar menuseparator
3960 \begin_layout Standard
3961 Independently of the platform, the generation of a particular archive format
3962 can be forced by adding either the
3963 \begin_inset Flex Code
3966 \begin_layout Plain Layout
3973 \begin_inset Flex Code
3976 \begin_layout Plain Layout
3983 \begin_inset Flex Code
3986 \begin_layout Plain Layout
3993 \begin_inset Flex Code
3996 \begin_layout Plain Layout
4002 format) switch to the
4003 \begin_inset Flex Code
4006 \begin_layout Plain Layout
4008 \SpecialChar menuseparator
4016 \begin_inset Flex Code
4019 \begin_layout Plain Layout
4020 Tools\SpecialChar menuseparator
4021 Preferences\SpecialChar menuseparator
4022 File Handling\SpecialChar menuseparator
4029 (Make sure you add the switch after the script name, not before it.)
4032 \begin_layout Section
4033 Fancy Headers and Footers
4036 \begin_layout Standard
4037 The default page layout is rather plain; for an
4038 \begin_inset Flex Code
4041 \begin_layout Plain Layout
4047 document class, all you get is a centered page number at the bottom of
4049 This document uses KOMA-script's book class, so it appears to be a bit
4051 But to really put on a show, you need to set the document page style to
4053 \begin_inset Quotes eld
4057 \begin_inset Quotes erd
4060 , as mentioned in the
4065 This section describes the \SpecialChar LaTeX
4066 code you need to insert in your \SpecialChar LaTeX
4068 order to get the desired effects.
4071 \begin_layout Standard
4072 For more information on fancy headers, see the
4073 \begin_inset Flex Code
4076 \begin_layout Plain Layout
4082 package documentation.
4084 \begin_inset Flex URL
4087 \begin_layout Plain Layout
4089 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
4097 \begin_layout Standard
4098 The page header is divided into three fields, not surprisingly labeled
4099 \begin_inset Quotes eld
4103 \begin_inset Quotes erd
4107 \begin_inset Quotes eld
4111 \begin_inset Quotes erd
4115 \begin_inset Quotes eld
4119 \begin_inset Quotes erd
4123 The footer is also divided into these three fields.
4124 The \SpecialChar LaTeX
4125 commands to set these fields in the simplest manner are
4126 \begin_inset Flex Code
4129 \begin_layout Plain Layout
4138 \begin_inset Flex Code
4141 \begin_layout Plain Layout
4150 \begin_inset Flex Code
4153 \begin_layout Plain Layout
4162 \begin_inset Flex Code
4165 \begin_layout Plain Layout
4174 Suppose you wish to put your name in the upper left hand corner of each
4176 Simply insert the following command in the preamble:
4179 \begin_layout Standard
4188 \begin_layout Standard
4189 You will now see your name in the upper left.
4190 If a field has a default entry that you would like to get rid of (often
4191 the page number appears in the central footer) simply include a command
4192 with a blank argument, e.
4193 \begin_inset space \thinspace{}
4199 \begin_layout Standard
4207 \begin_layout Standard
4208 Let's get really fancy: lets put the section number with the word
4209 \begin_inset Quotes eld
4213 \begin_inset Quotes erd
4217 \begin_inset space \thinspace{}
4221 \begin_inset space \space{}
4224 Section 3) in the upper left, the page number (e.
4225 \begin_inset space \thinspace{}
4229 \begin_inset space \space{}
4232 Page 4) in the upper right, your name in the lower left, and the date in
4234 The following commands should now appear in the preamble:
4237 \begin_layout Standard
4247 \begin_layout Standard
4255 \begin_layout Standard
4265 \begin_layout Standard
4274 \begin_layout Standard
4282 \begin_layout Standard
4292 \begin_layout Standard
4294 \begin_inset Flex Code
4297 \begin_layout Plain Layout
4306 \begin_inset Flex Code
4309 \begin_layout Plain Layout
4317 access \SpecialChar LaTeX
4318 's section and page counters, and so print out the current section
4321 \begin_inset Flex Code
4324 \begin_layout Plain Layout
4332 simply prints out today's date.
4335 \begin_layout Standard
4336 The thicknesses of the horizontal rules drawn beneath the header and above
4337 the footer can also be modified.
4338 If you don't want one of the rules, set its thickness to 0.
4339 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
4345 \begin_inset Flex Code
4348 \begin_layout Plain Layout
4353 headrulewidth}{0.4pt}
4359 \begin_inset Flex Code
4362 \begin_layout Plain Layout
4367 footrulewidth}{0.4pt}
4372 to set the thicknesses.
4375 \begin_layout Standard
4376 You can switch the header/footer settings on and off for individual pages
4378 \begin_inset Flex Code
4381 \begin_layout Plain Layout
4384 thispagestyle{empty}
4390 \begin_inset Flex Code
4393 \begin_layout Plain Layout
4396 thispagestyle{plain}
4402 \begin_inset Flex Code
4405 \begin_layout Plain Layout
4408 thispagestyle{fancy}
4414 Simply insert them in the text on the page you want changed and mark them
4417 In fact, title pages are marked as plain by default, while following pages
4418 are marked fancy when using the global fancy setting.
4421 \begin_layout Standard
4422 As a final example, it is possible to include an image in the header or
4424 Suppose you want to put a company logo in the upper lefthand corner.
4425 You might try something like
4428 \begin_layout Standard
4437 includegraphics{logo.eps}}}
4440 \begin_layout Standard
4442 (you may need to preface this with
4443 \begin_inset Flex Code
4446 \begin_layout Plain Layout
4449 usepackage{graphics}
4454 if you don't include graphics elsewhere in your document).
4457 \begin_layout Section
4458 Itemize Bullet Selection
4459 \begin_inset CommandInset label
4468 \begin_layout Standard
4474 \begin_layout Subsection
4478 \begin_layout Standard
4480 provides 216 bullet shapes that can be accessed from a simple dialog.
4481 Using this dialog you can easily specify what bullet shape to use at each
4482 level of an itemized list.
4483 These settings are document-wide so you won't be able to specify different
4484 sets of bullets for different paragraphs.
4488 \begin_layout Plain Layout
4489 Well, actually you can but you'll have to do it by hand.
4497 \begin_layout Subsection
4501 \begin_layout Standard
4502 Open the dialog by selecting the
4503 \begin_inset Flex Noun
4506 \begin_layout Plain Layout
4507 Document\SpecialChar menuseparator
4513 menu item and then select the
4514 \begin_inset Flex Noun
4517 \begin_layout Plain Layout
4526 \begin_layout Standard
4527 The dialog provides you with a table of bullet shapes.
4528 A column of buttons on the left of the table provides access to the six
4529 different panels of bullet shapes.
4530 The row of buttons across the top is used to select which bullet depth
4533 \change_deleted 244031559 1603875981
4534 A text entry under the table shows the currently selected bullet shape's
4536 equivalent and this can be edited if desired.
4537 If you do modify the text you will also need to specify any needed packages
4538 in the \SpecialChar LaTeX
4544 \begin_layout Standard
4545 The six panels are divided up by the packages they require.
4546 The following table shows the mappings from button name to \SpecialChar LaTeX
4550 \begin_layout Standard
4552 \begin_inset Tabular
4553 <lyxtabular version="3" rows="7" columns="2">
4554 <features tabularvalignment="middle">
4555 <column alignment="center" valignment="top" width="0pt">
4556 <column alignment="center" valignment="top" width="0pt">
4558 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4561 \begin_layout Plain Layout
4576 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4579 \begin_layout Plain Layout
4596 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4599 \begin_layout Plain Layout
4614 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4617 \begin_layout Plain Layout
4626 base \SpecialChar LaTeX
4634 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4637 \begin_layout Plain Layout
4652 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4655 \begin_layout Plain Layout
4672 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4675 \begin_layout Plain Layout
4690 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4693 \begin_layout Plain Layout
4710 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4713 \begin_layout Plain Layout
4728 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4731 \begin_layout Plain Layout
4748 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4751 \begin_layout Plain Layout
4766 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4769 \begin_layout Plain Layout
4786 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4789 \begin_layout Plain Layout
4804 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4807 \begin_layout Plain Layout
4830 \begin_layout Standard
4832 doesn't stop you using bullets from packages you don't have.
4833 If you get errors from \SpecialChar LaTeX
4834 when you try to view or print the file, then it
4835 is likely you are missing a package.
4839 \begin_layout Plain Layout
4841 doesn't restrict your use since you may be editing locally and exporting
4850 \begin_layout Subsection
4854 \begin_layout Standard
4855 Select which bullet depth you want to change then select the bullet shape
4857 Any changes will not be visible in \SpecialChar LyX
4858 , but are visible when viewing the document.
4861 \begin_layout Standard
4862 You can reset a bullet shape to the default simply by clicking your right
4863 mouse button on the appropriate bullet depth button.
4867 \begin_layout Plain Layout
4872 want to have multiple sets of paragraphs with different sets of bullets
4873 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4875 The bullet selection dialog can help though because it provides you with
4876 the \SpecialChar LaTeX
4877 code for a wide range of bullet shapes.
4878 To make your own custom paragraphs you have the following options:
4881 \begin_layout Plain Layout
4885 \begin_layout Plain Layout
4901 \begin_layout Plain Layout
4905 \begin_layout Plain Layout
4927 \begin_layout Itemize
4928 Use the \SpecialChar LaTeX
4930 \begin_inset Flex Code
4933 \begin_layout Plain Layout
4941 to specify a new bullet shape for a given depth.
4942 You'll also need to save the current bullet shape so you can restore it
4944 In this itemized list the following \SpecialChar LaTeX
4945 code was used to change the bullet
4946 used for the first depth.
4950 \begin_layout LyX-Code
4960 \begin_layout LyX-Code
4977 \begin_layout Itemize
4978 Note that the itemize depth is specified in Roman numerals as part of the
4988 \begin_layout Itemize
4989 \begin_inset Argument item:1
4992 \begin_layout Plain Layout
4996 \begin_layout Plain Layout
5014 Specify each individual entry by starting each item with the bullet shape
5016 \begin_inset Quotes eld
5020 \begin_inset Quotes erd
5025 Insert\SpecialChar menuseparator
5029 \begin_inset Flex Noun
5032 \begin_layout Plain Layout
5040 For example, this item was started with
5041 \begin_inset Flex Code
5044 \begin_layout Plain Layout
5059 \begin_layout Plain Layout
5063 \begin_layout Plain Layout
5079 \begin_layout Plain Layout
5080 You'll also need to revert the labelitem back to its previous setting for
5081 the global bullet shape settings to remain in effect.
5082 The way used here was:
5085 \begin_layout LyX-Code
5100 \begin_layout Chapter
5102 and the World Wide Web
5105 \begin_layout Standard
5107 has long supported the export of documents to various web-friendly formats,
5109 Before version 2.0, however, HTML export was always accomplished by the
5110 use of external converters.
5114 \begin_layout Plain Layout
5115 For details on the use of external converters with \SpecialChar LyX
5120 section of the Customization manual.
5125 These fall into two large groups: there are converters that use \SpecialChar LaTeX
5127 intermediate format, such as
5128 \begin_inset Flex Code
5131 \begin_layout Plain Layout
5138 \begin_inset Flex Code
5141 \begin_layout Plain Layout
5148 \begin_inset Flex Code
5151 \begin_layout Plain Layout
5157 , relying upon \SpecialChar LyX
5158 to produce the \SpecialChar LaTeX
5159 ; and there is a converter that works directly
5162 \begin_inset Flex Code
5165 \begin_layout Plain Layout
5173 All of these have different advantages and disadvantages.
5177 \begin_layout Standard
5178 The \SpecialChar LaTeX
5179 -based converters have the advantage that, in principle, they know everythin
5180 g about the exported document that \SpecialChar LaTeX
5182 Such converters do not care, for example, if a certain block of code was
5183 produced by \SpecialChar LyX
5184 or was Evil Red Text.
5185 These converters know about
5186 \begin_inset Flex Code
5189 \begin_layout Plain Layout
5195 files, counters, and references, and can often make use of the
5196 \begin_inset Flex Code
5199 \begin_layout Plain Layout
5205 files generated by Bib\SpecialChar TeX
5207 On the other hand, \SpecialChar LaTeX
5208 is a very hard language to parse—it is sometimes said
5209 that only \SpecialChar TeX
5210 itself understands \SpecialChar TeX
5211 —and \SpecialChar LaTeX
5212 -based converters will often choke on
5213 what seem to be quite simple constructs; complex ones can throw them completely
5214 , and as of this writing, for example, the
5218 manual will not export with
5219 \begin_inset Flex Code
5222 \begin_layout Plain Layout
5228 , though the others will.
5229 The other issue concerns how math is handled.
5230 These converters typically convert the formulae into little pictures that
5231 are then linked from the HTML document.
5232 Since these are actually generated by \SpecialChar LaTeX
5233 , they are accurate.
5234 But they do not scale well, and just getting them to look as if they are
5235 actually meant to be in your document—so that the font sizes seem to be
5236 roughly the same—can be a challenge.
5239 \begin_layout Standard
5241 \begin_inset Flex Code
5244 \begin_layout Plain Layout
5252 \begin_inset CommandInset href
5254 name "http://pinchito.es/elyxer/"
5255 target "http://pinchito.es/elyxer/"
5260 ) solves some of these problems.
5261 In particular, the formulae it produces scale perfectly, since it renders
5262 math using a combination of HTML and CSS rather than converting the formulae
5264 But even moderately complex formula are rendered less well than with
5265 \begin_inset Flex Code
5268 \begin_layout Plain Layout
5274 ; this reflects the limitations of HTML.
5278 \begin_layout Plain Layout
5280 \begin_inset Flex Code
5283 \begin_layout Plain Layout
5290 can also use jsMath and MathJax for equations, but this setting is only
5291 available globally and requires one to have access to a server that runs
5297 More importantly (as of version 1.1.1, at least),
5298 \begin_inset Flex Code
5301 \begin_layout Plain Layout
5308 has limited support for math macros and no support for user-defined paragraph
5309 or character styles.
5310 These limitations make
5311 \begin_inset Flex Code
5314 \begin_layout Plain Layout
5321 unsuitable for many of the documents \SpecialChar LyX
5323 In principle, of course, these problems could be solved, but the \SpecialChar LyX
5325 have decided to follow a different path and have made \SpecialChar LyX
5327 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
5328 , DocBook, and plaintext.
5331 \begin_layout Standard
5332 As of this writing, XHTML output remains under development and should probably
5334 \begin_inset Quotes eld
5338 \begin_inset Quotes erd
5345 \begin_layout Plain Layout
5347 \begin_inset Flex Code
5350 \begin_layout Plain Layout
5351 development/HTML/HTML.notes
5356 , which can be found in the \SpecialChar LyX
5358 \begin_inset CommandInset href
5360 name "accessed online"
5361 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
5366 , usually contains up-to-date information about the state of XHTML output.
5367 See also the list of XHTML bugs on
5368 \begin_inset CommandInset href
5370 name "the bug tracker"
5371 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"
5381 Still, the developers have chosen this approach because it has several
5382 potential advantages over the other two.
5385 \begin_layout Standard
5386 These advantages are primarily due to the fact that the XHTML output routines,
5387 since they are part of \SpecialChar LyX
5388 , know everything \SpecialChar LyX
5389 knows about the document being
5394 \begin_layout Plain Layout
5395 Another advantage is that, since these routines are internal to \SpecialChar LyX
5397 immune to changes in \SpecialChar LyX
5398 's file format, or to changes in the semantics of
5404 So they know about the table of contents (as displayed in the outline),
5405 about the counters associated with different paragraph styles, and about
5406 user-defined styles.
5407 The XHTML output routines know what \SpecialChar LyX
5408 knows about internationalization,
5409 too, so they will output
5410 \begin_inset Quotes eld
5414 \begin_inset Quotes erd
5418 \begin_inset Quotes eld
5426 \begin_inset Quotes erd
5429 , depending upon the language in effect at the time.
5433 \begin_layout Standard
5434 Quite generally, the output routines know what \SpecialChar LyX
5435 knows about document layout,
5436 that is, about how the document is to be rendered on screen.
5437 We use this information when we output the document as XHTML.
5438 In particular, \SpecialChar LyX
5443 generates CSS style information corresponding to the layout information
5444 it uses to render the document on screen: if section headings are supposed
5445 to be sans-serif and bold as seen in \SpecialChar LyX
5446 , then (by default) they will be sans-seri
5447 f and bold when viewed in a web browser, too.
5448 And this is true not just for pre-defined styles, like Section, but for
5449 any style, including user-defined styles.
5450 Indeed, the XHTML output routines make no distinction between user-defined
5452 \change_deleted 244031559 1603876931
5454 \change_inserted 244031559 1603876940
5457 styles and \SpecialChar LyX
5458 's own pre-defined styles: in each case, everything \SpecialChar LyX
5460 the styles is contained in the layout files.
5461 And much the same is true as regards pre-defined textual insets, such as
5462 footnotes, and various custom insets.
5466 \begin_layout Standard
5467 The result is that XHTML output can be customized and extended in exactly
5468 the same way \SpecialChar LaTeX
5469 output can be customized and extended: through layout files
5471 See chapter five of the
5475 manual for the details.
5478 \begin_layout Standard
5479 The remainder of this chapter contains more detailed information on XHTML
5480 output, its limitations, and ways to work around those limitations.
5483 \begin_layout Section
5484 Math Output in XHTML
5487 \begin_layout Standard
5489 offers four choices for how math is rendered.
5490 These have various advantages and disadvantages:
5493 \begin_layout Itemize
5495 \begin_inset Newline newline
5498 MathML is a dialect of XML designed specifically for mathematics on the
5499 web, and it typically renders very well in browsers that support it.
5500 The disadvantage is that not all browsers support MathML, and support is
5501 not complete even in the Gecko-based browsers, such as Firefox.
5502 \begin_inset Newline newline
5506 is unable to render a formula as MathML—for example, if the formula
5508 \begin_inset Flex Code
5511 \begin_layout Plain Layout
5517 package or ERT—then it will instead output the formula as an image.
5521 \begin_layout Itemize
5523 \begin_inset Newline newline
5527 \begin_inset Flex Code
5530 \begin_layout Plain Layout
5536 outputs math as HTML, styled by CSS.
5540 \begin_layout Plain Layout
5542 has borrowed some of the CSS for its HTML output from
5543 \begin_inset Flex Code
5546 \begin_layout Plain Layout
5557 For simple formulae, this can work quite well, though with more complicated
5558 formulae it tends to break down.
5559 Still, this method has the advantage that it is very widely supported and
5560 so it may be appropriate for documents that contain only a little, fairly
5562 \begin_inset Newline newline
5565 If Lyx is unable to render a formula as HTML—for example, if the formula
5567 \begin_inset Flex Code
5570 \begin_layout Plain Layout
5576 package or ERT—then it will instead output the formula as an image.
5580 \begin_layout Itemize
5582 \begin_inset Newline newline
5586 \begin_inset Flex Code
5589 \begin_layout Plain Layout
5596 will output formulae as images, the very same images, in fact, that are
5597 used for instant preview.
5601 \begin_layout Plain Layout
5602 Instant preview does
5606 have to be on for images to be output, however.
5611 The advantage to this method is that the images are simply generated by
5613 , so they are very accurate.
5614 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5615 so they do not scale terribly well, and one cannot copy them, etc.
5616 \begin_inset Newline newline
5619 The size of the images can be controlled by setting the
5620 \begin_inset Quotes eld
5624 \begin_inset Quotes erd
5628 \begin_inset Flex Noun
5631 \begin_layout Plain Layout
5632 Document\SpecialChar menuseparator
5633 Settings\SpecialChar menuseparator
5643 \begin_layout Plain Layout
5644 For those who want to know, this controls the resolution of the image in
5645 dots per inch and is based upon a default of 75 dpi.
5651 \begin_inset Newline newline
5655 for some reason fails to create an image for a formula (e.g., if a required
5657 package is not installed), then it will fall back to outputing the raw
5662 \begin_layout Itemize
5665 \begin_inset Newline newline
5668 Finally, \SpecialChar LyX
5669 will happily output math as \SpecialChar LaTeX
5671 As well as being the output of last resort, this method can be used with
5673 \begin_inset CommandInset href
5676 target "http://www.math.union.edu/~dpvc/jsMath/"
5681 , which uses JavaScript to render \SpecialChar LaTeX
5682 embedded in HTML documents.
5684 wraps the \SpecialChar LaTeX
5686 \begin_inset Flex Code
5689 \begin_layout Plain Layout
5695 (for inline formulas) or
5696 \begin_inset Flex Code
5699 \begin_layout Plain Layout
5705 (for displayed formulas) with
5706 \begin_inset Flex Code
5709 \begin_layout Plain Layout
5715 , as is required for jsMath.
5718 \begin_layout Standard
5719 One of these output methods must be selected under
5720 \begin_inset Flex Noun
5723 \begin_layout Plain Layout
5724 Document\SpecialChar menuseparator
5725 Settings\SpecialChar menuseparator
5732 By default, \SpecialChar LyX
5734 This is a document-wide setting, therefore.
5737 \begin_layout Standard
5738 Eventually, \SpecialChar LyX
5739 will offer the user the option to select an alternate output
5740 method for a particular inset, say, one that isn't being rendered very
5745 \begin_layout Plain Layout
5746 That said, since \SpecialChar LyX
5747 falls back to images if the inset contains ERT, then one
5748 can force output as an image by putting some harmless ERT into the math,
5750 \begin_inset Formula $a=b\relax$
5761 \begin_layout Section
5762 Bibliography and Citations
5765 \begin_layout Standard
5766 XHTML output fully supports bibliographies and citations.
5770 \begin_layout Standard
5771 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5773 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5776 If you are using numerical citations, then \SpecialChar LyX
5777 will output numerical labels,
5778 such as [1] or [17], rather than simply showing the citation key in square
5779 brackets, as it does on-screen.
5780 If you are using author-year citations, then \SpecialChar LyX
5781 will add lowercase letters
5782 to the years, just as Bib\SpecialChar TeX
5783 does, if it finds more than one citation for
5784 a given author-year combination.
5785 The labels will be printed with the bibliography entries.
5786 Note that there is, at present, no way to customize the appearance of the
5787 labels, for example, to choose between square brackets and parentheses.
5790 \begin_layout Standard
5791 Bibliography output is handled by the same machinery that handles the presentati
5792 on of reference information in the citation dialog, so you will see in the
5793 XHTML output pretty much what you would see if you were to look at a given
5794 entry in the citation dialog.
5795 The formatting can be customized in your layout file or, preferably, in
5801 manual for the details.
5804 \begin_layout Standard
5805 The main defect at present is that cross-referenced information is printed
5806 with every entry with which it is associated.
5807 So you can see things like this:
5812 \begin_inset Quotes eld
5815 Context and Logical Form
5816 \begin_inset Quotes erd
5821 Language in Context: Selected Essays
5823 (Oxford: Oxford University Press, 2007), pp.
5829 \begin_inset Quotes eld
5832 Semantics in Context
5833 \begin_inset Quotes erd
5838 Language in Context: Selected Essays
5840 (Oxford: Oxford University Press, 2007), pp.
5844 \begin_layout Standard
5845 This should be fixed before long.
5848 \begin_layout Standard
5849 There is no support at present for sectioned bibliographies.
5850 If you have multiple bibliographies, then \SpecialChar LyX
5851 will print the same bibliography
5855 \begin_layout Section
5859 \begin_layout Standard
5861 will happily export indexes as XHTML, but with certain limitations at the
5865 \begin_layout Standard
5866 Index export will be most reliable when you do not attempt to use the fancy
5867 constructs that are described in the section on indexes in the
5875 \begin_layout Plain Layout
5876 The main issue here is that \SpecialChar LyX
5877 itself does not really handle these.
5878 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5884 We'll describe how they are handled using the subsection headings from
5888 \begin_layout Itemize
5889 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5890 makes an effort to support these,
5891 but the entries must be separated by
5892 \begin_inset Quotes eld
5896 \begin_inset Quotes erd
5899 , that is, there must be spaces around the exclamation point.
5900 This is because it is otherwise too difficult to check for escaped exclamation
5901 points, ones in math, and so forth.
5904 \begin_layout Itemize
5905 Page Ranges: There is no support at all for page ranges, since these make
5906 no sense with XHMTL.
5907 Instead, you will just get two index entries, one at either end.
5910 \begin_layout Itemize
5911 Cross-referencing: There is no support for cross-referencing.
5913 finds an entry containing the
5914 \begin_inset Quotes eld
5917 |see\SpecialChar ldots
5919 \begin_inset Quotes erd
5922 construct, it is just dropped, and the rest is treated as an ordinary index
5926 \begin_layout Itemize
5927 Index Entry Order: \SpecialChar LyX
5928 does support attempts to fix the sorting order.
5929 It will take what is before the first `@' it finds and use that for sorting,
5930 taking what follows the first `@' to be the actual entry.
5931 At present, \SpecialChar LyX
5932 does not check for escaped `@', so do not try to index email
5936 \begin_layout Itemize
5937 Index Entry Layout: You can format entries by using the text style dialog,
5938 or by using any other method available within \SpecialChar LyX
5940 There is no support for constructs like:
5941 \begin_inset Quotes eld
5945 \begin_inset Quotes erd
5949 Indeed, if \SpecialChar LyX
5950 finds a pipe symbol, `|', in an entry, it will delete it and
5951 everything that follows it.
5954 \begin_layout Itemize
5955 Multiple Indexes: There is no support for multiple indexes.
5956 Rather, all index entries will be printed as one large index.
5957 To avoid our printing several versions of the index, we print only the
5958 main index, so make sure you have one.
5961 \begin_layout Section
5962 Nomenclature and Glossary
5965 \begin_layout Standard
5966 There is at present no support for glossaries.
5967 Adding it would be fairly trivial, and welcome.
5970 \begin_layout Chapter
5972 \change_inserted 1075283030 1616534180
5976 \begin_layout Standard
5978 \change_inserted 1075283030 1616534386
5979 Apart from HTML, \SpecialChar LyX
5980 can generate documents in the DocBook XML vocabulary.
5981 With versions 2.3 and before, only select templates could be used to generate
5982 DocBook documents (only version 4).
5983 Starting with \SpecialChar LyX
5984 2.4, most \SpecialChar LyX
5985 layouts can generate valid DocBook documents (only
5987 This feature is built into \SpecialChar LyX
5988 and does not require the use of external tools.
5991 \begin_layout Standard
5993 \change_inserted 1075283030 1616534437
5994 The result is that the DocBook output can be customized and extended in
5995 exactly the same way \SpecialChar LaTeX
5996 output can be customized and extended: through layout
5998 See chapter five of the
6002 manual for the details.
6005 \begin_layout Standard
6007 \change_inserted 1075283030 1616534475
6008 Most \SpecialChar LyX
6009 features are supported with DocBook, like math output.
6012 \begin_layout Itemize
6014 \change_inserted 1075283030 1616534741
6015 Math output is performed mostly in MathML (the major exception being constructio
6016 ns not supported by \SpecialChar LyX
6019 All formulae are also available in raw \SpecialChar TeX
6020 in the DocBook output for further
6024 \begin_layout Itemize
6026 \change_inserted 1075283030 1616534852
6027 Bibliographies and citations are implemented, including with an external
6029 Bibliography entries are not prerendered when the detailed information
6030 are available, but rather output with the standard DocBook constructs.
6031 The external DocBook processor is expected to handle the rendering of entries.
6034 \begin_layout Itemize
6036 \change_inserted 1075283030 1616534863
6037 Indexes are supported, including multiple indices.
6042 ), page ranges, and cross-references (
6046 ) are supported, with the exception of the same symbols escaped.
6055 ) are not supported.
6056 There is no support for escaping of index entries.
6059 \begin_layout Itemize
6061 \change_inserted 1075283030 1616534884
6062 Glossaries are implemented.
6065 \begin_layout Standard
6067 \change_inserted 1075283030 1616534894
6068 Two major parameters can be set at the document level.
6071 \begin_layout Itemize
6073 \change_inserted 1075283030 1616534948
6074 Format for tables: \SpecialChar LyX
6075 can generate tables either as HTML (default value) or
6076 CALS, depending on the user's requirements.
6077 Most DocBook processors accept both formats.
6080 \begin_layout Itemize
6082 \change_inserted 1075283030 1616535006
6083 MathML prefix: in DocBook, MathML is included within its own name space,
6085 The implication is that there must be an indication of the tags belonging
6086 to the MathML standard.
6087 Three choices are offered:
6091 \begin_layout Itemize
6093 \change_inserted 1075283030 1616535044
6094 Inline: the MathML name space is defined for each formula (using the
6098 attribute on each formula)
6101 \begin_layout Itemize
6103 \change_inserted 1075283030 1616535090
6108 prefix (default): the MathML name space is defined at the document level
6113 attribute on the root element).
6114 Each MathML is prefixed with
6123 \begin_layout Itemize
6125 \change_inserted 1075283030 1616620405
6130 prefix: similar to the
6139 \begin_layout Standard
6141 \change_inserted 1075283030 1616620470
6142 This option is especially useful if you want \SpecialChar LyX
6143 to match your personal style
6144 or to work with buggy software that only accepts one prefix for MathML.
6150 \begin_layout Chapter
6151 The \SpecialChar LyX
6155 \begin_layout Section
6159 \begin_layout Standard
6160 The `\SpecialChar LyX
6161 server' allows other programs to talk to \SpecialChar LyX
6162 , invoke \SpecialChar LyX
6163 commands, and retrieve
6164 information about the \SpecialChar LyX
6166 This is only intended for advanced users, but they should find it useful.
6167 It is by writing to the \SpecialChar LyX
6168 server, for example, that bibliography managers,
6169 such as JabRef, are able to
6170 \begin_inset Quotes eld
6174 \begin_inset Quotes erd
6177 citations to \SpecialChar LyX
6181 \begin_layout Section
6182 Starting the \SpecialChar LyX
6184 \begin_inset CommandInset label
6186 name "sec:Starting-the-Server"
6193 \begin_layout Standard
6194 The \SpecialChar LyX
6195 server works through the use of a pair of named pipes.
6196 These are usually located in
6197 \begin_inset Flex Code
6200 \begin_layout Plain Layout
6206 , (except on Windows, where
6210 named pipes are special objects located in
6211 \begin_inset Flex Code
6214 \begin_layout Plain Layout
6226 ) and have the names
6227 \begin_inset Quotes eld
6231 \begin_inset Flex Code
6234 \begin_layout Plain Layout
6241 \begin_inset Quotes erd
6245 \begin_inset Quotes eld
6249 \begin_inset Flex Code
6252 \begin_layout Plain Layout
6259 \begin_inset Quotes erd
6263 External programs write into
6264 \begin_inset Flex Code
6267 \begin_layout Plain Layout
6273 and read back data from
6274 \begin_inset Flex Code
6277 \begin_layout Plain Layout
6284 The stem of the pipe names can be defined in the
6285 \begin_inset Flex Noun
6288 \begin_layout Plain Layout
6289 Tools\SpecialChar menuseparator
6296 \begin_inset Flex Code
6299 \begin_layout Plain Layout
6300 "/home/myhome/lyxpipe"
6306 \begin_inset Flex Code
6309 \begin_layout Plain Layout
6323 on Windows (where any working path instead of lyxpipe can be used, for
6325 \begin_inset Flex Code
6328 \begin_layout Plain Layout
6351 configure this manually in order for the server to start.
6354 \begin_layout Standard
6357 \begin_inset Flex Code
6360 \begin_layout Plain Layout
6367 \begin_inset Flex Code
6370 \begin_layout Plain Layout
6376 ' to create the pipes.
6377 If one of the pipes already exists, \SpecialChar LyX
6378 will assume that another \SpecialChar LyX
6380 is already running and will not start the server.
6381 On POSIX (Unix like) systems, if for some other reason, an unused
6382 \begin_inset Quotes eld
6386 \begin_inset Quotes erd
6389 pipe is left in existence when \SpecialChar LyX
6390 closes, then \SpecialChar LyX
6391 will try to delete it.
6392 If this fails for some reason, you will need to delete the pipes manually
6393 and then restart \SpecialChar LyX
6395 On Windows, pipes are deleted by the OS on program termination or crash,
6397 \begin_inset Quotes eld
6401 \begin_inset Quotes erd
6404 pipes should not be possible.
6407 \begin_layout Standard
6408 To have several \SpecialChar LyX
6409 processes with servers at the same time, you have to use
6410 different configurations, perhaps by using separate user directories, each
6412 \begin_inset Flex Code
6415 \begin_layout Plain Layout
6421 file, for each process.
6424 \begin_layout Standard
6425 If you are developing a client program, you might find it useful to enable
6426 debugging information from the \SpecialChar LyX
6428 Do this by starting \SpecialChar LyX
6430 \begin_inset Flex Code
6433 \begin_layout Plain Layout
6442 \begin_layout Standard
6443 You can find a complete example client written in C++ in the source distribution
6445 \begin_inset Flex Code
6448 \begin_layout Plain Layout
6449 development/lyxserver/server_monitor.cpp
6457 \begin_layout Standard
6458 Another useful tool is the command-line based client found in
6459 \begin_inset Flex Code
6462 \begin_layout Plain Layout
6463 src/client/lyxclient
6471 \begin_layout Section
6472 Normal communication
6475 \begin_layout Standard
6476 To issue a \SpecialChar LyX
6477 call, the client writes a line of ASCII text into the input
6479 This line has the following format:
6496 \begin_layout Description
6497 clientname is a name that the client can choose arbitrarily.
6498 Its only use is that \SpecialChar LyX
6499 will echo it if it sends an answer—so a client can
6500 dispatch results from different requesters.
6503 \begin_layout Description
6504 function is the function you want \SpecialChar LyX
6506 It is the same as the commands you'd use in the minibuffer.
6509 \begin_layout Description
6510 argument is an optional argument which is meaningful only to some functions
6512 \begin_inset Quotes eld
6516 \begin_inset Quotes erd
6519 LFUN will insert the argument as text at the cursor position).
6522 \begin_layout Standard
6523 The answer from \SpecialChar LyX
6524 will arrive in the output pipe and be of the form
6541 \begin_layout Standard
6550 are just echoed from the command request, while
6554 is more or less useful information filled according to how the command
6555 execution worked out.
6556 Some commands, such as
6557 \begin_inset Quotes eld
6561 \begin_inset Quotes erd
6564 , will return information about the internal state of \SpecialChar LyX
6566 return an empty data-response.
6567 This means that the command execution went fine.
6570 \begin_layout Standard
6571 In case of errors, the response from \SpecialChar LyX
6589 \begin_layout Standard
6594 should contain an explanation of why the command failed.
6597 \begin_layout Standard
6601 \begin_layout LyX-Code
6602 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
6603 \begin_inset Newline newline
6606 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
6607 \begin_inset Newline newline
6610 read a <~/.lyxpipe.out
6611 \begin_inset Newline newline
6617 \begin_layout Subsection
6618 AppleScript (Mac OS X)
6621 \begin_layout Standard
6622 Since \SpecialChar LyX
6623 2.1, \SpecialChar LyX
6624 supports basic interactions with AppleScript for normal communicatio
6625 n through the command run.
6626 This command takes a direct argument (the
6630 to perform) and an optional argument.
6631 It either returns the output of the function or triggers an error with
6632 the error message and code.
6635 \begin_layout Standard
6639 \begin_layout LyX-Code
6640 tell application "\SpecialChar LyX
6644 \begin_layout LyX-Code
6648 \begin_layout LyX-Code
6649 -- Stores the current file name into f
6652 \begin_layout LyX-Code
6653 set f to (run "server-get-filename" with argument "")
6656 \begin_layout LyX-Code
6657 on error the error_message number the error_number
6660 \begin_layout LyX-Code
6661 display dialog "Error: " & the error_number & ".
6665 \begin_layout LyX-Code
6666 & the error_message buttons {"OK"} default button 1
6669 \begin_layout LyX-Code
6673 \begin_layout LyX-Code
6677 \begin_layout Section
6681 \begin_layout Standard
6683 can notify clients of events going on asynchronously.
6684 Currently it will only do this if the user binds a key sequence with the
6686 \begin_inset Quotes eld
6690 \begin_inset Quotes erd
6694 The format of the string \SpecialChar LyX
6695 sends is as follows:
6699 \begin_inset Flex Code
6702 \begin_layout Plain Layout
6713 \begin_layout Standard
6718 is the printed representation of the key sequence that was actually typed
6722 \begin_layout Standard
6723 This mechanism can be used to extend \SpecialChar LyX
6724 's command set and implement macros.
6725 Bind some key sequence to
6726 \begin_inset Quotes eld
6730 \begin_inset Quotes erd
6734 Then start a client that listens on the output pipe, dispatches the command
6735 according to the sequence, and starts a function that may use \SpecialChar LyX
6738 requests to issue a command or a series of commands to \SpecialChar LyX
6742 \begin_layout Section
6743 The simple \SpecialChar LyX
6747 \begin_layout Standard
6749 implements a simple protocol that can be used for session management.
6750 All messages are of the form
6763 \begin_layout Standard
6769 \begin_inset Quotes eld
6773 \begin_inset Quotes erd
6777 \begin_inset Quotes eld
6781 \begin_inset Quotes erd
6786 \begin_inset Quotes eld
6790 \begin_inset Quotes erd
6793 is received from a client, \SpecialChar LyX
6794 will report back to inform the client that
6795 it's listening to it's messages, while
6796 \begin_inset Quotes eld
6800 \begin_inset Quotes erd
6803 sent from \SpecialChar LyX
6804 will inform clients that \SpecialChar LyX
6808 \begin_layout Section
6809 Reverse DVI/PDF search
6812 \begin_layout Standard
6813 Some DVI/PDF viewers
6817 \begin_layout Plain Layout
6818 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6819 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6828 facility (also called
6833 This means that you can tell \SpecialChar LyX
6834 to put the cursor to a specific line in the
6835 document by clicking at the respective position in the DVI/PDF output.
6836 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6838 This is done via the \SpecialChar LyX
6839 server either by using the named pipe (
6843 ), or the UNIX domain socket (
6847 ) that \SpecialChar LyX
6848 creates in its temporary directory (this is the way the
6849 \begin_inset Flex Code
6852 \begin_layout Plain Layout
6858 program communicates with \SpecialChar LyX
6860 In some cases, you need a helper script that mediates between the viewer
6861 and \SpecialChar LyX
6862 , in others, the viewer can communicate with \SpecialChar LyX
6864 This depends on the selected viewer and on your operating system.
6865 The same applies to the way viewers need to be configured and the way the
6866 reverse search is actually performed.
6867 In what follows, we will thus describe how to setup reverse search for
6869 Before we turn to this, though, we will explain what needs to be done generally
6870 to enable reverse search in the DVI/PDF output.
6873 \begin_layout Subsection
6875 \begin_inset CommandInset label
6877 name "subsec:rev-search"
6884 \begin_layout Standard
6885 In most cases \SpecialChar LyX
6886 will do the work for you by pressing the following button
6890 arg "buffer-toggle-output-sync"
6894 Alternatively, you can also enable the feature by checking
6896 Synchronize with Output
6899 \begin_inset Flex Noun
6902 \begin_layout Plain Layout
6903 Document\SpecialChar menuseparator
6904 Settings\SpecialChar menuseparator
6911 In such a case \SpecialChar LyX
6912 will automatically insert the necessary Sync\SpecialChar TeX
6914 PDF) or load the srcltx package (for DVI) respectively.
6915 This option can be easily reached also on
6916 \begin_inset Flex Code
6919 \begin_layout Plain Layout
6928 \begin_layout Standard
6929 If you need a different setting, you can select or input a custom macro
6930 from the drop down box just below
6931 \begin_inset Flex Noun
6934 \begin_layout Plain Layout
6935 Document\SpecialChar menuseparator
6936 Settings\SpecialChar menuseparator
6937 Output\SpecialChar menuseparator
6938 Synchronize with Output
6946 \begin_layout Standard
6947 Note that the method
6948 \begin_inset Flex Code
6951 \begin_layout Plain Layout
6959 enables gzip compression.
6960 If your viewer does not support it, you should instead use
6961 \begin_inset Flex Code
6964 \begin_layout Plain Layout
6975 \begin_layout Standard
6976 Please also note that including the
6977 \begin_inset Flex Code
6980 \begin_layout Plain Layout
6987 \begin_inset Flex Code
6990 \begin_layout Plain Layout
6996 sometimes has an undesired impact on the typesetting.
6997 Thus, you should switch output synchronization off for the final typesetting
6999 \begin_inset Flex Code
7002 \begin_layout Plain Layout
7009 \begin_inset Flex Code
7012 \begin_layout Plain Layout
7022 \begin_layout Standard
7023 In case you need some more special settings that are not covered by the
7024 automatic settings, read the next section about how to set up output synchroniz
7026 If the automatic setup suits your needs, you can readily jump to section
7027 \begin_inset space ~
7031 \begin_inset CommandInset ref
7033 reference "subsec:configuring-viewers"
7037 , where the necessary configuration steps in your viewer – needed both with
7038 the automatic and the manual setup – are described.
7041 \begin_layout Subsection
7045 \begin_layout Standard
7047 provides several different methods for reverse search.
7048 Some are built-in in the
7049 \begin_inset Flex Code
7052 \begin_layout Plain Layout
7058 program, some are provided by external packages.
7059 Your choice depends on whether your \SpecialChar LaTeX
7060 distribution already provides a given
7061 method (the built-in methods are rather new) and whether your viewer can
7063 The available methods are described in the following.
7066 \begin_layout Subsubsection*
7067 Built-in DVI-search via src-specials (DVI only)
7070 \begin_layout Standard
7071 This method provides the DVI file with the necessary information for reverse
7073 It is available in \SpecialChar LaTeX
7074 since quite some time (any somewhat recent \SpecialChar LaTeX
7076 should include it), and it works reliably.
7077 To enable it, change the
7078 \begin_inset Flex Noun
7081 \begin_layout Plain Layout
7092 \begin_inset Flex Noun
7095 \begin_layout Plain Layout
7106 \begin_inset Flex Noun
7109 \begin_layout Plain Layout
7110 Preferences\SpecialChar menuseparator
7111 File Handling\SpecialChar menuseparator
7118 \begin_inset Flex Code
7121 \begin_layout Plain Layout
7122 latex -src-specials $$i
7128 If this doesn't work, check if your \SpecialChar TeX
7129 engine needs different options (the
7130 syntax might differ in some distributions).
7133 \begin_layout Subsubsection*
7134 External Packages (PDFSync and scrltx)
7137 \begin_layout Standard
7146 provide reverse search facility for PDF output (via pdflatex) and DVI output,
7148 In order to enable it, load the packages in the \SpecialChar LyX
7152 \begin_layout Itemize
7153 \begin_inset Flex Code
7156 \begin_layout Plain Layout
7164 for reverse PDF search,
7167 \begin_layout Itemize
7168 \begin_inset Flex Code
7171 \begin_layout Plain Layout
7174 usepackage[active]{srcltx}
7179 for reverse DVI search.
7182 \begin_layout Standard
7183 If you want to be able to perform both DVI and PDF reverse searches, you
7184 can also insert in the preamble the following lines
7187 \begin_layout LyX-Code
7191 \begin_inset Newline newline
7197 \begin_inset Newline newline
7203 \begin_inset Newline newline
7209 \begin_inset Newline newline
7214 usepackage[active]{srcltx}
7215 \begin_inset Newline newline
7223 \begin_layout Standard
7224 This way, you can preview the file as either DVI or PDF (pdflatex) and the
7225 right package will be used.
7228 \begin_layout Standard
7229 Note that PDFSync might affect the output layout of your document.
7230 It is therefore advised to disable PDFsync for final documents.
7233 \begin_layout Subsubsection*
7234 Built-in reverse search via Sync\SpecialChar TeX
7238 \begin_layout Standard
7240 \begin_inset Flex Code
7243 \begin_layout Plain Layout
7249 have built-in support for both PDF and DVI reverse search.
7252 Sync\SpecialChar TeX
7255 facility is basically the result of the integration of the PDFSync package
7256 to the pdftex program and its merge with the
7261 You need at least \SpecialChar TeX
7262 Live 2008 or a recent Mik\SpecialChar TeX
7263 distribution in order to use
7268 \begin_layout Plain Layout
7269 For some reason, Mik\SpecialChar TeX
7270 does not understand/obey the command \SpecialChar LyX
7272 the preamble when you check the "Enable Forward/Reverse Search" button
7273 in the toolbar and does not generate the necessary info.
7276 \begin_layout Plain Layout
7277 The generation of the required info can be forced by changing the converter
7279 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
7280 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
7281 the -synctex=1 switch).
7286 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
7287 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
7288 already provide Sync\SpecialChar TeX
7292 \begin_layout Standard
7293 To enable Sync\SpecialChar TeX
7294 for DVI output, change the
7295 \begin_inset Flex Noun
7298 \begin_layout Plain Layout
7309 \begin_inset Flex Noun
7312 \begin_layout Plain Layout
7323 \begin_inset Flex Noun
7326 \begin_layout Plain Layout
7327 Preferences\SpecialChar menuseparator
7328 File Handling\SpecialChar menuseparator
7335 \begin_inset Flex Code
7338 \begin_layout Plain Layout
7339 latex -synctex=1 $$i
7344 , and for PDF output, change the
7345 \begin_inset Flex Noun
7348 \begin_layout Plain Layout
7353 (pdflatex) -> PDF (pdflatex)
7359 \begin_inset Flex Code
7362 \begin_layout Plain Layout
7363 pdflatex -synctex=1 $$i
7369 Should your viewer not be considered in the following description, or in
7370 case of missing success, please check the documentation of your viewer
7371 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
7376 \begin_layout Plain Layout
7377 Note that the option
7378 \begin_inset Flex Code
7381 \begin_layout Plain Layout
7387 option enables gzip compression.
7388 If your viewer does not support it, you should instead use
7389 \begin_inset Flex Code
7392 \begin_layout Plain Layout
7406 \begin_layout Subsection
7407 Configuring and using specific viewers
7408 \begin_inset CommandInset label
7410 name "subsec:configuring-viewers"
7417 \begin_layout Subsubsection*
7418 Xdvi (all platforms)
7421 \begin_layout Standard
7423 \begin_inset Flex Code
7426 \begin_layout Plain Layout
7432 , you don't need to do anything else for performing a reverse DVI search,
7434 already provides the necessary hooks for automatically using the
7435 \begin_inset Flex Code
7438 \begin_layout Plain Layout
7445 Just setup your document as described above (reverse search is triggered
7446 by Ctrl-click or Alt-click on Mac OSX, respectively).
7449 \begin_layout Standard
7450 However, if for whatever reason you want to use the named pipe instead of
7451 the socket for communicating with \SpecialChar LyX
7452 , simply change the DVI viewer in
7453 \begin_inset Flex Noun
7456 \begin_layout Plain Layout
7457 Preferences\SpecialChar menuseparator
7458 File Handling\SpecialChar menuseparator
7468 \begin_layout Plain Layout
7469 On Mac OSX you have to use
7470 \begin_inset Flex Code
7473 \begin_layout Plain Layout
7474 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
7485 \begin_inset Flex Code
7488 \begin_layout Plain Layout
7489 xdvi -editor "lyxeditor.sh %f %l"
7495 \begin_inset Flex Code
7498 \begin_layout Plain Layout
7504 is a suitable script.
7505 For example, a minimal shell script is the following one:
7508 \begin_layout LyX-Code
7510 \begin_inset Newline newline
7513 LYXPIPE="/path/to/lyxpipe"
7514 \begin_inset Newline newline
7517 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
7518 \begin_inset Newline newline
7521 echo "$COMMAND" > "${LYXPIPE}".in || exit
7522 \begin_inset Newline newline
7525 read TMP < "${LYXPIPE}".out || exit
7528 \begin_layout Standard
7530 \begin_inset Flex Code
7533 \begin_layout Plain Layout
7539 is the LyXServer pipe path specified in
7540 \begin_inset Flex Noun
7543 \begin_layout Plain Layout
7544 Preferences\SpecialChar menuseparator
7554 \begin_layout Plain Layout
7556 \begin_inset Flex Code
7559 \begin_layout Plain Layout
7565 folder of a source distribution you can find a
7566 \begin_inset Flex Code
7569 \begin_layout Plain Layout
7575 script which is able to locate the
7579 based on your preferences.
7587 \begin_layout Subsubsection*
7591 \begin_layout Standard
7593 \begin_inset Flex Code
7596 \begin_layout Plain Layout
7597 /Applications/MacDviX_Folder/calleditor.script
7602 , add the following lines:
7605 \begin_layout LyX-Code
7606 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
7607 \begin_inset Newline newline
7613 \begin_layout Standard
7614 Modify the lines accordingly if you install \SpecialChar LyX
7615 somewhere else than in the
7616 Applications folder.
7619 \begin_layout Standard
7620 Reverse search is triggered by Alt-click (OPTION-click).
7623 \begin_layout Subsubsection*
7627 \begin_layout Standard
7629 \begin_inset Flex Code
7632 \begin_layout Plain Layout
7633 open -a Skim.app $$i
7638 to the viewer setting in
7639 \begin_inset Flex Noun
7642 \begin_layout Plain Layout
7643 Preferences\SpecialChar menuseparator
7644 File Handling\SpecialChar menuseparator
7645 File formats\SpecialChar menuseparator
7652 \begin_inset Flex Noun
7655 \begin_layout Plain Layout
7656 Skim\SpecialChar menuseparator
7657 Preferences\SpecialChar menuseparator
7664 \begin_inset Flex Noun
7667 \begin_layout Plain Layout
7673 preset and enter command
7674 \begin_inset Flex Noun
7677 \begin_layout Plain Layout
7678 /Applications/\SpecialChar LyX
7679 .app/Contents/MacOS/lyxeditor
7687 \begin_layout Standard
7688 Reverse search is triggered by COMMAND-SHIFT-click
7691 \begin_layout Subsubsection*
7695 \begin_layout Standard
7696 Reverse search with evince does not work out of the box, but it can be achieved
7697 by means of some third party helper scripts.
7699 \begin_inset CommandInset href
7701 target "https://wiki.lyx.org/LyX/SyncTeX"
7709 \begin_layout Subsubsection*
7713 \begin_layout Standard
7715 \begin_inset Flex Noun
7718 \begin_layout Plain Layout
7719 Settings\SpecialChar menuseparator
7720 Configure Okular\SpecialChar menuseparator
7727 \begin_inset Quotes erd
7731 This inserts the appropriate command (
7732 \begin_inset Flex Code
7735 \begin_layout Plain Layout
7744 \begin_layout Standard
7745 Reverse search is triggered by SHIFT-click.
7747 \change_inserted -712698321 1578211026
7748 Note that this only works if Okular is in
7749 \begin_inset Quotes eld
7753 \begin_inset Quotes erd
7757 \begin_inset space \thinspace{}
7760 e., the hand symbol is clicked).
7765 \begin_layout Subsubsection*
7769 \begin_layout Standard
7770 Qpdfview supports Sync\SpecialChar TeX
7771 since version 0.3.5.
7773 \begin_inset Flex Noun
7776 \begin_layout Plain Layout
7777 Edit\SpecialChar menuseparator
7778 Settings\SpecialChar menuseparator
7784 , click on the input field of the
7785 \begin_inset Quotes eld
7789 \begin_inset Quotes erd
7792 item and add the command
7793 \begin_inset Flex Code
7796 \begin_layout Plain Layout
7805 \begin_layout Standard
7806 Reverse search is triggered by double-click or, in more recent versions,
7810 \begin_layout Subsubsection*
7814 \begin_layout Standard
7815 Launch yap, choose its
7816 \begin_inset Flex Noun
7819 \begin_layout Plain Layout
7820 View\SpecialChar menuseparator
7827 \begin_inset Quotes eld
7831 \begin_inset Quotes erd
7836 \begin_inset Quotes eld
7839 New\SpecialChar ldots
7841 \begin_inset Quotes erd
7844 button and, in the window that opens, enter
7845 \begin_inset Quotes eld
7850 \begin_inset Quotes erd
7853 (or any other name you like) in the
7854 \begin_inset Quotes eld
7858 \begin_inset Quotes erd
7862 Now click on the button labeled
7863 \begin_inset Quotes eld
7868 \begin_inset Quotes erd
7871 to open a file dialog and navigate to the directory containing the batch
7873 \begin_inset Flex Code
7876 \begin_layout Plain Layout
7884 \begin_inset Flex Code
7887 \begin_layout Plain Layout
7893 and then specify the program arguments as
7894 \begin_inset Flex Code
7897 \begin_layout Plain Layout
7905 \begin_inset Flex Code
7908 \begin_layout Plain Layout
7914 wrapper is used for communicating with \SpecialChar LyX
7922 \begin_layout LyX-Code
7924 \begin_inset Newline newline
7927 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
7936 \begin_inset Newline newline
7950 \begin_layout Standard
7951 Make sure that the \SpecialChar LyX
7952 Server pipe path you specified in \SpecialChar LyX
7954 \begin_inset Flex Code
7957 \begin_layout Plain Layout
7971 , otherwise change the
7972 \begin_inset Flex Code
7975 \begin_layout Plain Layout
7981 wrapper accordingly.
7984 \begin_layout Standard
7985 In yap, reverse search is triggered by double-click.
7988 \begin_layout Subsubsection*
7989 SumatraPDF (Windows)
7992 \begin_layout Standard
7993 In order to use SumatraPDF for inverse search, enter
7994 \begin_inset Flex Code
7997 \begin_layout Plain Layout
7998 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
8003 in the viewer setting in
8004 \begin_inset Flex Noun
8007 \begin_layout Plain Layout
8008 Preferences\SpecialChar menuseparator
8009 File Handling\SpecialChar menuseparator
8010 File formats\SpecialChar menuseparator
8017 \begin_inset Flex Code
8020 \begin_layout Plain Layout
8026 is the previous wrapper.
8027 If SumatraPDF.exe is not in your command PATH, use its full file name.
8030 \begin_layout Standard
8031 Reverse search is triggered by double-click.
8034 \begin_layout Subsubsection*
8038 \begin_layout Standard
8039 First of all, make sure that yap is your default DVI viewer in the Windows
8040 environment, then launch it, choose its
8041 \begin_inset Flex Noun
8044 \begin_layout Plain Layout
8045 View\SpecialChar menuseparator
8052 \begin_inset Quotes eld
8056 \begin_inset Quotes erd
8061 \begin_inset Quotes eld
8064 New\SpecialChar ldots
8066 \begin_inset Quotes erd
8069 button and, in the window that opens, enter
8070 \begin_inset Quotes eld
8075 \begin_inset Quotes erd
8078 (or any other name you like) in the
8079 \begin_inset Quotes eld
8083 \begin_inset Quotes erd
8087 Now click on the button labeled
8088 \begin_inset Quotes eld
8093 \begin_inset Quotes erd
8096 to open a file dialog and navigate to the directory containing the
8097 \begin_inset Flex Code
8100 \begin_layout Plain Layout
8106 program (which is installed by default on Cygwin along with the \SpecialChar LyX
8109 \begin_inset Flex Code
8112 \begin_layout Plain Layout
8118 and then specify the program arguments as
8119 \begin_inset Flex Code
8122 \begin_layout Plain Layout
8129 In this way, you will be using the
8133 for communicating with \SpecialChar LyX
8135 If, for whatever reason, you want to use the
8140 \begin_inset Flex Code
8143 \begin_layout Plain Layout
8149 option and be sure to specify the \SpecialChar LyX
8150 Server pipe path in the \SpecialChar LyX
8154 \begin_layout Standard
8155 In yap, reverse search is triggered by double-click.
8158 \begin_layout Subsubsection*
8162 \begin_layout Standard
8163 In order to use SumatraPDF for inverse search, enter
8164 \begin_inset Flex Code
8167 \begin_layout Plain Layout
8168 SumatraPDF -inverse-search "lyxeditor -g %f %l"
8173 in the viewer setting in
8174 \begin_inset Flex Noun
8177 \begin_layout Plain Layout
8178 Preferences\SpecialChar menuseparator
8179 File Handling\SpecialChar menuseparator
8180 File formats\SpecialChar menuseparator
8187 If SumatraPDF.exe is not in your command PATH, use its full posix path.
8189 \begin_inset Flex Code
8192 \begin_layout Plain Layout
8198 enables communication via the
8204 \begin_inset Flex Code
8207 \begin_layout Plain Layout
8213 option if you want to use the
8217 , and be sure to specify the \SpecialChar LyX
8218 Server pipe path in the \SpecialChar LyX
8222 \begin_layout Standard
8223 Reverse search is triggered by double-click.
8226 \begin_layout Section
8230 \begin_layout Standard
8231 Forward search is, as the name implies, in a sense the
8232 \begin_inset Quotes eld
8236 \begin_inset Quotes erd
8240 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
8242 If forward search is set up (as described in what follows), you can put
8243 the cursor anywhere in your \SpecialChar LyX
8245 \begin_inset Flex Noun
8248 \begin_layout Plain Layout
8249 Navigate\SpecialChar menuseparator
8256 \begin_inset Flex Noun
8259 \begin_layout Plain Layout
8265 in the context menu via right mouse click), and then the viewer will jump
8266 to that position as well.
8267 This implies, of course, that your viewer supports this function.
8270 \begin_layout Standard
8271 To make forward search possible, you first need to provide the generated
8272 output PDF/DVI file with additional information about the \SpecialChar TeX
8274 This can be done via the methods described in the section
8275 \begin_inset CommandInset ref
8277 reference "subsec:rev-search"
8284 \begin_layout Standard
8285 Additionally, you need to configure \SpecialChar LyX
8286 for using your viewers in
8287 \begin_inset Flex Noun
8290 \begin_layout Plain Layout
8291 Tools\SpecialChar menuseparator
8292 Preferences\SpecialChar menuseparator
8293 Output\SpecialChar menuseparator
8300 We provide a range of tested configurations for some viewers, which you
8301 can select from the drop down list.
8302 If none of these configurations suits you, you have to find out and enter
8303 a suitable configuration yourself.
8304 The definition syntax uses the following placeholders:
8307 \begin_layout Itemize
8309 \begin_inset Flex Code
8312 \begin_layout Plain Layout
8321 \begin_layout Itemize
8323 \begin_inset Flex Code
8326 \begin_layout Plain Layout
8332 : name of the (temporary) exported .tex file (without path)
8335 \begin_layout Itemize
8337 \begin_inset Flex Code
8340 \begin_layout Plain Layout
8346 : name of the (temporary) exported .tex file (including path)
8349 \begin_layout Itemize
8351 \begin_inset Flex Code
8354 \begin_layout Plain Layout
8360 : name of the exported output file (either dvi or pdf, depending on which
8361 one exists in the temporary directory)
8364 \begin_layout Standard
8365 Note that only some of the viewers provide full and usable forward search
8366 functionality out of the box, among them yap, xdvi, okular
8370 \begin_layout Plain Layout
8371 You might want to set
8372 \begin_inset Flex Code
8375 \begin_layout Plain Layout
8382 \begin_inset Flex Noun
8385 \begin_layout Plain Layout
8386 Tools\SpecialChar menuseparator
8387 Preferences\SpecialChar menuseparator
8388 File Handling\SpecialChar menuseparator
8390 \begin_inset space ~
8403 , qpdfview, and SumatraPDF
8407 \begin_layout Plain Layout
8408 SumatraPDF can also use DDE commands through the external program CMCDDE
8410 \begin_inset CommandInset href
8412 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
8423 Others, such as evince
8427 \begin_layout Plain Layout
8428 Forward search with evince can be achieved by means of third party helper
8431 \begin_inset CommandInset href
8433 target "https://wiki.lyx.org/LyX/SyncTeX"
8443 , require some extra tools in order to use forward search.
8444 While many of the widespread PDF viewers (most notably Adobe Reader) do
8445 not support forward search at all, some other viewers – e.
8446 \begin_inset space \thinspace{}
8450 xpdf – allow at least to reload the document and jump to a specific page
8451 of the file, so you can at least navigate
8452 \begin_inset Quotes eld
8456 \begin_inset Quotes erd
8460 This latter functionality is provided by an external call of synctex (see
8461 the predefined example configurations).
8465 \begin_layout Standard
8466 Forward search works both with DVI and PDF output.
8468 simply checks which preview format you have used before (i.
8469 \begin_inset space \thinspace{}
8472 e., which format is already there in the temporary directory) and chooses
8473 the appropriate configuration for the respective format.
8476 \begin_layout Chapter
8477 Special Document Classes
8480 \begin_layout Section
8484 \begin_layout Standard
8490 \begin_layout Subsection
8494 \begin_layout Standard
8495 This section describes how \SpecialChar LyX
8496 can be used to write articles for submission
8497 to the scientific journal
8499 Astronomy and Astrophysics
8502 \begin_inset Flex URL
8505 \begin_layout Plain Layout
8507 https://www.aanda.org/
8512 ) using Version 5.01 of the document class
8517 This package can be downloaded from the ftp site
8520 \begin_layout Standard
8521 \begin_inset VSpace medskip
8527 \begin_layout Standard
8529 \begin_inset Flex URL
8532 \begin_layout Plain Layout
8534 ftp://ftp.edpsciences.org/pub/aa/readme.html
8542 \begin_layout Standard
8543 \begin_inset VSpace medskip
8549 \begin_layout Standard
8550 A manual comes together with that package, and this text is not meant to
8551 replace the original manual but is merely a short guide in how to realize
8552 the correct form of your paper.
8556 \begin_layout Standard
8557 Please note that the publisher of the journal was changed from Springer
8558 to EDP Sciences starting January 1, 2001.
8559 That change involved also some slight changes to the style files, namely
8560 the removal of the thesaurus command.
8561 The \SpecialChar LyX
8562 class aa supports the newest version of these style files, V 5.01.
8563 If you have an older version installed, please upgrade.
8564 For compatibility, the old (version 4) layout has been kept as
8569 Please refer to the comments in
8572 Dir/layouts/aapaper.layout
8577 \begin_layout Subsection
8581 \begin_layout Standard
8582 It is recommended you start from the example template distributed with \SpecialChar LyX
8584 If you are not using a template, note the following settings:
8587 \begin_layout Itemize
8594 Document\SpecialChar menuseparator
8597 dialog (OK, that one was obvious).
8600 \begin_layout Itemize
8601 Don't change the option
8604 \begin_inset space ~
8614 The whole layout is done by the macros, you shouldn't change anything.
8617 \begin_layout Subsection
8621 \begin_layout Standard
8622 First thing to enter is the header information.
8623 It consists of seven entries, of which some are optional.
8627 \begin_layout Itemize
8635 \begin_layout Itemize
8643 \begin_layout Itemize
8651 \begin_layout Itemize
8659 \begin_layout Itemize
8664 : [optional] if more than one author: whom to contact for offprint requests.
8667 \begin_layout Itemize
8672 : [optional] mail address for contacts.
8675 \begin_layout Itemize
8683 Received: <date>; Accepted <date>
8686 \begin_layout Standard
8687 There is no need to issue the
8693 command, this is done automatically by \SpecialChar LyX
8694 when the header is finished.
8695 Although the order of the single header entries doesn't matter it is advised
8696 to keep the above sequence, just to get the best optics and meets the layout
8697 of the real document.
8700 \begin_layout Standard
8701 If you want to place footnotes in the header block, e.
8702 \begin_inset space \thinspace{}
8706 \begin_inset space \space{}
8709 to state your present address, just use the standard footnote via the menu
8712 Insert\SpecialChar menuseparator
8717 will automagically use the term
8726 \begin_layout Standard
8729 Edit\SpecialChar menuseparator
8732 , you'll find two insets which are relevant for the titling:
8735 \begin_layout Itemize
8742 to mark corresponding author\SpecialChar breakableslash
8744 The institutes are numbered sequentially as they appear in the
8748 field, so you have to put a marker to each author.
8751 \begin_layout Itemize
8756 to supply an email address for fast contact.
8759 \begin_layout Standard
8760 In addition to these topics, the macros use one additional \SpecialChar LaTeX
8762 has no counterpart in \SpecialChar LyX
8766 \begin_layout Itemize
8773 to separate different names for more than one author and institute, respectivel
8777 \begin_layout Standard
8778 The appropriate command has to be entered in \SpecialChar LyX
8779 and marked as \SpecialChar LaTeX
8785 \begin_layout Subsection
8789 \begin_layout Standard
8790 The abstract should immediately follow the header block.
8791 With version 5 the abstract environment was changed to a command, and there
8792 is now a restriction to only one paragraph.
8793 In addition, it should contain an entry with the keywords.
8794 This is done via the paragraph style
8799 Refer to the example paper.
8802 \begin_layout Subsection
8803 Supported environments
8806 \begin_layout Standard
8807 The A&A paper layout supports the following environments for structuring
8811 \begin_layout Itemize
8817 \begin_layout Itemize
8823 \begin_layout Itemize
8829 \begin_layout Itemize
8835 \begin_layout Itemize
8841 \begin_layout Itemize
8847 \begin_layout Itemize
8853 \begin_layout Itemize
8859 \begin_layout Itemize
8865 \begin_layout Itemize
8871 \begin_layout Itemize
8877 \begin_layout Itemize
8884 \begin_layout Subsection
8885 Commands not supported by \SpecialChar LyX
8889 \begin_layout Standard
8890 Some commands are not yet supported by the
8894 layout for \SpecialChar LyX
8896 Some have already been mentioned.
8897 For the sake of completeness, they are listed all together here:
8900 \begin_layout Itemize
8908 \begin_layout Itemize
8916 \begin_layout Itemize
8924 \begin_layout Itemize
8932 \begin_layout Standard
8933 If you want to use any of these commands, you have to enter them yourself.
8936 Do not forget to mark them as \SpecialChar LaTeX
8940 \begin_layout Subsection
8941 Figure and Table Floats
8944 \begin_layout Standard
8946 provides support for the necessary float environments
8948 figure, figure*, table
8954 , therefore we won't tell much about it here.
8958 \begin_inset space ~
8964 Just remember that tables should be left-aligned.
8965 For that, select the table and change the alignment in
8967 Edit\SpecialChar menuseparator
8969 \begin_inset space ~
8975 \begin_layout Standard
8976 There is only one special thing: the figures with caption besides the figure.
8977 To create such a figure, you have to do the following:
8980 \begin_layout Enumerate
8981 Create a wide figure float:
8983 Insert\SpecialChar menuseparator
8984 Float\SpecialChar menuseparator
8987 , then right click in the figure and select
8990 \begin_inset space ~
8998 \begin_layout Enumerate
8999 Enter your caption text.
9002 \begin_layout Enumerate
9007 to move the cursor above the caption.
9010 \begin_layout Enumerate
9014 \begin_layout Enumerate
9015 Position the cursor behind the figure and insert a horizontal fill:
9017 Insert\SpecialChar menuseparator
9019 \begin_inset space ~
9022 Character\SpecialChar menuseparator
9024 \begin_inset space ~
9032 \begin_layout Enumerate
9033 Switch to \SpecialChar LaTeX
9037 \begin_inset space ~
9045 \begin_layout Enumerate
9055 Do not close the brace!
9058 \begin_layout Enumerate
9059 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
9064 \begin_inset space ~
9076 \begin_layout Standard
9077 Also, refer to the figures in the example paper.
9080 \begin_layout Subsection
9084 \begin_layout Standard
9085 For submission, the paper has to be formated in a special double-spacing
9087 For this purpose, you have to give the option
9091 to the document class.
9092 This must be done using the custom class options field in the
9094 Document\SpecialChar menuseparator
9098 Just enter the string
9105 \begin_layout Subsection
9109 \begin_layout Standard
9114 directory contains an example paper written with \SpecialChar LyX
9116 It is the example paper from the original macro package, translated to
9119 Use it for inspiration, and compare the original \SpecialChar LaTeX
9120 code with \SpecialChar LyX
9124 \begin_layout Section
9129 \begin_layout Standard
9135 \begin_layout Subsection
9139 \begin_layout Standard
9141 is a set of macros produced by the American Astronomical Society to
9142 facilitate electronic manuscript submission to the three journals they
9143 publish: the Astrophysical Journal (including the Letters and Supplement),
9144 the Astronomical Journal, and the Publications of the Astronomical Society
9147 has proven to be an excellent tool for generating these documents, especially
9148 given its equation, citation, and figure handling capabilities.
9150 requires version 5.0 (or higher) of these macros; preferably 6.0, which
9151 is the version described here, or higher.
9152 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
9153 2.09 and are fundamentally
9154 incompatible with \SpecialChar LyX
9156 The AAS\SpecialChar TeX
9157 package may be downloaded from the AAS\SpecialChar TeX
9161 \begin_layout Standard
9162 \begin_inset VSpace medskip
9168 \begin_layout Standard
9170 \begin_inset Flex URL
9173 \begin_layout Plain Layout
9175 https://aas.org/aastex/aastex-downloads
9183 \begin_layout Standard
9184 \begin_inset VSpace medskip
9190 \begin_layout Standard
9191 A complete user guide is contained in that package and you should familiarize
9192 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
9195 will not reduce the need to figure out all the AAS\SpecialChar TeX
9196 commands, it will only
9197 reduce the drudgery of typing everything in.
9198 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
9200 completely to the requirements of the journal to which you are submitting
9204 \begin_layout Subsection
9205 Starting a New Paper
9208 \begin_layout Standard
9209 I strongly suggest that you start with the AAS\SpecialChar TeX
9213 File\SpecialChar menuseparator
9220 , enter the new file name, then choose the
9225 This will show the most common fields found in a manuscript.
9226 Simply overwrite the existing text (including the brackets,
9230 ) with the correct information.
9231 Many of the AAS\SpecialChar TeX
9232 commands and environments can be implemented directly in
9235 For commands such as these, the \SpecialChar LaTeX
9236 code must be entered directly and marked
9238 Such commands are referred to as \SpecialChar TeX
9239 code, or Evil Red Text.
9240 I tried to minimize the amount of \SpecialChar TeX
9241 code needed in an AAS\SpecialChar TeX
9245 \begin_layout Subsection
9246 Finishing Your Paper
9249 \begin_layout Standard
9250 When the paper is finished to your satisfaction and previews/prints correctly,
9252 \begin_inset Quotes eld
9256 \begin_inset Quotes erd
9259 actions which need to be done before you submit it to the journals.
9263 \begin_layout Enumerate
9264 Export your paper as a \SpecialChar LaTeX
9267 File\SpecialChar menuseparator
9268 Export\SpecialChar menuseparator
9276 \begin_layout Enumerate
9281 file with your favorite text editor
9285 \begin_layout Enumerate
9286 remove the comment lines before the
9295 \begin_layout Enumerate
9300 usepackage...{fontenc}
9302 line if it appears (usually just after
9317 \begin_layout Enumerate
9318 remove everything between (and including) the
9330 commands, except for any commands you specifically put into the \SpecialChar LaTeX
9332 (which should appear immediately after the
9333 \begin_inset Quotes eld
9336 User specified \SpecialChar LaTeX
9338 \begin_inset Quotes erd
9349 \begin_layout Enumerate
9350 Run the resulting file through \SpecialChar LaTeX
9351 to make sure it still processes correctly.
9354 \begin_layout Enumerate
9355 Reread the journal requirements to make sure your filenames and formats
9359 \begin_layout Enumerate
9363 \begin_layout Subsection
9364 Comments On Specific Commands
9367 \begin_layout Standard
9368 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9375 ) gives a good description of each.
9376 Thus it's probably easiest for me to go down the list as found in the guide
9377 and offer comments where necessary.
9378 So let's begin \SpecialChar ldots
9382 \begin_layout Subsubsection
9383 Things that work as expected
9386 \begin_layout Standard
9387 Because they work as you might expect, I simply list them and the section
9488 begin{thebibliography}
9496 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9497 graphicx figure commands (2.14.1),
9521 (2.15.4, amongst other places),
9548 \begin_layout Standard
9549 The following style options also work correctly:
9570 Simply put them in the
9576 Layout\SpecialChar menuseparator
9582 \begin_layout Subsubsection
9583 Things that work, but require more comment
9586 \begin_layout Standard
9587 The following items work, but require a little more discussion:
9590 \begin_layout Itemize
9591 These items are reserved for use by the journal editors, but you can put
9592 them into the \SpecialChar LaTeX
9593 preamble if you feel compelled to do so:
9626 \begin_layout Itemize
9627 These items may be placed in the \SpecialChar LaTeX
9628 preamble, and are included as blanks in
9650 \begin_layout Itemize
9657 (2.3) – can only be used
9658 \begin_inset Quotes eld
9662 \begin_inset Quotes erd
9665 , not in the middle of a paragraph.
9666 Use \SpecialChar TeX
9667 code if you need to embed it.
9670 \begin_layout Itemize
9677 (2.3) – will have extra {} after it.
9678 This should not cause an error.
9681 \begin_layout Itemize
9688 (2.6) – can only be used
9689 \begin_inset Quotes eld
9693 \begin_inset Quotes erd
9696 , not in the middle of a paragraph.
9697 Use \SpecialChar TeX
9698 code if you need to embed it.
9701 \begin_layout Itemize
9708 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9712 \begin_layout Itemize
9726 \begin_layout Itemize
9733 (2.9) – will have extra {} after it.
9734 This should not cause an error.
9737 \begin_layout Itemize
9744 (2.11) – will have extra {} after it.
9745 This should not cause an error.
9748 \begin_layout Itemize
9755 (2.14.2) – you can insert an optional filename argument by placing the cursor
9756 at the beginning of the text and selecting
9758 Insert\SpecialChar menuseparator
9763 \begin_inset Quotes eld
9767 \begin_inset Quotes erd
9770 inserts an optional argument of the type needed by
9777 Hopefully it will be renamed someday.
9780 \begin_layout Itemize
9793 for the catalog ID optional parameter
9796 \begin_layout Itemize
9809 for the catalog ID optional parameter
9812 \begin_layout Subsubsection
9813 Things not implemented, use \SpecialChar TeX
9817 \begin_layout Standard
9828 setcounter{equation}
9830 (2.12), Journal name abbreviations (2.13.4),
9866 (2.15.4, insert it as the first element in the lefthand cell after where
9868 Don't use any of \SpecialChar LyX
9869 's rules in the table),
9881 (2.15.5), much of Misc (2.17, except
9932 \begin_layout Subsubsection
9933 Things that cannot be implemented
9936 \begin_layout Standard
9938 at least in any meaningful sort of way, so I suggest ignoring them.
9939 They are the references environment (2.13.3), and the deluxetable environment
9941 If you really, really need to use deluxetable, I suggest editing it in
9942 a separate file with a text editor, then using
9944 Insert\SpecialChar menuseparator
9946 \begin_inset space ~
9951 to include it in your \SpecialChar LyX
9957 file to see an example of this.
9960 \begin_layout Subsection
9961 FAQs, Tips, Tricks, and Other Ruminations
9964 \begin_layout Subsubsection
9965 Getting \SpecialChar LyX
9966 and AAS\SpecialChar TeX
9970 \begin_layout Standard
9971 It can be a bit tricky to get \SpecialChar LyX
9972 to recognize a new layout and document class.
9973 When all else fails, do this:
9976 \begin_layout Enumerate
9977 Make certain that \SpecialChar LaTeX
9978 can find AAS\SpecialChar TeX
9980 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9982 directory completely unrelated to \SpecialChar LaTeX
9983 or AAS\SpecialChar TeX
9984 and run \SpecialChar LaTeX
9992 \begin_layout Enumerate
9997 appears in \SpecialChar LyX
10005 \begin_layout Enumerate
10008 Tools\SpecialChar menuseparator
10011 in \SpecialChar LyX
10012 , then restart \SpecialChar LyX
10016 \begin_layout Enumerate
10017 Open a regular new file, not from a template.
10018 Does AAS\SpecialChar TeX
10019 appear in the class list in
10021 Document\SpecialChar menuseparator
10027 \begin_layout Standard
10028 If you get a warning from an existing AAS\SpecialChar TeX
10029 document about not being able
10030 to find the AAS\SpecialChar TeX
10031 layout or a message about
10032 \begin_inset Quotes eld
10035 You should not mix title layouts with normal ones
10036 \begin_inset Quotes erd
10039 , things haven't been installed correctly.
10042 \begin_layout Subsubsection
10044 error processing a table
10047 \begin_layout Standard
10049 , by default, attempts to center the table caption/title.
10050 This seems to produce a bad interaction in AAS\SpecialChar TeX
10051 so you should click somewhere
10052 in the caption/title, then select
10054 Edit\SpecialChar menuseparator
10056 \begin_inset space ~
10070 This took care of it for me.
10073 \begin_layout Subsubsection
10077 \begin_layout Standard
10078 A couple of things: 1) I have noticed some funny spacing in the reference
10079 entries in the text.
10080 When you enter the bibliography item data, make sure their is
10084 space between the last author and the parenthesis setting off the year;
10088 \begin_inset space \thinspace{}
10092 \begin_inset space \space{}
10106 2) Entering the references at all is not obvious.
10107 The easiest thing is to start typing your first reference at the end of
10108 the document, then mark it as type
10113 That will put a small gray box in front of what you just typed.
10114 Click on the box to fill in the rest of the information.
10115 For new references, go to the end of an existing reference and press return.
10116 That will create a new line with its own box, etc.
10119 \begin_layout Subsubsection
10120 Including EPS files
10123 \begin_layout Standard
10124 Even though AAS\SpecialChar TeX
10125 provides its own figure commands (
10131 , for example), I much prefer \SpecialChar LaTeX
10132 's standard figure commands (with the default
10141 \begin_inset space ~
10144 commands as \SpecialChar TeX
10145 code into a Figure Float box if you desire, but I never have
10146 much luck getting the layout right.
10147 With the standard graphics, \SpecialChar LyX
10152 usepackage{graphicx}
10154 command into the \SpecialChar LaTeX
10155 preamble and handle the figures in the standard \SpecialChar LaTeX2e
10157 interspersing the figures in the text.
10158 I believe ApJ accepts figures exactly this way now; AJ might still use
10160 \begin_inset Quotes eld
10163 stack everything at the end
10164 \begin_inset Quotes erd
10170 \begin_layout Subsubsection
10171 Things I could have done, but didn't
10174 \begin_layout Standard
10176 \begin_inset Quotes eld
10180 \begin_inset Quotes erd
10183 things I could have implemented, but chose not to.
10184 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
10186 even though it is double-spaced in the paper manuscript.
10187 Also, I chose not to make separate layouts for the preprint and preprint2
10189 Since I assume you will spend most of your time in the plain manuscript
10190 mode anyway, I decided not to chew up more disk space with this.
10194 \begin_layout Subsection
10198 \begin_layout Standard
10199 Your mileage may vary.
10200 I've now had papers published by both ApJ and AJ that have had 98% of the
10201 effort done in \SpecialChar LyX
10202 ; the last 2% was the \SpecialChar LaTeX
10203 post-processing and a few cleanups.
10204 I have had no trouble with the submission process, and I'm sure the journals
10205 were never aware that there might be a difference.
10206 So, go forth and publish!
10209 \begin_layout Section
10210 AMS \SpecialChar LaTeX
10214 \begin_layout Standard
10221 Richard Kimberly Heck
10224 \begin_layout Standard
10225 \begin_inset VSpace bigskip
10231 \begin_layout Standard
10233 The AMS \SpecialChar LaTeX
10234 layouts are set up to conform to suggested styles for mathematical
10235 papers to be submitted to American Mathematical Society publications.
10236 The layouts are not tailored to a specific journal, but easily can be.
10237 You should refer to the AMS documentation for specific instructions for
10238 each journal (usually it will entail only changing a single line in the
10241 That documentation is available on the Web at
10242 \begin_inset Flex URL
10245 \begin_layout Plain Layout
10253 \begin_inset Flex URL
10256 \begin_layout Plain Layout
10258 ftp://ftp.ams.org/pub/tex/amslatex/
10264 These layouts are appropriate, and useful, for any mathematical writing.
10268 \begin_layout Standard
10269 There are two basic AMS \SpecialChar LaTeX
10273 \begin_layout Itemize
10274 amsart: The standard AMS article format.
10277 \begin_layout Itemize
10278 amsbook: the standard AMS book (really, monograph) format.
10282 \begin_layout Standard
10283 The layouts themselves contain only the minimum necessary to use the AMS
10285 They do not, in particular, contain any of the `theorem' environments used
10286 for setting theorems, lemmas, and the like.
10287 These are contained, instead, in the
10288 \begin_inset Flex Code
10291 \begin_layout Plain Layout
10297 module, which is loaded by default when you select one of the AMS classes.
10298 (It can also be used with other classes and can be removed, if you would
10299 rather use something else.) Less commonly used environments are in the
10300 \begin_inset Flex Code
10303 \begin_layout Plain Layout
10304 Theorems (AMS-Extended)
10309 module, which must be loaded manually.
10312 \begin_layout Standard
10313 By default, theorems and the like are numbered consecutively throughout
10314 the document, but this may be modified by loading the module
10315 \begin_inset Flex Code
10318 \begin_layout Plain Layout
10319 Theorems (Order by Section)
10324 or, if you are using
10325 \begin_inset Flex Code
10328 \begin_layout Plain Layout
10335 \begin_inset Flex Code
10338 \begin_layout Plain Layout
10339 Theorems (Order by Chapter)
10345 These will number the results as
10346 \begin_inset Formula $n.m$
10349 , where the first number refers to the section (or chapter) and the second
10350 refers to the total number of results so far in that section (or chapter).
10351 Many environments are also available unnumbered.
10352 These are indicated by an asterisk at the end.
10353 If you happen to want
10357 unnumbered results, the module
10358 \begin_inset Flex Code
10361 \begin_layout Plain Layout
10367 provides that option.
10370 \begin_layout Standard
10371 Note that these modules do not
10375 to be used with the AMS classes.
10376 It is perfectly possible to use the
10377 \begin_inset Flex Code
10380 \begin_layout Plain Layout
10386 module, and the others mentioned, with other classes, such as
10387 \begin_inset Flex Code
10390 \begin_layout Plain Layout
10397 \begin_inset Flex Code
10400 \begin_layout Plain Layout
10407 \begin_inset Flex Code
10410 \begin_layout Plain Layout
10419 \begin_layout Subsection
10420 What these layouts provide
10423 \begin_layout Standard
10424 There is a long list of included environments provided by these layouts.
10425 In AMS-\SpecialChar LaTeX
10426 , there is, in fact, an opportunity to define an unlimited variety
10427 of `theorem' environments.
10428 However, the AMS recommends the environments that are available in \SpecialChar LyX
10433 \begin_layout Standard
10434 The following environments—as well as the standard environments, such as
10436 \begin_inset Flex Noun
10439 \begin_layout Plain Layout
10446 \begin_inset Flex Noun
10449 \begin_layout Plain Layout
10456 \begin_inset Flex Noun
10459 \begin_layout Plain Layout
10466 \begin_inset Flex Noun
10469 \begin_layout Plain Layout
10476 \begin_inset Flex Noun
10479 \begin_layout Plain Layout
10486 \begin_inset Flex Code
10489 \begin_layout Plain Layout
10496 \begin_inset Flex Code
10499 \begin_layout Plain Layout
10508 \begin_layout Description
10509 Address This should be the author's permanent address.
10512 \begin_layout Description
10514 \begin_inset space ~
10517 Address This should be the author's temporary address at the time of submission,
10518 if different from the Address.
10521 \begin_layout Description
10522 Email Author's e-mail address
10525 \begin_layout Description
10526 URL Author's Web address, if desired.
10529 \begin_layout Description
10530 Keywords Key words or phrases used to identify specific topics discussed
10534 \begin_layout Description
10535 Subjectclass These refer to the AMS Subject Classifications, published and
10538 Mathematical Reviews
10541 These are also available online at the AMS cites listed above.
10544 \begin_layout Description
10548 \begin_layout Description
10552 \begin_layout Description
10556 \begin_layout Standard
10557 The following environments are provided by both the
10558 \begin_inset Flex Code
10561 \begin_layout Plain Layout
10568 \begin_inset Flex Code
10571 \begin_layout Plain Layout
10577 modules, in the latter case in both starred (unnumbered) and unstarred
10578 (numbered) versions.
10579 These same environments are provided only in the starred versions by the
10581 \begin_inset Flex Code
10584 \begin_layout Plain Layout
10593 \begin_layout Theorem
10594 This is typically used for the statements of major results.
10598 \begin_layout Corollary*
10599 This is used for statements which follow fairly directly from previous statement
10601 Again, these can be major results.
10605 \begin_layout Lemma
10606 These are smaller results needed to prove other statements.
10609 \begin_layout Proposition
10610 These are less major results which (hopefully) add to the general theory
10614 \begin_layout Conjecture
10615 These are statements provided without justification, which the author does
10616 not know how to prove, but which seem to be true (to the author, at least).
10619 \begin_layout Definition*
10620 Guess what this is for.
10621 The font is different for this environment than for the previous ones.
10625 \begin_layout Example*
10626 Used for examples illustrating proven results.
10629 \begin_layout Problem
10630 It's not really known what this is for.
10631 You should figure it out.
10634 \begin_layout Exercise*
10635 Write a description for this one.
10638 \begin_layout Remark
10639 This environment is also a type of theorem, usually a lesser sort of observation.
10642 \begin_layout Claim*
10643 Often used in the course of giving a proof of a larger result.
10647 Generally, these are used to break up long arguments, using specific instances
10653 The numbering scheme for cases is on its own, not together with other numbered
10658 \begin_layout Proof
10659 At the end of this environment, a QED symbol (usually a square, but it can
10660 vary with different styles) is placed.
10661 If you want to have other environments within this one—for example, Case
10662 environments—and have the QED symbol appear only after them, then the other
10663 environments need to be nested within the proof environment.
10666 Nesting Environments
10672 for information on nesting.
10675 \begin_layout Standard
10676 And these environments are provided by
10677 \begin_inset Flex Code
10680 \begin_layout Plain Layout
10681 Theorems (AMS-Extended)
10689 \begin_layout Criterion*
10690 A required condition.
10693 \begin_layout Algorithm*
10694 A general procedure to be used.
10697 \begin_layout Axiom*
10698 This is a property or statement taken as true within the system being discussed.
10701 \begin_layout Condition*
10702 Sometimes used to state a condition assumed within the present context of
10706 \begin_layout Note*
10707 Similar to a Remark.
10710 \begin_layout Notation*
10711 Used for the explanation of, yes, notation.
10714 \begin_layout Summary
10715 Do we really need to tell you?
10718 \begin_layout Acknowledgement*
10722 \begin_layout Conclusion*
10723 Sometimes used at the end of a long train of argument.
10727 Used in a way similar to Proposition, though perhaps lower on the scale.
10730 \begin_layout Standard
10731 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10734 They need to be available on your system in order to use these environments.
10737 \begin_layout Section
10741 \begin_layout Standard
10747 \begin_layout Subsection
10751 \begin_layout Standard
10752 Broadway is for writing plays.
10753 The format is more decorative than Hollywood, and much less standardized.
10754 This format should be suitable for workshops.
10757 \begin_layout Subsection
10761 \begin_layout Standard
10762 The same as in Hollywood.
10765 \begin_layout Subsection
10769 \begin_layout Standard
10774 names as labels then cross-reference the label to insert the name.
10775 The cross-reference dialog will show the current cast of characters.
10778 \begin_layout Subsection
10779 Paper size and Margins
10782 \begin_layout Standard
10783 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10786 \begin_layout Subsection
10790 \begin_layout Standard
10791 The following environments are available.
10792 You can use broadway.bind to get the bind keys shown at the right.
10795 \begin_layout Itemize
10799 \begin_inset Newline newline
10804 You should not have to use this, but it is here for anything that does not
10808 \begin_layout Itemize
10812 \begin_inset space \hfill{}
10816 \begin_inset Newline newline
10821 Used to describe stage setting and the action.
10822 First use of speaker names in all CAPs.
10825 \begin_layout Itemize
10829 \begin_inset space \hfill{}
10833 \begin_inset Newline newline
10838 Automatically numbered.
10839 On screen it will be arabic, but will print as Roman.
10842 \begin_layout Itemize
10846 \begin_inset space \hfill{}
10850 \begin_inset Newline newline
10860 It is just centered text.
10863 \begin_layout Itemize
10867 \begin_inset space \hfill{}
10871 \begin_inset Newline newline
10876 Not automatically numbered.
10877 You supply the number.
10878 This is because I couldn't figure out how.
10881 \begin_layout Itemize
10885 \begin_inset space \hfill{}
10889 \begin_inset Newline newline
10894 A special case of Narrative to describe the setting and action as the curtain
10898 \begin_layout Itemize
10902 \begin_inset space \hfill{}
10906 \begin_inset Newline newline
10911 The speaker's (actor's) title, centered in all CAPS.
10914 \begin_layout Itemize
10918 \begin_inset space \hfill{}
10922 \begin_inset Newline newline
10927 Instructions to the speaker.
10928 The parentheses are automatically inserted.
10929 The ( will appear on screen, but both will be in the printed play.
10930 This environment is only used within
10937 \begin_layout Itemize
10941 \begin_inset space \hfill{}
10945 \begin_inset Newline newline
10950 What the Speaker says.
10953 \begin_layout Itemize
10957 \begin_inset space \hfill{}
10961 \begin_inset Newline newline
10966 The curtain comes down.
10969 \begin_layout Itemize
10973 \begin_inset space \hfill{}
10979 \begin_layout Itemize
10983 \begin_inset space \hfill{}
10989 \begin_layout Itemize
10993 \begin_inset space \hfill{}
10999 \begin_layout Standard
11003 \begin_layout Section
11007 \begin_layout Standard
11012 can be used to type letters according to German conventions.
11013 A template file is included in
11015 .../lyx/share/templates
11017 for you to use as a starting point.
11020 \begin_layout Section
11024 \begin_layout Standard
11025 See the \SpecialChar LyX
11031 It contains all infos you need.
11034 \begin_layout Section
11037 Foil\SpecialChar TeX
11041 \begin_inset CommandInset label
11050 \begin_layout Standard
11056 \begin_layout Subsection
11060 \begin_layout Standard
11061 This section describes how to use \SpecialChar LyX
11062 to make slides for overhead projectors.
11063 There are two document classes that can do this: the default slides class
11066 Foil\SpecialChar TeX
11070 This section documents the latter.
11073 \begin_layout Standard
11074 I'm going to say this again, nice and clear, so that there's no misunderstanding
11078 \begin_layout Standard
11079 \begin_inset VSpace bigskip
11085 \begin_layout Standard
11089 This section documents the class
11090 \begin_inset Quotes eld
11098 \begin_inset Quotes erd
11106 \begin_layout Standard
11107 \begin_inset VSpace bigskip
11113 \begin_layout Standard
11114 If you're looking for the documentation for
11115 \begin_inset Quotes eld
11123 \begin_inset Quotes erd
11126 , check out section
11127 \begin_inset space ~
11131 \begin_inset CommandInset ref
11133 reference "sec:slitex"
11138 If your machine doesn't have the
11146 installed, you'll probably have to use the default
11150 class, which isn't quite as good as
11155 \begin_layout Standard
11160 class is designed for use with version
11161 \begin_inset space ~
11169 class file which is now an integral part of \SpecialChar LaTeX2e
11173 \begin_layout Subsection
11177 \begin_layout Standard
11178 Obviously, to use this document class, you need to select
11189 \begin_inset space ~
11195 There are some settings in the
11198 \begin_inset space ~
11203 dialog that you should know about that are specific to this class:
11206 \begin_layout Itemize
11207 Don't change the options
11218 \begin_inset space ~
11224 They're ignored by the
11231 \begin_layout Itemize
11232 The default font size is 20
11233 \begin_inset space \thinspace{}
11236 pt with the other options being 17
11237 \begin_inset space \thinspace{}
11241 \begin_inset space \thinspace{}
11245 \begin_inset space \thinspace{}
11251 \begin_layout Itemize
11252 The default font is
11260 but all math equations are still typeset in the usual roman font.
11263 \begin_layout Itemize
11266 Foil\SpecialChar TeX
11269 supports A4 and Letter paper sizes as well as a special size for working
11271 \begin_inset space \thinspace{}
11275 It doesn't support A5, B5, legal or executive paper sizes.
11278 \begin_layout Itemize
11279 Don't bother changing the
11283 settings because they are ignored anyway.
11284 All floats appear where they are defined in the text.
11287 \begin_layout Itemize
11292 setting behaves a bit differently for this class.
11295 Foil\SpecialChar TeX
11298 provides extensive footer and header capabilities including a user-defined
11301 \begin_inset space ~
11305 \begin_inset CommandInset ref
11307 reference "sec:foilfoot"
11312 The title page is treated differently to all other pages in the document
11321 has the logo centered at the bottom of the page (if one is defined).
11322 The possible page style choices and what they do are as follows:
11326 \begin_layout Labeling
11327 \labelwidthstring MMMMMMM
11334 The final output contains no page numbers, or other headers or footers
11335 (except footnotes of course).
11339 \begin_layout Labeling
11340 \labelwidthstring MMMMMMM
11347 The final output contains page numbers centered at the bottom of the page.
11348 No other headings or footers (other than footnotes).
11351 \begin_layout Labeling
11352 \labelwidthstring MMMMMMM
11357 Page numbers in lower right corner.
11358 Additional headers and footers are also shown.
11359 This is also the default.
11362 \begin_layout Labeling
11363 \labelwidthstring MMMMMMM
11368 Gives you access to the
11372 package although its use with
11374 Foil\SpecialChar TeX
11377 is discouraged by the writer of the
11379 Foil\SpecialChar TeX
11382 package because of some potential page layout clashes.
11386 \begin_layout Subsubsection
11390 \begin_layout Standard
11391 The following options may be used in the extra class options in the
11393 Document\SpecialChar menuseparator
11399 \begin_layout Labeling
11400 \labelwidthstring MMMMMMx
11405 This sets up the page layout for 7.33
11406 \begin_inset space \thinspace{}
11410 \begin_inset space \thinspace{}
11413 in paper, which is about the same aspect ratio as a 35
11414 \begin_inset space \thinspace{}
11417 mm slide, making it a bit easier to work with this medium.
11420 \begin_layout Labeling
11421 \labelwidthstring MMMMMMx
11426 Places a rule across the page below the header on every page except the
11430 \begin_layout Labeling
11431 \labelwidthstring MMMMMMx
11436 Places a rule across the page above the footer on every page except the
11440 \begin_layout Labeling
11441 \labelwidthstring MMMMMMx
11446 This is automatically set each time you create a new
11453 Foil\SpecialChar TeX
11456 to use the dvips driver to rotate those pages that are set as landscape
11460 \begin_layout Labeling
11461 \labelwidthstring MMMMMMx
11466 Simply changes the page dimensions to those of a landscape page but doesn't
11468 Thus if you use this option you need to use an external program to rotate
11469 each page or feed your paper through your printer as landscape.
11470 Note that this option effectively reverses the roles of the
11478 environments (don't worry these are described in the next section).
11481 \begin_layout Labeling
11482 \labelwidthstring MMMMMMx
11487 Equation numbers on the left.
11490 \begin_layout Labeling
11491 \labelwidthstring MMMMMMx
11496 Flush-left equations.
11499 \begin_layout Subsection
11500 Supported Environments
11503 \begin_layout Standard
11504 Most of the environments commonly supported in other classes are also supported
11510 There are several additional environments provided by
11512 Foil\SpecialChar TeX
11515 as well as a couple added by \SpecialChar LyX
11517 The following environments are shared with other classes:
11520 \begin_layout Standard
11521 \begin_inset Flex Multiple Columns
11524 \begin_layout Itemize
11530 \begin_layout Itemize
11536 \begin_layout Itemize
11542 \begin_layout Itemize
11548 \begin_layout Itemize
11554 \begin_layout Itemize
11561 \begin_layout Itemize
11567 \begin_layout Itemize
11573 \begin_layout Itemize
11579 \begin_layout Itemize
11585 \begin_layout Itemize
11591 \begin_layout Itemize
11597 \begin_layout Itemize
11603 \begin_layout Itemize
11609 \begin_layout Itemize
11620 \begin_layout Standard
11621 That is, all the major environments apart from the sectioning environments.
11622 Since foils are essentially self-contained sections, with a title and body,
11625 Foil\SpecialChar TeX
11628 provides specific commands for starting new foils and these are:
11631 \begin_layout Itemize
11637 \begin_layout Itemize
11643 \begin_layout Standard
11645 also provides slightly modified versions of these two environments called:
11648 \begin_layout Itemize
11654 \begin_layout Itemize
11657 ShortRotatefoilhead
11660 \begin_layout Standard
11661 and the differences will be explained in the next section.
11664 \begin_layout Standard
11665 Since foils are often used in presenting ideas or new theorems and such
11668 Foil\SpecialChar TeX
11671 also provides a comprehensive box of goodies for presenting them:
11674 \begin_layout Standard
11675 \begin_inset Flex Multiple Columns
11678 \begin_layout Itemize
11684 \begin_layout Itemize
11690 \begin_layout Itemize
11696 \begin_layout Itemize
11702 \begin_layout Itemize
11708 \begin_layout Itemize
11714 \begin_layout Itemize
11720 \begin_layout Itemize
11726 \begin_layout Itemize
11732 \begin_layout Itemize
11738 \begin_layout Itemize
11749 \begin_layout Standard
11750 The starred versions are unnumbered while the unstarred versions are numbered.
11751 There are also two list environments added by \SpecialChar LyX
11755 \begin_layout Itemize
11761 \begin_layout Itemize
11767 \begin_layout Standard
11770 Foil\SpecialChar TeX
11773 provides some powerful header and footer capabilities that are best set
11774 in the preamble although they may be set at any point in a document.
11775 If you want to change these settings in your document the best place to
11776 do so is at the very top of a foil, i.
11777 \begin_inset space \thinspace{}
11783 \begin_inset space \space{}
11788 straight after the foilhead.
11791 \begin_layout Standard
11792 For this purpose, the following command styles are provided [
11799 \begin_layout Standard
11800 \begin_inset Flex Multiple Columns
11803 \begin_layout Itemize
11807 \begin_inset space ~
11813 \begin_layout Itemize
11819 \begin_layout Itemize
11823 \begin_inset space ~
11829 \begin_layout Itemize
11833 \begin_inset space ~
11839 \begin_layout Itemize
11843 \begin_inset space ~
11850 \begin_layout Plain Layout
11851 \begin_inset space ~
11863 \begin_layout Standard
11864 There are also a few commands provided by
11866 Foil\SpecialChar TeX
11869 that aren't directly supported by \SpecialChar LyX
11870 but I'll tell you what they do and how
11871 to use them in section
11872 \begin_inset space ~
11876 \begin_inset CommandInset ref
11878 reference "sec:unsuppfoils"
11885 \begin_layout Subsection
11886 Building a Set of Foils
11889 \begin_layout Standard
11890 This section will give a simple introduction to using the different environments
11891 to build a set of foils.
11892 If you want to see an example set of foils, take a look at the
11896 file you find in \SpecialChar LyX
11904 \begin_layout Subsubsection
11905 Give It a Title Page
11908 \begin_layout Standard
11909 Unlike other classes that provide
11929 creates the title on a page of its own.
11930 If you leave out the
11934 environment \SpecialChar LaTeX
11935 will substitute the current date (every time you regenerate
11939 \begin_layout Subsubsection
11943 \begin_layout Standard
11944 As I mentioned earlier, there are four ways of starting a new foil.
11945 For portrait foils you should use
11954 The difference between these two environments is the amount of space between
11955 the title of the foil (the foilhead) and the body of the foil.
11958 \begin_layout Standard
11959 Landscape foils are generated using the
11965 ShortRotatefoilhead
11968 Again the only difference is the spacing between foilhead and body.
11969 Both of the short versions have 0.5
11970 \begin_inset space ~
11973 inches less separation between the foilhead and the body.
11977 \begin_layout Standard
11978 One problem with the support for landscape foils is the requirement that
11979 you have to use the
11983 driver to generate the PostScript output otherwise the foils won't be rotated.
11984 It is possible to get landscape foils even if you haven't got the
11988 driver provided you can feed your foils sideways through your printer ;-)
11991 \begin_layout Subsubsection
11992 Theorems, Lemmas, Proofs and more
11995 \begin_layout Standard
11996 You can't have two of the same type of these environments directly following
11998 If you use a normal paragraph break, , you will just be extending the previous
11999 environment as if you had merged the two environments together.
12000 Rather than that, you need to insert a so-called separator.
12001 Please refer to the section entitled
12012 \begin_layout Subsubsection
12016 \begin_layout Standard
12017 You get all the commonly supported list styles found in other classes as
12018 well as two new ones.
12019 I'll only describe the new ones here.
12020 If you want to find out more about the other list environments check out
12026 If you intend to use itemized lists you might also want to read about the
12030 \begin_inset space ~
12034 \begin_inset space ~
12039 dialog described above in section
12040 \begin_inset space ~
12044 \begin_inset CommandInset ref
12046 reference "sec:bullet"
12053 \begin_layout Standard
12054 The two new list styles,
12062 , are designed to make it easier for you to create lists of do's and don'ts
12063 or right and wrong by providing dedicated environments that use a tick
12064 or a cross as the label of the list.
12065 These lists are in fact dedicated variants of the
12070 They do however require that you have the
12074 packages installed.
12077 \begin_layout Subsubsection
12081 \begin_layout Standard
12084 Foil\SpecialChar TeX
12087 redefines the floating tables and figures so that they appear exactly where
12088 they are in the text rather than pushing them to the top of the page or
12089 to some user specified location.
12090 In fact if you change the float placement settings they are simply ignored.
12093 \begin_layout Subsubsection
12094 Page Headers and Footers
12095 \begin_inset CommandInset label
12097 name "sec:foilfoot"
12104 \begin_layout Standard
12108 \begin_inset space ~
12117 are two commands used to control the left-footer text string.
12118 The first is meant to allow you to include a graphic logo on your foils
12120 \begin_inset Quotes eld
12125 Foil\SpecialChar TeX
12129 \begin_inset Quotes erd
12133 While the second is meant to provide a classification for the audience,
12137 \begin_inset space \thinspace{}
12143 \begin_inset space \space{}
12147 It is empty by default.
12150 \begin_layout Standard
12151 The remaining page corners can be filled by
12154 \begin_inset space ~
12159 (which defaults to page numbers),
12162 \begin_inset space ~
12170 \begin_inset space ~
12178 \begin_layout Subsection
12181 Foil\SpecialChar TeX
12185 \begin_inset CommandInset label
12187 name "sec:unsuppfoils"
12194 \begin_layout Standard
12195 All the commands mentioned below need to be set in a
12205 within another environment.
12208 \begin_layout Subsubsection
12212 \begin_layout Standard
12213 All lengths are adjusted using the
12236 should be replaced by the name given to the length you want to change and
12241 is the length value.
12242 All lengths should be specified in units of length such as inches (
12254 ) or relative to some document or font-based length such as
12264 \begin_layout Standard
12265 It's possible to change the spacing between a foilhead and the body of the
12266 foil by adjusting the length specified by
12273 For example, to make
12278 \begin_inset space \space{}
12281 in closer to their bodies put the following in the preamble:
12287 foilheadskip}{-0.5in}
12290 \begin_layout Standard
12291 The spacings around floats can be adjusted by setting these lengths:
12294 \begin_layout Labeling
12295 \labelwidthstring MMMMMMMMMMM
12302 Separation between the text and the top of the float
12305 \begin_layout Labeling
12306 \labelwidthstring MMMMMMMMMMM
12313 Separation between the float and the caption
12316 \begin_layout Labeling
12317 \labelwidthstring MMMMMMMMMMM
12324 Separation between the caption and the following text
12327 \begin_layout Labeling
12328 \labelwidthstring MMMMMMMMMMM
12335 You can make the captions narrower than the surrounding text by adjusting
12337 Best done relative to
12346 \begin_layout Standard
12347 There are also several title page related lengths that you may find useful
12348 if you have a long title or several authors:
12351 \begin_layout Labeling
12352 \labelwidthstring MMMMMMMMMMM
12359 Separation from headers to
12364 \begin_layout Labeling
12365 \labelwidthstring MMMMMMMMMMM
12383 \begin_layout Labeling
12384 \labelwidthstring MMMMMMMMMMM
12398 \begin_layout Labeling
12399 \labelwidthstring MMMMMMMMMMM
12415 \begin_layout Labeling
12416 \labelwidthstring MMMMMMMMMMM
12432 \begin_layout Standard
12433 The last length related command affects all the list environments.
12444 a list environment then all the vertical spacing between the list items
12446 Note that this is a command not a length so it doesn't require
12452 like the stuff mentioned above.
12455 \begin_layout Subsubsection
12456 Headers and Footers
12459 \begin_layout Standard
12472 commands control whether the logo in the
12476 definition appear on a given page.
12483 in the preamble then none of the foils will have the logo on them.
12484 If you don't want the logo on a particular page place the
12490 directly after the foilhead of that page and the
12496 directly after the next foilhead.
12499 \begin_layout Standard
12500 If you decide to use the
12504 page style setting in the
12507 \begin_inset space ~
12512 dialog you should probably add
12522 to your preamble so headers and footers on landscape pages are correctly
12523 placed when rotated.
12524 This is due to some clashes between the page layouts provided by the
12535 \begin_layout Section
12536 Hollywood (Hollywood spec scripts)
12539 \begin_layout Standard
12545 \begin_layout Subsection
12549 \begin_layout Standard
12550 Getting the format of a Hollywood script right is a
12551 \begin_inset Quotes eld
12555 \begin_inset Quotes erd
12558 It is designed to make the readers focus on content and to be easy and
12559 familiar for the actors to read.
12560 Each page of a script should be one minute of film.
12561 Nothing goes in a script that you cannot see or hear on screen.
12562 The courier 12 pt font should be used throughout.
12566 \begin_layout Subsection
12570 \begin_layout Standard
12571 Speakers' lines should NEVER break in mid-sentence.
12572 If a speaker's lines continue over a page break, repeat the
12576 title followed by (Cont'd).
12579 \begin_layout Subsection
12583 \begin_layout Standard
12588 names as labels then cross-reference the label to insert the name.
12589 The cross-reference dialog will show the current cast of characters.
12590 You can use this to insert the speaker name in narratives also.
12593 \begin_layout Subsection
12594 Paper size and Margins
12597 \begin_layout Standard
12598 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12601 \begin_layout Subsection
12605 \begin_layout Standard
12606 The following environments are available.
12607 You can use hollywood.bind to get the bind keys shown at the right.
12610 \begin_layout Itemize
12614 \begin_inset Newline newline
12619 Used where nothing else works.
12623 \begin_layout Itemize
12629 \begin_inset space \hfill{}
12637 \begin_inset Newline newline
12640 Usually followed by something like
12641 \begin_inset Quotes eld
12644 on Sally waking up.
12645 \begin_inset Quotes erd
12651 \begin_layout Itemize
12655 \begin_inset space \hfill{}
12659 \begin_inset Newline newline
12664 Introduces a new INTERIOR camera set-up.
12665 Always followed by DAY or NIGHT, or something similar to define the lighting
12667 Everthing on this line in CAPS.
12670 \begin_layout Itemize
12674 \begin_inset space \hfill{}
12678 \begin_inset Newline newline
12683 Introduces a new EXTERIOR camera set-up.
12684 Everthing on this line in CAPS.
12687 \begin_layout Itemize
12691 \begin_inset space \hfill{}
12695 \begin_inset Newline newline
12700 The character speaking.
12703 \begin_layout Itemize
12707 \begin_inset space \hfill{}
12711 \begin_inset Newline newline
12716 Instructions to the speaker.
12717 The () are automatically inserted.
12720 \begin_layout Itemize
12724 \begin_inset space \hfill{}
12728 \begin_inset Newline newline
12740 \begin_layout Itemize
12744 \begin_inset space \hfill{}
12748 \begin_inset Newline newline
12753 Camera movement instruction.
12755 \begin_inset space \thinspace{}
12759 \begin_inset space \space{}
12765 \begin_layout Itemize
12769 \begin_inset space \hfill{}
12775 \begin_layout Itemize
12779 \begin_inset space \hfill{}
12785 \begin_layout Itemize
12789 \begin_inset space \hfill{}
12795 \begin_layout Itemize
12799 \begin_inset space \hfill{}
12805 \begin_layout Subsection
12809 \begin_layout Itemize
12813 \begin_layout Itemize
12817 \begin_layout Itemize
12819 \begin_inset space \thinspace{}
12826 \begin_layout Itemize
12831 \begin_layout Itemize
12832 PAN — camera movement
12835 \begin_layout Itemize
12836 INSERT — cut to close-up of
12839 \begin_layout Section
12843 \begin_layout Standard
12846 Panayotis Papasotiriou
12849 \begin_layout Subsection
12853 \begin_layout Standard
12854 The ijmpc package is a set of macros that facilitates electronic manuscript
12857 International Journal of Modern Physics C
12860 Similarly, the ijmpd package is for creating manuscripts to be submitted
12863 International Journal of Modern Physics D
12866 Both journals are published by World Scientific.
12867 The corresponding document classes are named
12876 These files, together with instructions for the authors, can be downloaded
12878 \begin_inset Flex URL
12881 \begin_layout Plain Layout
12883 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12889 \begin_inset Flex URL
12892 \begin_layout Plain Layout
12894 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12900 Both packages are modified versions of the standard
12901 \begin_inset Quotes eld
12905 \begin_inset Quotes erd
12908 package, and they are almost (but not exactly) identical.
12909 Most of their features are supported by \SpecialChar LyX
12911 I have used \SpecialChar LyX
12912 successfully to write articles submitted to both journals
12913 without any problem.
12916 \begin_layout Subsection
12920 \begin_layout Standard
12921 As usual, the easiest way to write a paper is to start with a template.
12924 File\SpecialChar menuseparator
12940 This will give an (almost) empty document that includes the most common
12941 fields found in a manuscript.
12942 Simply overwrite the existing text (including the brackets,
12947 You should keep in mind the following remarks.
12950 \begin_layout Enumerate
12952 won't let you change the font size and the page style of the document,
12953 because such modifications are not allowed by both packages.
12956 \begin_layout Enumerate
12957 The language of the document should not be changed.
12958 Before previewing your paper, be sure that the babel package is not used.
12959 To do this, click on
12962 arg "dialog-show document"
12967 \SpecialChar menuseparator
12971 \begin_inset Quotes eld
12975 \begin_inset Quotes erd
12985 \begin_layout Enumerate
12987 \begin_inset Quotes eld
12991 \begin_inset Quotes erd
12994 style must be used to define keywords.
12997 \begin_layout Enumerate
12998 The ijmpc package provides a style named
12999 \begin_inset Quotes eld
13002 Classification Codes
13003 \begin_inset Quotes erd
13006 , which can be used to define classification codes, such as PACS numbers.
13007 Note that this facility is not supported by the ijmpd package.
13010 \begin_layout Enumerate
13011 Several new environments are available:
13012 \begin_inset Quotes eld
13016 \begin_inset Quotes erd
13020 \begin_inset Quotes eld
13024 \begin_inset Quotes erd
13028 \begin_inset Quotes eld
13032 \begin_inset Quotes erd
13036 \begin_inset Quotes eld
13040 \begin_inset Quotes erd
13044 \begin_inset Quotes eld
13048 \begin_inset Quotes erd
13052 \begin_inset Quotes eld
13056 \begin_inset Quotes erd
13060 \begin_inset Quotes eld
13064 \begin_inset Quotes erd
13068 \begin_inset Quotes eld
13072 \begin_inset Quotes erd
13076 \begin_inset Quotes eld
13080 \begin_inset Quotes erd
13084 \begin_inset Quotes eld
13088 \begin_inset Quotes erd
13092 \begin_inset Quotes eld
13096 \begin_inset Quotes erd
13100 \begin_inset Quotes eld
13104 \begin_inset Quotes erd
13108 \begin_inset Quotes eld
13112 \begin_inset Quotes erd
13116 \begin_inset Quotes eld
13120 \begin_inset Quotes erd
13124 Their use is more or less obvious.
13126 supports all these environments; it will use the proper label, text style,
13127 and numbering scheme for each of them.
13130 \begin_layout Enumerate
13131 Both packages use basic citations; the natbib package should not be used.
13132 In \SpecialChar LyX
13133 , citation references are shown as usual; in the output, citations are
13134 shown as superscripts.
13135 If you want to use a citation as normal text, you should use the
13140 \begin_inset space \thinspace{}
13144 \begin_inset space \space{}
13148 \begin_inset Quotes eld
13152 \begin_inset space \space{}
13162 \begin_inset Quotes erd
13168 \begin_layout Enumerate
13170 \begin_inset Quotes eld
13174 \begin_inset Quotes erd
13177 section in both packages.
13178 To put acknowledgments, just use the
13179 \begin_inset Quotes eld
13183 \begin_inset Quotes erd
13189 \begin_layout Enumerate
13190 Appendices may be added to the paper,
13194 the Acknowledgments and
13200 provides a special environment, called
13201 \begin_inset Quotes eld
13205 \begin_inset Quotes erd
13208 which marks the beginning of the appendices.
13209 This environment should be left blank; it just sends a \SpecialChar LaTeX
13210 command, but nothing
13212 In \SpecialChar LyX
13214 \begin_inset Quotes eld
13218 \begin_inset Quotes erd
13221 is printed with blue letters, as a signal that all sections after that
13222 point are appendices.
13223 To write an appendix, use the
13224 \begin_inset Quotes eld
13228 \begin_inset Quotes erd
13233 will number each appendix with capital letters, as required by both journals.
13235 \begin_inset Quotes eld
13239 \begin_inset Quotes erd
13246 be present before the first appendix; if not, all appendices will be numbered
13247 as normal sections in the output.
13250 \begin_layout Enumerate
13251 The ijmpc and the ijmpd packages use the
13255 command to implement table captions.
13256 As a result, a table created by \SpecialChar LyX
13257 is printed correctly, but its caption
13259 However, you can use some \SpecialChar TeX
13260 code to overcome this problem, so that captions
13261 are printed as expected.
13262 To do so, create a float table as usual, remove the caption, and replace
13263 it with the \SpecialChar TeX
13274 (sic); you must also the \SpecialChar TeX
13279 immediately after the tabular material.
13280 Study the example table included in the template files to see how this
13281 trick is implemented.
13282 Alternatively, If you need table captions, you should implement the whole
13287 file, then include this file to the \SpecialChar LyX
13290 Insert\SpecialChar menuseparator
13291 File\SpecialChar menuseparator
13293 \begin_inset space ~
13299 Details on how to create a table float can be found in the files
13307 , included in the corresponding packages.
13310 \begin_layout Subsection
13311 Preparing a paper for submission
13314 \begin_layout Standard
13315 Before you submit your paper you must export the \SpecialChar LyX
13316 document as a \SpecialChar LaTeX
13319 File\SpecialChar menuseparator
13320 Export\SpecialChar menuseparator
13328 \begin_layout Plain Layout
13329 Actually you have the choice between \SpecialChar LaTeX
13330 (plain) and pdflatex.
13331 If you intend to use pdflatex to prepare the paper, you should use the
13332 pdflatex option so that included graphics are converted to PDF format,
13333 ready for use by pdflatex.
13338 , then make the following changes to the resulting
13345 \begin_layout Enumerate
13346 Remove the comment lines before the
13355 \begin_layout Enumerate
13356 Remove everything between (and including) the
13368 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13372 \begin_layout Standard
13377 file should be saved and processed through \SpecialChar LaTeX
13378 as many times as necessary.
13379 You may also want to check the resulting
13386 \begin_layout Section
13390 \begin_layout Standard
13396 \begin_layout Subsection
13400 \begin_layout Standard
13401 The iopart package provides a document class to create electronic manuscript
13402 submission to the journals published by the Institute of Physics.
13403 Instructions for the authors how to create a paper using the iopart class
13404 can be downloaded together with the iopart package from the site
13405 \begin_inset Flex URL
13408 \begin_layout Plain Layout
13410 ftp://ftp.iop.org/pub/journals/latex2e
13418 \begin_layout Subsection
13422 \begin_layout Standard
13423 The easiest way to write a paper is to start with the template
13427 that is available via
13429 File\SpecialChar menuseparator
13432 The template explains how to use the special text environments.
13433 Here are the most important advices:
13436 \begin_layout Itemize
13437 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13438 no AMS packages are loaded in
13440 Document\SpecialChar menuseparator
13441 Settings\SpecialChar menuseparator
13447 \begin_layout Itemize
13450 The title environment defines the kind of your paper.
13451 So use one of the following environments for the title:
13455 \begin_layout Itemize
13464 \begin_layout Itemize
13473 \begin_layout Itemize
13479 for a Topical review
13482 \begin_layout Itemize
13491 \begin_layout Itemize
13500 \begin_layout Itemize
13506 for a Paper (same as Title)
13509 \begin_layout Itemize
13515 for a Preliminary communication
13518 \begin_layout Itemize
13524 for a Rapid communication
13527 \begin_layout Itemize
13533 for a Letter to the editor
13537 \begin_layout Itemize
13540 All title environments except of
13544 can have an optional short title.
13547 \begin_layout Itemize
13548 There is a general title environment
13552 which is not directly supported by \SpecialChar LyX
13554 This can be used as \SpecialChar TeX
13555 code when your document doesn't fit into one of the
13559 \begin_layout Standard
13560 For more informations like hints for special table and formula formatting,
13561 look at the IOP author guidelines.
13564 \begin_layout Section
13568 \begin_layout Standard
13571 Panayotis Papasotiriou
13574 \begin_layout Subsection
13578 \begin_layout Standard
13579 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13580 that facilitates electronic manuscript submission to the journals they
13582 Most known of them (at least in my domain of interest) are
13584 Astrophysics and Space Science
13590 , but there are many others (see a complete list at
13591 \begin_inset Flex URL
13594 \begin_layout Plain Layout
13596 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13602 The Kluwer package may be downloaded from the site
13603 \begin_inset Flex URL
13606 \begin_layout Plain Layout
13608 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13614 A complete user guide is contained in that package (but it can also be
13615 downloaded separately).
13618 \begin_layout Standard
13620 supports many features of the package but not everything.
13621 However, the \SpecialChar TeX
13622 code needed is reduced to some
13623 \begin_inset Quotes eld
13627 \begin_inset Quotes erd
13630 commands of the package (see
13631 \begin_inset space ~
13635 \begin_inset CommandInset ref
13637 reference "subsec:kluwer_peculiarities"
13642 I have recently used \SpecialChar LyX
13643 to write an article submitted to the
13645 Astrophysics and Space Science
13647 without any problem.
13650 \begin_layout Subsection
13654 \begin_layout Standard
13655 The easiest way to write a paper is to start with the Kluwer template file.
13658 File\SpecialChar menuseparator
13670 This will give an (almost) empty document that includes the most common
13671 fields found in a manuscript and a short description of their use.
13672 As in most templates, simply overwrite the existing text (including the
13677 ) with the correct information.
13680 \begin_layout Subsection
13681 Preparing a paper for submission
13684 \begin_layout Standard
13685 As in the AAS\SpecialChar TeX
13686 package, before you submit your paper to a journal you must
13688 \begin_inset Quotes eld
13692 \begin_inset Quotes erd
13698 \begin_layout Enumerate
13699 Export your paper as a \SpecialChar LaTeX
13701 To do this, click on
13703 File\SpecialChar menuseparator
13704 Export\SpecialChar menuseparator
13712 \begin_layout Enumerate
13717 file with a text editor and make the following changes
13721 \begin_layout Enumerate
13722 remove the comment lines before the
13731 \begin_layout Enumerate
13732 remove everything between (and including) the
13744 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13748 \begin_layout Standard
13757 \begin_layout Enumerate
13762 file through \SpecialChar LaTeX
13763 as many times as necessary (usually up to three).
13766 \begin_layout Enumerate
13772 \begin_inset space \thinspace{}
13776 \begin_inset space \space{}
13783 , and check if everything is OK (it should, if you didn't make any mistake).
13786 \begin_layout Subsection
13787 \begin_inset Quotes eld
13791 \begin_inset Quotes erd
13794 of the Kluwer package
13795 \begin_inset CommandInset label
13797 name "subsec:kluwer_peculiarities"
13804 \begin_layout Standard
13805 The Kluwer package has the following
13806 \begin_inset Quotes eld
13810 \begin_inset Quotes erd
13816 \begin_layout Enumerate
13817 It is possible to write multiple articles in the same \SpecialChar LaTeX
13822 \begin_layout Plain Layout
13823 I can't imagine any good reason to do this.
13829 Each article must be included in the environment
13830 \begin_inset Quotes eld
13834 \begin_inset Quotes erd
13838 Unfortunately, this environment cannot be omitted, even if you write just
13840 Therefore, each article starts with the command
13846 and, obviously, ends with the command
13853 Although this can be implemented in \SpecialChar LyX
13854 , I didn't included it, since it looks
13855 ugly and can confuse the novice user.
13856 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13859 \begin_inset Quotes eld
13864 \begin_inset Quotes erd
13870 \begin_layout Enumerate
13871 Information given at the beginning of the article (i.
13872 \begin_inset space \thinspace{}
13876 \begin_inset space \space{}
13879 title, subtitle, author, institution, running title, running author, abstract
13880 and keywords) must be included in an environment called
13881 \begin_inset Quotes eld
13885 \begin_inset Quotes erd
13889 This is not implemented in \SpecialChar LyX
13890 , so you must enter title, subtitle etc.
13891 \begin_inset space ~
13894 between two \SpecialChar TeX
13910 \begin_layout Enumerate
13911 According to the user manual, the label of each bibliography item must be
13935 \begin_layout Standard
13940 template takes care of all these
13941 \begin_inset Quotes eld
13945 \begin_inset Quotes erd
13949 If you start a new paper using this template you don't need to do anything
13954 \begin_layout Enumerate
13955 don't delete the \SpecialChar TeX
13956 code included in the template, and
13959 \begin_layout Enumerate
13960 copy the example bibliography item included in the template and modify it
13961 as necessary to enter new bibliography items.
13964 \begin_layout Section
13968 \begin_layout Standard
13974 \begin_layout Subsection
13978 \begin_layout Standard
13979 The \SpecialChar LyX
13982 article (koma-script)
13986 report (koma-script)
14004 correspond to the \SpecialChar LaTeX
14022 \begin_inset space ~
14025 of the Koma-Script family.
14026 They are replacements for the standard document classes
14042 , resp., and fit better to European typography conventions in a number of
14046 \begin_layout Itemize
14047 Standard character size is 11pt in
14049 article (koma-script)
14053 report (koma-script)
14061 letter (koma-script)
14066 \begin_layout Itemize
14067 Headings, labels of the description environment, and a number of elements
14070 letter (koma-script)
14072 document class are set in a bold sans serif font.
14076 \begin_layout Plain Layout
14077 There is a big difference between the bold sans serif old cm fonts and new
14078 ec fonts, especially in the appearance of headings.
14079 In comparison, the ec bold sans serif fonts look a bit thin.
14080 Here the \SpecialChar LaTeX
14089 helps to produce the
14090 \begin_inset Quotes eld
14094 \begin_inset Quotes erd
14097 appearance when using the ec fonts.
14102 The numbering of chapter headings is made in the same way as the numbering
14103 of section headings, that is without the extra line
14104 \begin_inset Quotes eld
14107 Chapter\SpecialChar ldots
14109 \begin_inset Quotes erd
14113 In addition, the appearance of the headings can be modified by using a
14114 number of options (in \SpecialChar LyX
14115 to be entered in the field
14118 \begin_inset space ~
14125 Layout\SpecialChar menuseparator
14132 \begin_layout Itemize
14133 The main means in the Koma-Script document classes to design the type area
14142 (in \SpecialChar LyX
14143 to be entered in the extra class options field in the dialog
14145 Document\SpecialChar menuseparator
14149 They make a clearer modification of page margins possible as do the options
14152 Document\SpecialChar menuseparator
14159 \begin_layout Itemize
14160 The \SpecialChar LaTeX
14161 document classes of the Koma-Script family define a number of additional
14163 Those part of it which makes sense in \SpecialChar LyX
14164 is implemented in corresponding
14168 \begin_layout Standard
14169 Detailed descriptions of the \SpecialChar LaTeX
14170 document classes of the Koma-Script family
14171 can be found in the Koma-Script documentation
14182 \begin_layout Subsection
14183 article (koma-script), report (koma-script), and book (koma-script)
14186 \begin_layout Standard
14187 The document classes
14189 article (koma-script)
14193 report (koma-script)
14203 are implemented in the layout files
14216 They contain all the paragraph types of the corresponding standard document
14229 , resp., partly modified, with the exception of the \SpecialChar LyX
14234 -type, which is replaced by the new
14238 -type having the same functionality.
14243 -Type there is a number of new paragraph types added.
14250 letter (koma-script)
14255 \begin_layout Itemize
14264 : are equivalents to
14272 , resp., additionally inserting an entry in the table of contents.
14281 are not contained in
14283 article (koma-script)
14288 \begin_layout Itemize
14297 : behave exactly as
14305 , resp., additionally clearing running heads.
14310 is not contained in
14312 article (koma-script)
14318 \begin_layout Plain Layout
14331 report (koma-script)
14333 , but since this is identical to
14337 , is has not been implemented in \SpecialChar LyX
14346 \begin_layout Itemize
14351 : generates a heading directly above the following paragraph in the standard
14352 character size without affecting the structure of the document.
14355 \begin_layout Itemize
14364 are special captions which respect the different space settings needed
14365 for captions placed above or below an element (if you follow strict typographic
14366 rules, you might want to place table captions always above the table).
14367 You can also use the class option
14371 , which will switch
14384 You need at least Koma-Script version 2.8q to use this.
14387 \begin_layout Itemize
14392 : can be used to set a bonmot, e.
14393 \begin_inset space \thinspace{}
14397 \begin_inset space \space{}
14400 at the beginning of a chapter.
14401 If you use the optional argument (
14403 Insert\SpecialChar menuseparator
14405 \begin_inset space ~
14410 ), you can insert the dictum's author there.
14411 Dictum and author are separated by a line.
14412 You need at least Koma-Script version 2.8q to use this.
14417 is not contained in
14419 article (koma-script)
14424 \begin_layout Standard
14425 The following types, together with the standard types
14437 , form the title area of the document.
14438 They must be entered ahead of the first
14439 \begin_inset Quotes eld
14443 \begin_inset Quotes erd
14450 \begin_layout Plain Layout
14451 The corresponding \SpecialChar LaTeX
14452 commands must appear before the
14463 When such a type is used more than once, the latter usage overwrites the
14464 former one, that means, for every type only the latest usage is valid.
14465 The order of the different types however has, like
14477 , no effect on the appearance of the produced document.
14480 \begin_layout Itemize
14485 : produces a centered paragraph above the ordinary title (
14497 ) for the subject of the document.
14500 \begin_layout Itemize
14505 : produces a centered paragraph below the ordinary title (
14517 ) for the publishers' name.
14520 \begin_layout Itemize
14527 report (koma-script)
14533 produces a centered paragraph on its own page behind the title page, or
14536 article (koma-script)
14538 produces a centered paragraph below the ordinary title (
14554 ) for a dedication.
14557 \begin_layout Itemize
14562 : produces a left aligned paragraph above the ordinary title (
14578 ) for a document`s head.
14581 \begin_layout Itemize
14586 : produces in a double-sided print in
14588 report (koma-script)
14594 a left-aligned paragraph at the top of the title page`s back or has no
14595 effect in a single-sided print or in
14597 article (koma-script)
14602 \begin_layout Itemize
14607 : produces in a double-sided print in
14609 report (koma-script)
14615 a left-aligned paragraph at the bottom of the title page`s back or has
14616 no effect in a single-sided print or in
14618 article (koma-script)
14623 \begin_layout Itemize
14628 : produces a special
14629 \begin_inset Quotes eld
14633 \begin_inset Quotes erd
14636 page ahead of the actual document containing a paragraph without special
14640 \begin_layout Standard
14641 The layout files for the document classes
14643 article (koma-script)
14647 report (koma-script)
14653 do include the file
14658 This is thought of as a place to define your own types.
14663 in your personal layout directory and edit the file!
14666 \begin_layout Subsection
14667 letter (koma-script)
14670 \begin_layout Description
14671 Note: This section discusses the obsolete
14673 KOMA-Script-Letter (v.
14674 \begin_inset space ~
14679 , which is not even included anymore in recent KOMA releases.
14680 Please refer to the next section for the current KOMA-Script-Letter class
14682 \begin_inset space ~
14688 \begin_layout Standard
14692 letter (koma-script)
14694 is implemented in the layout file
14699 It contains all the paragraph types of the corresponding standard document
14704 , partly modified, with the exception of the \SpecialChar LyX
14718 type, which is replaced by the new
14723 In addition, it contains, in contrast to the standard document class, the
14742 Furthermore, there are a number of new letter specific types.
14745 \begin_layout Standard
14746 The appearance of the letter produced by this document class can be controlled
14747 by a number of \SpecialChar LaTeX
14748 commands, which you can put in the \SpecialChar LaTeX
14753 \begin_layout Plain Layout
14754 For example, the standard appearance of the letter`s heading, consisting
14755 of name and address, is quite self-willed.
14757 \begin_inset Quotes eld
14761 \begin_inset Quotes erd
14764 heading is produced by the following \SpecialChar LaTeX
14765 commands in the preamble:
14768 \begin_layout LyX-Code
14778 \begin_layout LyX-Code
14794 \begin_layout LyX-Code
14804 \begin_layout LyX-Code
14824 A detailed German description of such \SpecialChar LaTeX
14825 commands can be found in the Koma-Script
14831 With it, the letter's author can produce his personal letter layout.
14834 \begin_layout Standard
14843 define the beginning of the letter and must be used in every letter.
14844 To emphasize them in the \SpecialChar LyX
14845 document class, they are marked with the letter
14855 \begin_inset space ~
14858 in the left margin.
14859 It is possible to write any number of letters in one file.
14864 type produces a new letter using the same addressee and a
14868 type produces a new addressee.
14885 are ordinary paragraph types and can also be used several times in one
14886 and the same letter.
14889 \begin_layout Itemize
14894 : produces a paragraph for the addressee and implicitly defines the beginning
14898 \begin_layout Itemize
14903 : produces a paragraph for the form of address and implicitly produces a
14907 \begin_layout Itemize
14912 : produces a paragraph for a close.
14915 \begin_layout Itemize
14920 : produces a paragraph for a postscript.
14923 \begin_layout Itemize
14928 : produces a paragraph for a distribution list.
14931 \begin_layout Itemize
14936 : produces a paragraph for enclosures.
14939 \begin_layout Standard
14980 are input types provided with a label to enter information, which will
14981 be processed by the document class.
14985 \begin_layout Plain Layout
14986 It could be seen as a matter of inconsequence, that the types
14994 described above are not such input types as well.
14995 Because of the special meaning of those types, however, I have implemented
14996 them as ordinary paragraph types with a one letter mark in the left margin.
14997 Moreover, it would affect my feeling of symmetry, if the
15005 type had such a serious different appearance.
15010 The types must be used ahead of the corresponding
15017 \begin_layout Standard
15018 An implementation of these types in a WYSIWYG fashion does not seem to make
15019 sense, because the real appearance of the produced letter does not only
15020 depend on the usage of the particular type, but also on other factors.
15021 For example, a signature entered in the
15025 type will in the standard behavior appear in the produced letter only,
15026 when in the same letter also a
15031 The entered value of the
15035 type will in the standard behavior not appear in the produced letter at
15037 The possibility to design the letter`s heading freely is already indicated
15038 in a footnote above.
15041 \begin_layout Standard
15042 The input types can also be used as empty paragraphs.
15043 This makes sense e.
15044 \begin_inset space \thinspace{}
15048 \begin_inset space \space{}
15060 type is not used at all, in the standard behavior the value of the
15064 type is used as signature, whereas if an empty
15068 type is used, no signature value is defined.
15071 \begin_layout Standard
15072 By using the input types it is possible to write a letter template, containing
15073 filled input types with your personal dates (name, address, etc.) and empty
15074 input types for other dates you want to enter.
15077 \begin_layout Itemize
15082 : sender's name, in the standard behavior appears as a centered paragraph
15083 in small caps in the letter`s heading.
15086 \begin_layout Itemize
15091 : sender's signature, in the standard behavior appears below the
15100 type is used, the value of the
15104 type appears instead.
15107 \begin_layout Itemize
15112 : sender's address, in the standard behavior appears in a centered paragraph
15113 in the letter`s heading below the sender's name.
15116 \begin_layout Itemize
15121 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
15132 \begin_layout Itemize
15137 : place of the letter`s making.
15140 \begin_layout Itemize
15145 : date of the letter`s making.
15154 , in the standard behavior, produce the place and the date in a right-aligned
15155 line below the addressee's field.
15160 type is used, neither place nor date appear, independent of the value of
15170 type is used, the date of the letter `s production is used.
15173 \begin_layout Itemize
15178 : sender`s back address, in the standard behavior appears above the addressee's
15179 field in a small sans serif font.
15182 \begin_layout Itemize
15187 : special mail information, in the standard behavior appears underlined
15188 above the addressee's field below the back address.
15191 \begin_layout Itemize
15196 : additional information, in the standard behavior appears on right side
15197 below the addressee`s field.
15200 \begin_layout Itemize
15205 : the letter's title, in the standard behavior appears in a big, bold, sans
15206 serif font above the subject.
15209 \begin_layout Itemize
15214 : the letter's subject, in the standard behavior appears in a bold font
15222 \begin_layout Standard
15243 produce a business letter like line above the
15247 line containing the fields
15248 \begin_inset Quotes eld
15252 \begin_inset Quotes erd
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 \begin_inset Quotes eld
15284 \begin_inset Quotes erd
15288 \begin_inset Quotes eld
15292 \begin_inset Quotes erd
15296 For the date field, the value of the
15302 \begin_inset Quotes eld
15305 business letter types
15306 \begin_inset Quotes erd
15309 is used, the value of the
15313 type however does not appear, but only the \SpecialChar LaTeX
15321 The ordinary output of place and date in a right-aligned line below the
15322 addressee`s field is suppressed.
15323 The types are implemented as input types provided with a label and must
15324 be used ahead of the corresponding
15331 \begin_layout Itemize
15339 \begin_layout Itemize
15347 \begin_layout Itemize
15355 \begin_layout Itemize
15363 \begin_layout Itemize
15371 \begin_layout Subsection
15372 The new letter class: letter (koma-script v.2)
15375 \begin_layout Standard
15381 \begin_layout Standard
15382 \begin_inset VSpace medskip
15388 \begin_layout Standard
15390 Koma-Script version 2.8 has introduced a new letter class
15394 which supersedes the now unsupported
15399 It has — on the \SpecialChar LaTeX
15400 side — a completely new interface and is not compatible
15401 with the old class.
15402 Therefore, \SpecialChar LyX
15403 supports both, though it is recommended you use the new class.
15406 \begin_layout Standard
15407 This class covers the same functionality as
15409 letter (koma-script),
15412 The basic items are
15416 (receiver's address, same as
15420 in the old layout),
15433 will start a new letter (i.
15434 \begin_inset space \thinspace{}
15438 \begin_inset space \space{}
15441 you can write several letters per document).
15442 New elements are sender's
15458 and the possibility to use a
15464 Insert\SpecialChar menuseparator
15470 \begin_layout Standard
15471 The biggest improvement is, though, that the letter's layout is configurable
15472 to meet almost any needs.
15473 This can be done via the preamble or with a special style file (Letter
15474 Class Option, extension
15478 ), that will be read in as a class option.
15482 \begin_layout Plain Layout
15483 The KOMA package comes with some default
15488 There is, for instance, a
15492 file that follows german typesetting rules, or a
15496 that provides the default layout of the old
15501 The latter can be loaded with the class option
15507 Layout\SpecialChar menuseparator
15508 Document\SpecialChar menuseparator
15520 template that is included in \SpecialChar LyX
15522 A detailed description is to be found in the Koma-Script documentation
15530 \begin_layout Subsection
15534 \begin_layout Standard
15535 Visualizing the Koma-Script document classes in \SpecialChar LyX
15536 , the \SpecialChar LyX
15537 internals cause some
15541 \begin_layout Itemize
15542 The chapter number of a
15546 type appears on a line of its own above the chapter heading instead of
15547 appearing in the same line ahead of it.
15548 The cause for that is the \SpecialChar LyX
15549 internal behavior for the labeltype
15553 in the layout file.
15556 \begin_layout Itemize
15557 The headings of the types
15565 are only put in the
15566 \begin_inset Quotes eld
15570 \begin_inset Quotes erd
15574 table of contents, but not in the \SpecialChar LyX
15575 table of contents (
15577 Document\SpecialChar menuseparator
15579 \begin_inset space ~
15583 \begin_inset space ~
15591 \begin_layout Itemize
15592 The paragraphs in a
15596 document class appear in a skip separation mode, not indented.
15597 This is the standard behavior, no special \SpecialChar LaTeX
15598 commands are needed for that.
15601 Document\SpecialChar menuseparator
15604 dialog the corresponding radio button indicates
15613 value always has the effect that extra \SpecialChar LaTeX
15614 commands are inserted in the document
15615 to produce the gap, which is not what is wanted in this case.
15618 \begin_layout Section
15622 \begin_layout Standard
15628 \begin_layout Subsection
15632 \begin_layout Standard
15633 Memoir is a very powerful and constantly evolving class.
15634 It has been designed with regard to fictional and non-fictional literature.
15635 Its aim is to let the user have maximum control over the typesetting of
15637 Memoir is based on the standard book class, but it can also emulate the
15638 article class (see below).
15641 \begin_layout Standard
15642 Peter Wilson, the developer of Memoir, is known as the author of lots of
15643 useful packages in the \SpecialChar LaTeX
15645 Most of them have been merged with Memoir.
15646 Therefore, it is much easier to layout the table of contents, appendices,
15647 chapter designs and such.
15649 , though, does not support all of these goodies natively.
15650 Some of them might be added to forthcoming releases
15654 \begin_layout Plain Layout
15655 You are invited to send suggestions to
15656 \begin_inset Flex URL
15659 \begin_layout Plain Layout
15661 lyx-devel@lists.lyx.org
15671 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15673 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15675 commands (\SpecialChar TeX
15680 \begin_layout Plain Layout
15685 \begin_layout Plain Layout
15695 \begin_inset space ~
15699 \begin_inset CommandInset ref
15701 reference "sec:Inserting-TeX-Code"
15711 In this section, we can only list those features that are natively supported
15712 by \SpecialChar LyX
15714 For detailed descriptions (and for the rest of features) we recommend you
15715 have a look at the detailed manual of the Memoir class
15719 \begin_layout Plain Layout
15724 \begin_layout Plain Layout
15734 \begin_inset Flex URL
15737 \begin_layout Plain Layout
15739 CTAN:/macros/latex/memoir/memman.pdf
15749 , which is not only a user guide for the class, but also both a comprehensive
15750 description on good typesetting and a superb example for good typesetting
15754 \begin_layout Subsection
15755 Basic features and restrictions
15758 \begin_layout Standard
15759 Memoir supports basically all features of the standard book classes.
15760 There are, however, some differences, as follows:
15763 \begin_layout Description
15765 \begin_inset space ~
15768 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15771 \begin_layout Description
15773 \begin_inset space ~
15776 style: The fancy page style is not supported, due to a command clash between
15777 Memoir and the fancyhdr package (they both define a command with the same
15778 name, which confuses \SpecialChar LaTeX
15780 Instead, Memoir comes with a number of its own page styles (see
15782 Document\SpecialChar menuseparator
15783 Settings\SpecialChar menuseparator
15785 \begin_inset space ~
15791 If you want to use these for the chapter pages, you have to use the command
15798 in the main text or in preamble (e.
15799 \begin_inset space \thinspace{}
15803 \begin_inset space \space{}
15810 chapterstyle{companion}
15815 \begin_layout Description
15816 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15817 optional argument in the standard classes.
15818 With this, you can specify an alternative version of the title for the
15819 table of contents and the headers (for instance, if the title is too long).
15820 In \SpecialChar LyX
15821 , you can do this via
15823 Insert\SpecialChar menuseparator
15825 \begin_inset space ~
15830 at the beginning of a chapter/section.
15831 Memoir features a second optional argument and thus separates the table
15832 of contents from the header.
15833 You can define three variants of a title with this: one for the main text,
15834 one for the table of contents, and one for the headers.
15836 makes these available in form of specific
15847 \begin_layout Description
15848 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15849 of contents, the list of figures and the list of table start a new page
15851 Memoir does not follow this route.
15852 You have to insert a page break yourself, if you want to have one.
15855 \begin_layout Description
15856 Titlepage: For some unknown reason, Memoir uses pagination on the title
15857 page (in the standard classes, title pages are
15858 \begin_inset Quotes eld
15862 \begin_inset Quotes erd
15866 If you want an empty title page, type
15870 aliaspagestyle{title}{empty}
15875 \begin_layout Description
15876 Article: With the class option
15882 Document\SpecialChar menuseparator
15883 Settings\SpecialChar menuseparator
15884 Class Settings\SpecialChar menuseparator
15886 \begin_inset space ~
15891 ), you can emulate article style.
15892 That is, counters (footnotes, figures, tables etc.) will not be reset on
15893 new chapters, chapters don't start a new page (but are—in contrary to
15894 \begin_inset Quotes eld
15898 \begin_inset Quotes erd
15901 article classes—still allowed), parts, though, use their own page, as in
15905 \begin_layout Description
15906 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15907 font commands, which have been used in the old \SpecialChar LaTeX
15909 \begin_inset space \thinspace{}
15913 \begin_inset space \space{}
15929 It produces an error and stops \SpecialChar LaTeX
15930 whenever such a command appears.
15935 reallows the commands and spits out warnings instead (which does at least
15936 not stop \SpecialChar LaTeX
15938 Since a lot of packages and particularly Bib\SpecialChar TeX
15939 style files are still using
15940 those commands, we have decided to use this option by default.
15943 \begin_layout Subsection
15947 \begin_layout Standard
15948 We will only describe the features supported by \SpecialChar LyX
15949 (which is not much currently).
15950 Please consult the Memoir manual
15954 \begin_layout Plain Layout
15959 \begin_layout Plain Layout
15969 \begin_inset Flex URL
15972 \begin_layout Plain Layout
15974 CTAN:/macros/latex/memoir/memman.pdf
15987 \begin_layout Description
15988 Abstract: You may wonder why an abstract is an extra feature.
15989 Well, it is in book class.
15990 Usually books don't have abstracts.
15991 Memoir, however, has.
15992 You can use it wherever and how often you like.
15995 \begin_layout Description
15996 Chapterprecis: You may know this older typesetting style: The contents of
15997 a chapter are summarized below the title and also in the table of contents
15999 \begin_inset space \thinspace{}
16003 \begin_inset space \space{}
16008 Our hero arrives in Troia; he loses some friends; he finds others
16011 Chapterprecis does exactly this.
16012 It is therefore only sensible below a chapter.
16015 \begin_layout Description
16016 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
16017 The epigraph environment provides an elegant way of typesetting such a
16019 The motto itself (text) and its (optional) author (source) are divided
16021 The author (source) can be inserted via
16023 Insert\SpecialChar menuseparator
16030 \begin_layout Description
16031 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
16032 complex figurative poems).
16034 can only support a few of them.
16035 One is poemtitle, which is a centered title for poems, which will also
16036 be added to the table of contents (verse is the standard environment for
16038 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
16040 because they have to be nested inside regular verse environments, which
16041 is not possible with \SpecialChar LyX
16045 \begin_layout Description
16046 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
16049 \begin_layout Section
16050 Article (mwart), book (mwbk) and report (mwrep)
16051 \begin_inset Argument status
16054 \begin_layout Plain Layout
16067 \begin_layout Standard
16073 \begin_layout Standard
16074 The \SpecialChar LyX
16091 correspond to the \SpecialChar LaTeX
16105 They are replacements for the standard document classes
16117 , resp., and fit better to Polish typography conventions in a number of points.
16121 \begin_layout Standard
16125 \begin_layout Itemize
16126 Unnumbered titles (with star, e.
16127 \begin_inset space \thinspace{}
16131 \begin_inset space \space{}
16138 ) are added into table of contents,
16141 \begin_layout Itemize
16142 Additional page styles:
16146 \begin_layout Description
16147 uheadings header with separated lines,
16150 \begin_layout Description
16151 myheadings custom header, contents headers via commands:
16166 \begin_layout Description
16167 myuheadings custom header with separated lines,
16170 \begin_layout Description
16171 outer page number is placed on outer side of page
16175 \begin_layout Itemize
16180 \begin_layout Description
16181 rmheadings serif titles — default,
16184 \begin_layout Description
16185 sfheadings sansserif titles,
16188 \begin_layout Description
16189 authortitle on title page first placed is author next title — default,
16192 \begin_layout Description
16193 titleauthor on title page first placed is title next author,
16196 \begin_layout Description
16197 withmarginpar reserve place on page for margins.
16201 \begin_layout Section
16205 \begin_layout Standard
16210 provides an alternative to the standard
16215 It provides similar functionality, but you might prefer this layout with
16216 sans serif sections, headings, and more.
16219 \begin_layout Section
16220 Rev\SpecialChar TeX
16224 \begin_layout Standard
16230 \begin_layout Standard
16231 \begin_inset VSpace bigskip
16237 \begin_layout Standard
16242 \begin_inset space ~
16247 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16249 \begin_inset Formula $\beta$
16252 release of May, 1999) class.
16255 \begin_layout Standard
16261 textclass, which works with Rev\SpecialChar TeX
16263 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16265 That means that it doesn't interact very well with \SpecialChar LyX
16266 , which requires \SpecialChar LaTeX2e
16268 it has been kludged to work.
16269 Since Rev\SpecialChar TeX
16270 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16275 Rev\SpecialChar TeX
16277 \begin_inset space ~
16282 textclass should also be pretty easy to use.
16285 \begin_layout Standard
16286 These documents are supposed to be used in
16290 to the Rev\SpecialChar TeX
16291 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16293 and assume you'll know what to put in the preamble if necessary.
16296 \begin_layout Subsection
16300 \begin_layout Standard
16301 All you need to do is install Rev\SpecialChar TeX
16302 4, as described in the package's README
16304 The package can be found at The Rev\SpecialChar TeX
16306 \begin_inset Flex URL
16309 \begin_layout Plain Layout
16311 http://publish.aps.org/revtex4/
16317 Install it somewhere that \SpecialChar LaTeX
16319 Test it by trying to \SpecialChar LaTeX
16320 a short Rev\SpecialChar TeX
16321 4 document in some random directory (i.
16322 \begin_inset space \thinspace{}
16326 \begin_inset space \space{}
16329 not the directory where you installed the class file.) Then, if you reconfigure
16331 , it will find the class file and let you use the Rev\SpecialChar TeX
16335 \begin_layout Standard
16336 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16345 \begin_inset space ~
16350 template, found in the templates directory.
16353 \begin_layout Subsection
16357 \begin_layout Standard
16358 Optional arguments to
16365 \begin_inset Quotes eld
16369 \begin_inset Quotes erd
16373 \begin_inset Quotes eld
16377 \begin_inset Quotes erd
16383 \begin_inset space ~
16391 \begin_inset space ~
16397 Remember that in Rev\SpecialChar TeX
16398 , at least one optional argument is required!
16401 \begin_layout Standard
16402 Other preamble matter, like
16409 \begin_inset space ~
16416 \begin_inset space ~
16421 dialog, also as usual.
16424 \begin_layout Subsection
16428 \begin_layout Standard
16429 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16431 For example, the Email layout corresponds to
16438 Note that (at least as of Rev\SpecialChar TeX
16447 layouts are exactly equivalent, so you shouldn't need to use both.
16451 \begin_layout Plain Layout
16452 In case you're curious, both were included so that
16456 would be able to translate both
16476 \begin_layout Subsection
16480 \begin_layout Standard
16481 There are a couple of important unique aspects of Rev\SpecialChar TeX
16482 4 which might cause
16483 bugs that will be even more confusing in \SpecialChar LyX
16487 \begin_layout Standard
16488 In Rev\SpecialChar TeX
16506 The \SpecialChar LyX
16507 equivalent is that there is a separate Thanks layout.
16512 write footnotes in the
16516 layout, or weird things may happen.
16517 See the Rev\SpecialChar TeX
16518 4 documentation for more details.
16521 \begin_layout Standard
16525 \begin_inset space ~
16533 \begin_inset space ~
16542 layouts must be placed
16550 layout and the corresponding
16567 , the \SpecialChar LaTeX
16571 \begin_layout Section
16572 Springer Journals (
16579 \begin_layout Standard
16585 \begin_layout Subsection
16589 \begin_layout Standard
16590 These are the layout files for some of the journal formats used by Springer
16591 Verlag and listed on
16592 \begin_inset Flex URL
16595 \begin_layout Plain Layout
16597 http://www.springer.de/author/tex/help-journals.html
16602 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16604 It is a modular system: the things common to all journals are implemented
16609 , which journal-specific layout files (such as, e.
16610 \begin_inset space \thinspace{}
16614 \begin_inset space \space{}
16621 for Journal of Geodesy) can include.
16624 \begin_layout Standard
16625 This means that implementing support for any other Springer journal on this
16626 list is as simple as writing your own
16634 file following the outline given in
16642 \begin_layout Standard
16643 It is reasonably well tested only for the Journal of Geodesy.
16652 come with the standard \SpecialChar LyX
16654 Install the relevant class file (downloaded from Springer) in a proper
16655 directory, reconfigure \SpecialChar LaTeX
16656 (in the te\SpecialChar TeX
16661 , as root if necessary — doesn't \SpecialChar LyX
16662 take care of this?), reconfigure \SpecialChar LyX
16667 \begin_layout Subsection
16671 \begin_layout Standard
16672 A large number of theorem-like styles —
16684 \begin_layout Standard
16687 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16688 _Title, Author_Running, Institute,
16689 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16692 See the Springer class file documentation for details.
16695 \begin_layout Subsection
16699 \begin_layout Itemize
16711 \begin_layout Itemize
16714 Probability Theory and Related Fields
16720 — Jean-Marc Lasgouttes
16723 \begin_layout Standard
16724 Add your own, it isn't so hard!
16727 \begin_layout Subsection
16731 \begin_layout Standard
16732 These files are partly based on the older
16736 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16738 file from Springer.
16743 layout, are now defunct.
16744 Jean-Marc Lasgouttes helped out big in making me find my way around the
16746 layout file mechanism.
16749 \begin_layout Subsection
16753 \begin_layout Standard
16755 But probably less than in the old hacked-\SpecialChar LaTeX
16763 \begin_layout Section
16766 Sli\SpecialChar TeX
16770 \begin_inset CommandInset label
16779 \begin_layout Standard
16787 \begin_layout Subsection
16791 \begin_layout Standard
16792 This section describes how to use \SpecialChar LyX
16793 to make slides for overhead projectors.
16794 There are two document classes that can do this: the default slides class
16797 Foil\SpecialChar TeX
16801 This section documents the former.
16804 \begin_layout Standard
16805 I'm going to say this again, nice and clear, so that there's no misunderstanding
16809 \begin_layout Standard
16810 \begin_inset VSpace bigskip
16816 \begin_layout Standard
16820 This section documents the class
16821 \begin_inset Quotes eld
16829 \begin_inset Quotes erd
16837 \begin_layout Standard
16838 \begin_inset VSpace bigskip
16844 \begin_layout Standard
16845 If you're looking for the documentation for
16846 \begin_inset Quotes eld
16851 slides (Foil\SpecialChar TeX
16855 \begin_inset Quotes erd
16858 , check out section
16859 \begin_inset space ~
16863 \begin_inset CommandInset ref
16865 reference "sec:foiltex"
16875 \begin_inset Quotes eld
16880 slides (Foil\SpecialChar TeX
16884 \begin_inset Quotes erd
16887 ] is actually somewhat better than the default
16895 \begin_layout Plain Layout
16897 or so I've been told repeatedly by its advocates.
16898 Having never used it, I have no idea if this claim is true or not.
16903 which this section documents.
16906 \begin_layout Standard
16907 This class is the \SpecialChar LaTeX2e
16908 improvement of the old
16910 Sli\SpecialChar TeX
16914 Every \SpecialChar LaTeX2e
16915 distribution includes this class [which I'll just refer to as
16916 \begin_inset Quotes eld
16924 \begin_inset Quotes erd
16927 from now on], so you're bound to have it.
16928 As I noted earlier, there are other classes, such as
16932 , which also produce slides for overhead projectors and do a better job
16934 However, there are some things which
16938 can do which the others can't, such as generate overlays.
16939 Read on to learn more!
16942 \begin_layout Subsection
16944 \begin_inset CommandInset label
16946 name "sec:slidesetup"
16953 \begin_layout Standard
16954 Obviously, to use this document class, you need to select
16955 \begin_inset Quotes eld
16963 \begin_inset Quotes erd
16966 from the class list in the
16968 Document\SpecialChar menuseparator
16972 There are some other special things you should know about this class:
16975 \begin_layout Itemize
16976 Don't bother changing the options
16981 They're not supported by the
16988 \begin_layout Itemize
16992 \begin_inset space ~
16997 behaves a bit differently for this class.
16998 The possible choices and what they do are as follows:
17002 \begin_layout Description
17007 The final output contains page numbers in the lower right corner.
17010 \begin_layout Description
17019 , but also prints out any time markers you've put in.
17020 This is the default.
17023 \begin_layout Description
17028 The final output contains no page numbers, time markers, or alignment markers.
17032 \begin_layout Itemize
17037 class has an extra option:
17043 \begin_inset Quotes eld
17051 \begin_inset Quotes erd
17054 in the extra class options.
17058 \begin_layout Standard
17059 Using this options allows you to add time markers to
17065 \begin_inset space ~
17069 \begin_inset CommandInset ref
17071 reference "sec:slideNote"
17079 \begin_layout Standard
17080 You can also use the template file
17081 \begin_inset Quotes eld
17089 \begin_inset Quotes erd
17092 to automatically set up a document to use the
17098 File\SpecialChar menuseparator
17100 \begin_inset space ~
17104 \begin_inset space ~
17109 to open your new document].
17110 The template file also contains some examples of the special paragraph
17111 environments used by this class.
17112 I'll describe those next.
17115 \begin_layout Subsection
17116 Paragraph Environments
17119 \begin_layout Subsubsection
17120 Supported Environments
17123 \begin_layout Standard
17124 The first thing you'll notice when you start up a new
17128 document is the font size and type: it's the equivalent of the size
17129 \begin_inset Quotes eld
17137 \begin_inset Quotes erd
17143 \begin_inset space ~
17149 This is also what's used in the output.
17151 \begin_inset Quotes eld
17155 \begin_inset Quotes erd
17158 to remind you that this is a slide.
17159 Your final slides will use a larger font; ergo, you'll have less space.
17160 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
17163 \begin_layout Standard
17164 The next thing that becomes obvious is the changes to the paragraph environment
17165 pull-down box [at the far-left end of the toolbar].
17166 Most of the paragraph environments you're used to seeing are missing.
17167 There are also five new ones.
17172 class itself only supports certain paragraph environments:
17175 \begin_layout Itemize
17181 \begin_layout Itemize
17187 \begin_layout Itemize
17193 \begin_layout Itemize
17199 \begin_layout Itemize
17205 \begin_layout Itemize
17211 \begin_layout Itemize
17217 \begin_layout Itemize
17223 \begin_layout Itemize
17229 \begin_layout Itemize
17236 \begin_layout Standard
17237 All of the other standard environments, including the section-heading environmen
17238 ts, aren't used in the
17245 \begin_layout Standard
17246 On the other hand, you'll notice the following new environments:
17249 \begin_layout Itemize
17255 \begin_layout Itemize
17261 \begin_layout Itemize
17267 \begin_layout Itemize
17273 \begin_layout Itemize
17279 \begin_layout Standard
17280 These five are kind of quirky, due to a
17281 \begin_inset Quotes eld
17285 \begin_inset Quotes erd
17288 in \SpecialChar LyX
17290 You see, \SpecialChar LyX
17291 doesn't permit you to nest any other paragraph environment into
17292 an empty environment.
17293 Now, that's fine and dandy, but it means that you wouldn't be able to start
17294 a slide with anything except plain text.
17295 To deal with this, I've performed a little
17296 \begin_inset Quotes eld
17301 \begin_inset Quotes erd
17307 \begin_layout Subsubsection
17308 Quirks of the New Environments
17309 \begin_inset CommandInset label
17311 name "sec:slideQuirk"
17318 \begin_layout Standard
17319 All five of the new paragraph environments are somewhat quirky due to inherent
17320 limitiations in the current version of \SpecialChar LyX
17322 As I just mentioned, \SpecialChar LyX
17323 forbids environments that begin with another environment.
17324 To get around this, the
17328 environment isn't a paragraph environment as described in the
17336 \begin_layout Standard
17337 You should consider
17350 \begin_inset Quotes eld
17353 pseudo-environments.
17354 \begin_inset Quotes erd
17357 They look like a section heading or a
17358 \begin_inset Quotes eld
17366 \begin_inset Quotes erd
17369 but really begin a [and, if necessary, end the previous] paragraph environment.
17379 \begin_inset Quotes eld
17383 \begin_inset Quotes erd
17386 These two perform some action.
17389 \begin_layout Standard
17390 A common feature of all five environments,
17410 , is a rather long-ish label.
17411 The text following this label — ordinarily the contents of the paragraph
17412 environment — is utterly irrelevant for
17434 completely ignores it.
17435 In fact, you can leave these five environments completely empty.
17439 \begin_layout Standard
17444 to put any text after the rather long-ish label, you might want to.
17445 This could be a short description of the contents of the
17450 In that case, enter your descriptive comment and hit
17454 as you normally would.
17457 \begin_layout Standard
17458 If, on the other hand, you don't want to enter any descriptive text, you'll
17459 hit another \SpecialChar LyX
17462 , like nature, abhors a vacuum, and will not let you start a new paragraph
17463 environment until you put something in the old one.
17467 \begin_layout Itemize
17468 Start entering the text that will
17496 \begin_layout Itemize
17497 Now move to the beginning of that paragraph.
17501 \begin_layout Itemize
17510 \begin_layout Itemize
17511 Finally, change this new, empty paragraph to a
17535 \begin_layout Standard
17536 Some future version of \SpecialChar LyX
17537 will, hopefully, resolve this quirkiness\SpecialChar ldots
17541 \begin_layout Subsection
17542 Making a Presentation with
17555 \begin_layout Subsubsection
17563 \begin_layout Standard
17564 If you're expecting this section to teach you how to actually make a presentatio
17565 n, you'll be sorely disappointed.
17566 Naturally, I'll describe all of the ways the
17570 class can assist you in preparing the materials for a presentation.
17571 Filling in the contents, however, is up to you.
17576 the \SpecialChar LyX
17580 \begin_layout Standard
17585 environment [in the manner described in section
17586 \begin_inset space ~
17590 \begin_inset CommandInset ref
17592 reference "sec:slideQuirk"
17596 ] tells \SpecialChar LyX
17597 to begin a new slide [duh].
17598 The label for this environment/
17599 \begin_inset Quotes erd
17603 \begin_inset Quotes erd
17607 \begin_inset Quotes eld
17611 \begin_inset Quotes erd
17614 in cool blue, followed by the label,
17615 \begin_inset Quotes eld
17619 \begin_inset Quotes erd
17623 Any text or paragraph environments that follow this one go on the new slide.
17627 \begin_layout Standard
17628 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17630 (this can be specified in the
17635 In fact, you'll want to, once you finish entering the contents of one slide.
17636 If you've entered more text than can physically fit on a slide, the extra
17637 overflows onto a new slide.
17638 I don't recommend doing this, however, since the overflow slide won't have
17639 any page number on it.
17640 Furthermore, it may interfere with any
17644 you've made to accompany the oversized
17651 \begin_layout Standard
17660 environments work the same way as the
17665 They both create an
17666 \begin_inset Quotes eld
17670 \begin_inset Quotes erd
17673 followed by a label [
17674 \begin_inset Quotes eld
17678 \begin_inset Quotes erd
17682 \begin_inset Quotes eld
17686 \begin_inset Quotes erd
17690 The color is a stunning magenta instead of blue, and the
17691 \begin_inset Quotes eld
17695 \begin_inset Quotes erd
17698 will look different, in style and in length.
17699 The label fonts of all three also differ from one another.
17702 \begin_layout Standard
17707 , if the contents of a
17715 exceed the physical size of a slide or sheet of paper, the extra will overflow
17717 Again, you should avoid this.
17718 It defeats the whole purpose of
17729 \begin_layout Subsubsection
17739 \begin_layout Standard
17744 is a slide that sits atop another slide.
17745 Perhaps you wish to discuss a figure on the main
17749 before displaying the text associated with it.
17750 One way to accomplish this is tape a flap of dark paper over the part of
17755 you want to display later.
17756 This method fails, however, if you wish to overlap one graph with another,
17758 You would then have to fumble while speaking to align the two separate,
17763 s to align the two graphs.
17768 environment in both cases makes life much easier.
17771 \begin_layout Standard
17776 receives the page number of its
17777 \begin_inset Quotes eld
17781 \begin_inset Quotes erd
17789 \begin_inset Quotes eld
17797 \begin_inset Quotes erd
17804 \begin_layout Plain Layout
17805 Presumably, mutliple
17810 \begin_inset Quotes eld
17818 \begin_inset Quotes erd
17822 \begin_inset Quotes eld
17830 \begin_inset Quotes erd
17834 \begin_inset Quotes eld
17842 \begin_inset Quotes erd
17846 \begin_inset space ~
17849 appended to the page number of the parent
17859 Clearly, you want the contents of both the
17867 to each fit on a single physical slide! You should probably consider an
17873 \begin_inset Quotes eld
17877 \begin_inset Quotes erd
17885 Indeed, the \SpecialChar LyX
17890 class provides a visual cue for this: the label at the start of an
17894 is shorter than that at the start of a
17899 Lastly, when you generate printable output, you'll find alignment markers
17900 in all four corners of both the
17904 page and its parent
17909 These will assist you in lining up the two physical slides.
17912 \begin_layout Standard
17913 The major problem in overlaying two slides is aligning the contents of the
17914 two transparencies.
17915 How much space should you leave for that graph on the second slide? Worse
17916 still, what if you want a graph and a sentence on second slide, but there
17917 is text on the main transparency that goes in between them? You could try
17918 and insert vertical space of the right size.
17919 The better way is to use
17930 \begin_layout Standard
17931 As their names imply,
17939 are two command-like paragraph environments that make all subsequent text
17940 invisible and visible, respectively.
17942 \begin_inset space ~
17946 \begin_inset CommandInset ref
17948 reference "sec:slideQuirk"
17952 that you don't place anything
17956 these two environments, however.
17961 , it inserts a centered, sky-blue label into the page reading
17962 \begin_inset Quotes eld
17965 <Invisible Text Follows>
17966 \begin_inset Quotes erd
17970 For paragraphs following this label, the parts of the
17978 ; it doesn't matter which] where they would be contain instead blank space.
17982 \begin_layout Standard
17987 , the corresponding centered label is
17988 \begin_inset Quotes eld
17991 <Visible Text Follows>
17992 \begin_inset Quotes erd
17996 Paragraphs following this label behave normally.
17997 Note that the beginning of a new
18009 automatically shuts off an
18014 It's therefore not necessary to use
18025 \begin_layout Standard
18026 By now, it should be obvious how to create overlay transparencies using
18027 the proper combination of
18046 \begin_layout Enumerate
18051 , including everything that will appear on it, whether on the main slide
18059 \begin_layout Enumerate
18060 Before each figure or paragraph that will appear only on the
18069 If necessary, insert a
18073 environment after the
18080 \begin_layout Enumerate
18085 immediately following the
18092 \begin_layout Enumerate
18093 Copy the contents of this
18104 \begin_layout Enumerate
18109 , change all of the
18120 \begin_layout Standard
18122 You've just made an
18129 \begin_layout Standard
18130 There's one problem with the way I've designed the \SpecialChar LyX
18135 class: you can't make text in the middle of a paragraph invisible, nor
18136 make text in the middle of an invisible paragraph visible again.
18137 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
18142 \begin_layout Plain Layout
18143 The commands of interest are:
18146 \begin_layout Itemize
18151 invisible \SpecialChar ldots
18155 \begin_layout Itemize
18160 visible \SpecialChar ldots
18164 \begin_layout Plain Layout
18166 and need to be marked as \SpecialChar TeX
18169 \begin_inset Quotes eld
18173 \begin_inset Quotes erd
18176 you wish to change goes in between the brackets [and after the
18189 If you don't know how to mark text as \SpecialChar TeX
18190 , see the appropriate section of
18203 \begin_layout Subsubsection
18213 \begin_inset CommandInset label
18215 name "sec:slideNote"
18222 \begin_layout Standard
18231 is associated with a
18232 \begin_inset Quotes eld
18236 \begin_inset Quotes erd
18244 Here, too, the \SpecialChar LyX
18249 class provides visual cues.
18254 is shorter than that of a
18258 [yet longer than that of an
18262 ] and, like the label of an
18266 is shockingly magenta.
18267 Additionally, the printed
18271 has the page number of its
18272 \begin_inset Quotes eld
18276 \begin_inset Quotes erd
18284 \begin_inset Quotes eld
18292 \begin_inset Quotes erd
18296 \begin_inset Quotes eld
18304 \begin_inset Quotes erd
18308 \begin_inset Quotes eld
18316 \begin_inset Quotes erd
18320 You can have multiple
18324 s associated with a single
18336 , you'll probably want to break up long
18340 s so that they fit on a single sheet of paper.
18343 \begin_layout Standard
18348 is obvious: it contains anything additional you might want to say about
18354 It could also be used as a sheet of reminders for a particular
18359 In the case of the latter, you might want to make use of time markers.
18360 Currently, the \SpecialChar LyX
18366 \begin_inset Quotes eld
18370 \begin_inset Quotes erd
18373 support for time markers, a
18375 Sli\SpecialChar TeX
18379 So, you'll have to resort to using the \SpecialChar LaTeX
18383 \begin_layout Standard
18384 To use time markers, you'll need to specify the extra class option
18385 \begin_inset Quotes eld
18393 \begin_inset Quotes erd
18397 \begin_inset space ~
18401 \begin_inset CommandInset ref
18403 reference "sec:slidesetup"
18408 This option turns on timing marks, which will appear in the lower-left-hand
18414 To set what appears in the time marker, you use the \SpecialChar LaTeX
18416 \begin_inset Quotes eld
18426 \begin_inset Quotes erd
18430 \begin_inset Quotes eld
18440 \begin_inset Quotes erd
18444 The arguments of both commands are time measured in seconds.
18446 \begin_inset Quotes eld
18456 \begin_inset Quotes erd
18459 sets the time marker to a given time.
18461 \begin_inset Quotes eld
18471 \begin_inset Quotes erd
18474 increments the time marker by the specified amount.
18475 Using time markers and
18479 s in this fashion, you can remind yourself how much time to spend on a particula
18487 \begin_layout Standard
18488 There's one last feature to describe.
18489 Clearly, you'd like to print out all of your
18497 s on transparencies while printing all of your
18514 with which it is associated.
18515 What's a person to do?
18518 \begin_layout Standard
18519 Luckily, there are two \SpecialChar LaTeX
18520 commands that allow you to select what to print
18522 Both must be placed into the preamble of your document.
18524 \begin_inset Quotes eld
18536 \begin_inset Quotes erd
18539 will cause the output to contain only the
18548 Correspondingly, the command
18549 \begin_inset Quotes eld
18561 \begin_inset Quotes erd
18564 prevents the output of anything but
18569 I'd advise placing both commands in the preamble and initially comment
18571 You can then preview your entire presentation as you write.
18572 When you're done writing, you can then uncomment one of the two to select
18573 what you want to print.
18574 I like to uncomment
18575 \begin_inset Quotes eld
18587 \begin_inset Quotes erd
18590 , print to a file with
18591 \begin_inset Quotes eld
18599 \begin_inset Quotes erd
18602 in its name, comment it back out, then uncomment
18603 \begin_inset Quotes eld
18615 \begin_inset Quotes erd
18619 \begin_inset Quotes eld
18627 \begin_inset Quotes erd
18631 I can then send either file to a printer, loading transparencies or plain
18632 paper as appropriate.
18635 \begin_layout Standard
18636 You can also provide other arguments to the
18637 \begin_inset Quotes eld
18647 \begin_inset Quotes erd
18651 \begin_inset Quotes eld
18661 \begin_inset Quotes erd
18665 See a good \SpecialChar LaTeX
18669 \begin_layout Subsection
18674 Class Template File
18677 \begin_layout Standard
18678 I have also provided a template file,
18679 \begin_inset Quotes eld
18687 \begin_inset Quotes erd
18695 To use it, begin your new presentation with
18697 File\SpecialChar menuseparator
18699 \begin_inset space ~
18703 \begin_inset space ~
18709 Your new \SpecialChar LyX
18710 presentation file will contain an example
18731 additionally contain an example of the use of
18740 Lastly, the preamble will contain:
18743 \begin_layout LyX-Code
18744 % Uncomment to print out only slides and overlays
18747 \begin_layout LyX-Code
18751 \begin_layout LyX-Code
18757 \begin_inset Newline newline
18763 \begin_layout LyX-Code
18764 % Uncomment to print out only notes
18767 \begin_layout LyX-Code
18771 \begin_layout LyX-Code
18779 \begin_layout Standard
18780 One final thing: I created this class to support the \SpecialChar LaTeX2e
18782 \begin_inset Quotes eld
18787 Sli\SpecialChar TeX
18791 \begin_inset Quotes erd
18794 class, one of the built-in \SpecialChar LaTeX2e
18796 Neither I nor the rest of the \SpecialChar LyX
18797 Team endorse or oppose the use of this built-in
18799 It's here if you want it or need it.
18800 There exist other \SpecialChar LaTeX2e
18801 classes for creating presentations, such as the
18806 \begin_inset space ~
18810 \begin_inset CommandInset ref
18812 reference "sec:foiltex"
18817 \begin_inset Quotes eld
18825 \begin_inset Quotes erd
18828 package [present on some \SpecialChar TeX
18830 The latter is not yet supported under \SpecialChar LyX
18835 \begin_layout Plain Layout
18836 Perhaps you can take on the task\SpecialChar ldots
18842 I know nothing about these other classes.
18843 Try them out to see what sort of alternative they provide.
18846 \begin_layout Chapter
18848 Features needing Extra Software
18851 \begin_layout Section
18852 Checking \SpecialChar TeX
18856 \begin_layout Standard
18862 \begin_layout Subsection
18866 \begin_layout Standard
18875 \begin_layout Plain Layout
18880 is not yet available when you are using the \SpecialChar LaTeX
18881 distribution MiK\SpecialChar TeX
18887 , you'll find in the
18894 \begin_inset space ~
18905 \begin_inset Newline newline
18909 \begin_inset CommandInset href
18911 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18919 \begin_layout Standard
18922 Chk\SpecialChar TeX
18925 package is a program that was written by
18926 \begin_inset Flex Noun
18929 \begin_layout Plain Layout
18931 \begin_inset space ~
18939 in frustration because some constructs in \SpecialChar LaTeX
18940 are sometimes non-intuitive,
18941 and easy to forget.
18942 The program runs over your \SpecialChar LaTeX
18943 file, checks the integrity of the file, and
18944 flags some common errors.
18945 In other technical words, it is
18949 for \SpecialChar LaTeX
18953 \begin_layout Standard
18954 Well, what is a syntax checker doing in \SpecialChar LyX
18955 which is supposed to produce correct
18957 anyways? The answer is simple: Just as
18961 not only checks the
18965 of C programs, but also does
18969 checks for type-errors,
18971 Chk\SpecialChar TeX
18974 catches some common
18978 errors, in addition to the syntactical ones.
18981 Chk\SpecialChar TeX
18984 is capable of detecting several common errors, such as
18987 \begin_layout Itemize
18988 Ellipsis detection:
18989 \begin_inset Newline newline
18992 Use \SpecialChar ldots
18996 \begin_layout Itemize
18997 No space in front of/after parenthesis:
18998 \begin_inset Newline newline
19004 \begin_layout Itemize
19005 Enforcement of normal space after common abbreviations:
19006 \begin_inset Newline newline
19010 \begin_inset space \thinspace{}
19014 \begin_inset space \space{}
19017 is too wide spacing.
19020 \begin_layout Itemize
19021 Enforcement of end-of-sentence space when the last sentence ends with a
19023 \begin_inset Newline newline
19027 And this is wrong spacing.
19030 \begin_layout Itemize
19031 Space in front of labels and similar commands:
19032 \begin_inset Newline newline
19035 The label should stick right up to the text to avoid falling to a wrong
19038 \begin_inset CommandInset label
19048 \begin_layout Plain Layout
19049 This footnote is in danger of falling off to a wrong page
19054 The label is separated too much.
19057 \begin_layout Itemize
19058 Space in front of references, instead of hard spaces:
19059 \begin_inset Newline newline
19062 If you have bad luck, the text will break right between the referenced text
19063 and reference number, and that's a pity.
19065 \begin_inset CommandInset ref
19067 reference "sec:chktex"
19074 \begin_layout Itemize
19076 \begin_inset Quotes eld
19080 \begin_inset Quotes erd
19084 \begin_inset Formula $\times$
19088 \begin_inset Newline newline
19091 2x2 looks cheap compared to
19092 \begin_inset Formula $2\times2$
19098 \begin_layout Standard
19099 and more \SpecialChar ldots
19100 It is an invaluable tool when you are
19101 \begin_inset Quotes eld
19105 \begin_inset Quotes erd
19108 your document before printing, and you should run it right after the obligatory
19109 spelling check, and before you go fine tuning the typesetting.
19112 \begin_layout Subsection
19116 \begin_layout Standard
19117 If you have the program installed, usage is as simple as choosing
19119 Tools\SpecialChar menuseparator
19121 \begin_inset space ~
19127 This will make \SpecialChar LyX
19128 generate a \SpecialChar LaTeX
19129 file of your document, start
19131 Chk\SpecialChar TeX
19134 to check it, and then make \SpecialChar LyX
19136 \begin_inset Quotes eld
19140 \begin_inset Quotes erd
19143 with the warnings from
19145 Chk\SpecialChar TeX
19148 , if there were any.
19149 The warnings will be placed close to the point of the mistake, and you
19150 can quickly find them by using the
19152 Navigate\SpecialChar menuseparator
19155 menu item, or the shortcut key
19164 Open the error boxes by clicking on them with the mouse, or use the shortcut
19173 bindings, or the corresponding
19182 Read the warning and correct the mistake, if it is a mistake.
19183 If you have trouble understanding what the warning is about, you can safely
19185 Remember that there is a hidden layer between the document on screen and
19186 the technical details in invoking
19188 Chk\SpecialChar TeX
19191 , and this gap can make some warnings seem arcane or just plain silly.
19194 \begin_layout Standard
19195 This document is an excellent testing bed for the feature, and it should
19196 provide quite a few warnings for you to fiddle with.
19197 Since computers are only so smart, expect most of the warnings to be false
19201 \begin_layout Subsection
19202 How to fine tune it
19205 \begin_layout Standard
19206 Sometimes, you'll find that
19208 Chk\SpecialChar TeX
19211 makes more noise than suits your mood.
19212 Then you can choose not to use it, wait until your mood changes, or try
19215 Chk\SpecialChar TeX
19218 to get better along with you.
19221 \begin_layout Standard
19224 Chk\SpecialChar TeX
19231 very configurable and extensible, you should not expect to solve all problems
19234 Chk\SpecialChar TeX
19237 in \SpecialChar LyX
19239 Since \SpecialChar LyX
19240 has to generate a somewhat special \SpecialChar LaTeX
19241 file to be able to match the
19242 line numbers from the
19244 Chk\SpecialChar TeX
19251 \begin_layout Plain Layout
19252 You can inspect the specific output from
19258 Document\SpecialChar menuseparator
19261 \begin_inset space ~
19275 to the internal document structure, some of the warnings will not appear
19277 There are two things you can do about this:
19280 \begin_layout Itemize
19283 Chk\SpecialChar TeX
19286 invocation command line in
19287 \begin_inset Flex Noun
19290 \begin_layout Plain Layout
19291 Tools\SpecialChar menuseparator
19292 Preferences\SpecialChar menuseparator
19293 Output\SpecialChar menuseparator
19294 LaTeX\SpecialChar menuseparator
19302 Chk\SpecialChar TeX
19305 installation configuration file (usually with the file
19310 See below to learn what warnings can be enabled and disabled on the command
19314 \begin_layout Itemize
19315 Export your document as a raw \SpecialChar LaTeX
19318 File\SpecialChar menuseparator
19319 Export\SpecialChar menuseparator
19328 Invoked in this way, it can be a hassle to find the corresponding place
19329 in the document inside \SpecialChar LyX
19330 , but with a little patience, you should be able
19334 \begin_layout Standard
19335 Here follows the warning messages that can be enabled and disabled in
19344 to disable a warning, and
19348 to enable a warning.
19349 The emphasized entries are disabled by default, because the default is
19352 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19357 \begin_layout Standard
19358 Notice that you should only use the options that enable and disable warnings,
19359 because \SpecialChar LyX
19360 relies on some of the other command line parameters to be set
19361 in a specific way to have a chance to communicate with
19368 \begin_layout Enumerate
19372 Command terminated with space.
19375 \begin_layout Enumerate
19378 Non-breaking space (
19379 \begin_inset Quotes eld
19387 \begin_inset Quotes erd
19390 ) should have been used.
19393 \begin_layout Enumerate
19397 You should enclose the previous parenthesis with
19398 \begin_inset Quotes eld
19406 \begin_inset Quotes erd
19412 \begin_layout Enumerate
19415 Italic correction (
19416 \begin_inset Quotes eld
19426 \begin_inset Quotes erd
19429 ) found in non-italic buffer.
19432 \begin_layout Enumerate
19435 Italic correction (
19436 \begin_inset Quotes eld
19446 \begin_inset Quotes erd
19449 ) found more than once.
19452 \begin_layout Enumerate
19456 No italic correction (
19457 \begin_inset Quotes eld
19467 \begin_inset Quotes erd
19473 \begin_layout Enumerate
19477 \begin_inset Quotes eld
19485 \begin_inset Quotes erd
19489 \begin_inset Quotes eld
19497 \begin_inset Quotes erd
19503 \begin_layout Enumerate
19506 Wrong length of dash may have been used.
19509 \begin_layout Enumerate
19513 \begin_inset Quotes eld
19521 \begin_inset Quotes erd
19525 \begin_inset Quotes eld
19533 \begin_inset Quotes erd
19539 \begin_layout Enumerate
19543 \begin_inset Quotes eld
19551 \begin_inset Quotes erd
19557 \begin_layout Enumerate
19561 \begin_inset Quotes eld
19569 \begin_inset Quotes erd
19572 to achieve an ellipsis.
19575 \begin_layout Enumerate
19578 Inter-word spacing (
19579 \begin_inset Quotes eld
19589 \begin_inset Quotes eld
19592 ) should perhaps be used.
19595 \begin_layout Enumerate
19598 Inter-sentence spacing (
19599 \begin_inset Quotes eld
19609 \begin_inset Quotes erd
19612 ) should perhaps be used.
19615 \begin_layout Enumerate
19618 Could not find argument for command.
19621 \begin_layout Enumerate
19625 \begin_inset Quotes eld
19633 \begin_inset Quotes erd
19639 \begin_layout Enumerate
19642 Math mode still on at end of \SpecialChar LaTeX
19646 \begin_layout Enumerate
19650 \begin_inset Quotes eld
19658 \begin_inset Quotes erd
19661 doesn't match the number of
19662 \begin_inset Quotes eld
19670 \begin_inset Quotes erd
19676 \begin_layout Enumerate
19679 You should use either
19682 \begin_inset Quotes eld
19690 \begin_inset Quotes erd
19695 as an alternative to
19696 \begin_inset Quotes eld
19704 \begin_inset Quotes erd
19710 \begin_layout Enumerate
19717 " (ASCII 39) instead of "
19724 \begin_layout Enumerate
19727 User-specified pattern found.
19730 \begin_layout Enumerate
19733 This command might not be intended.
19736 \begin_layout Enumerate
19743 \begin_layout Enumerate
19761 \begin_layout Enumerate
19764 Delete this space to maintain correct page references.
19767 \begin_layout Enumerate
19771 You might wish to put this between a pair of
19772 \begin_inset Quotes eld
19780 \begin_inset Quotes erd
19786 \begin_layout Enumerate
19789 You ought to remove spaces in front of punctuation.
19792 \begin_layout Enumerate
19795 Could not execute \SpecialChar LaTeX
19799 \begin_layout Enumerate
19808 in front of small punctuation.
19811 \begin_layout Enumerate
19819 may look prettier here.
19822 \begin_layout Enumerate
19826 Multiple spaces detected in output.
19829 \begin_layout Enumerate
19832 This text may be ignored.
19835 \begin_layout Enumerate
19841 \begin_inset Quotes eld
19846 to begin quotation, not
19853 \begin_layout Enumerate
19860 to end quotation, not
19863 \begin_inset Quotes eld
19871 \begin_layout Enumerate
19877 \begin_layout Enumerate
19880 You should perhaps use
19881 \begin_inset Quotes eld
19889 \begin_inset Quotes erd
19895 \begin_layout Enumerate
19898 You should put a space in front of/after parenthesis.
19901 \begin_layout Enumerate
19904 You should avoid spaces in front of/after parenthesis.
19907 \begin_layout Enumerate
19911 You should not use punctuation in front of/after quotes.
19914 \begin_layout Enumerate
19917 Double space found.
19920 \begin_layout Enumerate
19923 You should put punctuation outside inner/inside display math mode.
19926 \begin_layout Enumerate
19929 You ought to not use primitive \SpecialChar TeX
19930 in \SpecialChar LaTeX
19934 \begin_layout Enumerate
19937 You should remove spaces in front of
19938 \begin_inset Quotes eld
19946 \begin_inset Quotes erd
19952 \begin_layout Enumerate
19955 \begin_inset Quotes eld
19963 \begin_inset Quotes erd
19966 is normally not followed by
19967 \begin_inset Quotes eld
19975 \begin_inset Quotes erd
19981 \begin_layout Standard
19982 In later versions of \SpecialChar LyX
19983 , we hope to provide a more complete interface to this
19984 tool (and it's smaller cousin
19988 ) to exploit the full power of it.
19989 But it's not exactly useless as it is now: go try it on one of your existing
19990 documents of a certain length and be surprised.
19993 \begin_layout Section
19994 Version Control in \SpecialChar LyX
19998 \begin_layout Standard
20001 Lars Gullik Bjønnes
20008 \begin_layout Subsection
20012 \begin_layout Standard
20014 supports some of the most basic RCS/CVS/SVN/GIT commands.
20015 If you need something a bit more sophisticated you will have to do that
20016 manually in a terminal.
20019 \begin_layout Standard
20020 Also note that CVS support is not as good as subversion support, so we advise
20022 A good place to start learning Subversion is the SVN Book
20026 \begin_layout Plain Layout
20027 \begin_inset CommandInset href
20029 target "http://svnbook.red-bean.com/"
20040 In the case of RCS you should read
20041 \begin_inset Quotes eld
20045 \begin_inset Quotes erd
20048 (a man file, read it with
20053 This file describes all the basic features of RCS.
20054 You should especially notice the comment about a RCS directory, and the
20055 notion of a master RCS file (the file ending in
20062 \begin_layout Standard
20063 Before you begin to use the version control features in \SpecialChar LyX
20065 familiar with RCS/CVS/SVN/GIT usage.
20066 The implementation in \SpecialChar LyX
20067 assumes a recent version of the GNU RCS or CVS/SVN
20068 package — no guarantees are made for older versions.
20069 Most of the log messages are not currently displayed after operations —
20070 you can check them in the Messages pane if you are unsure.
20071 Regular users of version control will appreciate the VC toolbar, which
20074 View\SpecialChar menuseparator
20075 Toolbars\SpecialChar menuseparator
20077 \begin_inset space ~
20085 \begin_layout Standard
20086 For introducing your own external commands consult
20087 \begin_inset Flex Code
20090 \begin_layout Plain Layout
20104 \begin_layout Standard
20105 It is strongly recommended to store documents in uncompressed format if
20106 using version control (uncheck
20108 Document\SpecialChar menuseparator
20111 if it is checked): Uncompressed LyX documents are text files and therefore
20112 for merging two different versions by version control systems.
20113 Compressed LyX documents are binary files, which cannot be merged by version
20117 \begin_layout Subsection
20118 RCS commands in \SpecialChar LyX
20122 \begin_layout Standard
20123 The following sections describe the RCS commands supported by \SpecialChar LyX
20125 You can find them in the
20127 File\SpecialChar menuseparator
20129 \begin_inset space ~
20136 was tested against RCS 5.7/5.8.
20139 \begin_layout Subsubsection
20145 \begin_layout Standard
20146 If your document is not under revision control, this is the only item shown
20148 And if it is under revision control, the
20152 item is not visible.
20156 \begin_layout Standard
20157 This command registers your document with RCS (unless you are under the
20158 directory managed by CVS)\SpecialChar endofsentence
20159 You are asked interactively to supply an initial
20160 description of the document.
20161 The document is now set in Read-Only mode and you have to
20164 \begin_inset space ~
20168 \begin_inset space ~
20172 \begin_inset space ~
20177 , before making any changes to it.
20178 A document under revision control has a
20179 \begin_inset Quotes eld
20182 [RCS:<version> <locker>]
20183 \begin_inset Quotes erd
20186 item tagged to the filename in the minibuffer.
20189 \begin_layout Standard
20190 RCS command that is run:
20193 \begin_layout LyX-Code
20196 ci -q -u -i -t-"<initial description>" <file-name>
20199 \begin_layout Standard
20204 to understand the switches.
20208 \begin_layout Subsubsection
20214 \begin_layout Standard
20215 When you are finished editing a file, you check in your changes.
20216 When you do this, you are asked for a description of the changes.
20217 This is stored in the history log.
20218 The version number is bumped, your changes are applied to the master RCS
20219 file, the document is unlocked and set to Read-Only mode.
20222 \begin_layout Itemize
20225 ci -q -u -m"<description>" <file-name>
20228 \begin_layout Subsubsection
20234 \begin_layout Standard
20235 By doing this you lock the document so that only you can edit it.
20236 This will also make the document Read-Write only for you.
20237 You will usually continue editing for a while and when you are finished
20238 you check in your changes.
20239 The status line is changed to reflect that you have locked the file.
20242 \begin_layout Itemize
20245 co -q -l <file-name>
20248 \begin_layout Subsubsection
20251 Revert To Repository Version
20254 \begin_layout Standard
20255 This will discard all changes made to the document since the last check
20257 You get a warning before changes are discarded.
20260 \begin_layout Itemize
20263 co -f -u<version> <file-name>
20266 \begin_layout Subsubsection
20272 \begin_layout Standard
20273 This will create a copy of the current document.
20274 Since RCS does not support copy operations natively, the version history
20275 is not preserved, and the copy is added as a new file.
20276 It requires a clean document without any changes since the last checkin.
20277 You are asked for a file name and a description of the copy operation.
20278 After that the copy is created, both locally and in the repository.
20279 If the parent directories of the copied and original document differ, all
20280 relative paths of included files of the copy are adjusted (like in
20282 File\SpecialChar menuseparator
20287 Finally, the copy is loaded instead of the original document.
20290 \begin_layout Labeling
20291 \labelwidthstring 00.00.0000
20293 \begin_inset space ~
20297 \begin_inset space ~
20301 \begin_inset Newline newline
20305 \begin_inset Flex Code
20308 \begin_layout Plain Layout
20311 \begin_inset Quotes qld
20315 \begin_inset Quotes qld
20324 \begin_inset Flex Code
20327 \begin_layout Plain Layout
20330 \begin_inset Quotes qld
20334 \begin_inset Quotes qld
20343 \begin_inset Newline newline
20347 \begin_inset Flex Code
20350 \begin_layout Plain Layout
20354 \begin_inset Quotes qld
20358 \begin_inset Quotes qld
20369 \begin_layout Subsubsection
20375 \begin_layout Standard
20376 This makes as if the last check in never happened.
20377 No changes are made to the document loaded into \SpecialChar LyX
20378 , but the last version
20379 is removed from the master RCS file.
20382 \begin_layout Itemize
20385 rcs -o<version> <file-name>
20388 \begin_layout Subsubsection
20394 \begin_layout Standard
20395 This shows the complete history of the RCS document.
20400 is shown in a browser.
20408 \begin_layout Subsubsection
20412 \begin_layout Standard
20414 supports RCS version number, author name, date and time of last commit.
20415 All those are extracted from
20417 rlog -r <file-name>
20421 \begin_inset CommandInset ref
20423 reference "subsec:VCS-Revision-Information"
20430 \begin_layout Subsection
20431 CVS commands in \SpecialChar LyX
20435 \begin_layout Standard
20436 A subset of CVS operations is supported by \SpecialChar LyX
20438 You can find the commands in the
20440 File\SpecialChar menuseparator
20442 \begin_inset space ~
20448 The version control system SVN is more powerful, so please use it instead
20449 of CVS if possible.
20452 \begin_layout Subsubsection
20458 \begin_layout Standard
20459 If you start from scratch with CVS you have to create your repository and
20460 checkout the working copy with external tools.
20461 If you're using a client-server setup you may need to login before doing
20462 the first repository checkout.
20465 \begin_layout Standard
20466 If your documents are under revision control and others are using the same
20467 repository problems arise when different changes to the same document at
20468 the same location happen.
20469 Standard CVS repositories don't operate with a file locking mechanism.
20470 This may be surprising, but conflicts only occur if people disagree on
20471 the proper content of the same part of a document.
20472 So, if co-workers are used to communicate regularly, these conflicts occur
20474 If they don't communicate they have a fundamental problem anyway.
20475 Nevertheless some people like to work with so called
20476 \begin_inset Quotes eld
20480 \begin_inset Quotes erd
20484 If they do so the working copy of all files is readonly when checked out
20485 first and the user starts editing after using a special command to make
20486 the working copy writable.
20487 When the changes are checked in the working copy returns to readonly state.
20488 With \SpecialChar LyX
20489 one has to edit the
20490 \begin_inset Flex Code
20493 \begin_layout Plain Layout
20499 file and add the line
20500 \begin_inset Flex Code
20503 \begin_layout Plain Layout
20509 to work with reserved checkouts.
20510 The benefit is the possibility to see who is using a writable copy of some
20512 It's not guaranteed only one user makes a copy writable.
20515 \begin_layout Standard
20517 tries to guess if you're using reserved or non-reserved checkouts.
20518 If your working copy is readonly or it is writable and an additional copy
20519 of your document exists in the CVS/Base sub-directory a reserved otherwise
20520 a non-reserved checkout is assumed.
20521 When a reserved checkout is detected you have to use
20522 \begin_inset Flex Noun
20525 \begin_layout Plain Layout
20531 to make your working copy writable if it's readonly.
20533 \begin_inset Flex Noun
20536 \begin_layout Plain Layout
20542 operation is possible and that makes your working copy readonly again after
20543 transferring your changes to the repository.
20546 \begin_layout Standard
20547 More information about CVS can be found here
20548 \begin_inset Flex URL
20551 \begin_layout Plain Layout
20553 http://www.nongnu.org/cvs
20559 \begin_inset Flex URL
20562 \begin_layout Plain Layout
20564 http://ximbiot.com/cvs
20572 \begin_layout Standard
20577 to understand the sub-commands and the switches mentioned below.
20580 \begin_layout Subsubsection
20586 \begin_layout Standard
20587 If your document is not under revision control, this is the only item shown
20589 And if it is under revision control, the
20593 item is not visible.
20597 \begin_layout Standard
20598 This command registers in CVS your document
20599 \begin_inset Flex Strong
20602 \begin_layout Plain Layout
20610 in the case you have already the documents directory under CVS control
20616 This means you have to create or checkout the archive by yourself using
20618 (In case you forget that step \SpecialChar LyX
20619 registers the document with RCS.)
20622 \begin_layout Standard
20623 Then you are asked interactively to supply an initial description of the
20625 Don't forget that registered file is not yet checked in.
20628 \begin_layout Standard
20629 CVS command that is run:
20631 cvs -q add -m"<entered message>" "<file-name>"
20634 \begin_layout Standard
20639 above and for all other CVS commands is an abbreviation for
20640 \begin_inset Quotes eld
20643 change the current working directory to file location and use the file name
20644 without path component as argument
20645 \begin_inset Quotes erd
20651 \begin_layout Subsubsection
20657 \begin_layout Standard
20658 When you are finished editing a file, you commit your changes.
20659 When you do this and you had changed the document, you are asked for a
20660 description of the changes.
20661 After that changes are written to the repository.
20662 In case you didn't change the document and a reserved checkout is detected
20663 the reservation made on
20664 \begin_inset Flex Noun
20667 \begin_layout Plain Layout
20676 \begin_layout Labeling
20677 \labelwidthstring 00.00.0000
20679 \begin_inset space ~
20683 \begin_inset space ~
20687 \begin_inset Newline newline
20691 \begin_inset Flex Code
20694 \begin_layout Plain Layout
20697 -q commit -m"<description>" "<file-name>"
20703 \begin_inset Newline newline
20707 \begin_inset Flex Code
20710 \begin_layout Plain Layout
20721 \begin_layout Subsubsection
20727 \begin_layout Standard
20728 When you are sharing a repository with others, you may have to incorporate
20729 their changes into your working copy.
20732 \begin_layout Standard
20735 cvs -q update "<file-name>"
20738 \begin_layout Standard
20739 If a readonly checkout is detected the working copy is made writable and
20743 \begin_layout Standard
20746 cvs -q edit "<file-name>"
20749 \begin_layout Subsubsection
20752 Revert To Repository Version
20755 \begin_layout Standard
20756 This will discard all changes made to the document since the last check
20758 You get a warning before changes are discarded.
20759 Firstly the file is deleted, secondly CVS update command is run.
20762 \begin_layout Standard
20765 cvs -q update "<file-name>"
20768 \begin_layout Standard
20769 If a reserved checkout is detected and the working copy has no changes only
20770 the reservation is undone.
20773 \begin_layout Standard
20776 cvs -q unedit "<file-name>"
20779 \begin_layout Subsubsection
20785 \begin_layout Standard
20786 This will create a copy of the current document.
20787 Since CVS does not support copy operations natively, the version history
20788 is not preserved, and the copy is added as a new file.
20789 It requires a clean document without any changes since the last checkin.
20790 You are asked for a file name and a description of the copy operation.
20791 After that the copy is created, both locally and in the repository.
20792 If the parent directories of the copied and original document differ, all
20793 relative paths of included files of the copy are adjusted (like in
20795 File\SpecialChar menuseparator
20800 Finally, the copy is loaded instead of the original document.
20803 \begin_layout Labeling
20804 \labelwidthstring 00.00.0000
20806 \begin_inset space ~
20810 \begin_inset space ~
20814 \begin_inset Newline newline
20818 \begin_inset Flex Code
20821 \begin_layout Plain Layout
20828 \begin_inset Flex Code
20831 \begin_layout Plain Layout
20838 \begin_inset Newline newline
20842 \begin_inset Flex Code
20845 \begin_layout Plain Layout
20846 cvs -q add "<new-file-name>"
20854 \begin_layout Subsubsection
20860 \begin_layout Standard
20861 This will rename the current document.
20862 Since CVS does not support rename operations natively, the version history
20863 is not preserved, the renamed document is added as a new file, and the
20864 original document is deleted.
20865 It requires a clean document without any changes since the last checkin.
20866 You are asked for a file name and a description of the rename operation.
20867 After that the document is renamed, both locally and in the repository.
20868 If the parent directories of the new and old file names differ, all relative
20869 paths of included files are adjusted (like in
20871 File\SpecialChar menuseparator
20876 Finally, the document is reloaded using the new name.
20879 \begin_layout Labeling
20880 \labelwidthstring 00.00.0000
20882 \begin_inset space ~
20886 \begin_inset space ~
20890 \begin_inset Newline newline
20894 \begin_inset Flex Code
20897 \begin_layout Plain Layout
20904 \begin_inset Flex Code
20907 \begin_layout Plain Layout
20914 \begin_inset Newline newline
20918 \begin_inset Flex Code
20921 \begin_layout Plain Layout
20922 cvs -q add "<new-file-name>"
20928 \begin_inset Newline newline
20932 \begin_inset Flex Code
20935 \begin_layout Plain Layout
20936 cvs -q remove "<file-name>"
20944 \begin_layout Subsubsection
20945 Update of the local directory checkout from repository
20948 \begin_layout Standard
20949 Once your documents gets more complex, containing sub-documents and pictures,
20951 \begin_inset Flex Code
20954 \begin_layout Plain Layout
20960 files and so on using version control becomes more complicated.
20962 supports updating the whole tree in which resides the document.
20963 This become especially useful once you cooperate with people which neither
20964 have detailed knowledge about CVS usage nor they have ambition to commit
20965 additional material to the repository.
20966 You have to organize the files structure so that all external files are
20967 in the same directory or subdirectories of the document.
20968 It's good practice anyway to store multipart documents in an extra directory.
20971 \begin_layout Standard
20973 \begin_inset Flex Code
20976 \begin_layout Plain Layout
20977 Update local directory from repository
20982 command updates the whole directory.
20983 If local changes are detected user is warned before update starts.
20984 In case of merge conflicts both versions of the conflicting document parts
20985 are placed in the final document.
20986 You have to review and correct the result of the merge.
20987 You'll find the conflicts enclosed in pairs of
20988 \begin_inset Flex Code
20991 \begin_layout Plain Layout
20998 \begin_inset Flex Code
21001 \begin_layout Plain Layout
21008 \begin_inset Flex Code
21011 \begin_layout Plain Layout
21018 The first part is your version as before the update operation with the
21019 document name prepended.
21020 The second one is the repository version with the version number after
21022 \begin_inset Flex Code
21025 \begin_layout Plain Layout
21034 \begin_layout Labeling
21035 \labelwidthstring 00.00.0000
21037 \begin_inset space ~
21041 \begin_inset space ~
21045 \begin_inset Newline newline
21049 \begin_inset Flex Code
21052 \begin_layout Plain Layout
21060 (Ask if changes are detected.)
21061 \begin_inset Newline newline
21065 \begin_inset Flex Code
21068 \begin_layout Plain Layout
21069 cd $path; cvs -q update
21079 \begin_layout Standard
21081 \begin_inset Flex Code
21084 \begin_layout Plain Layout
21090 stands for the path to the document.
21093 \begin_layout Subsubsection
21099 \begin_layout Standard
21100 This shows the complete history of the CVS document.
21103 cvs log "<file-name>"
21105 is shown in a browser.
21108 \begin_layout Subsubsection
21112 \begin_layout Standard
21114 supports CVS version number, author name, date and time of last commit.
21115 All those are extracted from
21117 cvs log -r <file-name>
21121 \begin_inset CommandInset ref
21123 reference "subsec:VCS-Revision-Information"
21130 \begin_layout Subsection
21131 SVN commands in \SpecialChar LyX
21135 \begin_layout Standard
21136 SVN is now partially supported by \SpecialChar LyX
21138 You can find the commands in the
21140 File\SpecialChar menuseparator
21142 \begin_inset space ~
21148 Please note that if you use password protected access to repository via
21149 ssh, you will be asked in terminal window.
21151 was tested against SVN 1.5, 1.6, 1.7 and 1.8
21155 \begin_layout Plain Layout
21156 Most of the commands will work with 1.4 too, see
21157 \begin_inset CommandInset ref
21159 reference "subsec:SVN-Repo-Update"
21164 There seems to be currently unresolved permissions problem under SVN 1.8
21165 with reverting changes when file is locked.
21173 \begin_layout Subsubsection
21179 \begin_layout Standard
21180 If your document is not under revision control, this is the only item shown
21182 And if it is under revision control, the
21186 item is not visible.
21189 \begin_layout Standard
21190 This command registers in SVN your document ONLY in case you have already
21191 the documents directory under SVN control (in particular
21196 This means you have to checkout the archive by yourself.
21199 \begin_layout Standard
21200 Then you are asked interactively to supply an initial description of the
21202 Don't forget that registered file is not yet commited.
21205 \begin_layout Standard
21206 SVN command that is run:
21209 \begin_inset Quotes qld
21213 \begin_inset Quotes qld
21219 \begin_layout Standard
21224 to understand the switches.
21227 \begin_layout Subsubsection
21233 \begin_layout Standard
21234 When you are finished editing a file, you commit your changes.
21235 When you do this, you are asked for a description of the changes.
21236 After that changes are commited.
21239 \begin_layout Standard
21244 \begin_layout Plain Layout
21245 In case locking is not enabled.
21247 \begin_inset CommandInset ref
21249 reference "subsec:SVN-File-Locking"
21260 svn commit -q -m"<description>" <file-name>
21263 \begin_layout Subsubsection
21269 \begin_layout Standard
21270 Updates the changes of this file from the repository.
21271 Be sure you understand SVN merging and conflicts resolving before using
21272 this function, because all conflicts has to be resolved manually by you!
21275 \begin_layout Standard
21280 \begin_layout Plain Layout
21288 svn update --non-interactive
21289 \begin_inset Quotes qld
21293 \begin_inset Quotes qld
21299 \begin_layout Subsubsection
21302 Revert To Repository Version
21305 \begin_layout Standard
21306 This will discard all changes made to the document since the last check
21308 You get a warning before changes are discarded.
21311 \begin_layout Standard
21315 \begin_inset Quotes qld
21319 \begin_inset Quotes qld
21325 \begin_layout Subsubsection
21331 \begin_layout Standard
21332 This will create a copy of the current document including the version history.
21333 It requires a clean document without any changes since the last checkin.
21334 You are asked for a file name and a description of the copy operation.
21335 After that the copy is created, both locally and in the repository.
21336 If the parent directories of the copied and original document differ, all
21337 relative paths of included files of the copy are adjusted (like in
21339 File\SpecialChar menuseparator
21344 Finally, the copy is loaded instead of the original document.
21347 \begin_layout Labeling
21348 \labelwidthstring 00.00.0000
21350 \begin_inset space ~
21354 \begin_inset space ~
21358 \begin_inset Newline newline
21362 \begin_inset Flex Code
21365 \begin_layout Plain Layout
21369 \begin_inset Quotes qld
21373 \begin_inset Quotes qld
21377 \begin_inset Quotes qld
21381 \begin_inset Quotes qld
21390 \begin_inset Newline newline
21394 \begin_inset Flex Code
21397 \begin_layout Plain Layout
21406 \begin_layout Subsubsection
21412 \begin_layout Standard
21413 This will rename the current document including the version history.
21414 It requires a clean document without any changes since the last checkin.
21415 You are asked for a file name and a description of the rename operation.
21416 After that the document is renamed, both locally and in the repository.
21417 If the parent directories of the new and old file names differ, all relative
21418 paths of included files are adjusted (like in
21420 File\SpecialChar menuseparator
21425 Finally, the document is reloaded using the new name.
21428 \begin_layout Labeling
21429 \labelwidthstring 00.00.0000
21431 \begin_inset space ~
21435 \begin_inset space ~
21439 \begin_inset Newline newline
21443 \begin_inset Flex Code
21446 \begin_layout Plain Layout
21450 \begin_inset Quotes qld
21454 \begin_inset Quotes qld
21458 \begin_inset Quotes qld
21462 \begin_inset Quotes qld
21471 \begin_inset Newline newline
21475 \begin_inset Flex Code
21478 \begin_layout Plain Layout
21487 \begin_layout Subsubsection
21488 \begin_inset CommandInset label
21490 name "subsec:SVN-Repo-Update"
21494 Update of the local directory checkout from repository
21498 \begin_layout Plain Layout
21499 Note that this command will work only with subversion
21500 \begin_inset Formula $\geqq1.5$
21511 \begin_layout Standard
21512 All the commands above have one shortcoming – they deal with the current
21514 Once your document contains pictures, includes external
21515 \begin_inset Flex Code
21518 \begin_layout Plain Layout
21524 files and so on administration becomes more complicated.
21526 now supports updating the whole tree in which resides the document
21530 \begin_layout Plain Layout
21531 One need to organize the files structure so that all external files are
21532 in the same directory or subdirectories of the document.
21539 This become especially useful once you cooperate with people which neither
21540 know about subversion management nor they have ambition to commit additional
21541 material to the repository.
21545 \begin_layout Standard
21546 \begin_inset Flex Code
21549 \begin_layout Plain Layout
21550 Update local directory from repository
21555 command updates the whole directory and in case of merge conflicts local
21556 version of the files are left, so no unintended data loss occurs.
21557 If local changes are detected user is warned before update starts.
21560 \begin_layout Labeling
21561 \labelwidthstring 00.00.0000
21563 \begin_inset space ~
21567 \begin_inset space ~
21571 \begin_inset Newline newline
21575 \begin_inset Flex Code
21578 \begin_layout Plain Layout
21584 (Ask if changes are detected.)
21585 \begin_inset Newline newline
21589 \begin_inset Flex Code
21592 \begin_layout Plain Layout
21593 svn update --accept mine-full $path
21601 \begin_layout Standard
21603 \begin_inset Flex Code
21606 \begin_layout Plain Layout
21612 stands for the path to the document.
21615 \begin_layout Subsubsection
21621 \begin_layout Standard
21622 This shows the complete history of the SVN document.
21626 \begin_inset Quotes qld
21630 \begin_inset Quotes qld
21635 is shown in a browser.
21638 \begin_layout Subsubsection
21640 \begin_inset CommandInset label
21642 name "subsec:SVN-File-Locking"
21649 \begin_layout Standard
21650 The file exchange through various revision control systems brings the problem
21651 of merge conflicts in case two different users try to edit the same (parts
21653 When such a conflict happens it needs manual resolving and one reasonable
21654 alternative is to provide some kind of locking mechanism, which guarantees
21655 that only one user is allowed to edit file at the given time.
21658 \begin_layout Standard
21659 SVN has two such mechanisms to provide mutual exclusivity for file access
21660 – locks and automatic setting of write permissions (see sec.
21662 \begin_inset CommandInset ref
21664 reference "subsec:Automatical-Locking-Property"
21669 \begin_inset Flex Code
21672 \begin_layout Plain Layout
21682 \begin_layout Plain Layout
21683 \begin_inset Flex URL
21686 \begin_layout Plain Layout
21688 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21699 If this property is detected for a given document \SpecialChar LyX
21700 starts to use SVN locks
21701 for document editing automatically and the whole check-in/out mechanism
21702 switches to the same regimen as for RCS.
21703 This in particular means there are two different modes of file use in \SpecialChar LyX
21707 \begin_layout Itemize
21709 The loaded file is in the read-only mode.
21710 For editing on needs to check-out.
21715 consists of updating from the repository and gaining write lock.
21716 If the lock is not possible to obtain, we remain in unlocked state.
21719 \begin_layout Itemize
21721 The loaded file is in the
21722 \begin_inset Quotes els
21726 \begin_inset Quotes ers
21730 No other user is allowed to edit the file.
21735 consists of commiting changes and releasing write-lock.
21736 If no changes have been made to the document, no commit will be produced
21740 \begin_layout Plain Layout
21741 Don't be puzzled by the fact that you will be asked for commit message anyway.
21746 and only the write-lock will be released.
21749 \begin_layout Standard
21753 \begin_layout Labeling
21754 \labelwidthstring 00.00.0000
21757 svn commit -q -m"<description>" "<file-name>"
21758 \begin_inset Newline newline
21761 svn unlock "<file-name>"
21764 \begin_layout Labeling
21765 \labelwidthstring 00.00.0000
21768 svn update "<file-name>"
21769 \begin_inset Newline newline
21772 svn lock "<file-name>"
21775 \begin_layout Subsubsection
21778 \begin_inset CommandInset label
21780 name "subsec:Automatical-Locking-Property"
21786 Automatic Locking Property
21789 \begin_layout Standard
21790 The above mentioned automatic setting of write permissions of the .lyx file
21793 File\SpecialChar menuseparator
21795 \begin_inset space ~
21798 Control\SpecialChar menuseparator
21799 Use Locking Property
21802 This command is active only when the file is not locked on the svn server
21804 you need to check-out before proceeding).
21807 \begin_layout Labeling
21808 \labelwidthstring 00.00.0000
21810 \begin_inset space ~
21816 \begin_layout Labeling
21817 \labelwidthstring 00.00.0000
21820 svn propset svn:needs-lock ON "<file-name>"
21823 \begin_layout Labeling
21824 \labelwidthstring 00.00.0000
21827 svn propdel svn:needs-lock "<file-name>"
21830 \begin_layout Subsubsection
21831 \begin_inset CommandInset label
21833 name "subsec:VCS-Revision-Information"
21837 Revision Information in Documents
21840 \begin_layout Standard
21841 There are more possibilities how to activate revision information in our
21845 \begin_layout Itemize
21851 \begin_layout Itemize
21852 tree revision information (
21853 \begin_inset Flex Code
21856 \begin_layout Plain Layout
21863 The result is the output of the
21864 \begin_inset Flex Code
21867 \begin_layout Plain Layout
21873 command, the following table gives you an idea, how to read the results.
21876 \begin_layout Standard
21878 \begin_inset Tabular
21879 <lyxtabular version="3" rows="6" columns="2">
21880 <features tabularvalignment="middle">
21881 <column alignment="left" valignment="top">
21882 <column alignment="left" valignment="top">
21884 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21887 \begin_layout Plain Layout
21895 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21898 \begin_layout Plain Layout
21908 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21911 \begin_layout Plain Layout
21917 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21920 \begin_layout Plain Layout
21921 mixed revision working copy
21928 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21931 \begin_layout Plain Layout
21937 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21940 \begin_layout Plain Layout
21941 modified working copy
21948 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21951 \begin_layout Plain Layout
21957 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21960 \begin_layout Plain Layout
21961 switched working copy
21968 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21971 \begin_layout Plain Layout
21977 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21980 \begin_layout Plain Layout
21981 partial working copy, from a sparse checkout
21988 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21991 \begin_layout Plain Layout
21997 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22000 \begin_layout Plain Layout
22001 mixed revision, modified, switched working copy
22014 \begin_layout Itemize
22015 file revision information.
22016 The result comes from parsing the output of
22017 \begin_inset Flex Code
22020 \begin_layout Plain Layout
22022 \begin_inset space ~
22026 \begin_inset space ~
22030 \begin_inset space ~
22039 Supported flags are:
22043 \begin_layout Itemize
22044 version number of the last commit (
22045 \begin_inset Flex Code
22048 \begin_layout Plain Layout
22057 \begin_layout Itemize
22058 author of the last commit (
22059 \begin_inset Flex Code
22062 \begin_layout Plain Layout
22071 \begin_layout Itemize
22072 date of the last commit (
22073 \begin_inset Flex Code
22076 \begin_layout Plain Layout
22085 \begin_layout Itemize
22086 time of the last commit (
22087 \begin_inset Flex Code
22090 \begin_layout Plain Layout
22100 \begin_layout Standard
22101 You can obtain this info via InsetInfo (
22102 \change_inserted 5863208 1564400022
22105 Insert\SpecialChar menuseparator
22106 Field\SpecialChar menuseparator
22107 Version Control Revision
22108 \change_deleted 5863208 1564399852
22113 \begin_inset Flex Code
22116 \begin_layout Plain Layout
22117 info-insert buffer vcs-date
22125 The information will be available only when you have the file stored under
22126 svn managment (i.e.
22128 \begin_inset Flex Code
22131 \begin_layout Plain Layout
22137 directory is available with your document).
22141 \begin_layout Itemize
22142 Another—a hacking one—possibility is to use svn keywords
22146 \begin_layout Plain Layout
22147 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
22153 In short – you set file keywords property (e.g.
22156 svn propset svn:keywords 'Rev' file.lyx
22158 ) and then paste keyword \SpecialChar TeX
22163 \begin_layout Plain Layout
22164 This is an easy way how to ensure that \SpecialChar LyX
22165 won't break the line in the middle
22171 tag in your document (e.g.
22173 \begin_inset Flex Code
22176 \begin_layout Plain Layout
22183 This way svn client will automatically substitute revision number (e.g.
22185 \begin_inset Flex Code
22188 \begin_layout Plain Layout
22194 ) after each update and commit.
22195 There are more problems with this approach.
22196 Firstly, the '$' character is used in \SpecialChar TeX
22197 world for math equations, so any
22198 occurence of math formula
22199 \begin_inset Formula $Rev$
22203 \begin_inset Formula $Rev:59$
22206 in your \SpecialChar LyX
22208 Similarly for other keywords like Id, Date, Author, etc.
22209 Secondly svn output is dependent on your locales, so its very easy that
22210 svn would produce some problematic strings once Date is used.
22211 Thirdly you get the whole 'Rev: 59' string in your document instead of
22213 Until subversion implements user's custom keywords it will be hard to use
22214 this approach reliably or let \SpecialChar LyX
22215 to support it directly.
22218 \begin_layout Subsection
22219 SVN and Windows Environment
22222 \begin_layout Quote
22223 My inclination is to say that if the user cannot figure out the command
22224 line operations on their own fairly quickly, they would be well advised
22225 to use TortoiseSVN.
22231 \begin_layout Subsubsection
22235 \begin_layout Standard
22236 In addition to installing \SpecialChar LyX
22237 , and having access to a Subversion repository,
22238 the user will need to install the Subversion client program.
22239 A Windows installer for the client program is available from
22240 \begin_inset CommandInset href
22243 target "http://www.collab.net/nonav/downloads/subversion/"
22249 The user may also want to install
22250 \begin_inset CommandInset href
22253 target "http://tortoisesvn.tigris.org/"
22258 , which integrates Subversion operations into the context (rightclick) menu
22259 of Windows Explorer.
22260 Operations done outside \SpecialChar LyX
22261 will typically be more convenient using the Explorer
22263 Note that TortoiseSVN is not a replacement for the client program, which
22264 is what \SpecialChar LyX
22268 \begin_layout Subsubsection
22269 Bringing a document under Subversion control
22272 \begin_layout Standard
22273 Before a \SpecialChar LyX
22274 document can be brought under version control in Subversion, its
22275 parent directory needs to be under version control.
22276 If the document is being added to a project already in the repository,
22277 this is accomplished by checking the project out to the directory where
22278 the new document will be placed.
22279 If the project itself is not yet under version control (for instance, if
22280 this document starts a new project), the directory must be imported into
22282 This is done outside \SpecialChar LyX
22284 Both import and checkout are easily accomplished from the Explorer context
22285 menu using TortoiseSVN, or alternatively can be done using the command
22286 line client at a DOS prompt.
22287 The procedure for importing the project using TortoiseSVN is described
22288 below, assuming an existing repository and a new project being started
22296 For information on using the Subversion client program, run
22303 \begin_layout Enumerate
22310 in Windows Explorer, right click it, and select
22312 TortoiseSVN\SpecialChar menuseparator
22316 If necessary, adjust the URL for the repository, then click OK.
22319 \begin_layout Enumerate
22320 Right click the level of the repository under which you want to place the
22321 new project folder (typically the top level) and click
22325 Supply a name for the project folder and click OK.
22326 Add a message for the log file if desired, then click OK again.
22327 The new project folder should appear in the repository.
22328 Finally, click OK again to exit the repository browser.
22331 \begin_layout Enumerate
22332 Once again right click
22338 , this time selecting SVN Checkout\SpecialChar ldots
22339 Select the URL of the project folder
22340 you just created in the repository, and set the checkout directory to
22348 You will be warned about a non-empty folder; click OK to proceed.
22349 You should now have a
22360 \begin_layout Enumerate
22361 Create or open your document in \SpecialChar LyX
22364 File\SpecialChar menuseparator
22366 \begin_inset space ~
22369 Control\SpecialChar menuseparator
22373 Add a log message and click OK to commit the document to version control.
22376 \begin_layout Standard
22377 From this point onward, you should have full functionality in the
22379 File\SpecialChar menuseparator
22381 \begin_inset space ~
22387 You also have the option of checking the document in and out, viewing its
22389 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22390 client program from a command prompt.
22393 \begin_layout Subsubsection
22394 SSH tunnel used with SVN under Windows
22397 \begin_layout Standard
22398 Compared with Linux setting up an svn client to communicate over ssh under
22399 Windows is a rather troublesome task.
22400 We will at least offer some hints how to setup the client side but prior
22401 knowledge about ssh and the Windows command line is needed, also be prepared
22402 for a great deal of frustration\SpecialChar ldots
22406 \begin_layout Enumerate
22407 Get an svn client for windows, as described in the previous sections.
22408 When it is a fresh install run some svn command (e.g.
22410 \begin_inset Flex Code
22413 \begin_layout Plain Layout
22419 ) to create config files, which you will need to change later on.
22422 \begin_layout Enumerate
22423 Choose an ssh client for Windows.
22424 There are several possibilities, we will use the one from Putty tools
22428 \begin_layout Plain Layout
22429 \begin_inset Flex URL
22432 \begin_layout Plain Layout
22434 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22445 You will need to set the connection up so that the client doesn't ask for
22446 any password from you.
22447 To keep things easy we will use only keys without any additional password
22452 \begin_layout Enumerate
22454 \begin_inset Flex Code
22457 \begin_layout Plain Layout
22464 Save your private .ppk key file and put the public one on the server side.
22465 If the SVN server runs on Linux, note that the format of the public key
22466 is not compatible with Linux openssh and you will need to direcly copy-paste
22468 \begin_inset Quotes eld
22473 Public key for pasting into OpenSSH authorized_keys file
22476 \begin_inset Quotes erd
22479 edit field into the server's
22480 \begin_inset Flex Code
22483 \begin_layout Plain Layout
22484 ~/.ssh/authorized_keys
22490 \begin_inset Flex Code
22493 \begin_layout Plain Layout
22502 \begin_layout Enumerate
22504 \begin_inset Flex Code
22507 \begin_layout Plain Layout
22514 In the SVN config file
22518 \begin_layout Plain Layout
22519 Exact path depends on Windows version, usually somewhere around
22520 \begin_inset Flex Code
22523 \begin_layout Plain Layout
22526 Documents and Settings
22540 \begin_inset Flex Code
22543 \begin_layout Plain Layout
22558 , section [tunnels], setup ssh command, e.g.
22560 \begin_inset Flex Code
22563 \begin_layout Plain Layout
22564 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22573 \begin_layout Plain Layout
22574 It will usually take a lot of time to get exact command right and it depends
22576 For example do not have some remote server saved as a default session in
22578 If things fail, try to connect via plink without SVN first.
22587 \begin_layout Enumerate
22588 Checkout the SVN archive, e.
22589 \begin_inset space \thinspace{}
22593 \begin_inset Newline newline
22597 \begin_inset Flex Code
22600 \begin_layout Plain Layout
22601 svn co svn+ssh://user@server/repository_path
22609 \begin_layout Subsubsection
22610 End-of-Line Conversions
22613 \begin_layout Standard
22614 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22616 use different line endings inside the .lyx files.
22617 This is not a problem as far as \SpecialChar LyX
22618 functionality is concerned, but the commit
22619 diffs will be huge and merge-conflicts prone.
22620 Fortunately SVN itself knows
22624 \begin_layout Plain Layout
22625 \begin_inset Flex URL
22628 \begin_layout Plain Layout
22630 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22640 how to deal with CR/LF problems when switching .lyx files to the
22641 \begin_inset Flex Code
22644 \begin_layout Plain Layout
22654 \begin_layout Plain Layout
22656 \begin_inset Flex Code
22659 \begin_layout Plain Layout
22660 svn propset svn:eol-style native FILE_NAME
22673 \begin_layout Subsection
22674 GIT commands in \SpecialChar LyX
22678 \begin_layout Standard
22679 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22681 You can find the commands in the
22683 File\SpecialChar menuseparator
22685 \begin_inset space ~
22691 Please note that if you use password protected access to repository via
22692 ssh, you will be asked in terminal window.
22694 was tested against GIT 1.7.
22698 \begin_layout Plain Layout
22699 Windows users please note that you need to ensure that git is on the path.
22700 This can be set from within \SpecialChar LyX
22703 Tools\SpecialChar menuseparator
22704 Preferences\SpecialChar menuseparator
22705 Paths\SpecialChar menuseparator
22716 \begin_layout Standard
22717 One big difference of GIT and the other supported version control systems
22718 is the distributed nature of GIT: With traditional version control systems
22719 there is one central server which hosts the repository.
22720 Users commit their changes to the server, and get updates made by other
22722 With GIT, users commit to a local repository.
22723 The local repository can be synchronized with one or more remote repositories
22725 \begin_inset Flex Code
22728 \begin_layout Plain Layout
22735 \begin_inset Flex Code
22738 \begin_layout Plain Layout
22746 does not interact in any way with remote GIT repositories.
22747 It works exclusively with the local repository in a very similar way as
22748 with a central CVS or SVN repository.
22749 If you use remote GIT repositories you need to do the
22750 \begin_inset Flex Code
22753 \begin_layout Plain Layout
22760 \begin_inset Flex Code
22763 \begin_layout Plain Layout
22769 operations with your favourite GIT client.
22772 \begin_layout Subsubsection
22778 \begin_layout Standard
22779 If your document is not under revision control, this is the only item shown
22781 And if it is under revision control, the
22785 item is not visible.
22788 \begin_layout Standard
22789 This command registers in GIT your document ONLY in case you have already
22790 the documents directory under GIT control (in particular
22795 This means you have to checkout the archive by yourself.
22798 \begin_layout Standard
22799 Then you are asked interactively to supply an initial description of the
22801 Don't forget that registered file is not yet committed.
22804 \begin_layout Standard
22805 GIT command that is run:
22808 \begin_inset Quotes qld
22812 \begin_inset Quotes qld
22818 \begin_layout Standard
22823 to understand the switches.
22826 \begin_layout Subsubsection
22832 \begin_layout Standard
22833 When you are finished editing a file, you commit your changes.
22834 When you do this, you are asked for a description of the changes.
22835 After that changes are committed.
22838 \begin_layout Standard
22841 git commit -q -m"<description>" <file-name>
22844 \begin_layout Subsubsection
22847 Revert To Repository Version
22850 \begin_layout Standard
22851 This will discard all changes made to the document since the last check
22853 You get a warning before changes are discarded.
22856 \begin_layout Standard
22860 \begin_inset Quotes qld
22864 \begin_inset Quotes qld
22870 \begin_layout Subsubsection
22876 \begin_layout Standard
22877 This will rename the current document including the version history.
22878 It requires a clean document without any changes since the last checkin.
22879 You are asked for a file name and a description of the rename operation.
22880 After that the document is renamed, both locally and in the repository.
22881 If the parent directories of the new and old file names differ, all relative
22882 paths of included files are adjusted (like in
22884 File\SpecialChar menuseparator
22889 Finally, the document is reloaded using the new name.
22892 \begin_layout Labeling
22893 \labelwidthstring 00.00.0000
22895 \begin_inset space ~
22899 \begin_inset space ~
22903 \begin_inset Newline newline
22907 \begin_inset Flex Code
22910 \begin_layout Plain Layout
22914 \begin_inset Quotes qld
22918 \begin_inset Quotes qld
22922 \begin_inset Quotes qld
22926 \begin_inset Quotes qld
22935 \begin_inset Newline newline
22939 \begin_inset Flex Code
22942 \begin_layout Plain Layout
22951 \begin_layout Subsubsection
22957 \begin_layout Standard
22958 This shows the complete history of the GIT document.
22962 \begin_inset Quotes qld
22966 \begin_inset Quotes qld
22971 is shown in a browser.
22974 \begin_layout Subsubsection
22978 \begin_layout Standard
22980 supports GIT hash number of the last commit to the file,
22981 \change_inserted 1119979965 1564297456
22982 its abbreviated form,
22984 author name, date and time of last commit.
22985 All those are extracted from
22987 git log -n 1 --pretty=format:%H%n
22988 \change_inserted 1119979965 1564297427
22994 Tree version information is obtained via
22996 git describe --abbrev --dirty --long
23000 \begin_inset CommandInset ref
23002 reference "subsec:VCS-Revision-Information"
23009 \begin_layout Subsection
23013 \begin_layout Standard
23014 With the recent addition of the
23015 \begin_inset Flex Code
23018 \begin_layout Plain Layout
23024 function \SpecialChar LyX
23025 power users are allowed to create their own commands for revision
23029 \begin_layout Standard
23030 As an example you can see how two TortoiseSVN commands could be integrated
23034 \begin_layout Description
23036 \begin_inset Flex Code
23039 \begin_layout Plain Layout
23040 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
23048 \begin_layout Description
23050 \begin_inset Flex Code
23053 \begin_layout Plain Layout
23054 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
23062 \begin_layout Subsection
23063 Version control and Document comparison
23066 \begin_layout Standard
23067 One of the typical uses of version control is to inspect the changes between
23068 revisions, usually by creating
23069 \begin_inset Flex Code
23072 \begin_layout Plain Layout
23079 While this is useful for plain text files, it is much less useful in the
23080 case of \SpecialChar LyX
23081 files, which have more a complicated structure.
23082 Hence we provide binding to the Document comparison feature.
23083 There are two ways of calling this feature – either by direct call of
23084 \begin_inset Flex Code
23087 \begin_layout Plain Layout
23094 function (for details see \SpecialChar LyX
23095 functions manual) or by the toolbar icon
23108 One can either compare two chosen revisions of the document or he can simply
23109 compare the current version of edited text with older revisions (where
23111 \begin_inset Flex Noun
23114 \begin_layout Plain Layout
23120 ' revisions back means comparison of the edited file with last commited
23125 \begin_layout Standard
23126 This feature is supported for SVN and RCS though due to the more complicated
23127 versioning scheme of RCS there is a constraint – when addressing the revisions
23128 in dialog, numbers always point to the last number in RCS revision number,
23131 We don't currently support GIT addressing of revisions, one can just compare
23132 edited document with its revision X steps backs, where X is addressed as
23134 \begin_inset Flex Code
23137 \begin_layout Plain Layout
23146 \begin_layout Section
23147 Literate Programming
23150 \begin_layout Standard
23155 (kayvan@sylvan.com)
23159 original documentation written by
23161 Edmar Wienskoski Jr.
23164 (edmar-w-jr@technologist.com)
23167 \begin_layout Subsection
23171 \begin_layout Standard
23172 The main purpose of this documentation is to show you how to use \SpecialChar LyX
23174 programming, where it is assumed that you are familiar with this programming
23175 technique, and know what
23176 \begin_inset Quotes eld
23180 \begin_inset Quotes erd
23184 \begin_inset Quotes eld
23188 \begin_inset Quotes erd
23192 If that is not the case, please follow the web links provided in the following
23194 There is a lot of good documentation out there covering old development
23195 history to the latest tools tips.
23198 \begin_layout Standard
23199 It is also assumed that you are familiar with \SpecialChar LyX
23200 itself to a point that you
23201 are comfortable changing your \SpecialChar LyX
23202 preferences, and X resources file.
23203 If that is not the case please refer to other \SpecialChar LyX
23204 documentation to cover your
23208 \begin_layout Subsection
23209 Literate Programming
23212 \begin_layout Standard
23213 From the Literate Programming FAQ:
23216 \begin_layout Quotation
23217 Literate programming is the combination of documentation and source together
23218 in a fashion suited for reading by human beings.
23219 In fact, literate programs should be enjoyable reading, even inviting!
23220 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23221 and documentation in a single file.
23222 Literate programming tools then parse the file to produce either readable
23223 documentation or compilable source.
23224 The WEB style of literate programming was created by D.
23225 \begin_inset space \thinspace{}
23229 Knuth during the development of his \SpecialChar TeX
23230 typesetting software.
23234 \begin_layout Standard
23235 Another excerpt says:
23238 \begin_layout Quotation
23241 How is literate programming different from verbose commenting?
23244 \begin_layout Quotation
23245 There are three distinguishing characteristics.
23246 In order of importance, they are:
23250 \begin_layout Itemize
23251 flexible order of elaboration
23254 \begin_layout Itemize
23255 automatic support for browsing
23258 \begin_layout Itemize
23259 typeset documentation, especially diagrams and mathematics
23263 \begin_layout Standard
23264 Now that I sparked your curiosity, take a look in the references.
23267 \begin_layout Subsubsection
23271 \begin_layout Standard
23272 The complete Literate Programming FAQ can be found at:
23275 \begin_layout Quote
23276 Literate Programming FAQ
23277 \begin_inset Flex URL
23280 \begin_layout Plain Layout
23282 http://www.literateprogramming.com/lpfaq.pdf
23290 \begin_layout Standard
23291 The FAQ lists 23 (twenty three!) different literate programming tools.
23292 Where some are specialized or
23293 \begin_inset Quotes eld
23297 \begin_inset Quotes erd
23300 for particular programming languages, while other have general scope.
23305 for my own use for several reasons:
23308 \begin_layout Itemize
23309 It can generate the documentation either in \SpecialChar LaTeX
23313 \begin_layout Itemize
23314 It has a open architecture, i.
23315 \begin_inset space \thinspace{}
23319 \begin_inset space \space{}
23322 it is easy to plug in new filters
23326 \begin_layout Plain Layout
23331 are programs that read a given data stream and output a manipulated data
23333 That way, a WEB file (consisting of literate code) can be turned into a
23334 file consisting only of C program code or \SpecialChar LaTeX
23340 and to perform special processing that you may need.
23344 \begin_layout Itemize
23345 There is a good selection of filters available already (the HTML is one
23349 \begin_layout Itemize
23353 \begin_layout Standard
23354 The Noweb web page can be found at:
23357 \begin_layout Quote
23359 \begin_inset Flex URL
23362 \begin_layout Plain Layout
23364 https://www.cs.tufts.edu/~nr/noweb/
23372 \begin_layout Standard
23373 Starting from there you can reach many other interesting links and even
23374 some literate program examples.
23377 \begin_layout Subsection
23379 and Literate Programming with Noweb
23382 \begin_layout Standard
23383 The \SpecialChar LyX
23384 support for Literate Programming is provided by using the generic \SpecialChar LyX
23386 converters mechanism.
23387 This support is provided in a
23388 \begin_inset Quotes eld
23392 \begin_inset Quotes erd
23396 \begin_inset space \thinspace{}
23400 \begin_inset space \space{}
23403 you will be able to use this new \SpecialChar LyX
23404 feature with some other literate programming
23405 tool of your choice by just changing your \SpecialChar LyX
23409 \begin_layout Subsubsection
23410 Generating documents and code (weaving and tangling)
23413 \begin_layout Paragraph
23414 Using the noweb module
23417 \begin_layout Standard
23418 If you have installed Noweb and \SpecialChar LyX
23419 successfully, whenever you open a new document,
23420 after you have chosen its document class, use the
23422 Document\SpecialChar menuseparator
23426 \begin_inset Quotes eld
23430 \begin_inset Quotes erd
23434 If Noweb is correctly installed, when you click on the
23435 \begin_inset Quotes eld
23439 \begin_inset Quotes erd
23442 link, you will see the
23443 \begin_inset Quotes eld
23447 \begin_inset Quotes erd
23450 module in the available list and you can add it to your document.
23453 \begin_layout Paragraph
23457 \begin_layout Standard
23459 enables you to write code with a custom inset named
23460 \begin_inset Flex Noun
23463 \begin_layout Plain Layout
23470 Noweb delimits chunks like this:
23473 \begin_layout LyX-Code
23477 \begin_layout LyX-Code
23481 \begin_layout LyX-Code
23485 \begin_layout LyX-Code
23489 \begin_layout LyX-Code
23493 \begin_layout Standard
23494 The problem is that whatever is written in between the << and the
23498 must be taken literally, i.
23499 \begin_inset space \thinspace{}
23503 \begin_inset space \space{}
23507 should be prevented from making any special interpretation of what has
23509 This is also handled by
23510 \begin_inset Flex Noun
23513 \begin_layout Plain Layout
23519 , that works like a normal text inset but has a free spacing capability.
23522 \begin_layout Standard
23523 As a special note, you can also use the
23524 \begin_inset Quotes eld
23528 \begin_inset Quotes erd
23531 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23535 \begin_layout LyX-Code
23539 \begin_layout LyX-Code
23540 def some_function(args):
23543 \begin_layout LyX-Code
23544 "This is the doc string for this function."
23547 \begin_layout LyX-Code
23548 print "My args: ", args
23551 \begin_layout LyX-Code
23552 @ %def some_function
23555 \begin_layout Standard
23556 For an example of this usage and the resulting cross-reference output, look
23557 at the Literate python program in
23559 LIBDIR/examples/listerrors.lyx
23561 which should make this all clear.
23564 \begin_layout Paragraph
23565 Generating the documentation
23568 \begin_layout Standard
23569 At this point you already have a new document file with a proper document
23570 class, and with some code and text on it.
23571 How do I print it? The answer is simple, you select
23573 View\SpecialChar menuseparator
23577 Just like you would do for a plain document.
23578 No special procedure is required.
23581 \begin_layout Standard
23582 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23586 \begin_layout Enumerate
23589 Update\SpecialChar menuseparator
23592 menu option is chosen, a \SpecialChar LaTeX
23598 \begin_layout Standard
23599 If the document is of any literate class the generated file will be named
23600 with an extension name defined by the
23601 \begin_inset Quotes eld
23605 \begin_inset Quotes erd
23608 format (defined in the Preferences panel), otherwise the file will have
23617 \begin_layout Enumerate
23618 Note that the only difference so far is in the name of the file, no special
23619 processing is required by \SpecialChar LyX
23621 Given that you formatted the code using the
23622 \begin_inset Flex Noun
23625 \begin_layout Plain Layout
23631 inset that, by itself, takes care of the business.
23634 \begin_layout Enumerate
23635 If the document is of any literate class \SpecialChar LyX
23636 will then use the internal \SpecialChar LyX
23638 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23643 \begin_layout Plain Layout
23644 The converters are defined in the
23646 Tools\SpecialChar menuseparator
23650 \begin_inset Quotes eld
23654 \begin_inset Quotes erd
23666 manual for general information about converters.
23671 to generate the \SpecialChar LaTeX
23676 \begin_layout Standard
23677 Otherwise it will just skip this step.
23681 \begin_layout Enumerate
23682 Finally, \SpecialChar LaTeX
23683 is invoked and the regular post processing continues as in a plain
23687 \begin_layout Standard
23688 Independence from a particular
23689 \begin_inset Quotes eld
23693 \begin_inset Quotes erd
23696 is easily achieved by changing the commands that are run by the various
23700 \begin_layout Paragraph
23701 Generating the code
23704 \begin_layout Standard
23705 When the build menu option is chosen or the corresponding button in the
23706 toolbar is pressed, a \SpecialChar LaTeX
23707 file is generated just like step 1 above.
23708 Next, \SpecialChar LyX
23714 This converter needs to be defined by the user and is not installed by
23715 default, though the Program format is.
23716 This converter (like any other converter) will have two parts:
23719 \begin_layout Enumerate
23720 The converter program itself.
23721 This program performs the conversion from the one format to the other (in
23722 this case, from the Noweb format to the Program pseudo-format).
23725 \begin_layout Enumerate
23726 The error log parser.
23727 This is a program whose sole purpose is to rewrite error messages in a
23728 format that \SpecialChar LyX
23730 This makes it possible for \SpecialChar LyX
23731 to place error boxes in the right places in
23735 \begin_layout Standard
23736 The first part, the
23737 \begin_inset Quotes eld
23741 \begin_inset Quotes erd
23744 setting, should be set to
23747 \begin_layout LyX-Code
23755 \begin_layout Standard
23756 This basically means that \SpecialChar LyX
23758 \begin_inset Quotes eld
23762 \begin_inset Quotes erd
23765 (a program or script) with the name of the Noweb file (normally a file
23766 in the \SpecialChar LyX
23767 temp directory) and the directory path of the original \SpecialChar LyX
23772 \begin_layout Standard
23773 This is an implementation of
23774 \begin_inset Quotes eld
23778 \begin_inset Quotes erd
23781 that you can place in a directory on your path:
23784 \begin_layout LyX-Code
23790 \begin_layout LyX-Code
23796 \begin_layout LyX-Code
23799 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23802 \begin_layout Standard
23803 The next part of the converter setting is the
23804 \begin_inset Quotes eld
23808 \begin_inset Quotes erd
23811 which is to be set to
23814 \begin_layout LyX-Code
23817 parselog=$$s/scripts/listerrors
23820 \begin_layout Standard
23821 This will run any errors that are generated by the
23822 \begin_inset Quotes eld
23826 \begin_inset Quotes erd
23829 process through the
23830 \begin_inset Quotes eld
23834 \begin_inset Quotes erd
23840 \begin_layout Standard
23841 The build will normally take place in \SpecialChar LyX
23842 's temporary directory, so the files
23843 produced by the conversion will be in that directory.
23845 will copy out what it regards as the `main' file, but the
23849 conversion may produce several files, and so most of these would then be
23850 deleted when \SpecialChar LyX
23852 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23853 the build-script chunk can place the generated files in that location.
23856 \begin_layout Paragraph
23857 Build instructions in the document
23860 \begin_layout Standard
23861 The last piece of the integration between \SpecialChar LyX
23863 \begin_inset Quotes eld
23867 \begin_inset Quotes erd
23871 Generally, the instructions for building your program should be embedded
23872 in a chunk of its own.
23874 \begin_inset Quotes eld
23878 \begin_inset Quotes erd
23881 above uses the notangle command to look for this chunk (called
23882 \begin_inset Quotes eld
23886 \begin_inset Quotes erd
23889 ) and runs its contents through
23890 \begin_inset Quotes eld
23894 \begin_inset Quotes erd
23900 \begin_layout Standard
23901 Typically, such a chunk would look something like this:
23904 \begin_layout LyX-Code
23908 \begin_layout LyX-Code
23910 \begin_inset Newline newline
23913 if [ -z "${NOWEB_SOURCE}" ]
23914 \begin_inset Newline newline
23920 \begin_layout LyX-Code
23921 NOWEB_SOURCE=myfile.nw
23922 \begin_inset Newline newline
23926 \begin_inset Newline newline
23930 code to extract files ...
23931 use NOWEB_OUTPUT_DIR here ...]
23932 \begin_inset Newline newline
23936 code to compile files ...]
23937 \begin_inset Newline newline
23943 \begin_layout Standard
23946 LIBDIR/examples/listerrors.lyx
23950 LIBDIR/examples/Literate.lyx
23952 which implement two versions of the
23953 \begin_inset Quotes eld
23957 \begin_inset Quotes erd
23960 program for some illustrations of how all of these pieces go together or
23963 LIBDIR/examples/noweb2lyx.lyx.
23966 Interestingly, these three files show off the language-indepence of the
23968 literate programming support since they are written in Python, C and Perl
23972 \begin_layout Subsubsection
23973 Configuring \SpecialChar LyX
23977 \begin_layout Standard
23978 All the Literate Programming support is configured by the
23980 Tools\SpecialChar menuseparator
23984 \begin_inset Quotes eld
23988 \begin_inset Quotes erd
23992 The important parts are:
23995 \begin_layout Description
23997 \begin_inset space ~
24001 \begin_inset Quotes eld
24005 \begin_inset Quotes erd
24009 \begin_inset space ~
24012 format Set up via the File Formats tab, this is where the Noweb-specific
24022 , the file extension is set to
24027 This tells \SpecialChar LyX
24028 to create a file with a
24032 extension in the first step of the conversion process.
24035 \begin_layout Description
24037 \begin_inset space ~
24045 \begin_inset space ~
24048 format This is an empty format whose sole purpose is to be the endpoint
24049 of a conversion (which then allows us to set up a converter for it).
24052 \begin_layout Description
24062 This converter performs the
24063 \begin_inset Quotes eld
24067 \begin_inset Quotes erd
24070 of the literate document.
24071 For Noweb, it is set to
24072 \begin_inset Quotes eld
24077 noweave -delay -index $$i > $$o
24080 \begin_inset Quotes erd
24086 \begin_layout Description
24096 \begin_inset Quotes eld
24100 \begin_inset Quotes erd
24104 As stated above, the Converter is set to
24105 \begin_inset Quotes eld
24113 \begin_inset Quotes erd
24116 , with Flags set to
24117 \begin_inset Newline newline
24121 \begin_inset Quotes eld
24126 parselog=$$s/scripts/listerrors
24129 \begin_inset Quotes erd
24135 \begin_layout Subsubsection
24139 \begin_layout Standard
24140 There is also a new function implemented in the \SpecialChar LyX
24142 \begin_inset Quotes eld
24145 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
24149 \begin_layout Standard
24150 When debugging code with ddd/gdb, it is possible to invoke a text editor
24151 at the current execution position with a single key stroke.
24152 The default ddd configuration for that is shift-ctrl-V.
24153 It happens that you can define the editor command line invocation in ddd
24156 Edit\SpecialChar menuseparator
24157 Preferences\SpecialChar menuseparator
24160 dialog and changing the "Edit Sources" entry.
24163 \begin_layout Standard
24164 I take advantage of the newly created \SpecialChar LyX
24165 server function and this ddd feature,
24167 \begin_inset Quotes eld
24171 \begin_inset Quotes erd
24177 \begin_layout LyX-Code
24178 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
24181 \begin_layout Standard
24182 With this, whenever you are using ddd and find a point in the program that
24183 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24184 ddd will forward this information to \SpecialChar LyX
24185 through the \SpecialChar LyX
24186 server and then the
24188 window will show the same file with the cursor at the same position ddd
24190 No more guessing or long scrolling to locate a point in the program back
24194 \begin_layout Standard
24195 Note however that you must enable the \SpecialChar LyX
24196 server to get this feature working
24197 (it is disabled by default).
24199 \begin_inset space ~
24203 \begin_inset CommandInset ref
24205 reference "sec:Starting-the-Server"
24209 explains how to do that.
24212 \begin_layout Subsubsection
24216 \begin_layout Standard
24217 There are six new buttons that can be added to your \SpecialChar LyX
24219 Four of these buttons are short cuts to layout styles:
24237 , one for the custom inset
24242 The last one is a short cut to the
24243 \begin_inset Quotes eld
24247 \begin_inset Quotes erd
24254 \begin_layout Standard
24256 has a range of buttons that are available for tool bar customization.
24257 In my toolbar I like to combine the six short cuts above with two more:
24262 \SpecialChar menuseparator
24267 \SpecialChar menuseparator
24274 Document\SpecialChar menuseparator
24275 View\SpecialChar menuseparator
24279 Here is how it looks like:
24282 \begin_layout LyX-Code
24286 \begin_layout LyX-Code
24290 \begin_layout LyX-Code
24291 Icon "layout Standard"
24294 \begin_layout LyX-Code
24295 Icon "layout Section"
24298 \begin_layout LyX-Code
24299 Icon "layout \SpecialChar LaTeX
24303 \begin_layout LyX-Code
24304 Icon "layout \SpecialChar LyX
24308 \begin_layout LyX-Code
24309 Icon "flex.insert Chunk"
24312 \begin_layout LyX-Code
24316 \begin_layout LyX-Code
24320 \begin_layout LyX-Code
24321 Icon "buffer-typeset"
24324 \begin_layout LyX-Code
24325 Icon "build-program"
24328 \begin_layout LyX-Code
24332 \begin_layout LyX-Code
24336 \begin_layout LyX-Code
24340 \begin_layout LyX-Code
24344 \begin_layout LyX-Code
24348 \begin_layout Subsubsection
24349 Colors customization
24352 \begin_layout Standard
24353 There are a number of colors in \SpecialChar LyX
24354 that can be customized in
24359 One of the things that bothers people is the \SpecialChar LaTeX
24361 The default color is red, since the chunks uses \SpecialChar LaTeX
24362 font, and there is a lot
24363 of chunks in literate documents, you may get tired of seeing everything
24365 You can change it by going to the tabs
24374 \begin_layout Standard
24375 The next thing is the visible presence of the newline character in the screen.
24376 You can choose the color of this particular character and make it blend
24378 I recommend you choosing a color that is close to the background but not
24379 equal, that way you still can see it is there, but it is not bothering
24383 \begin_layout Subsection
24388 \begin_layout Standard
24397 is documented in the
24401 example file and in the Sweave manual (menu
24403 Help\SpecialChar menuseparator
24409 \begin_layout Chapter
24413 \begin_layout Standard
24414 You can do everything with \SpecialChar LyX
24415 that you can do with \SpecialChar LaTeX
24417 However, \SpecialChar LyX
24418 cannot support every \SpecialChar LaTeX
24420 But you can always use \SpecialChar TeX
24422 This chapter shows you some more special things you might want to use.
24423 For other special things you can do with figures, tables, floats, boxes
24424 and notes, have a look at the
24427 \begin_inset space ~
24435 \begin_layout Section
24436 Multiple Text Columns
24439 \begin_layout Standard
24440 This feature is independent of the option
24442 Two-column document
24444 in the document settings under
24449 If you want to have 2
24450 \begin_inset space ~
24453 columns for the whole document, it is recommended to use the
24455 Two-column document
24458 For all other cases use this feature.
24461 \begin_layout Standard
24462 To use multiple text columns in your document, you have to load the module
24469 Document\SpecialChar menuseparator
24470 Settings\SpecialChar menuseparator
24473 ) and must have the \SpecialChar LaTeX
24475 \begin_inset Flex Code
24478 \begin_layout Plain Layout
24487 \begin_layout Standard
24488 Footnotes within multiple columns will be placed at the bottom of the page
24489 and not under each column.
24490 Within the different columns you can use everything, with the limitation
24491 that for floats you need to use the float option
24498 \begin_layout Subsection
24502 \begin_layout Standard
24503 If you want to have 2
24504 \begin_inset space ~
24507 columns in your text, insert a multicolumn inset via the menu
24509 Insert\SpecialChar menuseparator
24511 \begin_inset space ~
24514 Insets\SpecialChar menuseparator
24516 \begin_inset space ~
24521 where the columns should start.
24522 Write all text that should be printed in 2
24523 \begin_inset space ~
24526 columns into this inset.
24529 \begin_layout Standard
24530 Here is an example:
24533 \begin_layout Standard
24535 \begin_inset Flex Multiple Columns
24538 \begin_layout Plain Layout
24543 The Adventure of the Empty House
24546 \begin_inset Newline newline
24549 by Sir Arthur Conan Doyle
24552 \begin_layout Plain Layout
24555 It was in the spring of the year 1894 that all London was interested, and
24556 the fashionable world dismayed, by the murder of the Honourable Ronald
24557 Adair under most unusual and inexplicable circumstances.
24558 The public has already learned those particulars of the crime which came
24559 out in the police investigation, but a good deal was suppressed upon that
24560 occasion, since the case for the prosecution was so overwhelmingly strong
24561 that it was not necessary to bring forward all the facts.
24562 Only now, at the end of nearly ten years, am I allowed to supply those
24563 missing links which make up the whole of that remarkable chain.
24564 The crime was of interest in itself, but that interest was as nothing to
24565 me compared to the inconceivable sequel, which afforded me the greatest
24566 shock and surprise of any event in my adventurous life.
24567 Even now, after this long interval, I find myself thrilling as I think
24568 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24569 ty which utterly submerged my mind.
24570 Let me say to that public, which has shown some interest in those glimpses
24571 which I have occasionally given them of the thoughts and actions of a very
24572 remarkable man, that they are not to blame me if I have not shared my knowledge
24573 with them, for I should have considered it my first duty to do so, had
24574 I not been barred by a positive prohibition from his own lips, which was
24575 only withdrawn upon the third of last month.
24583 \begin_layout Standard
24584 To get 3 or more columns, set the cursor into the multicolumn inset and
24587 Insert\SpecialChar menuseparator
24589 \begin_inset space ~
24593 \begin_inset space ~
24599 The number of the desired columns is written into that inset (for 3
24600 \begin_inset space ~
24604 \begin_inset Quotes eld
24608 \begin_inset Quotes erd
24612 \begin_inset Newline newline
24615 Here is an example with 3
24616 \begin_inset space ~
24622 \begin_layout Standard
24623 \begin_inset Flex Multiple Columns
24626 \begin_layout Plain Layout
24629 \begin_inset Argument 1
24632 \begin_layout Plain Layout
24639 It can be imagined that my close intimacy with Sherlock Holmes had interested
24640 me deeply in crime, and that after his disappearance I never failed to
24641 read with care the various problems which came before the public.
24642 And I even attempted, more than once, for my own private satisfaction,
24643 to employ his methods in their solution, though with indifferent success.
24644 There was none, however, which appealed to me like this tragedy of Ronald
24646 As I read the evidence at the inquest, which led up to a verdict of willful
24647 murder against some person or persons unknown, I realized more clearly
24648 than I had ever done the loss which the community had sustained by the
24649 death of Sherlock Holmes.
24650 There were points about this strange business which would, I was sure,
24651 have specially appealed to him, and the efforts of the police would have
24652 been supplemented, or more probably anticipated, by the trained observation
24653 and the alert mind of the first criminal agent in Europe.
24654 All day, as I drove upon my round, I turned over the case in my mind and
24655 found no explanation which appeared to me to be adequate.
24656 At the risk of telling a twice-told tale, I will recapitulate the facts
24657 as they were known to the public at the conclusion of the inquest.
24665 \begin_layout Standard
24666 You can have up to 10
24667 \begin_inset space ~
24670 columns if you want to, but that might not be very pleasant for the readers
24674 \begin_layout Standard
24675 \begin_inset Newpage newpage
24681 \begin_layout Subsection
24682 Columns inside Columns
24685 \begin_layout Standard
24686 You can also have columns inside columns:
24689 \begin_layout Standard
24690 \begin_inset Flex Multiple Columns
24693 \begin_layout Plain Layout
24696 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24697 at that time governor of one of the Australian colonies.
24698 Adair's mother had returned from Australia to undergo the operation for
24699 cataract, and she, her son Ronald, and her daughter Hilda were living together
24703 \begin_layout Plain Layout
24704 \begin_inset Flex Multiple Columns
24707 \begin_layout Plain Layout
24710 The youth moved in the best society
24711 \begin_inset space ~
24714 – had, so far as was known, no enemies and no particular vices.
24715 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24716 had been broken off by mutual consent some months before, and there was
24717 no sign that it had left any very profound feeling behind it.
24718 For the rest {sic} the man's life moved in a narrow and conventional circle,
24719 for his habits were quiet and his nature unemotional.
24720 Yet it was upon this easy-going young aristocrat that death came, in most
24721 strange and unexpected form, between the hours of ten and eleven-twenty
24722 on the night of March 30, 1894.
24730 \begin_layout Plain Layout
24733 Ronald Adair was fond of cards
24734 \begin_inset space ~
24737 – playing continually, but never for such stakes as would hurt him.
24738 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24739 It was shown that, after dinner on the day of his death, he had played
24740 a rubber of whist at the latter club.
24741 He had also played there in the afternoon.
24746 The evidence of those who had played with him
24747 \begin_inset space ~
24751 Murray, Sir John Hardy, and Colonel Moran
24752 \begin_inset space ~
24755 – showed that the game was whist, and that there was a fairly equal fall
24757 Adair might have lost five pounds, but not more.
24758 His fortune was a considerable one, and such a loss could not in any way
24760 He had played nearly every day at one club or other, but he was a cautious
24761 player, and usually rose a winner.
24762 It came out in evidence that, in partnership with Colonel Moran, he had
24763 actually won as much as four hundred and twenty pounds in a sitting, some
24764 weeks before, from Godfrey Milner and Lord Balmoral.
24765 So much for his recent history as it came out at the inquest.
24773 \begin_layout Subsection
24777 \begin_layout Standard
24778 The examples in this section show some more special features of multiple
24782 \begin_layout Standard
24783 For more features of multiple columns, have a look at the
24784 \begin_inset CommandInset href
24786 name "documentation"
24787 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
24792 of the \SpecialChar LaTeX
24794 \begin_inset Flex Code
24797 \begin_layout Plain Layout
24806 \begin_layout Subsubsection
24810 \begin_layout Standard
24811 To add a preface text for multiple columns, set the cursor into the multicolumn
24812 inset and use the menu
24814 Insert\SpecialChar menuseparator
24818 Write your preface text into that inset.
24819 \begin_inset Newline newline
24822 This is an example with some preface text:
24825 \begin_layout Standard
24826 \begin_inset VSpace bigskip
24832 \begin_layout Standard
24833 \begin_inset Flex Multiple Columns
24836 \begin_layout Plain Layout
24837 \begin_inset Argument 2
24840 \begin_layout Plain Layout
24841 And the story continues and continues and continues and continues\SpecialChar ldots
24849 On the evening of the crime, he returned from the club exactly at ten.
24850 His mother and sister were out spending the evening with a relation.
24851 The servant deposed that she heard him enter the front room on the second
24852 floor, generally used as his sitting-room.
24853 She had lit a fire there, and as it smoked she had opened the window.
24854 No sound was heard from the room until eleven-twenty, the hour of the return
24855 of Lady Maynooth and her daughter.
24856 Desiring to say good-night, she attempted to enter her son's room.
24857 The door was locked on the inside, and no answer could be got to their
24858 cries and knocking.
24859 Help was obtained, and the door forced.
24860 The unfortunate young man was found lying near the table.
24861 His head had been horribly mutilated by an expanding revolver bullet, but
24862 no weapon of any sort was to be found in the room.
24870 \begin_layout Standard
24871 You can also use a section heading as the preface if you use a section command
24872 as \SpecialChar TeX
24874 For example the command
24877 \begin_layout LyX-Code
24880 subsection{subsection title}
24883 \begin_layout Standard
24884 creates a subsection.
24885 In this example the preface is a subsubsection:
24888 \begin_layout Standard
24889 \begin_inset Flex Multiple Columns
24892 \begin_layout Plain Layout
24893 \begin_inset Argument 2
24896 \begin_layout Plain Layout
24900 \begin_layout Plain Layout
24909 This is a subsubsection heading as a preface
24913 \begin_layout Plain Layout
24927 A minute examination of the circumstances served only to make the case more
24929 In the first place, no reason could be given why the young man should have
24930 fastened the door upon the inside.
24931 There was the possibility that the murderer had done this, and had afterwards
24932 escaped by the window.
24933 The drop was at least twenty feet, however, and a bed of crocuses in full
24935 Neither the flowers nor the earth showed any sign of having been disturbed,
24936 nor were there any marks upon the narrow strip of grass which separated
24937 the house from the road.
24938 Apparently, therefore, it was the young man himself who had fastened the
24940 But how did he come by his death? No one could have climbed up to the window
24941 without leaving traces.
24942 Suppose a man had fired through the window, he would indeed be a remarkable
24943 shot who could with a revolver inflict so deadly a wound.
24944 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
24945 a hundred yards of the house.
24946 No one had heard a shot.
24954 \begin_layout Standard
24955 If there is less vertical space than 6
24956 \begin_inset space ~
24959 text lines is left on the page at the beginning of the multiple columns,
24960 a page break will be inserted before the multiple columns.
24961 Depending on the number of lines of the preface text, you might want to
24963 This is done by setting the cursor into the mulitcolumn inset behind the
24964 preface (if there is any) and using the menu
24966 Insert\SpecialChar menuseparator
24968 \begin_inset space ~
24972 \begin_inset space ~
24976 \begin_inset space ~
24982 Insert into that inset the amount of space like e.
24983 \begin_inset space \thinspace{}
24987 \begin_inset space \space{}
24991 \begin_inset Quotes eld
24995 \begin_inset Quotes erd
24999 \begin_inset Newline newline
25002 In this example the space is set to 7
25003 \begin_inset space ~
25006 text lines by using
25007 \begin_inset Flex Code
25010 \begin_layout Plain Layout
25019 \begin_inset Flex Code
25022 \begin_layout Plain Layout
25030 needs to be inserted as \SpecialChar TeX
25034 \begin_layout Standard
25035 \begin_inset Flex Multiple Columns
25038 \begin_layout Plain Layout
25039 \begin_inset Argument 3
25042 \begin_layout Plain Layout
25047 \begin_layout Plain Layout
25063 On the evening of the crime, he returned from the club exactly at ten.
25064 His mother and sister were out spending the evening with a relation.
25065 The servant deposed that she heard him enter the front room on the second
25066 floor, generally used as his sitting-room.
25067 She had lit a fire there, and as it smoked she had opened the window.
25068 No sound was heard from the room until eleven-twenty, the hour of the return
25069 of Lady Maynooth and her daughter.
25070 Desiring to say good-night, she attempted to enter her son's room.
25071 The door was locked on the inside, and no answer could be got to their
25072 cries and knocking.
25073 Help was obtained, and the door forced.
25074 The unfortunate young man was found lying near the table.
25075 His head had been horribly mutilated by an expanding revolver bullet, but
25076 no weapon of any sort was to be found in the room.
25084 \begin_layout Subsubsection
25088 \begin_layout Standard
25089 The amount of space before and after multiple columns can be changed by
25090 changing the length
25091 \begin_inset Flex Code
25094 \begin_layout Plain Layout
25103 For example the command
25106 \begin_layout LyX-Code
25114 \begin_layout Standard
25115 in \SpecialChar TeX
25116 Code changes its value to 3
25117 \begin_inset space \thinspace{}
25121 The change must be made before the multiple columns' start.
25122 The predefined value is 13
25123 \begin_inset space \thinspace{}
25129 \begin_layout Standard
25131 \begin_inset Flex Code
25134 \begin_layout Plain Layout
25143 \begin_inset space \thinspace{}
25149 \begin_layout Standard
25153 \begin_layout Plain Layout
25159 multicolsep}{2.5cm}
25167 \begin_layout Standard
25168 \begin_inset Flex Multiple Columns
25171 \begin_layout Plain Layout
25174 All day I turned these facts over in my mind, endeavouring to hit upon some
25175 theory which could reconcile them all, and to find that line of least resistanc
25176 e which my poor friend had declared to be the starting-point of every investigat
25178 I confess that I made little progress.
25179 In the evening I strolled across the Park, and found myself about six o'clock
25180 at the Oxford Street end of Park Lane.
25181 A group of loafers upon the pavements, all staring up at a particular window,
25182 directed me to the house which I had come to see.
25183 A tall, thin man with coloured glasses, whom I strongly suspected of being
25184 a plain-clothes detective, was pointing out some theory of his own, while
25185 the others crowded round to listen to what he said.
25186 I got as near him as I could, but his observations seemed to me to be absurd,
25187 so I withdrew again in some disgust.
25188 As I did so I struck against an elderly, deformed man, who had been behind
25189 me, and I knocked down several books which he was carrying.
25197 \begin_layout Standard
25198 \begin_inset Note Greyedout
25201 \begin_layout Plain Layout
25206 The values you set with
25207 \begin_inset Flex Code
25210 \begin_layout Plain Layout
25218 will be used for all following multiple columns until you change them again.
25226 \begin_layout Standard
25230 \begin_layout Plain Layout
25242 \begin_inset Note Note
25245 \begin_layout Plain Layout
25246 go back to the default
25254 \begin_layout Standard
25255 \begin_inset Newpage newpage
25261 \begin_layout Subsubsection
25265 \begin_layout Standard
25266 A column break can be forced by inserting the command
25267 \begin_inset Flex Code
25270 \begin_layout Plain Layout
25278 as \SpecialChar TeX
25279 Code to that position in the text where the column should be broken.
25280 Note that this leads in most cases to whitespace in the text.
25281 \begin_inset Newline newline
25284 Here is an example:
25287 \begin_layout Standard
25288 \begin_inset Flex Multiple Columns
25291 \begin_layout Plain Layout
25294 \begin_inset Quotes eld
25297 You're surprised to see me, sir,
25298 \begin_inset Quotes erd
25301 said he, in a strange, croaking voice.
25304 \begin_layout Plain Layout
25307 I acknowledged that I was.
25310 \begin_layout Plain Layout
25313 \begin_inset Quotes eld
25316 Well, I've a conscience, sir, and when I chanced to see you go into this
25317 house, as I came hobbling after you, I thought to myself, I'll just step
25318 in and see that kind gentleman, and tell him that if I was a bit gruff
25319 in my manner there was not any harm meant, and that I am much obliged to
25320 him for picking up my books.
25321 \begin_inset Quotes erd
25327 \begin_layout Plain Layout
25330 \begin_inset Quotes eld
25333 You make too much of a trifle,
25334 \begin_inset Quotes erd
25339 \begin_inset Quotes eld
25342 May I ask how you knew who I was?
25343 \begin_inset Quotes erd
25346 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25350 \begin_layout Plain Layout
25362 \begin_layout Plain Layout
25365 \begin_inset Quotes eld
25368 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25369 you'll find my little bookshop at the corner of Church Street, and very
25370 happy to see you, I am sure.
25371 Maybe you collect yourself, sir.
25375 \begin_inset space ~
25389 \begin_inset space ~
25392 – a bargain, every one of them.
25393 With five volumes you could just fill that gap on that second shelf.
25394 It looks untidy, does it not, sir?
25395 \begin_inset Quotes erd
25406 \begin_layout Subsubsection
25410 \begin_layout Standard
25411 The width of the columns is automatically calculated, but you can modify
25412 the space between the columns.
25413 This is done by changing the length
25414 \begin_inset Flex Code
25417 \begin_layout Plain Layout
25426 Its predefined value is 10
25427 \begin_inset space \thinspace{}
25431 Here is an example where
25432 \begin_inset Flex Code
25435 \begin_layout Plain Layout
25444 \begin_inset space \thinspace{}
25450 \begin_layout Standard
25454 \begin_layout Plain Layout
25468 \begin_layout Standard
25469 \begin_inset Flex Multiple Columns
25472 \begin_layout Plain Layout
25475 My observations of No.
25476 \begin_inset space \space{}
25479 427 Park Lane did little to clear up the problem in which I was interested.
25480 The house was separated from the street by a low wall and railing, the
25481 whole not more than five feet high.
25482 It was perfectly easy, therefore, for anyone to get into the garden, but
25483 the window was entirely inaccessible, since there was no water pipe or
25484 anything which could help the most active man to climb it.
25485 More puzzled than ever, I retraced my steps to Kensington.
25486 I had not been in my study five minutes when the maid entered to say that
25487 a person desired to see me.
25488 To my astonishment it was none other than my strange old book collector,
25489 his sharp, wizened face peering out from a frame of white hair, and his
25490 precious volumes, a dozen of them at least, wedged under his right arm.
25498 \begin_layout Standard
25502 \begin_layout Plain Layout
25514 \begin_inset Note Note
25517 \begin_layout Plain Layout
25518 go back to the default
25526 \begin_layout Subsubsection
25530 \begin_layout Standard
25531 Between the columns a rule with a width of the length
25532 \begin_inset Flex Code
25535 \begin_layout Plain Layout
25544 If this rule width is set to 0
25545 \begin_inset space \thinspace{}
25548 pt (this is the default), the rule is suppressed.
25549 In the following example the rule is 2
25550 \begin_inset space \thinspace{}
25556 \begin_layout Standard
25560 \begin_layout Plain Layout
25566 columnseprule}{2pt}
25574 \begin_layout Standard
25575 \begin_inset Flex Multiple Columns
25578 \begin_layout Plain Layout
25581 \begin_inset Quotes eld
25584 You're surprised to see me, sir,
25585 \begin_inset Quotes erd
25588 said he, in a strange, croaking voice.
25591 \begin_layout Plain Layout
25594 I acknowledged that I was.
25597 \begin_layout Plain Layout
25600 \begin_inset Quotes eld
25603 Well, I've a conscience, sir, and when I chanced to see you go into this
25604 house, as I came hobbling after you, I thought to myself, I'll just step
25605 in and see that kind gentleman, and tell him that if I was a bit gruff
25606 in my manner there was not any harm meant, and that I am much obliged to
25607 him for picking up my books.
25608 \begin_inset Quotes erd
25614 \begin_layout Plain Layout
25617 \begin_inset Quotes eld
25620 You make too much of a trifle,
25621 \begin_inset Quotes erd
25626 \begin_inset Quotes eld
25629 May I ask how you knew who I was?
25630 \begin_inset Quotes erd
25636 \begin_layout Plain Layout
25639 \begin_inset Quotes eld
25642 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25643 you'll find my little bookshop at the corner of Church Street, and very
25644 happy to see you, I am sure.
25645 Maybe you collect yourself, sir.
25649 \begin_inset space ~
25663 \begin_inset space ~
25666 – a bargain, every one of them.
25667 With five volumes you could just fill that gap on that second shelf.
25668 It looks untidy, does it not, sir?
25669 \begin_inset Quotes erd
25680 \begin_layout Standard
25681 \begin_inset VSpace defskip
25687 \begin_layout Standard
25688 The rule can be colored by redefining the command
25689 \begin_inset Flex Code
25692 \begin_layout Plain Layout
25701 This is done by inserting the command
25704 \begin_layout LyX-Code
25709 columnseprulecolor}{
25714 \begin_layout Standard
25715 as \SpecialChar TeX
25716 Code before the multicolumn inset.
25718 \begin_inset Flex Code
25721 \begin_layout Plain Layout
25727 in this command by a color of your choice.
25728 You can use all pre- and self-defined colors.
25736 \begin_inset space ~
25741 for more information about pre- and self-defined colors.
25742 To go back to the default color insert the command
25745 \begin_layout LyX-Code
25750 columnseprulecolor}{
25755 \begin_layout Standard
25756 Here is the example with a cyan rule and 1
25757 \begin_inset space \thinspace{}
25760 cm column separation:
25763 \begin_layout Standard
25767 \begin_layout Plain Layout
25776 \begin_layout Plain Layout
25782 columnseprulecolor}{
25792 \begin_layout Standard
25793 \begin_inset Flex Multiple Columns
25796 \begin_layout Plain Layout
25799 \begin_inset Quotes eld
25802 You're surprised to see me, sir,
25803 \begin_inset Quotes erd
25806 said he, in a strange, croaking voice.
25809 \begin_layout Plain Layout
25812 I acknowledged that I was.
25815 \begin_layout Plain Layout
25818 \begin_inset Quotes eld
25821 Well, I've a conscience, sir, and when I chanced to see you go into this
25822 house, as I came hobbling after you, I thought to myself, I'll just step
25823 in and see that kind gentleman, and tell him that if I was a bit gruff
25824 in my manner there was not any harm meant, and that I am much obliged to
25825 him for picking up my books.
25826 \begin_inset Quotes erd
25832 \begin_layout Plain Layout
25835 \begin_inset Quotes eld
25838 You make too much of a trifle,
25839 \begin_inset Quotes erd
25844 \begin_inset Quotes eld
25847 May I ask how you knew who I was?
25848 \begin_inset Quotes erd
25854 \begin_layout Plain Layout
25857 \begin_inset Quotes eld
25860 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25861 you'll find my little bookshop at the corner of Church Street, and very
25862 happy to see you, I am sure.
25863 Maybe you collect yourself, sir.
25867 \begin_inset space ~
25881 \begin_inset space ~
25884 – a bargain, every one of them.
25885 With five volumes you could just fill that gap on that second shelf.
25886 It looks untidy, does it not, sir?
25887 \begin_inset Quotes erd
25898 \begin_layout Standard
25902 \begin_layout Plain Layout
25908 columnseprule}{0pt}
25911 \begin_layout Plain Layout
25917 columnseprulecolor}{
25925 \begin_inset Note Note
25928 \begin_layout Plain Layout
25929 go back to the default
25937 \begin_layout Section
25938 Non-standard Paragraph Shapes
25941 \begin_layout Standard
25944 as well as any other text processor uses by default rectangular paragraphs.
25945 For special cases like for example posters, invitation cards or poems you
25946 can modify the paragraph shape to one of your choice.
25947 This can be done by using the \SpecialChar LaTeX
25949 \begin_inset Flex Code
25952 \begin_layout Plain Layout
25958 which is loaded by using in the document settings the module
25960 Custom paragraph shapes
25965 \begin_layout Subsection
25969 \begin_layout Standard
25974 provides the following shapes:
25977 \begin_layout Standard
25978 \begin_inset Tabular
25979 <lyxtabular version="3" rows="13" columns="3">
25980 <features booktabs="true" islongtable="true" longtabularalignment="center">
25981 <column alignment="left" valignment="middle" width="16col%">
25982 <column alignment="left" valignment="middle" width="40col%">
25983 <column alignment="left" valignment="middle" width="35col%">
25984 <row endhead="true">
25985 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25988 \begin_layout Plain Layout
25997 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26000 \begin_layout Plain Layout
26009 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26012 \begin_layout Plain Layout
26022 <row interlinespace="default">
26023 <cell alignment="left" valignment="top" usebox="none">
26026 \begin_layout Plain Layout
26034 <cell alignment="left" valignment="top" usebox="none">
26037 \begin_layout Plain Layout
26040 Circle with circular hole (in the size of a CD/DVD)
26045 <cell alignment="left" valignment="top" usebox="none">
26048 \begin_layout Plain Layout
26051 Cannot be scaled, take care there is not too much text
26057 <row interlinespace="default">
26058 <cell alignment="left" valignment="top" usebox="none">
26061 \begin_layout Plain Layout
26069 <cell alignment="left" valignment="top" usebox="none">
26072 \begin_layout Plain Layout
26080 <cell alignment="left" valignment="top" usebox="none">
26083 \begin_layout Plain Layout
26086 Fragile, calculation might fail
26092 <row interlinespace="default">
26093 <cell alignment="left" valignment="top" usebox="none">
26096 \begin_layout Plain Layout
26104 <cell alignment="left" valignment="top" usebox="none">
26107 \begin_layout Plain Layout
26110 Rhomboid (symbolizing a
26111 \begin_inset Quotes eld
26115 \begin_inset Quotes erd
26123 <cell alignment="left" valignment="top" usebox="none">
26126 \begin_layout Plain Layout
26135 <row interlinespace="default">
26136 <cell alignment="left" valignment="top" usebox="none">
26139 \begin_layout Plain Layout
26147 <cell alignment="left" valignment="top" usebox="none">
26150 \begin_layout Plain Layout
26158 <cell alignment="left" valignment="top" usebox="none">
26161 \begin_layout Plain Layout
26170 <row interlinespace="default">
26171 <cell alignment="left" valignment="top" usebox="none">
26174 \begin_layout Plain Layout
26182 <cell alignment="left" valignment="top" usebox="none">
26185 \begin_layout Plain Layout
26193 <cell alignment="left" valignment="top" usebox="none">
26196 \begin_layout Plain Layout
26205 <row interlinespace="default">
26206 <cell alignment="left" valignment="top" usebox="none">
26209 \begin_layout Plain Layout
26217 <cell alignment="left" valignment="top" usebox="none">
26220 \begin_layout Plain Layout
26223 Nut for bolt (hexagon with circular hole)
26228 <cell alignment="left" valignment="top" usebox="none">
26231 \begin_layout Plain Layout
26240 <row interlinespace="default">
26241 <cell alignment="left" valignment="top" usebox="none">
26244 \begin_layout Plain Layout
26252 <cell alignment="left" valignment="top" usebox="none">
26255 \begin_layout Plain Layout
26263 <cell alignment="left" valignment="top" usebox="none">
26266 \begin_layout Plain Layout
26275 <row interlinespace="default">
26276 <cell alignment="left" valignment="top" usebox="none">
26279 \begin_layout Plain Layout
26287 <cell alignment="left" valignment="top" usebox="none">
26290 \begin_layout Plain Layout
26298 <cell alignment="left" valignment="top" usebox="none">
26301 \begin_layout Plain Layout
26310 <row interlinespace="default">
26311 <cell alignment="left" valignment="top" usebox="none">
26314 \begin_layout Plain Layout
26322 <cell alignment="left" valignment="top" usebox="none">
26325 \begin_layout Plain Layout
26333 <cell alignment="left" valignment="top" usebox="none">
26336 \begin_layout Plain Layout
26345 <row interlinespace="default">
26346 <cell alignment="left" valignment="top" usebox="none">
26349 \begin_layout Plain Layout
26357 <cell alignment="left" valignment="top" usebox="none">
26360 \begin_layout Plain Layout
26363 Normal/reversed rain drop
26368 <cell alignment="left" valignment="top" usebox="none">
26371 \begin_layout Plain Layout
26374 Fragile, calculation might fail
26380 <row interlinespace="default">
26381 <cell alignment="left" valignment="top" usebox="none">
26384 \begin_layout Plain Layout
26393 <cell alignment="left" valignment="top" usebox="none">
26396 \begin_layout Plain Layout
26399 The \SpecialChar TeX
26405 <cell alignment="left" valignment="top" usebox="none">
26408 \begin_layout Plain Layout
26417 <row interlinespace="default">
26418 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26421 \begin_layout Plain Layout
26425 \begin_inset Newline newline
26433 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26436 \begin_layout Plain Layout
26439 Triangles in different orientations
26444 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26447 \begin_layout Plain Layout
26463 \begin_layout Standard
26464 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26466 for environments in the toolbar.
26469 \begin_layout Standard
26470 \begin_inset Newpage newpage
26476 \begin_layout Standard
26477 Here is an example paragraph in the shape of a nut:
26480 \begin_layout Standard
26481 \begin_inset VSpace bigskip
26490 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26491 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26493 At vero eos et accusam et justo duo dolores et ea rebum.
26494 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26496 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26497 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26501 \begin_layout Standard
26502 \begin_inset VSpace bigskip
26508 \begin_layout Standard
26509 \begin_inset Note Greyedout
26512 \begin_layout Plain Layout
26521 paragraphs cannot run over a page break.
26529 \begin_layout Standard
26530 \begin_inset VSpace bigskip
26536 \begin_layout Standard
26538 \begin_inset Flex Code
26541 \begin_layout Plain Layout
26547 takes care that the shape will always be preserved, no matter how much
26548 text is in the paragraph.
26549 Therefore the paragraph size changes with the amount of contained text.
26550 This can lead to paragraph sizes exceeding the page margins.
26551 To demonstrate the size scaling, here is the same example paragraph but
26552 with twice as much text:
26555 \begin_layout Standard
26556 \begin_inset Newpage newpage
26565 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26566 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26568 At vero eos et accusam et justo duo dolores et ea rebum.
26569 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26571 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26572 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26574 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26575 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26577 At vero eos et accusam et justo duo dolores et ea rebum.
26578 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26580 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26581 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26585 \begin_layout Standard
26586 \begin_inset VSpace bigskip
26592 \begin_layout Standard
26593 An exception is the shape
26598 It cannot be scaled because it must fit the size of a CD/DVD.
26599 Therefore the amount of text that fits into the shape is limited.
26600 \begin_inset Newline newline
26611 shape are fragile, meaning that the calculation of their size can fail,
26612 depending on the amount of text.
26613 You will then get the \SpecialChar LaTeX
26615 \begin_inset Quotes eld
26618 Arithmetic overflow
26619 \begin_inset Quotes erd
26623 In this case one can try to remove or add some text; if nothing works one
26624 has to use another shape.
26627 \begin_layout Standard
26628 \begin_inset VSpace bigskip
26634 \begin_layout Standard
26635 For shapes with tips you will maybe see that \SpecialChar LaTeX
26636 's hyphenation routine fails
26637 for text in the tips.
26638 Therefore it is often necessary to add hyphenation points
26643 arg "specialchar-insert hyphenation"
26648 ) to the corresponding text parts.
26651 \begin_layout Standard
26652 \begin_inset VSpace bigskip
26658 \begin_layout Standard
26659 Shapepar paragraphs are either always centered or placed on the page so
26660 that their left border touches the left page margin.
26661 You can therefore not use the paragraph dialog to align such paragraphs.
26662 A solution is to put the paragraph into a minipage or parbox and align
26664 The problem is hereby to find the right width for the box.
26665 Because if it is too wide and you center the box, the paragraph is not
26666 centered too because it sticks at the left side of the box.
26667 So you might have to play a bit with the width until it fits.
26668 Here are two heart-shaped paragraphs, the first one is not aligned, the
26669 second one is right-aligned:
26672 \begin_layout Standard
26673 \begin_inset Newpage newpage
26679 \begin_layout Heart
26683 Lo\SpecialChar softhyphen
26684 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26685 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26687 At vero eos et accusam et justo duo dolores et ea rebum.
26688 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26692 \begin_layout Standard
26693 \begin_inset VSpace bigskip
26699 \begin_layout Standard
26702 \begin_inset Box Frameless
26712 height_special "totalheight"
26717 backgroundcolor "none"
26720 \begin_layout Heart
26724 Lo\SpecialChar softhyphen
26725 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26726 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26728 At vero eos et accusam et justo duo dolores et ea rebum.
26729 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26738 \begin_layout Subsection
26742 \begin_layout Standard
26743 You can define any shape you want.
26744 Doing this manually is a lot of work because every coordinate must be specified.
26745 But there is a way to let the computer calculate the coordinates:
26748 \begin_layout Enumerate
26749 Install the program
26750 \begin_inset CommandInset href
26753 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
26761 \begin_layout Enumerate
26768 TeX/LaTeX\SpecialChar menuseparator
26769 Settings\SpecialChar menuseparator
26772 and select the font size you are using in your document.
26773 For example this document uses the size 12
26774 \begin_inset space \thinspace{}
26780 \begin_layout Enumerate
26784 \begin_layout Enumerate
26787 TeX/LaTeX\SpecialChar menuseparator
26790 to export the shape to coordinates.
26791 In the appearing dialog use either the outline of your shape for the coordinate
26792 s or the path itself.
26796 \begin_layout Plain Layout
26797 For more information see
26798 \begin_inset CommandInset href
26800 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26813 \begin_layout Standard
26814 The coordinates are written into a \SpecialChar TeX
26816 To use it for your \SpecialChar LyX
26820 \begin_layout Enumerate
26821 Place the cursor before the first character of your paragraph (or into a
26825 \begin_layout Enumerate
26826 Open in \SpecialChar LyX
26829 Insert\SpecialChar menuseparator
26830 File\SpecialChar menuseparator
26832 \begin_inset space ~
26837 , select the file and use
26846 \begin_layout Standard
26847 \begin_inset VSpace defskip
26853 \begin_layout Standard
26854 \begin_inset Note Greyedout
26857 \begin_layout Plain Layout
26862 : The changed shape only applies to the current paragraph; everything is
26863 reset to normal for the next paragraph.
26864 Therefore the shape definition file must be input into every paragraph
26865 with the desired shape.
26873 \begin_layout Standard
26874 \begin_inset VSpace bigskip
26880 \begin_layout Standard
26881 Here is an example:
26884 \begin_layout Standard
26885 \begin_inset VSpace bigskip
26891 \begin_layout Standard
26892 \begin_inset CommandInset include
26894 filename "SpecialParagraphShape.tex"
26901 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26902 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26904 At vero eos et accusam et justo duo dolores et ea rebum.
26905 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26907 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26908 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26912 \begin_layout Standard
26913 \begin_inset VSpace bigskip
26919 \begin_layout Standard
26924 to draw complexer shapes in
26928 you can draw the shape in a program of your choice and import the resulting
26934 Then you only need to draw a line or spline along the outline of the image.
26937 \begin_layout Standard
26938 \begin_inset VSpace bigskip
26944 \begin_layout Standard
26947 Custom paragraph shapes
26949 also provides the two commands
26957 which can be used to define custom shapes coordinate by coordinate.
26961 \begin_layout Plain Layout
26962 These commands are internally used for all shapes described here.
26967 For information how these styles are used and about further customization
26968 possibilities, have a look at the
26969 \begin_inset CommandInset href
26971 name "documentation"
26972 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
26978 \begin_inset Flex Code
26981 \begin_layout Plain Layout