1 #LyX 2.1 created this file. For more info see http://www.lyx.org/
7 % DO NOT ALTER THIS PREAMBLE!!!
9 % This preamble is designed to ensure that the manual prints
10 % out as advertised. If you mess with this preamble,
11 % parts of the manual may not print out as expected. If you
12 % have problems LaTeXing this file, please contact
13 % the documentation team
14 % email: lyx-docs@lists.lyx.org
20 % set fonts for nicer pdf view
21 \IfFileExists{lmodern.sty}
22 {\usepackage{lmodern}}{}
24 \fi % end if pdflatex is used
26 % the pages of the TOC are numbered roman
27 % and a PDF-bookmark for the TOC is added
29 \let\myTOC\tableofcontents
30 \renewcommand{\tableofcontents}{%
31 \pdfbookmark[1]{\contentsname}{}
34 \pagenumbering{arabic}}
36 % used for multi-column text
39 % extra space for tables
40 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
42 \options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
43 \use_default_options false
50 \maintain_unincluded_children false
53 InsetLayout CharStyle:MenuItem
62 \newcommand*{\menuitem}[1]{{\sffamily #1}}
67 \language_package default
72 \font_typewriter default
74 \font_default_family default
75 \use_non_tex_fonts false
81 \default_output_format default
83 \bibtex_command default
84 \index_command default
88 \pdf_title "LyX's Additional Features manual"
89 \pdf_author "LyX Team"
90 \pdf_subject "LyX's additional features documentation"
91 \pdf_keywords "LyX, Documentation, Additional"
93 \pdf_bookmarksnumbered true
94 \pdf_bookmarksopen false
95 \pdf_bookmarksopenlevel 1
100 \pdf_pdfusetitle false
101 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
104 \use_package amsmath 1
105 \use_package amssymb 1
107 \use_package mathdots 1
108 \use_package mathtools 0
109 \use_package mhchem 1
110 \use_package undertilde 0
112 \cite_engine_type numerical
116 \paperorientation portrait
120 \notefontcolor #0000ff
127 \paragraph_separation indent
128 \paragraph_indentation default
129 \quotes_language english
132 \paperpagestyle headings
133 \tracking_changes true
134 \output_changes false
138 \author 274215730 "scott"
144 Additional LyX Features
147 \begin_layout Subtitle
156 \begin_layout Plain Layout
158 Principal maintainer of this file is
163 If you have comments or error corrections, please send them to the LyX
164 Documentation mailing list,
165 \begin_inset Flex Code
168 \begin_layout Plain Layout
170 <lyx-docs@lists.lyx.org>
183 \begin_layout Standard
184 \begin_inset CommandInset toc
185 LatexCommand tableofcontents
192 \begin_layout Chapter
196 \begin_layout Standard
197 This manual is essentially Part II of the
199 User's Guide\SpecialChar \@.
202 The reason for separating the two documents is simple: the
206 is already quite lengthy, and it contains information on all of the basic
207 features one needs to know in order to prepare most documents.
208 However, the LyX Team has worked to make LyX extensible through various
209 configuration files and external packages.
210 That means that if you want to support the Fizzwizzle LaTeX package, you
211 can create a layout file (or module) for it without having to alter LyX
213 We've already had contributions of several new features this way, and some
214 of them are documented here.
215 There are also some more `advanced' features, such as how to control the
216 presentation of bibliographies and how to work with multi-part documents,
217 that are not covered in the
221 and are discussed here.
224 \begin_layout Standard
225 This manual also documents some special features, like fax support, version
226 control, and SGML support, which require additional software to work properly.
227 There is also a chapter on LyX's support for HTML.
228 And lastly, there's a chapter of LaTeX tools and tips, things you can use
229 to spruce up your documents by directly using the powerful features of
235 only WYSIWYM and will only ever interface to some, not all, LaTeX features.
238 \begin_layout Standard
239 If you haven't read the
243 yet, you are definitely in the wrong manual.
248 is the first place to go, since it describes the notation and format of
250 You should also be thoroughly familiar with the
254 and all of the basic features of LyX before attempting to read this one.
257 \begin_layout Standard
258 Since many of the topics in this manual depend heavily on LyX's interaction
259 with LaTeX, this first chapter covers the inner workings of LyX and how
260 to direct LyX to generate exactly the LaTeX code you want.
261 It is obviously for more seasoned LyX users.
264 \begin_layout Chapter
268 \begin_layout Section
272 \begin_layout Standard
273 This chapter is for both TeX-nicians and the LaTeX-curious.
274 In it, we'll explain how LyX and LaTeX work together to produce printable
276 This is the only place in any of the manuals where we assume you know something
280 \begin_layout Standard
281 At one time, LyX was called a
282 \begin_inset Quotes eld
285 WYSIWYM frontend to LaTeX,
286 \begin_inset Quotes erd
289 but that's no longer true.
290 There are frontends to LaTeX out there.
294 \begin_layout Plain Layout
295 Some familar ones are TeXmaker and kile, on Linux, and TeXshop, OSX.
296 There are also the LaTeX modes for vi and emacs, of course.
301 These are basically text editors with the ability to run LaTeX and mark
302 any errors in the file you're editing.
311 run LaTeX, and it also indicates errors in the file, it also does much,
313 For one thing, you don't need to know LaTeX to use LyX effectively.
314 And LyX has added its own extensions to LaTeX.
315 Try the following sometime: select
316 \begin_inset Flex MenuItem
319 \begin_layout Plain Layout
320 Export\SpecialChar \menuseparator
327 \begin_inset Flex MenuItem
330 \begin_layout Plain Layout
337 \begin_inset Flex MenuItem
340 \begin_layout Plain Layout
341 View\SpecialChar \menuseparator
347 ), then look at the preamble of the resulting
348 \begin_inset Flex Code
351 \begin_layout Plain Layout
358 You'll notice a variety of new macros defined specifically by LyX.
359 These macros are defined automatically, according to the features you use
363 \begin_layout Standard
364 There are several commands that automatically invoke LaTeX.
368 \begin_layout Itemize
369 \begin_inset Flex MenuItem
372 \begin_layout Plain Layout
373 View\SpecialChar \menuseparator
382 \begin_layout Itemize
383 \begin_inset Flex MenuItem
386 \begin_layout Plain Layout
387 View\SpecialChar \menuseparator
396 \begin_layout Itemize
397 \begin_inset Flex MenuItem
400 \begin_layout Plain Layout
401 File\SpecialChar \menuseparator
410 \begin_layout Itemize
411 \begin_inset Flex MenuItem
414 \begin_layout Plain Layout
415 File\SpecialChar \menuseparator
424 \begin_layout Standard
425 They will only invoke LaTeX if the file has changed since the last time
430 \begin_layout Standard
431 When LyX runs LaTeX on the file you're editing, it performs these steps:
434 \begin_layout Enumerate
435 Convert the document to LaTeX and save to a file with the extension
436 \begin_inset Flex Code
439 \begin_layout Plain Layout
446 \begin_inset Flex Code
449 \begin_layout Plain Layout
458 \begin_layout Enumerate
460 \begin_inset Flex Code
463 \begin_layout Plain Layout
469 file (maybe several times), and run any other commands (such as
470 \begin_inset Flex Code
473 \begin_layout Plain Layout
480 \begin_inset Flex Code
483 \begin_layout Plain Layout
489 ) needed to compile the LaTeX file.
492 \begin_layout Enumerate
493 If there are any errors, show the error log.
496 \begin_layout Standard
497 If you have run LaTeX using
498 \begin_inset Flex MenuItem
501 \begin_layout Plain Layout
504 \SpecialChar \menuseparator
512 , LyX then runs a DVI viewer to display the DVI-file.
514 \begin_inset Flex MenuItem
517 \begin_layout Plain Layout
520 \SpecialChar \menuseparator
528 , LyX performs further steps:
531 \begin_layout Itemize
533 \begin_inset Flex Code
536 \begin_layout Plain Layout
542 to convert the DVI file to PostScript.
545 \begin_layout Itemize
546 Run a PostScript viewer, such as
547 \begin_inset Flex Code
550 \begin_layout Plain Layout
556 , to display the PostScript file.
559 \begin_layout Standard
560 LyX does similar things when viewing, or exporting, other formats.
563 \begin_layout Section
564 Translating LaTeX files into LyX
567 \begin_layout Standard
568 You can import a LaTeX file into LyX by using the
569 \begin_inset Flex MenuItem
572 \begin_layout Plain Layout
573 File\SpecialChar \menuseparator
574 Import\SpecialChar \menuseparator
581 This will call a program named
582 \begin_inset Flex Code
585 \begin_layout Plain Layout
591 which will create a file
592 \begin_inset Flex Code
595 \begin_layout Plain Layout
602 \begin_inset Flex Code
605 \begin_layout Plain Layout
612 LyX will then open that file.
616 \begin_layout Plain Layout
617 \begin_inset Flex Code
620 \begin_layout Plain Layout
626 can also be run from the command line, of course.
634 \begin_layout Standard
635 \begin_inset Flex Code
638 \begin_layout Plain Layout
644 will translate most legal LaTeX, but not everything.
645 It will put things it doesn't understand into TeX code, so after translating
647 \begin_inset Flex Code
650 \begin_layout Plain Layout
656 , you can look for TeX code and hand-edit it until it looks right.
659 \begin_layout Standard
660 If you don't know what TeX code is, read the next section.
663 \begin_layout Section
664 \begin_inset CommandInset label
666 name "sec:Inserting-TeX-Code"
670 Inserting TeX Code into LyX Documents
673 \begin_layout Standard
674 Anything you can do in LaTeX you can do in LyX, for a very simple reason:
675 You can always insert TeX code into any LyX document.
676 LyX cannot, and will never be able to, display every possible LaTeX construct.
677 If ever you need to insert LaTeX commands into your LyX document, you can
679 \begin_inset Flex Code
682 \begin_layout Plain Layout
688 box, which you can insert into your document with
689 \begin_inset Flex MenuItem
692 \begin_layout Plain Layout
693 Insert\SpecialChar \menuseparator
699 or the keyboard shortcut
708 \begin_layout Standard
709 Here's an example of inserting LaTeX commands in a LyX document.
710 The code looks like this:
713 \begin_layout LyX-Code
717 \begin_inset Newline newline
723 \begin_inset Newline newline
726 This is an example of a minipage environment.
728 \begin_inset Newline newline
731 can put nearly everything in it, even (non-floating)
732 \begin_inset Newline newline
737 \begin_inset Newline newline
743 \begin_inset Newline newline
747 \begin_inset Newline newline
753 \begin_inset Newline newline
759 \begin_inset Newline newline
765 \begin_inset Newline newline
770 \begin_inset Newline newline
776 \begin_inset Newline newline
782 \begin_inset Newline newline
788 \begin_inset Newline newline
796 \begin_layout LyX-Code
800 \begin_layout Standard
802 \begin_inset Flex Code
805 \begin_layout Plain Layout
811 box containing this text is directly after this paragraph.
812 Those of you reading the manual in LyX will only see the TeX code inset.
813 Those reading a printed version of the manuals will see the actual results:
814 \begin_inset VSpace bigskip
820 \begin_layout Standard
824 \begin_layout Plain Layout
831 \begin_layout Plain Layout
838 \begin_layout Plain Layout
840 This is an example of a minipage environment.
841 You can put nearly everything in it, even (non-floating) figures and tables.
845 \begin_layout Plain Layout
852 \begin_layout Plain Layout
857 \begin_layout Plain Layout
864 \begin_layout Plain Layout
871 \begin_layout Plain Layout
878 \begin_layout Plain Layout
884 \begin_layout Plain Layout
891 \begin_layout Plain Layout
898 \begin_layout Plain Layout
905 \begin_layout Plain Layout
915 \begin_inset VSpace bigskip
921 \begin_layout Standard
922 In addition to using TeX code, you can also create a separate file containing
923 some complex LaTeX structure and then use
924 \begin_inset Flex MenuItem
927 \begin_layout Plain Layout
928 Insert\SpecialChar \menuseparator
938 to include your file (you should select the type
939 \begin_inset Flex Code
942 \begin_layout Plain Layout
949 We recommend that you only do this if you have a
950 \begin_inset Flex Code
953 \begin_layout Plain Layout
964 Otherwise, you'll have a big job tracking down LaTeX errors.
967 \begin_layout Standard
968 There are a few last points to emphasize:
971 \begin_layout Itemize
976 check if your LaTeX code is correct.
979 \begin_layout Itemize
980 Beware of reinventing the wheel.
983 \begin_layout Standard
984 On that last point, LyX does have quite a few features tucked into it, and
986 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
987 feature before you decide you have to do it by hand.
988 Moreover, there are numerous LaTeX packages out there to do all sorts of
989 things, from labels to envelopes to fancy multipage tables.
991 \begin_inset CommandInset href
994 target "http://www.ctan.org/"
1001 \begin_layout Standard
1002 If you do need to do some wild and fancy things within your document, be
1003 sure to check out a good LaTeX book for assistance.
1004 There are a number of them listed in the bibliography of the
1011 \begin_layout Section
1012 LyX and the LaTeX Preamble
1015 \begin_layout Subsection
1016 About the LaTeX Preamble
1019 \begin_layout Standard
1020 If you already know LaTeX, there is no need to explain here what the preamble
1022 If you don't, the following will give you some ideas—we recommend again
1023 that you consult a LaTeX book for further information.
1024 In any case, you should read the points below, because they explain what
1025 you can do and what you don't need to do in the LaTeX preamble of a LyX
1029 \begin_layout Standard
1030 The LaTeX preamble comes at the very beginning of a document,
1038 \begin_layout Itemize
1039 Declare the document class.
1041 \begin_inset Newline newline
1044 LyX already does this for you.
1045 If you're a seasoned LaTeX-nician, and you have a custom document class
1046 you want to use, check out the
1048 Customization Manual
1050 for information on how to make LyX interface to it.
1053 \begin_layout Itemize
1054 Declare the usage of packages.
1056 \begin_inset Newline newline
1059 LaTeX packages provide special commands, which are only available within
1060 a document when the package has been declared in the preamble.
1061 In addition to providing special commands, the inclusion of a package can
1062 change the document.
1063 For example, the package
1064 \begin_inset Flex Code
1067 \begin_layout Plain Layout
1073 forces all paragraphs to be indented.
1074 There are other packages for labels, envelopes, margins, etc.
1078 \begin_layout Itemize
1079 Set counters, variables, lengths and widths.
1081 \begin_inset Newline newline
1084 There are several LaTeX counters and variables that
1088 be set globally from within the preamble in order to have the desired effect.
1089 (There are variables that you can set and reset inside the document, too.)
1090 Margins are a good example of something that must be set in the preamble.
1091 Another example is the label format for lists.
1092 You can actually set these just about anywhere, but it's best to do it
1093 just once, inside the preamble.
1096 \begin_layout Itemize
1097 Declare user defined commands (with
1098 \begin_inset Flex Code
1101 \begin_layout Plain Layout
1110 \begin_inset Flex Code
1113 \begin_layout Plain Layout
1122 \begin_inset Newline newline
1125 These are abbreviations for LaTeX commands which appear very often inside
1127 Although the preamble is a good place to declare such commands, they
1131 be declared anywhere (before they are used for the first time, of course).
1132 This can be useful if there is a lot of raw LaTeX code in your document,
1133 which normally should not be the case.
1136 \begin_layout Standard
1137 LyX adds its own set of definitions to the preamble of the
1138 \begin_inset Flex Code
1141 \begin_layout Plain Layout
1148 This makes LaTeX files generated by LyX portable.
1151 \begin_layout Subsection
1152 Changing the Preamble
1155 \begin_layout Standard
1156 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1157 can't change them without patching LyX itself.
1158 You can, however, add your own stuff to the preamble by selecting
1159 \begin_inset Flex MenuItem
1162 \begin_layout Plain Layout
1164 \begin_inset space ~
1173 \begin_inset Flex MenuItem
1176 \begin_layout Plain Layout
1177 Document\SpecialChar \menuseparator
1184 LyX adds anything in the
1185 \begin_inset Flex MenuItem
1188 \begin_layout Plain Layout
1194 dialog to its own built-in preamble.
1195 Before adding your own declarations in the preamble, you should make sure
1196 that LyX doesn't already support what you want to do.
1197 (Remember what we said about reinventing the wheel?) Also,
1199 make sure your preamble code is correct
1202 LyX doesn't check it for you.
1203 If there is an error, you're likely to get an error like
1204 \begin_inset Quotes eld
1208 \begin_inset Flex Code
1211 \begin_layout Plain Layout
1220 \begin_inset Quotes erd
1224 If you see this error, check your preamble.
1227 \begin_layout Subsection
1231 \begin_layout Standard
1232 Here are some examples of what you can add to a preamble, and what they
1236 \begin_layout Subsubsection
1240 \begin_layout Standard
1241 There are two variables under LaTeX that control page position:
1242 \begin_inset Flex Code
1245 \begin_layout Plain Layout
1254 \begin_inset Flex Code
1257 \begin_layout Plain Layout
1266 Their names should be self-explanatory.
1267 These variables are useful if you think for a moment about computer labels.
1268 Sometimes, the size of a print medium and the area of the medium that you
1269 can actually print on aren't the same.
1271 \begin_inset Flex Code
1274 \begin_layout Plain Layout
1283 \begin_inset Flex Code
1286 \begin_layout Plain Layout
1297 \begin_layout Standard
1298 The default values for
1299 \begin_inset Flex Code
1302 \begin_layout Plain Layout
1311 \begin_inset Flex Code
1314 \begin_layout Plain Layout
1323 \begin_inset space \thinspace{}
1327 \begin_inset space \thinspace{}
1331 \begin_inset space \space{}
1334 the page isn't shifted.
1335 Unfortunately, some DVI drivers always seem to shift the page.
1336 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1337 If you're using LyX on a system that you don't personally maintain, and
1338 your sysadmin is a doofus,
1339 \begin_inset Flex Code
1342 \begin_layout Plain Layout
1351 \begin_inset Flex Code
1354 \begin_layout Plain Layout
1363 Suppose your left and top margins are always 0.5
1364 \begin_inset space \thinspace{}
1368 You can add this to the preamble:
1371 \begin_layout LyX-Code
1379 \begin_layout LyX-Code
1387 \begin_layout Standard
1388 and your margins should now be correct.
1391 \begin_layout Subsubsection
1395 \begin_layout Standard
1396 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1397 There's a rather nice package, available at your nearest CTAN archive,
1398 for printing sheets of labels:
1399 \begin_inset Flex Code
1402 \begin_layout Plain Layout
1409 Now, your system may not have this package installed by default.
1410 We leave that up to you to check.
1411 You'll also want to read the documentation for it; we're not going to do
1413 Since this is an example, however, we'll give you an example of how you
1417 \begin_layout Standard
1418 First, make sure you're using the
1419 \begin_inset Flex Code
1422 \begin_layout Plain Layout
1429 Next, you need to put the following in your preamble:
1432 \begin_layout LyX-Code
1438 \begin_layout LyX-Code
1444 \begin_layout LyX-Code
1450 \begin_layout LyX-Code
1456 \begin_layout LyX-Code
1462 \begin_layout LyX-Code
1468 \begin_layout LyX-Code
1474 \begin_layout Standard
1475 This sets things up for Avery label sheets, stock #5360.
1476 You're now ready to print labels, but you'll need to insert LaTeX code,
1477 placing the commands
1478 \begin_inset Flex Code
1481 \begin_layout Plain Layout
1490 \begin_inset Flex Code
1493 \begin_layout Plain Layout
1501 around each label text.
1502 This and other special features of
1503 \begin_inset Flex Code
1506 \begin_layout Plain Layout
1512 are explained in its documentation.
1515 \begin_layout Standard
1516 Someday, someone may write a LyX layout file to support this package directly.
1517 Maybe that someone is you.
1520 \begin_layout Subsubsection
1521 Example #3: Paragraph Indentation
1524 \begin_layout Standard
1525 Americans are trained to indent the first line of
1530 As with all of their other weird quirks, most Americans will whine and
1531 moan until they can have their way and indent the first line of all paragraphs.
1540 \begin_layout Standard
1541 Of course, this behavior isn't standard typography.
1542 In books, you typically only indent the first line of a paragraph
1546 it follows another one.
1547 The idea behind indenting the first line of a paragraph is to distinguish
1548 neighboring paragraphs from one another.
1549 If there is no previous paragraph—for example, if it follows a figure or
1550 is the first paragraph in a section—then there is no need for indentation.
1554 \begin_layout Standard
1555 If you're a typical American (we're still joking!), though, you don't care
1556 about such esoteric things; you want your indentation! Add this to the
1560 \begin_layout LyX-Code
1563 usepackage{indentfirst}
1566 \begin_layout Standard
1567 If your TeX distribution isn't braindead, you'll have this package, and
1568 all of your paragraphs will get the indentation the Founding Fathers intended
1572 \begin_layout Subsubsection
1573 Example #4: This Document
1576 \begin_layout Standard
1577 You can also check out the preamble of this document to get an idea of some
1578 of the advanced things you can do.
1581 \begin_layout Section
1582 LyX and LaTeX Errors
1585 \begin_layout Standard
1586 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1588 It then uses the logfile from the LaTeX run to do a post-mortem.
1589 After analyzing the logfile, LyX displays a dialog listing the errors.
1590 Clicking on any one of them will take you to the position in your LyX file
1591 where the error occurred.
1595 \begin_layout Plain Layout
1597 Analyzing the logfile is a tough job, and LyX doesn't always go to the
1599 There are also cases where LaTeX reports the error on one line, but the
1600 actual error is earlier.
1601 This is not unlike forgetting a closing brace in a program: You'll get
1602 an error, but only later.
1610 \begin_layout Standard
1611 Some folks also like to look at the log file directly: It is available from
1613 \begin_inset Flex MenuItem
1616 \begin_layout Plain Layout
1619 \SpecialChar \menuseparator
1623 \begin_inset space ~
1632 There are some fairly common error messages and warnings.
1633 We'll cover those here.
1634 You should look at a good LaTeX book for a complete listing.
1637 \begin_layout Itemize
1638 \begin_inset Flex Code
1641 \begin_layout Plain Layout
1648 \begin_inset Newline newline
1651 Anything beginning with these words is a warning message for the purpose
1653 \begin_inset Quotes eld
1657 \begin_inset Quotes erd
1660 the LaTeX code itself.
1661 You'll get messages like this if you added or changed cross-references
1662 or bibliography entries, in which case, LaTeX is trying to tell you that
1663 you need to make another run.
1664 You can by-and-large ignore these.
1667 \begin_layout Itemize
1668 \begin_inset Flex Code
1671 \begin_layout Plain Layout
1678 \begin_inset Newline newline
1681 Another warning message, this time about fonts which LaTeX couldn't find.
1682 The rest of the message will often say something about a replacement font
1684 You can safely ignore these, too.
1687 \begin_layout Itemize
1688 \begin_inset Flex Code
1691 \begin_layout Plain Layout
1700 \begin_inset Newline newline
1708 They are warnings about lines that were too long and run past the right
1710 Almost always, this is unnoticeable in the final output.
1711 (It can be just a point or two.) Or, only one or two characters extend past
1713 LaTeX seems to generate at least one of these messages for just about any
1715 \begin_inset Newline newline
1718 You can ignore these messages.
1719 Your eyes will tell you if there's a problem with something that's too
1720 wide; just look at the output.
1724 \begin_layout Plain Layout
1725 You can also enable the `draft' option in
1726 \begin_inset Flex MenuItem
1729 \begin_layout Plain Layout
1732 \SpecialChar \menuseparator
1740 , and then LaTeX will draw a black box in the margin of lines that are overfull.
1748 \begin_layout Itemize
1749 \begin_inset Flex Code
1752 \begin_layout Plain Layout
1761 \begin_inset Newline newline
1764 Not quite as common as its cousin.
1765 LaTeX seems to like to print lines that are a bit too wide as opposed to
1766 ones that are a bit too narrow.
1767 We have no idea why.
1770 \begin_layout Itemize
1771 \begin_inset Flex Code
1774 \begin_layout Plain Layout
1783 \begin_inset Flex Code
1786 \begin_layout Plain Layout
1795 \begin_inset Newline newline
1798 Warnings about troubles breaking the page.
1799 Once again, just look at the output.
1800 Your eyes will tell you where something has gone wrong.
1803 \begin_layout Itemize
1804 \begin_inset Flex Code
1807 \begin_layout Plain Layout
1809 \begin_inset Quotes els
1813 \begin_inset Quotes ers
1822 \begin_inset Newline newline
1826 \begin_inset Quotes eld
1830 \begin_inset Quotes erd
1833 isn't installed on this system.
1834 This usually appears because some package your document needs isn't installed.
1835 If you didn't touch the preamble or didn't use the
1836 \begin_inset Flex Code
1839 \begin_layout Plain Layout
1847 command, then one of the packages LyX tried to load is missing.
1849 \begin_inset Flex MenuItem
1852 \begin_layout Plain Layout
1853 Help\SpecialChar \menuseparator
1859 to get a list of packages that LyX knows about.
1860 This file is updated whenever you reconfigure LyX (using
1861 \begin_inset Flex MenuItem
1864 \begin_layout Plain Layout
1865 Tools\SpecialChar \menuseparator
1871 ) and tells you which packages have been detected and what they do.
1872 \begin_inset Newline newline
1876 \begin_inset Flex Code
1879 \begin_layout Plain Layout
1887 command and the package in question isn't installed, then you'll need to
1888 install it yourself.
1891 \begin_layout Itemize
1892 \begin_inset Flex Code
1895 \begin_layout Plain Layout
1896 LaTeX Error: Unknown option
1902 \begin_inset Newline newline
1905 Error messages beginning with this are trying to tell you that you specified
1906 a bad or undefined option to a package.
1907 Check the package's documentation.
1910 \begin_layout Itemize
1911 \begin_inset Flex Code
1914 \begin_layout Plain Layout
1915 Undefined control sequence
1921 \begin_inset Newline newline
1924 If you've inserted LaTeX code into your document, but made a typo, you'll
1926 You may have forgotten to load a package.
1927 In any case, this error message usually means that you used an undefined
1932 \begin_layout Standard
1933 There are other error and warning messages.
1934 Some are self-explanatory.
1935 These are usually LaTeX messages.
1936 Others are downright cryptic.
1937 These are usually TeX error messages, and we really have
1941 what they mean or how to decipher them.
1945 \begin_layout Standard
1946 There's a general sequence you should follow if you get error messages:
1949 \begin_layout Enumerate
1950 Look at the LaTeX code you inserted for typos.
1953 \begin_layout Enumerate
1954 If there are no typos, check that you used the command(s) correctly.
1957 \begin_layout Enumerate
1958 If you get a bunch of error boxes piled up at the very top of the document—and
1959 especially if you see a
1960 \begin_inset Quotes eld
1964 \begin_inset Flex Code
1967 \begin_layout Plain Layout
1976 \begin_inset Quotes erd
1979 error—it means that there are errors in the preamble.
1980 Start debugging your preamble.
1983 \begin_layout Enumerate
1984 If you didn't add anything to the preamble and didn't add any LaTeX code
1985 to the document, the first suspect is your LaTeX distribution itself.
1986 Check for missing packages and install them.
1989 \begin_layout Enumerate
1990 Okay, so there are no missing packages.
1991 Did you use any of the fine-tuning options in LyX? Specifically, did you
1996 any of them, like trying to manually insert lots of
1997 \begin_inset Flex Code
2000 \begin_layout Plain Layout
2002 \begin_inset space ~
2011 \begin_inset Flex Code
2014 \begin_layout Plain Layout
2021 \begin_inset Flex Code
2024 \begin_layout Plain Layout
2030 ? Did you try to kludge something together with these instead of using the
2031 appropriate paragraph environment?
2034 \begin_layout Enumerate
2035 All right, you didn't use any of the fine-tuning options, you played by
2037 Did you try to pull a fancy maneuver? Did you do something funky inside
2038 a table or an equation, like inserting a graphic into a table cell?
2041 \begin_layout Enumerate
2042 Do you have long sections of text where LaTeX cannot find a place to break
2043 a line? By default, LaTeX is rather strict about how much extra inter-word
2044 spacing it will add in order to break a line.
2045 Preferably, you should rework the paragraph to avoid the problem.
2046 If this isn't an option, you can wrap your text in
2047 \begin_inset Flex Code
2050 \begin_layout Plain Layout
2058 to make LaTeX's line breaking more, well, sloppy.
2061 \begin_layout Enumerate
2062 Did you go overboard with the nesting? LyX (currently) doesn't check to
2063 make sure you're in the limits for nesting environments.
2064 If you nested a bunch of environments to the
2065 \begin_inset Formula $17^{\mathrm{th}}$
2068 level, that's the problem.
2069 (The limit in LaTeX is five.)
2072 \begin_layout Enumerate
2073 Okay, you didn't get any error messages, but your output looks awful.
2074 If you have a table or figure that's too wide or long for the page, you
2079 \begin_layout Enumerate
2080 rescale the figure so it fits.
2083 \begin_layout Enumerate
2084 trim down the table so it fits.
2088 \begin_layout Enumerate
2089 If something else is wrong with the output, and you didn't try to pull anything
2090 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2093 \begin_layout Standard
2094 If all this doesn't help—well, then
2098 you might have found a bug in LyX\SpecialChar \ldots{}
2102 \begin_layout Chapter
2106 \begin_layout Section
2107 Customizing Bibliographies with BibTeX
2110 \begin_layout Standard
2111 The most basic information about how to use BibTeX with LyX is contained
2114 Bibliography databases (BibTeX)
2121 The following subsections explain special bibliography features supported
2125 \begin_layout Subsection
2126 Alternative Citation Styles
2129 \begin_layout Standard
2130 Standard BibTeX uses numbers (e.
2131 \begin_inset space \thinspace{}
2135 \begin_inset space \space{}
2139 \begin_inset Quotes eld
2143 \begin_inset Quotes erd
2146 ) to refer to a cited work.
2147 However, in many scientific disciplines, other citation styles are in use.
2148 The most common one is the author-year style (e.
2149 \begin_inset space \thinspace{}
2153 \begin_inset space \space{}
2157 \begin_inset Quotes eld
2161 \begin_inset Quotes erd
2165 LyX supports two packages that provide this style,
2166 \begin_inset Flex Code
2169 \begin_layout Plain Layout
2176 \begin_inset Flex Code
2179 \begin_layout Plain Layout
2186 Both packages have their pros and cons, which cannot be listed in detail.
2187 If you only want to have simple author-year (or author-numerical) style,
2188 or if you want to use one of the countless style files for
2189 \begin_inset Flex Code
2192 \begin_layout Plain Layout
2198 , then the established
2199 \begin_inset Flex Code
2202 \begin_layout Plain Layout
2208 package is probably your choice.
2209 If you need special features like short title references, ibidem etc., you
2211 \begin_inset Flex Code
2214 \begin_layout Plain Layout
2223 \begin_layout Standard
2224 The handling of both packages in LyX is basically the same.
2226 \begin_inset Flex MenuItem
2229 \begin_layout Plain Layout
2230 Document\SpecialChar \menuseparator
2237 \begin_inset Flex MenuItem
2240 \begin_layout Plain Layout
2247 \begin_inset Flex MenuItem
2250 \begin_layout Plain Layout
2257 \begin_inset Flex MenuItem
2260 \begin_layout Plain Layout
2267 With both packages, you will get some extra features in the citation dialog
2268 and you can select the style of the reference (
2269 \begin_inset Quotes eld
2273 \begin_inset Quotes erd
2277 \begin_inset Quotes eld
2281 \begin_inset Quotes erd
2285 \begin_inset Quotes eld
2289 \begin_inset Quotes erd
2293 \begin_inset Quotes eld
2297 \begin_inset Quotes erd
2301 Note that both packages need specifically designed style files.
2302 They both ship their own, but there are lots of additional style files,
2303 and there is even an interactive style file builder
2307 \begin_layout Plain Layout
2309 \begin_inset Flex URL
2312 \begin_layout Plain Layout
2314 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2325 \begin_inset Flex Code
2328 \begin_layout Plain Layout
2337 \begin_layout Subsection
2338 Sectioned Bibliographies
2341 \begin_layout Standard
2342 Sometimes you might need to divide your bibliography into several sections.
2343 If you are for instance a historian, the possibility to separate sources
2344 and scientific works is most likely a
2345 \begin_inset Quotes eld
2349 \begin_inset Quotes erd
2353 Unfortunately, BibTeX itself does not allow you to do this.
2354 But with the help of some LaTeX packages, BibTeX can be extended to fit
2358 \begin_layout Standard
2359 LyX provides native support for one of these packages,
2367 \begin_layout Plain Layout
2369 \begin_inset Flex URL
2372 \begin_layout Plain Layout
2374 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2384 The advantage of this package (compared to other packages like
2388 ) is that you don't need to define new citation commands.
2389 Instead, you need to prepare different bibliographic databases which include
2390 the entries for the different sections of the bibliography.
2391 For example: If you want to divide your bibliography into the sections
2393 \begin_inset Quotes eld
2397 \begin_inset Quotes erd
2401 \begin_inset Quotes eld
2405 \begin_inset Quotes erd
2408 , you first need to create two bibliographic databases, e.
2409 \begin_inset space \thinspace{}
2413 \begin_inset space \space{}
2417 \begin_inset Flex Code
2420 \begin_layout Plain Layout
2427 \begin_inset Flex Code
2430 \begin_layout Plain Layout
2440 \begin_layout Standard
2442 \begin_inset Flex MenuItem
2445 \begin_layout Plain Layout
2446 Document\SpecialChar \menuseparator
2453 \begin_inset Flex MenuItem
2456 \begin_layout Plain Layout
2463 \begin_inset Flex MenuItem
2466 \begin_layout Plain Layout
2467 Sectioned bibliography
2473 Now you can insert multiple BibTeX bibliographies, one for each section
2474 of your bibliography.
2475 Returning to our example: Insert the BibTeX bibliography
2476 \begin_inset Flex Code
2479 \begin_layout Plain Layout
2485 and a second one for the database
2486 \begin_inset Flex Code
2489 \begin_layout Plain Layout
2496 You are free to use the same or different styles for each section.
2497 Additionally, you can choose if the bibliography section should contain
2499 \begin_inset Quotes eld
2502 all cited references
2503 \begin_inset Quotes erd
2506 of the specified database(s) (which is the default),
2507 \begin_inset Quotes eld
2510 all uncited references
2511 \begin_inset Quotes erd
2515 \begin_inset Quotes eld
2519 \begin_inset Quotes erd
2523 This might be useful if you would like to separate your bibliography into
2525 \begin_inset Quotes eld
2529 \begin_inset Quotes erd
2533 \begin_inset Quotes eld
2537 \begin_inset Quotes erd
2541 \begin_inset Quotes eld
2545 \begin_inset Quotes erd
2549 The titles for the sections can be added as ordinary sections or subsections.
2551 \begin_inset Flex Code
2554 \begin_layout Plain Layout
2560 removes the bibliography title, you have to manually re-add that, too (as
2561 a chapter* or section*, for instance).
2564 \begin_layout Subsection
2565 Multiple Bibliographies
2568 \begin_layout Standard
2569 Multiple bibliographies, e.
2570 \begin_inset space \thinspace{}
2574 \begin_inset space \space{}
2577 a bibliography for each section or chapter of the document, are not supported
2580 \begin_inset Flex Code
2583 \begin_layout Plain Layout
2589 package, which is used for the creation of sectioned bibliographies in
2590 LyX (see the previous section), provides an easy way to solve this task,
2591 if you are willing to use some
2592 \begin_inset Flex MenuItem
2595 \begin_layout Plain Layout
2602 \begin_inset space ~
2606 \begin_inset CommandInset ref
2608 reference "sec:Inserting-TeX-Code"
2616 \begin_layout Plain Layout
2617 An alternative approach is to use the
2618 \begin_inset Flex Code
2621 \begin_layout Plain Layout
2628 \begin_inset Flex Code
2631 \begin_layout Plain Layout
2637 package, respectively.
2645 \begin_layout Standard
2647 \begin_inset Flex MenuItem
2650 \begin_layout Plain Layout
2651 Document\SpecialChar \menuseparator
2658 \begin_inset Flex MenuItem
2661 \begin_layout Plain Layout
2668 \begin_inset Flex MenuItem
2671 \begin_layout Plain Layout
2672 Sectioned bibliography
2678 In the document, you have to enclose the sections, which shall contain
2679 their own bibliography (including the BibTeX bibliography itself), between
2681 \begin_inset Flex Code
2684 \begin_layout Plain Layout
2693 \begin_inset Flex Code
2696 \begin_layout Plain Layout
2704 (those commands have to be inserted as TeX code).
2705 The bibliography will contain all references that have been cited in the
2707 \begin_inset Flex Code
2710 \begin_layout Plain Layout
2721 If you are using this approach, then every citation reference has to be
2723 \begin_inset Flex Code
2726 \begin_layout Plain Layout
2734 \begin_inset Flex Code
2737 \begin_layout Plain Layout
2746 \begin_layout Section
2750 \begin_layout Subsection
2754 \begin_layout Standard
2755 When you are working on a large file with many sections, it is often convenient
2756 to break up the document into several files, or perhaps you have something
2757 where a table may change from time to time, but the preceding text does
2759 In these cases, you should seriously consider using multipart documents.
2760 For example, scientific papers often have five major sections: the introduction
2761 , observations, results, discussion, and conclusion.
2762 Each of these could be its own separate LyX file, with one
2763 \begin_inset Quotes eld
2767 \begin_inset Quotes erd
2770 file which contains the title, authors, abstract, references, etc., plus
2771 the five included files.
2772 It is important to note that each of these files is a full LyX file which
2773 can be formatted and printed on its own, as well as included in a master
2775 Each of these files must have the same document class, however—don't attempt
2776 to mix book classes with article classes.
2777 You may also include LaTeX files; however, these files must not have their
2779 \begin_inset space \thinspace{}
2783 \begin_inset space \space{}
2786 everything up to and including the
2787 \begin_inset Flex Code
2790 \begin_layout Plain Layout
2799 \begin_inset Flex Code
2802 \begin_layout Plain Layout
2810 line must be deleted) or else errors will be generated when you try to
2814 \begin_layout Standard
2815 LyX allows you to include files quite easily with
2816 \begin_inset Flex MenuItem
2819 \begin_layout Plain Layout
2820 Insert\SpecialChar \menuseparator
2822 \begin_inset space ~
2831 When you click on this selection a small box is inserted into the file
2832 at the current cursor location.
2833 Clicking on the box raises a dialog which allows you to select the file
2834 to be included, and the method of its inclusion.
2838 \begin_layout Standard
2839 The file selection box should by now be obvious.
2840 The three inclusion methods are
2841 \begin_inset Quotes eld
2845 \begin_inset Quotes erd
2849 \begin_inset Quotes eld
2853 \begin_inset Quotes erd
2857 \begin_inset Quotes eld
2861 \begin_inset Quotes erd
2865 The difference between
2866 \begin_inset Quotes eld
2870 \begin_inset Quotes erd
2874 \begin_inset Quotes eld
2878 \begin_inset Quotes erd
2881 is really only meaningful to LaTeXperts, but the practical difference is
2883 \begin_inset Quotes eld
2887 \begin_inset Quotes erd
2890 are typeset beginning on a new page, while files that are
2891 \begin_inset Quotes eld
2895 \begin_inset Quotes erd
2898 are typeset starting on the current page.
2901 \begin_layout Standard
2902 Generally, the master file is converted into a full LaTeX file before typesettin
2903 g, while the included files are converted to LaTeX files that do not have
2904 all the preamble information.
2907 \begin_layout Standard
2909 \begin_inset Quotes eld
2913 \begin_inset Quotes erd
2916 included file allows you to include a file typeset exactly as it appears
2918 \begin_inset space \thinspace{}
2922 \begin_inset space \space{}
2926 \begin_inset Flex Code
2929 \begin_layout Plain Layout
2935 mode, with the characters set in a fixed-width typewriter font.
2936 Normally, spaces in this file are invisible, though two consecutive spaces
2937 are conserved, unlike LyX's normal treatment of spaces.
2938 However, setting the
2939 \begin_inset Flex MenuItem
2942 \begin_layout Plain Layout
2944 \begin_inset space ~
2948 \begin_inset space ~
2952 \begin_inset space ~
2960 checkbox typesets a mark to unambiguously define the presence of a space.
2964 \begin_layout Subsection
2965 Cross-References Between Files
2968 \begin_layout Standard
2969 \begin_inset Box Shadowbox
2979 height_special "totalheight"
2982 \begin_layout Plain Layout
2983 This section is somewhat out of date.
2984 Need to describe default master documents and how children are opened when
2994 \begin_layout Standard
2995 It is possible to set up cross-references between the different files.
2996 First, open all the files in question: let's call them A and B in a two
2997 file example, where B is included in A.
2998 Let's say you insert a label in A, then want to reference it in B.
2999 Open the cross-reference dialog whilst in document B, and you can select
3001 \begin_inset Quotes eld
3005 \begin_inset Quotes erd
3011 \begin_layout Subsection
3012 Bibliography Lists in all Subdocuments
3015 \begin_layout Standard
3016 \begin_inset Box Frameless
3026 height_special "totalheight"
3029 \begin_layout Plain Layout
3030 This section also needs updating.
3031 There is now material about this on the wiki, and it could be copied here.
3039 \begin_layout Standard
3040 Copy the bibliography list with all entries to all subdocuments and transform
3042 This way LyX will find the
3043 \begin_inset Flex Code
3046 \begin_layout Plain Layout
3052 -files and you can easily insert references without making the bibliography
3056 \begin_layout Standard
3057 As the bibliography list is in a comment, LaTeX won't use use it and the
3058 references will look like this: [?], instead of like this: [1].
3059 One solution is to use the LaTeX-package
3060 \begin_inset Flex Code
3063 \begin_layout Plain Layout
3069 that will only include comments by processing the files separately.
3070 To do this, add in the LaTeX preamble of every subdocument the following:
3073 \begin_layout LyX-Code
3079 \begin_layout LyX-Code
3082 includecomment{comment}
3085 \begin_layout Standard
3087 \begin_inset Flex URL
3090 \begin_layout Plain Layout
3092 http://wiki.lyx.org/FAQ/Unsorted#toc31
3100 \begin_layout Section
3104 \begin_layout Standard
3105 Users sometimes need to be able to
3106 \begin_inset Quotes eld
3110 \begin_inset Quotes erd
3113 a LyX file together with all the images (and other files) on which it depends,
3114 either for sending to a publisher or for sharing with a co-author.
3115 LyX 2.0 includes a Python script (
3116 \begin_inset Flex Code
3119 \begin_layout Plain Layout
3125 ) that automates this process.
3126 To use it, you must have either the
3127 \begin_inset Flex Code
3130 \begin_layout Plain Layout
3137 \begin_inset Flex Code
3140 \begin_layout Plain Layout
3146 python modules installed on your system.
3147 By default, the script prefers the
3148 \begin_inset Flex Code
3151 \begin_layout Plain Layout
3158 \begin_inset Flex Code
3161 \begin_layout Plain Layout
3167 format on Unix-like systems and the
3168 \begin_inset Flex Code
3171 \begin_layout Plain Layout
3180 \begin_layout Standard
3181 LyX's configuration process will set the script up to export a `LyX Archive',
3182 and this format will then be available under
3183 \begin_inset Flex Code
3186 \begin_layout Plain Layout
3187 File\SpecialChar \menuseparator
3196 \begin_layout Standard
3197 Independently of the platform, the generation of a particular archive format
3198 can be forced by adding either the
3199 \begin_inset Flex Code
3202 \begin_layout Plain Layout
3209 \begin_inset Flex Code
3212 \begin_layout Plain Layout
3219 \begin_inset Flex Code
3222 \begin_layout Plain Layout
3229 \begin_inset Flex Code
3232 \begin_layout Plain Layout
3238 format) switch to the
3239 \begin_inset Flex Code
3242 \begin_layout Plain Layout
3243 LyX\SpecialChar \menuseparator
3250 \begin_inset Flex Code
3253 \begin_layout Plain Layout
3254 Tools\SpecialChar \menuseparator
3255 Preferences\SpecialChar \menuseparator
3256 File Handling\SpecialChar \menuseparator
3263 (Make sure you add the switch after the script name, not before it.)
3266 \begin_layout Section
3267 Fancy Headers and Footers
3270 \begin_layout Standard
3271 The default page layout is rather plain; for an
3272 \begin_inset Flex Code
3275 \begin_layout Plain Layout
3281 document class, all you get is a centered page number at the bottom of
3283 This document uses KOMA-script's book class, so it appears to be a bit
3285 But to really put on a show, you need to set the document page style to
3287 \begin_inset Quotes eld
3291 \begin_inset Quotes erd
3294 , as mentioned in the
3299 This section describes the LaTeX code you need to insert in your LaTeX
3300 preamble in order to get the desired effects.
3303 \begin_layout Standard
3304 For more information on fancy headers, see the
3305 \begin_inset Flex Code
3308 \begin_layout Plain Layout
3314 package documentation.
3316 \begin_inset Flex URL
3319 \begin_layout Plain Layout
3321 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
3329 \begin_layout Standard
3330 The page header is divided into three fields, not surprisingly labeled
3331 \begin_inset Quotes eld
3335 \begin_inset Quotes erd
3339 \begin_inset Quotes eld
3343 \begin_inset Quotes erd
3347 \begin_inset Quotes eld
3351 \begin_inset Quotes erd
3355 The footer is also divided into these three fields.
3356 The LaTeX commands to set these fields in the simplest manner are
3357 \begin_inset Flex Code
3360 \begin_layout Plain Layout
3369 \begin_inset Flex Code
3372 \begin_layout Plain Layout
3381 \begin_inset Flex Code
3384 \begin_layout Plain Layout
3393 \begin_inset Flex Code
3396 \begin_layout Plain Layout
3405 Suppose you wish to put your name in the upper left hand corner of each
3407 Simply insert the following command in the preamble:
3410 \begin_layout Standard
3419 \begin_layout Standard
3420 You will now see your name in the upper left.
3421 If a field has a default entry that you would like to get rid of (often
3422 the page number appears in the central footer) simply include a command
3423 with a blank argument, e.
3424 \begin_inset space \thinspace{}
3430 \begin_layout Standard
3438 \begin_layout Standard
3439 Let's get really fancy: lets put the section number with the word
3440 \begin_inset Quotes eld
3444 \begin_inset Quotes erd
3448 \begin_inset space \thinspace{}
3452 \begin_inset space \space{}
3455 Section 3) in the upper left, the page number (e.
3456 \begin_inset space \thinspace{}
3460 \begin_inset space \space{}
3463 Page 4) in the upper right, your name in the lower left, and the date in
3465 The following commands should now appear in the preamble:
3468 \begin_layout Standard
3478 \begin_layout Standard
3486 \begin_layout Standard
3496 \begin_layout Standard
3505 \begin_layout Standard
3513 \begin_layout Standard
3523 \begin_layout Standard
3525 \begin_inset Flex Code
3528 \begin_layout Plain Layout
3537 \begin_inset Flex Code
3540 \begin_layout Plain Layout
3548 access LaTeX's section and page counters, and so print out the current
3549 section and page numbers.
3551 \begin_inset Flex Code
3554 \begin_layout Plain Layout
3562 simply prints out today's date.
3565 \begin_layout Standard
3566 The thicknesses of the horizontal rules drawn beneath the header and above
3567 the footer can also be modified.
3568 If you don't want one of the rules, set its thickness to 0.
3569 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3575 \begin_inset Flex Code
3578 \begin_layout Plain Layout
3583 headrulewidth}{0.4pt}
3589 \begin_inset Flex Code
3592 \begin_layout Plain Layout
3597 footrulewidth}{0.4pt}
3602 to set the thicknesses.
3605 \begin_layout Standard
3606 You can switch the header/footer settings on and off for individual pages
3608 \begin_inset Flex Code
3611 \begin_layout Plain Layout
3614 thispagestyle{empty}
3620 \begin_inset Flex Code
3623 \begin_layout Plain Layout
3626 thispagestyle{plain}
3632 \begin_inset Flex Code
3635 \begin_layout Plain Layout
3638 thispagestyle{fancy}
3644 Simply insert them in the text on the page you want changed and mark them
3646 In fact, title pages are marked as plain by default, while following pages
3647 are marked fancy when using the global fancy setting.
3650 \begin_layout Standard
3651 As a final example, it is possible to include an image in the header or
3653 Suppose you want to put a company logo in the upper lefthand corner.
3654 You might try something like
3657 \begin_layout Standard
3666 includegraphics{logo.eps}}}
3669 \begin_layout Standard
3671 (you may need to preface this with
3672 \begin_inset Flex Code
3675 \begin_layout Plain Layout
3679 usepackage{graphics}
3684 if you don't include graphics elsewhere in your document).
3687 \begin_layout Section
3688 Itemize Bullet Selection
3689 \begin_inset CommandInset label
3698 \begin_layout Standard
3704 \begin_layout Subsection
3708 \begin_layout Standard
3709 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3710 Using this dialog you can easily specify what bullet shape to use at each
3711 level of an itemized list.
3712 These settings are document-wide so you won't be able to specify different
3713 sets of bullets for different paragraphs.
3717 \begin_layout Plain Layout
3718 Well, actually you can but you'll have to do it by hand.
3726 \begin_layout Subsection
3730 \begin_layout Standard
3731 Open the dialog by selecting the
3732 \begin_inset Flex MenuItem
3735 \begin_layout Plain Layout
3736 Document\SpecialChar \menuseparator
3742 menu item and then select the
3743 \begin_inset Flex MenuItem
3746 \begin_layout Plain Layout
3755 \begin_layout Standard
3756 The dialog provides you with a table of bullet shapes.
3757 A column of buttons on the left of the table provides access to the six
3758 different panels of bullet shapes.
3759 The row of buttons across the top is used to select which bullet depth
3761 A text entry under the table shows the currently selected bullet shape's
3762 LaTeX equivalent and this can be edited if desired.
3763 If you do modify the text you will also need to specify any needed packages
3764 in the LaTeX preamble.
3767 \begin_layout Standard
3768 The six panels are divided up by the packages they require.
3769 The following table shows the mappings from button name to LaTeX package.
3772 \begin_layout Standard
3774 \begin_inset Tabular
3775 <lyxtabular version="3" rows="7" columns="2">
3776 <features rotate="0" tabularvalignment="middle">
3777 <column alignment="center" valignment="top" width="0pt">
3778 <column alignment="center" valignment="top" width="0pt">
3780 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3783 \begin_layout Plain Layout
3798 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3801 \begin_layout Plain Layout
3818 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3821 \begin_layout Plain Layout
3836 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3839 \begin_layout Plain Layout
3855 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3858 \begin_layout Plain Layout
3873 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3876 \begin_layout Plain Layout
3893 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3896 \begin_layout Plain Layout
3911 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3914 \begin_layout Plain Layout
3931 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3934 \begin_layout Plain Layout
3949 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3952 \begin_layout Plain Layout
3969 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3972 \begin_layout Plain Layout
3987 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3990 \begin_layout Plain Layout
4007 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4010 \begin_layout Plain Layout
4025 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4028 \begin_layout Plain Layout
4051 \begin_layout Standard
4052 LyX doesn't stop you using bullets from packages you don't have.
4053 If you get errors from LaTeX when you try to view or print the file, then
4054 it is likely you are missing a package.
4058 \begin_layout Plain Layout
4059 LyX doesn't restrict your use since you may be editing locally and exporting
4068 \begin_layout Subsection
4072 \begin_layout Standard
4073 Select which bullet depth you want to change then select the bullet shape
4075 Any changes will not be visible in LyX, but are visible when viewing the
4079 \begin_layout Standard
4080 You can reset a bullet shape to the default simply by clicking your right
4081 mouse button on the appropriate bullet depth button.
4085 \begin_layout Plain Layout
4090 want to have multiple sets of paragraphs with different sets of bullets
4091 in each, then you're going to have to get your hands dirty with TeX code.
4092 The bullet selection dialog can help though because it provides you with
4093 the LaTeX code for a wide range of bullet shapes.
4094 To make your own custom paragraphs you have the following options:
4097 \begin_layout Plain Layout
4101 \begin_layout Plain Layout
4117 \begin_layout Plain Layout
4121 \begin_layout Plain Layout
4143 \begin_layout Itemize
4144 Use the LaTeX command
4145 \begin_inset Flex Code
4148 \begin_layout Plain Layout
4156 to specify a new bullet shape for a given depth.
4157 You'll also need to save the current bullet shape so you can restore it
4159 In this itemized list the following LaTeX code was used to change the bullet
4160 used for the first depth.
4164 \begin_layout LyX-Code
4174 \begin_layout LyX-Code
4191 \begin_layout Itemize
4192 Note that the itemize depth is specified in Roman numerals as part of the
4202 \begin_layout Itemize
4206 \begin_layout Plain Layout
4219 Specify each individual entry by starting each item with the bullet shape
4220 enclosed in square brackets and set as
4221 \begin_inset Flex MenuItem
4224 \begin_layout Plain Layout
4231 For example, this item was started with
4232 \begin_inset Flex Code
4235 \begin_layout Plain Layout
4250 \begin_layout Plain Layout
4254 \begin_layout Plain Layout
4270 \begin_layout Plain Layout
4271 You'll also need to revert the labelitem back to its previous setting for
4272 the global bullet shape settings to remain in effect.
4273 The way used here was:
4276 \begin_layout LyX-Code
4291 \begin_layout Chapter
4292 LyX and the World Wide Web
4295 \begin_layout Standard
4296 LyX has long supported the export of documents to various web-friendly formats,
4298 Before verson 2.0, however, HTML export was always accomplished by the use
4299 of external converters.
4303 \begin_layout Plain Layout
4304 For details on the use of external converters with LyX, see the
4308 section of the Customization manual.
4313 These fall into two large groups: there are converters that use LaTeX as
4314 an intermediate format, such as
4315 \begin_inset Flex Code
4318 \begin_layout Plain Layout
4325 \begin_inset Flex Code
4328 \begin_layout Plain Layout
4335 \begin_inset Flex Code
4338 \begin_layout Plain Layout
4344 , relying upon LyX to produce the LaTeX; and there is a converter that works
4345 directly on LyX files,
4346 \begin_inset Flex Code
4349 \begin_layout Plain Layout
4356 All of these have different advantages and disadvantages.
4360 \begin_layout Standard
4361 The LaTeX-based converters have the advantage that, in principle, they know
4362 everything about the exported document that LaTeX does.
4363 Such converters do not care, for example, if a certain block of code was
4364 produced by LyX or was Evil Red Text.
4365 These converters know about
4366 \begin_inset Flex Code
4369 \begin_layout Plain Layout
4375 files, counters, and references, and can often make use of the
4376 \begin_inset Flex Code
4379 \begin_layout Plain Layout
4385 files generated by BibTeX.
4386 On the other hand, LaTeX is a very hard language to parse---it is sometimes
4387 said that only TeX itself understands TeX---and LaTeX-based converters
4388 will often choke on what seem to be quite simple constructs; complex ones
4389 can throw them completely, and as of this writing, for example, the
4393 manual will not export with
4394 \begin_inset Flex Code
4397 \begin_layout Plain Layout
4403 , though the others will.
4404 The other issue concerns how math is handled.
4405 These converters typically convert the formulae into little pictures that
4406 are then linked from the HTML document.
4407 Since these are actually generated by LaTeX, they are accurate.
4408 But they do not scale well, and just getting them to look as if they are
4409 actually meant to be in your document---so that the font sizes seem to
4410 be roughly the same---can be a challenge.
4413 \begin_layout Standard
4415 \begin_inset Flex Code
4418 \begin_layout Plain Layout
4425 \begin_inset CommandInset href
4427 name "http://elyxer.nongnu.org/"
4428 target "http://elyxer.nongnu.org/"
4432 ) solves some of these problems.
4433 In particular, the formulae it produces scale perfectly, since it renders
4434 math using a combination of HTML and CSS rather than converting the formulae
4436 But even moderately complex formula are rendered less well than with
4437 \begin_inset Flex Code
4440 \begin_layout Plain Layout
4446 ; this reflects the limitations of HTML.
4450 \begin_layout Plain Layout
4452 \begin_inset Flex Code
4455 \begin_layout Plain Layout
4461 can also use jsMath and MathJax for equations, but this setting is only
4462 available globally and requires one to have access to a server that runs
4468 More importantly (as of version 1.1.1, at least),
4469 \begin_inset Flex Code
4472 \begin_layout Plain Layout
4478 has limited support for math macros and no support for user-defined paragraph
4479 or character styles.
4480 These limitations make
4481 \begin_inset Flex Code
4484 \begin_layout Plain Layout
4490 unsuitable for many of the documents LyX users produce.
4491 In principle, of course, these problems could be solved, but the LyX developers
4492 have decided to follow a different path and have made LyX itself capable
4493 of writing XHTML, just as it is capable of writing LaTeX, DocBook, and
4497 \begin_layout Standard
4498 As of this writing, XHTML output remains under development and should probably
4500 \begin_inset Quotes eld
4504 \begin_inset Quotes erd
4511 \begin_layout Plain Layout
4513 \begin_inset Flex Code
4516 \begin_layout Plain Layout
4517 development/HTML.notes
4522 , which can be found in the LyX source tree or
4523 \begin_inset CommandInset href
4525 name "accessed online"
4526 target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
4530 , usually contains up-to-date information about the state of XHTML output.
4531 See also the list of XHTML bugs on
4532 \begin_inset CommandInset href
4534 name "the bug tracker"
4535 target "http://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"
4544 Still, the developers have chosen this approach because it has several
4545 potential advantages over the other two.
4548 \begin_layout Standard
4549 These advantages are primarily due to the fact that the XHTML output routines,
4550 since they are part of LyX, know everything LyX knows about the document
4555 \begin_layout Plain Layout
4556 Another advantage is that, since these routines are internal to LyX, they
4557 are immune to changes in LyX's file format, or to changes in the semantics
4563 So they know about the table of contents (as displayed in the outline),
4564 about the counters associated with different paragraph styles, and about
4565 user-defined styles.
4566 The XHTML output routines know what LyX knows about internationalization,
4567 too, so they will output
4568 \begin_inset Quotes eld
4572 \begin_inset Quotes erd
4576 \begin_inset Quotes eld
4584 \begin_inset Quotes erd
4587 , depending upon the language in effect at the time.
4591 \begin_layout Standard
4592 Quite generally, the output routines know what LyX knows about document
4593 layout, that is, about how the document is to be rendered on screen.
4594 We use this information when we output the document as XHTML.
4599 generates CSS style information corresponding to the layout information
4600 it uses to render the document on screen: if section headings are supposed
4601 to be sans-serif and bold as seen in LyX, then (by default) they will be
4602 sans-serif and bold when viewed in a web browser, too.
4603 And this is true not just for pre-defined styles, like Section, but for
4604 any style, including user-defined styles.
4605 Indeed, the XHTML output routines make no distinction between user-defined
4606 paragraph and character styles and LyX's own pre-defined styles: in each
4607 case, everything LyX knows about the styles is contained in the layout
4609 And much the same is true as regards pre-defined textual insets, such as
4610 footnotes, and various custom insets.
4614 \begin_layout Standard
4615 The result is that XHTML output can be customized and extended in exactly
4616 the same way LaTeX output can be customized and extended: through layout
4618 See chapter five of the
4622 manual for the details.
4625 \begin_layout Standard
4626 The remainder of this chapter contains more detailed information on XHTML
4627 output, its limitations, and ways to work around those limitations.
4630 \begin_layout Section
4631 Math Output in XHTML
4634 \begin_layout Standard
4635 LyX offers four choices for how math is rendered.
4636 These have various advantages and disadvantages:
4639 \begin_layout Itemize
4641 \begin_inset Newline newline
4644 MathML is a dialect of XML designed specifically for mathematics on the
4645 web, and it typically renders very well in browsers that support it.
4646 The disadvantage is that not all browsers support MathML, and support is
4647 not complete even in the Gecko-based browsers, such as Firefox.
4648 \begin_inset Newline newline
4651 If LyX is unable to render a formula as MathML---for example, if the formula
4653 \begin_inset Flex Code
4656 \begin_layout Plain Layout
4662 package or ERT---then it will instead output the formula as an image.
4666 \begin_layout Itemize
4668 \begin_inset Newline newline
4672 \begin_inset Flex Code
4675 \begin_layout Plain Layout
4681 outputs math as HTML, styled by CSS.
4685 \begin_layout Plain Layout
4686 LyX has borrowed some of the CSS for its HTML output from
4687 \begin_inset Flex Code
4690 \begin_layout Plain Layout
4701 For simple formulae, this can work quite well, though with more complicated
4702 formulae it tends to break down.
4703 Still, this method has the advantage that it is very widely supported and
4704 so it may be appropriate for documents that contain only a little, fairly
4706 \begin_inset Newline newline
4709 If Lyx is unable to render a formula as HTML---for example, if the formula
4711 \begin_inset Flex Code
4714 \begin_layout Plain Layout
4720 package or ERT---then it will instead output the formula as an image.
4724 \begin_layout Itemize
4726 \begin_inset Newline newline
4730 \begin_inset Flex Code
4733 \begin_layout Plain Layout
4739 , LyX will output formulae as images, the very same images, in fact, that
4740 are used for instant preview.
4744 \begin_layout Plain Layout
4745 Instant preview does
4749 have to be on for images to be output, however.
4754 The advantage to this method is that the images are simply generated by
4755 LaTeX, so they are very accurate.
4756 The disadvantage, as mentioned earlier, is that these are bitmapped images,
4757 so they do not scale terribly well, and one cannot copy them, etc.
4758 (As of this writing, there are also problems about equation numbering.
4760 \begin_inset CommandInset href
4763 target "http://www.lyx.org/trac/ticket/6894"
4768 \begin_inset Newline newline
4771 The size of the images can be controlled by setting the
4772 \begin_inset Quotes eld
4776 \begin_inset Quotes erd
4780 \begin_inset Flex MenuItem
4783 \begin_layout Plain Layout
4784 Document\SpecialChar \menuseparator
4785 Settings\SpecialChar \menuseparator
4795 \begin_layout Plain Layout
4796 For those who want to know, this controls the resolution of the image in
4797 dots per inch and is based upon a default of 75 dpi.
4803 \begin_inset Newline newline
4806 If LyX for some reason fails to create an image for a formula (e.g., if a
4807 required LaTeX package is not installed), then it will fall back to outputing
4811 \begin_layout Itemize
4813 \begin_inset Newline newline
4816 Finally, LyX will happily output math as LaTeX.
4817 As well as being the output of last resort, this method can be used with
4819 \begin_inset CommandInset href
4822 target "http://www.math.union.edu/~dpvc/jsMath/"
4826 , which uses JavaScript to render LaTeX embedded in HTML documents.
4827 LyX wraps the LaTeX in either a
4828 \begin_inset Flex Code
4831 \begin_layout Plain Layout
4837 (for inline formulas) or
4838 \begin_inset Flex Code
4841 \begin_layout Plain Layout
4847 (for displayed formulas) with
4848 \begin_inset Flex Code
4851 \begin_layout Plain Layout
4857 , as is required for jsMath.
4860 \begin_layout Standard
4861 One of these output methods must be selected under
4862 \begin_inset Flex MenuItem
4865 \begin_layout Plain Layout
4866 Document\SpecialChar \menuseparator
4867 Settings\SpecialChar \menuseparator
4874 By default, LyX outputs MathML.
4875 This is a document-wide setting, therefore.
4878 \begin_layout Standard
4879 Eventually, LyX will offer the user the option to select an alternate output
4880 method for a particular inset, say, one that isn't being rendered very
4885 \begin_layout Plain Layout
4886 That said, since LyX falls back to images if the inset contains ERT, then
4887 one can force output as an image by putting some harmless ERT into the
4889 \begin_inset Formula $a=b\relax$
4900 \begin_layout Section
4901 Bibliography and Citations
4904 \begin_layout Standard
4905 XHTML output fully supports bibliographies and citations.
4909 \begin_layout Standard
4910 Citation labels are generated by the same machinery that generates LyX's
4911 on-screen labels, so the labels will look in the output much as they do
4912 in LyX, though better.
4913 If you are using numerical citations, then LyX will output numerical labels,
4914 such as [1] or [17], rather than simply showing the citation key in square
4915 brackets, as it does on-screen.
4916 If you are using author-year citations, then LyX will add lowercase letters
4917 to the years, just as BibTeX does, if it finds more than one citation for
4918 a given author-year combination.
4919 The labels will be printed with the bibliography entries.
4920 Note that there is, at present, no way to customize the appearance of the
4921 labels, for example, to choose between square brackets and parentheses.
4924 \begin_layout Standard
4925 Bibliography output is handled by the same machinery that handles the presentati
4926 on of reference information in the citation dialog, so you will see in the
4927 XHTML output pretty much what you would see if you were to look at a given
4928 entry in the citation dialog.
4929 The formatting can be customized in your layout file or, preferably, in
4935 manual for the details.
4938 \begin_layout Standard
4939 The main defect at present is that cross-referenced information is printed
4940 with every entry with which it is associated.
4941 So you can see things like this:
4946 \begin_inset Quotes eld
4949 Context and Logical Form
4950 \begin_inset Quotes erd
4955 Language in Context: Selected Essays
4957 (Oxford: Oxford University Press, 2007), pp.
4963 \begin_inset Quotes eld
4966 Semantics in Context
4967 \begin_inset Quotes erd
4972 Language in Context: Selected Essays
4974 (Oxford: Oxford University Press, 2007), pp.
4978 \begin_layout Standard
4979 This should be fixed before long.
4982 \begin_layout Standard
4983 There is no support at present for sectioned bibliographies.
4984 If you have multiple bibliographies, then LyX will print the same bibliography
4988 \begin_layout Section
4992 \begin_layout Standard
4993 LyX will happily export indexes as XHTML, but with certain limitations at
4997 \begin_layout Standard
4998 Index export will be most reliable when you do not attempt to use the fancy
4999 constructs that are described in the section on indexes in the
5007 \begin_layout Plain Layout
5008 The main issue here is that LyX itself does not really handle these.
5009 It just lets you enter what you would have to enter in raw LaTeX.
5014 We'll describe how they are handled using the subsection headings from
5018 \begin_layout Itemize
5019 Grouping Index Entries (aka, sub-entries): LyX makes an effort to support
5020 these, but the entries must be separated by
5021 \begin_inset Quotes eld
5025 \begin_inset Quotes erd
5028 , that is, there must be spaces around the exclamation point.
5029 This is because it is otherwise too difficult to check for escaped exclamation
5030 points, ones in math, and so forth.
5033 \begin_layout Itemize
5034 Page Ranges: There is no support at all for page ranges, since these make
5035 no sense with XHMTL.
5036 Instead, you will just get two index entries, one at either end.
5039 \begin_layout Itemize
5040 Cross-referencing: There is no support for cross-referencing.
5041 If LyX finds an entry containing the
5042 \begin_inset Quotes eld
5045 |see\SpecialChar \ldots{}
5047 \begin_inset Quotes erd
5050 construct, it is just dropped, and the rest is treated as an ordinary index
5054 \begin_layout Itemize
5055 Index Entry Order: LyX does support attempts to fix the sorting order.
5056 It will take what is before the first `@' it finds and use that for sorting,
5057 taking what follows the first `@' to be the actual entry.
5058 At present, LyX does not check for escaped `@', so do not try to index
5062 \begin_layout Itemize
5063 Index Entry Layout: You can format entries by using the text style dialog,
5064 or by using any other method available within LyX itself.
5065 There is no support for constructs like:
5066 \begin_inset Quotes eld
5070 \begin_inset Quotes erd
5074 Indeed, if LyX finds a pipe symbol, `|', in an entry, it will delete it
5075 and everything that follows it.
5078 \begin_layout Itemize
5079 Multiple Indexes: There is no support for multiple indexes.
5080 Rather, all index entries will be printed as one large index.
5081 To avoid our printing several versions of the index, we print only the
5082 main index, so make sure you have one.
5085 \begin_layout Section
5086 Nomenclature and Glossary
5089 \begin_layout Standard
5090 There is at present no support for glossaries.
5091 Adding it would be fairly trivial, and welcome.
5094 \begin_layout Chapter
5098 \begin_layout Section
5102 \begin_layout Standard
5103 The `LyX server' allows other programs to talk to LyX, invoke LyX commands,
5104 and retrieve information about the LyX internal state.
5105 This is only intended for advanced users, but they should find it useful.
5106 It is by writing to the LyX server, for example, that bibliography managers,
5107 such as JabRef, are able to
5108 \begin_inset Quotes eld
5112 \begin_inset Quotes erd
5118 \begin_layout Section
5119 Starting the LyX Server
5122 \begin_layout Standard
5123 The LyX server works through the use of a pair of named pipes.
5124 These are usually located in
5125 \begin_inset Flex Code
5128 \begin_layout Plain Layout
5134 , (except on Windows, where
5138 named pipes are special objects located in
5139 \begin_inset Flex Code
5142 \begin_layout Plain Layout
5154 ) and have the names
5155 \begin_inset Quotes eld
5159 \begin_inset Flex Code
5162 \begin_layout Plain Layout
5169 \begin_inset Quotes erd
5173 \begin_inset Quotes eld
5177 \begin_inset Flex Code
5180 \begin_layout Plain Layout
5187 \begin_inset Quotes erd
5191 External programs write into
5192 \begin_inset Flex Code
5195 \begin_layout Plain Layout
5201 and read back data from
5202 \begin_inset Flex Code
5205 \begin_layout Plain Layout
5212 The stem of the pipe names can be defined in the
5213 \begin_inset Flex MenuItem
5216 \begin_layout Plain Layout
5217 Tools\SpecialChar \menuseparator
5224 \begin_inset Flex Code
5227 \begin_layout Plain Layout
5228 "/home/myhome/lyxpipe"
5234 \begin_inset Flex Code
5237 \begin_layout Plain Layout
5251 on Windows (but any working path can be used).
5256 configure this manually in order for the server to start.
5259 \begin_layout Standard
5261 \begin_inset Flex Code
5264 \begin_layout Plain Layout
5271 \begin_inset Flex Code
5274 \begin_layout Plain Layout
5280 ' to create the pipes.
5281 If one of the pipes already exists, LyX will assume that another LyX process
5282 is already running and will not start the server.
5283 On POSIX (Unix like) systems, if for some other reason, an unused
5284 \begin_inset Quotes eld
5288 \begin_inset Quotes erd
5291 pipe is left in existence when LyX closes, then LyX will try to delete
5293 If this fails for some reason, you will need to delete the pipes manually
5294 and then restart LyX.
5295 On Windows, pipes are deleted by the OS on program termination or crash,
5297 \begin_inset Quotes eld
5301 \begin_inset Quotes erd
5304 pipes should not be possible.
5307 \begin_layout Standard
5308 To have several LyX processes with servers at the same time, you have to
5309 use different configurations, perhaps by using separate user directories,
5311 \begin_inset Flex Code
5314 \begin_layout Plain Layout
5320 file, for each process.
5323 \begin_layout Standard
5324 If you are developing a client program, you might find it useful to enable
5325 debugging information from the LyX server.
5326 Do this by starting LyX as
5327 \begin_inset Flex Code
5330 \begin_layout Plain Layout
5339 \begin_layout Standard
5340 You can find a complete example client written in C in the source distribution
5342 \begin_inset Flex Code
5345 \begin_layout Plain Layout
5346 development/lyxserver/server_monitor.c
5354 \begin_layout Standard
5355 Another useful tool is the command-line based clientfound in
5356 \begin_inset Flex Code
5359 \begin_layout Plain Layout
5360 src/client/lyxclient
5368 \begin_layout Section
5369 Normal communication
5372 \begin_layout Standard
5373 To issue a LyX call, the client writes a line of ASCII text into the input
5375 This line has the following format:
5392 \begin_layout Description
5393 clientname is a name that the client can choose arbitrarily.
5394 Its only use is that LyX will echo it if it sends an answer—so a client
5395 can dispatch results from different requesters.
5398 \begin_layout Description
5399 function is the function you want LyX to perform.
5400 It is the same as the commands you'd use in the minibuffer.
5403 \begin_layout Description
5404 argument is an optional argument which is meaningful only to some functions
5406 \begin_inset Quotes eld
5410 \begin_inset Quotes erd
5413 LFUN will insert the argument as text at the cursor position).
5416 \begin_layout Standard
5417 The answer from LyX will arrive in the output pipe and be of the form
5434 \begin_layout Standard
5443 are just echoed from the command request, while
5447 is more or less useful information filled according to how the command
5448 execution worked out.
5449 Some commands, such as
5450 \begin_inset Quotes eld
5454 \begin_inset Quotes erd
5457 , will return information about the internal state of LyX, while other will
5458 return an empty data-response.
5459 This means that the command execution went fine.
5462 \begin_layout Standard
5463 In case of errors, the response from LyX will have this form
5480 \begin_layout Standard
5485 should contain an explanation of why the command failed.
5488 \begin_layout Standard
5492 \begin_layout LyX-Code
5493 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
5494 \begin_inset Newline newline
5497 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
5498 \begin_inset Newline newline
5501 read a <~/.lyxpipe.out
5502 \begin_inset Newline newline
5508 \begin_layout Section
5512 \begin_layout Standard
5513 LyX can notify clients of events going on asynchronously.
5514 Currently it will only do this if the user binds a key sequence with the
5516 \begin_inset Quotes eld
5520 \begin_inset Quotes erd
5524 The format of the string LyX sends is as follows:
5528 \begin_inset Flex Code
5531 \begin_layout Plain Layout
5542 \begin_layout Standard
5547 is the printed representation of the key sequence that was actually typed
5551 \begin_layout Standard
5552 This mechanism can be used to extend LyX's command set and implement macros.
5553 Bind some key sequence to
5554 \begin_inset Quotes eld
5558 \begin_inset Quotes erd
5562 Then start a client that listens on the output pipe, dispatches the command
5563 according to the sequence, and starts a function that may use LyX calls
5564 and LyX requests to issue a command or a series of commands to LyX.
5567 \begin_layout Section
5568 The simple LyX Server Protocol
5571 \begin_layout Standard
5572 LyX implements a simple protocol that can be used for session management.
5573 All messages are of the form
5586 \begin_layout Standard
5592 \begin_inset Quotes eld
5596 \begin_inset Quotes erd
5600 \begin_inset Quotes eld
5604 \begin_inset Quotes erd
5609 \begin_inset Quotes eld
5613 \begin_inset Quotes erd
5616 is received from a client, LyX will report back to inform the client that
5617 it's listening to it's messages, while
5618 \begin_inset Quotes eld
5622 \begin_inset Quotes erd
5625 sent from LyX will inform clients that LyX is closing.
5628 \begin_layout Section
5629 Reverse DVI/PDF search
5632 \begin_layout Standard
5633 Some DVI/PDF viewers
5637 \begin_layout Plain Layout
5638 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
5639 Skim on Mac OSX and SumatraPDF on Windows.
5648 facility (also called
5653 This means that you can tell LyX to put the cursor to a specific line in
5654 the document by clicking at the respective position in the DVI/PDF output.
5655 To achieve this, the viewer must be able to communicate with LyX.
5656 This is done via the LyX server either by using the named pipe (
5660 ), or the UNIX domain socket (
5664 ) that LyX creates in its temporary directory (this is the way the
5665 \begin_inset Flex Code
5668 \begin_layout Plain Layout
5674 program communicates with LyX).
5675 In some cases, you need a helper script that mediates between the viewer
5676 and LyX, in others, the viewer can communicate with LyX directly.
5677 This depends on the selected viewer and on your operating system.
5678 The same applies to the way viewers need to be configured and the way the
5679 reverse search is actually performed.
5680 In what follows, we will thus describe how to setup reverse search for
5682 Before we turn to this, though, we will explain what needs to be done generally
5683 to enable reverse search in the DVI/PDF output.
5686 \begin_layout Subsection
5688 \begin_inset CommandInset label
5690 name "sub:rev-search"
5697 \begin_layout Standard
5698 In most cases LyX will do the work for you by enabling the option
5699 \begin_inset Flex MenuItem
5702 \begin_layout Plain Layout
5703 Synchronize with Output
5709 \begin_inset Flex MenuItem
5712 \begin_layout Plain Layout
5713 Document\SpecialChar \menuseparator
5714 Settings\SpecialChar \menuseparator
5721 In such a case LyX will automatically insert the necessary SyncTeX macro
5722 (for PDF) or load the srcltx package (for DVI) respectively.
5723 This option can be easily reached also on
5724 \begin_inset Flex Code
5727 \begin_layout Plain Layout
5736 \begin_layout Standard
5737 If you need a different setting, you can select or input a custom macro
5738 from the drop down box just below
5739 \begin_inset Flex MenuItem
5742 \begin_layout Plain Layout
5743 Document\SpecialChar \menuseparator
5744 Settings\SpecialChar \menuseparator
5745 Output\SpecialChar \menuseparator
5746 Synchronize with Output
5754 \begin_layout Standard
5755 Note that the method
5756 \begin_inset Flex Code
5759 \begin_layout Plain Layout
5767 enables gzip compression.
5768 If your viewer does not support it, you should instead use
5769 \begin_inset Flex Code
5772 \begin_layout Plain Layout
5783 \begin_layout Standard
5784 Please aöso note that including the
5785 \begin_inset Flex Code
5788 \begin_layout Plain Layout
5795 \begin_inset Flex Code
5798 \begin_layout Plain Layout
5804 sometimes has an undesired impact on the typesetting.
5805 Thus, you should switch output synchronization off for the final typesetting
5807 \begin_inset Flex Code
5810 \begin_layout Plain Layout
5817 \begin_inset Flex Code
5820 \begin_layout Plain Layout
5830 \begin_layout Standard
5831 In case you need some more special settings that are not covered by the
5832 automatic settings, read the next section about how to set up output synchroniz
5834 If the automatic setup suits your needs, you can readily jump to section
5835 \begin_inset space ~
5839 \begin_inset CommandInset ref
5841 reference "sub:configuring-viewers"
5845 , where the necessary configuration steps in your viewer -- needed both
5846 with the automatic and the manual setup -- are described.
5849 \begin_layout Subsection
5853 \begin_layout Standard
5854 LaTeX provides several different methods for reverse search.
5855 Some are built-in in the
5856 \begin_inset Flex Code
5859 \begin_layout Plain Layout
5865 program, some are provided by external packages.
5866 Your choice depends on whether your LaTeX distribution already provides
5867 a given method (the built-in methods are rather new) and whether your viewer
5869 The available methods are described in the following.
5872 \begin_layout Subsubsection*
5873 Built-in DVI-search via src-specials (DVI only)
5876 \begin_layout Standard
5877 This method provides the DVI file with the necessary information for reverse
5879 It is available in LaTeX since quite some time (any somewhat recent LaTeX
5880 distribution should include it), and it works reliably.
5881 To enable it, change the
5882 \begin_inset Flex MenuItem
5885 \begin_layout Plain Layout
5890 \begin_layout Plain Layout
5903 \begin_inset Flex MenuItem
5906 \begin_layout Plain Layout
5911 \begin_layout Plain Layout
5918 eX (plain)->DraftDVI
5924 \begin_inset Flex MenuItem
5927 \begin_layout Plain Layout
5928 Preferences\SpecialChar \menuseparator
5929 File Handling\SpecialChar \menuseparator
5936 \begin_inset Flex Code
5939 \begin_layout Plain Layout
5940 latex -src-specials $$i
5946 If this doesn't work, check if your TeX engine needs different options
5947 (the syntax might differ in some distributions).
5950 \begin_layout Subsubsection*
5951 External Packages (PDFSync and scrltx)
5954 \begin_layout Standard
5963 provide reverse search facility for PDF output (via pdflatex) and DVI output,
5965 In order to enable it, load the packages in the LyX preamble:
5968 \begin_layout Itemize
5969 \begin_inset Flex Code
5972 \begin_layout Plain Layout
5980 for reverse PDF search,
5983 \begin_layout Itemize
5984 \begin_inset Flex Code
5987 \begin_layout Plain Layout
5990 usepackage[active]{srcltx}
5995 for reverse DVI search.
5998 \begin_layout Standard
5999 If you want to be able to perform both DVI and PDF reverse searches, you
6000 can also insert in the preamble the following lines
6003 \begin_layout LyX-Code
6007 \begin_inset Newline newline
6013 \begin_inset Newline newline
6019 \begin_inset Newline newline
6025 \begin_inset Newline newline
6030 usepackage[active]{srcltx}
6031 \begin_inset Newline newline
6039 \begin_layout Standard
6040 This way, you can preview the file as either DVI or PDF (pdflatex) and the
6041 right package will be used.
6044 \begin_layout Standard
6045 Note that PDFSync might affect the output layout of your document.
6046 It is therefore advised to disable PDFsync for final documents.
6049 \begin_layout Subsubsection*
6050 Built-in reverse search via SyncTeX (DVI and PDF)
6053 \begin_layout Standard
6055 \begin_inset Flex Code
6058 \begin_layout Plain Layout
6064 have built-in support for both PDF and DVI reverse search.
6069 facility is basically the result of the integration of the PDFSync package
6070 to the pdftex program and its merge with the
6075 You need at least TeXLive 2008 or a recent MikTeX distribution in order
6077 Also note that only a few PDF viewers (Skim on the Mac, SumatraPDF on Windows)
6078 already provide SyncTeX support.
6081 \begin_layout Standard
6082 To enable SyncTeX for DVI output, change the
6083 \begin_inset Flex MenuItem
6086 \begin_layout Plain Layout
6091 \begin_layout Plain Layout
6104 \begin_inset Flex MenuItem
6107 \begin_layout Plain Layout
6112 \begin_layout Plain Layout
6119 eX (plain) -> DraftDVI
6125 \begin_inset Flex MenuItem
6128 \begin_layout Plain Layout
6129 Preferences\SpecialChar \menuseparator
6130 File Handling\SpecialChar \menuseparator
6137 \begin_inset Flex Code
6140 \begin_layout Plain Layout
6141 latex -synctex=1 $$i
6146 , and for PDF output, change the
6147 \begin_inset Flex MenuItem
6150 \begin_layout Plain Layout
6155 \begin_layout Plain Layout
6162 eX (pdflatex) -> PDF (pdflatex)
6168 \begin_inset Flex Code
6171 \begin_layout Plain Layout
6172 pdflatex -synctex=1 $$i
6178 Check the documentation of your viewer whether the viewer needs to be configure
6179 d for the use with SyncTeX.
6183 \begin_layout Plain Layout
6184 Note that the option
6185 \begin_inset Flex Code
6188 \begin_layout Plain Layout
6194 option enables gzip compression.
6195 If your viewer does not support it, you should instead use
6196 \begin_inset Flex Code
6199 \begin_layout Plain Layout
6213 \begin_layout Subsection
6214 Configuring and using specific viewers
6215 \begin_inset CommandInset label
6217 name "sub:configuring-viewers"
6224 \begin_layout Subsubsection*
6225 Xdvi (all platforms)
6228 \begin_layout Standard
6230 \begin_inset Flex Code
6233 \begin_layout Plain Layout
6239 , you don't need to do anything else for performing a reverse DVI search,
6240 as LyX already provides the necessary hooks for automatically using the
6242 \begin_inset Flex Code
6245 \begin_layout Plain Layout
6252 Just setup your document as described above (reverse search is triggered
6253 by Ctrl-click or Alt-click on Mac OSX, respectively).
6256 \begin_layout Standard
6257 However, if for whatever reason you want to use the named pipe instead of
6258 the socket for communicating with LyX, simply change the DVI viewer in
6260 \begin_inset Flex MenuItem
6263 \begin_layout Plain Layout
6264 Preferences\SpecialChar \menuseparator
6265 File Handling\SpecialChar \menuseparator
6275 \begin_layout Plain Layout
6276 On Mac OSX you have to use
6277 \begin_inset Flex Code
6280 \begin_layout Plain Layout
6281 DISPLAY=:0.0 xdvi -editor 'lyxeditor.sh %f %l'
6292 \begin_inset Flex Code
6295 \begin_layout Plain Layout
6296 xdvi -editor 'lyxeditor.sh %f %l'
6302 \begin_inset Flex Code
6305 \begin_layout Plain Layout
6311 is a suitable script.
6312 For example, a minimal shell script is the following one:
6315 \begin_layout LyX-Code
6317 \begin_inset Newline newline
6320 LYXPIPE="/path/to/lyxpipe"
6321 \begin_inset Newline newline
6324 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
6325 \begin_inset Newline newline
6328 echo "$COMMAND" > "${LYXPIPE}".in || exit
6329 \begin_inset Newline newline
6332 read < "${LYXPIPE}".out || exit
6335 \begin_layout Standard
6337 \begin_inset Flex Code
6340 \begin_layout Plain Layout
6350 \begin_layout Plain Layout
6357 XServer pipe path specified in
6358 \begin_inset Flex MenuItem
6361 \begin_layout Plain Layout
6362 Preferences\SpecialChar \menuseparator
6372 \begin_layout Plain Layout
6374 \begin_inset Flex Code
6377 \begin_layout Plain Layout
6383 folder of a source distribution you can find a
6384 \begin_inset Flex Code
6387 \begin_layout Plain Layout
6393 script which is able to locate the
6397 based on your preferences.
6405 \begin_layout Subsubsection*
6409 \begin_layout Standard
6411 \begin_inset Flex Code
6414 \begin_layout Plain Layout
6415 /Applications/MacDviX_Folder/calleditor.script
6420 , add the following lines:
6423 \begin_layout LyX-Code
6428 \begin_layout Plain Layout
6435 X.app/Contents/MacOS/lyxeditor "$2" $1
6436 \begin_inset Newline newline
6442 \begin_layout Standard
6443 Modify the lines accordingly if you install LyX somewhere else than in the
6444 Applications folder.
6447 \begin_layout Standard
6448 Reverse search is triggered by Alt-click (OPTION-click).
6451 \begin_layout Subsubsection*
6455 \begin_layout Standard
6457 \begin_inset Flex Code
6460 \begin_layout Plain Layout
6461 open -a Skim.app $$i
6466 to the viewer setting in
6467 \begin_inset Flex MenuItem
6470 \begin_layout Plain Layout
6471 Preferences\SpecialChar \menuseparator
6472 File Handling\SpecialChar \menuseparator
6473 File formats\SpecialChar \menuseparator
6480 \begin_inset Flex MenuItem
6483 \begin_layout Plain Layout
6484 Skim\SpecialChar \menuseparator
6485 Preferences\SpecialChar \menuseparator
6492 \begin_inset Flex MenuItem
6495 \begin_layout Plain Layout
6501 preset and enter command
6502 \begin_inset Flex MenuItem
6505 \begin_layout Plain Layout
6506 /Applications/LyX.app/Contents/MacOS/lyxeditor
6514 \begin_layout Standard
6515 Reverse search is triggered by COMMAND-SHIFT-click
6518 \begin_layout Subsubsection*
6522 \begin_layout Standard
6524 \begin_inset Flex MenuItem
6527 \begin_layout Plain Layout
6528 Settings\SpecialChar \menuseparator
6529 Configure Okular\SpecialChar \ldots{}
6530 \SpecialChar \menuseparator
6537 \begin_inset Quotes eld
6541 \begin_inset Quotes erd
6545 \begin_inset Flex Code
6548 \begin_layout Plain Layout
6557 \begin_layout Standard
6558 Reverse search is triggered by SHIFT-click.
6561 \begin_layout Subsubsection*
6565 \begin_layout Standard
6566 Launch yap, choose its
6567 \begin_inset Flex MenuItem
6570 \begin_layout Plain Layout
6571 View\SpecialChar \menuseparator
6578 \begin_inset Quotes eld
6582 \begin_inset Quotes erd
6587 \begin_inset Quotes eld
6590 New\SpecialChar \ldots{}
6592 \begin_inset Quotes erd
6595 button and, in the window that opens, enter
6596 \begin_inset Quotes eld
6600 \begin_inset Quotes erd
6603 (or any other name you like) in the
6604 \begin_inset Quotes eld
6608 \begin_inset Quotes erd
6612 Now click on the button labeled
6613 \begin_inset Quotes eld
6616 \SpecialChar \ldots{}
6618 \begin_inset Quotes erd
6621 to open a file dialog and navigate to the directory containing the batch
6623 \begin_inset Flex Code
6626 \begin_layout Plain Layout
6634 \begin_inset Flex Code
6637 \begin_layout Plain Layout
6643 and then specify the program arguments as
6644 \begin_inset Flex Code
6647 \begin_layout Plain Layout
6655 \begin_inset Flex Code
6658 \begin_layout Plain Layout
6664 wrapper is used for communicating with LyX through the
6671 \begin_layout LyX-Code
6673 \begin_inset Newline newline
6676 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
6685 \begin_inset Newline newline
6699 \begin_layout Standard
6700 Make sure that the LyXServer pipe path you specified in LyX is
6701 \begin_inset Flex Code
6704 \begin_layout Plain Layout
6718 , otherwise change the
6719 \begin_inset Flex Code
6722 \begin_layout Plain Layout
6728 wrapper accordingly.
6731 \begin_layout Standard
6732 In yap, reverse search is triggered by double-click.
6735 \begin_layout Subsubsection*
6736 SumatraPDF (Windows)
6739 \begin_layout Standard
6740 In order to use SumatraPDF for inverse search, enter
6741 \begin_inset Flex Code
6744 \begin_layout Plain Layout
6745 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
6750 in the viewer setting in
6751 \begin_inset Flex MenuItem
6754 \begin_layout Plain Layout
6755 Preferences\SpecialChar \menuseparator
6756 File Handling\SpecialChar \menuseparator
6757 File formats\SpecialChar \menuseparator
6764 \begin_inset Flex Code
6767 \begin_layout Plain Layout
6773 is the previous wrapper.
6774 If SumatraPDF.exe is not in your command PATH, use its full file name.
6777 \begin_layout Standard
6778 Reverse search is triggered by double-click.
6781 \begin_layout Subsubsection*
6785 \begin_layout Standard
6786 First of all, make sure that yap is your default DVI viewer in the Windows
6787 environment, then launch it, choose its
6788 \begin_inset Flex MenuItem
6791 \begin_layout Plain Layout
6792 View\SpecialChar \menuseparator
6799 \begin_inset Quotes eld
6803 \begin_inset Quotes erd
6808 \begin_inset Quotes eld
6811 New\SpecialChar \ldots{}
6813 \begin_inset Quotes erd
6816 button and, in the window that opens, enter
6817 \begin_inset Quotes eld
6821 \begin_inset Quotes erd
6824 (or any other name you like) in the
6825 \begin_inset Quotes eld
6829 \begin_inset Quotes erd
6833 Now click on the button labeled
6834 \begin_inset Quotes eld
6837 \SpecialChar \ldots{}
6839 \begin_inset Quotes erd
6842 to open a file dialog and navigate to the directory containing the
6843 \begin_inset Flex Code
6846 \begin_layout Plain Layout
6852 program (which is installed by default on Cygwin along with the LyX executable).
6854 \begin_inset Flex Code
6857 \begin_layout Plain Layout
6863 and then specify the program arguments as
6864 \begin_inset Flex Code
6867 \begin_layout Plain Layout
6874 In this way, you will be using the
6878 for communicating with LyX.
6879 If, for whatever reason, you want to use the
6884 \begin_inset Flex Code
6887 \begin_layout Plain Layout
6893 option and be sure to specify the LyXServer pipe path in the LyX preferences.
6896 \begin_layout Standard
6897 In yap, reverse search is triggered by double-click.
6900 \begin_layout Subsubsection*
6904 \begin_layout Standard
6905 In order to use SumatraPDF for inverse search, enter
6906 \begin_inset Flex Code
6909 \begin_layout Plain Layout
6910 SumatraPDF -inverse-search "lyxeditor -g %f %l"
6915 in the viewer setting in
6916 \begin_inset Flex MenuItem
6919 \begin_layout Plain Layout
6920 Preferences\SpecialChar \menuseparator
6921 File Handling\SpecialChar \menuseparator
6922 File formats\SpecialChar \menuseparator
6929 If SumatraPDF.exe is not in your command PATH, use its full posix path.
6931 \begin_inset Flex Code
6934 \begin_layout Plain Layout
6940 enables communication via the
6946 \begin_inset Flex Code
6949 \begin_layout Plain Layout
6955 option if you want to use the
6959 , and be sure to specify the LyXServer pipe path in the LyX preferences.
6962 \begin_layout Standard
6963 Reverse search is triggered by double-click.
6966 \begin_layout Section
6970 \begin_layout Standard
6971 Forward search is, as the name implies, in a sense the
6972 \begin_inset Quotes eld
6976 \begin_inset Quotes erd
6980 It allows you to let the viewer jump to a given position from within LyX.
6981 If forward search is set up (as described in what follows), you can put
6982 the cursor anywhere in your LyX document, and hit
6983 \begin_inset Flex MenuItem
6986 \begin_layout Plain Layout
6987 Navigate\SpecialChar \menuseparator
6994 \begin_inset Flex MenuItem
6997 \begin_layout Plain Layout
7003 in the context menu via right mouse click), and then the viewer will jump
7004 to that position as well.
7005 This implies, of course, that your viewer supports this function.
7008 \begin_layout Standard
7009 To make forward search possible, you first need to provide the generated
7010 output PDF/DVI file with additional information about the TeX sources.
7011 This can be done via the methods described in the section
7012 \begin_inset CommandInset ref
7014 reference "sub:rev-search"
7021 \begin_layout Standard
7022 Additionally, you need to configure LyX for using your viewers in
7023 \begin_inset Flex MenuItem
7026 \begin_layout Plain Layout
7027 Tools\SpecialChar \menuseparator
7028 Preferences\SpecialChar \menuseparator
7029 Output\SpecialChar \menuseparator
7036 We provide a range of tested configurations for some viewers, which you
7037 can select from the drop down list.
7038 If none of these configurations suits you, you have to find out and enter
7039 a suitable configuration yourself.
7040 The definition syntax uses the following placeholders:
7043 \begin_layout Itemize
7045 \begin_inset Flex Code
7048 \begin_layout Plain Layout
7057 \begin_layout Itemize
7059 \begin_inset Flex Code
7062 \begin_layout Plain Layout
7068 : name of the (temporary) exported .tex file (without path)
7071 \begin_layout Itemize
7073 \begin_inset Flex Code
7076 \begin_layout Plain Layout
7082 : name of the (temporary) exported .tex file (including path)
7085 \begin_layout Itemize
7087 \begin_inset Flex Code
7090 \begin_layout Plain Layout
7096 : name of the exported output file (either dvi or pdf, depending on which
7097 one exists in the temporary directory)
7100 \begin_layout Standard
7101 Note that only some of the viewers provide full forward search functionality,
7102 among them yap, xdvi, okular and Sumatra PDF.
7106 \begin_layout Plain Layout
7107 For Sumatra CMCDDE is needed --- downloadable from
7108 \begin_inset CommandInset href
7110 target "http://www.istri.fr/zip/CMCDDE.zip"
7119 While many of the widespread PDF viewers (most notably Adobe Reader) do
7120 not support forward search at all, some other viewers -- e.
7121 \begin_inset space \thinspace{}
7125 evince and xpdf -- allow at least to reload the document and jump to a
7126 specific page of the file, so you can at least navigate
7127 \begin_inset Quotes eld
7131 \begin_inset Quotes erd
7135 This latter functionality is provided by an external call of synctex (see
7136 the predefined example configurations).
7140 \begin_layout Standard
7141 Forward search works both with DVI and PDF output.
7142 LyX simply checks which preview format you have used before (i.
7143 \begin_inset space \thinspace{}
7146 e., which format is already there in the temporary directory) and chooses
7147 the appropriate configuration for the respective format.
7150 \begin_layout Chapter
7151 Special Document Classes
7154 \begin_layout Section
7158 \begin_layout Standard
7164 \begin_layout Subsection
7168 \begin_layout Standard
7169 This section describes how LyX can be used to write articles for submission
7170 to the scientific journal
7172 Astronomy and Astrophysics
7174 (www.edpsciences.fr/aa/
7175 \begin_inset Flex URL
7178 \begin_layout Plain Layout
7180 http://www.edpsciences.fr/aa/
7185 ) using Version 5.01 of the document class
7190 This package can be downloaded from the ftp site
7193 \begin_layout Standard
7194 \begin_inset VSpace medskip
7200 \begin_layout Standard
7202 \begin_inset Flex URL
7205 \begin_layout Plain Layout
7207 ftp://ftp.edpsciences.org/pub/aa/readme.html
7215 \begin_layout Standard
7216 \begin_inset VSpace medskip
7222 \begin_layout Standard
7223 A manual comes together with that package, and this text is not meant to
7224 replace the original manual but is merely a short guide in how to realize
7225 the correct form of your paper.
7229 \begin_layout Standard
7230 Please note that the publisher of the journal was changed from Springer
7231 to EDP Sciences starting January 1, 2001.
7232 That change involved also some slight changes to the style files, namely
7233 the removal of the thesaurus command.
7234 The LyX class aa supports the newest version of these style files, V 5.01.
7235 If you have an older version installed, please upgrade.
7236 For compatibility, the old (version 4) layout has been kept as
7241 Please refer to the comments in
7243 LyXDir/layouts/aapaper.layout
7248 \begin_layout Subsection
7252 \begin_layout Standard
7253 It is recommended you start from the example template distributed with LyX.
7254 If you are not using a template, note the following settings:
7257 \begin_layout Itemize
7264 Document\SpecialChar \menuseparator
7267 dialog (OK, that one was obvious).
7270 \begin_layout Itemize
7271 Don't change the option
7274 \begin_inset space ~
7284 The whole layout is done by the macros, you shouldn't change anything.
7287 \begin_layout Subsection
7291 \begin_layout Standard
7292 First thing to enter is the header information.
7293 It consists of seven entries, of which some are optional.
7297 \begin_layout Itemize
7305 \begin_layout Itemize
7313 \begin_layout Itemize
7321 \begin_layout Itemize
7329 \begin_layout Itemize
7334 : [optional] if more than one author: whom to contact for offprint requests.
7337 \begin_layout Itemize
7342 : [optional] mail address for contacts.
7345 \begin_layout Itemize
7353 Received: <date>; Accepted <date>
7356 \begin_layout Standard
7357 There is no need to issue the
7363 command, this is done automatically by LyX when the header is finished.
7364 Although the order of the single header entries doesn't matter it is advised
7365 to keep the above sequence, just to get the best optics and meets the layout
7366 of the real document.
7369 \begin_layout Standard
7370 If you want to place footnotes in the header block, e.
7371 \begin_inset space \thinspace{}
7375 \begin_inset space \space{}
7378 to state your present address, just use the standard footnote via the menu
7381 Insert\SpecialChar \menuseparator
7385 LyX will automagically use the term
7394 \begin_layout Standard
7395 In addition to these topics, the macros use three additional LaTeX commands
7396 that have no counterpart in LyX:
7399 \begin_layout Itemize
7406 to separate different names for more than one author and institute, respectivel
7410 \begin_layout Itemize
7417 to mark corresponding author/institute pairs.
7418 The institutes are numbered sequentially as they appear in the
7422 field, so you have to put a marker to each author.
7425 \begin_layout Itemize
7432 to supply an email address for fast contact.
7435 \begin_layout Standard
7436 In all cases, the appropriate command has to be entered in LyX and marked
7442 \begin_layout Subsection
7446 \begin_layout Standard
7447 The abstract should immediately follow the header block.
7448 With version 5 the abstract environment was changed to a command, and there
7449 is now a resctriction to only one paragraph.
7450 In addition, it should contain an entry with the keywords.
7451 This is not yet implemented for LyX, therefore you have to enter the LaTeX
7458 by hand and mark it as LaTeX code.
7459 Refer to the example paper.
7462 \begin_layout Subsection
7463 Supported environments
7466 \begin_layout Standard
7467 The A&A paper layout supports the following environments for structuring
7471 \begin_layout Itemize
7477 \begin_layout Itemize
7483 \begin_layout Itemize
7489 \begin_layout Itemize
7495 \begin_layout Itemize
7501 \begin_layout Itemize
7507 \begin_layout Itemize
7513 \begin_layout Itemize
7519 \begin_layout Itemize
7525 \begin_layout Itemize
7531 \begin_layout Itemize
7537 \begin_layout Itemize
7543 \begin_layout Subsection
7544 Commands not supported by LyX
7547 \begin_layout Standard
7548 Some commands are not yet supported by the
7553 Some have already been mentioned.
7554 For the sake of completeness, they are listed all together here:
7557 \begin_layout Itemize
7565 \begin_layout Itemize
7573 \begin_layout Itemize
7581 \begin_layout Itemize
7589 \begin_layout Itemize
7597 \begin_layout Itemize
7605 \begin_layout Itemize
7613 \begin_layout Itemize
7621 \begin_layout Standard
7622 If you want to use any of these commands, you have to enter them yourself.
7625 Do not forget to mark them as LaTeX code!
7628 \begin_layout Subsection
7629 Figure and Table Floats
7632 \begin_layout Standard
7633 LyX provides support for the necessary float environments
7635 figure, figure*, table
7641 , therefore we won't tell much about it here.
7645 \begin_inset space ~
7651 Just remember that tables should be left-aligned.
7652 For that, select the table and change the alignment in
7654 Edit\SpecialChar \menuseparator
7656 \begin_inset space ~
7662 \begin_layout Standard
7663 There is only one special thing: the figures with caption besides the figure.
7664 To create such a figure, you have to do the following:
7667 \begin_layout Enumerate
7668 Create a wide figure float:
7670 Insert\SpecialChar \menuseparator
7671 Float\SpecialChar \menuseparator
7674 , then right click in the figure and select
7680 \begin_inset space ~
7688 \begin_layout Enumerate
7689 Enter your caption text.
7692 \begin_layout Enumerate
7697 to move the cursor above the caption.
7700 \begin_layout Enumerate
7704 \begin_layout Enumerate
7705 Position the cursor behind the figure and insert a horizontal fill:
7707 Insert\SpecialChar \menuseparator
7709 \begin_inset space ~
7712 Character\SpecialChar \menuseparator
7714 \begin_inset space ~
7722 \begin_layout Enumerate
7723 Switch to LaTeX mode:
7726 \begin_inset space ~
7734 \begin_layout Enumerate
7744 Do not close the brace!
7747 \begin_layout Enumerate
7748 Position the cursor behind the caption text, switch to LaTeX mode and insert
7752 \begin_inset space ~
7764 \begin_layout Standard
7765 Also, refer to the figures in the example paper.
7768 \begin_layout Subsection
7772 \begin_layout Standard
7773 For submission, the paper has to be formated in a special double-spacing
7775 For this purpose, you have to give the option
7779 to the documentclass.
7780 This must be done using the extra class options field in the
7782 Document\SpecialChar \menuseparator
7786 Just enter the string
7793 \begin_layout Subsection
7797 \begin_layout Standard
7802 directory contains an example paper written with LyX.
7803 It is the example paper from the original macro package, translated to
7805 Use it for inspiration, and compare the original LaTeX code with LyX way
7809 \begin_layout Section
7813 \begin_layout Standard
7819 \begin_layout Subsection
7823 \begin_layout Standard
7824 AASTeX is a set of macros produced by the American Astronomical Society
7825 to facilitate electronic manuscript submission to the three journals they
7826 publish: the Astrophysical Journal (including the Letters and Supplement),
7827 the Astronomical Journal, and the Publications of the Astronomical Society
7829 LyX has proven to be an excellent tool for generating these documents,
7830 especially given its equation, citation, and figure handling capabilities.
7831 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
7832 is the version described here, or higher.
7833 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
7834 incompatible with LyX.
7835 The AASTeX package may be downloaded from the AASTeX Web site
7838 \begin_layout Standard
7839 \begin_inset VSpace medskip
7845 \begin_layout Standard
7847 \begin_inset Flex URL
7850 \begin_layout Plain Layout
7852 http://www.journals.uchicago.edu/AAS/AASTeX
7860 \begin_layout Standard
7861 \begin_inset VSpace medskip
7867 \begin_layout Standard
7868 A complete user guide is contained in that package and you should familiarize
7869 yourself with it thoroughly before embarking on writing a paper in LyX.
7870 LyX will not reduce the need to figure out all the AASTeX commands, it
7871 will only reduce the drudgery of typing everything in.
7872 It is your responsibility to ensure that the final exported LaTeX document
7873 conforms completely to the requirements of the journal to which you are
7874 submitting your paper.
7877 \begin_layout Subsection
7878 Starting a New Paper
7881 \begin_layout Standard
7882 I strongly suggest that you start with the AASTeX template file.
7885 File\SpecialChar \menuseparator
7892 , enter the new file name, then choose the
7897 This will show the most common fields found in a manuscript.
7898 Simply overwrite the existing text (including the brackets,
7902 ) with the correct information.
7903 Many of the AASTeX commands and environments can be implemented directly
7904 in LyX, but some cannot: most noticeably
7916 , which should stick out like a sore thumb if you actually just opened the
7918 For commands such as these, the LaTeX code must be entered directly and
7920 Such commands are referred to as TeX code, or Evil Red Text.
7921 I tried to minimize the amount of TeX code needed in an AASTeX document,
7922 but there is still a bit more required than any of us would like.
7925 \begin_layout Subsection
7926 Finishing Your Paper
7929 \begin_layout Standard
7930 When the paper is finished to your satisfaction and previews/prints correctly,
7932 \begin_inset Quotes eld
7936 \begin_inset Quotes erd
7939 actions which need to be done before you submit it to the journals.
7943 \begin_layout Enumerate
7944 Export your paper as a LaTeX file (
7946 File\SpecialChar \menuseparator
7947 Export\SpecialChar \menuseparator
7954 \begin_layout Enumerate
7959 file with your favorite text editor
7963 \begin_layout Enumerate
7964 remove the comment lines before the
7973 \begin_layout Enumerate
7978 usepackage...{fontenc}
7980 line if it appears (usually just after
7995 \begin_layout Enumerate
7996 remove everything between (and including) the
8008 commands, except for any commands you specifically put into the LaTeX preamble
8009 (which should appear immediately after the
8010 \begin_inset Quotes eld
8013 User specified LaTeX commands
8014 \begin_inset Quotes erd
8025 \begin_layout Enumerate
8026 Run the resulting file through LaTeX to make sure it still processes correctly.
8029 \begin_layout Enumerate
8030 Reread the journal requirements to make sure your filenames and formats
8034 \begin_layout Enumerate
8038 \begin_layout Subsection
8039 Comments On Specific Commands
8042 \begin_layout Standard
8043 I will not describe the detailed usage of the individual AASTeX commands:
8044 the AASTeX User Guide (
8048 ) gives a good description of each.
8049 Thus it's probably easiest for me to go down the list as found in the guide
8050 and offer comments where necessary.
8051 So let's begin \SpecialChar \ldots{}
8055 \begin_layout Subsubsection
8056 Things that work as expected
8059 \begin_layout Standard
8060 Because they work as you might expect, I simply list them and the section
8161 begin{thebibliography}
8169 (2.13.2), all the cite commands and their variations (2.13.2), the generic
8170 graphicx figure commands (2.14.1),
8194 (2.15.4, amongst other places),
8221 \begin_layout Standard
8222 The following style options also work correctly:
8243 Simply put them in the
8249 Layout\SpecialChar \menuseparator
8255 \begin_layout Subsubsection
8256 Things that work, but require more comment
8259 \begin_layout Standard
8260 The following items work, but require a little more discussion:
8263 \begin_layout Itemize
8264 These items are reserved for use by the journal editors, but you can put
8265 them into the LaTeX preamble if you feel compelled to do so:
8298 \begin_layout Itemize
8299 These items may be placed in the LaTeX preamble, and are included as blanks
8300 in the template file:
8321 \begin_layout Itemize
8328 (2.3) – can only be used
8329 \begin_inset Quotes eld
8333 \begin_inset Quotes erd
8336 , not in the middle of a paragraph.
8337 Use TeX code if you need to embed it.
8340 \begin_layout Itemize
8347 (2.3) – will have extra {} after it.
8348 This should not cause an error.
8351 \begin_layout Itemize
8358 (2.6) – can only be used
8359 \begin_inset Quotes eld
8363 \begin_inset Quotes erd
8366 , not in the middle of a paragraph.
8367 Use TeX code if you need to embed it.
8370 \begin_layout Itemize
8377 (2.8) – can't insert a cross-reference tag, you must type the tag name by
8381 \begin_layout Itemize
8395 \begin_layout Itemize
8402 (2.9) – will have extra {} after it.
8403 This should not cause an error.
8406 \begin_layout Itemize
8413 (2.11) – will have extra {} after it.
8414 This should not cause an error.
8417 \begin_layout Itemize
8424 (2.14.2) – you can insert an optional filename argument by placing the cursor
8425 at the beginning of the text and selecting
8427 Insert\SpecialChar \menuseparator
8432 \begin_inset Quotes eld
8436 \begin_inset Quotes erd
8439 inserts an optional argument of the type needed by
8446 Hopefully it will be renamed someday.
8449 \begin_layout Itemize
8462 for the catalog ID optional parameter
8465 \begin_layout Itemize
8478 for the catalog ID optional parameter
8481 \begin_layout Subsubsection
8482 Things not implemented, use TeX code
8485 \begin_layout Standard
8508 setcounter{equation}
8510 (2.12), Journal name abbreviations (2.13.4),
8546 (2.15.4, insert it as the first element in the lefthand cell after where
8548 Don't use any of LyX's rules in the table),
8560 (2.15.5), much of Misc (2.17, except
8611 \begin_layout Subsubsection
8612 Things that cannot be implemented
8615 \begin_layout Standard
8616 \SpecialChar \ldots{}
8617 at least in any meaningful sort of way, so I suggest ignoring them.
8618 They are the references environment (2.13.3), and the deluxetable environment
8620 If you really, really need to use deluxetable, I suggest editing it in
8621 a separate file with a text editor, then using
8623 Insert\SpecialChar \menuseparator
8625 \begin_inset space ~
8630 to include it in your LyX document.
8635 file to see an example of this.
8638 \begin_layout Subsection
8639 FAQs, Tips, Tricks, and Other Ruminations
8642 \begin_layout Subsubsection
8643 Getting LyX and AASTeX to cooperate
8646 \begin_layout Standard
8647 It can be a bit tricky to get LyX to recognize a new layout and document
8649 When all else fails, do this:
8652 \begin_layout Enumerate
8653 Make certain that LaTeX can find AASTeX.
8654 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
8655 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
8662 \begin_layout Enumerate
8674 \begin_layout Enumerate
8677 Tools\SpecialChar \menuseparator
8680 in LyX, then restart LyX.
8683 \begin_layout Enumerate
8684 Open a regular new file, not from a template.
8685 Does AASTeX appear in the class list in
8687 Document\SpecialChar \menuseparator
8693 \begin_layout Standard
8694 If you get a warning from an existing AASTeX document about not being able
8695 to find the AASTeX layout or a message about
8696 \begin_inset Quotes eld
8699 You should not mix title layouts with normal ones
8700 \begin_inset Quotes erd
8703 , things haven't been installed correctly.
8706 \begin_layout Subsubsection
8707 LaTeX error processing a table
8710 \begin_layout Standard
8711 LyX, by default, attempts to center the table caption/title.
8712 This seems to produce a bad interaction in AASTeX so you should click somewhere
8713 in the caption/title, then select
8715 Edit\SpecialChar \menuseparator
8717 \begin_inset space ~
8731 This took care of it for me.
8734 \begin_layout Subsubsection
8738 \begin_layout Standard
8739 A couple of things: 1) I have noticed some funny spacing in the reference
8740 entries in the text.
8741 When you enter the bibliography item data, make sure their is
8745 space between the last author and the parenthesis setting off the year;
8749 \begin_inset space \thinspace{}
8753 \begin_inset space \space{}
8767 2) Entering the references at all is not obvious.
8768 The easiest thing is to start typing your first reference at the end of
8769 the document, then mark it as type
8774 That will put a small gray box in front of what you just typed.
8775 Click on the box to fill in the rest of the information.
8776 For new references, go to the end of an existing reference and press return.
8777 That will create a new line with its own box, etc.
8780 \begin_layout Subsubsection
8784 \begin_layout Standard
8785 Even though AASTeX provides its own figure commands (
8791 , for example), I much prefer LaTeX's standard figure commands (with the
8800 \begin_inset space ~
8803 commands as TeX code into a Figure Float box if you desire, but I never
8804 have much luck getting the layout right.
8805 With the standard graphics, LyX will insert a
8809 usepackage{graphicx}
8811 command into the LaTeX preamble and handle the figures in the standard
8812 LaTeX2e way, interspersing the figures in the text.
8813 I believe ApJ accepts figures exactly this way now; AJ might still use
8815 \begin_inset Quotes eld
8818 stack everything at the end
8819 \begin_inset Quotes erd
8825 \begin_layout Subsubsection
8826 Things I could have done, but didn't
8829 \begin_layout Standard
8831 \begin_inset Quotes eld
8835 \begin_inset Quotes erd
8838 things I could have implemented, but chose not to.
8839 For instance, I saw no point in double-spacing the text in the LyX window,
8840 even though it is double-spaced in the paper manuscript.
8841 Also, I chose not to make separate layouts for the preprint and preprint2
8843 Since I assume you will spend most of your time in the plain manuscript
8844 mode anyway, I decided not to chew up more disk space with this.
8848 \begin_layout Subsection
8852 \begin_layout Standard
8853 Your mileage may vary.
8854 I've now had papers published by both ApJ and AJ that have had 98% of the
8855 effort done in LyX; the last 2% was the LaTeX post-processing and a few
8857 I have had no trouble with the submission process, and I'm sure the journals
8858 were never aware that there might be a difference.
8859 So, go forth and publish!
8862 \begin_layout Section
8866 \begin_layout Standard
8876 \begin_layout Standard
8877 \begin_inset VSpace bigskip
8883 \begin_layout Standard
8885 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
8886 papers to be submitted to American Mathematical Society publications.
8887 The layouts are not tailored to a specific journal, but easily can be.
8888 You should refer to the AMS documentation for specific instructions for
8889 each journal (usually it will entail only changing a single line in the
8891 That documentation is available on the Web at
8892 \begin_inset Flex URL
8895 \begin_layout Plain Layout
8903 \begin_inset Flex URL
8906 \begin_layout Plain Layout
8908 ftp://ftp.ams.org/pub/tex/amslatex/
8914 These layouts are appropriate, and useful, for any mathematical writing.
8918 \begin_layout Standard
8919 There are two basic AMS LaTeX layouts:
8922 \begin_layout Itemize
8923 amsart: The standard AMS article format.
8926 \begin_layout Itemize
8927 amsbook: the standard AMS book (really, monograph) format.
8931 \begin_layout Standard
8932 The layouts themselves contain only the minimum necessary to use the AMS
8934 They do not, in particular, contain any of the `theorem' environments used
8935 for setting theorems, lemmas, and the like.
8936 These are contained, instead, in the
8937 \begin_inset Flex Code
8940 \begin_layout Plain Layout
8946 module, which is loaded by default when when you select one of the AMS
8948 (It can also be used with other classes and can be removed, if you would
8949 rather use something else.) Less commonly used environments are in the
8950 \begin_inset Flex Code
8953 \begin_layout Plain Layout
8954 Theorems (AMS-Extended)
8959 module, which must be loaded manually.
8962 \begin_layout Standard
8963 By default, theorems and the like are numbered consecutively throughout
8964 the document, but this may be modified by loading the module
8965 \begin_inset Flex Code
8968 \begin_layout Plain Layout
8969 Theorems (Order by Section)
8974 or, if you are using
8975 \begin_inset Flex Code
8978 \begin_layout Plain Layout
8985 \begin_inset Flex Code
8988 \begin_layout Plain Layout
8989 Theorems (Order by Chapter)
8995 These will number the results as
8996 \begin_inset Formula $n.m$
8999 , where the first number refers to the section (or chapter) and the second
9000 refers to the total number of results so far in that section (or chapter).
9001 Many environments are also available unnumbered.
9002 These are indicated by an asterisk at the end.
9003 If you happen to want
9007 unnumbered results, the module
9008 \begin_inset Flex Code
9011 \begin_layout Plain Layout
9017 provides that option.
9020 \begin_layout Standard
9021 Note that these modules do not
9025 to be used with the AMS classes.
9026 It is perfectly possible to use the
9027 \begin_inset Flex Code
9030 \begin_layout Plain Layout
9036 module, and the others mentioned, with other classes, such as
9037 \begin_inset Flex Code
9040 \begin_layout Plain Layout
9047 \begin_inset Flex Code
9050 \begin_layout Plain Layout
9057 \begin_inset Flex Code
9060 \begin_layout Plain Layout
9069 \begin_layout Subsection
9070 What these layouts provide
9073 \begin_layout Standard
9074 There is a long list of included environments provided by these layouts.
9075 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
9076 variety of `theorem' environments.
9077 However, the AMS recommends the environments that are available in LyX.
9081 \begin_layout Standard
9082 The following environments—as well as the standard environments, such as
9084 \begin_inset Flex Noun
9087 \begin_layout Plain Layout
9094 \begin_inset Flex Noun
9097 \begin_layout Plain Layout
9104 \begin_inset Flex Noun
9107 \begin_layout Plain Layout
9114 \begin_inset Flex Noun
9117 \begin_layout Plain Layout
9124 \begin_inset Flex Noun
9127 \begin_layout Plain Layout
9134 \begin_inset Flex Code
9137 \begin_layout Plain Layout
9144 \begin_inset Flex Code
9147 \begin_layout Plain Layout
9156 \begin_layout Description
9157 Address This should be the author's permanent address.
9160 \begin_layout Description
9162 \begin_inset space ~
9165 Address This should be the author's temporary address at the time of submission,
9166 if different from the Address.
9169 \begin_layout Description
9170 Email Author's e-mail address
9173 \begin_layout Description
9174 URL Author's Web address, if desired.
9177 \begin_layout Description
9178 Keywords Key words or phrases used to identify specific topics discussed
9182 \begin_layout Description
9183 Subjectclass These refer to the AMS Subject Classifications, published and
9186 Mathematical Reviews
9189 These are also available online at the AMS cites listed above.
9192 \begin_layout Description
9196 \begin_layout Description
9200 \begin_layout Description
9204 \begin_layout Standard
9205 The following environments are provided by both the
9206 \begin_inset Flex Code
9209 \begin_layout Plain Layout
9216 \begin_inset Flex Code
9219 \begin_layout Plain Layout
9225 modules, in the latter case in both starred (unnumbered) and unstarred
9226 (numbered) versions.
9227 These same environments are provided only in the starred versions by the
9229 \begin_inset Flex Code
9232 \begin_layout Plain Layout
9241 \begin_layout Theorem
9242 This is typically used for the statements of major results.
9246 \begin_layout Corollary*
9247 This is used for statements which follow fairly directly from previous statement
9249 Again, these can be major results.
9254 These are smaller results needed to prove other statements.
9257 \begin_layout Proposition
9258 These are less major results which (hopefully) add to the general theory
9262 \begin_layout Conjecture
9263 These are statements provided without justification, which the author does
9264 not know how to prove, but which seem to be true (to the author, at least).
9267 \begin_layout Definition*
9268 Guess what this is for.
9269 The font is different for this environment than for the previous ones.
9273 \begin_layout Example*
9274 Used for examples illustrating proven results.
9277 \begin_layout Problem
9278 It's not really known what this is for.
9279 You should figure it out.
9282 \begin_layout Exercise*
9283 Write a description for this one.
9286 \begin_layout Remark
9287 This environment is also a type of theorem, usually a lesser sort of observation.
9290 \begin_layout Claim*
9291 Often used in the course of giving a proof of a larger result.
9295 Generally, these are used to break up long arguments, using specific instances
9301 The numbering scheme for cases is on its own, not together with other numbered
9307 At the end of this environment, a QED symbol (usually a square, but it can
9308 vary with different styles) is placed.
9309 If you want to have other environments within this one—for example, Case
9310 environments—and have the QED symbol appear only after them, then the other
9311 environments need to be nested within the proof environment.
9314 Nesting Environments
9320 for information on nesting.
9323 \begin_layout Standard
9324 And these environments are provided by
9325 \begin_inset Flex Code
9328 \begin_layout Plain Layout
9329 Theorems (AMS-Extended)
9337 \begin_layout Criterion*
9338 A required condition.
9341 \begin_layout Algorithm*
9342 A general procedure to be used.
9345 \begin_layout Axiom*
9346 This is a property or statement taken as true within the system being discussed.
9349 \begin_layout Condition*
9350 Sometimes used to state a condition assumed within the present context of
9355 Similar to a Remark.
9358 \begin_layout Notation*
9359 Used for the explanation of, yes, notation.
9362 \begin_layout Summary
9363 Do we really need to tell you?
9366 \begin_layout Acknowledgement*
9370 \begin_layout Conclusion*
9371 Sometimes used at the end of a long train of argument.
9375 Used in a way similar to Proposition, though perhaps lower on the scale.
9378 \begin_layout Standard
9379 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
9381 They need to be available on your system in order to use these environments.
9384 \begin_layout Section
9392 \begin_layout Standard
9398 \begin_layout Subsection
9402 \begin_layout Standard
9403 These are the layout files for some of the journals of the American Geophysical
9405 It is assumed that you have both the AGU's own class files and AGUplus
9406 installed (everything to be found at
9407 \begin_inset Flex URL
9410 \begin_layout Plain Layout
9412 ftp://ftp.agu.org/journals/latex/journals
9420 \begin_layout Subsection
9424 \begin_layout Standard
9434 They are still called this in the LyX GUI, though their LaTeX equivalents
9435 in the AGU classes are
9446 \begin_layout Standard
9447 Newly defined styles are
9484 These are mostly manuscript attributes and defined in the AGU class documentati
9488 \begin_layout Standard
9489 I suspect this is still badly incomplete.
9492 \begin_layout Subsection
9496 \begin_layout Standard
9513 \begin_layout Subsection
9517 \begin_layout Itemize
9520 Journal of Geophysical Research
9529 \begin_layout Standard
9530 Add your own, it isn't so hard! Look at the
9541 \begin_layout Subsection
9542 Bugs and things to remember
9545 \begin_layout Standard
9546 In order to use the new layouts, you must remember to do the following for
9550 \begin_layout Enumerate
9556 This can be done in the
9558 Layout\SpecialChar \menuseparator
9563 Document\SpecialChar \menuseparator
9567 (AGU articles are always in English, right? So
9574 \begin_layout Enumerate
9584 (Yes, this is a bug.)
9587 \begin_layout Enumerate
9588 Make sure you use the
9592 bibliography style, by entering
9596 into the second field of the BibTeX inset.
9597 None of the standard styles will do.
9600 \begin_layout Section
9604 \begin_layout Standard
9610 \begin_layout Subsection
9614 \begin_layout Standard
9615 Broadway is for writing plays.
9616 The format is more decorative than Hollywood, and much less standardized.
9617 This format should be suitable for workshops.
9620 \begin_layout Subsection
9624 \begin_layout Standard
9625 The same as in Hollywood.
9628 \begin_layout Subsection
9632 \begin_layout Standard
9637 names as labels then cross-reference the label to insert the name.
9638 The cross-reference dialog will show the current cast of characters.
9641 \begin_layout Subsection
9642 Paper size and Margins
9645 \begin_layout Standard
9646 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
9649 \begin_layout Subsection
9653 \begin_layout Standard
9654 The following environments are available.
9655 You can use broadway.bind to get the bind keys shown at the right.
9658 \begin_layout Itemize
9662 \begin_inset Newline newline
9667 You should not have to use this, but it is here for anything that does not
9671 \begin_layout Itemize
9675 \begin_inset space \hfill{}
9679 \begin_inset Newline newline
9684 Used to describe stage setting and the action.
9685 First use of speaker names in all CAPs.
9688 \begin_layout Itemize
9692 \begin_inset space \hfill{}
9696 \begin_inset Newline newline
9701 Automatically numbered.
9702 On screen it will be arabic, but will print as Roman.
9705 \begin_layout Itemize
9709 \begin_inset space \hfill{}
9713 \begin_inset Newline newline
9723 It is just centered text.
9726 \begin_layout Itemize
9730 \begin_inset space \hfill{}
9734 \begin_inset Newline newline
9739 Not automatically numbered.
9740 You supply the number.
9741 This is because I couldn't figure out how.
9744 \begin_layout Itemize
9748 \begin_inset space \hfill{}
9752 \begin_inset Newline newline
9757 A special case of Narrative to describe the setting and action as the curtain
9761 \begin_layout Itemize
9765 \begin_inset space \hfill{}
9769 \begin_inset Newline newline
9774 The speaker's (actor's) title, centered in all CAPS.
9777 \begin_layout Itemize
9781 \begin_inset space \hfill{}
9785 \begin_inset Newline newline
9790 Instructions to the speaker.
9791 The parentheses are automatically inserted.
9792 The ( will appear on screen, but both will be in the printed play.
9793 This environment is only used within
9800 \begin_layout Itemize
9804 \begin_inset space \hfill{}
9808 \begin_inset Newline newline
9813 What the Speaker says.
9816 \begin_layout Itemize
9820 \begin_inset space \hfill{}
9824 \begin_inset Newline newline
9829 The curtain comes down.
9832 \begin_layout Itemize
9836 \begin_inset space \hfill{}
9842 \begin_layout Itemize
9846 \begin_inset space \hfill{}
9852 \begin_layout Itemize
9856 \begin_inset space \hfill{}
9862 \begin_layout Standard
9866 \begin_layout Section
9870 \begin_layout Standard
9875 can be used to type letters according to German conventions.
9876 A template file is included in
9878 .../lyx/share/templates
9880 for you to use as a starting point.
9883 \begin_layout Section
9891 \begin_layout Standard
9897 \begin_layout Subsection
9901 \begin_layout Standard
9902 This is the layout file for the European Geophysical Society journals.
9907 can be downloaded from the web site of the EGS under
9908 \begin_inset Flex URL
9911 \begin_layout Plain Layout
9921 \begin_layout Subsection
9925 \begin_layout Standard
9928 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9936 The current layout file is unfortunately very unmodular and would benefit
9937 from using the various
9944 \begin_layout Section
9948 \begin_layout Standard
9949 See the LyX template file
9954 It contains all infos you need.
9957 \begin_layout Section
9963 \begin_inset CommandInset label
9972 \begin_layout Standard
9978 \begin_layout Subsection
9982 \begin_layout Standard
9983 This section describes how to use LyX to make slides for overhead projectors.
9984 There are two document classes that can do this: the default slides class
9990 This section documents the latter.
9993 \begin_layout Standard
9994 I'm going to say this again, nice and clear, so that there's no misunderstanding
9998 \begin_layout Standard
9999 \begin_inset VSpace bigskip
10005 \begin_layout Standard
10009 This section documents the class
10010 \begin_inset Quotes eld
10018 \begin_inset Quotes erd
10026 \begin_layout Standard
10027 \begin_inset VSpace bigskip
10033 \begin_layout Standard
10034 If you're looking for the documentation for
10035 \begin_inset Quotes eld
10043 \begin_inset Quotes erd
10046 , check out section
10047 \begin_inset space ~
10051 \begin_inset CommandInset ref
10053 reference "sec:slitex"
10058 If your machine doesn't have the
10063 \begin_inset Quotes eld
10071 \begin_inset Quotes erd
10074 ] installed, you'll probably have to use the default
10078 class, which isn't quite as good as
10083 \begin_layout Standard
10088 class is designed for use with version 2.1 of the
10092 LaTeX class file which is now an integral part of LaTeX2e.
10095 \begin_layout Subsection
10099 \begin_layout Standard
10100 Obviously, to use this document class, you need to select
10101 \begin_inset Quotes eld
10109 \begin_inset Quotes erd
10119 \begin_inset space ~
10125 There are some settings in the
10128 \begin_inset space ~
10133 dialog that you should know about that are specific to this class:
10136 \begin_layout Itemize
10137 Don't change the options
10148 \begin_inset space ~
10154 They're ignored by the
10161 \begin_layout Itemize
10162 The default font size is 20
10163 \begin_inset space \thinspace{}
10166 pt with the other options being 17
10167 \begin_inset space \thinspace{}
10171 \begin_inset space \thinspace{}
10175 \begin_inset space \thinspace{}
10181 \begin_layout Itemize
10182 The default font is
10190 but all math equations are still typeset in the usual roman font.
10193 \begin_layout Itemize
10198 supports A4 and Letter paper sizes as well as a special size for working
10200 \begin_inset space \thinspace{}
10204 It doesn't support A5, B5, legal or executive paper sizes.
10207 \begin_layout Itemize
10208 Don't bother changing the
10212 settings because they are ignored anyway.
10213 All floats appear where they are defined in the text.
10216 \begin_layout Itemize
10221 setting behaves a bit differently for this class.
10226 provides extensive footer and header capabilities including a user-defined
10229 \begin_inset space ~
10233 \begin_inset CommandInset ref
10235 reference "sec:foilfoot"
10240 The title page is treated differently to all other pages in the document
10249 has the logo centered at the bottom of the page (if one is defined).
10250 The possible page style choices and what they do are as follows:
10254 \begin_layout Labeling
10255 \labelwidthstring MMMMMMM
10262 The final output contains no page numbers, or other headers or footers
10263 (except footnotes of course).
10267 \begin_layout Labeling
10268 \labelwidthstring MMMMMMM
10275 The final output contains page numbers centered at the bottom of the page.
10276 No other headings or footers (other than footnotes).
10279 \begin_layout Labeling
10280 \labelwidthstring MMMMMMM
10285 Page numbers in lower right corner.
10286 Additional headers and footers are also shown.
10287 This is also the default.
10290 \begin_layout Labeling
10291 \labelwidthstring MMMMMMM
10296 Gives you access to the
10300 package although its use with
10304 is discouraged by the writer of the
10308 package because of some potential page layout clashes.
10312 \begin_layout Subsubsection
10316 \begin_layout Standard
10317 The following options may be used in the extra class options in the
10319 Document\SpecialChar \menuseparator
10325 \begin_layout Labeling
10326 \labelwidthstring MMMMMMx
10331 This sets up the page layout for 7.33
10332 \begin_inset space \thinspace{}
10336 \begin_inset space \thinspace{}
10339 in paper, which is about the same aspect ratio as a 35
10340 \begin_inset space \thinspace{}
10343 mm slide, making it a bit easier to work with this medium.
10346 \begin_layout Labeling
10347 \labelwidthstring MMMMMMx
10352 Places a rule across the page below the header on every page except the
10356 \begin_layout Labeling
10357 \labelwidthstring MMMMMMx
10362 Places a rule across the page above the footer on every page except the
10366 \begin_layout Labeling
10367 \labelwidthstring MMMMMMx
10372 This is automatically set each time you create a new
10381 to use the dvips driver to rotate those pages that are set as landscape
10385 \begin_layout Labeling
10386 \labelwidthstring MMMMMMx
10391 Simply changes the page dimensions to those of a landscape page but doesn't
10393 Thus if you use this option you need to use an external program to rotate
10394 each page or feed your paper through your printer as landscape.
10395 Note that this option effectively reverses the roles of the
10403 environments (don't worry these are described in the next section).
10406 \begin_layout Labeling
10407 \labelwidthstring MMMMMMx
10412 Equation numbers on the left.
10415 \begin_layout Labeling
10416 \labelwidthstring MMMMMMx
10421 Flush-left equations.
10424 \begin_layout Subsection
10425 Supported Environments
10428 \begin_layout Standard
10429 Most of the environments commonly supported in other classes are also supported
10435 There are several additional environments provided by
10439 as well as a couple added by LyX.
10440 The following environments are shared with other classes:
10443 \begin_layout Standard
10447 \begin_layout Plain Layout
10451 begin{multicols}{2}
10459 \begin_layout Itemize
10465 \begin_layout Itemize
10471 \begin_layout Itemize
10477 \begin_layout Itemize
10483 \begin_layout Itemize
10489 \begin_layout Itemize
10495 \begin_layout Itemize
10501 \begin_layout Itemize
10507 \begin_layout Itemize
10513 \begin_layout Itemize
10519 \begin_layout Itemize
10525 \begin_layout Itemize
10531 \begin_layout Itemize
10537 \begin_layout Itemize
10543 \begin_layout Itemize
10549 \begin_layout Itemize
10555 \begin_layout Itemize
10561 \begin_layout Itemize
10567 \begin_layout Standard
10571 \begin_layout Plain Layout
10583 \begin_layout Standard
10584 That is, all the major environments apart from the sectioning environments.
10585 Since foils are essentially self-contained sections, with a title and body,
10590 provides specific commands for starting new foils and these are:
10593 \begin_layout Itemize
10599 \begin_layout Itemize
10605 \begin_layout Standard
10606 LyX also provides slightly modified versions of these two environments called:
10609 \begin_layout Itemize
10615 \begin_layout Itemize
10618 ShortRotatefoilhead
10621 \begin_layout Standard
10622 and the differences will be explained in the next section.
10625 \begin_layout Standard
10626 Since foils are often used in presenting ideas or new theorems and such
10631 also provides a comprehensive box of goodies for presenting them:
10634 \begin_layout Standard
10638 \begin_layout Plain Layout
10642 begin{multicols}{2}
10650 \begin_layout Itemize
10656 \begin_layout Itemize
10662 \begin_layout Itemize
10668 \begin_layout Itemize
10674 \begin_layout Itemize
10680 \begin_layout Itemize
10686 \begin_layout Itemize
10692 \begin_layout Itemize
10698 \begin_layout Itemize
10704 \begin_layout Itemize
10710 \begin_layout Itemize
10716 \begin_layout Standard
10720 \begin_layout Plain Layout
10732 \begin_layout Standard
10733 The starred versions are unnumbered while the unstarred versions are numbered.
10734 There are also two list environments added by LyX and these are:
10737 \begin_layout Itemize
10743 \begin_layout Itemize
10749 \begin_layout Standard
10754 provides some powerful header and footer capabilities that are best set
10755 in the preamble although they may be set at any point in a document.
10756 If you want to change these settings in your document the best place to
10757 do so is at the very top of a foil, i.
10758 \begin_inset space \thinspace{}
10764 \begin_inset space \space{}
10769 straight after the foilhead.
10772 \begin_layout Standard
10773 For this purpose, the following command styles are provided [
10780 \begin_layout Standard
10784 \begin_layout Plain Layout
10788 begin{multicols}{2}
10796 \begin_layout Itemize
10800 \begin_inset space ~
10806 \begin_layout Itemize
10812 \begin_layout Itemize
10816 \begin_inset space ~
10822 \begin_layout Itemize
10826 \begin_inset space ~
10832 \begin_layout Itemize
10836 \begin_inset space ~
10843 \begin_layout Standard
10844 \begin_inset space ~
10851 \begin_layout Standard
10855 \begin_layout Plain Layout
10867 \begin_layout Standard
10868 There are also a few commands provided by
10872 that aren't directly supported by LyX but I'll tell you what they do and
10873 how to use them in section
10874 \begin_inset space ~
10878 \begin_inset CommandInset ref
10880 reference "sec:unsuppfoils"
10887 \begin_layout Subsection
10888 Building a Set of Foils
10891 \begin_layout Standard
10892 This section will give a simple introduction to using the different environments
10893 to build a set of foils.
10894 If you want to see an example set of foils, take a look at the
10898 file you find in LyX's
10905 \begin_layout Subsubsection
10906 Give It a Title Page
10909 \begin_layout Standard
10910 Unlike other classes that provide
10930 creates the title on a page of its own.
10931 If you leave out the
10935 environment LaTeX will substitute the current date (every time you regenerate
10939 \begin_layout Subsubsection
10943 \begin_layout Standard
10944 As I mentioned earlier, there are four ways of starting a new foil.
10945 For portrait foils you should use
10954 The difference between these two environments is the amount of space between
10955 the title of the foil (the foilhead) and the body of the foil.
10958 \begin_layout Standard
10959 Landscape foils are generated using the
10965 ShortRotatefoilhead
10968 Again the only difference is the spacing between foilhead and body.
10969 Both of the short versions have 0.5 inches less separation between the foilhead
10974 \begin_layout Standard
10975 One problem with the support for landscape foils is the requirement that
10976 you have to use the
10980 driver to generate the PostScript output otherwise the foils won't be rotated.
10981 It is possible to get landscape foils even if you haven't got the
10985 driver provided you can feed your foils sideways through your printer ;-)
10988 \begin_layout Subsubsection
10989 Theorems, Lemmas, Proofs and more
10992 \begin_layout Standard
10993 Due to a small bug in LyX you can't have two of the same type of these environme
10994 nts directly following each other.
10995 They must be separated by something.
10996 If you try, you will just be extending the previous environment as if you
10997 had merged the two environments together.
10998 So, how do you get around this problem? The simplest option is to insert
10999 some text between the two environments or add a
11003 environment between the two with just a
11004 \begin_inset Quotes eld
11012 \begin_inset Quotes erd
11016 This will force LyX to produce two separate environments and hence the
11017 correct LaTeX output.
11018 An example is provided in the example file included with the LyX distribution.
11019 Remember, this problem only occurs if you are trying to place two of the
11020 same type of theorem-like environments one directly after the other.
11023 \begin_layout Subsubsection
11027 \begin_layout Standard
11028 You get all the commonly supported list styles found in other classes as
11029 well as two new ones.
11030 I'll only describe the new ones here.
11031 If you want to find out more about the other list environments check out
11037 If you intend to use itemized lists you might also want to read about the
11041 \begin_inset space ~
11045 \begin_inset space ~
11050 dialog described above in section
11051 \begin_inset space ~
11055 \begin_inset CommandInset ref
11057 reference "sec:bullet"
11064 \begin_layout Standard
11065 The two new list styles,
11073 , are designed to make it easier for you to create lists of do's and don'ts
11074 or right and wrong by providing dedicated environments that use a tick
11075 or a cross as the label of the list.
11076 These lists are in fact dedicated variants of the
11081 They do however require that you have the
11085 packages installed.
11088 \begin_layout Subsubsection
11092 \begin_layout Standard
11097 redefines the floating tables and figures so that they appear exactly where
11098 they are in the text rather than pushing them to the top of the page or
11099 to some user specified location.
11100 In fact if you change the float placement settings they are simply ignored.
11103 \begin_layout Subsubsection
11104 Page Headers and Footers
11105 \begin_inset CommandInset label
11107 name "sec:foilfoot"
11114 \begin_layout Standard
11118 \begin_inset space ~
11127 are two commands used to control the left-footer text string.
11128 The first is meant to allow you to include a graphic logo on your foils
11130 \begin_inset Quotes eld
11138 \begin_inset Quotes erd
11142 While the second is meant to provide a classification for the audience,
11146 \begin_inset space \thinspace{}
11152 \begin_inset space \space{}
11156 It is empty by default.
11159 \begin_layout Standard
11160 The remaining page corners can be filled by
11163 \begin_inset space ~
11168 (which defaults to page numbers),
11171 \begin_inset space ~
11179 \begin_inset space ~
11187 \begin_layout Subsection
11193 \begin_inset CommandInset label
11195 name "sec:unsuppfoils"
11202 \begin_layout Standard
11203 All the commands mentioned below need to be set in a
11211 within another environment.
11214 \begin_layout Subsubsection
11218 \begin_layout Standard
11219 All lengths are adjusted using the
11242 should be replaced by the name given to the length you want to change and
11247 is the length value.
11248 All lengths should be specified in units of length such as inches (
11260 ) or relative to some document or font-based length such as
11270 \begin_layout Standard
11271 It's possible to change the spacing between a foilhead and the body of the
11272 foil by adjusting the length specified by
11279 For example, to make
11284 \begin_inset space \space{}
11287 in closer to their bodies put the following in the preamble:
11293 foilheadskip}{-0.5in}
11296 \begin_layout Standard
11297 The spacings around floats can be adjusted by setting these lengths:
11300 \begin_layout Labeling
11301 \labelwidthstring MMMMMMMMMMM
11308 Separation between the text and the top of the float
11311 \begin_layout Labeling
11312 \labelwidthstring MMMMMMMMMMM
11319 Separation between the float and the caption
11322 \begin_layout Labeling
11323 \labelwidthstring MMMMMMMMMMM
11330 Separation between the caption and the following text
11333 \begin_layout Labeling
11334 \labelwidthstring MMMMMMMMMMM
11341 You can make the captions narrower than the surrounding text by adjusting
11343 Best done relative to
11352 \begin_layout Standard
11353 There are also several title page related lengths that you may find useful
11354 if you have a long title or several authors:
11357 \begin_layout Labeling
11358 \labelwidthstring MMMMMMMMMMM
11365 Separation from headers to
11370 \begin_layout Labeling
11371 \labelwidthstring MMMMMMMMMMM
11389 \begin_layout Labeling
11390 \labelwidthstring MMMMMMMMMMM
11404 \begin_layout Labeling
11405 \labelwidthstring MMMMMMMMMMM
11421 \begin_layout Labeling
11422 \labelwidthstring MMMMMMMMMMM
11438 \begin_layout Standard
11439 The last length related command affects all the list environments.
11450 a list environment then all the vertical spacing between the list items
11452 Note that this is a command not a length so it doesn't require
11458 like the stuff mentioned above.
11461 \begin_layout Subsubsection
11462 Headers and Footers
11465 \begin_layout Standard
11478 commands control whether the logo in the
11482 definition appear on a given page.
11489 in the preamble then none of the foils will have the logo on them.
11490 If you don't want the logo on a particular page place the
11496 directly after the foilhead of that page and the
11502 directly after the next foilhead.
11505 \begin_layout Standard
11506 If you decide to use the
11510 page style setting in the
11513 \begin_inset space ~
11518 dialog you should probably add
11528 to your preamble so headers and footers on landscape pages are correctly
11529 placed when rotated.
11530 This is due to some clashes between the page layouts provided by the
11541 \begin_layout Section
11542 Hollywood (Hollywood spec scripts)
11545 \begin_layout Standard
11551 \begin_layout Subsection
11555 \begin_layout Standard
11556 Getting the format of a Hollywood script right is a
11557 \begin_inset Quotes eld
11561 \begin_inset Quotes erd
11564 It is designed to make the readers focus on content and to be easy and
11565 familiar for the actors to read.
11566 Each page of a script should be one minute of film.
11567 Nothing goes in a script that you cannot see or hear on screen.
11568 The courier 12 pt font should be used throughout.
11572 \begin_layout Subsection
11576 \begin_layout Standard
11577 Speakers' lines should NEVER break in mid-sentence.
11578 If a speaker's lines continue over a page break, repeat the
11582 title followed by (Cont'd).
11585 \begin_layout Subsection
11589 \begin_layout Standard
11594 names as labels then cross-reference the label to insert the name.
11595 The cross-reference dialog will show the current cast of characters.
11596 You can use this to insert the speaker name in narratives also.
11599 \begin_layout Subsection
11600 Paper size and Margins
11603 \begin_layout Standard
11604 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
11607 \begin_layout Subsection
11611 \begin_layout Standard
11612 The following environments are available.
11613 You can use hollywood.bind to get the bind keys shown at the right.
11616 \begin_layout Itemize
11620 \begin_inset Newline newline
11625 Used where nothing else works.
11629 \begin_layout Itemize
11635 \begin_inset space \hfill{}
11643 \begin_inset Newline newline
11646 Usually followed by something like
11647 \begin_inset Quotes eld
11650 on Sally waking up.
11651 \begin_inset Quotes erd
11657 \begin_layout Itemize
11661 \begin_inset space \hfill{}
11665 \begin_inset Newline newline
11670 Introduces a new INTERIOR camera set-up.
11671 Always followed by DAY or NIGHT, or something similar to define the lighting
11673 Everthing on this line in CAPS.
11676 \begin_layout Itemize
11680 \begin_inset space \hfill{}
11684 \begin_inset Newline newline
11689 Introduces a new EXTERIOR camera set-up.
11690 Everthing on this line in CAPS.
11693 \begin_layout Itemize
11697 \begin_inset space \hfill{}
11701 \begin_inset Newline newline
11706 The character speaking.
11709 \begin_layout Itemize
11713 \begin_inset space \hfill{}
11717 \begin_inset Newline newline
11722 Instructions to the speaker.
11723 The () are automatically inserted, but only the ( will show in LyX.
11724 Both will be printed.
11727 \begin_layout Itemize
11731 \begin_inset space \hfill{}
11735 \begin_inset Newline newline
11747 \begin_layout Itemize
11751 \begin_inset space \hfill{}
11755 \begin_inset Newline newline
11760 Camera movement instruction.
11762 \begin_inset space \thinspace{}
11766 \begin_inset space \space{}
11772 \begin_layout Itemize
11776 \begin_inset space \hfill{}
11782 \begin_layout Itemize
11786 \begin_inset space \hfill{}
11792 \begin_layout Itemize
11796 \begin_inset space \hfill{}
11802 \begin_layout Itemize
11806 \begin_inset space \hfill{}
11812 \begin_layout Subsection
11816 \begin_layout Itemize
11820 \begin_layout Itemize
11824 \begin_layout Itemize
11826 \begin_inset space \thinspace{}
11833 \begin_layout Itemize
11838 \begin_layout Itemize
11839 PAN — camera movement
11842 \begin_layout Itemize
11843 INSERT — cut to close-up of
11846 \begin_layout Section
11850 \begin_layout Standard
11853 Panayotis Papasotiriou
11856 \begin_layout Subsection
11860 \begin_layout Standard
11861 The ijmpc package is a set of macros that facilitates electronic manuscript
11864 International Journal of Modern Physics C
11867 Similarly, the ijmpd package is for creating manuscripts to be submitted
11870 International Journal of Modern Physics D
11873 Both journals are published by World Scientific.
11874 The corresponding document classes are named
11883 These files, together with instructions for the authors, can be downloaded
11885 \begin_inset Flex URL
11888 \begin_layout Plain Layout
11890 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
11896 \begin_inset Flex URL
11899 \begin_layout Plain Layout
11901 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
11907 Both packages are modified versions of the standard
11908 \begin_inset Quotes eld
11912 \begin_inset Quotes erd
11915 package, and they are almost (but not exactly) identical.
11916 Most of their features are supported by LyX.
11917 I have used LyX successfully to write articles submitted to both journals
11918 without any problem.
11921 \begin_layout Subsection
11925 \begin_layout Standard
11926 As usual, the easiest way to write a paper is to start with a template.
11929 File\SpecialChar \menuseparator
11948 This will give an (almost) empty document that includes the most common
11949 fields found in a manuscript.
11950 Simply overwrite the existing text (including the brackets,
11955 You should keep in mind the following remarks.
11958 \begin_layout Enumerate
11959 LyX won't let you change the font size and the page style of the document,
11960 because such modifications are not allowed by both packages.
11963 \begin_layout Enumerate
11964 The language of the document should not be changed.
11965 Before previewing your paper, be sure that the babel package is not used.
11966 To do this, click on
11968 Tools\SpecialChar \menuseparator
11979 checkbox in the language settings, and click on
11987 , if you wish to make this change permanent).
11990 \begin_layout Enumerate
11992 \begin_inset Quotes eld
11996 \begin_inset Quotes erd
11999 style must be used to define keywords.
12002 \begin_layout Enumerate
12003 The ijmpc package provides a style named
12004 \begin_inset Quotes eld
12007 Classification Codes
12008 \begin_inset Quotes erd
12011 , which can be used to define classification codes, such as PACS numbers.
12012 Note that this facility is not supported by the ijmpd package.
12015 \begin_layout Enumerate
12016 Several new environments are available:
12017 \begin_inset Quotes eld
12021 \begin_inset Quotes erd
12025 \begin_inset Quotes eld
12029 \begin_inset Quotes erd
12033 \begin_inset Quotes eld
12037 \begin_inset Quotes erd
12041 \begin_inset Quotes eld
12045 \begin_inset Quotes erd
12049 \begin_inset Quotes eld
12053 \begin_inset Quotes erd
12057 \begin_inset Quotes eld
12061 \begin_inset Quotes erd
12065 \begin_inset Quotes eld
12069 \begin_inset Quotes erd
12073 \begin_inset Quotes eld
12077 \begin_inset Quotes erd
12081 \begin_inset Quotes eld
12085 \begin_inset Quotes erd
12089 \begin_inset Quotes eld
12093 \begin_inset Quotes erd
12097 \begin_inset Quotes eld
12101 \begin_inset Quotes erd
12105 \begin_inset Quotes eld
12109 \begin_inset Quotes erd
12113 \begin_inset Quotes eld
12117 \begin_inset Quotes erd
12121 \begin_inset Quotes eld
12125 \begin_inset Quotes erd
12129 Their use is more or less obvious.
12130 LyX supports all these environments; it will use the proper label, text
12131 style, and numbering scheme for each of them.
12134 \begin_layout Enumerate
12135 Both packages use basic citations; the natbib package should not be used.
12136 In LyX, citation references are shown as usual; in the output, citations
12137 are shown as superscripts.
12138 If you want to use a citation as normal text, you should use the
12143 \begin_inset space \thinspace{}
12147 \begin_inset space \space{}
12151 \begin_inset Quotes eld
12155 \begin_inset space \space{}
12165 \begin_inset Quotes erd
12171 \begin_layout Enumerate
12173 \begin_inset Quotes eld
12177 \begin_inset Quotes erd
12180 section in both packages.
12181 To put acknowledgments, just use the
12182 \begin_inset Quotes eld
12186 \begin_inset Quotes erd
12192 \begin_layout Enumerate
12193 Appendices may be added to the paper,
12197 the Acknowledgments and
12202 LyX provides a special environment, called
12203 \begin_inset Quotes eld
12207 \begin_inset Quotes erd
12210 which marks the beginning of the appendices.
12211 This environment should be left blank; it just sends a LaTeX command, but
12212 nothing is really printed.
12214 \begin_inset Quotes eld
12218 \begin_inset Quotes erd
12221 is printed with blue letters, as a signal that all sections after that
12222 point are appendices.
12223 To write an appendix, use the
12224 \begin_inset Quotes eld
12228 \begin_inset Quotes erd
12232 LyX will number each appendix with capital letters, as required by both
12235 \begin_inset Quotes eld
12239 \begin_inset Quotes erd
12246 be present before the first appendix; if not, all appendices will be numbered
12247 as normal sections in the output.
12250 \begin_layout Enumerate
12251 The ijmpc and the ijmpd packages use the
12255 command to implement table captions.
12256 As a result, a table created by LyX is printed correctly, but its caption
12258 However, you can use some TeX code to overcome this problem, so that captions
12259 are printed as expected.
12260 To do so, create a float table as usual, remove the caption, and replace
12261 it with the TeX code
12271 (sic); you must also the TeX code
12275 immediately after the tabular material.
12276 Study the example table included in the template files to see how this
12277 trick is implemented.
12278 Alternatively, If you need table captions, you should implement the whole
12283 file, then include this file to the LyX document (
12285 Insert\SpecialChar \menuseparator
12286 File\SpecialChar \menuseparator
12288 \begin_inset space ~
12294 Details on how to create a table float can be found in the files
12302 , included in the corresponding packages.
12305 \begin_layout Subsection
12306 Preparing a paper for submission
12309 \begin_layout Standard
12310 Before you submit your paper you must export the LyX document as a LaTeX
12313 File\SpecialChar \menuseparator
12314 Export\SpecialChar \menuseparator
12321 \begin_layout Plain Layout
12322 Actually you have the choice between LaTeX (plain) and pdflatex.
12323 If you intend to use pdflatex to prepare the paper, you should use the
12324 pdflatex option so that included graphics are converted to PDF format,
12325 ready for use by pdflatex.
12330 , then make the following changes to the resulting
12337 \begin_layout Enumerate
12338 Remove the comment lines before the
12347 \begin_layout Enumerate
12348 Remove everything between (and including) the
12360 commands, except for any commands you specifically put into the LaTeX preamble.
12363 \begin_layout Standard
12368 file should be saved and processed through LaTeX as many times as necessary.
12369 You may also want to check the resulting
12376 \begin_layout Subsection
12380 \begin_layout Standard
12381 The use of TeX code is reduced to two commands, which must be placed at
12382 the top of the document.
12383 If you started writing your paper by using the
12391 template, the TeX code needed is already in its place; you usually don't
12393 You may only modify the first TeX code to specify the information printed
12394 to the top of odd and even pages (authors' names and short paper's title,
12396 This TeX code must have the form
12400 markboth{Authors' Names}{Short Paper's Title}
12405 \begin_layout Section
12409 \begin_layout Standard
12415 \begin_layout Subsection
12419 \begin_layout Standard
12420 The iopart package provides a document class to create electronic manuscript
12421 submission to the journals published by the Institute of Physics.
12422 Instructions for the authors how to create a paper using the iopart class
12423 can be downloaded together with the iopart package from the site
12424 \begin_inset Flex URL
12427 \begin_layout Plain Layout
12429 ftp://ftp.iop.org/pub/journals/latex2e
12437 \begin_layout Subsection
12441 \begin_layout Standard
12442 The easiest way to write a paper is to start with the file
12446 that is available in LyX's examples files folder.
12447 Open this file, save it under a new name, and start writing.
12448 The example file explains how to use the special text environments.
12449 Here are the most important advices:
12452 \begin_layout Itemize
12453 To be able to compile your document to a PDF, PS, or DVI, ensure that the
12456 Use AMS math package
12458 in the document settings under
12465 \begin_layout Itemize
12468 The title environment defines the kind of your paper.
12469 So use one of the following environments for the title:
12473 \begin_layout Itemize
12482 \begin_layout Itemize
12491 \begin_layout Itemize
12497 for a Topical review
12500 \begin_layout Itemize
12509 \begin_layout Itemize
12518 \begin_layout Itemize
12524 for a Paper (same as Title)
12527 \begin_layout Itemize
12533 for a Preliminary communication
12536 \begin_layout Itemize
12542 for a Rapid communication
12545 \begin_layout Itemize
12551 for a Letter to the editor
12555 \begin_layout Itemize
12558 All title environments except of
12562 can have an optional short title.
12565 \begin_layout Itemize
12566 There is a general title environment
12570 which is not directly supported by the LyX.
12571 This can be used as TeX code when your document doesn't fit into one of
12572 the other title types.
12575 \begin_layout Standard
12576 For more informations like hints for special table and formula formatting,
12577 look at the IOP author guidelines.
12580 \begin_layout Section
12584 \begin_layout Standard
12587 Panayotis Papasotiriou
12590 \begin_layout Subsection
12594 \begin_layout Standard
12595 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
12596 that facilitates electronic manuscript submission to the journals they
12598 Most known of them (at least in my domain of interest) are
12600 Astrophysics and Space Science
12606 , but there are many others (see a complete list at
12607 \begin_inset Flex URL
12610 \begin_layout Plain Layout
12612 http://www.wkap.nl/jrnllist.htm/JRNLHOME
12618 The Kluwer package may be downloaded from the site
12619 \begin_inset Flex URL
12622 \begin_layout Plain Layout
12624 http://www.wkap.nl/kaphtml.htm/STYLEFILES
12630 A complete user guide is contained in that package (but it can also be
12631 downloaded separately).
12634 \begin_layout Standard
12635 LyX supports many features of the package but not everything.
12636 However, the TeX code needed is reduced to some
12637 \begin_inset Quotes eld
12641 \begin_inset Quotes erd
12644 commands of the package (see
12645 \begin_inset space ~
12649 \begin_inset CommandInset ref
12651 reference "subsec:kluwer_peculiarities"
12656 I have recently used LyX to write an article submitted to the
12658 Astrophysics and Space Science
12660 without any problem.
12663 \begin_layout Subsection
12667 \begin_layout Standard
12668 The easiest way to write a paper is to start with the Kluwer template file.
12671 File\SpecialChar \menuseparator
12683 This will give an (almost) empty document that includes the most common
12684 fields found in a manuscript and a short description of their use.
12685 As in most templates, simply overwrite the existing text (including the
12690 ) with the correct information.
12693 \begin_layout Subsection
12694 Preparing a paper for submission
12697 \begin_layout Standard
12698 As in the AASTeX package, before you submit your paper to a journal you
12700 \begin_inset Quotes eld
12704 \begin_inset Quotes erd
12710 \begin_layout Enumerate
12711 Export your paper as a LaTeX file.
12712 To do this, click on
12714 File\SpecialChar \menuseparator
12715 Export\SpecialChar \menuseparator
12722 \begin_layout Enumerate
12727 file with a text editor and make the following changes
12731 \begin_layout Enumerate
12732 remove the comment lines before the
12741 \begin_layout Enumerate
12742 remove everything between (and including) the
12754 commands, except for any commands you specifically put into the LaTeX preamble.
12757 \begin_layout Standard
12766 \begin_layout Enumerate
12771 file through LaTeX as many times as necessary (usually up to three).
12774 \begin_layout Enumerate
12780 \begin_inset space \thinspace{}
12784 \begin_inset space \space{}
12791 , and check if everything is OK (it should, if you didn't make any mistake).
12794 \begin_layout Subsection
12795 \begin_inset Quotes eld
12799 \begin_inset Quotes erd
12802 of the Kluwer package
12803 \begin_inset CommandInset label
12805 name "subsec:kluwer_peculiarities"
12812 \begin_layout Standard
12813 The Kluwer package has the following
12814 \begin_inset Quotes eld
12818 \begin_inset Quotes erd
12824 \begin_layout Enumerate
12825 It is possible to write multiple articles in the same LaTeX file
12829 \begin_layout Plain Layout
12830 I can't imagine any good reason to do this.
12836 Each article must be included in the environment
12837 \begin_inset Quotes eld
12841 \begin_inset Quotes erd
12845 Unfortunately, this environment cannot be omitted, even if you write just
12847 Therefore, each article starts with the command
12853 and, obviously, ends with the command
12860 Although this can be implemented in LyX, I didn't included it, since it
12861 looks ugly and can confuse the novice user.
12862 Therefore, you need to enter them directly and mark them as LaTeX code
12864 \begin_inset Quotes eld
12868 \begin_inset Quotes erd
12874 \begin_layout Enumerate
12875 Information given at the beginning of the article (i.
12876 \begin_inset space \thinspace{}
12880 \begin_inset space \space{}
12883 title, subtitle, author, institution, running title, running author, abstract
12884 and keywords) must be included in an environment called
12885 \begin_inset Quotes eld
12889 \begin_inset Quotes erd
12893 This is not implemented in LyX, so you must enter title, subtitle etc.
12894 \begin_inset space ~
12897 between two TeX code lines (
12912 \begin_layout Enumerate
12913 According to the user manual, the label of each bibliography item must be
12937 \begin_layout Standard
12942 template takes care of all these
12943 \begin_inset Quotes eld
12947 \begin_inset Quotes erd
12951 If you start a new paper using this template you don't need to do anything
12956 \begin_layout Enumerate
12957 don't delete the TeX code included in the template, and
12960 \begin_layout Enumerate
12961 copy the example bibliography item included in the template and modify it
12962 as necessary to enter new bibliography items.
12965 \begin_layout Section
12969 \begin_layout Standard
12975 \begin_layout Subsection
12979 \begin_layout Standard
12980 The LyX document classes
12982 article (koma-script)
12986 report (koma-script)
13004 correspond to the LaTeX document classes
13021 \begin_inset space ~
13024 of the Koma-Script family.
13025 They are replacements for the standard document classes
13041 , resp., and fit better to European typography conventions in a number of
13045 \begin_layout Itemize
13046 Standard character size is 11pt in
13048 article (koma-script)
13052 report (koma-script)
13060 letter (koma-script)
13065 \begin_layout Itemize
13066 Headings, labels of the description environment, and a number of elements
13069 letter (koma-script)
13071 document class are set in a bold sans serif font.
13075 \begin_layout Plain Layout
13076 There is a big difference between the bold sans serif old cm fonts and new
13077 ec fonts, especially in the appearance of headings.
13078 In comparison, the ec bold sans serif fonts look a bit thin.
13079 Here the LaTeX package
13087 helps to produce the
13088 \begin_inset Quotes eld
13092 \begin_inset Quotes erd
13095 appearance when using the ec fonts.
13100 The numbering of chapter headings is made in the same way as the numbering
13101 of section headings, that is without the extra line
13102 \begin_inset Quotes eld
13105 Chapter\SpecialChar \ldots{}
13107 \begin_inset Quotes erd
13111 In addition, the appearance of the headings can be modified by using a
13112 number of options (in LyX to be entered in the field
13115 \begin_inset space ~
13122 Layout\SpecialChar \menuseparator
13129 \begin_layout Itemize
13130 The main means in the Koma-Script document classes to design the type area
13139 (in LyX to be entered in the extra class options field in the dialog
13141 Document\SpecialChar \menuseparator
13145 They make a clearer modification of page margins possible as do the options
13148 Document\SpecialChar \menuseparator
13155 \begin_layout Itemize
13156 The LaTeX document classes of the Koma-Script family define a number of
13157 additional commands.
13158 Those part of it which makes sense in LyX is implemented in corresponding
13162 \begin_layout Standard
13163 Detailed descriptions of the LaTeX document classes of the Koma-Script family
13164 can be found in the Koma-Script documentation
13175 \begin_layout Subsection
13176 article (koma-script), report (koma-script), and book (koma-script)
13179 \begin_layout Standard
13180 The document classes
13182 article (koma-script)
13186 report (koma-script)
13196 are implemented in the layout files
13209 They contain all the paragraph types of the corresponding standard document
13222 , resp., partly modified, with the exception of the LyX specific
13226 -type, which is replaced by the new
13230 -type having the same functionality.
13235 -Type there is a number of new paragraph types added.
13242 letter (koma-script)
13247 \begin_layout Itemize
13256 : are equivalents to
13264 , resp., additionally inserting an entry in the table of contents.
13273 are not contained in
13275 article (koma-script)
13280 \begin_layout Itemize
13289 : behave exactly as
13297 , resp., additionally clearing running heads.
13302 is not contained in
13304 article (koma-script)
13310 \begin_layout Plain Layout
13323 report (koma-script)
13325 , but since this is identical to
13329 , is has not been implemented in LyX.
13337 \begin_layout Itemize
13342 : generates a heading directly above the following paragraph in the standard
13343 character size without affecting the structure of the document.
13346 \begin_layout Itemize
13355 are special captions which respect the different space settings needed
13356 for captions placed above or below an element (if you follow strict typographic
13357 rules, you might want to place table captions always above the table).
13358 You can also use the class option
13362 , which will switch
13375 You need at least Koma-Script version 2.8q to use this.
13378 \begin_layout Itemize
13383 : can be used to set a bonmot, e.
13384 \begin_inset space \thinspace{}
13388 \begin_inset space \space{}
13391 at the beginning of a chapter.
13392 If you use the optional argument (
13394 Insert\SpecialChar \menuseparator
13396 \begin_inset space ~
13401 ), you can insert the dictum's author there.
13402 Dictum and author are separated by a line.
13403 You need at least Koma-Script version 2.8q to use this.
13408 is not contained in
13410 article (koma-script)
13415 \begin_layout Standard
13416 The following types, together with the standard types
13428 , form the title area of the document.
13429 They must be entered ahead of the first
13430 \begin_inset Quotes eld
13434 \begin_inset Quotes erd
13441 \begin_layout Plain Layout
13442 The corresponding LaTeX commands must appear before the
13453 When such a type is used more than once, the latter usage overwrites the
13454 former one, that means, for every type only the latest usage is valid.
13455 The order of the different types however has, like
13467 , no effect on the appearance of the produced document.
13470 \begin_layout Itemize
13475 : produces a centered paragraph above the ordinary title (
13487 ) for the subject of the document.
13490 \begin_layout Itemize
13495 : produces a centered paragraph below the ordinary title (
13507 ) for the publishers' name.
13510 \begin_layout Itemize
13517 report (koma-script)
13523 produces a centered paragraph on its own page behind the title page, or
13526 article (koma-script)
13528 produces a centered paragraph below the ordinary title (
13544 ) for a dedication.
13547 \begin_layout Itemize
13552 : produces a left aligned paragraph above the ordinary title (
13568 ) for a document`s head.
13571 \begin_layout Itemize
13576 : produces in a double-sided print in
13578 report (koma-script)
13584 a left-aligned paragraph at the top of the title page`s back or has no
13585 effect in a single-sided print or in
13587 article (koma-script)
13592 \begin_layout Itemize
13597 : produces in a double-sided print in
13599 report (koma-script)
13605 a left-aligned paragraph at the bottom of the title page`s back or has
13606 no effect in a single-sided print or in
13608 article (koma-script)
13613 \begin_layout Itemize
13618 : produces a special
13619 \begin_inset Quotes eld
13623 \begin_inset Quotes erd
13626 page ahead of the actual document containing a paragraph without special
13630 \begin_layout Standard
13631 The layout files for the document classes
13633 article (koma-script)
13637 report (koma-script)
13643 do include the file
13648 This is thought of as a place to define your own types.
13653 in your personal layout directory and edit the file!
13656 \begin_layout Subsection
13657 letter (koma-script)
13660 \begin_layout Standard
13664 letter (koma-script)
13666 is implemented in the layout file
13671 It contains all the paragraph types of the corresponding standard document
13676 , partly modified, with the exception of the LyX specific types
13688 type, which is replaced by the new
13693 In addition, it contains, in contrast to the standard document class, the
13711 Furthermore, there are a number of new letter specific types.
13714 \begin_layout Standard
13715 The appearance of the letter produced by this document class can be controlled
13716 by a number of LaTeX commands, which you can put in the LaTeX preamble.
13720 \begin_layout Plain Layout
13721 For example, the standard appearance of the letter`s heading, consisting
13722 of name and address, is quite self-willed.
13724 \begin_inset Quotes eld
13728 \begin_inset Quotes erd
13731 heading is produced by the following LaTeX commands in the preamble:
13734 \begin_layout LyX-Code
13744 \begin_layout LyX-Code
13760 \begin_layout LyX-Code
13770 \begin_layout LyX-Code
13790 A detailed German description of such LaTeX commands can be found in the
13791 Koma-Script documentation
13796 With it, the letter's author can produce his personal letter layout.
13799 \begin_layout Standard
13808 define the beginning of the letter and must be used in every letter.
13809 To emphasize them in the LyX document class, they are marked with the letter
13819 \begin_inset space ~
13822 in the left margin.
13823 It is possible to write any number of letters in one file.
13828 type produces a new letter using the same addressee and a
13832 type produces a new addressee.
13849 are ordinary paragraph types and can also be used several times in one
13850 and the same letter.
13853 \begin_layout Itemize
13858 : produces a paragraph for the addressee and implicitly defines the beginning
13862 \begin_layout Itemize
13867 : produces a paragraph for the form of address and implicitly produces a
13871 \begin_layout Itemize
13876 : produces a paragraph for a close.
13879 \begin_layout Itemize
13884 : produces a paragraph for a postscript.
13887 \begin_layout Itemize
13892 : produces a paragraph for a distribution list.
13895 \begin_layout Itemize
13900 : produces a paragraph for enclosures.
13903 \begin_layout Standard
13944 are input types provided with a label to enter information, which will
13945 be processed by the document class.
13949 \begin_layout Plain Layout
13950 It could be seen as a matter of inconsequence, that the types
13958 described above are not such input types as well.
13959 Because of the special meaning of those types, however, I have implemented
13960 them as ordinary paragraph types with a one letter mark in the left margin.
13961 Moreover, it would affect my feeling of symmetry, if the
13969 type had such a serious different appearance.
13974 The types must be used ahead of the corresponding
13981 \begin_layout Standard
13982 An implementation of these types in a WYSIWYG fashion does not seem to make
13983 sense, because the real appearance of the produced letter does not only
13984 depend on the usage of the particular type, but also on other factors.
13985 For example, a signature entered in the
13989 type will in the standard behavior appear in the produced letter only,
13990 when in the same letter also a
13995 The entered value of the
13999 type will in the standard behavior not appear in the produced letter at
14001 The possibility to design the letter`s heading freely is already indicated
14002 in a footnote above.
14005 \begin_layout Standard
14006 The input types can also be used as empty paragraphs.
14007 This makes sense e.
14008 \begin_inset space \thinspace{}
14012 \begin_inset space \space{}
14024 type is not used at all, in the standard behavior the value of the
14028 type is used as signature, whereas if an empty
14032 type is used, no signature value is defined.
14035 \begin_layout Standard
14036 By using the input types it is possible to write a letter template, containing
14037 filled input types with your personal dates (name, address, etc.) and empty
14038 input types for other dates you want to enter.
14041 \begin_layout Itemize
14046 : sender's name, in the standard behavior appears as a centered paragraph
14047 in small caps in the letter`s heading.
14050 \begin_layout Itemize
14055 : sender's signature, in the standard behavior appears below the
14064 type is used, the value of the
14068 type appears instead.
14071 \begin_layout Itemize
14076 : sender's address, in the standard behavior appears in a centered paragraph
14077 in the letter`s heading below the sender's name.
14080 \begin_layout Itemize
14085 : sender's telephone number, in the standard behavior only sets the LaTeX
14095 \begin_layout Itemize
14100 : place of the letter`s making.
14103 \begin_layout Itemize
14108 : date of the letter`s making.
14117 , in the standard behavior, produce the place and the date in a right-aligned
14118 line below the addressee's field.
14123 type is used, neither place nor date appear, independent of the value of
14133 type is used, the date of the letter `s production is used.
14136 \begin_layout Itemize
14141 : sender`s back address, in the standard behavior appears above the addressee's
14142 field in a small sans serif font.
14145 \begin_layout Itemize
14150 : special mail information, in the standard behavior appears underlined
14151 above the addressee's field below the back address.
14154 \begin_layout Itemize
14159 : additional information, in the standard behavior appears on right side
14160 below the addressee`s field.
14163 \begin_layout Itemize
14168 : the letter's title, in the standard behavior appears in a big, bold, sans
14169 serif font above the subject.
14172 \begin_layout Itemize
14177 : the letter's subject, in the standard behavior appears in a bold font
14185 \begin_layout Standard
14206 produce a business letter like line above the
14210 line containing the fields
14211 \begin_inset Quotes eld
14215 \begin_inset Quotes erd
14219 \begin_inset Quotes eld
14223 \begin_inset Quotes erd
14227 \begin_inset Quotes eld
14231 \begin_inset Quotes erd
14235 \begin_inset Quotes eld
14239 \begin_inset Quotes erd
14243 \begin_inset Quotes eld
14247 \begin_inset Quotes erd
14251 \begin_inset Quotes eld
14255 \begin_inset Quotes erd
14259 For the date field, the value of the
14265 \begin_inset Quotes eld
14268 business letter types
14269 \begin_inset Quotes erd
14272 is used, the value of the
14276 type however does not appear, but only the LaTeX variable
14283 The ordinary output of place and date in a right-aligned line below the
14284 addressee`s field is suppressed.
14285 The types are implemented as input types provided with a label and must
14286 be used ahead of the corresponding
14293 \begin_layout Itemize
14301 \begin_layout Itemize
14309 \begin_layout Itemize
14317 \begin_layout Itemize
14325 \begin_layout Itemize
14333 \begin_layout Subsection
14334 The new letter class: letter (koma-script v.2)
14337 \begin_layout Standard
14343 \begin_layout Standard
14344 \begin_inset VSpace medskip
14350 \begin_layout Standard
14352 Koma-Script version 2.8 has introduced a new letter class
14356 which supersedes the now unsupported
14361 It has — on the LaTeX side — a completely new interface and is not compatible
14362 with the old class.
14363 Therefore, LyX supports both, though it is recommended you use the new
14367 \begin_layout Standard
14368 This class covers the same functionality as
14370 letter (koma-script),
14373 The basic items are
14377 (receiver's address, same as
14381 in the old layout),
14394 will start a new letter (i.
14395 \begin_inset space \thinspace{}
14399 \begin_inset space \space{}
14402 you can write several letters per document).
14403 New elements are sender's
14419 and the possibility to use a
14425 Insert\SpecialChar \menuseparator
14431 \begin_layout Standard
14432 The biggest improvement is, though, that the letter's layout is configurable
14433 to meet almost any needs.
14434 This can be done via the preamble or with a special style file (Letter
14435 Class Option, extension
14439 ), that will be read in as a class option.
14443 \begin_layout Plain Layout
14444 The KOMA package comes with some default
14449 There is, for instance, a
14453 file that follows german typesetting rules, or a
14457 that provides the default layout of the old
14462 The latter can be loaded with the class option
14471 ayout\SpecialChar \menuseparator
14476 ocument\SpecialChar \menuseparator
14488 template that is included in LyX for examples.
14489 A detailed description is to be found in the Koma-Script documentation
14497 \begin_layout Subsection
14501 \begin_layout Standard
14502 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
14506 \begin_layout Itemize
14507 The chapter number of a
14511 type appears on a line of its own above the chapter heading instead of
14512 appearing in the same line ahead of it.
14513 The cause for that is the LyX internal behavior for the labeltype
14517 in the layout file.
14520 \begin_layout Itemize
14521 The headings of the types
14529 are only put in the
14530 \begin_inset Quotes eld
14534 \begin_inset Quotes erd
14537 LaTeX table of contents, but not in the LyX table of contents (
14539 Document\SpecialChar \menuseparator
14541 \begin_inset space ~
14545 \begin_inset space ~
14553 \begin_layout Itemize
14554 The paragraphs in a
14558 document class appear in a skip separation mode, not indented.
14559 This is the standard behavior, no special LaTeX commands are needed for
14563 Document\SpecialChar \menuseparator
14566 dialog the corresponding radio button indicates
14575 value always has the effect that extra LaTeX commands are inserted in the
14576 document to produce the gap, which is not what is wanted in this case.
14579 \begin_layout Section
14583 \begin_layout Standard
14589 \begin_layout Subsection
14593 \begin_layout Standard
14594 Memoir is a very powerful and constantly evolving class.
14595 It has been designed with regard to fictional and non-fictional literature.
14596 Its aim is to let the user have maximum control over the typesetting of
14598 Memoir is based on the standard book class, but it can also emulate the
14599 article class (see below).
14602 \begin_layout Standard
14603 Peter Wilson, the developer of Memoir, is known as the author of lots of
14604 useful packages in the LaTeX world.
14605 Most of them have been merged with Memoir.
14606 Therefore, it is much easier to layout the table of contents, appendices,
14607 chapter designs and such.
14608 LyX, though, does not support all of these goodies natively.
14609 Some of them might be added to forthcoming releases
14613 \begin_layout Plain Layout
14614 You are invited to send suggestions to
14615 \begin_inset Flex URL
14618 \begin_layout Plain Layout
14620 lyx-devel@lists.lyx.org
14630 , lots will probably never be supported, due to the limitations of LyX's
14632 Of course you can still use all features with the help of some native LaTeX
14637 \begin_layout Plain Layout
14642 \begin_layout Plain Layout
14652 \begin_inset space ~
14656 \begin_inset CommandInset ref
14658 reference "sec:Inserting-TeX-Code"
14668 In this section, we can only list those features that are natively supported
14670 For detailed descriptions (and for the rest of features) we recommend you
14671 have a look at the detailed manual of the Memoir class
14675 \begin_layout Plain Layout
14680 \begin_layout Plain Layout
14690 \begin_inset Flex URL
14693 \begin_layout Plain Layout
14695 CTAN:/macros/latex/memoir/memman.pdf
14705 , which is not only a user guide for the class, but also both a comprehensive
14706 description on good typesetting and a superb example for good typesetting
14710 \begin_layout Subsection
14711 Basic features and restrictions
14714 \begin_layout Standard
14715 Memoir supports basically all features of the standard book classes.
14716 There are, however, some differences, as follows:
14719 \begin_layout Description
14721 \begin_inset space ~
14724 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
14727 \begin_layout Description
14729 \begin_inset space ~
14732 style: The fancy page style is not supported, due to a command clash between
14733 Memoir and the fancyhdr package (they both define a command with the same
14734 name, which confuses LaTeX).
14735 Instead, Memoir comes with a number of its own page styles (see
14737 Layout\SpecialChar \menuseparator
14738 Document\SpecialChar \menuseparator
14740 \begin_inset space ~
14746 If you want to use these for the chapter pages, you have to use the command
14753 in the main text or in preamble (e.
14754 \begin_inset space \thinspace{}
14758 \begin_inset space \space{}
14765 chapterstyle{companion}
14770 \begin_layout Description
14771 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
14772 optional argument in the standard classes.
14773 With this, you can specify an alternative version of the title for the
14774 table of contents and the headers (for instance, if the title is too long).
14775 In LyX, you can do this via
14777 Insert\SpecialChar \menuseparator
14779 \begin_inset space ~
14784 at the beginning of a chapter/section.
14785 Memoir features a second optional argument and thus separates the table
14786 of contents from the header.
14787 You can define three variants of a title with this: one for the main text,
14788 one for the table of contents, and one for the headers.
14789 Simply insert two optional arguments if you need this feature, the first
14790 one containing the short title for the Table of Contents, the second one
14791 containing an alternative short title for the headers.
14794 \begin_layout Description
14795 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14796 of contents, the list of figures and the list of table start a new page
14798 Memoir does not follow this route.
14799 You have to insert a page break yourself, if you want to have one.
14802 \begin_layout Description
14803 Titlepage: For some unknown reason, Memoir uses pagination on the title
14804 page (in the standard classes, title pages are
14805 \begin_inset Quotes eld
14809 \begin_inset Quotes erd
14813 If you want an empty title page, type
14817 aliaspagestyle{title}{empty}
14822 \begin_layout Description
14823 Article: With the class option
14829 Layout\SpecialChar \menuseparator
14830 Document\SpecialChar \menuseparator
14832 \begin_inset space ~
14837 ), you can emulate article style.
14838 That is, counters (footnotes, figures, tables etc.) will not be reset on
14839 new chapters, chapters don't start a new page (but are—in contrary to
14840 \begin_inset Quotes eld
14844 \begin_inset Quotes erd
14847 article classes—still allowed), parts, though, use their own page, as in
14851 \begin_layout Description
14852 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14853 font commands, which have been used in the old LaTeX version 2.09 (e.
14854 \begin_inset space \thinspace{}
14858 \begin_inset space \space{}
14874 It produces an error and stops LaTeX whenever such a command appears.
14879 reallows the commands and spits out warnings instead (which does at least
14881 Since a lot of packages and particularly BibTeX style files are still using
14882 those commands, we have decided to use this option by default.
14885 \begin_layout Subsection
14889 \begin_layout Standard
14890 We will only describe the features supported by LyX (which is not much currently
14892 Please consult the Memoir manual
14896 \begin_layout Plain Layout
14901 \begin_layout Plain Layout
14911 \begin_inset Flex URL
14914 \begin_layout Plain Layout
14916 CTAN:/macros/latex/memoir/memman.pdf
14929 \begin_layout Description
14930 Abstract: You may wonder why an abstract is an extra feature.
14931 Well, it is in book class.
14932 Usually books don't have abstracts.
14933 Memoir, however, has.
14934 You can use it wherever and how often you like.
14937 \begin_layout Description
14938 Chapterprecis: You may know this older typesetting style: The contents of
14939 a chapter are summarized below the title and also in the table of contents
14941 \begin_inset space \thinspace{}
14945 \begin_inset space \space{}
14950 Our hero arrives in Troia; he loses some friends; he finds others
14953 Chapterprecis does exactly this.
14954 It is therefore only sensible below a chapter.
14957 \begin_layout Description
14958 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14959 The epigraph environment provides an elegant way of typesetting such a
14961 The motto itself (text) and its author (source) are divided by a short
14963 Unfortunately, we have to fool LyX a bit here again, since the environment
14964 needs two arguments (text and source).
14965 In this case, we have to use curly brackets (in TeX mode) between the two
14976 <author of the slogan>.
14979 \begin_layout Description
14980 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14981 complex figurative poems).
14982 LyX can only support a few of them.
14983 One is poemtitle, which is a centered title for poems, which will also
14984 be added to the table of contents (verse is the standard environment for
14986 Memoir has some enhanced versions of verse, but you need to use TeX code,
14987 because they have to be nested inside regular verse environments, which
14988 is not possible with LyX).
14991 \begin_layout Description
14992 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14995 \begin_layout Section
14996 Article (mwart), book (mwbk) and report (mwrep)
14997 \begin_inset Argument
15000 \begin_layout Plain Layout
15013 \begin_layout Standard
15019 \begin_layout Standard
15020 The LyX document classes
15036 correspond to the LaTeX document classes
15049 They are replacements for the standard document classes
15061 , resp., and fit better to Polish typography conventions in a number of points.
15065 \begin_layout Standard
15069 \begin_layout Itemize
15070 Unnumbered titles (with star, e.
15071 \begin_inset space \thinspace{}
15075 \begin_inset space \space{}
15082 ) are added into table of contents,
15085 \begin_layout Itemize
15086 Additional page styles:
15090 \begin_layout Description
15091 uheadings header with separated lines,
15094 \begin_layout Description
15095 myheadings custom header, contents headers via commands:
15110 \begin_layout Description
15111 myuheadings custom header with separated lines,
15114 \begin_layout Description
15115 outer page number is placed on outer side of page
15119 \begin_layout Itemize
15124 \begin_layout Description
15125 rmheadings serif titles — default,
15128 \begin_layout Description
15129 sfheadings sansserif titles,
15132 \begin_layout Description
15133 authortitle on title page first placed is author next title — default,
15136 \begin_layout Description
15137 titleauthor on title page first placed is title next author,
15140 \begin_layout Description
15141 withmarginpar reserve place on page for margins.
15145 \begin_layout Section
15149 \begin_layout Standard
15154 provides an alternative to the standard
15159 It provides similar functionality, but you might prefer this layout with
15160 sans serif sections, headings, and more.
15163 \begin_layout Section
15167 \begin_layout Standard
15173 \begin_layout Standard
15174 \begin_inset VSpace bigskip
15180 \begin_layout Standard
15185 \begin_inset space ~
15190 textclass works with the American Physical Sociey's RevTeX 4.0 (the
15191 \begin_inset Formula $\beta$
15194 release of May, 1999) class.
15197 \begin_layout Standard
15202 textclass, which works with RevTeX 3.1.
15203 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
15204 That means that it doesn't interact very well with LyX, which requires
15205 LaTeX2e, although it has been kludged to work.
15206 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
15210 \begin_inset space ~
15215 textclass should also be pretty easy to use.
15218 \begin_layout Standard
15219 These documents are supposed to be used in
15223 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
15224 macros, and assume you'll know what to put in the preamble if necessary.
15227 \begin_layout Subsection
15231 \begin_layout Standard
15232 All you need to do is install RevTeX 4, as described in the package's README
15234 The package can be found at The RevTeX 4 Web Site
15235 \begin_inset Flex URL
15238 \begin_layout Plain Layout
15240 http://publish.aps.org/revtex4/
15246 Install it somewhere that LaTeX can see it.
15247 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
15249 \begin_inset space \thinspace{}
15253 \begin_inset space \space{}
15256 not the directory where you installed the class file.) Then, if you reconfigure
15257 LyX, it will find the class file and let you use the RevTeX4 textclass.
15260 \begin_layout Standard
15261 Probably the easiest way to get started is either to import a RevTeX 4 document
15269 \begin_inset space ~
15274 template, found in the templates directory.
15277 \begin_layout Subsection
15281 \begin_layout Standard
15282 Optional arguments to
15289 \begin_inset Quotes eld
15293 \begin_inset Quotes erd
15297 \begin_inset Quotes eld
15301 \begin_inset Quotes erd
15311 \begin_inset space ~
15319 \begin_inset space ~
15325 Remember that in RevTeX, at least one optional argument is required!
15328 \begin_layout Standard
15329 Other preamble matter, like
15336 \begin_inset space ~
15342 \begin_inset space ~
15347 dialog, also as usual.
15350 \begin_layout Subsection
15354 \begin_layout Standard
15355 The layouts basically correspond to the commands in RevTeX4.0.
15356 For example, the Email layout corresponds to
15363 Note that (at least as of RevTeX 4.0 Beta), the
15371 layouts are exactly equivalent, so you shouldn't need to use both.
15375 \begin_layout Plain Layout
15376 In case you're curious, both were included so that
15380 would be able to translate both
15400 \begin_layout Subsection
15404 \begin_layout Standard
15405 There are a couple of important unique aspects of RevTeX 4 which might cause
15406 bugs that will be even more confusing in LyX.
15409 \begin_layout Standard
15427 The LyX equivalent is that there is a separate Thanks layout.
15432 write footnotes in the
15436 layout, or weird things may happen.
15437 See the RevTeX 4 documentation for more details.
15440 \begin_layout Standard
15444 \begin_inset space ~
15452 \begin_inset space ~
15461 layouts must be placed
15469 layout and the corresponding
15486 , the LaTeX won't compile.
15489 \begin_layout Subsection
15493 \begin_layout Standard
15494 The main problem with this layout is that you can't use the optional arguments
15495 to layouts like Email and Title.
15496 (The problem is not unique to this layout; you can't use optional arguments
15497 to the Section layouts either.) This means that after you export that file
15498 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
15499 need to edit the LaTeX file with a text editor to add the optional arguments
15501 \begin_inset space \thinspace{}
15505 \begin_inset space \space{}
15508 the running title for the page headers.
15509 Lacking these layouts makes the
15515 (and the equivalent
15521 ) useless, so the corresponding layouts don't exist, and will have to be
15526 \begin_layout Plain Layout
15531 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
15532 has not been updated yet to take advantage of it.
15540 \begin_layout Section
15541 Springer Journals (
15548 \begin_layout Standard
15554 \begin_layout Subsection
15558 \begin_layout Standard
15559 These are the layout files for some of the journal formats used by Springer
15560 Verlag and listed on
15561 \begin_inset Flex URL
15564 \begin_layout Plain Layout
15566 http://www.springer.de/author/tex/help-journals.html
15571 , where you should also go to fetch the class files (yes, these are LaTeX2e
15573 It is a modular system: the things common to all journals are implemented
15578 , which journal-specific layout files (such as, e.
15579 \begin_inset space \thinspace{}
15583 \begin_inset space \space{}
15590 for Journal of Geodesy) can include.
15593 \begin_layout Standard
15594 This means that implementing support for any other Springer journal on this
15595 list is as simple as writing your own
15603 file following the outline given in
15611 \begin_layout Standard
15612 It is reasonably well tested only for the Journal of Geodesy.
15621 come with the standard LyX distribution.
15622 Install the relevant class file (downloaded from Springer) in a proper
15623 directory, reconfigure LaTeX (in the teTeX case by running
15627 , as root if necessary — doesn't LyX take care of this?), reconfigure LyX
15628 and it should work.
15631 \begin_layout Subsection
15635 \begin_layout Standard
15636 A large number of theorem-like styles —
15642 \SpecialChar \ldots{}
15648 \begin_layout Standard
15651 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
15652 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
15655 See the Springer class file documentation for details.
15658 \begin_layout Subsection
15662 \begin_layout Itemize
15674 \begin_layout Itemize
15677 Probability Theory and Related Fields
15683 — Jean-Marc Lasgouttes
15686 \begin_layout Standard
15687 Add your own, it isn't so hard!
15690 \begin_layout Subsection
15694 \begin_layout Standard
15695 These files are partly based on the older
15699 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
15700 file from Springer.
15705 layout, are now defunct.
15706 Jean-Marc Lasgouttes helped out big in making me find my way around the
15707 LyX layout file mechanism.
15710 \begin_layout Subsection
15714 \begin_layout Standard
15716 But probably less than in the old hacked-LaTeX
15723 \begin_layout Standard
15725 \begin_inset space \thinspace{}
15728 g.: does not display the number for theorem-like layouts, just #.
15731 \begin_layout Section
15737 \begin_inset CommandInset label
15746 \begin_layout Standard
15754 \begin_layout Subsection
15758 \begin_layout Standard
15759 This section describes how to use LyX to make slides for overhead projectors.
15760 There are two document classes that can do this: the default slides class
15766 This section documents the former.
15769 \begin_layout Standard
15770 I'm going to say this again, nice and clear, so that there's no misunderstanding
15774 \begin_layout Standard
15775 \begin_inset VSpace bigskip
15781 \begin_layout Standard
15785 This section documents the class
15786 \begin_inset Quotes eld
15794 \begin_inset Quotes erd
15802 \begin_layout Standard
15803 \begin_inset VSpace bigskip
15809 \begin_layout Standard
15810 If you're looking for the documentation for
15811 \begin_inset Quotes eld
15819 \begin_inset Quotes erd
15822 , check out section
15823 \begin_inset space ~
15827 \begin_inset CommandInset ref
15829 reference "sec:foiltex"
15839 \begin_inset Quotes eld
15847 \begin_inset Quotes erd
15850 ] is actually somewhat better than the default
15858 \begin_layout Plain Layout
15859 \SpecialChar \ldots{}
15860 or so I've been told repeatedly by its advocates.
15861 Having never used it, I have no idea if this claim is true or not.
15866 which this section documents.
15869 \begin_layout Standard
15870 This class is the LaTeX2e improvement of the old
15875 Every LaTeX2e distribution includes this class [which I'll just refer to
15877 \begin_inset Quotes eld
15885 \begin_inset Quotes erd
15888 from now on], so you're bound to have it.
15889 As I noted earlier, there are other classes, such as
15893 , which also produce slides for overhead projectors and do a better job
15895 However, there are some things which
15899 can do which the others can't, such as generate overlays.
15900 Read on to learn more!
15903 \begin_layout Subsection
15905 \begin_inset CommandInset label
15907 name "sec:slidesetup"
15914 \begin_layout Standard
15915 Obviously, to use this document class, you need to select
15916 \begin_inset Quotes eld
15924 \begin_inset Quotes erd
15927 from the class list in the
15929 Document\SpecialChar \menuseparator
15933 There are some other special things you should know about this class:
15936 \begin_layout Itemize
15937 Don't bother changing the options
15942 They're not supported by the
15949 \begin_layout Itemize
15953 \begin_inset space ~
15958 behaves a bit differently for this class.
15959 The possible choices and what they do are as follows:
15963 \begin_layout Description
15968 The final output contains page numbers in the lower right corner.
15971 \begin_layout Description
15980 , but also prints out any time markers you've put in.
15981 This is the default.
15984 \begin_layout Description
15989 The final output contains no page numbers, time markers, or alignment markers.
15993 \begin_layout Itemize
15998 class has an extra option:
16004 \begin_inset Quotes eld
16012 \begin_inset Quotes erd
16015 in the extra class options.
16019 \begin_layout Standard
16020 Using this options allows you to add time markers to
16026 \begin_inset space ~
16030 \begin_inset CommandInset ref
16032 reference "sec:slideNote"
16040 \begin_layout Standard
16041 You can also use the template file
16042 \begin_inset Quotes eld
16050 \begin_inset Quotes erd
16053 to automatically set up a document to use the
16059 File\SpecialChar \menuseparator
16061 \begin_inset space ~
16065 \begin_inset space ~
16070 to open your new document].
16071 The template file also contains some examples of the special paragraph
16072 environments used by this class.
16073 I'll describe those next.
16076 \begin_layout Subsection
16077 Paragraph Environments
16080 \begin_layout Subsubsection
16081 Supported Environments
16084 \begin_layout Standard
16085 The first thing you'll notice when you start up a new
16089 document is the font size and type: it's the equivalent of the size
16090 \begin_inset Quotes eld
16098 \begin_inset Quotes erd
16104 \begin_inset space ~
16110 This is also what's used in the output.
16112 \begin_inset Quotes eld
16116 \begin_inset Quotes erd
16119 to remind you that this is a slide.
16120 Your final slides will use a larger font; ergo, you'll have less space.
16121 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
16124 \begin_layout Standard
16125 The next thing that becomes obvious is the changes to the paragraph environment
16126 pull-down box [at the far-left end of the toolbar].
16127 Most of the paragraph environments you're used to seeing are missing.
16128 There are also five new ones.
16133 class itself only supports certain paragraph environments:
16136 \begin_layout Itemize
16142 \begin_layout Itemize
16148 \begin_layout Itemize
16154 \begin_layout Itemize
16160 \begin_layout Itemize
16166 \begin_layout Itemize
16172 \begin_layout Itemize
16178 \begin_layout Itemize
16184 \begin_layout Itemize
16190 \begin_layout Itemize
16196 \begin_layout Itemize
16202 \begin_layout Standard
16203 All of the other standard environments, including the section-heading environmen
16204 ts, aren't used in the
16211 \begin_layout Standard
16212 On the other hand, you'll notice the following new environments:
16215 \begin_layout Itemize
16221 \begin_layout Itemize
16227 \begin_layout Itemize
16233 \begin_layout Itemize
16239 \begin_layout Itemize
16245 \begin_layout Standard
16246 These five are kind of quirky, due to a
16247 \begin_inset Quotes eld
16251 \begin_inset Quotes erd
16255 You see, LyX doesn't permit you to nest any other paragraph environment
16256 into an empty environment.
16257 Now, that's fine and dandy, but it means that you wouldn't be able to start
16258 a slide with anything except plain text.
16259 To deal with this, I've performed a little
16260 \begin_inset Quotes eld
16264 \begin_inset Quotes erd
16270 \begin_layout Subsubsection
16271 Quirks of the New Environments
16272 \begin_inset CommandInset label
16274 name "sec:slideQuirk"
16281 \begin_layout Standard
16282 All five of the new paragraph environments are somewhat quirky due to inherent
16283 limitiations in the current version of LyX.
16284 As I just mentioned, LyX forbids environments that begin with another environme
16286 To get around this, the
16290 environment isn't a paragraph environment as described in the
16298 \begin_layout Standard
16299 You should consider
16312 \begin_inset Quotes eld
16315 pseudo-environments.
16316 \begin_inset Quotes erd
16319 They look like a section heading or a
16320 \begin_inset Quotes eld
16328 \begin_inset Quotes erd
16331 but really begin a [and, if necessary, end the previous] paragraph environment.
16341 \begin_inset Quotes eld
16345 \begin_inset Quotes erd
16348 These two perform some action.
16351 \begin_layout Standard
16352 A common feature of all five environments,
16372 , is a rather long-ish label.
16373 The text following this label — ordinarily the contents of the paragraph
16374 environment — is utterly irrelevant for
16395 LyX completely ignores it.
16396 In fact, you can leave these five environments completely empty.
16400 \begin_layout Standard
16405 to put any text after the rather long-ish label, you might want to.
16406 This could be a short description of the contents of the
16411 In that case, enter your descriptive comment and hit
16415 as you normally would.
16418 \begin_layout Standard
16419 If, on the other hand, you don't want to enter any descriptive text, you'll
16420 hit another LyX quirk.
16421 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
16422 environment until you put something in the old one.
16426 \begin_layout Itemize
16427 Start entering the text that will
16455 \begin_layout Itemize
16456 Now move to the beginning of that paragraph.
16460 \begin_layout Itemize
16469 \begin_layout Itemize
16470 Finally, change this new, empty paragraph to a
16494 \begin_layout Standard
16495 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
16499 \begin_layout Subsection
16500 Making a Presentation with
16513 \begin_layout Subsubsection
16521 \begin_layout Standard
16522 If you're expecting this section to teach you how to actually make a presentatio
16523 n, you'll be sorely disappointed.
16524 Naturally, I'll describe all of the ways the
16528 class can assist you in preparing the materials for a presentation.
16529 Filling in the contents, however, is up to you.
16534 the LyX philosophy.]
16537 \begin_layout Standard
16542 environment [in the manner described in section
16543 \begin_inset space ~
16547 \begin_inset CommandInset ref
16549 reference "sec:slideQuirk"
16553 ] tells LyX to begin a new slide [duh].
16554 The label for this environment/
16555 \begin_inset Quotes erd
16559 \begin_inset Quotes erd
16563 \begin_inset Quotes eld
16567 \begin_inset Quotes erd
16570 in cool blue, followed by the label,
16571 \begin_inset Quotes eld
16575 \begin_inset Quotes erd
16579 Any text or paragraph environments that follow this one go on the new slide.
16583 \begin_layout Standard
16584 Slides are probably the only time you'll need to forcibly end pages in LyX
16585 (this can be specified in the
16590 In fact, you'll want to, once you finish entering the contents of one slide.
16591 If you've entered more text than can physically fit on a slide, the extra
16592 overflows onto a new slide.
16593 I don't recommend doing this, however, since the overflow slide won't have
16594 any page number on it.
16595 Furthermore, it may interfere with any
16599 you've made to accompany the oversized
16606 \begin_layout Standard
16615 environments work the same way as the
16620 They both create an
16621 \begin_inset Quotes eld
16625 \begin_inset Quotes erd
16628 followed by a label [
16629 \begin_inset Quotes eld
16633 \begin_inset Quotes erd
16637 \begin_inset Quotes eld
16641 \begin_inset Quotes erd
16645 The color is a stunning magenta instead of blue, and the
16646 \begin_inset Quotes eld
16650 \begin_inset Quotes erd
16653 will look different, in style and in length.
16654 The label fonts of all three also differ from one another.
16657 \begin_layout Standard
16662 , if the contents of a
16670 exceed the physical size of a slide or sheet of paper, the extra will overflow
16672 Again, you should avoid this.
16673 It defeats the whole purpose of
16684 \begin_layout Subsubsection
16694 \begin_layout Standard
16699 is a slide that sits atop another slide.
16700 Perhaps you wish to discuss a figure on the main
16704 before displaying the text associated with it.
16705 One way to accomplish this is tape a flap of dark paper over the part of
16710 you want to display later.
16711 This method fails, however, if you wish to overlap one graph with another,
16713 You would then have to fumble while speaking to align the two separate,
16718 s to align the two graphs.
16723 environment in both cases makes life much easier.
16726 \begin_layout Standard
16731 receives the page number of its
16732 \begin_inset Quotes eld
16736 \begin_inset Quotes erd
16744 \begin_inset Quotes eld
16752 \begin_inset Quotes erd
16759 \begin_layout Plain Layout
16760 Presumably, mutliple
16765 \begin_inset Quotes eld
16773 \begin_inset Quotes erd
16777 \begin_inset Quotes eld
16785 \begin_inset Quotes erd
16789 \begin_inset Quotes eld
16797 \begin_inset Quotes erd
16801 \begin_inset space ~
16804 appended to the page number of the parent
16814 Clearly, you want the contents of both the
16822 to each fit on a single physical slide! You should probably consider an
16828 \begin_inset Quotes eld
16832 \begin_inset Quotes erd
16844 class provides a visual cue for this: the label at the start of an
16848 is shorter than that at the start of a
16853 Lastly, when you generate printable output, you'll find alignment markers
16854 in all four corners of both the
16858 page and its parent
16863 These will assist you in lining up the two physical slides.
16866 \begin_layout Standard
16867 The major problem in overlaying two slides is aligning the contents of the
16868 two transparencies.
16869 How much space should you leave for that graph on the second slide? Worse
16870 still, what if you want a graph and a sentence on second slide, but there
16871 is text on the main transparency that goes in between them? You could try
16872 and insert vertical space of the right size.
16873 The better way is to use
16884 \begin_layout Standard
16885 As their names imply,
16893 are two command-like paragraph environments that make all subsequent text
16894 invisible and visible, respectively.
16896 \begin_inset space ~
16900 \begin_inset CommandInset ref
16902 reference "sec:slideQuirk"
16906 that you don't place anything
16910 these two environments, however.
16915 , it inserts a centered, sky-blue label into the page reading
16916 \begin_inset Quotes eld
16919 <Invisible Text Follows>
16920 \begin_inset Quotes erd
16924 For paragraphs following this label, the parts of the
16932 ; it doesn't matter which] where they would be contain instead blank space.
16936 \begin_layout Standard
16941 , the corresponding centered label is
16942 \begin_inset Quotes eld
16945 <Visible Text Follows>
16946 \begin_inset Quotes erd
16950 Paragraphs following this label behave normally.
16951 Note that the beginning of a new
16963 automatically shuts off an
16968 It's therefore not necessary to use
16979 \begin_layout Standard
16980 By now, it should be obvious how to create overlay transparencies using
16981 the proper combination of
17000 \begin_layout Enumerate
17005 , including everything that will appear on it, whether on the main slide
17013 \begin_layout Enumerate
17014 Before each figure or paragraph that will appear only on the
17023 If necessary, insert a
17027 environment after the
17034 \begin_layout Enumerate
17039 immediately following the
17046 \begin_layout Enumerate
17047 Copy the contents of this
17058 \begin_layout Enumerate
17063 , change all of the
17074 \begin_layout Standard
17076 You've just made an
17083 \begin_layout Standard
17084 There's one problem with the way I've designed the LyX
17088 class: you can't make text in the middle of a paragraph invisible, nor
17089 make text in the middle of an invisible paragraph visible again.
17090 To accomplish this feat, you'll need to use some inlined LaTeX codes.
17094 \begin_layout Plain Layout
17095 The commands of interest are:
17098 \begin_layout Itemize
17103 invisible \SpecialChar \ldots{}
17107 \begin_layout Itemize
17112 visible \SpecialChar \ldots{}
17116 \begin_layout Plain Layout
17117 \SpecialChar \ldots{}
17118 and need to be marked as TeX.
17120 \begin_inset Quotes eld
17124 \begin_inset Quotes erd
17127 you wish to change goes in between the brackets [and after the
17140 If you don't know how to mark text as TeX, see the appropriate section
17153 \begin_layout Subsubsection
17163 \begin_inset CommandInset label
17165 name "sec:slideNote"
17172 \begin_layout Standard
17181 is associated with a
17182 \begin_inset Quotes eld
17186 \begin_inset Quotes erd
17198 class provides visual cues.
17203 is shorter than that of a
17207 [yet longer than that of an
17211 ] and, like the label of an
17215 is shockingly magenta.
17216 Additionally, the printed
17220 has the page number of its
17221 \begin_inset Quotes eld
17225 \begin_inset Quotes erd
17233 \begin_inset Quotes eld
17241 \begin_inset Quotes erd
17245 \begin_inset Quotes eld
17253 \begin_inset Quotes erd
17257 \begin_inset Quotes eld
17265 \begin_inset Quotes erd
17269 You can have multiple
17273 s associated with a single
17285 , you'll probably want to break up long
17289 s so that they fit on a single sheet of paper.
17292 \begin_layout Standard
17297 is obvious: it contains anything additional you might want to say about
17303 It could also be used as a sheet of reminders for a particular
17308 In the case of the latter, you might want to make use of time markers.
17314 \begin_inset Quotes eld
17318 \begin_inset Quotes erd
17321 support for time markers, a
17326 So, you'll have to resort to using the LaTeX codes.
17329 \begin_layout Standard
17330 To use time markers, you'll need to specify the extra class option
17331 \begin_inset Quotes eld
17339 \begin_inset Quotes erd
17343 \begin_inset space ~
17347 \begin_inset CommandInset ref
17349 reference "sec:slidesetup"
17354 This option turns on timing marks, which will appear in the lower-left-hand
17360 To set what appears in the time marker, you use the LaTeX commands
17361 \begin_inset Quotes eld
17371 \begin_inset Quotes erd
17375 \begin_inset Quotes eld
17385 \begin_inset Quotes erd
17389 The arguments of both commands are time measured in seconds.
17391 \begin_inset Quotes eld
17401 \begin_inset Quotes erd
17404 sets the time marker to a given time.
17406 \begin_inset Quotes eld
17416 \begin_inset Quotes erd
17419 increments the time marker by the specified amount.
17420 Using time markers and
17424 s in this fashion, you can remind yourself how much time to spend on a particula
17432 \begin_layout Standard
17433 There's one last feature to describe.
17434 Clearly, you'd like to print out all of your
17442 s on transparencies while printing all of your
17459 with which it is associated.
17460 What's a person to do?
17463 \begin_layout Standard
17464 Luckily, there are two LaTeX commands that allow you to select what to print
17466 Both must be placed into the preamble of your document.
17468 \begin_inset Quotes eld
17480 \begin_inset Quotes erd
17483 will cause the output to contain only the
17492 Correspondingly, the command
17493 \begin_inset Quotes eld
17505 \begin_inset Quotes erd
17508 prevents the output of anything but
17513 I'd advise placing both commands in the preamble and initially comment
17515 You can then preview your entire presentation as you write.
17516 When you're done writing, you can then uncomment one of the two to select
17517 what you want to print.
17518 I like to uncomment
17519 \begin_inset Quotes eld
17531 \begin_inset Quotes erd
17534 , print to a file with
17535 \begin_inset Quotes eld
17543 \begin_inset Quotes erd
17546 in its name, comment it back out, then uncomment
17547 \begin_inset Quotes eld
17559 \begin_inset Quotes erd
17563 \begin_inset Quotes eld
17571 \begin_inset Quotes erd
17575 I can then send either file to a printer, loading transparencies or plain
17576 paper as appropriate.
17579 \begin_layout Standard
17580 You can also provide other arguments to the
17581 \begin_inset Quotes eld
17591 \begin_inset Quotes erd
17595 \begin_inset Quotes eld
17605 \begin_inset Quotes erd
17609 See a good LaTeX book for details.
17612 \begin_layout Subsection
17617 Class Template File
17620 \begin_layout Standard
17621 I have also provided a template file,
17622 \begin_inset Quotes eld
17630 \begin_inset Quotes erd
17638 To use it, begin your new presentation with
17643 ile\SpecialChar \menuseparator
17645 \begin_inset space ~
17649 \begin_inset space ~
17659 Your new LyX presentation file will contain an example
17680 additionally contain an example of the use of
17689 Lastly, the preamble will contain:
17692 \begin_layout LyX-Code
17693 % Uncomment to print out only slides and overlays
17696 \begin_layout LyX-Code
17700 \begin_layout LyX-Code
17706 \begin_inset Newline newline
17712 \begin_layout LyX-Code
17713 % Uncomment to print out only notes
17716 \begin_layout LyX-Code
17720 \begin_layout LyX-Code
17728 \begin_layout Standard
17729 One final thing: I created this class to support the LaTeX2e
17730 \begin_inset Quotes eld
17738 \begin_inset Quotes erd
17741 class, one of the built-in LaTeX2e classes.
17742 Neither I nor the rest of the LyX Team endorse or oppose the use of this
17743 built-in slide class.
17744 It's here if you want it or need it.
17745 There exist other LaTeX2e classes for creating presentations, such as the
17751 \begin_inset space ~
17755 \begin_inset CommandInset ref
17757 reference "sec:foiltex"
17762 \begin_inset Quotes eld
17770 \begin_inset Quotes erd
17773 package [present on some TeX distributions].
17774 The latter is not yet supported under LyX.
17778 \begin_layout Plain Layout
17779 Perhaps you can take on the task\SpecialChar \ldots{}
17785 I know nothing about these other classes.
17786 Try them out to see what sort of alternative they provide.
17789 \begin_layout Chapter
17790 LyX Features needing Extra Software
17793 \begin_layout Section
17797 \begin_layout Standard
17803 \begin_layout Subsection
17807 \begin_layout Standard
17816 \begin_layout Plain Layout
17821 is not yet available when you are using the LaTeX distribution MiKTeX.
17826 , you'll find in the
17833 \begin_inset space ~
17844 \begin_inset CommandInset href
17846 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
17853 \begin_layout Standard
17858 package is a program that was written by
17859 \begin_inset Flex Noun
17862 \begin_layout Plain Layout
17864 \begin_inset space ~
17872 in frustration because some constructs in LaTeX are sometimes non-intuitive,
17873 and easy to forget.
17874 The program runs over your LaTeX file, checks the integrity of the file,
17875 and flags some common errors.
17876 In other technical words, it is
17883 \begin_layout Standard
17884 Well, what is a syntax checker doing in LyX which is supposed to produce
17885 correct LaTeX anyways? The answer is simple: Just as
17889 not only checks the
17893 of C programs, but also does
17897 checks for type-errors,
17901 catches some common
17905 errors, in addition to the syntactical ones.
17910 is capable of detecting several common errors, such as
17913 \begin_layout Itemize
17914 Ellipsis detection:
17915 \begin_inset Newline newline
17918 Use \SpecialChar \ldots{}
17922 \begin_layout Itemize
17923 No space in front of/after parenthesis:
17924 \begin_inset Newline newline
17930 \begin_layout Itemize
17931 Enforcement of normal space after common abbreviations:
17932 \begin_inset Newline newline
17936 \begin_inset space \thinspace{}
17940 \begin_inset space \space{}
17943 is too wide spacing.
17946 \begin_layout Itemize
17947 Enforcement of end-of-sentence space when the last sentence ends with a
17949 \begin_inset Newline newline
17953 And this is wrong spacing.
17956 \begin_layout Itemize
17957 Space in front of labels and similar commands:
17958 \begin_inset Newline newline
17961 The label should stick right up to the text to avoid falling to a wrong
17964 \begin_inset CommandInset label
17974 \begin_layout Plain Layout
17975 This footnote is in danger of falling off to a wrong page
17980 The label is separated too much.
17983 \begin_layout Itemize
17984 Space in front of references, instead of hard spaces:
17985 \begin_inset Newline newline
17988 If you have bad luck, the text will break right between the referenced text
17989 and reference number, and that's a pity.
17991 \begin_inset CommandInset ref
17993 reference "sec:chktex"
18000 \begin_layout Itemize
18002 \begin_inset Quotes eld
18006 \begin_inset Quotes erd
18010 \begin_inset Formula $\times$
18014 \begin_inset Newline newline
18017 2x2 looks cheap compared to
18018 \begin_inset Formula $2\times2$
18024 \begin_layout Standard
18025 and more \SpecialChar \ldots{}
18026 It is an invaluable tool when you are
18027 \begin_inset Quotes eld
18031 \begin_inset Quotes erd
18034 your document before printing, and you should run it right after the obligatory
18035 spelling check, and before you go fine tuning the typesetting.
18038 \begin_layout Subsection
18042 \begin_layout Standard
18043 If you have the program installed, usage is as simple as choosing
18045 Tools\SpecialChar \menuseparator
18047 \begin_inset space ~
18053 This will make LyX generate a LaTeX file of your document, start
18057 to check it, and then make LyX insert
18058 \begin_inset Quotes eld
18062 \begin_inset Quotes erd
18065 with the warnings from
18069 , if there were any.
18070 The warnings will be placed close to the point of the mistake, and you
18071 can quickly find them by using the
18073 Navigate\SpecialChar \menuseparator
18076 menu item, or the shortcut key
18085 Open the error boxes by clicking on them with the mouse, or use the shortcut
18094 bindings, or the corresponding
18103 Read the warning and correct the mistake, if it is a mistake.
18104 If you have trouble understanding what the warning is about, you can safely
18106 Remember that there is a hidden layer between the document on screen and
18107 the technical details in invoking
18111 , and this gap can make some warnings seem arcane or just plain silly.
18114 \begin_layout Standard
18115 This document is an excellent testing bed for the feature, and it should
18116 provide quite a few warnings for you to fiddle with.
18117 Since computers are only so smart, expect most of the warnings to be false
18121 \begin_layout Subsection
18122 How to fine tune it
18125 \begin_layout Standard
18126 Sometimes, you'll find that
18130 makes more noise than suits your mood.
18131 Then you can choose not to use it, wait until your mood changes, or try
18136 to get better along with you.
18139 \begin_layout Standard
18148 very configurable and extensible, you shouldn't expect to solve all problems
18154 Since LyX has to generate a somewhat special LaTeX file to be able to match
18155 the line numbers from the
18163 \begin_layout Plain Layout
18164 You can inspect the specific output from
18170 Edit\SpecialChar \menuseparator
18172 \begin_inset space ~
18176 \begin_inset space ~
18190 to the internal document structure, some of the warnings will not appear
18192 There are two things you can do about this:
18195 \begin_layout Itemize
18200 invocation command line in
18201 \begin_inset Flex MenuItem
18204 \begin_layout Plain Layout
18205 Tools\SpecialChar \menuseparator
18206 Preferences\SpecialChar \menuseparator
18207 Output\SpecialChar \menuseparator
18208 LaTeX\SpecialChar \menuseparator
18218 installation configuration file (usually with the file
18223 See below to learn what warnings can be enabled and disabled on the command
18227 \begin_layout Itemize
18228 Export your document as a raw LaTeX file using
18230 File\SpecialChar \menuseparator
18231 Export\SpecialChar \menuseparator
18239 Invoked in this way, it can be a hassle to find the corresponding place
18240 in the document inside LyX, but with a little patience, you should be able
18244 \begin_layout Standard
18245 Here follows the warning messages that can be enabled and disabled in
18254 to disable a warning, and
18258 to enable a warning.
18259 The emphasized entries are disabled by default, because the default is
18262 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
18267 \begin_layout Standard
18268 Notice that you should only use the options that enable and disable warnings,
18269 because LyX relies on some of the other command line parameters to be set
18270 in a specific way to have a chance to communicate with
18277 \begin_layout Enumerate
18281 Command terminated with space.
18284 \begin_layout Enumerate
18287 Non-breaking space (
18288 \begin_inset Quotes eld
18296 \begin_inset Quotes erd
18299 ) should have been used.
18302 \begin_layout Enumerate
18306 You should enclose the previous parenthesis with
18307 \begin_inset Quotes eld
18315 \begin_inset Quotes erd
18321 \begin_layout Enumerate
18324 Italic correction (
18325 \begin_inset Quotes eld
18335 \begin_inset Quotes erd
18338 ) found in non-italic buffer.
18341 \begin_layout Enumerate
18344 Italic correction (
18345 \begin_inset Quotes eld
18355 \begin_inset Quotes erd
18358 ) found more than once.
18361 \begin_layout Enumerate
18365 No italic correction (
18366 \begin_inset Quotes eld
18376 \begin_inset Quotes erd
18382 \begin_layout Enumerate
18386 \begin_inset Quotes eld
18394 \begin_inset Quotes erd
18398 \begin_inset Quotes eld
18406 \begin_inset Quotes erd
18412 \begin_layout Enumerate
18415 Wrong length of dash may have been used.
18418 \begin_layout Enumerate
18422 \begin_inset Quotes eld
18430 \begin_inset Quotes erd
18434 \begin_inset Quotes eld
18442 \begin_inset Quotes erd
18448 \begin_layout Enumerate
18452 \begin_inset Quotes eld
18460 \begin_inset Quotes erd
18466 \begin_layout Enumerate
18470 \begin_inset Quotes eld
18478 \begin_inset Quotes erd
18481 to achieve an ellipsis.
18484 \begin_layout Enumerate
18487 Inter-word spacing (
18488 \begin_inset Quotes eld
18498 \begin_inset Quotes eld
18501 ) should perhaps be used.
18504 \begin_layout Enumerate
18507 Inter-sentence spacing (
18508 \begin_inset Quotes eld
18518 \begin_inset Quotes erd
18521 ) should perhaps be used.
18524 \begin_layout Enumerate
18527 Could not find argument for command.
18530 \begin_layout Enumerate
18534 \begin_inset Quotes eld
18542 \begin_inset Quotes erd
18548 \begin_layout Enumerate
18551 Math mode still on at end of LaTeX file.
18554 \begin_layout Enumerate
18558 \begin_inset Quotes eld
18566 \begin_inset Quotes erd
18569 doesn't match the number of
18570 \begin_inset Quotes eld
18578 \begin_inset Quotes erd
18584 \begin_layout Enumerate
18587 You should use either
18590 \begin_inset Quotes eld
18598 \begin_inset Quotes erd
18603 as an alternative to
18604 \begin_inset Quotes eld
18612 \begin_inset Quotes erd
18618 \begin_layout Enumerate
18625 " (ASCII 39) instead of "
18632 \begin_layout Enumerate
18635 User-specified pattern found.
18638 \begin_layout Enumerate
18641 This command might not be intended.
18644 \begin_layout Enumerate
18651 \begin_layout Enumerate
18669 \begin_layout Enumerate
18672 Delete this space to maintain correct page references.
18675 \begin_layout Enumerate
18679 You might wish to put this between a pair of
18680 \begin_inset Quotes eld
18688 \begin_inset Quotes erd
18694 \begin_layout Enumerate
18697 You ought to remove spaces in front of punctuation.
18700 \begin_layout Enumerate
18703 Could not execute LaTeX command.
18706 \begin_layout Enumerate
18715 in front of small punctuation.
18718 \begin_layout Enumerate
18726 may look prettier here.
18729 \begin_layout Enumerate
18733 Multiple spaces detected in output.
18736 \begin_layout Enumerate
18739 This text may be ignored.
18742 \begin_layout Enumerate
18748 \begin_inset Quotes eld
18753 to begin quotation, not
18760 \begin_layout Enumerate
18767 to end quotation, not
18770 \begin_inset Quotes eld
18778 \begin_layout Enumerate
18784 \begin_layout Enumerate
18787 You should perhaps use
18788 \begin_inset Quotes eld
18796 \begin_inset Quotes erd
18802 \begin_layout Enumerate
18805 You should put a space in front of/after parenthesis.
18808 \begin_layout Enumerate
18811 You should avoid spaces in front of/after parenthesis.
18814 \begin_layout Enumerate
18818 You should not use punctuation in front of/after quotes.
18821 \begin_layout Enumerate
18824 Double space found.
18827 \begin_layout Enumerate
18830 You should put punctuation outside inner/inside display math mode.
18833 \begin_layout Enumerate
18836 You ought to not use primitive TeX in LaTeX code.
18839 \begin_layout Enumerate
18842 You should remove spaces in front of
18843 \begin_inset Quotes eld
18851 \begin_inset Quotes erd
18857 \begin_layout Enumerate
18860 \begin_inset Quotes eld
18868 \begin_inset Quotes erd
18871 is normally not followed by
18872 \begin_inset Quotes eld
18880 \begin_inset Quotes erd
18886 \begin_layout Standard
18887 In later versions of LyX, we hope to provide a more complete interface to
18888 this tool (and it's smaller cousin
18892 ) to exploit the full power of it.
18893 But it's not exactly useless as it is now: go try it on one of your existing
18894 documents of a certain length and be surprised.
18897 \begin_layout Section
18898 Version Control in LyX
18901 \begin_layout Standard
18904 Lars Gullik Bjønnes
18911 \begin_layout Subsection
18915 \begin_layout Standard
18916 LyX supports some of the most basic RCS/CVS/SVN commands.
18917 If you need something a bit more sophisticated you will have to do that
18918 manually in a terminal.
18921 \begin_layout Standard
18922 Also note that CVS support is not as good as subversion support so we advise
18924 A good place to start learning Subversion is SVN Book
18928 \begin_layout Plain Layout
18929 \begin_inset CommandInset href
18931 target "http://svnbook.red-bean.com/"
18941 In the case of RCS you should read
18942 \begin_inset Quotes eld
18946 \begin_inset Quotes erd
18949 (a man file, read it with
18954 This file describes all the basic features of RCS.
18955 You should especially notice the comment about a RCS directory, and the
18956 notion of a master RCS file (the file ending in
18963 \begin_layout Standard
18964 Before you begin to use the version control features in LyX, you should
18965 be familiar with RCS/CVS/SVN usage.
18966 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
18967 package—no guarantees are made for older versions.
18968 Most of the log messages are not currently displayed after operations —
18969 you can check them in the Messages pane if unsure.
18970 Regular users of version control will appreciate VC toolbar, which can
18973 View\SpecialChar \menuseparator
18974 Toolbars\SpecialChar \menuseparator
18976 \begin_inset space ~
18984 \begin_layout Standard
18985 For introducing your own external commands consult vc-command in the manual
18989 \begin_layout Subsection
18990 RCS commands in LyX
18993 \begin_layout Standard
18994 The following sections describe the RCS commands supported by LyX.
18995 You can find them in the
18997 File\SpecialChar \menuseparator
18999 \begin_inset space ~
19005 LyX was tested against RCS 5.7/5.8
19009 \begin_layout Plain Layout
19010 Note that old DOS / MS Windows builds (5.7) need to setup environment variables
19011 in order to work properly with LyX.
19012 In particular time zone (TZ) should be set and more importantly RCSINIT
19013 in order to change default archive location ("SET RCSINIT=-x,v/") --- LyX
19014 expects archive to be found in file.lyx,v within the original document directory.
19015 See also README shipped with Windows RCS binaries.
19023 \begin_layout Subsubsection
19029 \begin_layout Standard
19030 If your document is not under revision control, this is the only item shown
19032 And if it is under revision control, the
19036 item is not visible.
19040 \begin_layout Standard
19041 This command registers your document with RCS (unless you are under the
19042 directory managed by CVS)\SpecialChar \@.
19043 You are asked interactively to supply an initial
19044 description of the document.
19045 The document is now set in Read-Only mode and you have to
19048 \begin_inset space ~
19052 \begin_inset space ~
19056 \begin_inset space ~
19061 , before making any changes to it.
19062 A document under revision control has a
19063 \begin_inset Quotes eld
19066 [RCS:<version> <locker>]
19067 \begin_inset Quotes erd
19070 item tagged to the filename in the minibuffer.
19073 \begin_layout Standard
19074 RCS command that is run:
19076 ci -q -u -i -t-"<initial description>" <file-name>
19079 \begin_layout Standard
19084 to understand the switches.
19088 \begin_layout Subsubsection
19094 \begin_layout Standard
19095 When you are finished editing a file, you check in your changes.
19096 When you do this, you are asked for a description of the changes.
19097 This is stored in the history log.
19098 The version number is bumped, your changes are applied to the master RCS
19099 file, the document is unlocked and set to Read-Only mode.
19103 \begin_layout Standard
19106 ci -q -u -m"<description>" <file-name>
19109 \begin_layout Subsubsection
19115 \begin_layout Standard
19116 By doing this you lock the document so that only you can edit it.
19117 This will also make the document Read-Write only for you.
19118 You will usually continue editing for a while and when you are finished
19119 you check in your changes.
19120 The status line is changed to reflect that you have locked the file.
19124 \begin_layout Standard
19127 co -q -l <file-name>
19130 \begin_layout Subsubsection
19133 Revert To Repository Version
19136 \begin_layout Standard
19137 This will discard all changes made to the document since the last check
19139 You get a warning before changes are discarded.
19142 \begin_layout Standard
19145 co -f -u<version> <file-name>
19148 \begin_layout Subsubsection
19154 \begin_layout Standard
19155 This makes as if the last check in never happened.
19156 No changes are made to the document loaded into LyX, but the last version
19157 is removed from the master RCS file.
19161 \begin_layout Standard
19164 rcs -o<version> <file-name>
19167 \begin_layout Subsubsection
19173 \begin_layout Standard
19174 This shows the complete history of the RCS document.
19179 is shown in a browser.
19187 \begin_layout Subsubsection
19191 \begin_layout Standard
19192 LyX supports RCS version number, author name, date and time of last commit.
19193 All those are extracted from
19195 rlog -r <file-name>
19198 For other details see
19199 \begin_inset CommandInset ref
19201 reference "sub:VCS-Revision-Information"
19208 \begin_layout Subsection
19209 CVS commands in LyX
19212 \begin_layout Standard
19213 A subset of CVS operations is supported by LyX.
19214 You can find the commands in the
19216 File\SpecialChar \menuseparator
19218 \begin_inset space ~
19224 The version control system SVN is more powerful, so please use it instead
19225 of CVS if possible.
19228 \begin_layout Subsubsection
19234 \begin_layout Standard
19235 If you start from scratch with CVS you have to create your repository and
19236 checkout the working copy with external tools.
19237 If you're using a client-server setup you may need to login before doing
19238 the first repository checkout.
19241 \begin_layout Standard
19242 If your documents are under revision control and others are using the same
19243 repository problems arise when different changes to the same document at
19244 the same location happen.
19245 Standard CVS repositories doesn't operate with a file locking mechanism.
19246 This may be surprising, but conflicts only occur if people disagree on
19247 the proper content of the same part of a document.
19248 So, if co-workers are used to communicate regularly, these conflicts occur
19250 If they don't communicate they have a fundamental problem anyway.
19251 Nevertheless some people like to work with so called
19252 \begin_inset Quotes eld
19256 \begin_inset Quotes erd
19260 If they do so the working copy of all files is readonly when checked out
19261 first and the user starts editing after using a special command to make
19262 the working copy writable.
19263 When the changes are checked in the working copy returns to readonly state.
19264 With LyX one has to edit the
19265 \begin_inset Flex Code
19268 \begin_layout Plain Layout
19274 file and add the line
19275 \begin_inset Flex Code
19278 \begin_layout Plain Layout
19284 to work with reserved checkouts.
19285 The benefit is the possibility to see who is using a writable copy of some
19287 It's not guaranteed only one user makes a copy writable.
19290 \begin_layout Standard
19291 LyX tries to guess if you're using reserved or non-reserved checkouts.
19292 If your working copy is readonly or it is writable and an additional copy
19293 of your document exists in the CVS/Base sub-directory a reserved otherwise
19294 a non-reserved checkout is assumed.
19295 When a reserved checkout is detected you have to use
19296 \begin_inset Flex MenuItem
19299 \begin_layout Plain Layout
19305 to make your working copy writable if it's readonly.
19307 \begin_inset Flex MenuItem
19310 \begin_layout Plain Layout
19316 operation is possible and that makes your working copy readonly again after
19317 transferring your changes to the repository.
19320 \begin_layout Standard
19321 More information about CVS can be found here
19322 \begin_inset Flex URL
19325 \begin_layout Plain Layout
19327 http://www.nongnu.org/cvs
19333 \begin_inset Flex URL
19336 \begin_layout Plain Layout
19338 http://ximbiot.com/cvs
19346 \begin_layout Standard
19351 to understand the sub-commands and the switches mentioned below.
19354 \begin_layout Subsubsection
19360 \begin_layout Standard
19361 If your document is not under revision control, this is the only item shown
19363 And if it is under revision control, the
19370 item is not visible.
19374 \begin_layout Standard
19375 This command registers in CVS your document
19376 \begin_inset Flex Strong
19379 \begin_layout Plain Layout
19387 in the case you have already the documents directory under CVS control
19393 This means you have to create or checkout the archive by yourself using
19395 (In case you forget that step LyX registers the document with RCS.)
19398 \begin_layout Standard
19399 Then you are asked interactively to supply an initial description of the
19401 Don't forget that registered file is not yet checked in.
19404 \begin_layout Standard
19405 CVS command that is run:
19407 cvs -q add -m"<entered message>" "<file-name>"
19410 \begin_layout Standard
19415 above and for all other CVS commands is an abbreviation for
19416 \begin_inset Quotes eld
19419 change the current working directory to file location and use the file name
19420 without path component as argument
19421 \begin_inset Quotes erd
19427 \begin_layout Subsubsection
19433 \begin_layout Standard
19434 When you are finished editing a file, you commit your changes.
19435 When you do this and you had changed the document, you are asked for a
19436 description of the changes.
19437 After that changes are written to the repository.
19438 In case you didn't change the document and a reserved checkout is detected
19439 the reservation made on
19440 \begin_inset Flex MenuItem
19443 \begin_layout Plain Layout
19452 \begin_layout Labeling
19453 \labelwidthstring 00.00.0000
19455 \begin_inset space ~
19459 \begin_inset space ~
19463 \begin_inset Newline newline
19467 \begin_inset Flex Code
19470 \begin_layout Plain Layout
19473 -q commit -m"<description>" "<file-name>"
19479 \begin_inset Newline newline
19483 \begin_inset Flex Code
19486 \begin_layout Plain Layout
19497 \begin_layout Subsubsection
19503 \begin_layout Standard
19504 When you are sharing a repository with others, you may have to incorporate
19505 their changes into your working copy.
19508 \begin_layout Standard
19511 cvs -q update "<file-name>"
19514 \begin_layout Standard
19515 If a readonly checkout is detected the working copy is made writable and
19519 \begin_layout Standard
19522 cvs -q edit "<file-name>"
19525 \begin_layout Subsubsection
19528 Revert To Repository Version
19531 \begin_layout Standard
19532 This will discard all changes made to the document since the last check
19534 You get a warning before changes are discarded.
19535 Firstly the file is deleted, secondly CVS update command is run.
19538 \begin_layout Standard
19541 cvs -q update "<file-name>"
19544 \begin_layout Standard
19545 If a reserved checkout is detected and the working copy has no changes only
19546 the reservation is undone.
19549 \begin_layout Standard
19552 cvs -q unedit "<file-name>"
19555 \begin_layout Subsubsection
19556 Update of the local directory checkout from repository
19559 \begin_layout Standard
19560 Once your documents gets more complex, containing sub-documents and pictures,
19562 \begin_inset Flex Code
19565 \begin_layout Plain Layout
19571 files and so on using version control becomes more complicated.
19572 LyX supports updating the whole tree in which resides the document.
19573 This become especially useful once you cooperate with people which neither
19574 have detailed knowledge about CVS usage nor they have ambition to commit
19575 additional material to the repository.
19576 You have to organize the files structure so that all external files are
19577 in the same directory or subdirectories of the document.
19578 It's good practice anyway to store multipart documents in an extra directory.
19581 \begin_layout Standard
19583 \begin_inset Flex Code
19586 \begin_layout Plain Layout
19587 Update local directory from repository
19592 command updates the whole directory.
19593 If local changes are detected user is warned before update starts.
19594 In case of merge conflicts both versions of the conflicting document parts
19595 are placed in the final document.
19596 You have to review and correct the result of the merge.
19597 You'll find the conflicts enclosed in pairs of
19598 \begin_inset Flex Code
19601 \begin_layout Plain Layout
19608 \begin_inset Flex Code
19611 \begin_layout Plain Layout
19618 \begin_inset Flex Code
19621 \begin_layout Plain Layout
19628 The first part is your version as before the update operation with the
19629 document name prepended.
19630 The second one is the repository version with the version number after
19632 \begin_inset Flex Code
19635 \begin_layout Plain Layout
19644 \begin_layout Labeling
19645 \labelwidthstring 00.00.0000
19647 \begin_inset space ~
19651 \begin_inset space ~
19655 \begin_inset Newline newline
19659 \begin_inset Flex Code
19662 \begin_layout Plain Layout
19670 (Ask if changes are detected.)
19671 \begin_inset Newline newline
19675 \begin_inset Flex Code
19678 \begin_layout Plain Layout
19679 cd $path; cvs -q update
19689 \begin_layout Standard
19691 \begin_inset Flex Code
19694 \begin_layout Plain Layout
19700 stands for the path to the document.
19703 \begin_layout Subsubsection
19709 \begin_layout Standard
19710 This shows the complete history of the CVS document.
19713 cvs log "<file-name>"
19715 is shown in a browser.
19718 \begin_layout Subsection
19719 SVN commands in LyX
19722 \begin_layout Standard
19723 SVN is now partially supported by LyX.
19724 You can find the commands in the
19726 File\SpecialChar \menuseparator
19728 \begin_inset space ~
19734 Please note that if you use password protected access to repository via
19735 ssh, you will be asked in terminal window.
19736 LyX was tested against SVN 1.5 and 1.6
19740 \begin_layout Plain Layout
19741 Most of the commands will work with 1.4 too, see
19742 \begin_inset CommandInset ref
19744 reference "sub:SVN-Repo-Update"
19756 \begin_layout Subsubsection
19762 \begin_layout Standard
19763 If your document is not under revision control, this is the only item shown
19765 And if it is under revision control, the
19772 item is not visible.
19776 \begin_layout Standard
19777 This command registers in SVN your document ONLY in case you have already
19778 the documents directory under SVN control (in particular
19783 This means you have to checkout the archive by yourself.
19787 \begin_layout Standard
19788 Then you are asked interactively to supply an initial description of the
19790 Don't forget that registered file is not yet commited.
19793 \begin_layout Standard
19794 SVN command that is run:
19797 \begin_inset Quotes eld
19801 \begin_inset Quotes erd
19807 \begin_layout Standard
19812 to understand the switches.
19816 \begin_layout Subsubsection
19822 \begin_layout Standard
19823 When you are finished editing a file, you commit your changes.
19824 When you do this, you are asked for a description of the changes.
19825 After that changes are commited.
19828 \begin_layout Standard
19833 \begin_layout Plain Layout
19834 In case locking is not enabled.
19836 \begin_inset CommandInset ref
19838 reference "subsec:SVN-File-Locking"
19849 svn commit -q -m"<description>" <file-name>
19852 \begin_layout Subsubsection
19858 \begin_layout Standard
19859 Updates the changes of this file from the repository.
19860 Be sure you understand SVN merging and conflicts resolving before using
19861 this function, because all conflicts has to be resolved manually by you!
19864 \begin_layout Standard
19869 \begin_layout Plain Layout
19877 svn update --non-interactive
19878 \begin_inset Quotes eld
19882 \begin_inset Quotes erd
19888 \begin_layout Subsubsection
19891 Revert To Repository Version
19894 \begin_layout Standard
19895 This will discard all changes made to the document since the last check
19897 You get a warning before changes are discarded.
19901 \begin_layout Standard
19905 \begin_inset Quotes eld
19909 \begin_inset Quotes erd
19915 \begin_layout Subsubsection
19916 \begin_inset CommandInset label
19918 name "sub:SVN-Repo-Update"
19922 Update of the local directory checkout from repository
19926 \begin_layout Plain Layout
19927 Note that this command will work only with subversion
19928 \begin_inset Formula $\geqq1.5$
19939 \begin_layout Standard
19940 All the commands above have one shortcomming - they deal with the current
19942 Once your document contains pictures, includes external
19943 \begin_inset Flex Code
19946 \begin_layout Plain Layout
19952 files and so on administration becomes more complicated.
19953 LyX now supports updating the whole tree in which resides the document
19957 \begin_layout Plain Layout
19958 One need to organize the files structure so that all external files are
19959 in the same directory or subdirectories of the document.
19966 This become especially useful once you cooperate with people which neither
19967 know about subversion management nor they have ambition to commit additional
19968 material to the repository.
19972 \begin_layout Standard
19973 \begin_inset Flex Code
19976 \begin_layout Plain Layout
19977 Update local directory from repository
19982 command updates the whole directory and in case of merge conflicts local
19983 version of the files are left, so no unintended data loss occurs.
19984 If local changes are detected user is warned before update starts.
19987 \begin_layout Labeling
19988 \labelwidthstring 00.00.0000
19990 \begin_inset space ~
19994 \begin_inset space ~
19998 \begin_inset Newline newline
20002 \begin_inset Flex Code
20005 \begin_layout Plain Layout
20011 (Ask if changes are detected.)
20012 \begin_inset Newline newline
20016 \begin_inset Flex Code
20019 \begin_layout Plain Layout
20020 svn update --accept mine-full $path
20028 \begin_layout Standard
20030 \begin_inset Flex Code
20033 \begin_layout Plain Layout
20039 stands for the path to the document.
20042 \begin_layout Subsubsection
20048 \begin_layout Standard
20049 This shows the complete history of the SVN document.
20053 \begin_inset Quotes eld
20057 \begin_inset Quotes erd
20062 is shown in a browser.
20065 \begin_layout Subsubsection
20067 \begin_inset CommandInset label
20069 name "subsec:SVN-File-Locking"
20076 \begin_layout Standard
20077 The file exchange through various revision control systems brings the problem
20078 of merge conflicts in case two different users try to edit the same (parts
20080 When such a conflict happens it needs manual resolving and one reasonable
20081 alternative is to provide some kind of locking mechanism, which guarantees
20082 that only one user is allowed to edit file at the given time.
20085 \begin_layout Standard
20086 SVN has two such mechanisms to provide mutual exclusivity for file access
20087 - locks and automatic setting of write permissions (see sec.
20089 \begin_inset CommandInset ref
20091 reference "subsec:Automatical-Locking-Property"
20096 \begin_inset Flex Code
20099 \begin_layout Plain Layout
20109 \begin_layout Plain Layout
20110 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
20116 If this property is detected for a given document LyX starts to use SVN
20117 locks for document editing automatically and the whole check-in/out mechanism
20118 switches to the same regimen as for RCS.
20119 This in particular means there are two different modes of file use in LyX:
20122 \begin_layout Itemize
20124 The loaded file is in the read-only mode.
20125 For editing on needs to check-out.
20130 consists of updating from the repository and gaining write lock.
20131 If the lock is not possible to obtain, we remain in unlocked state.
20134 \begin_layout Itemize
20136 The loaded file is in the 'normal' edit mode.
20137 No other user is allowed to edit the file.
20142 consists of commiting changes and releasing write-lock.
20143 If no changes have been made to the document, no commit will be produced
20147 \begin_layout Plain Layout
20148 Don't be puzzled by the fact that you will be asked for commit message anyway.
20153 and only the write-lock will be released.
20156 \begin_layout Standard
20160 \begin_layout Labeling
20161 \labelwidthstring 00.00.0000
20164 svn commit -q -m"<description>" "<file-name>"
20165 \begin_inset Newline newline
20168 svn unlock "<file-name>"
20171 \begin_layout Labeling
20172 \labelwidthstring 00.00.0000
20175 svn update "<file-name>"
20176 \begin_inset Newline newline
20179 svn lock "<file-name>"
20182 \begin_layout Subsubsection
20185 \begin_inset CommandInset label
20187 name "subsec:Automatical-Locking-Property"
20193 Automatic Locking Property
20196 \begin_layout Standard
20197 The above mentioned automatic setting of write permissions of the .lyx file
20203 ile\SpecialChar \menuseparator
20209 \begin_inset space ~
20212 Control\SpecialChar \menuseparator
20217 oggle locking property
20220 This command is active only when the file is not locked on the svn server
20222 you need to check-out before proceeding).
20225 \begin_layout Labeling
20226 \labelwidthstring 00.00.0000
20228 \begin_inset space ~
20234 \begin_layout Labeling
20235 \labelwidthstring 00.00.0000
20238 svn propset svn:needs-lock ON "<file-name>"
20241 \begin_layout Labeling
20242 \labelwidthstring 00.00.0000
20245 svn propdel svn:needs-lock "<file-name>"
20248 \begin_layout Subsubsection
20249 \begin_inset CommandInset label
20251 name "sub:VCS-Revision-Information"
20255 Revision Information in Documents
20258 \begin_layout Standard
20259 There are more possibilities how to activate revision information in our
20263 \begin_layout Itemize
20264 LyX supports directly:
20268 \begin_layout Itemize
20269 tree revision information (
20270 \begin_inset Flex Code
20273 \begin_layout Plain Layout
20280 The result is the output of the
20281 \begin_inset Flex Code
20284 \begin_layout Plain Layout
20290 command, the following table gives you an idea, how to read the results.
20293 \begin_layout Standard
20295 \begin_inset Tabular
20296 <lyxtabular version="3" rows="6" columns="2">
20297 <features rotate="0" tabularvalignment="middle">
20298 <column alignment="center" valignment="top" width="0">
20299 <column alignment="center" valignment="top" width="0">
20301 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
20304 \begin_layout Plain Layout
20310 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
20313 \begin_layout Plain Layout
20321 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20324 \begin_layout Plain Layout
20330 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20333 \begin_layout Plain Layout
20334 mixed revision working copy
20341 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20344 \begin_layout Plain Layout
20350 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20353 \begin_layout Plain Layout
20354 modified working copy
20361 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20364 \begin_layout Plain Layout
20370 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20373 \begin_layout Plain Layout
20374 switched working copy
20381 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20384 \begin_layout Plain Layout
20390 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20393 \begin_layout Plain Layout
20394 partial working copy, from a sparse checkout
20401 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
20404 \begin_layout Plain Layout
20410 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
20413 \begin_layout Plain Layout
20414 mixed revision, modified, switched working copy
20427 \begin_layout Itemize
20428 file revision information.
20429 The result comes from parsing the output of
20430 \begin_inset Flex Code
20433 \begin_layout Plain Layout
20435 \begin_inset space ~
20439 \begin_inset space ~
20443 \begin_inset space ~
20452 Supported flags are:
20456 \begin_layout Itemize
20457 version number of the last commit (
20458 \begin_inset Flex Code
20461 \begin_layout Plain Layout
20470 \begin_layout Itemize
20471 author of the last commit (
20472 \begin_inset Flex Code
20475 \begin_layout Plain Layout
20484 \begin_layout Itemize
20485 date of the last commit (
20486 \begin_inset Flex Code
20489 \begin_layout Plain Layout
20498 \begin_layout Itemize
20499 time of the last commit (
20500 \begin_inset Flex Code
20503 \begin_layout Plain Layout
20513 \begin_layout Standard
20514 You can obtain this info via InsetInfo (e.g.
20516 \begin_inset Flex Code
20519 \begin_layout Plain Layout
20520 info-insert buffer vcs-date
20526 The information will be available only when you have the file stored under
20527 svn managment (i.e.
20529 \begin_inset Flex Code
20532 \begin_layout Plain Layout
20538 directory is available with your document).
20542 \begin_layout Itemize
20543 Another---a hacking one---possibility is to use svn keywords
20547 \begin_layout Plain Layout
20548 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
20554 In short -- you set file keywords property (e.g.
20557 svn propset svn:keywords 'Rev' file.lyx
20559 ) and then paste keyword TeX code
20563 \begin_layout Plain Layout
20564 This is an easy way how to ensure that LyX won't break the line in the middle
20570 tag in your document (e.g.
20575 \begin_layout Plain Layout
20583 This way svn client will automatically substitute revision number (e.g.
20588 \begin_layout Plain Layout
20595 ) after each update and commit.
20596 There are more problems with this approach.
20597 Firstly, the '$' character is used in TeX world for math equations, so
20598 any occurence of math formula
20599 \begin_inset Formula $Rev$
20603 \begin_inset Formula $Rev:59$
20606 in your LyX document.
20607 Similarly for other keywords like Id, Date, Author, etc.
20608 Secondly svn output is dependent on your locales, so its very easy that
20609 svn would produce some problematic strings once Date is used.
20610 Thirdly you get the whole 'Rev: 59' string in your document instead of
20612 Until subversion implements user's custom keywords it will be hard to use
20613 this approach reliably or let LyX to support it directly.
20616 \begin_layout Subsection
20617 SVN and Windows Environment
20620 \begin_layout Quote
20621 My inclination is to say that if the user cannot figure out the command
20622 line operations on their own fairly quickly, they would be well advised
20623 to use TortoiseSVN.
20629 \begin_layout Subsubsection
20633 \begin_layout Standard
20634 In addition to installing LyX, and having access to a Subversion repository,
20635 the user will need to install the Subversion client program.
20636 A Windows installer for the client program is available from
20637 \begin_inset CommandInset href
20640 target "http://www.collab.net/nonav/downloads/subversion/"
20645 The user may also want to install
20646 \begin_inset CommandInset href
20649 target "http://tortoisesvn.tigris.org/"
20653 , which integrates Subversion operations into the context (rightclick) menu
20654 of Windows Explorer.
20655 Operations done outside LyX will typically be more convenient using the
20656 Explorer context menu.
20657 Note that TortoiseSVN is not a replacement for the client program, which
20658 is what LyX itself will use.
20661 \begin_layout Subsubsection
20662 Bringing a document under Subversion control
20665 \begin_layout Standard
20666 Before a LyX document can be brought under version control in Subversion,
20667 its parent directory needs to be under version control.
20668 If the document is being added to a project already in the repository,
20669 this is accomplished by checking the project out to the directory where
20670 the new document will be placed.
20671 If the project itself is not yet under version control (for instance, if
20672 this document starts a new project), the directory must be imported into
20674 This is done outside LyX.
20675 Both import and checkout are easily accomplished from the Explorer context
20676 menu using TortoiseSVN, or alternatively can be done using the command
20677 line client at a DOS prompt.
20678 The procedure for importing the project using TortoiseSVN is described
20679 below, assuming an existing repository and a new project being started
20687 For information on using the Subversion client program, run
20694 \begin_layout Enumerate
20701 in Windows Explorer, right click it, and select
20703 TortoiseSVN > Repo-browser
20706 If necessary, adjust the URL for the repository, then click OK.
20709 \begin_layout Enumerate
20710 Right click the level of the repository under which you want to place the
20711 new project folder (typically the top level) and click
20713 Create folder\SpecialChar \ldots{}
20716 Supply a name for the project folder and click OK.
20717 Add a message for the log file if desired, then click OK again.
20718 The new project folder should appear in the repository.
20719 Finally, click OK again to exit the repository browser.
20722 \begin_layout Enumerate
20723 Once again right click
20729 , this time selecting SVN Checkout\SpecialChar \ldots{}
20730 Select the URL of the project folder
20731 you just created in the repository, and set the checkout directory to
20739 You will be warned about a non-empty folder; click OK to proceed.
20740 You should now have a
20751 \begin_layout Enumerate
20752 Create or open your document in LyX and click
20757 ile\SpecialChar \menuseparator
20763 \begin_inset space ~
20766 Control\SpecialChar \menuseparator
20774 Add a log message and click OK to commit the document to version control.
20777 \begin_layout Standard
20778 From this point onward, you should have full functionality in the
20783 ile\SpecialChar \menuseparator
20789 \begin_inset space ~
20795 You also have the option of checking the document in and out, viewing its
20797 using the TortoiseSVN context menu in Windows Explorer or the Subversion
20798 client program from a command prompt.
20801 \begin_layout Subsubsection
20802 SSH tunnel used with SVN under Windows
20805 \begin_layout Standard
20806 Compared with Linux setting up an svn client to communicate over ssh under
20807 Windows is a rather troublesome task.
20808 We will at least offer some hints how to setup the client side but prior
20809 knowledge about ssh and the Windows command line is needed, also be prepared
20810 for a great deal of frustration\SpecialChar \ldots{}
20814 \begin_layout Enumerate
20815 Get an svn client for windows, as described in the previous sections.
20816 When it is a fresh install run some svn command (e.g.
20818 \begin_inset Flex Code
20821 \begin_layout Plain Layout
20827 ) to create config files, which you will need to change later on.
20830 \begin_layout Enumerate
20831 Choose an ssh client for Windows.
20832 There are several possibilities, we will use the one from Putty tools
20836 \begin_layout Plain Layout
20837 \begin_inset Flex URL
20840 \begin_layout Plain Layout
20842 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
20853 You will need to set the connection up so that the client doesn't ask for
20854 any password from you.
20855 To keep things easy we will use only keys without any additional password
20860 \begin_layout Enumerate
20862 \begin_inset Flex Code
20865 \begin_layout Plain Layout
20872 Save your private .ppk key file and put the public one on the server side.
20873 If the SVN server runs on Linux, note that the format of the public key
20874 is not compatible with Linux openssh and you will need to direcly copy-paste
20877 Public key for pasting into OpenSSH authorized_keys file
20879 :” edit field into the server's
20880 \begin_inset Flex Code
20883 \begin_layout Plain Layout
20884 ~/.ssh/authorized_keys
20890 \begin_inset Flex Code
20893 \begin_layout Plain Layout
20902 \begin_layout Enumerate
20904 \begin_inset Flex Code
20907 \begin_layout Plain Layout
20914 In the SVN config file
20918 \begin_layout Plain Layout
20919 Exact path depends on Windows version, usually somewhere around
20920 \begin_inset Flex Code
20923 \begin_layout Plain Layout
20926 Documents and Settings
20940 \begin_inset Flex Code
20943 \begin_layout Plain Layout
20958 , section [tunnels], setup ssh command, e.g.
20960 \begin_inset Flex Code
20963 \begin_layout Plain Layout
20964 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
20973 \begin_layout Plain Layout
20974 It will usually take a lot of time to get exact command right and it depends
20976 For example do not have some remote server saved as a default session in
20978 If things fail, try to connect via plink without SVN first.
20987 \begin_layout Enumerate
20988 Checkout the SVN archive, e.g.
20990 \begin_inset Flex Code
20993 \begin_layout Plain Layout
20994 svn co svn+ssh://user@server/repository_path
21002 \begin_layout Subsubsection
21003 End-of-Line Conversions
21006 \begin_layout Standard
21007 When the collaborators are mixing Linux and Windows environments, LyX will
21008 use different line endings inside the .lyx files.
21009 This is not a problem as far as LyX functionality is concerned, but the
21010 commit diffs will be huge and merge-conflicts prone.
21011 Fortunately SVN itself knows
21015 \begin_layout Plain Layout
21016 \begin_inset Flex URL
21019 \begin_layout Plain Layout
21021 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
21031 how to deal with CR/LF problems when switching .lyx files to the
21032 \begin_inset Flex Code
21035 \begin_layout Plain Layout
21045 \begin_layout Plain Layout
21047 \begin_inset Flex Code
21050 \begin_layout Plain Layout
21051 svn propset svn:eol-style native FILE_NAME
21064 \begin_layout Subsection
21068 \begin_layout Standard
21069 With the recent addition of the vc-command function LyX power users are
21070 allowed to create their own commands for revision control.
21073 \begin_layout Standard
21074 As an example you can see how two TortoiseSVN commands could be integrated
21078 \begin_layout Description
21080 \begin_inset Flex Code
21083 \begin_layout Plain Layout
21084 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
21092 \begin_layout Description
21094 \begin_inset Flex Code
21097 \begin_layout Plain Layout
21098 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
21106 \begin_layout Subsection
21107 Version control and Document comparison
21110 \begin_layout Standard
21111 One of the typical uses of version control is to inspect the changes between
21112 revisions, usually by creating
21113 \begin_inset Flex Code
21116 \begin_layout Plain Layout
21123 While this is useful for plain text files, it is much less useful in the
21124 case of LyX files, which have more a complicated structure.
21125 Hence we provide binding to the Document comparison feature.
21126 There are two ways of calling this feature - either by direct call of
21127 \begin_inset Flex Code
21130 \begin_layout Plain Layout
21136 LyX function (for details see LyX functions manual) or by icon/menu item
21138 \begin_inset Flex MenuItem
21141 \begin_layout Plain Layout
21142 Compare with older revision...
21148 One can either compare two chosen revisions of the document or he can simply
21149 compare the current version of edited text with older revisions (where
21151 \begin_inset Flex MenuItem
21154 \begin_layout Plain Layout
21160 ' revisions back means comparison of the edited file with last commited
21165 \begin_layout Standard
21166 This feature is supported for SVN and RCS though due to the more complicated
21167 versioning scheme of RCS there is a constraint -- when addressing the revisions
21168 in dialog, numbers always point to the last number in RCS revision number,
21173 \begin_layout Section
21174 Literate Programming
21177 \begin_layout Standard
21182 (kayvan@sylvan.com)
21186 original documentation written by
21188 Edmar Wienskoski Jr.
21191 (edmar-w-jr@technologist.com)
21194 \begin_layout Subsection
21198 \begin_layout Standard
21199 The main purpose of this documentation is to show you how to use LyX for
21200 literate programming, where it is assumed that you are familiar with this
21201 programming technique, and know what
21202 \begin_inset Quotes eld
21206 \begin_inset Quotes erd
21210 \begin_inset Quotes eld
21214 \begin_inset Quotes erd
21218 If that is not the case, please follow the web links provided in the following
21220 There is a lot of good documentation out there covering old development
21221 history to the latest tools tips.
21224 \begin_layout Standard
21225 It is also assumed that you are familiar with LyX itself to a point that
21226 you are comfortable changing your LyX preferences, and X resources file.
21227 If that is not the case please refer to other LyX documentation to cover
21228 your specific needs.
21231 \begin_layout Subsection
21232 Literate Programming
21235 \begin_layout Standard
21236 From the Literate Programming FAQ:
21239 \begin_layout Quotation
21240 Literate programming is the combination of documentation and source together
21241 in a fashion suited for reading by human beings.
21242 In fact, literate programs should be enjoyable reading, even inviting!
21243 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
21244 and documentation in a single file.
21245 Literate programming tools then parse the file to produce either readable
21246 documentation or compilable source.
21247 The WEB style of literate programming was created by D.
21248 \begin_inset space \thinspace{}
21252 Knuth during the development of his TeX typesetting software.
21256 \begin_layout Standard
21257 Another excerpt says:
21260 \begin_layout Quotation
21263 How is literate programming different from verbose commenting?
21266 \begin_layout Quotation
21267 There are three distinguishing characteristics.
21268 In order of importance, they are:
21272 \begin_layout Itemize
21273 flexible order of elaboration
21276 \begin_layout Itemize
21277 automatic support for browsing
21280 \begin_layout Itemize
21281 typeset documentation, especially diagrams and mathematics
21285 \begin_layout Standard
21286 Now that I sparked your curiosity, take a look in the references.
21289 \begin_layout Subsubsection
21293 \begin_layout Standard
21294 The complete Literate Programming FAQ can be found at:
21297 \begin_layout Quote
21298 Literate Programming FAQ
21299 \begin_inset Flex URL
21302 \begin_layout Plain Layout
21304 http://www.literateprogramming.com/lpfaq.pdf
21312 \begin_layout Standard
21313 The FAQ lists 23 (twenty three!) different literate programming tools.
21314 Where some are specialized or
21315 \begin_inset Quotes eld
21319 \begin_inset Quotes erd
21322 for particular programming languages, while other have general scope.
21327 for my own use for several reasons:
21330 \begin_layout Itemize
21331 It can generate the documentation either in LaTeX or HTML.
21334 \begin_layout Itemize
21335 It has a open architecture, i.
21336 \begin_inset space \thinspace{}
21340 \begin_inset space \space{}
21343 it is easy to plug in new filters and to perform special processing that
21348 \begin_layout Itemize
21349 There is a good selection of filters available already (the HTML is one
21353 \begin_layout Itemize
21357 \begin_layout Standard
21358 The Noweb web page can be found at:
21361 \begin_layout Quote
21363 \begin_inset Flex URL
21366 \begin_layout Plain Layout
21368 http://www.cs.virginia.edu/~nr/noweb/
21376 \begin_layout Standard
21377 Starting from there you can reach many other interesting links and even
21378 some literate program examples.
21381 \begin_layout Subsection
21382 LyX and Literate Programming
21383 \change_inserted 274215730 1350434640
21389 \begin_layout Standard
21390 The LyX support for Literate Programming is provided by using the generic
21391 LyX converters mechanism.
21392 This support is provided in a
21393 \begin_inset Quotes eld
21397 \begin_inset Quotes erd
21401 \begin_inset space \thinspace{}
21405 \begin_inset space \space{}
21408 you will be able to use this new LyX feature with some other literate programmin
21409 g tool of your choice by just changing your LyX preferences.
21412 \begin_layout Subsubsection
21413 Generating documents and code (weaving and tangling)
21416 \begin_layout Paragraph
21417 Selecting the document class
21420 \begin_layout Standard
21421 If you have installed Noweb and LyX successfully, whenever you open a new
21422 document or try to change the document class of an existing one, you will
21423 find that there are three new document classes available:
21426 \begin_layout Itemize
21430 \begin_layout Itemize
21434 \begin_layout Itemize
21438 \begin_layout Standard
21439 You must select one of them to create your literate documents from.
21443 \begin_layout Standard
21444 Note that literate documents are not limited to these three classes.
21445 New classes can be generated from other styles like letter or in combination
21446 with other class variations like Article (AMS).
21447 If you have special needs that cannot be covered by one of the existing
21448 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
21449 will arrange to insert a new entry, or teach you how to do it.
21453 \begin_layout Plain Layout
21454 It is very simple, it involves the creation of a file with four lines, and
21455 re-running of the auto configuration.
21460 Moreover, if you use a literate tool other than Noweb you may need to create
21461 a new set of document classes for it.
21464 \begin_layout Paragraph
21468 \begin_layout Standard
21469 LyX enables you to write code with a layout named
21477 \begin_layout Plain Layout
21478 The equivalent Noweb term is
21479 \begin_inset Quotes eld
21483 \begin_inset Quotes erd
21487 For historical reasons, I got used to the term
21488 \begin_inset Quotes eld
21492 \begin_inset Quotes erd
21495 introduced by other literate tool named Nuweb, which I used for many years
21496 before rendering myself to Noweb.
21501 Noweb delimits scraps like this:
21504 \begin_layout LyX-Code
21508 \begin_layout LyX-Code
21512 \begin_layout LyX-Code
21516 \begin_layout LyX-Code
21520 \begin_layout LyX-Code
21524 \begin_layout Standard
21525 The problem is that whatever is written in between the << and the
21529 must be taken literally, i.
21530 \begin_inset space \thinspace{}
21534 \begin_inset space \space{}
21537 LyX should be prevented from making any special interpretation of what has
21539 This is handled by a special layout named Scrap, that works like a normal
21540 paragraph but has a free spacing capability.
21543 \begin_layout Standard
21545 \change_deleted 274215730 1350432842
21548 side of the Scrap paragraph layout is that consecutive paragraphs of code
21549 will be spaced with one empty line in the source code and also in the printed
21551 The work around is to enter each line of code within a single Scrap, with
21552 a newline (ctrl-return).
21553 The example above will look like this:
21557 \begin_layout Plain Layout
21558 If you have a printed version of this document you will not see any difference
21559 between the previous example and this one.
21567 \begin_layout LyX-Code
21569 \begin_inset Newline newline
21573 \begin_inset Newline newline
21577 \begin_inset Newline newline
21581 \begin_inset Newline newline
21587 \begin_layout Standard
21588 This layout works fine.
21589 The only real inconvenience is that you have to type ctrl-return instead
21594 \begin_layout Plain Layout
21595 It is in my list of
21596 \begin_inset Quotes eld
21600 \begin_inset Quotes erd
21611 \begin_layout Standard
21612 As a special note, you can also use the
21613 \begin_inset Quotes eld
21617 \begin_inset Quotes erd
21620 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
21624 \begin_layout LyX-Code
21626 \begin_inset Newline newline
21629 def some_function(args):
21630 \begin_inset Newline newline
21633 "This is the doc string for this function."
21634 \begin_inset Newline newline
21637 print "My args: ", args
21640 \begin_layout LyX-Code
21641 @ %def some_function
21644 \begin_layout Standard
21645 For an example of this usage and the resulting cross-reference output, look
21646 at the Literate python program in
21648 LIBDIR/examples/listerrors.lyx
21650 which should make this all clear.
21653 \begin_layout Paragraph
21654 Generating the documentation
21657 \begin_layout Standard
21658 At this point you already have a new document file with a proper document
21659 class, and with some code and text on it.
21660 How do I print it? The answer is simple, you select
21662 View\SpecialChar \menuseparator
21666 Just like you would do for a plain document.
21667 No special procedure is required.
21670 \begin_layout Standard
21671 To help orientate you, I will now explain what happens inside LyX:
21674 \begin_layout Enumerate
21677 Update\SpecialChar \menuseparator
21680 menu option is chosen, a LaTeX file is generated.
21685 \begin_layout Standard
21686 If the document is of any literate class the generated file will be named
21687 with an extension name defined by the
21688 \begin_inset Quotes eld
21692 \begin_inset Quotes erd
21695 format (defined in the Preferences panel), otherwise the file will have
21704 \begin_layout Enumerate
21705 Note that the only difference so far is in the name of the file, no special
21706 processing is required by LyX.
21707 Given that you formatted the code using the Scrap layout that, by itself,
21708 takes care of the business.
21711 \begin_layout Enumerate
21712 If the document is of any literate class LyX will then use the internal
21713 LyX to Noweb converter, followed by the Noweb to LaTeX converter
21717 \begin_layout Plain Layout
21718 The converters are defined in the
21720 Tools\SpecialChar \menuseparator
21724 \begin_inset Quotes eld
21728 \begin_inset Quotes erd
21740 manual for general information about converters.
21745 to generate the LaTeX file.
21749 \begin_layout Standard
21750 Otherwise it will just skip this step.
21754 \begin_layout Enumerate
21755 Finally, LaTeX is invoked and the regular post processing continues as in
21759 \begin_layout Standard
21760 Independence from a particular
21761 \begin_inset Quotes eld
21765 \begin_inset Quotes erd
21768 is easily achieved by changing the commands that are run by the various
21772 \begin_layout Paragraph
21773 Generating the code
21776 \begin_layout Standard
21777 When the build menu option is chosen or the corresponding button in the
21778 toolbar is pressed, a LaTeX file is generated just like step 1 above.
21779 Next, LyX invokes the
21784 This converter needs to be defined by the user and is not installed by
21785 default, though the Program format is.
21786 This converter (like any other converter) will have two parts:
21789 \begin_layout Enumerate
21790 The converter program itself.
21791 This program performs the conversion from the one format to the other (in
21792 this case, from the Noweb format to the Program pseudo-format).
21795 \begin_layout Enumerate
21796 The error log parser.
21797 This is a program whose sole purpose is to rewrite error messages in a
21798 format that LyX understands.
21799 This makes it possible for LyX to place error boxes in the right places
21800 in the file buffer.
21803 \begin_layout Standard
21804 The first part, the
21805 \begin_inset Quotes eld
21809 \begin_inset Quotes erd
21812 setting, should be set to
21813 \begin_inset Quotes eld
21821 \begin_inset Quotes erd
21825 This basically means that LyX will call
21826 \begin_inset Quotes eld
21830 \begin_inset Quotes erd
21833 (a program or script) with the name of the Noweb file (normally a file
21834 in the LyX temp directory) and the directory path of the original LyX file.
21838 \begin_layout Standard
21839 This is an implementation of
21840 \begin_inset Quotes eld
21844 \begin_inset Quotes erd
21847 that you can place in a directory on your path:
21850 \begin_layout LyX-Code
21854 \begin_layout LyX-Code
21858 \begin_layout LyX-Code
21859 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
21862 \begin_layout Standard
21863 The next part of the converter setting is the
21864 \begin_inset Quotes eld
21868 \begin_inset Quotes erd
21871 which is to be set to
21872 \begin_inset Quotes eld
21877 parselog=$$s/scripts/listerrors
21880 \begin_inset Quotes erd
21884 This will run any errors that are generated by the
21885 \begin_inset Quotes eld
21889 \begin_inset Quotes erd
21892 process through the
21893 \begin_inset Quotes eld
21897 \begin_inset Quotes erd
21903 \begin_layout Standard
21904 The build will normally take place in LyX's temporary directory, so the
21905 files produced by the conversion will be in that directory.
21906 LyX will copy out what it regards as the `main' file, but the
21910 conversion may produce several files, and so most of these would then be
21911 deleted when LyX was closed.
21912 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
21913 the build-script scrap can place the generated files in that location.
21916 \begin_layout Paragraph
21917 Build instructions in the document
21920 \begin_layout Standard
21921 The last piece of the integration between LyX and noweb is the
21922 \begin_inset Quotes eld
21926 \begin_inset Quotes erd
21930 Generally, the instructions for building your program should be embedded
21931 in a scrap of its own.
21933 \begin_inset Quotes eld
21937 \begin_inset Quotes erd
21940 above uses the notangle command to look for this scrap (called
21941 \begin_inset Quotes eld
21945 \begin_inset Quotes erd
21948 ) and runs its contents through
21949 \begin_inset Quotes eld
21953 \begin_inset Quotes erd
21959 \begin_layout Standard
21960 Typically, such a scrap would look something like this:
21963 \begin_layout LyX-Code
21965 \begin_inset Newline newline
21969 \begin_inset Newline newline
21973 \begin_inset Newline newline
21976 if [ -z "${NOWEB_SOURCE}" ]
21977 \begin_inset Newline newline
21981 \begin_inset Newline newline
21984 NOWEB_SOURCE=myfile.nw
21985 \begin_inset Newline newline
21989 \begin_inset Newline newline
21993 code to extract files ...
21994 use NOWEB_OUTPUT_DIR here ...]
21995 \begin_inset Newline newline
21999 code to compile files ...]
22000 \begin_inset Newline newline
22006 \begin_layout Standard
22009 LIBDIR/examples/listerrors.lyx
22013 LIBDIR/examples/Literate.lyx
22015 which implement two versions of the
22016 \begin_inset Quotes eld
22020 \begin_inset Quotes erd
22023 program for some illustrations of how all of these pieces go together or
22026 LIBDIR/examples/noweb2lyx.lyx.
22029 Interestingly, these three files show off the language-indepence of the
22030 LyX literate programming support since they are written in Python, C and
22034 \begin_layout Subsubsection
22038 \begin_layout Standard
22039 All the Literate Programming support is configured by the
22041 Tools\SpecialChar \menuseparator
22045 \begin_inset Quotes eld
22049 \begin_inset Quotes erd
22053 The important parts are:
22056 \begin_layout Description
22058 \begin_inset space ~
22062 \begin_inset Quotes eld
22066 \begin_inset Quotes erd
22070 \begin_inset space ~
22073 format Set up via the File Formats tab, this is where the Noweb-specific
22083 , the file extension is set to
22088 This tells LyX to create a file with a
22092 extension in the first step of the conversion process.
22095 \begin_layout Description
22097 \begin_inset space ~
22105 \begin_inset space ~
22108 format This is an empty format whose sole purpose is to be the endpoint
22109 of a conversion (which then allows us to set up a converter for it).
22112 \begin_layout Description
22121 This converter performs the
22122 \begin_inset Quotes eld
22126 \begin_inset Quotes erd
22129 of the literate document.
22130 For Noweb, it is set to
22131 \begin_inset Quotes eld
22136 noweave -delay -index $$i > $$o
22139 \begin_inset Quotes erd
22145 \begin_layout Description
22155 \begin_inset Quotes eld
22159 \begin_inset Quotes erd
22163 As stated above, the Converter is set to
22164 \begin_inset Quotes eld
22172 \begin_inset Quotes erd
22175 , with Flags set to
22176 \begin_inset Quotes eld
22181 parselog=$$s/scripts/listerrors
22184 \begin_inset Quotes erd
22190 \begin_layout Subsubsection
22194 \begin_layout Standard
22195 There is also a new function implemented in the LyX server, the
22196 \begin_inset Quotes eld
22199 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
22203 \begin_layout Standard
22204 When debugging code with ddd/gdb, it is possible to invoke a text editor
22205 at the current execution position with a single key stroke.
22206 The default ddd configuration for that is shift-ctrl-V.
22207 It happens that you can define the editor command line invocation in ddd
22210 Edit\SpecialChar \menuseparator
22211 Preferences\SpecialChar \menuseparator
22214 dialog and changing the "Edit Sources" entry.
22217 \begin_layout Standard
22218 I take advantage of the new
22219 \change_inserted 274215730 1350432999
22222 created LyX server function and this ddd feature, and set
22223 \begin_inset Quotes eld
22227 \begin_inset Quotes erd
22233 \begin_layout LyX-Code
22234 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
22237 \begin_layout Standard
22238 With this, whenever you are using ddd and find a point in the program that
22239 you want to edit, you just press shift-ctrl-V (in the ddd window), and
22241 \change_deleted 274215730 1350433047
22243 \change_inserted 274215730 1350433047
22246 forward this information to LyX through the LyX server and then the LyX
22247 window will show the same file with the cursor at the same position ddd
22249 No more guessing or long scrolling to locate a point in the program back
22253 \begin_layout Standard
22254 Note however that you must enable the LyX server to get this feature working
22255 (it is disabled by default).
22256 You can enable it in
22268 ) by entering in the
22273 \begin_inset Quotes eld
22278 /home/<your-home-directory>/.lyx/lyxpipe
22281 \begin_inset Quotes erd
22287 \begin_layout Standard
22288 Read the LyX server documentation in the
22290 Customization Manual
22292 for further information.
22295 \begin_layout Subsubsection
22299 \begin_layout Standard
22300 There are six new buttons that can be added to your LyX toolbar.
22301 Five of these buttons are short cuts to layout styles:
22322 The last one is a short cut to the
22323 \begin_inset Quotes eld
22327 \begin_inset Quotes erd
22334 \begin_layout Standard
22335 LyX has a range of buttons that are available for tool bar customization.
22336 In my toolbar I like to combine the six short cuts above with two more:
22341 \SpecialChar \menuseparator
22346 \SpecialChar \menuseparator
22353 View\SpecialChar \menuseparator
22357 Here is how it looks like:
22360 \begin_layout LyX-Code
22364 \begin_layout LyX-Code
22368 \begin_layout LyX-Code
22369 Icon "layout Standard"
22372 \begin_layout LyX-Code
22373 Icon "layout Section"
22376 \begin_layout LyX-Code
22377 Icon "layout LaTeX"
22380 \begin_layout LyX-Code
22381 Icon "layout LyX-Code"
22384 \begin_layout LyX-Code
22385 Icon "layout Scrap"
22388 \begin_layout LyX-Code
22392 \begin_layout LyX-Code
22396 \begin_layout LyX-Code
22397 Icon "buffer-typeset"
22400 \begin_layout LyX-Code
22401 Icon "build-program"
22404 \begin_layout LyX-Code
22408 \begin_layout LyX-Code
22412 \begin_layout LyX-Code
22416 \begin_layout LyX-Code
22420 \begin_layout LyX-Code
22424 \begin_layout Subsubsection
22425 Colors customization
22428 \begin_layout Standard
22429 There are a number of colors in LyX that can be customized in
22434 One of the things that bothers people is the LaTeX font color.
22435 The default color is red, since the scraps uses LaTeX font, and there is
22436 a lot of scraps in literate documents, you may get tired of seeing everything
22438 You can change it by going to the tabs
22447 \begin_layout Standard
22448 The next thing is the visible presence of the newline character in the screen.
22449 You can choose the color of this particular character and make it blend
22451 I recommend you choosing a color that is close to the background but not
22452 equal, that way you still can see it is there, but it is not bothering
22455 \change_deleted 274215730 1350434691
22457 \change_inserted 274215730 1350434708
22461 \begin_layout Subsection
22463 \change_inserted 274215730 1350434732
22464 LyX and knitr/Sweave
22467 \begin_layout Standard
22469 \change_inserted 274215730 1350434777
22470 Support for knitr and Sweave is documented in the knitr.lyx example file
22471 and in the Sweave manual (in the Help > Specific Manuals submenu).
22476 \begin_layout Chapter
22480 \begin_layout Standard
22481 You can do everything with LyX that you can do with LaTeX.
22482 However, LyX cannot support every LaTeX feature directly.
22483 But you can always use TeX Code.
22484 This chapter shows you some more special things you might want to use.
22485 For other special things you can do with figures, tables, floats, boxes
22486 and notes, have a look at the
22489 \begin_inset space ~
22497 \begin_layout Section
22498 Multiple Text Columns
22501 \begin_layout Standard
22502 This feature is independent of the option
22504 Two-column document
22506 in the document settings under
22511 If you want to have 2
22512 \begin_inset space ~
22515 columns for the whole document, it is recommended to use the
22517 Two-column document
22520 For all other cases use this feature.
22523 \begin_layout Standard
22524 To use multiple text columns in your document, you have to load the module
22531 Document\SpecialChar \menuseparator
22532 Settings\SpecialChar \menuseparator
22535 ) and must have the LaTeX-package
22540 \begin_inset Index idx
22543 \begin_layout Plain Layout
22544 LaTeX-packages ! multicol
22552 \begin_layout Standard
22553 Footnotes within multiple columns will be placed at the bottom of the page
22554 and not under each column.
22555 Within the different columns you can use everything, with the limitation
22556 that for floats you need to use the float option
22563 \begin_layout Subsection
22567 \begin_layout Standard
22568 If you want to have 2
22569 \begin_inset space ~
22572 columns in your text, use the style
22574 Begin Multiple Columns
22576 where the columns should start.
22577 The content of the style is the number of the columns, so in this case
22579 \begin_inset Quotes eld
22583 \begin_inset Quotes erd
22587 At the point where the columns should end use the style
22589 End Multiple Columns
22594 \begin_layout Standard
22595 Here is an example:
22598 \begin_layout Begin Multiple Columns
22602 \begin_layout Standard
22607 The Adventure of the Empty House
22610 \begin_inset Newline newline
22615 Sir Arthur Conan Doyle
22618 \begin_layout Standard
22621 It was in the spring of the year 1894 that all London was interested, and
22622 the fashionable world dismayed, by the murder of the Honourable Ronald
22623 Adair under most unusual and inexplicable circumstances.
22624 The public has already learned those particulars of the crime which came
22625 out in the police investigation, but a good deal was suppressed upon that
22626 occasion, since the case for the prosecution was so overwhelmingly strong
22627 that it was not necessary to bring forward all the facts.
22628 Only now, at the end of nearly ten years, am I allowed to supply those
22629 missing links which make up the whole of that remarkable chain.
22630 The crime was of interest in itself, but that interest was as nothing to
22631 me compared to the inconceivable sequel, which afforded me the greatest
22632 shock and surprise of any event in my adventurous life.
22633 Even now, after this long interval, I find myself thrilling as I think
22634 of it, and feeling once more that sudden flood of joy, amazement, and increduli
22635 ty which utterly submerged my mind.
22636 Let me say to that public, which has shown some interest in those glimpses
22637 which I have occasionally given them of the thoughts and actions of a very
22638 remarkable man, that they are not to blame me if I have not shared my knowledge
22639 with them, for I should have considered it my first duty to do so, had
22640 I not been barred by a positive prohibition from his own lips, which was
22641 only withdrawn upon the third of last month.
22644 \begin_layout End Multiple Columns
22648 \begin_layout Standard
22649 Here is an example with 3
22650 \begin_inset space ~
22656 \begin_layout Begin Multiple Columns
22660 \begin_layout Standard
22663 It can be imagined that my close intimacy with Sherlock Holmes had interested
22664 me deeply in crime, and that after his disappearance I never failed to
22665 read with care the various problems which came before the public.
22666 And I even attempted, more than once, for my own private satisfaction,
22667 to employ his methods in their solution, though with indifferent success.
22668 There was none, however, which appealed to me like this tragedy of Ronald
22670 As I read the evidence at the inquest, which led up to a verdict of willful
22671 murder against some person or persons unknown, I realized more clearly
22672 than I had ever done the loss which the community had sustained by the
22673 death of Sherlock Holmes.
22674 There were points about this strange business which would, I was sure,
22675 have specially appealed to him, and the efforts of the police would have
22676 been supplemented, or more probably anticipated, by the trained observation
22677 and the alert mind of the first criminal agent in Europe.
22678 All day, as I drove upon my round, I turned over the case in my mind and
22679 found no explanation which appeared to me to be adequate.
22680 At the risk of telling a twice-told tale, I will recapitulate the facts
22681 as they were known to the public at the conclusion of the inquest.
22684 \begin_layout End Multiple Columns
22688 \begin_layout Standard
22689 You can have up to 10
22690 \begin_inset space ~
22693 columns if you want to, but that might not be very pleasant for the readers
22697 \begin_layout Standard
22698 \begin_inset Newpage newpage
22704 \begin_layout Subsection
22705 Columns inside Columns
22708 \begin_layout Standard
22709 You can also have columns inside columns:
22712 \begin_layout Begin Multiple Columns
22716 \begin_layout Standard
22719 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
22720 at that time governor of one of the Australian colonies.
22721 Adair's mother had returned from Australia to undergo the operation for
22722 cataract, and she, her son Ronald, and her daughter Hilda were living together
22726 \begin_layout Begin Multiple Columns
22730 \begin_layout Standard
22733 The youth moved in the best society–had, so far as was known, no enemies
22734 and no particular vices.
22735 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
22736 had been broken off by mutual consent some months before, and there was
22737 no sign that it had left any very profound feeling behind it.
22738 For the rest {sic} the man's life moved in a narrow and conventional circle,
22739 for his habits were quiet and his nature unemotional.
22740 Yet it was upon this easy-going young aristocrat that death came, in most
22741 strange and unexpected form, between the hours of ten and eleven-twenty
22742 on the night of March 30, 1894.
22745 \begin_layout End Multiple Columns
22749 \begin_layout Standard
22752 Ronald Adair was fond of cards–playing continually, but never for such stakes
22754 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
22755 It was shown that, after dinner on the day of his death, he had played
22756 a rubber of whist at the latter club.
22757 He had also played there in the afternoon.
22762 The evidence of those who had played with him– Mr.
22763 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
22764 and that there was a fairly equal fall of the cards.
22765 Adair might have lost five pounds, but not more.
22766 His fortune was a considerable one, and such a loss could not in any way
22768 He had played nearly every day at one club or other, but he was a cautious
22769 player, and usually rose a winner.
22770 It came out in evidence that, in partnership with Colonel Moran, he had
22771 actually won as much as four hundred and twenty pounds in a sitting, some
22772 weeks before, from Godfrey Milner and Lord Balmoral.
22773 So much for his recent history as it came out at the inquest.
22776 \begin_layout End Multiple Columns
22780 \begin_layout Subsection
22784 \begin_layout Standard
22785 The examples in this section show some more special features of multiple
22789 \begin_layout Standard
22790 For more features of multiple columns, have a look at the documentation
22791 of the LaTeX-package
22796 \begin_inset Index idx
22799 \begin_layout Plain Layout
22800 LaTeX-packages ! multicol
22806 \begin_inset CommandInset citation
22815 \begin_layout Subsubsection
22819 \begin_layout Standard
22820 To add a preface text for multiple columns, add the command
22823 \begin_layout Standard
22829 \begin_layout Standard
22830 as TeX Code behind the number of columns in the
22832 Begin Multiple Columns
22835 Behind the command follows the preface text.
22836 At the end of the style use the command
22839 \begin_layout Standard
22845 \begin_layout Standard
22847 An example with some preface text:
22850 \begin_layout Standard
22851 \begin_inset VSpace bigskip
22857 \begin_layout Begin Multiple Columns
22862 \begin_layout Plain Layout
22869 And the story continues and continues and continues and continues\SpecialChar \ldots{}
22874 \begin_layout Plain Layout
22884 \begin_layout Standard
22887 On the evening of the crime, he returned from the club exactly at ten.
22888 His mother and sister were out spending the evening with a relation.
22889 The servant deposed that she heard him enter the front room on the second
22890 floor, generally used as his sitting-room.
22891 She had lit a fire there, and as it smoked she had opened the window.
22892 No sound was heard from the room until eleven-twenty, the hour of the return
22893 of Lady Maynooth and her daughter.
22894 Desiring to say good-night, she attempted to enter her son's room.
22895 The door was locked on the inside, and no answer could be got to their
22896 cries and knocking.
22897 Help was obtained, and the door forced.
22898 The unfortunate young man was found lying near the table.
22899 His head had been horribly mutilated by an expanding revolver bullet, but
22900 no weapon of any sort was to be found in the room.
22903 \begin_layout End Multiple Columns
22907 \begin_layout Standard
22908 You can also use a section heading as the preface if you use a section command
22909 as TeX Code behind the first TeX Code.
22910 For example the command
22913 \begin_layout Standard
22918 subsection{subsection title}
22921 \begin_layout Standard
22922 creates a subsection.
22923 In this example the preface is a subsubsection:
22926 \begin_layout Begin Multiple Columns
22931 \begin_layout Plain Layout
22942 \begin_layout Plain Layout
22951 This is a subsubsection heading as a preface
22955 \begin_layout Plain Layout
22966 \begin_layout Plain Layout
22976 \begin_layout Standard
22979 A minute examination of the circumstances served only to make the case more
22981 In the first place, no reason could be given why the young man should have
22982 fastened the door upon the inside.
22983 There was the possibility that the murderer had done this, and had afterwards
22984 escaped by the window.
22985 The drop was at least twenty feet, however, and a bed of crocuses in full
22987 Neither the flowers nor the earth showed any sign of having been disturbed,
22988 nor were there any marks upon the narrow strip of grass which separated
22989 the house from the road.
22990 Apparently, therefore, it was the young man himself who had fastened the
22992 But how did he come by his death? No one could have climbed up to the window
22993 without leaving traces.
22994 Suppose a man had fired through the window, he would indeed be a remarkable
22995 shot who could with a revolver inflict so deadly a wound.
22996 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
22997 a hundred yards of the house.
22998 No one had heard a shot.
23001 \begin_layout End Multiple Columns
23005 \begin_layout Standard
23006 If there is less vertical space left on the page at the beginning of the
23007 multiple columns than needed for 6
23008 \begin_inset space ~
23011 text lines, a page break will be inserted before the multiple columns.
23012 Depending on the number of lines of the preface text, you might want to
23014 It is determined by inserting the command
23017 \begin_layout Standard
23025 \begin_layout Standard
23026 as TeX Code behind the preface definition but before the final
23035 is hereby the number of text lines.
23036 In this example the space is set to 7
23037 \begin_inset space ~
23043 \begin_layout Begin Multiple Columns
23048 \begin_layout Plain Layout
23059 \begin_layout Plain Layout
23068 This is the sectioning command
23069 \begin_inset Newline newline
23073 \begin_inset Newline newline
23076 with multiple text lines
23080 \begin_layout Plain Layout
23091 \begin_layout Plain Layout
23104 \begin_layout Plain Layout
23114 \begin_layout Standard
23117 On the evening of the crime, he returned from the club exactly at ten.
23118 His mother and sister were out spending the evening with a relation.
23119 The servant deposed that she heard him enter the front room on the second
23120 floor, generally used as his sitting-room.
23121 She had lit a fire there, and as it smoked she had opened the window.
23122 No sound was heard from the room until eleven-twenty, the hour of the return
23123 of Lady Maynooth and her daughter.
23124 Desiring to say good-night, she attempted to enter her son's room.
23125 The door was locked on the inside, and no answer could be got to their
23126 cries and knocking.
23127 Help was obtained, and the door forced.
23128 The unfortunate young man was found lying near the table.
23129 His head had been horribly mutilated by an expanding revolver bullet, but
23130 no weapon of any sort was to be found in the room.
23133 \begin_layout End Multiple Columns
23137 \begin_layout Subsubsection
23141 \begin_layout Standard
23142 The amount of space before and after multiple columns can be changed by
23143 changing the length
23150 For example the command
23153 \begin_layout Standard
23163 \begin_layout Standard
23164 in TeX Code changes its value to 3
23165 \begin_inset space \thinspace{}
23169 The change must be made before the multiple columns' start.
23170 The predefined value is 13
23171 \begin_inset space \thinspace{}
23177 \begin_layout Standard
23185 \begin_inset space \thinspace{}
23191 \begin_layout Standard
23195 \begin_layout Plain Layout
23201 multicolsep}{2.5cm}
23209 \begin_layout Begin Multiple Columns
23213 \begin_layout Standard
23216 All day I turned these facts over in my mind, endeavouring to hit upon some
23217 theory which could reconcile them all, and to find that line of least resistanc
23218 e which my poor friend had declared to be the starting-point of every investigat
23220 I confess that I made little progress.
23221 In the evening I strolled across the Park, and found myself about six o'clock
23222 at the Oxford Street end of Park Lane.
23223 A group of loafers upon the pavements, all staring up at a particular window,
23224 directed me to the house which I had come to see.
23225 A tall, thin man with coloured glasses, whom I strongly suspected of being
23226 a plain-clothes detective, was pointing out some theory of his own, while
23227 the others crowded round to listen to what he said.
23228 I got as near him as I could, but his observations seemed to me to be absurd,
23229 so I withdrew again in some disgust.
23230 As I did so I struck against an elderly, deformed man, who had been behind
23231 me, and I knocked down several books which he was carrying.
23234 \begin_layout End Multiple Columns
23238 \begin_layout Standard
23239 \begin_inset Note Greyedout
23242 \begin_layout Plain Layout
23247 The values you set with
23253 will be used for all following multiple columns until you change them again.
23261 \begin_layout Standard
23265 \begin_layout Plain Layout
23277 \begin_inset Note Note
23280 \begin_layout Plain Layout
23281 go back to the default
23289 \begin_layout Standard
23290 \begin_inset Newpage newpage
23296 \begin_layout Subsubsection
23300 \begin_layout Standard
23301 The width of the columns is automatically calculated, but you can modify
23302 the space between the columns.
23303 This is done by changing the length
23310 Its predefined value is 10
23311 \begin_inset space \thinspace{}
23315 Here is an example where
23322 \begin_inset space \thinspace{}
23328 \begin_layout Standard
23332 \begin_layout Plain Layout
23346 \begin_layout Begin Multiple Columns
23350 \begin_layout Standard
23353 My observations of No.
23354 \begin_inset space \space{}
23357 427 Park Lane did little to clear up the problem in which I was interested.
23358 The house was separated from the street by a low wall and railing, the
23359 whole not more than five feet high.
23360 It was perfectly easy, therefore, for anyone to get into the garden, but
23361 the window was entirely inaccessible, since there was no water pipe or
23362 anything which could help the most active man to climb it.
23363 More puzzled than ever, I retraced my steps to Kensington.
23364 I had not been in my study five minutes when the maid entered to say that
23365 a person desired to see me.
23366 To my astonishment it was none other than my strange old book collector,
23367 his sharp, wizened face peering out from a frame of white hair, and his
23368 precious volumes, a dozen of them at least, wedged under his right arm.
23371 \begin_layout End Multiple Columns
23375 \begin_layout Standard
23379 \begin_layout Plain Layout
23391 \begin_inset Note Note
23394 \begin_layout Plain Layout
23395 go back to the default
23403 \begin_layout Subsubsection
23407 \begin_layout Standard
23408 Between the columns a rule with a width of the length
23415 If this rule width is set to 0
23416 \begin_inset space \thinspace{}
23419 pt (this is the default), the rule is suppressed.
23420 In the following example the line is 2
23421 \begin_inset space \thinspace{}
23427 \begin_layout Standard
23431 \begin_layout Plain Layout
23437 columnseprule}{2pt}
23445 \begin_layout Begin Multiple Columns
23449 \begin_layout Standard
23452 \begin_inset Quotes eld
23455 You're surprised to see me, sir,
23456 \begin_inset Quotes erd
23459 said he, in a strange, croaking voice.
23462 \begin_layout Standard
23465 I acknowledged that I was.
23468 \begin_layout Standard
23471 \begin_inset Quotes eld
23474 Well, I've a conscience, sir, and when I chanced to see you go into this
23475 house, as I came hobbling after you, I thought to myself, I'll just step
23476 in and see that kind gentleman, and tell him that if I was a bit gruff
23477 in my manner there was not any harm meant, and that I am much obliged to
23478 him for picking up my books.
23479 \begin_inset Quotes erd
23485 \begin_layout Standard
23488 \begin_inset Quotes eld
23491 You make too much of a trifle,
23492 \begin_inset Quotes erd
23497 \begin_inset Quotes eld
23500 May I ask how you knew who I was?
23501 \begin_inset Quotes erd
23507 \begin_layout Standard
23510 \begin_inset Quotes eld
23513 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
23514 you'll find my little bookshop at the corner of Church Street, and very
23515 happy to see you, I am sure.
23516 Maybe you collect yourself, sir.
23520 \begin_inset space ~
23533 --a bargain, every one of them.
23534 With five volumes you could just fill that gap on that second shelf.
23535 It looks untidy, does it not, sir?
23536 \begin_inset Quotes erd
23542 \begin_layout End Multiple Columns
23546 \begin_layout Standard
23550 \begin_layout Plain Layout
23556 columnseprule}{0pt}
23562 \begin_inset Note Note
23565 \begin_layout Plain Layout
23566 go back to the default
23574 \begin_layout Standard
23575 \begin_inset Newpage newpage
23581 \begin_layout Section
23582 Non-standard Paragraph Shapes
23585 \begin_layout Standard
23589 \begin_layout Plain Layout
23601 \begin_layout Standard
23605 \begin_layout Plain Layout
23614 \begin_layout Plain Layout
23628 \begin_layout Standard
23633 \begin_layout Plain Layout
23644 \begin_layout Plain Layout
23653 \begin_layout Plain Layout
23662 \begin_layout Plain Layout
23671 \begin_layout Plain Layout
23680 \begin_layout Plain Layout
23689 \begin_layout Plain Layout
23698 \begin_layout Plain Layout
23707 \begin_layout Plain Layout
23716 \begin_layout Plain Layout
23725 \begin_layout Plain Layout
23734 \begin_layout Plain Layout
23743 \begin_layout Plain Layout
23752 \begin_layout Plain Layout
23761 \begin_layout Plain Layout
23770 \begin_layout Plain Layout
23779 \begin_layout Plain Layout
23788 \begin_layout Plain Layout
23797 \begin_layout Plain Layout
23806 \begin_layout Plain Layout
23812 There are times when the tyranny of rectangular paragraphs must be overthrown.
23813 In such situations, a call to the delightful plain TeX command
23820 As you can see, completely arbitrary shapes can be laid out with a suitable
23821 set of line length definitions.
23822 While this parshape may look a bit silly and useless, one could conceive
23823 of situations such as finely tuned dropped capitals, word wrapping around
23824 non-rectangular graphics, etc.
23825 which will benefit from such handcrafting.
23828 \begin_layout Standard
23829 \begin_inset VSpace bigskip
23835 \begin_layout Standard
23840 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
23847 is the number of lines of text which define the paragraph.
23848 If there turn out to be fewer lines, the shape is truncated; if there are
23849 more, the excess lines have the same dimensions as the last line of the
23859 entries specify the indentation of the line from the left margin, and the
23860 length of the line as measured from that point.
23861 The shape applies only to the current paragraph; everything is reset to
23862 normal for the next paragraph.
23865 \begin_layout Standard
23869 \begin_layout Plain Layout
23881 \begin_layout Bibliography
23882 \begin_inset CommandInset bibitem
23883 LatexCommand bibitem
23888 Documentation of the LaTeX-package
23889 \begin_inset CommandInset href
23892 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
23897 \begin_inset Index idx
23900 \begin_layout Plain Layout
23901 LaTeX-packages ! multicol