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
73 \font_default_family default
74 \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 false
134 \output_changes false
143 Additional LyX Features
146 \begin_layout Subtitle
155 \begin_layout Plain Layout
157 Principal maintainer of this file is
162 If you have comments or error corrections, please send them to the LyX
163 Documentation mailing list,
164 \begin_inset Flex Code
167 \begin_layout Plain Layout
169 <lyx-docs@lists.lyx.org>
182 \begin_layout Standard
183 \begin_inset CommandInset toc
184 LatexCommand tableofcontents
191 \begin_layout Chapter
195 \begin_layout Standard
196 This manual is essentially Part II of the
198 User's Guide\SpecialChar \@.
201 The reason for separating the two documents is simple: the
205 is already quite lengthy, and it contains information on all of the basic
206 features one needs to know in order to prepare most documents.
207 However, the LyX Team has worked to make LyX extensible through various
208 configuration files and external packages.
209 That means that if you want to support the Fizzwizzle LaTeX package, you
210 can create a layout file (or module) for it without having to alter LyX
212 We've already had contributions of several new features this way, and some
213 of them are documented here.
214 There are also some more `advanced' features, such as how to control the
215 presentation of bibliographies and how to work with multi-part documents,
216 that are not covered in the
220 and are discussed here.
223 \begin_layout Standard
224 This manual also documents some special features, like fax support, version
225 control, and SGML support, which require additional software to work properly.
226 There is also a chapter on LyX's support for HTML.
227 And lastly, there's a chapter of LaTeX tools and tips, things you can use
228 to spruce up your documents by directly using the powerful features of
234 only WYSIWYM and will only ever interface to some, not all, LaTeX features.
237 \begin_layout Standard
238 If you haven't read the
242 yet, you are definitely in the wrong manual.
247 is the first place to go, since it describes the notation and format of
249 You should also be thoroughly familiar with the
253 and all of the basic features of LyX before attempting to read this one.
256 \begin_layout Standard
257 Since many of the topics in this manual depend heavily on LyX's interaction
258 with LaTeX, this first chapter covers the inner workings of LyX and how
259 to direct LyX to generate exactly the LaTeX code you want.
260 It is obviously for more seasoned LyX users.
263 \begin_layout Chapter
267 \begin_layout Section
271 \begin_layout Standard
272 This chapter is for both TeX-nicians and the LaTeX-curious.
273 In it, we'll explain how LyX and LaTeX work together to produce printable
275 This is the only place in any of the manuals where we assume you know something
279 \begin_layout Standard
280 At one time, LyX was called a
281 \begin_inset Quotes eld
284 WYSIWYM frontend to LaTeX,
285 \begin_inset Quotes erd
288 but that's no longer true.
289 There are frontends to LaTeX out there.
293 \begin_layout Plain Layout
294 Some familar ones are TeXmaker and kile, on Linux, and TeXshop, OSX.
295 There are also the LaTeX modes for vi and emacs, of course.
300 These are basically text editors with the ability to run LaTeX and mark
301 any errors in the file you're editing.
310 run LaTeX, and it also indicates errors in the file, it also does much,
312 For one thing, you don't need to know LaTeX to use LyX effectively.
313 And LyX has added its own extensions to LaTeX.
314 Try the following sometime: select
315 \begin_inset Flex MenuItem
318 \begin_layout Plain Layout
319 Export\SpecialChar \menuseparator
326 \begin_inset Flex MenuItem
329 \begin_layout Plain Layout
336 \begin_inset Flex MenuItem
339 \begin_layout Plain Layout
340 View\SpecialChar \menuseparator
346 ), then look at the preamble of the resulting
347 \begin_inset Flex Code
350 \begin_layout Plain Layout
357 You'll notice a variety of new macros defined specifically by LyX.
358 These macros are defined automatically, according to the features you use
362 \begin_layout Standard
363 There are several commands that automatically invoke LaTeX.
367 \begin_layout Itemize
368 \begin_inset Flex MenuItem
371 \begin_layout Plain Layout
372 View\SpecialChar \menuseparator
381 \begin_layout Itemize
382 \begin_inset Flex MenuItem
385 \begin_layout Plain Layout
386 View\SpecialChar \menuseparator
395 \begin_layout Itemize
396 \begin_inset Flex MenuItem
399 \begin_layout Plain Layout
400 File\SpecialChar \menuseparator
409 \begin_layout Itemize
410 \begin_inset Flex MenuItem
413 \begin_layout Plain Layout
414 File\SpecialChar \menuseparator
423 \begin_layout Standard
424 They will only invoke LaTeX if the file has changed since the last time
429 \begin_layout Standard
430 When LyX runs LaTeX on the file you're editing, it performs these steps:
433 \begin_layout Enumerate
434 Convert the document to LaTeX and save to a file with the extension
435 \begin_inset Flex Code
438 \begin_layout Plain Layout
445 \begin_inset Flex Code
448 \begin_layout Plain Layout
457 \begin_layout Enumerate
459 \begin_inset Flex Code
462 \begin_layout Plain Layout
468 file (maybe several times), and run any other commands (such as
469 \begin_inset Flex Code
472 \begin_layout Plain Layout
479 \begin_inset Flex Code
482 \begin_layout Plain Layout
488 ) needed to compile the LaTeX file.
491 \begin_layout Enumerate
492 If there are any errors, show the error log.
495 \begin_layout Standard
496 If you have run LaTeX using
497 \begin_inset Flex MenuItem
500 \begin_layout Plain Layout
503 \SpecialChar \menuseparator
511 , LyX then runs a DVI viewer to display the DVI-file.
513 \begin_inset Flex MenuItem
516 \begin_layout Plain Layout
519 \SpecialChar \menuseparator
527 , LyX performs further steps:
530 \begin_layout Itemize
532 \begin_inset Flex Code
535 \begin_layout Plain Layout
541 to convert the DVI file to PostScript.
544 \begin_layout Itemize
545 Run a PostScript viewer, such as
546 \begin_inset Flex Code
549 \begin_layout Plain Layout
555 , to display the PostScript file.
558 \begin_layout Standard
559 LyX does similar things when viewing, or exporting, other formats.
562 \begin_layout Section
563 Translating LaTeX files into LyX
566 \begin_layout Standard
567 You can import a LaTeX file into LyX by using the
568 \begin_inset Flex MenuItem
571 \begin_layout Plain Layout
572 File\SpecialChar \menuseparator
573 Import\SpecialChar \menuseparator
580 This will call a program named
581 \begin_inset Flex Code
584 \begin_layout Plain Layout
590 which will create a file
591 \begin_inset Flex Code
594 \begin_layout Plain Layout
601 \begin_inset Flex Code
604 \begin_layout Plain Layout
611 LyX will then open that file.
615 \begin_layout Plain Layout
616 \begin_inset Flex Code
619 \begin_layout Plain Layout
625 can also be run from the command line, of course.
633 \begin_layout Standard
634 \begin_inset Flex Code
637 \begin_layout Plain Layout
643 will translate most legal LaTeX, but not everything.
644 It will put things it doesn't understand into TeX code, so after translating
646 \begin_inset Flex Code
649 \begin_layout Plain Layout
655 , you can look for TeX code and hand-edit it until it looks right.
658 \begin_layout Standard
659 If you don't know what TeX code is, read the next section.
662 \begin_layout Section
663 \begin_inset CommandInset label
665 name "sec:Inserting-TeX-Code"
669 Inserting TeX Code into LyX Documents
672 \begin_layout Standard
673 Anything you can do in LaTeX you can do in LyX, for a very simple reason:
674 You can always insert TeX code into any LyX document.
675 LyX cannot, and will never be able to, display every possible LaTeX construct.
676 If ever you need to insert LaTeX commands into your LyX document, you can
678 \begin_inset Flex Code
681 \begin_layout Plain Layout
687 box, which you can insert into your document with
688 \begin_inset Flex MenuItem
691 \begin_layout Plain Layout
692 Insert\SpecialChar \menuseparator
698 or the keyboard shortcut
707 \begin_layout Standard
708 Here's an example of inserting LaTeX commands in a LyX document.
709 The code looks like this:
712 \begin_layout LyX-Code
716 \begin_inset Newline newline
722 \begin_inset Newline newline
725 This is an example of a minipage environment.
727 \begin_inset Newline newline
730 can put nearly everything in it, even (non-floating)
731 \begin_inset Newline newline
736 \begin_inset Newline newline
742 \begin_inset Newline newline
746 \begin_inset Newline newline
752 \begin_inset Newline newline
758 \begin_inset Newline newline
764 \begin_inset Newline newline
769 \begin_inset Newline newline
775 \begin_inset Newline newline
781 \begin_inset Newline newline
787 \begin_inset Newline newline
795 \begin_layout LyX-Code
799 \begin_layout Standard
801 \begin_inset Flex Code
804 \begin_layout Plain Layout
810 box containing this text is directly after this paragraph.
811 Those of you reading the manual in LyX will only see the TeX code inset.
812 Those reading a printed version of the manuals will see the actual results:
813 \begin_inset VSpace bigskip
819 \begin_layout Standard
823 \begin_layout Plain Layout
830 \begin_layout Plain Layout
837 \begin_layout Plain Layout
839 This is an example of a minipage environment.
840 You can put nearly everything in it, even (non-floating) figures and tables.
844 \begin_layout Plain Layout
851 \begin_layout Plain Layout
856 \begin_layout Plain Layout
863 \begin_layout Plain Layout
870 \begin_layout Plain Layout
877 \begin_layout Plain Layout
883 \begin_layout Plain Layout
890 \begin_layout Plain Layout
897 \begin_layout Plain Layout
904 \begin_layout Plain Layout
914 \begin_inset VSpace bigskip
920 \begin_layout Standard
921 In addition to using TeX code, you can also create a separate file containing
922 some complex LaTeX structure and then use
923 \begin_inset Flex MenuItem
926 \begin_layout Plain Layout
927 Insert\SpecialChar \menuseparator
937 to include your file (you should select the type
938 \begin_inset Flex Code
941 \begin_layout Plain Layout
948 We recommend that you only do this if you have a
949 \begin_inset Flex Code
952 \begin_layout Plain Layout
963 Otherwise, you'll have a big job tracking down LaTeX errors.
966 \begin_layout Standard
967 There are a few last points to emphasize:
970 \begin_layout Itemize
975 check if your LaTeX code is correct.
978 \begin_layout Itemize
979 Beware of reinventing the wheel.
982 \begin_layout Standard
983 On that last point, LyX does have quite a few features tucked into it, and
985 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
986 feature before you decide you have to do it by hand.
987 Moreover, there are numerous LaTeX packages out there to do all sorts of
988 things, from labels to envelopes to fancy multipage tables.
990 \begin_inset CommandInset href
993 target "http://www.ctan.org/"
1000 \begin_layout Standard
1001 If you do need to do some wild and fancy things within your document, be
1002 sure to check out a good LaTeX book for assistance.
1003 There are a number of them listed in the bibliography of the
1010 \begin_layout Section
1011 LyX and the LaTeX Preamble
1014 \begin_layout Subsection
1015 About the LaTeX Preamble
1018 \begin_layout Standard
1019 If you already know LaTeX, there is no need to explain here what the preamble
1021 If you don't, the following will give you some ideas—we recommend again
1022 that you consult a LaTeX book for further information.
1023 In any case, you should read the points below, because they explain what
1024 you can do and what you don't need to do in the LaTeX preamble of a LyX
1028 \begin_layout Standard
1029 The LaTeX preamble comes at the very beginning of a document,
1037 \begin_layout Itemize
1038 Declare the document class.
1040 \begin_inset Newline newline
1043 LyX already does this for you.
1044 If you're a seasoned LaTeX-nician, and you have a custom document class
1045 you want to use, check out the
1047 Customization Manual
1049 for information on how to make LyX interface to it.
1052 \begin_layout Itemize
1053 Declare the usage of packages.
1055 \begin_inset Newline newline
1058 LaTeX packages provide special commands, which are only available within
1059 a document when the package has been declared in the preamble.
1060 In addition to providing special commands, the inclusion of a package can
1061 change the document.
1062 For example, the package
1063 \begin_inset Flex Code
1066 \begin_layout Plain Layout
1072 forces all paragraphs to be indented.
1073 There are other packages for labels, envelopes, margins, etc.
1077 \begin_layout Itemize
1078 Set counters, variables, lengths and widths.
1080 \begin_inset Newline newline
1083 There are several LaTeX counters and variables that
1087 be set globally from within the preamble in order to have the desired effect.
1088 (There are variables that you can set and reset inside the document, too.)
1089 Margins are a good example of something that must be set in the preamble.
1090 Another example is the label format for lists.
1091 You can actually set these just about anywhere, but it's best to do it
1092 just once, inside the preamble.
1095 \begin_layout Itemize
1096 Declare user defined commands (with
1097 \begin_inset Flex Code
1100 \begin_layout Plain Layout
1109 \begin_inset Flex Code
1112 \begin_layout Plain Layout
1121 \begin_inset Newline newline
1124 These are abbreviations for LaTeX commands which appear very often inside
1126 Although the preamble is a good place to declare such commands, they
1130 be declared anywhere (before they are used for the first time, of course).
1131 This can be useful if there is a lot of raw LaTeX code in your document,
1132 which normally should not be the case.
1135 \begin_layout Standard
1136 LyX adds its own set of definitions to the preamble of the
1137 \begin_inset Flex Code
1140 \begin_layout Plain Layout
1147 This makes LaTeX files generated by LyX portable.
1150 \begin_layout Subsection
1151 Changing the Preamble
1154 \begin_layout Standard
1155 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1156 can't change them without patching LyX itself.
1157 You can, however, add your own stuff to the preamble by selecting
1158 \begin_inset Flex MenuItem
1161 \begin_layout Plain Layout
1163 \begin_inset space ~
1172 \begin_inset Flex MenuItem
1175 \begin_layout Plain Layout
1176 Document\SpecialChar \menuseparator
1183 LyX adds anything in the
1184 \begin_inset Flex MenuItem
1187 \begin_layout Plain Layout
1193 dialog to its own built-in preamble.
1194 Before adding your own declarations in the preamble, you should make sure
1195 that LyX doesn't already support what you want to do.
1196 (Remember what we said about reinventing the wheel?) Also,
1198 make sure your preamble code is correct
1201 LyX doesn't check it for you.
1202 If there is an error, you're likely to get an error like
1203 \begin_inset Quotes eld
1207 \begin_inset Flex Code
1210 \begin_layout Plain Layout
1219 \begin_inset Quotes erd
1223 If you see this error, check your preamble.
1226 \begin_layout Subsection
1230 \begin_layout Standard
1231 Here are some examples of what you can add to a preamble, and what they
1235 \begin_layout Subsubsection
1239 \begin_layout Standard
1240 There are two variables under LaTeX that control page position:
1241 \begin_inset Flex Code
1244 \begin_layout Plain Layout
1253 \begin_inset Flex Code
1256 \begin_layout Plain Layout
1265 Their names should be self-explanatory.
1266 These variables are useful if you think for a moment about computer labels.
1267 Sometimes, the size of a print medium and the area of the medium that you
1268 can actually print on aren't the same.
1270 \begin_inset Flex Code
1273 \begin_layout Plain Layout
1282 \begin_inset Flex Code
1285 \begin_layout Plain Layout
1296 \begin_layout Standard
1297 The default values for
1298 \begin_inset Flex Code
1301 \begin_layout Plain Layout
1310 \begin_inset Flex Code
1313 \begin_layout Plain Layout
1322 \begin_inset space \thinspace{}
1326 \begin_inset space \thinspace{}
1330 \begin_inset space \space{}
1333 the page isn't shifted.
1334 Unfortunately, some DVI drivers always seem to shift the page.
1335 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1336 If you're using LyX on a system that you don't personally maintain, and
1337 your sysadmin is a doofus,
1338 \begin_inset Flex Code
1341 \begin_layout Plain Layout
1350 \begin_inset Flex Code
1353 \begin_layout Plain Layout
1362 Suppose your left and top margins are always 0.5
1363 \begin_inset space \thinspace{}
1367 You can add this to the preamble:
1370 \begin_layout LyX-Code
1378 \begin_layout LyX-Code
1386 \begin_layout Standard
1387 and your margins should now be correct.
1390 \begin_layout Subsubsection
1394 \begin_layout Standard
1395 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1396 There's a rather nice package, available at your nearest CTAN archive,
1397 for printing sheets of labels:
1398 \begin_inset Flex Code
1401 \begin_layout Plain Layout
1408 Now, your system may not have this package installed by default.
1409 We leave that up to you to check.
1410 You'll also want to read the documentation for it; we're not going to do
1412 Since this is an example, however, we'll give you an example of how you
1416 \begin_layout Standard
1417 First, make sure you're using the
1418 \begin_inset Flex Code
1421 \begin_layout Plain Layout
1428 Next, you need to put the following in your preamble:
1431 \begin_layout LyX-Code
1437 \begin_layout LyX-Code
1443 \begin_layout LyX-Code
1449 \begin_layout LyX-Code
1455 \begin_layout LyX-Code
1461 \begin_layout LyX-Code
1467 \begin_layout LyX-Code
1473 \begin_layout Standard
1474 This sets things up for Avery label sheets, stock #5360.
1475 You're now ready to print labels, but you'll need to insert LaTeX code,
1476 placing the commands
1477 \begin_inset Flex Code
1480 \begin_layout Plain Layout
1489 \begin_inset Flex Code
1492 \begin_layout Plain Layout
1500 around each label text.
1501 This and other special features of
1502 \begin_inset Flex Code
1505 \begin_layout Plain Layout
1511 are explained in its documentation.
1514 \begin_layout Standard
1515 Someday, someone may write a LyX layout file to support this package directly.
1516 Maybe that someone is you.
1519 \begin_layout Subsubsection
1520 Example #3: Paragraph Indentation
1523 \begin_layout Standard
1524 Americans are trained to indent the first line of
1529 As with all of their other weird quirks, most Americans will whine and
1530 moan until they can have their way and indent the first line of all paragraphs.
1539 \begin_layout Standard
1540 Of course, this behavior isn't standard typography.
1541 In books, you typically only indent the first line of a paragraph
1545 it follows another one.
1546 The idea behind indenting the first line of a paragraph is to distinguish
1547 neighboring paragraphs from one another.
1548 If there is no previous paragraph—for example, if it follows a figure or
1549 is the first paragraph in a section—then there is no need for indentation.
1553 \begin_layout Standard
1554 If you're a typical American (we're still joking!), though, you don't care
1555 about such esoteric things; you want your indentation! Add this to the
1559 \begin_layout LyX-Code
1562 usepackage{indentfirst}
1565 \begin_layout Standard
1566 If your TeX distribution isn't braindead, you'll have this package, and
1567 all of your paragraphs will get the indentation the Founding Fathers intended
1571 \begin_layout Subsubsection
1572 Example #4: This Document
1575 \begin_layout Standard
1576 You can also check out the preamble of this document to get an idea of some
1577 of the advanced things you can do.
1580 \begin_layout Section
1581 LyX and LaTeX Errors
1584 \begin_layout Standard
1585 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1587 It then uses the logfile from the LaTeX run to do a post-mortem.
1588 After analyzing the logfile, LyX displays a dialog listing the errors.
1589 Clicking on any one of them will take you to the position in your LyX file
1590 where the error occurred.
1594 \begin_layout Plain Layout
1596 Analyzing the logfile is a tough job, and LyX doesn't always go to the
1598 There are also cases where LaTeX reports the error on one line, but the
1599 actual error is earlier.
1600 This is not unlike forgetting a closing brace in a program: You'll get
1601 an error, but only later.
1609 \begin_layout Standard
1610 Some folks also like to look at the log file directly: It is available from
1612 \begin_inset Flex MenuItem
1615 \begin_layout Plain Layout
1618 \SpecialChar \menuseparator
1622 \begin_inset space ~
1631 There are some fairly common error messages and warnings.
1632 We'll cover those here.
1633 You should look at a good LaTeX book for a complete listing.
1636 \begin_layout Itemize
1637 \begin_inset Flex Code
1640 \begin_layout Plain Layout
1647 \begin_inset Newline newline
1650 Anything beginning with these words is a warning message for the purpose
1652 \begin_inset Quotes eld
1656 \begin_inset Quotes erd
1659 the LaTeX code itself.
1660 You'll get messages like this if you added or changed cross-references
1661 or bibliography entries, in which case, LaTeX is trying to tell you that
1662 you need to make another run.
1663 You can by-and-large ignore these.
1666 \begin_layout Itemize
1667 \begin_inset Flex Code
1670 \begin_layout Plain Layout
1677 \begin_inset Newline newline
1680 Another warning message, this time about fonts which LaTeX couldn't find.
1681 The rest of the message will often say something about a replacement font
1683 You can safely ignore these, too.
1686 \begin_layout Itemize
1687 \begin_inset Flex Code
1690 \begin_layout Plain Layout
1699 \begin_inset Newline newline
1707 They are warnings about lines that were too long and run past the right
1709 Almost always, this is unnoticeable in the final output.
1710 (It can be just a point or two.) Or, only one or two characters extend past
1712 LaTeX seems to generate at least one of these messages for just about any
1714 \begin_inset Newline newline
1717 You can ignore these messages.
1718 Your eyes will tell you if there's a problem with something that's too
1719 wide; just look at the output.
1723 \begin_layout Plain Layout
1724 You can also enable the `draft' option in
1725 \begin_inset Flex MenuItem
1728 \begin_layout Plain Layout
1731 \SpecialChar \menuseparator
1739 , and then LaTeX will draw a black box in the margin of lines that are overfull.
1747 \begin_layout Itemize
1748 \begin_inset Flex Code
1751 \begin_layout Plain Layout
1760 \begin_inset Newline newline
1763 Not quite as common as its cousin.
1764 LaTeX seems to like to print lines that are a bit too wide as opposed to
1765 ones that are a bit too narrow.
1766 We have no idea why.
1769 \begin_layout Itemize
1770 \begin_inset Flex Code
1773 \begin_layout Plain Layout
1782 \begin_inset Flex Code
1785 \begin_layout Plain Layout
1794 \begin_inset Newline newline
1797 Warnings about troubles breaking the page.
1798 Once again, just look at the output.
1799 Your eyes will tell you where something has gone wrong.
1802 \begin_layout Itemize
1803 \begin_inset Flex Code
1806 \begin_layout Plain Layout
1808 \begin_inset Quotes els
1812 \begin_inset Quotes ers
1821 \begin_inset Newline newline
1825 \begin_inset Quotes eld
1829 \begin_inset Quotes erd
1832 isn't installed on this system.
1833 This usually appears because some package your document needs isn't installed.
1834 If you didn't touch the preamble or didn't use the
1835 \begin_inset Flex Code
1838 \begin_layout Plain Layout
1846 command, then one of the packages LyX tried to load is missing.
1848 \begin_inset Flex MenuItem
1851 \begin_layout Plain Layout
1852 Help\SpecialChar \menuseparator
1858 to get a list of packages that LyX knows about.
1859 This file is updated whenever you reconfigure LyX (using
1860 \begin_inset Flex MenuItem
1863 \begin_layout Plain Layout
1864 Tools\SpecialChar \menuseparator
1870 ) and tells you which packages have been detected and what they do.
1871 \begin_inset Newline newline
1875 \begin_inset Flex Code
1878 \begin_layout Plain Layout
1886 command and the package in question isn't installed, then you'll need to
1887 install it yourself.
1890 \begin_layout Itemize
1891 \begin_inset Flex Code
1894 \begin_layout Plain Layout
1895 LaTeX Error: Unknown option
1901 \begin_inset Newline newline
1904 Error messages beginning with this are trying to tell you that you specified
1905 a bad or undefined option to a package.
1906 Check the package's documentation.
1909 \begin_layout Itemize
1910 \begin_inset Flex Code
1913 \begin_layout Plain Layout
1914 Undefined control sequence
1920 \begin_inset Newline newline
1923 If you've inserted LaTeX code into your document, but made a typo, you'll
1925 You may have forgotten to load a package.
1926 In any case, this error message usually means that you used an undefined
1931 \begin_layout Standard
1932 There are other error and warning messages.
1933 Some are self-explanatory.
1934 These are usually LaTeX messages.
1935 Others are downright cryptic.
1936 These are usually TeX error messages, and we really have
1940 what they mean or how to decipher them.
1944 \begin_layout Standard
1945 There's a general sequence you should follow if you get error messages:
1948 \begin_layout Enumerate
1949 Look at the LaTeX code you inserted for typos.
1952 \begin_layout Enumerate
1953 If there are no typos, check that you used the command(s) correctly.
1956 \begin_layout Enumerate
1957 If you get a bunch of error boxes piled up at the very top of the document—and
1958 especially if you see a
1959 \begin_inset Quotes eld
1963 \begin_inset Flex Code
1966 \begin_layout Plain Layout
1975 \begin_inset Quotes erd
1978 error—it means that there are errors in the preamble.
1979 Start debugging your preamble.
1982 \begin_layout Enumerate
1983 If you didn't add anything to the preamble and didn't add any LaTeX code
1984 to the document, the first suspect is your LaTeX distribution itself.
1985 Check for missing packages and install them.
1988 \begin_layout Enumerate
1989 Okay, so there are no missing packages.
1990 Did you use any of the fine-tuning options in LyX? Specifically, did you
1995 any of them, like trying to manually insert lots of
1996 \begin_inset Flex Code
1999 \begin_layout Plain Layout
2001 \begin_inset space ~
2010 \begin_inset Flex Code
2013 \begin_layout Plain Layout
2020 \begin_inset Flex Code
2023 \begin_layout Plain Layout
2029 ? Did you try to kludge something together with these instead of using the
2030 appropriate paragraph environment?
2033 \begin_layout Enumerate
2034 All right, you didn't use any of the fine-tuning options, you played by
2036 Did you try to pull a fancy maneuver? Did you do something funky inside
2037 a table or an equation, like inserting a graphic into a table cell?
2040 \begin_layout Enumerate
2041 Do you have long sections of text where LaTeX cannot find a place to break
2042 a line? By default, LaTeX is rather strict about how much extra inter-word
2043 spacing it will add in order to break a line.
2044 Preferably, you should rework the paragraph to avoid the problem.
2045 If this isn't an option, you can wrap your text in
2046 \begin_inset Flex Code
2049 \begin_layout Plain Layout
2057 to make LaTeX's line breaking more, well, sloppy.
2060 \begin_layout Enumerate
2061 Did you go overboard with the nesting? LyX (currently) doesn't check to
2062 make sure you're in the limits for nesting environments.
2063 If you nested a bunch of environments to the
2064 \begin_inset Formula $17^{\mathrm{th}}$
2067 level, that's the problem.
2068 (The limit in LaTeX is five.)
2071 \begin_layout Enumerate
2072 Okay, you didn't get any error messages, but your output looks awful.
2073 If you have a table or figure that's too wide or long for the page, you
2078 \begin_layout Enumerate
2079 rescale the figure so it fits.
2082 \begin_layout Enumerate
2083 trim down the table so it fits.
2087 \begin_layout Enumerate
2088 If something else is wrong with the output, and you didn't try to pull anything
2089 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2092 \begin_layout Standard
2093 If all this doesn't help—well, then
2097 you might have found a bug in LyX\SpecialChar \ldots{}
2101 \begin_layout Chapter
2105 \begin_layout Section
2106 Customizing Bibliographies with BibTeX
2109 \begin_layout Standard
2110 The most basic information about how to use BibTeX with LyX is contained
2113 Bibliography databases (BibTeX)
2120 The following subsections explain special bibliography features supported
2124 \begin_layout Subsection
2125 Alternative Citation Styles
2128 \begin_layout Standard
2129 Standard BibTeX uses numbers (e.
2130 \begin_inset space \thinspace{}
2134 \begin_inset space \space{}
2138 \begin_inset Quotes eld
2142 \begin_inset Quotes erd
2145 ) to refer to a cited work.
2146 However, in many scientific disciplines, other citation styles are in use.
2147 The most common one is the author-year style (e.
2148 \begin_inset space \thinspace{}
2152 \begin_inset space \space{}
2156 \begin_inset Quotes eld
2160 \begin_inset Quotes erd
2164 LyX supports two packages that provide this style,
2165 \begin_inset Flex Code
2168 \begin_layout Plain Layout
2175 \begin_inset Flex Code
2178 \begin_layout Plain Layout
2185 Both packages have their pros and cons, which cannot be listed in detail.
2186 If you only want to have simple author-year (or author-numerical) style,
2187 or if you want to use one of the countless style files for
2188 \begin_inset Flex Code
2191 \begin_layout Plain Layout
2197 , then the established
2198 \begin_inset Flex Code
2201 \begin_layout Plain Layout
2207 package is probably your choice.
2208 If you need special features like short title references, ibidem etc., you
2210 \begin_inset Flex Code
2213 \begin_layout Plain Layout
2222 \begin_layout Standard
2223 The handling of both packages in LyX is basically the same.
2225 \begin_inset Flex MenuItem
2228 \begin_layout Plain Layout
2229 Document\SpecialChar \menuseparator
2236 \begin_inset Flex MenuItem
2239 \begin_layout Plain Layout
2246 \begin_inset Flex MenuItem
2249 \begin_layout Plain Layout
2256 \begin_inset Flex MenuItem
2259 \begin_layout Plain Layout
2266 With both packages, you will get some extra features in the citation dialog
2267 and you can select the style of the reference (
2268 \begin_inset Quotes eld
2272 \begin_inset Quotes erd
2276 \begin_inset Quotes eld
2280 \begin_inset Quotes erd
2284 \begin_inset Quotes eld
2288 \begin_inset Quotes erd
2292 \begin_inset Quotes eld
2296 \begin_inset Quotes erd
2300 Note that both packages need specifically designed style files.
2301 They both ship their own, but there are lots of additional style files,
2302 and there is even an interactive style file builder
2306 \begin_layout Plain Layout
2308 \begin_inset Flex URL
2311 \begin_layout Plain Layout
2313 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2324 \begin_inset Flex Code
2327 \begin_layout Plain Layout
2336 \begin_layout Subsection
2337 Sectioned Bibliographies
2340 \begin_layout Standard
2341 Sometimes you might need to divide your bibliography into several sections.
2342 If you are for instance a historian, the possibility to separate sources
2343 and scientific works is most likely a
2344 \begin_inset Quotes eld
2348 \begin_inset Quotes erd
2352 Unfortunately, BibTeX itself does not allow you to do this.
2353 But with the help of some LaTeX packages, BibTeX can be extended to fit
2357 \begin_layout Standard
2358 LyX provides native support for one of these packages,
2366 \begin_layout Plain Layout
2368 \begin_inset Flex URL
2371 \begin_layout Plain Layout
2373 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2383 The advantage of this package (compared to other packages like
2387 ) is that you don't need to define new citation commands.
2388 Instead, you need to prepare different bibliographic databases which include
2389 the entries for the different sections of the bibliography.
2390 For example: If you want to divide your bibliography into the sections
2392 \begin_inset Quotes eld
2396 \begin_inset Quotes erd
2400 \begin_inset Quotes eld
2404 \begin_inset Quotes erd
2407 , you first need to create two bibliographic databases, e.
2408 \begin_inset space \thinspace{}
2412 \begin_inset space \space{}
2416 \begin_inset Flex Code
2419 \begin_layout Plain Layout
2426 \begin_inset Flex Code
2429 \begin_layout Plain Layout
2439 \begin_layout Standard
2441 \begin_inset Flex MenuItem
2444 \begin_layout Plain Layout
2445 Document\SpecialChar \menuseparator
2452 \begin_inset Flex MenuItem
2455 \begin_layout Plain Layout
2462 \begin_inset Flex MenuItem
2465 \begin_layout Plain Layout
2466 Sectioned bibliography
2472 Now you can insert multiple BibTeX bibliographies, one for each section
2473 of your bibliography.
2474 Returning to our example: Insert the BibTeX bibliography
2475 \begin_inset Flex Code
2478 \begin_layout Plain Layout
2484 and a second one for the database
2485 \begin_inset Flex Code
2488 \begin_layout Plain Layout
2495 You are free to use the same or different styles for each section.
2496 Additionally, you can choose if the bibliography section should contain
2498 \begin_inset Quotes eld
2501 all cited references
2502 \begin_inset Quotes erd
2505 of the specified database(s) (which is the default),
2506 \begin_inset Quotes eld
2509 all uncited references
2510 \begin_inset Quotes erd
2514 \begin_inset Quotes eld
2518 \begin_inset Quotes erd
2522 This might be useful if you would like to separate your bibliography into
2524 \begin_inset Quotes eld
2528 \begin_inset Quotes erd
2532 \begin_inset Quotes eld
2536 \begin_inset Quotes erd
2540 \begin_inset Quotes eld
2544 \begin_inset Quotes erd
2548 The titles for the sections can be added as ordinary sections or subsections.
2550 \begin_inset Flex Code
2553 \begin_layout Plain Layout
2559 removes the bibliography title, you have to manually re-add that, too (as
2560 a chapter* or section*, for instance).
2563 \begin_layout Subsection
2564 Multiple Bibliographies
2567 \begin_layout Standard
2568 Multiple bibliographies, e.
2569 \begin_inset space \thinspace{}
2573 \begin_inset space \space{}
2576 a bibliography for each section or chapter of the document, are not supported
2579 \begin_inset Flex Code
2582 \begin_layout Plain Layout
2588 package, which is used for the creation of sectioned bibliographies in
2589 LyX (see the previous section), provides an easy way to solve this task,
2590 if you are willing to use some
2591 \begin_inset Flex MenuItem
2594 \begin_layout Plain Layout
2601 \begin_inset space ~
2605 \begin_inset CommandInset ref
2607 reference "sec:Inserting-TeX-Code"
2615 \begin_layout Plain Layout
2616 An alternative approach is to use the
2617 \begin_inset Flex Code
2620 \begin_layout Plain Layout
2627 \begin_inset Flex Code
2630 \begin_layout Plain Layout
2636 package, respectively.
2644 \begin_layout Standard
2646 \begin_inset Flex MenuItem
2649 \begin_layout Plain Layout
2650 Document\SpecialChar \menuseparator
2657 \begin_inset Flex MenuItem
2660 \begin_layout Plain Layout
2667 \begin_inset Flex MenuItem
2670 \begin_layout Plain Layout
2671 Sectioned bibliography
2677 In the document, you have to enclose the sections, which shall contain
2678 their own bibliography (including the BibTeX bibliography itself), between
2680 \begin_inset Flex Code
2683 \begin_layout Plain Layout
2692 \begin_inset Flex Code
2695 \begin_layout Plain Layout
2703 (those commands have to be inserted as TeX code).
2704 The bibliography will contain all references that have been cited in the
2706 \begin_inset Flex Code
2709 \begin_layout Plain Layout
2720 If you are using this approach, then every citation reference has to be
2722 \begin_inset Flex Code
2725 \begin_layout Plain Layout
2733 \begin_inset Flex Code
2736 \begin_layout Plain Layout
2745 \begin_layout Section
2749 \begin_layout Subsection
2753 \begin_layout Standard
2754 When you are working on a large file with many sections, it is often convenient
2755 to break up the document into several files, or perhaps you have something
2756 where a table may change from time to time, but the preceding text does
2758 In these cases, you should seriously consider using multipart documents.
2759 For example, scientific papers often have five major sections: the introduction
2760 , observations, results, discussion, and conclusion.
2761 Each of these could be its own separate LyX file, with one
2762 \begin_inset Quotes eld
2766 \begin_inset Quotes erd
2769 file which contains the title, authors, abstract, references, etc., plus
2770 the five included files.
2771 It is important to note that each of these files is a full LyX file which
2772 can be formatted and printed on its own, as well as included in a master
2774 Each of these files must have the same document class, however—don't attempt
2775 to mix book classes with article classes.
2776 You may also include LaTeX files; however, these files must not have their
2778 \begin_inset space \thinspace{}
2782 \begin_inset space \space{}
2785 everything up to and including the
2786 \begin_inset Flex Code
2789 \begin_layout Plain Layout
2798 \begin_inset Flex Code
2801 \begin_layout Plain Layout
2809 line must be deleted) or else errors will be generated when you try to
2813 \begin_layout Standard
2814 LyX allows you to include files quite easily with
2815 \begin_inset Flex MenuItem
2818 \begin_layout Plain Layout
2819 Insert\SpecialChar \menuseparator
2821 \begin_inset space ~
2830 When you click on this selection a small box is inserted into the file
2831 at the current cursor location.
2832 Clicking on the box raises a dialog which allows you to select the file
2833 to be included, and the method of its inclusion.
2837 \begin_layout Standard
2838 The file selection box should by now be obvious.
2839 The three inclusion methods are
2840 \begin_inset Quotes eld
2844 \begin_inset Quotes erd
2848 \begin_inset Quotes eld
2852 \begin_inset Quotes erd
2856 \begin_inset Quotes eld
2860 \begin_inset Quotes erd
2864 The difference between
2865 \begin_inset Quotes eld
2869 \begin_inset Quotes erd
2873 \begin_inset Quotes eld
2877 \begin_inset Quotes erd
2880 is really only meaningful to LaTeXperts, but the practical difference is
2882 \begin_inset Quotes eld
2886 \begin_inset Quotes erd
2889 are typeset beginning on a new page, while files that are
2890 \begin_inset Quotes eld
2894 \begin_inset Quotes erd
2897 are typeset starting on the current page.
2900 \begin_layout Standard
2901 Generally, the master file is converted into a full LaTeX file before typesettin
2902 g, while the included files are converted to LaTeX files that do not have
2903 all the preamble information.
2906 \begin_layout Standard
2908 \begin_inset Quotes eld
2912 \begin_inset Quotes erd
2915 included file allows you to include a file typeset exactly as it appears
2917 \begin_inset space \thinspace{}
2921 \begin_inset space \space{}
2925 \begin_inset Flex Code
2928 \begin_layout Plain Layout
2934 mode, with the characters set in a fixed-width typewriter font.
2935 Normally, spaces in this file are invisible, though two consecutive spaces
2936 are conserved, unlike LyX's normal treatment of spaces.
2937 However, setting the
2938 \begin_inset Flex MenuItem
2941 \begin_layout Plain Layout
2943 \begin_inset space ~
2947 \begin_inset space ~
2951 \begin_inset space ~
2959 checkbox typesets a mark to unambiguously define the presence of a space.
2963 \begin_layout Subsection
2964 Cross-References Between Files
2967 \begin_layout Standard
2968 \begin_inset Box Shadowbox
2978 height_special "totalheight"
2981 \begin_layout Plain Layout
2982 This section is somewhat out of date.
2983 Need to describe default master documents and how children are opened when
2993 \begin_layout Standard
2994 It is possible to set up cross-references between the different files.
2995 First, open all the files in question: let's call them A and B in a two
2996 file example, where B is included in A.
2997 Let's say you insert a label in A, then want to reference it in B.
2998 Open the cross-reference dialog whilst in document B, and you can select
3000 \begin_inset Quotes eld
3004 \begin_inset Quotes erd
3010 \begin_layout Subsection
3011 Bibliography Lists in all Subdocuments
3014 \begin_layout Standard
3015 \begin_inset Box Frameless
3025 height_special "totalheight"
3028 \begin_layout Plain Layout
3029 This section also needs updating.
3030 There is now material about this on the wiki, and it could be copied here.
3038 \begin_layout Standard
3039 Copy the bibliography list with all entries to all subdocuments and transform
3041 This way LyX will find the
3042 \begin_inset Flex Code
3045 \begin_layout Plain Layout
3051 -files and you can easily insert references without making the bibliography
3055 \begin_layout Standard
3056 As the bibliography list is in a comment, LaTeX won't use use it and the
3057 references will look like this: [?], instead of like this: [1].
3058 One solution is to use the LaTeX-package
3059 \begin_inset Flex Code
3062 \begin_layout Plain Layout
3068 that will only include comments by processing the files separately.
3069 To do this, add in the LaTeX preamble of every subdocument the following:
3072 \begin_layout LyX-Code
3078 \begin_layout LyX-Code
3081 includecomment{comment}
3084 \begin_layout Standard
3086 \begin_inset Flex URL
3089 \begin_layout Plain Layout
3091 http://wiki.lyx.org/FAQ/Unsorted#toc31
3099 \begin_layout Section
3103 \begin_layout Standard
3104 Users sometimes need to be able to
3105 \begin_inset Quotes eld
3109 \begin_inset Quotes erd
3112 a LyX file together with all the images (and other files) on which it depends,
3113 either for sending to a publisher or for sharing with a co-author.
3114 LyX 2.0 includes a Python script (
3115 \begin_inset Flex Code
3118 \begin_layout Plain Layout
3124 ) that automates this process.
3125 To use it, you must have either the
3126 \begin_inset Flex Code
3129 \begin_layout Plain Layout
3136 \begin_inset Flex Code
3139 \begin_layout Plain Layout
3145 python modules installed on your system.
3146 By default, the script prefers the
3147 \begin_inset Flex Code
3150 \begin_layout Plain Layout
3157 \begin_inset Flex Code
3160 \begin_layout Plain Layout
3166 format on Unix-like systems and the
3167 \begin_inset Flex Code
3170 \begin_layout Plain Layout
3179 \begin_layout Standard
3180 LyX's configuration process will set the script up to export a `LyX Archive',
3181 and this format will then be available under
3182 \begin_inset Flex Code
3185 \begin_layout Plain Layout
3186 File\SpecialChar \menuseparator
3195 \begin_layout Standard
3196 Independently of the platform, the generation of a particular archive format
3197 can be forced by adding either the
3198 \begin_inset Flex Code
3201 \begin_layout Plain Layout
3208 \begin_inset Flex Code
3211 \begin_layout Plain Layout
3218 \begin_inset Flex Code
3221 \begin_layout Plain Layout
3228 \begin_inset Flex Code
3231 \begin_layout Plain Layout
3237 format) switch to the
3238 \begin_inset Flex Code
3241 \begin_layout Plain Layout
3242 LyX\SpecialChar \menuseparator
3249 \begin_inset Flex Code
3252 \begin_layout Plain Layout
3253 Tools\SpecialChar \menuseparator
3254 Preferences\SpecialChar \menuseparator
3255 File Handling\SpecialChar \menuseparator
3262 (Make sure you add the switch after the script name, not before it.)
3265 \begin_layout Section
3266 Fancy Headers and Footers
3269 \begin_layout Standard
3270 The default page layout is rather plain; for an
3271 \begin_inset Flex Code
3274 \begin_layout Plain Layout
3280 document class, all you get is a centered page number at the bottom of
3282 This document uses KOMA-script's book class, so it appears to be a bit
3284 But to really put on a show, you need to set the document page style to
3286 \begin_inset Quotes eld
3290 \begin_inset Quotes erd
3293 , as mentioned in the
3298 This section describes the LaTeX code you need to insert in your LaTeX
3299 preamble in order to get the desired effects.
3302 \begin_layout Standard
3303 For more information on fancy headers, see the
3304 \begin_inset Flex Code
3307 \begin_layout Plain Layout
3313 package documentation.
3315 \begin_inset Flex URL
3318 \begin_layout Plain Layout
3320 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
3328 \begin_layout Standard
3329 The page header is divided into three fields, not surprisingly labeled
3330 \begin_inset Quotes eld
3334 \begin_inset Quotes erd
3338 \begin_inset Quotes eld
3342 \begin_inset Quotes erd
3346 \begin_inset Quotes eld
3350 \begin_inset Quotes erd
3354 The footer is also divided into these three fields.
3355 The LaTeX commands to set these fields in the simplest manner are
3356 \begin_inset Flex Code
3359 \begin_layout Plain Layout
3368 \begin_inset Flex Code
3371 \begin_layout Plain Layout
3380 \begin_inset Flex Code
3383 \begin_layout Plain Layout
3392 \begin_inset Flex Code
3395 \begin_layout Plain Layout
3404 Suppose you wish to put your name in the upper left hand corner of each
3406 Simply insert the following command in the preamble:
3409 \begin_layout Standard
3418 \begin_layout Standard
3419 You will now see your name in the upper left.
3420 If a field has a default entry that you would like to get rid of (often
3421 the page number appears in the central footer) simply include a command
3422 with a blank argument, e.
3423 \begin_inset space \thinspace{}
3429 \begin_layout Standard
3437 \begin_layout Standard
3438 Let's get really fancy: lets put the section number with the word
3439 \begin_inset Quotes eld
3443 \begin_inset Quotes erd
3447 \begin_inset space \thinspace{}
3451 \begin_inset space \space{}
3454 Section 3) in the upper left, the page number (e.
3455 \begin_inset space \thinspace{}
3459 \begin_inset space \space{}
3462 Page 4) in the upper right, your name in the lower left, and the date in
3464 The following commands should now appear in the preamble:
3467 \begin_layout Standard
3477 \begin_layout Standard
3485 \begin_layout Standard
3495 \begin_layout Standard
3504 \begin_layout Standard
3512 \begin_layout Standard
3522 \begin_layout Standard
3524 \begin_inset Flex Code
3527 \begin_layout Plain Layout
3536 \begin_inset Flex Code
3539 \begin_layout Plain Layout
3547 access LaTeX's section and page counters, and so print out the current
3548 section and page numbers.
3550 \begin_inset Flex Code
3553 \begin_layout Plain Layout
3561 simply prints out today's date.
3564 \begin_layout Standard
3565 The thicknesses of the horizontal rules drawn beneath the header and above
3566 the footer can also be modified.
3567 If you don't want one of the rules, set its thickness to 0.
3568 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3574 \begin_inset Flex Code
3577 \begin_layout Plain Layout
3582 headrulewidth}{0.4pt}
3588 \begin_inset Flex Code
3591 \begin_layout Plain Layout
3596 footrulewidth}{0.4pt}
3601 to set the thicknesses.
3604 \begin_layout Standard
3605 You can switch the header/footer settings on and off for individual pages
3607 \begin_inset Flex Code
3610 \begin_layout Plain Layout
3613 thispagestyle{empty}
3619 \begin_inset Flex Code
3622 \begin_layout Plain Layout
3625 thispagestyle{plain}
3631 \begin_inset Flex Code
3634 \begin_layout Plain Layout
3637 thispagestyle{fancy}
3643 Simply insert them in the text on the page you want changed and mark them
3645 In fact, title pages are marked as plain by default, while following pages
3646 are marked fancy when using the global fancy setting.
3649 \begin_layout Standard
3650 As a final example, it is possible to include an image in the header or
3652 Suppose you want to put a company logo in the upper lefthand corner.
3653 You might try something like
3656 \begin_layout Standard
3665 includegraphics{logo.eps}}}
3668 \begin_layout Standard
3670 (you may need to preface this with
3671 \begin_inset Flex Code
3674 \begin_layout Plain Layout
3678 usepackage{graphics}
3683 if you don't include graphics elsewhere in your document).
3686 \begin_layout Section
3687 Itemize Bullet Selection
3688 \begin_inset CommandInset label
3697 \begin_layout Standard
3703 \begin_layout Subsection
3707 \begin_layout Standard
3708 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3709 Using this dialog you can easily specify what bullet shape to use at each
3710 level of an itemized list.
3711 These settings are document-wide so you won't be able to specify different
3712 sets of bullets for different paragraphs.
3716 \begin_layout Plain Layout
3717 Well, actually you can but you'll have to do it by hand.
3725 \begin_layout Subsection
3729 \begin_layout Standard
3730 Open the dialog by selecting the
3731 \begin_inset Flex MenuItem
3734 \begin_layout Plain Layout
3735 Document\SpecialChar \menuseparator
3741 menu item and then select the
3742 \begin_inset Flex MenuItem
3745 \begin_layout Plain Layout
3754 \begin_layout Standard
3755 The dialog provides you with a table of bullet shapes.
3756 A column of buttons on the left of the table provides access to the six
3757 different panels of bullet shapes.
3758 The row of buttons across the top is used to select which bullet depth
3760 A text entry under the table shows the currently selected bullet shape's
3761 LaTeX equivalent and this can be edited if desired.
3762 If you do modify the text you will also need to specify any needed packages
3763 in the LaTeX preamble.
3766 \begin_layout Standard
3767 The six panels are divided up by the packages they require.
3768 The following table shows the mappings from button name to LaTeX package.
3771 \begin_layout Standard
3773 \begin_inset Tabular
3774 <lyxtabular version="3" rows="7" columns="2">
3775 <features rotate="0" tabularvalignment="middle">
3776 <column alignment="center" valignment="top" width="0pt">
3777 <column alignment="center" valignment="top" width="0pt">
3779 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3782 \begin_layout Plain Layout
3797 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3800 \begin_layout Plain Layout
3817 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3820 \begin_layout Plain Layout
3835 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3838 \begin_layout Plain Layout
3854 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3857 \begin_layout Plain Layout
3872 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3875 \begin_layout Plain Layout
3892 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3895 \begin_layout Plain Layout
3910 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3913 \begin_layout Plain Layout
3930 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3933 \begin_layout Plain Layout
3948 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3951 \begin_layout Plain Layout
3968 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3971 \begin_layout Plain Layout
3986 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3989 \begin_layout Plain Layout
4006 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4009 \begin_layout Plain Layout
4024 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4027 \begin_layout Plain Layout
4050 \begin_layout Standard
4051 LyX doesn't stop you using bullets from packages you don't have.
4052 If you get errors from LaTeX when you try to view or print the file, then
4053 it is likely you are missing a package.
4057 \begin_layout Plain Layout
4058 LyX doesn't restrict your use since you may be editing locally and exporting
4067 \begin_layout Subsection
4071 \begin_layout Standard
4072 Select which bullet depth you want to change then select the bullet shape
4074 Any changes will not be visible in LyX, but are visible when viewing the
4078 \begin_layout Standard
4079 You can reset a bullet shape to the default simply by clicking your right
4080 mouse button on the appropriate bullet depth button.
4084 \begin_layout Plain Layout
4089 want to have multiple sets of paragraphs with different sets of bullets
4090 in each, then you're going to have to get your hands dirty with TeX code.
4091 The bullet selection dialog can help though because it provides you with
4092 the LaTeX code for a wide range of bullet shapes.
4093 To make your own custom paragraphs you have the following options:
4096 \begin_layout Plain Layout
4100 \begin_layout Plain Layout
4116 \begin_layout Plain Layout
4120 \begin_layout Plain Layout
4142 \begin_layout Itemize
4143 Use the LaTeX command
4144 \begin_inset Flex Code
4147 \begin_layout Plain Layout
4155 to specify a new bullet shape for a given depth.
4156 You'll also need to save the current bullet shape so you can restore it
4158 In this itemized list the following LaTeX code was used to change the bullet
4159 used for the first depth.
4163 \begin_layout LyX-Code
4173 \begin_layout LyX-Code
4190 \begin_layout Itemize
4191 Note that the itemize depth is specified in Roman numerals as part of the
4201 \begin_layout Itemize
4205 \begin_layout Plain Layout
4218 Specify each individual entry by starting each item with the bullet shape
4219 enclosed in square brackets and set as
4220 \begin_inset Flex MenuItem
4223 \begin_layout Plain Layout
4230 For example, this item was started with
4231 \begin_inset Flex Code
4234 \begin_layout Plain Layout
4249 \begin_layout Plain Layout
4253 \begin_layout Plain Layout
4269 \begin_layout Plain Layout
4270 You'll also need to revert the labelitem back to its previous setting for
4271 the global bullet shape settings to remain in effect.
4272 The way used here was:
4275 \begin_layout LyX-Code
4290 \begin_layout Chapter
4291 LyX and the World Wide Web
4294 \begin_layout Standard
4295 LyX has long supported the export of documents to various web-friendly formats,
4297 Before verson 2.0, however, HTML export was always accomplished by the use
4298 of external converters.
4302 \begin_layout Plain Layout
4303 For details on the use of external converters with LyX, see the
4307 section of the Customization manual.
4312 These fall into two large groups: there are converters that use LaTeX as
4313 an intermediate format, such as
4314 \begin_inset Flex Code
4317 \begin_layout Plain Layout
4324 \begin_inset Flex Code
4327 \begin_layout Plain Layout
4334 \begin_inset Flex Code
4337 \begin_layout Plain Layout
4343 , relying upon LyX to produce the LaTeX; and there is a converter that works
4344 directly on LyX files,
4345 \begin_inset Flex Code
4348 \begin_layout Plain Layout
4355 All of these have different advantages and disadvantages.
4359 \begin_layout Standard
4360 The LaTeX-based converters have the advantage that, in principle, they know
4361 everything about the exported document that LaTeX does.
4362 Such converters do not care, for example, if a certain block of code was
4363 produced by LyX or was Evil Red Text.
4364 These converters know about
4365 \begin_inset Flex Code
4368 \begin_layout Plain Layout
4374 files, counters, and references, and can often make use of the
4375 \begin_inset Flex Code
4378 \begin_layout Plain Layout
4384 files generated by BibTeX.
4385 On the other hand, LaTeX is a very hard language to parse---it is sometimes
4386 said that only TeX itself understands TeX---and LaTeX-based converters
4387 will often choke on what seem to be quite simple constructs; complex ones
4388 can throw them completely, and as of this writing, for example, the
4392 manual will not export with
4393 \begin_inset Flex Code
4396 \begin_layout Plain Layout
4402 , though the others will.
4403 The other issue concerns how math is handled.
4404 These converters typically convert the formulae into little pictures that
4405 are then linked from the HTML document.
4406 Since these are actually generated by LaTeX, they are accurate.
4407 But they do not scale well, and just getting them to look as if they are
4408 actually meant to be in your document---so that the font sizes seem to
4409 be roughly the same---can be a challenge.
4412 \begin_layout Standard
4414 \begin_inset Flex Code
4417 \begin_layout Plain Layout
4424 \begin_inset CommandInset href
4426 name "http://elyxer.nongnu.org/"
4427 target "http://elyxer.nongnu.org/"
4431 ) solves some of these problems.
4432 In particular, the formulae it produces scale perfectly, since it renders
4433 math using a combination of HTML and CSS rather than converting the formulae
4435 But even moderately complex formula are rendered less well than with
4436 \begin_inset Flex Code
4439 \begin_layout Plain Layout
4445 ; this reflects the limitations of HTML.
4449 \begin_layout Plain Layout
4451 \begin_inset Flex Code
4454 \begin_layout Plain Layout
4460 can also use jsMath and MathJax for equations, but this setting is only
4461 available globally and requires one to have access to a server that runs
4467 More importantly (as of version 1.1.1, at least),
4468 \begin_inset Flex Code
4471 \begin_layout Plain Layout
4477 has limited support for math macros and no support for user-defined paragraph
4478 or character styles.
4479 These limitations make
4480 \begin_inset Flex Code
4483 \begin_layout Plain Layout
4489 unsuitable for many of the documents LyX users produce.
4490 In principle, of course, these problems could be solved, but the LyX developers
4491 have decided to follow a different path and have made LyX itself capable
4492 of writing XHTML, just as it is capable of writing LaTeX, DocBook, and
4496 \begin_layout Standard
4497 As of this writing, XHTML output remains under development and should probably
4499 \begin_inset Quotes eld
4503 \begin_inset Quotes erd
4510 \begin_layout Plain Layout
4512 \begin_inset Flex Code
4515 \begin_layout Plain Layout
4516 development/HTML.notes
4521 , which can be found in the LyX source tree or
4522 \begin_inset CommandInset href
4524 name "accessed online"
4525 target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
4529 , usually contains up-to-date information about the state of XHTML output.
4530 See also the list of XHTML bugs on
4531 \begin_inset CommandInset href
4533 name "the bug tracker"
4534 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"
4543 Still, the developers have chosen this approach because it has several
4544 potential advantages over the other two.
4547 \begin_layout Standard
4548 These advantages are primarily due to the fact that the XHTML output routines,
4549 since they are part of LyX, know everything LyX knows about the document
4554 \begin_layout Plain Layout
4555 Another advantage is that, since these routines are internal to LyX, they
4556 are immune to changes in LyX's file format, or to changes in the semantics
4562 So they know about the table of contents (as displayed in the outline),
4563 about the counters associated with different paragraph styles, and about
4564 user-defined styles.
4565 The XHTML output routines know what LyX knows about internationalization,
4566 too, so they will output
4567 \begin_inset Quotes eld
4571 \begin_inset Quotes erd
4575 \begin_inset Quotes eld
4583 \begin_inset Quotes erd
4586 , depending upon the language in effect at the time.
4590 \begin_layout Standard
4591 Quite generally, the output routines know what LyX knows about document
4592 layout, that is, about how the document is to be rendered on screen.
4593 We use this information when we output the document as XHTML.
4598 generates CSS style information corresponding to the layout information
4599 it uses to render the document on screen: if section headings are supposed
4600 to be sans-serif and bold as seen in LyX, then (by default) they will be
4601 sans-serif and bold when viewed in a web browser, too.
4602 And this is true not just for pre-defined styles, like Section, but for
4603 any style, including user-defined styles.
4604 Indeed, the XHTML output routines make no distinction between user-defined
4605 paragraph and character styles and LyX's own pre-defined styles: in each
4606 case, everything LyX knows about the styles is contained in the layout
4608 And much the same is true as regards pre-defined textual insets, such as
4609 footnotes, and various custom insets.
4613 \begin_layout Standard
4614 The result is that XHTML output can be customized and extended in exactly
4615 the same way LaTeX output can be customized and extended: through layout
4617 See chapter five of the
4621 manual for the details.
4624 \begin_layout Standard
4625 The remainder of this chapter contains more detailed information on XHTML
4626 output, its limitations, and ways to work around those limitations.
4629 \begin_layout Section
4630 Math Output in XHTML
4633 \begin_layout Standard
4634 LyX offers four choices for how math is rendered.
4635 These have various advantages and disadvantages:
4638 \begin_layout Itemize
4640 \begin_inset Newline newline
4643 MathML is a dialect of XML designed specifically for mathematics on the
4644 web, and it typically renders very well in browsers that support it.
4645 The disadvantage is that not all browsers support MathML, and support is
4646 not complete even in the Gecko-based browsers, such as Firefox.
4647 \begin_inset Newline newline
4650 If LyX is unable to render a formula as MathML---for example, if the formula
4652 \begin_inset Flex Code
4655 \begin_layout Plain Layout
4661 package or ERT---then it will instead output the formula as an image.
4665 \begin_layout Itemize
4667 \begin_inset Newline newline
4671 \begin_inset Flex Code
4674 \begin_layout Plain Layout
4680 outputs math as HTML, styled by CSS.
4684 \begin_layout Plain Layout
4685 LyX has borrowed some of the CSS for its HTML output from
4686 \begin_inset Flex Code
4689 \begin_layout Plain Layout
4700 For simple formulae, this can work quite well, though with more complicated
4701 formulae it tends to break down.
4702 Still, this method has the advantage that it is very widely supported and
4703 so it may be appropriate for documents that contain only a little, fairly
4705 \begin_inset Newline newline
4708 If Lyx is unable to render a formula as HTML---for example, if the formula
4710 \begin_inset Flex Code
4713 \begin_layout Plain Layout
4719 package or ERT---then it will instead output the formula as an image.
4723 \begin_layout Itemize
4725 \begin_inset Newline newline
4729 \begin_inset Flex Code
4732 \begin_layout Plain Layout
4738 , LyX will output formulae as images, the very same images, in fact, that
4739 are used for instant preview.
4743 \begin_layout Plain Layout
4744 Instant preview does
4748 have to be on for images to be output, however.
4753 The advantage to this method is that the images are simply generated by
4754 LaTeX, so they are very accurate.
4755 The disadvantage, as mentioned earlier, is that these are bitmapped images,
4756 so they do not scale terribly well, and one cannot copy them, etc.
4757 (As of this writing, there are also problems about equation numbering.
4759 \begin_inset CommandInset href
4762 target "http://www.lyx.org/trac/ticket/6894"
4767 \begin_inset Newline newline
4770 The size of the images can be controlled by setting the
4771 \begin_inset Quotes eld
4775 \begin_inset Quotes erd
4779 \begin_inset Flex MenuItem
4782 \begin_layout Plain Layout
4783 Document\SpecialChar \menuseparator
4784 Settings\SpecialChar \menuseparator
4794 \begin_layout Plain Layout
4795 For those who want to know, this controls the resolution of the image in
4796 dots per inch and is based upon a default of 75 dpi.
4802 \begin_inset Newline newline
4805 If LyX for some reason fails to create an image for a formula (e.g., if a
4806 required LaTeX package is not installed), then it will fall back to outputing
4810 \begin_layout Itemize
4812 \begin_inset Newline newline
4815 Finally, LyX will happily output math as LaTeX.
4816 As well as being the output of last resort, this method can be used with
4818 \begin_inset CommandInset href
4821 target "http://www.math.union.edu/~dpvc/jsMath/"
4825 , which uses JavaScript to render LaTeX embedded in HTML documents.
4826 LyX wraps the LaTeX in either a
4827 \begin_inset Flex Code
4830 \begin_layout Plain Layout
4836 (for inline formulas) or
4837 \begin_inset Flex Code
4840 \begin_layout Plain Layout
4846 (for displayed formulas) with
4847 \begin_inset Flex Code
4850 \begin_layout Plain Layout
4856 , as is required for jsMath.
4859 \begin_layout Standard
4860 One of these output methods must be selected under
4861 \begin_inset Flex MenuItem
4864 \begin_layout Plain Layout
4865 Document\SpecialChar \menuseparator
4866 Settings\SpecialChar \menuseparator
4873 By default, LyX outputs MathML.
4874 This is a document-wide setting, therefore.
4877 \begin_layout Standard
4878 Eventually, LyX will offer the user the option to select an alternate output
4879 method for a particular inset, say, one that isn't being rendered very
4884 \begin_layout Plain Layout
4885 That said, since LyX falls back to images if the inset contains ERT, then
4886 one can force output as an image by putting some harmless ERT into the
4888 \begin_inset Formula $a=b\relax$
4899 \begin_layout Section
4900 Bibliography and Citations
4903 \begin_layout Standard
4904 XHTML output fully supports bibliographies and citations.
4908 \begin_layout Standard
4909 Citation labels are generated by the same machinery that generates LyX's
4910 on-screen labels, so the labels will look in the output much as they do
4911 in LyX, though better.
4912 If you are using numerical citations, then LyX will output numerical labels,
4913 such as [1] or [17], rather than simply showing the citation key in square
4914 brackets, as it does on-screen.
4915 If you are using author-year citations, then LyX will add lowercase letters
4916 to the years, just as BibTeX does, if it finds more than one citation for
4917 a given author-year combination.
4918 The labels will be printed with the bibliography entries.
4919 Note that there is, at present, no way to customize the appearance of the
4920 labels, for example, to choose between square brackets and parentheses.
4923 \begin_layout Standard
4924 Bibliography output is handled by the same machinery that handles the presentati
4925 on of reference information in the citation dialog, so you will see in the
4926 XHTML output pretty much what you would see if you were to look at a given
4927 entry in the citation dialog.
4928 The formatting can be customized in your layout file or, preferably, in
4934 manual for the details.
4937 \begin_layout Standard
4938 The main defect at present is that cross-referenced information is printed
4939 with every entry with which it is associated.
4940 So you can see things like this:
4945 \begin_inset Quotes eld
4948 Context and Logical Form
4949 \begin_inset Quotes erd
4954 Language in Context: Selected Essays
4956 (Oxford: Oxford University Press, 2007), pp.
4962 \begin_inset Quotes eld
4965 Semantics in Context
4966 \begin_inset Quotes erd
4971 Language in Context: Selected Essays
4973 (Oxford: Oxford University Press, 2007), pp.
4977 \begin_layout Standard
4978 This should be fixed before long.
4981 \begin_layout Standard
4982 There is no support at present for sectioned bibliographies.
4983 If you have multiple bibliographies, then LyX will print the same bibliography
4987 \begin_layout Section
4991 \begin_layout Standard
4992 LyX will happily export indexes as XHTML, but with certain limitations at
4996 \begin_layout Standard
4997 Index export will be most reliable when you do not attempt to use the fancy
4998 constructs that are described in the section on indexes in the
5006 \begin_layout Plain Layout
5007 The main issue here is that LyX itself does not really handle these.
5008 It just lets you enter what you would have to enter in raw LaTeX.
5013 We'll describe how they are handled using the subsection headings from
5017 \begin_layout Itemize
5018 Grouping Index Entries (aka, sub-entries): LyX makes an effort to support
5019 these, but the entries must be separated by
5020 \begin_inset Quotes eld
5024 \begin_inset Quotes erd
5027 , that is, there must be spaces around the exclamation point.
5028 This is because it is otherwise too difficult to check for escaped exclamation
5029 points, ones in math, and so forth.
5032 \begin_layout Itemize
5033 Page Ranges: There is no support at all for page ranges, since these make
5034 no sense with XHMTL.
5035 Instead, you will just get two index entries, one at either end.
5038 \begin_layout Itemize
5039 Cross-referencing: There is no support for cross-referencing.
5040 If LyX finds an entry containing the
5041 \begin_inset Quotes eld
5044 |see\SpecialChar \ldots{}
5046 \begin_inset Quotes erd
5049 construct, it is just dropped, and the rest is treated as an ordinary index
5053 \begin_layout Itemize
5054 Index Entry Order: LyX does support attempts to fix the sorting order.
5055 It will take what is before the first `@' it finds and use that for sorting,
5056 taking what follows the first `@' to be the actual entry.
5057 At present, LyX does not check for escaped `@', so do not try to index
5061 \begin_layout Itemize
5062 Index Entry Layout: You can format entries by using the text style dialog,
5063 or by using any other method available within LyX itself.
5064 There is no support for constructs like:
5065 \begin_inset Quotes eld
5069 \begin_inset Quotes erd
5073 Indeed, if LyX finds a pipe symbol, `|', in an entry, it will delete it
5074 and everything that follows it.
5077 \begin_layout Itemize
5078 Multiple Indexes: There is no support for multiple indexes.
5079 Rather, all index entries will be printed as one large index.
5080 To avoid our printing several versions of the index, we print only the
5081 main index, so make sure you have one.
5084 \begin_layout Section
5085 Nomenclature and Glossary
5088 \begin_layout Standard
5089 There is at present no support for glossaries.
5090 Adding it would be fairly trivial, and welcome.
5093 \begin_layout Chapter
5097 \begin_layout Section
5101 \begin_layout Standard
5102 The `LyX server' allows other programs to talk to LyX, invoke LyX commands,
5103 and retrieve information about the LyX internal state.
5104 This is only intended for advanced users, but they should find it useful.
5105 It is by writing to the LyX server, for example, that bibliography managers,
5106 such as JabRef, are able to
5107 \begin_inset Quotes eld
5111 \begin_inset Quotes erd
5117 \begin_layout Section
5118 Starting the LyX Server
5121 \begin_layout Standard
5122 The LyX server works through the use of a pair of named pipes.
5123 These are usually located in
5124 \begin_inset Flex Code
5127 \begin_layout Plain Layout
5133 , (except on Windows, where
5137 named pipes are special objects located in
5138 \begin_inset Flex Code
5141 \begin_layout Plain Layout
5153 ) and have the names
5154 \begin_inset Quotes eld
5158 \begin_inset Flex Code
5161 \begin_layout Plain Layout
5168 \begin_inset Quotes erd
5172 \begin_inset Quotes eld
5176 \begin_inset Flex Code
5179 \begin_layout Plain Layout
5186 \begin_inset Quotes erd
5190 External programs write into
5191 \begin_inset Flex Code
5194 \begin_layout Plain Layout
5200 and read back data from
5201 \begin_inset Flex Code
5204 \begin_layout Plain Layout
5211 The stem of the pipe names can be defined in the
5212 \begin_inset Flex MenuItem
5215 \begin_layout Plain Layout
5216 Tools\SpecialChar \menuseparator
5223 \begin_inset Flex Code
5226 \begin_layout Plain Layout
5227 "/home/myhome/lyxpipe"
5233 \begin_inset Flex Code
5236 \begin_layout Plain Layout
5250 on Windows (but any working path can be used).
5255 configure this manually in order for the server to start.
5258 \begin_layout Standard
5260 \begin_inset Flex Code
5263 \begin_layout Plain Layout
5270 \begin_inset Flex Code
5273 \begin_layout Plain Layout
5279 ' to create the pipes.
5280 If one of the pipes already exists, LyX will assume that another LyX process
5281 is already running and will not start the server.
5282 On POSIX (Unix like) systems, if for some other reason, an unused
5283 \begin_inset Quotes eld
5287 \begin_inset Quotes erd
5290 pipe is left in existence when LyX closes, then LyX will try to delete
5292 If this fails for some reason, you will need to delete the pipes manually
5293 and then restart LyX.
5294 On Windows, pipes are deleted by the OS on program termination or crash,
5296 \begin_inset Quotes eld
5300 \begin_inset Quotes erd
5303 pipes should not be possible.
5306 \begin_layout Standard
5307 To have several LyX processes with servers at the same time, you have to
5308 use different configurations, perhaps by using separate user directories,
5310 \begin_inset Flex Code
5313 \begin_layout Plain Layout
5319 file, for each process.
5322 \begin_layout Standard
5323 If you are developing a client program, you might find it useful to enable
5324 debugging information from the LyX server.
5325 Do this by starting LyX as
5326 \begin_inset Flex Code
5329 \begin_layout Plain Layout
5338 \begin_layout Standard
5339 You can find a complete example client written in C in the source distribution
5341 \begin_inset Flex Code
5344 \begin_layout Plain Layout
5345 development/lyxserver/server_monitor.c
5353 \begin_layout Standard
5354 Another useful tool is the command-line based clientfound in
5355 \begin_inset Flex Code
5358 \begin_layout Plain Layout
5359 src/client/lyxclient
5367 \begin_layout Section
5368 Normal communication
5371 \begin_layout Standard
5372 To issue a LyX call, the client writes a line of ASCII text into the input
5374 This line has the following format:
5391 \begin_layout Description
5392 clientname is a name that the client can choose arbitrarily.
5393 Its only use is that LyX will echo it if it sends an answer—so a client
5394 can dispatch results from different requesters.
5397 \begin_layout Description
5398 function is the function you want LyX to perform.
5399 It is the same as the commands you'd use in the minibuffer.
5402 \begin_layout Description
5403 argument is an optional argument which is meaningful only to some functions
5405 \begin_inset Quotes eld
5409 \begin_inset Quotes erd
5412 LFUN will insert the argument as text at the cursor position).
5415 \begin_layout Standard
5416 The answer from LyX will arrive in the output pipe and be of the form
5433 \begin_layout Standard
5442 are just echoed from the command request, while
5446 is more or less useful information filled according to how the command
5447 execution worked out.
5448 Some commands, such as
5449 \begin_inset Quotes eld
5453 \begin_inset Quotes erd
5456 , will return information about the internal state of LyX, while other will
5457 return an empty data-response.
5458 This means that the command execution went fine.
5461 \begin_layout Standard
5462 In case of errors, the response from LyX will have this form
5479 \begin_layout Standard
5484 should contain an explanation of why the command failed.
5487 \begin_layout Standard
5491 \begin_layout LyX-Code
5492 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
5493 \begin_inset Newline newline
5496 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
5497 \begin_inset Newline newline
5500 read a <~/.lyxpipe.out
5501 \begin_inset Newline newline
5507 \begin_layout Section
5511 \begin_layout Standard
5512 LyX can notify clients of events going on asynchronously.
5513 Currently it will only do this if the user binds a key sequence with the
5515 \begin_inset Quotes eld
5519 \begin_inset Quotes erd
5523 The format of the string LyX sends is as follows:
5527 \begin_inset Flex Code
5530 \begin_layout Plain Layout
5541 \begin_layout Standard
5546 is the printed representation of the key sequence that was actually typed
5550 \begin_layout Standard
5551 This mechanism can be used to extend LyX's command set and implement macros.
5552 Bind some key sequence to
5553 \begin_inset Quotes eld
5557 \begin_inset Quotes erd
5561 Then start a client that listens on the output pipe, dispatches the command
5562 according to the sequence, and starts a function that may use LyX calls
5563 and LyX requests to issue a command or a series of commands to LyX.
5566 \begin_layout Section
5567 The simple LyX Server Protocol
5570 \begin_layout Standard
5571 LyX implements a simple protocol that can be used for session management.
5572 All messages are of the form
5585 \begin_layout Standard
5591 \begin_inset Quotes eld
5595 \begin_inset Quotes erd
5599 \begin_inset Quotes eld
5603 \begin_inset Quotes erd
5608 \begin_inset Quotes eld
5612 \begin_inset Quotes erd
5615 is received from a client, LyX will report back to inform the client that
5616 it's listening to it's messages, while
5617 \begin_inset Quotes eld
5621 \begin_inset Quotes erd
5624 sent from LyX will inform clients that LyX is closing.
5627 \begin_layout Section
5628 Reverse DVI/PDF search
5631 \begin_layout Standard
5632 Some DVI/PDF viewers
5636 \begin_layout Plain Layout
5637 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
5638 Skim on Mac OSX and SumatraPDF on Windows.
5647 facility (also called
5652 This means that you can tell LyX to put the cursor to a specific line in
5653 the document by clicking at the respective position in the DVI/PDF output.
5654 To achieve this, the viewer must be able to communicate with LyX.
5655 This is done via the LyX server either by using the named pipe (
5659 ), or the UNIX domain socket (
5663 ) that LyX creates in its temporary directory (this is the way the
5664 \begin_inset Flex Code
5667 \begin_layout Plain Layout
5673 program communicates with LyX).
5674 In some cases, you need a helper script that mediates between the viewer
5675 and LyX, in others, the viewer can communicate with LyX directly.
5676 This depends on the selected viewer and on your operating system.
5677 The same applies to the way viewers need to be configured and the way the
5678 reverse search is actually performed.
5679 In what follows, we will thus describe how to setup reverse search for
5681 Before we turn to this, though, we will explain what needs to be done generally
5682 to enable reverse search in the DVI/PDF output.
5685 \begin_layout Subsection
5687 \begin_inset CommandInset label
5689 name "sub:rev-search"
5696 \begin_layout Standard
5697 In most cases LyX will do the work for you by enabling the option
5698 \begin_inset Flex MenuItem
5701 \begin_layout Plain Layout
5702 Synchronize with Output
5708 \begin_inset Flex MenuItem
5711 \begin_layout Plain Layout
5712 Document\SpecialChar \menuseparator
5713 Settings\SpecialChar \menuseparator
5720 In such a case LyX will automatically insert the necessary SyncTeX macro
5721 (for PDF) or load the srcltx package (for DVI) respectively.
5722 This option can be easily reached also on
5723 \begin_inset Flex Code
5726 \begin_layout Plain Layout
5735 \begin_layout Standard
5736 If you need a different setting, you can select or input a custom macro
5737 from the drop down box just below
5738 \begin_inset Flex MenuItem
5741 \begin_layout Plain Layout
5742 Document\SpecialChar \menuseparator
5743 Settings\SpecialChar \menuseparator
5744 Output\SpecialChar \menuseparator
5745 Synchronize with Output
5753 \begin_layout Standard
5754 Note that the method
5755 \begin_inset Flex Code
5758 \begin_layout Plain Layout
5766 enables gzip compression.
5767 If your viewer does not support it, you should instead use
5768 \begin_inset Flex Code
5771 \begin_layout Plain Layout
5782 \begin_layout Standard
5783 Please aöso note that including the
5784 \begin_inset Flex Code
5787 \begin_layout Plain Layout
5794 \begin_inset Flex Code
5797 \begin_layout Plain Layout
5803 sometimes has an undesired impact on the typesetting.
5804 Thus, you should switch output synchronization off for the final typesetting
5806 \begin_inset Flex Code
5809 \begin_layout Plain Layout
5816 \begin_inset Flex Code
5819 \begin_layout Plain Layout
5829 \begin_layout Standard
5830 In case you need some more special settings that are not covered by the
5831 automatic settings, read the next section about how to set up output synchroniz
5833 If the automatic setup suits your needs, you can readily jump to section
5834 \begin_inset space ~
5838 \begin_inset CommandInset ref
5840 reference "sub:configuring-viewers"
5844 , where the necessary configuration steps in your viewer -- needed both
5845 with the automatic and the manual setup -- are described.
5848 \begin_layout Subsection
5852 \begin_layout Standard
5853 LaTeX provides several different methods for reverse search.
5854 Some are built-in in the
5855 \begin_inset Flex Code
5858 \begin_layout Plain Layout
5864 program, some are provided by external packages.
5865 Your choice depends on whether your LaTeX distribution already provides
5866 a given method (the built-in methods are rather new) and whether your viewer
5868 The available methods are described in the following.
5871 \begin_layout Subsubsection*
5872 Built-in DVI-search via src-specials (DVI only)
5875 \begin_layout Standard
5876 This method provides the DVI file with the necessary information for reverse
5878 It is available in LaTeX since quite some time (any somewhat recent LaTeX
5879 distribution should include it), and it works reliably.
5880 To enable it, change the
5881 \begin_inset Flex MenuItem
5884 \begin_layout Plain Layout
5889 \begin_layout Plain Layout
5902 \begin_inset Flex MenuItem
5905 \begin_layout Plain Layout
5910 \begin_layout Plain Layout
5917 eX (plain)->DraftDVI
5923 \begin_inset Flex MenuItem
5926 \begin_layout Plain Layout
5927 Preferences\SpecialChar \menuseparator
5928 File Handling\SpecialChar \menuseparator
5935 \begin_inset Flex Code
5938 \begin_layout Plain Layout
5939 latex -src-specials $$i
5945 If this doesn't work, check if your TeX engine needs different options
5946 (the syntax might differ in some distributions).
5949 \begin_layout Subsubsection*
5950 External Packages (PDFSync and scrltx)
5953 \begin_layout Standard
5962 provide reverse search facility for PDF output (via pdflatex) and DVI output,
5964 In order to enable it, load the packages in the LyX preamble:
5967 \begin_layout Itemize
5968 \begin_inset Flex Code
5971 \begin_layout Plain Layout
5979 for reverse PDF search,
5982 \begin_layout Itemize
5983 \begin_inset Flex Code
5986 \begin_layout Plain Layout
5989 usepackage[active]{srcltx}
5994 for reverse DVI search.
5997 \begin_layout Standard
5998 If you want to be able to perform both DVI and PDF reverse searches, you
5999 can also insert in the preamble the following lines
6002 \begin_layout LyX-Code
6006 \begin_inset Newline newline
6012 \begin_inset Newline newline
6018 \begin_inset Newline newline
6024 \begin_inset Newline newline
6029 usepackage[active]{srcltx}
6030 \begin_inset Newline newline
6038 \begin_layout Standard
6039 This way, you can preview the file as either DVI or PDF (pdflatex) and the
6040 right package will be used.
6043 \begin_layout Standard
6044 Note that PDFSync might affect the output layout of your document.
6045 It is therefore advised to disable PDFsync for final documents.
6048 \begin_layout Subsubsection*
6049 Built-in reverse search via SyncTeX (DVI and PDF)
6052 \begin_layout Standard
6054 \begin_inset Flex Code
6057 \begin_layout Plain Layout
6063 have built-in support for both PDF and DVI reverse search.
6068 facility is basically the result of the integration of the PDFSync package
6069 to the pdftex program and its merge with the
6074 You need at least TeXLive 2008 or a recent MikTeX distribution in order
6076 Also note that only a few PDF viewers (Skim on the Mac, SumatraPDF on Windows)
6077 already provide SyncTeX support.
6080 \begin_layout Standard
6081 To enable SyncTeX for DVI output, change the
6082 \begin_inset Flex MenuItem
6085 \begin_layout Plain Layout
6090 \begin_layout Plain Layout
6103 \begin_inset Flex MenuItem
6106 \begin_layout Plain Layout
6111 \begin_layout Plain Layout
6118 eX (plain) -> DraftDVI
6124 \begin_inset Flex MenuItem
6127 \begin_layout Plain Layout
6128 Preferences\SpecialChar \menuseparator
6129 File Handling\SpecialChar \menuseparator
6136 \begin_inset Flex Code
6139 \begin_layout Plain Layout
6140 latex -synctex=1 $$i
6145 , and for PDF output, change the
6146 \begin_inset Flex MenuItem
6149 \begin_layout Plain Layout
6154 \begin_layout Plain Layout
6161 eX (pdflatex) -> PDF (pdflatex)
6167 \begin_inset Flex Code
6170 \begin_layout Plain Layout
6171 pdflatex -synctex=1 $$i
6177 Check the documentation of your viewer whether the viewer needs to be configure
6178 d for the use with SyncTeX.
6182 \begin_layout Plain Layout
6183 Note that the option
6184 \begin_inset Flex Code
6187 \begin_layout Plain Layout
6193 option enables gzip compression.
6194 If your viewer does not support it, you should instead use
6195 \begin_inset Flex Code
6198 \begin_layout Plain Layout
6212 \begin_layout Subsection
6213 Configuring and using specific viewers
6214 \begin_inset CommandInset label
6216 name "sub:configuring-viewers"
6223 \begin_layout Subsubsection*
6224 Xdvi (all platforms)
6227 \begin_layout Standard
6229 \begin_inset Flex Code
6232 \begin_layout Plain Layout
6238 , you don't need to do anything else for performing a reverse DVI search,
6239 as LyX already provides the necessary hooks for automatically using the
6241 \begin_inset Flex Code
6244 \begin_layout Plain Layout
6251 Just setup your document as described above (reverse search is triggered
6252 by Ctrl-click or Alt-click on Mac OSX, respectively).
6255 \begin_layout Standard
6256 However, if for whatever reason you want to use the named pipe instead of
6257 the socket for communicating with LyX, simply change the DVI viewer in
6259 \begin_inset Flex MenuItem
6262 \begin_layout Plain Layout
6263 Preferences\SpecialChar \menuseparator
6264 File Handling\SpecialChar \menuseparator
6274 \begin_layout Plain Layout
6275 On Mac OSX you have to use
6276 \begin_inset Flex Code
6279 \begin_layout Plain Layout
6280 DISPLAY=:0.0 xdvi -editor 'lyxeditor.sh %f %l'
6291 \begin_inset Flex Code
6294 \begin_layout Plain Layout
6295 xdvi -editor 'lyxeditor.sh %f %l'
6301 \begin_inset Flex Code
6304 \begin_layout Plain Layout
6310 is a suitable script.
6311 For example, a minimal shell script is the following one:
6314 \begin_layout LyX-Code
6316 \begin_inset Newline newline
6319 LYXPIPE="/path/to/lyxpipe"
6320 \begin_inset Newline newline
6323 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
6324 \begin_inset Newline newline
6327 echo "$COMMAND" > "${LYXPIPE}".in || exit
6328 \begin_inset Newline newline
6331 read < "${LYXPIPE}".out || exit
6334 \begin_layout Standard
6336 \begin_inset Flex Code
6339 \begin_layout Plain Layout
6349 \begin_layout Plain Layout
6356 XServer pipe path specified in
6357 \begin_inset Flex MenuItem
6360 \begin_layout Plain Layout
6361 Preferences\SpecialChar \menuseparator
6371 \begin_layout Plain Layout
6373 \begin_inset Flex Code
6376 \begin_layout Plain Layout
6382 folder of a source distribution you can find a
6383 \begin_inset Flex Code
6386 \begin_layout Plain Layout
6392 script which is able to locate the
6396 based on your preferences.
6404 \begin_layout Subsubsection*
6408 \begin_layout Standard
6410 \begin_inset Flex Code
6413 \begin_layout Plain Layout
6414 /Applications/MacDviX_Folder/calleditor.script
6419 , add the following lines:
6422 \begin_layout LyX-Code
6427 \begin_layout Plain Layout
6434 X.app/Contents/MacOS/lyxeditor "$2" $1
6435 \begin_inset Newline newline
6441 \begin_layout Standard
6442 Modify the lines accordingly if you install LyX somewhere else than in the
6443 Applications folder.
6446 \begin_layout Standard
6447 Reverse search is triggered by Alt-click (OPTION-click).
6450 \begin_layout Subsubsection*
6454 \begin_layout Standard
6456 \begin_inset Flex Code
6459 \begin_layout Plain Layout
6460 open -a Skim.app $$i
6465 to the viewer setting in
6466 \begin_inset Flex MenuItem
6469 \begin_layout Plain Layout
6470 Preferences\SpecialChar \menuseparator
6471 File Handling\SpecialChar \menuseparator
6472 File formats\SpecialChar \menuseparator
6479 \begin_inset Flex MenuItem
6482 \begin_layout Plain Layout
6483 Skim\SpecialChar \menuseparator
6484 Preferences\SpecialChar \menuseparator
6494 \begin_layout Plain Layout
6504 \begin_layout Standard
6505 Reverse search is triggered by COMMAND-SHIFT-click
6508 \begin_layout Subsubsection*
6512 \begin_layout Standard
6514 \begin_inset Flex MenuItem
6517 \begin_layout Plain Layout
6518 Settings\SpecialChar \menuseparator
6519 Configure Okular\SpecialChar \ldots{}
6520 \SpecialChar \menuseparator
6527 \begin_inset Quotes eld
6531 \begin_inset Quotes erd
6535 \begin_inset Flex Code
6538 \begin_layout Plain Layout
6547 \begin_layout Standard
6548 Reverse search is triggered by SHIFT-click.
6551 \begin_layout Subsubsection*
6555 \begin_layout Standard
6556 Launch yap, choose its
6557 \begin_inset Flex MenuItem
6560 \begin_layout Plain Layout
6561 View\SpecialChar \menuseparator
6568 \begin_inset Quotes eld
6572 \begin_inset Quotes erd
6577 \begin_inset Quotes eld
6580 New\SpecialChar \ldots{}
6582 \begin_inset Quotes erd
6585 button and, in the window that opens, enter
6586 \begin_inset Quotes eld
6590 \begin_inset Quotes erd
6593 (or any other name you like) in the
6594 \begin_inset Quotes eld
6598 \begin_inset Quotes erd
6602 Now click on the button labeled
6603 \begin_inset Quotes eld
6606 \SpecialChar \ldots{}
6608 \begin_inset Quotes erd
6611 to open a file dialog and navigate to the directory containing the batch
6613 \begin_inset Flex Code
6616 \begin_layout Plain Layout
6624 \begin_inset Flex Code
6627 \begin_layout Plain Layout
6633 and then specify the program arguments as
6634 \begin_inset Flex Code
6637 \begin_layout Plain Layout
6645 \begin_inset Flex Code
6648 \begin_layout Plain Layout
6654 wrapper is used for communicating with LyX through the
6661 \begin_layout LyX-Code
6663 \begin_inset Newline newline
6666 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
6675 \begin_inset Newline newline
6689 \begin_layout Standard
6690 Make sure that the LyXServer pipe path you specified in LyX is
6691 \begin_inset Flex Code
6694 \begin_layout Plain Layout
6708 , otherwise change the
6709 \begin_inset Flex Code
6712 \begin_layout Plain Layout
6718 wrapper accordingly.
6721 \begin_layout Standard
6722 In yap, reverse search is triggered by double-click.
6725 \begin_layout Subsubsection*
6726 SumatraPDF (Windows)
6729 \begin_layout Standard
6730 In order to use SumatraPDF for inverse search, enter
6731 \begin_inset Flex Code
6734 \begin_layout Plain Layout
6735 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
6740 in the viewer setting in
6741 \begin_inset Flex MenuItem
6744 \begin_layout Plain Layout
6745 Preferences\SpecialChar \menuseparator
6746 File Handling\SpecialChar \menuseparator
6747 File formats\SpecialChar \menuseparator
6754 \begin_inset Flex Code
6757 \begin_layout Plain Layout
6763 is the previous wrapper.
6764 If SumatraPDF.exe is not in your command PATH, use its full file name.
6767 \begin_layout Standard
6768 Reverse search is triggered by double-click.
6771 \begin_layout Subsubsection*
6775 \begin_layout Standard
6776 First of all, make sure that yap is your default DVI viewer in the Windows
6777 environment, then launch it, choose its
6778 \begin_inset Flex MenuItem
6781 \begin_layout Plain Layout
6782 View\SpecialChar \menuseparator
6789 \begin_inset Quotes eld
6793 \begin_inset Quotes erd
6798 \begin_inset Quotes eld
6801 New\SpecialChar \ldots{}
6803 \begin_inset Quotes erd
6806 button and, in the window that opens, enter
6807 \begin_inset Quotes eld
6811 \begin_inset Quotes erd
6814 (or any other name you like) in the
6815 \begin_inset Quotes eld
6819 \begin_inset Quotes erd
6823 Now click on the button labeled
6824 \begin_inset Quotes eld
6827 \SpecialChar \ldots{}
6829 \begin_inset Quotes erd
6832 to open a file dialog and navigate to the directory containing the
6833 \begin_inset Flex Code
6836 \begin_layout Plain Layout
6842 program (which is installed by default on Cygwin along with the LyX executable).
6844 \begin_inset Flex Code
6847 \begin_layout Plain Layout
6853 and then specify the program arguments as
6854 \begin_inset Flex Code
6857 \begin_layout Plain Layout
6864 In this way, you will be using the
6868 for communicating with LyX.
6869 If, for whatever reason, you want to use the
6874 \begin_inset Flex Code
6877 \begin_layout Plain Layout
6883 option and be sure to specify the LyXServer pipe path in the LyX preferences.
6886 \begin_layout Standard
6887 In yap, reverse search is triggered by double-click.
6890 \begin_layout Subsubsection*
6894 \begin_layout Standard
6895 In order to use SumatraPDF for inverse search, enter
6896 \begin_inset Flex Code
6899 \begin_layout Plain Layout
6900 SumatraPDF -inverse-search "lyxeditor -g %f %l"
6905 in the viewer setting in
6906 \begin_inset Flex MenuItem
6909 \begin_layout Plain Layout
6910 Preferences\SpecialChar \menuseparator
6911 File Handling\SpecialChar \menuseparator
6912 File formats\SpecialChar \menuseparator
6919 If SumatraPDF.exe is not in your command PATH, use its full posix path.
6921 \begin_inset Flex Code
6924 \begin_layout Plain Layout
6930 enables communication via the
6936 \begin_inset Flex Code
6939 \begin_layout Plain Layout
6945 option if you want to use the
6949 , and be sure to specify the LyXServer pipe path in the LyX preferences.
6952 \begin_layout Standard
6953 Reverse search is triggered by double-click.
6956 \begin_layout Section
6960 \begin_layout Standard
6961 Forward search is, as the name implies, in a sense the
6962 \begin_inset Quotes eld
6966 \begin_inset Quotes erd
6970 It allows you to let the viewer jump to a given position from within LyX.
6971 If forward search is set up (as described in what follows), you can put
6972 the cursor anywhere in your LyX document, and hit
6973 \begin_inset Flex MenuItem
6976 \begin_layout Plain Layout
6977 Navigate\SpecialChar \menuseparator
6984 \begin_inset Flex MenuItem
6987 \begin_layout Plain Layout
6993 in the context menu via right mouse click), and then the viewer will jump
6994 to that position as well.
6995 This implies, of course, that your viewer supports this function.
6998 \begin_layout Standard
6999 To make forward search possible, you first need to provide the generated
7000 output PDF/DVI file with additional information about the TeX sources.
7001 This can be done via the methods described in the section
7002 \begin_inset CommandInset ref
7004 reference "sub:rev-search"
7011 \begin_layout Standard
7012 Additionally, you need to configure LyX for using your viewers in
7013 \begin_inset Flex MenuItem
7016 \begin_layout Plain Layout
7017 Tools\SpecialChar \menuseparator
7018 Preferences\SpecialChar \menuseparator
7019 Output\SpecialChar \menuseparator
7026 We provide a range of tested configurations for some viewers, which you
7027 can select from the drop down list.
7028 If none of these configurations suits you, you have to find out and enter
7029 a suitable configuration yourself.
7030 The definition syntax uses the following placeholders:
7033 \begin_layout Itemize
7035 \begin_inset Flex Code
7038 \begin_layout Plain Layout
7047 \begin_layout Itemize
7049 \begin_inset Flex Code
7052 \begin_layout Plain Layout
7058 : name of the (temporary) exported .tex file
7061 \begin_layout Itemize
7063 \begin_inset Flex Code
7066 \begin_layout Plain Layout
7072 : name of the exported output file (either dvi or pdf, depending on which
7073 one exists in the temporary directory)
7076 \begin_layout Standard
7077 Note that only some of the viewers provide full forward search functionality,
7078 among them yap, xdvi, okular and Sumatra PDF.
7082 \begin_layout Plain Layout
7083 For Sumatra CMCDDE is needed --- downloadable from
7084 \begin_inset CommandInset href
7086 target "http://www.istri.fr/zip/CMCDDE.zip"
7095 While many of the widespread PDF viewers (most notably Adobe Reader) do
7096 not support forward search at all, some other viewers -- e.
7097 \begin_inset space \thinspace{}
7101 evince and xpdf -- allow at least to reload the document and jump to a
7102 specific page of the file, so you can at least navigate
7103 \begin_inset Quotes eld
7107 \begin_inset Quotes erd
7111 This latter functionality is provided by an external call of synctex (see
7112 the predefined example configurations).
7116 \begin_layout Standard
7117 Forward search works both with DVI and PDF output.
7118 LyX simply checks which preview format you have used before (i.
7119 \begin_inset space \thinspace{}
7122 e., which format is already there in the temporary directory) and chooses
7123 the appropriate configuration for the respective format.
7126 \begin_layout Chapter
7127 Special Document Classes
7130 \begin_layout Section
7134 \begin_layout Standard
7140 \begin_layout Subsection
7144 \begin_layout Standard
7145 This section describes how LyX can be used to write articles for submission
7146 to the scientific journal
7148 Astronomy and Astrophysics
7150 (www.edpsciences.fr/aa/
7151 \begin_inset Flex URL
7154 \begin_layout Plain Layout
7156 http://www.edpsciences.fr/aa/
7161 ) using Version 5.01 of the document class
7166 This package can be downloaded from the ftp site
7169 \begin_layout Standard
7170 \begin_inset VSpace medskip
7176 \begin_layout Standard
7178 \begin_inset Flex URL
7181 \begin_layout Plain Layout
7183 ftp://ftp.edpsciences.org/pub/aa/readme.html
7191 \begin_layout Standard
7192 \begin_inset VSpace medskip
7198 \begin_layout Standard
7199 A manual comes together with that package, and this text is not meant to
7200 replace the original manual but is merely a short guide in how to realize
7201 the correct form of your paper.
7205 \begin_layout Standard
7206 Please note that the publisher of the journal was changed from Springer
7207 to EDP Sciences starting January 1, 2001.
7208 That change involved also some slight changes to the style files, namely
7209 the removal of the thesaurus command.
7210 The LyX class aa supports the newest version of these style files, V 5.01.
7211 If you have an older version installed, please upgrade.
7212 For compatibility, the old (version 4) layout has been kept as
7217 Please refer to the comments in
7219 LyXDir/layouts/aapaper.layout
7224 \begin_layout Subsection
7228 \begin_layout Standard
7229 It is recommended you start from the example template distributed with LyX.
7230 If you are not using a template, note the following settings:
7233 \begin_layout Itemize
7240 Document\SpecialChar \menuseparator
7243 dialog (OK, that one was obvious).
7246 \begin_layout Itemize
7247 Don't change the option
7250 \begin_inset space ~
7260 The whole layout is done by the macros, you shouldn't change anything.
7263 \begin_layout Subsection
7267 \begin_layout Standard
7268 First thing to enter is the header information.
7269 It consists of seven entries, of which some are optional.
7273 \begin_layout Itemize
7281 \begin_layout Itemize
7289 \begin_layout Itemize
7297 \begin_layout Itemize
7305 \begin_layout Itemize
7310 : [optional] if more than one author: whom to contact for offprint requests.
7313 \begin_layout Itemize
7318 : [optional] mail address for contacts.
7321 \begin_layout Itemize
7329 Received: <date>; Accepted <date>
7332 \begin_layout Standard
7333 There is no need to issue the
7339 command, this is done automatically by LyX when the header is finished.
7340 Although the order of the single header entries doesn't matter it is advised
7341 to keep the above sequence, just to get the best optics and meets the layout
7342 of the real document.
7345 \begin_layout Standard
7346 If you want to place footnotes in the header block, e.
7347 \begin_inset space \thinspace{}
7351 \begin_inset space \space{}
7354 to state your present address, just use the standard footnote via the menu
7357 Insert\SpecialChar \menuseparator
7361 LyX will automagically use the term
7370 \begin_layout Standard
7371 In addition to these topics, the macros use three additional LaTeX commands
7372 that have no counterpart in LyX:
7375 \begin_layout Itemize
7382 to separate different names for more than one author and institute, respectivel
7386 \begin_layout Itemize
7393 to mark corresponding author/institute pairs.
7394 The institutes are numbered sequentially as they appear in the
7398 field, so you have to put a marker to each author.
7401 \begin_layout Itemize
7408 to supply an email address for fast contact.
7411 \begin_layout Standard
7412 In all cases, the appropriate command has to be entered in LyX and marked
7418 \begin_layout Subsection
7422 \begin_layout Standard
7423 The abstract should immediately follow the header block.
7424 With version 5 the abstract environment was changed to a command, and there
7425 is now a resctriction to only one paragraph.
7426 In addition, it should contain an entry with the keywords.
7427 This is not yet implemented for LyX, therefore you have to enter the LaTeX
7434 by hand and mark it as LaTeX code.
7435 Refer to the example paper.
7438 \begin_layout Subsection
7439 Supported environments
7442 \begin_layout Standard
7443 The A&A paper layout supports the following environments for structuring
7447 \begin_layout Itemize
7453 \begin_layout Itemize
7459 \begin_layout Itemize
7465 \begin_layout Itemize
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 Subsection
7520 Commands not supported by LyX
7523 \begin_layout Standard
7524 Some commands are not yet supported by the
7529 Some have already been mentioned.
7530 For the sake of completeness, they are listed all together here:
7533 \begin_layout Itemize
7541 \begin_layout Itemize
7549 \begin_layout Itemize
7557 \begin_layout Itemize
7565 \begin_layout Itemize
7573 \begin_layout Itemize
7581 \begin_layout Itemize
7589 \begin_layout Itemize
7597 \begin_layout Standard
7598 If you want to use any of these commands, you have to enter them yourself.
7601 Do not forget to mark them as LaTeX code!
7604 \begin_layout Subsection
7605 Figure and Table Floats
7608 \begin_layout Standard
7609 LyX provides support for the necessary float environments
7611 figure, figure*, table
7617 , therefore we won't tell much about it here.
7621 \begin_inset space ~
7627 Just remember that tables should be left-aligned.
7628 For that, select the table and change the alignment in
7630 Edit\SpecialChar \menuseparator
7632 \begin_inset space ~
7638 \begin_layout Standard
7639 There is only one special thing: the figures with caption besides the figure.
7640 To create such a figure, you have to do the following:
7643 \begin_layout Enumerate
7644 Create a wide figure float:
7646 Insert\SpecialChar \menuseparator
7647 Float\SpecialChar \menuseparator
7650 , then right click in the figure and select
7656 \begin_inset space ~
7664 \begin_layout Enumerate
7665 Enter your caption text.
7668 \begin_layout Enumerate
7673 to move the cursor above the caption.
7676 \begin_layout Enumerate
7680 \begin_layout Enumerate
7681 Position the cursor behind the figure and insert a horizontal fill:
7683 Insert\SpecialChar \menuseparator
7685 \begin_inset space ~
7688 Character\SpecialChar \menuseparator
7690 \begin_inset space ~
7698 \begin_layout Enumerate
7699 Switch to LaTeX mode:
7702 \begin_inset space ~
7710 \begin_layout Enumerate
7720 Do not close the brace!
7723 \begin_layout Enumerate
7724 Position the cursor behind the caption text, switch to LaTeX mode and insert
7728 \begin_inset space ~
7740 \begin_layout Standard
7741 Also, refer to the figures in the example paper.
7744 \begin_layout Subsection
7748 \begin_layout Standard
7749 For submission, the paper has to be formated in a special double-spacing
7751 For this purpose, you have to give the option
7755 to the documentclass.
7756 This must be done using the extra class options field in the
7758 Document\SpecialChar \menuseparator
7762 Just enter the string
7769 \begin_layout Subsection
7773 \begin_layout Standard
7778 directory contains an example paper written with LyX.
7779 It is the example paper from the original macro package, translated to
7781 Use it for inspiration, and compare the original LaTeX code with LyX way
7785 \begin_layout Section
7789 \begin_layout Standard
7795 \begin_layout Subsection
7799 \begin_layout Standard
7800 AASTeX is a set of macros produced by the American Astronomical Society
7801 to facilitate electronic manuscript submission to the three journals they
7802 publish: the Astrophysical Journal (including the Letters and Supplement),
7803 the Astronomical Journal, and the Publications of the Astronomical Society
7805 LyX has proven to be an excellent tool for generating these documents,
7806 especially given its equation, citation, and figure handling capabilities.
7807 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
7808 is the version described here, or higher.
7809 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
7810 incompatible with LyX.
7811 The AASTeX package may be downloaded from the AASTeX Web site
7814 \begin_layout Standard
7815 \begin_inset VSpace medskip
7821 \begin_layout Standard
7823 \begin_inset Flex URL
7826 \begin_layout Plain Layout
7828 http://www.journals.uchicago.edu/AAS/AASTeX
7836 \begin_layout Standard
7837 \begin_inset VSpace medskip
7843 \begin_layout Standard
7844 A complete user guide is contained in that package and you should familiarize
7845 yourself with it thoroughly before embarking on writing a paper in LyX.
7846 LyX will not reduce the need to figure out all the AASTeX commands, it
7847 will only reduce the drudgery of typing everything in.
7848 It is your responsibility to ensure that the final exported LaTeX document
7849 conforms completely to the requirements of the journal to which you are
7850 submitting your paper.
7853 \begin_layout Subsection
7854 Starting a New Paper
7857 \begin_layout Standard
7858 I strongly suggest that you start with the AASTeX template file.
7861 File\SpecialChar \menuseparator
7868 , enter the new file name, then choose the
7873 This will show the most common fields found in a manuscript.
7874 Simply overwrite the existing text (including the brackets,
7878 ) with the correct information.
7879 Many of the AASTeX commands and environments can be implemented directly
7880 in LyX, but some cannot: most noticeably
7892 , which should stick out like a sore thumb if you actually just opened the
7894 For commands such as these, the LaTeX code must be entered directly and
7896 Such commands are referred to as TeX code, or Evil Red Text.
7897 I tried to minimize the amount of TeX code needed in an AASTeX document,
7898 but there is still a bit more required than any of us would like.
7901 \begin_layout Subsection
7902 Finishing Your Paper
7905 \begin_layout Standard
7906 When the paper is finished to your satisfaction and previews/prints correctly,
7908 \begin_inset Quotes eld
7912 \begin_inset Quotes erd
7915 actions which need to be done before you submit it to the journals.
7919 \begin_layout Enumerate
7920 Export your paper as a LaTeX file (
7922 File\SpecialChar \menuseparator
7923 Export\SpecialChar \menuseparator
7930 \begin_layout Enumerate
7935 file with your favorite text editor
7939 \begin_layout Enumerate
7940 remove the comment lines before the
7949 \begin_layout Enumerate
7954 usepackage...{fontenc}
7956 line if it appears (usually just after
7971 \begin_layout Enumerate
7972 remove everything between (and including) the
7984 commands, except for any commands you specifically put into the LaTeX preamble
7985 (which should appear immediately after the
7986 \begin_inset Quotes eld
7989 User specified LaTeX commands
7990 \begin_inset Quotes erd
8001 \begin_layout Enumerate
8002 Run the resulting file through LaTeX to make sure it still processes correctly.
8005 \begin_layout Enumerate
8006 Reread the journal requirements to make sure your filenames and formats
8010 \begin_layout Enumerate
8014 \begin_layout Subsection
8015 Comments On Specific Commands
8018 \begin_layout Standard
8019 I will not describe the detailed usage of the individual AASTeX commands:
8020 the AASTeX User Guide (
8024 ) gives a good description of each.
8025 Thus it's probably easiest for me to go down the list as found in the guide
8026 and offer comments where necessary.
8027 So let's begin \SpecialChar \ldots{}
8031 \begin_layout Subsubsection
8032 Things that work as expected
8035 \begin_layout Standard
8036 Because they work as you might expect, I simply list them and the section
8137 begin{thebibliography}
8145 (2.13.2), all the cite commands and their variations (2.13.2), the generic
8146 graphicx figure commands (2.14.1),
8170 (2.15.4, amongst other places),
8197 \begin_layout Standard
8198 The following style options also work correctly:
8219 Simply put them in the
8225 Layout\SpecialChar \menuseparator
8231 \begin_layout Subsubsection
8232 Things that work, but require more comment
8235 \begin_layout Standard
8236 The following items work, but require a little more discussion:
8239 \begin_layout Itemize
8240 These items are reserved for use by the journal editors, but you can put
8241 them into the LaTeX preamble if you feel compelled to do so:
8274 \begin_layout Itemize
8275 These items may be placed in the LaTeX preamble, and are included as blanks
8276 in the template file:
8297 \begin_layout Itemize
8304 (2.3) – can only be used
8305 \begin_inset Quotes eld
8309 \begin_inset Quotes erd
8312 , not in the middle of a paragraph.
8313 Use TeX code if you need to embed it.
8316 \begin_layout Itemize
8323 (2.3) – will have extra {} after it.
8324 This should not cause an error.
8327 \begin_layout Itemize
8334 (2.6) – can only be used
8335 \begin_inset Quotes eld
8339 \begin_inset Quotes erd
8342 , not in the middle of a paragraph.
8343 Use TeX code if you need to embed it.
8346 \begin_layout Itemize
8353 (2.8) – can't insert a cross-reference tag, you must type the tag name by
8357 \begin_layout Itemize
8371 \begin_layout Itemize
8378 (2.9) – will have extra {} after it.
8379 This should not cause an error.
8382 \begin_layout Itemize
8389 (2.11) – will have extra {} after it.
8390 This should not cause an error.
8393 \begin_layout Itemize
8400 (2.14.2) – you can insert an optional filename argument by placing the cursor
8401 at the beginning of the text and selecting
8403 Insert\SpecialChar \menuseparator
8408 \begin_inset Quotes eld
8412 \begin_inset Quotes erd
8415 inserts an optional argument of the type needed by
8422 Hopefully it will be renamed someday.
8425 \begin_layout Itemize
8438 for the catalog ID optional parameter
8441 \begin_layout Itemize
8454 for the catalog ID optional parameter
8457 \begin_layout Subsubsection
8458 Things not implemented, use TeX code
8461 \begin_layout Standard
8484 setcounter{equation}
8486 (2.12), Journal name abbreviations (2.13.4),
8522 (2.15.4, insert it as the first element in the lefthand cell after where
8524 Don't use any of LyX's rules in the table),
8536 (2.15.5), much of Misc (2.17, except
8587 \begin_layout Subsubsection
8588 Things that cannot be implemented
8591 \begin_layout Standard
8592 \SpecialChar \ldots{}
8593 at least in any meaningful sort of way, so I suggest ignoring them.
8594 They are the references environment (2.13.3), and the deluxetable environment
8596 If you really, really need to use deluxetable, I suggest editing it in
8597 a separate file with a text editor, then using
8599 Insert\SpecialChar \menuseparator
8601 \begin_inset space ~
8606 to include it in your LyX document.
8611 file to see an example of this.
8614 \begin_layout Subsection
8615 FAQs, Tips, Tricks, and Other Ruminations
8618 \begin_layout Subsubsection
8619 Getting LyX and AASTeX to cooperate
8622 \begin_layout Standard
8623 It can be a bit tricky to get LyX to recognize a new layout and document
8625 When all else fails, do this:
8628 \begin_layout Enumerate
8629 Make certain that LaTeX can find AASTeX.
8630 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
8631 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
8638 \begin_layout Enumerate
8650 \begin_layout Enumerate
8653 Tools\SpecialChar \menuseparator
8656 in LyX, then restart LyX.
8659 \begin_layout Enumerate
8660 Open a regular new file, not from a template.
8661 Does AASTeX appear in the class list in
8663 Document\SpecialChar \menuseparator
8669 \begin_layout Standard
8670 If you get a warning from an existing AASTeX document about not being able
8671 to find the AASTeX layout or a message about
8672 \begin_inset Quotes eld
8675 You should not mix title layouts with normal ones
8676 \begin_inset Quotes erd
8679 , things haven't been installed correctly.
8682 \begin_layout Subsubsection
8683 LaTeX error processing a table
8686 \begin_layout Standard
8687 LyX, by default, attempts to center the table caption/title.
8688 This seems to produce a bad interaction in AASTeX so you should click somewhere
8689 in the caption/title, then select
8691 Edit\SpecialChar \menuseparator
8693 \begin_inset space ~
8707 This took care of it for me.
8710 \begin_layout Subsubsection
8714 \begin_layout Standard
8715 A couple of things: 1) I have noticed some funny spacing in the reference
8716 entries in the text.
8717 When you enter the bibliography item data, make sure their is
8721 space between the last author and the parenthesis setting off the year;
8725 \begin_inset space \thinspace{}
8729 \begin_inset space \space{}
8743 2) Entering the references at all is not obvious.
8744 The easiest thing is to start typing your first reference at the end of
8745 the document, then mark it as type
8750 That will put a small gray box in front of what you just typed.
8751 Click on the box to fill in the rest of the information.
8752 For new references, go to the end of an existing reference and press return.
8753 That will create a new line with its own box, etc.
8756 \begin_layout Subsubsection
8760 \begin_layout Standard
8761 Even though AASTeX provides its own figure commands (
8767 , for example), I much prefer LaTeX's standard figure commands (with the
8776 \begin_inset space ~
8779 commands as TeX code into a Figure Float box if you desire, but I never
8780 have much luck getting the layout right.
8781 With the standard graphics, LyX will insert a
8785 usepackage{graphicx}
8787 command into the LaTeX preamble and handle the figures in the standard
8788 LaTeX2e way, interspersing the figures in the text.
8789 I believe ApJ accepts figures exactly this way now; AJ might still use
8791 \begin_inset Quotes eld
8794 stack everything at the end
8795 \begin_inset Quotes erd
8801 \begin_layout Subsubsection
8802 Things I could have done, but didn't
8805 \begin_layout Standard
8807 \begin_inset Quotes eld
8811 \begin_inset Quotes erd
8814 things I could have implemented, but chose not to.
8815 For instance, I saw no point in double-spacing the text in the LyX window,
8816 even though it is double-spaced in the paper manuscript.
8817 Also, I chose not to make separate layouts for the preprint and preprint2
8819 Since I assume you will spend most of your time in the plain manuscript
8820 mode anyway, I decided not to chew up more disk space with this.
8824 \begin_layout Subsection
8828 \begin_layout Standard
8829 Your mileage may vary.
8830 I've now had papers published by both ApJ and AJ that have had 98% of the
8831 effort done in LyX; the last 2% was the LaTeX post-processing and a few
8833 I have had no trouble with the submission process, and I'm sure the journals
8834 were never aware that there might be a difference.
8835 So, go forth and publish!
8838 \begin_layout Section
8842 \begin_layout Standard
8852 \begin_layout Standard
8853 \begin_inset VSpace bigskip
8859 \begin_layout Standard
8861 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
8862 papers to be submitted to American Mathematical Society publications.
8863 The layouts are not tailored to a specific journal, but easily can be.
8864 You should refer to the AMS documentation for specific instructions for
8865 each journal (usually it will entail only changing a single line in the
8867 That documentation is available on the Web at
8868 \begin_inset Flex URL
8871 \begin_layout Plain Layout
8879 \begin_inset Flex URL
8882 \begin_layout Plain Layout
8884 ftp://ftp.ams.org/pub/tex/amslatex/
8890 These layouts are appropriate, and useful, for any mathematical writing.
8894 \begin_layout Standard
8895 There are two basic AMS LaTeX layouts:
8898 \begin_layout Itemize
8899 amsart: The standard AMS article format.
8902 \begin_layout Itemize
8903 amsbook: the standard AMS book (really, monograph) format.
8907 \begin_layout Standard
8908 The layouts themselves contain only the minimum necessary to use the AMS
8910 They do not, in particular, contain any of the `theorem' environments used
8911 for setting theorems, lemmas, and the like.
8912 These are contained, instead, in the
8913 \begin_inset Flex Code
8916 \begin_layout Plain Layout
8922 module, which is loaded by default when when you select one of the AMS
8924 (It can also be used with other classes and can be removed, if you would
8925 rather use something else.) Less commonly used environments are in the
8926 \begin_inset Flex Code
8929 \begin_layout Plain Layout
8930 Theorems (AMS-Extended)
8935 module, which must be loaded manually.
8938 \begin_layout Standard
8939 By default, theorems and the like are numbered consecutively throughout
8940 the document, but this may be modified by loading the module
8941 \begin_inset Flex Code
8944 \begin_layout Plain Layout
8945 Theorems (Order by Section)
8950 or, if you are using
8951 \begin_inset Flex Code
8954 \begin_layout Plain Layout
8961 \begin_inset Flex Code
8964 \begin_layout Plain Layout
8965 Theorems (Order by Chapter)
8971 These will number the results as
8972 \begin_inset Formula $n.m$
8975 , where the first number refers to the section (or chapter) and the second
8976 refers to the total number of results so far in that section (or chapter).
8977 Many environments are also available unnumbered.
8978 These are indicated by an asterisk at the end.
8979 If you happen to want
8983 unnumbered results, the module
8984 \begin_inset Flex Code
8987 \begin_layout Plain Layout
8993 provides that option.
8996 \begin_layout Standard
8997 Note that these modules do not
9001 to be used with the AMS classes.
9002 It is perfectly possible to use the
9003 \begin_inset Flex Code
9006 \begin_layout Plain Layout
9012 module, and the others mentioned, with other classes, such as
9013 \begin_inset Flex Code
9016 \begin_layout Plain Layout
9023 \begin_inset Flex Code
9026 \begin_layout Plain Layout
9033 \begin_inset Flex Code
9036 \begin_layout Plain Layout
9045 \begin_layout Subsection
9046 What these layouts provide
9049 \begin_layout Standard
9050 There is a long list of included environments provided by these layouts.
9051 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
9052 variety of `theorem' environments.
9053 However, the AMS recommends the environments that are available in LyX.
9057 \begin_layout Standard
9058 The following environments—as well as the standard environments, such as
9060 \begin_inset Flex Noun
9063 \begin_layout Plain Layout
9070 \begin_inset Flex Noun
9073 \begin_layout Plain Layout
9080 \begin_inset Flex Noun
9083 \begin_layout Plain Layout
9090 \begin_inset Flex Noun
9093 \begin_layout Plain Layout
9100 \begin_inset Flex Noun
9103 \begin_layout Plain Layout
9110 \begin_inset Flex Code
9113 \begin_layout Plain Layout
9120 \begin_inset Flex Code
9123 \begin_layout Plain Layout
9132 \begin_layout Description
9133 Address This should be the author's permanent address.
9136 \begin_layout Description
9138 \begin_inset space ~
9141 Address This should be the author's temporary address at the time of submission,
9142 if different from the Address.
9145 \begin_layout Description
9146 Email Author's e-mail address
9149 \begin_layout Description
9150 URL Author's Web address, if desired.
9153 \begin_layout Description
9154 Keywords Key words or phrases used to identify specific topics discussed
9158 \begin_layout Description
9159 Subjectclass These refer to the AMS Subject Classifications, published and
9162 Mathematical Reviews
9165 These are also available online at the AMS cites listed above.
9168 \begin_layout Description
9172 \begin_layout Description
9176 \begin_layout Description
9180 \begin_layout Standard
9181 The following environments are provided by both the
9182 \begin_inset Flex Code
9185 \begin_layout Plain Layout
9192 \begin_inset Flex Code
9195 \begin_layout Plain Layout
9201 modules, in the latter case in both starred (unnumbered) and unstarred
9202 (numbered) versions.
9203 These same environments are provided only in the starred versions by the
9205 \begin_inset Flex Code
9208 \begin_layout Plain Layout
9217 \begin_layout Theorem
9218 This is typically used for the statements of major results.
9222 \begin_layout Corollary*
9223 This is used for statements which follow fairly directly from previous statement
9225 Again, these can be major results.
9230 These are smaller results needed to prove other statements.
9233 \begin_layout Proposition
9234 These are less major results which (hopefully) add to the general theory
9238 \begin_layout Conjecture
9239 These are statements provided without justification, which the author does
9240 not know how to prove, but which seem to be true (to the author, at least).
9243 \begin_layout Definition*
9244 Guess what this is for.
9245 The font is different for this environment than for the previous ones.
9249 \begin_layout Example*
9250 Used for examples illustrating proven results.
9253 \begin_layout Problem
9254 It's not really known what this is for.
9255 You should figure it out.
9258 \begin_layout Exercise*
9259 Write a description for this one.
9262 \begin_layout Remark
9263 This environment is also a type of theorem, usually a lesser sort of observation.
9266 \begin_layout Claim*
9267 Often used in the course of giving a proof of a larger result.
9271 Generally, these are used to break up long arguments, using specific instances
9277 The numbering scheme for cases is on its own, not together with other numbered
9283 At the end of this environment, a QED symbol (usually a square, but it can
9284 vary with different styles) is placed.
9285 If you want to have other environments within this one—for example, Case
9286 environments—and have the QED symbol appear only after them, then the other
9287 environments need to be nested within the proof environment.
9290 Nesting Environments
9296 for information on nesting.
9299 \begin_layout Standard
9300 And these environments are provided by
9301 \begin_inset Flex Code
9304 \begin_layout Plain Layout
9305 Theorems (AMS-Extended)
9313 \begin_layout Criterion*
9314 A required condition.
9317 \begin_layout Algorithm*
9318 A general procedure to be used.
9321 \begin_layout Axiom*
9322 This is a property or statement taken as true within the system being discussed.
9325 \begin_layout Condition*
9326 Sometimes used to state a condition assumed within the present context of
9331 Similar to a Remark.
9334 \begin_layout Notation*
9335 Used for the explanation of, yes, notation.
9338 \begin_layout Summary
9339 Do we really need to tell you?
9342 \begin_layout Acknowledgement*
9346 \begin_layout Conclusion*
9347 Sometimes used at the end of a long train of argument.
9351 Used in a way similar to Proposition, though perhaps lower on the scale.
9354 \begin_layout Standard
9355 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
9357 They need to be available on your system in order to use these environments.
9360 \begin_layout Section
9368 \begin_layout Standard
9374 \begin_layout Subsection
9378 \begin_layout Standard
9379 These are the layout files for some of the journals of the American Geophysical
9381 It is assumed that you have both the AGU's own class files and AGUplus
9382 installed (everything to be found at
9383 \begin_inset Flex URL
9386 \begin_layout Plain Layout
9388 ftp://ftp.agu.org/journals/latex/journals
9396 \begin_layout Subsection
9400 \begin_layout Standard
9410 They are still called this in the LyX GUI, though their LaTeX equivalents
9411 in the AGU classes are
9422 \begin_layout Standard
9423 Newly defined styles are
9460 These are mostly manuscript attributes and defined in the AGU class documentati
9464 \begin_layout Standard
9465 I suspect this is still badly incomplete.
9468 \begin_layout Subsection
9472 \begin_layout Standard
9489 \begin_layout Subsection
9493 \begin_layout Itemize
9496 Journal of Geophysical Research
9505 \begin_layout Standard
9506 Add your own, it isn't so hard! Look at the
9517 \begin_layout Subsection
9518 Bugs and things to remember
9521 \begin_layout Standard
9522 In order to use the new layouts, you must remember to do the following for
9526 \begin_layout Enumerate
9532 This can be done in the
9534 Layout\SpecialChar \menuseparator
9539 Document\SpecialChar \menuseparator
9543 (AGU articles are always in English, right? So
9550 \begin_layout Enumerate
9560 (Yes, this is a bug.)
9563 \begin_layout Enumerate
9564 Make sure you use the
9568 bibliography style, by entering
9572 into the second field of the BibTeX inset.
9573 None of the standard styles will do.
9576 \begin_layout Section
9580 \begin_layout Standard
9586 \begin_layout Subsection
9590 \begin_layout Standard
9591 Broadway is for writing plays.
9592 The format is more decorative than Hollywood, and much less standardized.
9593 This format should be suitable for workshops.
9596 \begin_layout Subsection
9600 \begin_layout Standard
9601 The same as in Hollywood.
9604 \begin_layout Subsection
9608 \begin_layout Standard
9613 names as labels then cross-reference the label to insert the name.
9614 The cross-reference dialog will show the current cast of characters.
9617 \begin_layout Subsection
9618 Paper size and Margins
9621 \begin_layout Standard
9622 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
9625 \begin_layout Subsection
9629 \begin_layout Standard
9630 The following environments are available.
9631 You can use broadway.bind to get the bind keys shown at the right.
9634 \begin_layout Itemize
9638 \begin_inset Newline newline
9643 You should not have to use this, but it is here for anything that does not
9647 \begin_layout Itemize
9651 \begin_inset space \hfill{}
9655 \begin_inset Newline newline
9660 Used to describe stage setting and the action.
9661 First use of speaker names in all CAPs.
9664 \begin_layout Itemize
9668 \begin_inset space \hfill{}
9672 \begin_inset Newline newline
9677 Automatically numbered.
9678 On screen it will be arabic, but will print as Roman.
9681 \begin_layout Itemize
9685 \begin_inset space \hfill{}
9689 \begin_inset Newline newline
9699 It is just centered text.
9702 \begin_layout Itemize
9706 \begin_inset space \hfill{}
9710 \begin_inset Newline newline
9715 Not automatically numbered.
9716 You supply the number.
9717 This is because I couldn't figure out how.
9720 \begin_layout Itemize
9724 \begin_inset space \hfill{}
9728 \begin_inset Newline newline
9733 A special case of Narrative to describe the setting and action as the curtain
9737 \begin_layout Itemize
9741 \begin_inset space \hfill{}
9745 \begin_inset Newline newline
9750 The speaker's (actor's) title, centered in all CAPS.
9753 \begin_layout Itemize
9757 \begin_inset space \hfill{}
9761 \begin_inset Newline newline
9766 Instructions to the speaker.
9767 The parentheses are automatically inserted.
9768 The ( will appear on screen, but both will be in the printed play.
9769 This environment is only used within
9776 \begin_layout Itemize
9780 \begin_inset space \hfill{}
9784 \begin_inset Newline newline
9789 What the Speaker says.
9792 \begin_layout Itemize
9796 \begin_inset space \hfill{}
9800 \begin_inset Newline newline
9805 The curtain comes down.
9808 \begin_layout Itemize
9812 \begin_inset space \hfill{}
9818 \begin_layout Itemize
9822 \begin_inset space \hfill{}
9828 \begin_layout Itemize
9832 \begin_inset space \hfill{}
9838 \begin_layout Standard
9842 \begin_layout Section
9846 \begin_layout Standard
9851 can be used to type letters according to German conventions.
9852 A template file is included in
9854 .../lyx/share/templates
9856 for you to use as a starting point.
9859 \begin_layout Section
9867 \begin_layout Standard
9873 \begin_layout Subsection
9877 \begin_layout Standard
9878 This is the layout file for the European Geophysical Society journals.
9883 can be downloaded from the web site of the EGS under
9884 \begin_inset Flex URL
9887 \begin_layout Plain Layout
9897 \begin_layout Subsection
9901 \begin_layout Standard
9904 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9912 The current layout file is unfortunately very unmodular and would benefit
9913 from using the various
9920 \begin_layout Section
9924 \begin_layout Standard
9925 See the LyX template file
9930 It contains all infos you need.
9933 \begin_layout Section
9939 \begin_inset CommandInset label
9948 \begin_layout Standard
9954 \begin_layout Subsection
9958 \begin_layout Standard
9959 This section describes how to use LyX to make slides for overhead projectors.
9960 There are two document classes that can do this: the default slides class
9966 This section documents the latter.
9969 \begin_layout Standard
9970 I'm going to say this again, nice and clear, so that there's no misunderstanding
9974 \begin_layout Standard
9975 \begin_inset VSpace bigskip
9981 \begin_layout Standard
9985 This section documents the class
9986 \begin_inset Quotes eld
9994 \begin_inset Quotes erd
10002 \begin_layout Standard
10003 \begin_inset VSpace bigskip
10009 \begin_layout Standard
10010 If you're looking for the documentation for
10011 \begin_inset Quotes eld
10019 \begin_inset Quotes erd
10022 , check out section
10023 \begin_inset space ~
10027 \begin_inset CommandInset ref
10029 reference "sec:slitex"
10034 If your machine doesn't have the
10039 \begin_inset Quotes eld
10047 \begin_inset Quotes erd
10050 ] installed, you'll probably have to use the default
10054 class, which isn't quite as good as
10059 \begin_layout Standard
10064 class is designed for use with version 2.1 of the
10068 LaTeX class file which is now an integral part of LaTeX2e.
10071 \begin_layout Subsection
10075 \begin_layout Standard
10076 Obviously, to use this document class, you need to select
10077 \begin_inset Quotes eld
10085 \begin_inset Quotes erd
10095 \begin_inset space ~
10101 There are some settings in the
10104 \begin_inset space ~
10109 dialog that you should know about that are specific to this class:
10112 \begin_layout Itemize
10113 Don't change the options
10124 \begin_inset space ~
10130 They're ignored by the
10137 \begin_layout Itemize
10138 The default font size is 20
10139 \begin_inset space \thinspace{}
10142 pt with the other options being 17
10143 \begin_inset space \thinspace{}
10147 \begin_inset space \thinspace{}
10151 \begin_inset space \thinspace{}
10157 \begin_layout Itemize
10158 The default font is
10166 but all math equations are still typeset in the usual roman font.
10169 \begin_layout Itemize
10174 supports A4 and Letter paper sizes as well as a special size for working
10176 \begin_inset space \thinspace{}
10180 It doesn't support A5, B5, legal or executive paper sizes.
10183 \begin_layout Itemize
10184 Don't bother changing the
10188 settings because they are ignored anyway.
10189 All floats appear where they are defined in the text.
10192 \begin_layout Itemize
10197 setting behaves a bit differently for this class.
10202 provides extensive footer and header capabilities including a user-defined
10205 \begin_inset space ~
10209 \begin_inset CommandInset ref
10211 reference "sec:foilfoot"
10216 The title page is treated differently to all other pages in the document
10225 has the logo centered at the bottom of the page (if one is defined).
10226 The possible page style choices and what they do are as follows:
10230 \begin_layout Labeling
10231 \labelwidthstring MMMMMMM
10238 The final output contains no page numbers, or other headers or footers
10239 (except footnotes of course).
10243 \begin_layout Labeling
10244 \labelwidthstring MMMMMMM
10251 The final output contains page numbers centered at the bottom of the page.
10252 No other headings or footers (other than footnotes).
10255 \begin_layout Labeling
10256 \labelwidthstring MMMMMMM
10261 Page numbers in lower right corner.
10262 Additional headers and footers are also shown.
10263 This is also the default.
10266 \begin_layout Labeling
10267 \labelwidthstring MMMMMMM
10272 Gives you access to the
10276 package although its use with
10280 is discouraged by the writer of the
10284 package because of some potential page layout clashes.
10288 \begin_layout Subsubsection
10292 \begin_layout Standard
10293 The following options may be used in the extra class options in the
10295 Document\SpecialChar \menuseparator
10301 \begin_layout Labeling
10302 \labelwidthstring MMMMMMx
10307 This sets up the page layout for 7.33
10308 \begin_inset space \thinspace{}
10312 \begin_inset space \thinspace{}
10315 in paper, which is about the same aspect ratio as a 35
10316 \begin_inset space \thinspace{}
10319 mm slide, making it a bit easier to work with this medium.
10322 \begin_layout Labeling
10323 \labelwidthstring MMMMMMx
10328 Places a rule across the page below the header on every page except the
10332 \begin_layout Labeling
10333 \labelwidthstring MMMMMMx
10338 Places a rule across the page above the footer on every page except the
10342 \begin_layout Labeling
10343 \labelwidthstring MMMMMMx
10348 This is automatically set each time you create a new
10357 to use the dvips driver to rotate those pages that are set as landscape
10361 \begin_layout Labeling
10362 \labelwidthstring MMMMMMx
10367 Simply changes the page dimensions to those of a landscape page but doesn't
10369 Thus if you use this option you need to use an external program to rotate
10370 each page or feed your paper through your printer as landscape.
10371 Note that this option effectively reverses the roles of the
10379 environments (don't worry these are described in the next section).
10382 \begin_layout Labeling
10383 \labelwidthstring MMMMMMx
10388 Equation numbers on the left.
10391 \begin_layout Labeling
10392 \labelwidthstring MMMMMMx
10397 Flush-left equations.
10400 \begin_layout Subsection
10401 Supported Environments
10404 \begin_layout Standard
10405 Most of the environments commonly supported in other classes are also supported
10411 There are several additional environments provided by
10415 as well as a couple added by LyX.
10416 The following environments are shared with other classes:
10419 \begin_layout Standard
10423 \begin_layout Plain Layout
10427 begin{multicols}{2}
10435 \begin_layout Itemize
10441 \begin_layout Itemize
10447 \begin_layout Itemize
10453 \begin_layout Itemize
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 Standard
10547 \begin_layout Plain Layout
10559 \begin_layout Standard
10560 That is, all the major environments apart from the sectioning environments.
10561 Since foils are essentially self-contained sections, with a title and body,
10566 provides specific commands for starting new foils and these are:
10569 \begin_layout Itemize
10575 \begin_layout Itemize
10581 \begin_layout Standard
10582 LyX also provides slightly modified versions of these two environments called:
10585 \begin_layout Itemize
10591 \begin_layout Itemize
10594 ShortRotatefoilhead
10597 \begin_layout Standard
10598 and the differences will be explained in the next section.
10601 \begin_layout Standard
10602 Since foils are often used in presenting ideas or new theorems and such
10607 also provides a comprehensive box of goodies for presenting them:
10610 \begin_layout Standard
10614 \begin_layout Plain Layout
10618 begin{multicols}{2}
10626 \begin_layout Itemize
10632 \begin_layout Itemize
10638 \begin_layout Itemize
10644 \begin_layout Itemize
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 Standard
10696 \begin_layout Plain Layout
10708 \begin_layout Standard
10709 The starred versions are unnumbered while the unstarred versions are numbered.
10710 There are also two list environments added by LyX and these are:
10713 \begin_layout Itemize
10719 \begin_layout Itemize
10725 \begin_layout Standard
10730 provides some powerful header and footer capabilities that are best set
10731 in the preamble although they may be set at any point in a document.
10732 If you want to change these settings in your document the best place to
10733 do so is at the very top of a foil, i.
10734 \begin_inset space \thinspace{}
10740 \begin_inset space \space{}
10745 straight after the foilhead.
10748 \begin_layout Standard
10749 For this purpose, the following command styles are provided [
10756 \begin_layout Standard
10760 \begin_layout Plain Layout
10764 begin{multicols}{2}
10772 \begin_layout Itemize
10776 \begin_inset space ~
10782 \begin_layout Itemize
10788 \begin_layout Itemize
10792 \begin_inset space ~
10798 \begin_layout Itemize
10802 \begin_inset space ~
10808 \begin_layout Itemize
10812 \begin_inset space ~
10819 \begin_layout Standard
10820 \begin_inset space ~
10827 \begin_layout Standard
10831 \begin_layout Plain Layout
10843 \begin_layout Standard
10844 There are also a few commands provided by
10848 that aren't directly supported by LyX but I'll tell you what they do and
10849 how to use them in section
10850 \begin_inset space ~
10854 \begin_inset CommandInset ref
10856 reference "sec:unsuppfoils"
10863 \begin_layout Subsection
10864 Building a Set of Foils
10867 \begin_layout Standard
10868 This section will give a simple introduction to using the different environments
10869 to build a set of foils.
10870 If you want to see an example set of foils, take a look at the
10874 file you find in LyX's
10881 \begin_layout Subsubsection
10882 Give It a Title Page
10885 \begin_layout Standard
10886 Unlike other classes that provide
10906 creates the title on a page of its own.
10907 If you leave out the
10911 environment LaTeX will substitute the current date (every time you regenerate
10915 \begin_layout Subsubsection
10919 \begin_layout Standard
10920 As I mentioned earlier, there are four ways of starting a new foil.
10921 For portrait foils you should use
10930 The difference between these two environments is the amount of space between
10931 the title of the foil (the foilhead) and the body of the foil.
10934 \begin_layout Standard
10935 Landscape foils are generated using the
10941 ShortRotatefoilhead
10944 Again the only difference is the spacing between foilhead and body.
10945 Both of the short versions have 0.5 inches less separation between the foilhead
10950 \begin_layout Standard
10951 One problem with the support for landscape foils is the requirement that
10952 you have to use the
10956 driver to generate the PostScript output otherwise the foils won't be rotated.
10957 It is possible to get landscape foils even if you haven't got the
10961 driver provided you can feed your foils sideways through your printer ;-)
10964 \begin_layout Subsubsection
10965 Theorems, Lemmas, Proofs and more
10968 \begin_layout Standard
10969 Due to a small bug in LyX you can't have two of the same type of these environme
10970 nts directly following each other.
10971 They must be separated by something.
10972 If you try, you will just be extending the previous environment as if you
10973 had merged the two environments together.
10974 So, how do you get around this problem? The simplest option is to insert
10975 some text between the two environments or add a
10979 environment between the two with just a
10980 \begin_inset Quotes eld
10988 \begin_inset Quotes erd
10992 This will force LyX to produce two separate environments and hence the
10993 correct LaTeX output.
10994 An example is provided in the example file included with the LyX distribution.
10995 Remember, this problem only occurs if you are trying to place two of the
10996 same type of theorem-like environments one directly after the other.
10999 \begin_layout Subsubsection
11003 \begin_layout Standard
11004 You get all the commonly supported list styles found in other classes as
11005 well as two new ones.
11006 I'll only describe the new ones here.
11007 If you want to find out more about the other list environments check out
11013 If you intend to use itemized lists you might also want to read about the
11017 \begin_inset space ~
11021 \begin_inset space ~
11026 dialog described above in section
11027 \begin_inset space ~
11031 \begin_inset CommandInset ref
11033 reference "sec:bullet"
11040 \begin_layout Standard
11041 The two new list styles,
11049 , are designed to make it easier for you to create lists of do's and don'ts
11050 or right and wrong by providing dedicated environments that use a tick
11051 or a cross as the label of the list.
11052 These lists are in fact dedicated variants of the
11057 They do however require that you have the
11061 packages installed.
11064 \begin_layout Subsubsection
11068 \begin_layout Standard
11073 redefines the floating tables and figures so that they appear exactly where
11074 they are in the text rather than pushing them to the top of the page or
11075 to some user specified location.
11076 In fact if you change the float placement settings they are simply ignored.
11079 \begin_layout Subsubsection
11080 Page Headers and Footers
11081 \begin_inset CommandInset label
11083 name "sec:foilfoot"
11090 \begin_layout Standard
11094 \begin_inset space ~
11103 are two commands used to control the left-footer text string.
11104 The first is meant to allow you to include a graphic logo on your foils
11106 \begin_inset Quotes eld
11114 \begin_inset Quotes erd
11118 While the second is meant to provide a classification for the audience,
11122 \begin_inset space \thinspace{}
11128 \begin_inset space \space{}
11132 It is empty by default.
11135 \begin_layout Standard
11136 The remaining page corners can be filled by
11139 \begin_inset space ~
11144 (which defaults to page numbers),
11147 \begin_inset space ~
11155 \begin_inset space ~
11163 \begin_layout Subsection
11169 \begin_inset CommandInset label
11171 name "sec:unsuppfoils"
11178 \begin_layout Standard
11179 All the commands mentioned below need to be set in a
11187 within another environment.
11190 \begin_layout Subsubsection
11194 \begin_layout Standard
11195 All lengths are adjusted using the
11218 should be replaced by the name given to the length you want to change and
11223 is the length value.
11224 All lengths should be specified in units of length such as inches (
11236 ) or relative to some document or font-based length such as
11246 \begin_layout Standard
11247 It's possible to change the spacing between a foilhead and the body of the
11248 foil by adjusting the length specified by
11255 For example, to make
11260 \begin_inset space \space{}
11263 in closer to their bodies put the following in the preamble:
11269 foilheadskip}{-0.5in}
11272 \begin_layout Standard
11273 The spacings around floats can be adjusted by setting these lengths:
11276 \begin_layout Labeling
11277 \labelwidthstring MMMMMMMMMMM
11284 Separation between the text and the top of the float
11287 \begin_layout Labeling
11288 \labelwidthstring MMMMMMMMMMM
11295 Separation between the float and the caption
11298 \begin_layout Labeling
11299 \labelwidthstring MMMMMMMMMMM
11306 Separation between the caption and the following text
11309 \begin_layout Labeling
11310 \labelwidthstring MMMMMMMMMMM
11317 You can make the captions narrower than the surrounding text by adjusting
11319 Best done relative to
11328 \begin_layout Standard
11329 There are also several title page related lengths that you may find useful
11330 if you have a long title or several authors:
11333 \begin_layout Labeling
11334 \labelwidthstring MMMMMMMMMMM
11341 Separation from headers to
11346 \begin_layout Labeling
11347 \labelwidthstring MMMMMMMMMMM
11365 \begin_layout Labeling
11366 \labelwidthstring MMMMMMMMMMM
11380 \begin_layout Labeling
11381 \labelwidthstring MMMMMMMMMMM
11397 \begin_layout Labeling
11398 \labelwidthstring MMMMMMMMMMM
11414 \begin_layout Standard
11415 The last length related command affects all the list environments.
11426 a list environment then all the vertical spacing between the list items
11428 Note that this is a command not a length so it doesn't require
11434 like the stuff mentioned above.
11437 \begin_layout Subsubsection
11438 Headers and Footers
11441 \begin_layout Standard
11454 commands control whether the logo in the
11458 definition appear on a given page.
11465 in the preamble then none of the foils will have the logo on them.
11466 If you don't want the logo on a particular page place the
11472 directly after the foilhead of that page and the
11478 directly after the next foilhead.
11481 \begin_layout Standard
11482 If you decide to use the
11486 page style setting in the
11489 \begin_inset space ~
11494 dialog you should probably add
11504 to your preamble so headers and footers on landscape pages are correctly
11505 placed when rotated.
11506 This is due to some clashes between the page layouts provided by the
11517 \begin_layout Section
11518 Hollywood (Hollywood spec scripts)
11521 \begin_layout Standard
11527 \begin_layout Subsection
11531 \begin_layout Standard
11532 Getting the format of a Hollywood script right is a
11533 \begin_inset Quotes eld
11537 \begin_inset Quotes erd
11540 It is designed to make the readers focus on content and to be easy and
11541 familiar for the actors to read.
11542 Each page of a script should be one minute of film.
11543 Nothing goes in a script that you cannot see or hear on screen.
11544 The courier 12 pt font should be used throughout.
11548 \begin_layout Subsection
11552 \begin_layout Standard
11553 Speakers' lines should NEVER break in mid-sentence.
11554 If a speaker's lines continue over a page break, repeat the
11558 title followed by (Cont'd).
11561 \begin_layout Subsection
11565 \begin_layout Standard
11570 names as labels then cross-reference the label to insert the name.
11571 The cross-reference dialog will show the current cast of characters.
11572 You can use this to insert the speaker name in narratives also.
11575 \begin_layout Subsection
11576 Paper size and Margins
11579 \begin_layout Standard
11580 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
11583 \begin_layout Subsection
11587 \begin_layout Standard
11588 The following environments are available.
11589 You can use hollywood.bind to get the bind keys shown at the right.
11592 \begin_layout Itemize
11596 \begin_inset Newline newline
11601 Used where nothing else works.
11605 \begin_layout Itemize
11611 \begin_inset space \hfill{}
11619 \begin_inset Newline newline
11622 Usually followed by something like
11623 \begin_inset Quotes eld
11626 on Sally waking up.
11627 \begin_inset Quotes erd
11633 \begin_layout Itemize
11637 \begin_inset space \hfill{}
11641 \begin_inset Newline newline
11646 Introduces a new INTERIOR camera set-up.
11647 Always followed by DAY or NIGHT, or something similar to define the lighting
11649 Everthing on this line in CAPS.
11652 \begin_layout Itemize
11656 \begin_inset space \hfill{}
11660 \begin_inset Newline newline
11665 Introduces a new EXTERIOR camera set-up.
11666 Everthing on this line in CAPS.
11669 \begin_layout Itemize
11673 \begin_inset space \hfill{}
11677 \begin_inset Newline newline
11682 The character speaking.
11685 \begin_layout Itemize
11689 \begin_inset space \hfill{}
11693 \begin_inset Newline newline
11698 Instructions to the speaker.
11699 The () are automatically inserted, but only the ( will show in LyX.
11700 Both will be printed.
11703 \begin_layout Itemize
11707 \begin_inset space \hfill{}
11711 \begin_inset Newline newline
11723 \begin_layout Itemize
11727 \begin_inset space \hfill{}
11731 \begin_inset Newline newline
11736 Camera movement instruction.
11738 \begin_inset space \thinspace{}
11742 \begin_inset space \space{}
11748 \begin_layout Itemize
11752 \begin_inset space \hfill{}
11758 \begin_layout Itemize
11762 \begin_inset space \hfill{}
11768 \begin_layout Itemize
11772 \begin_inset space \hfill{}
11778 \begin_layout Itemize
11782 \begin_inset space \hfill{}
11788 \begin_layout Subsection
11792 \begin_layout Itemize
11796 \begin_layout Itemize
11800 \begin_layout Itemize
11802 \begin_inset space \thinspace{}
11809 \begin_layout Itemize
11814 \begin_layout Itemize
11815 PAN — camera movement
11818 \begin_layout Itemize
11819 INSERT — cut to close-up of
11822 \begin_layout Section
11826 \begin_layout Standard
11829 Panayotis Papasotiriou
11832 \begin_layout Subsection
11836 \begin_layout Standard
11837 The ijmpc package is a set of macros that facilitates electronic manuscript
11840 International Journal of Modern Physics C
11843 Similarly, the ijmpd package is for creating manuscripts to be submitted
11846 International Journal of Modern Physics D
11849 Both journals are published by World Scientific.
11850 The corresponding document classes are named
11859 These files, together with instructions for the authors, can be downloaded
11861 \begin_inset Flex URL
11864 \begin_layout Plain Layout
11866 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
11872 \begin_inset Flex URL
11875 \begin_layout Plain Layout
11877 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
11883 Both packages are modified versions of the standard
11884 \begin_inset Quotes eld
11888 \begin_inset Quotes erd
11891 package, and they are almost (but not exactly) identical.
11892 Most of their features are supported by LyX.
11893 I have used LyX successfully to write articles submitted to both journals
11894 without any problem.
11897 \begin_layout Subsection
11901 \begin_layout Standard
11902 As usual, the easiest way to write a paper is to start with a template.
11905 File\SpecialChar \menuseparator
11924 This will give an (almost) empty document that includes the most common
11925 fields found in a manuscript.
11926 Simply overwrite the existing text (including the brackets,
11931 You should keep in mind the following remarks.
11934 \begin_layout Enumerate
11935 LyX won't let you change the font size and the page style of the document,
11936 because such modifications are not allowed by both packages.
11939 \begin_layout Enumerate
11940 The language of the document should not be changed.
11941 Before previewing your paper, be sure that the babel package is not used.
11942 To do this, click on
11944 Tools\SpecialChar \menuseparator
11955 checkbox in the language settings, and click on
11963 , if you wish to make this change permanent).
11966 \begin_layout Enumerate
11968 \begin_inset Quotes eld
11972 \begin_inset Quotes erd
11975 style must be used to define keywords.
11978 \begin_layout Enumerate
11979 The ijmpc package provides a style named
11980 \begin_inset Quotes eld
11983 Classification Codes
11984 \begin_inset Quotes erd
11987 , which can be used to define classification codes, such as PACS numbers.
11988 Note that this facility is not supported by the ijmpd package.
11991 \begin_layout Enumerate
11992 Several new environments are available:
11993 \begin_inset Quotes eld
11997 \begin_inset Quotes erd
12001 \begin_inset Quotes eld
12005 \begin_inset Quotes erd
12009 \begin_inset Quotes eld
12013 \begin_inset Quotes erd
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 Their use is more or less obvious.
12106 LyX supports all these environments; it will use the proper label, text
12107 style, and numbering scheme for each of them.
12110 \begin_layout Enumerate
12111 Both packages use basic citations; the natbib package should not be used.
12112 In LyX, citation references are shown as usual; in the output, citations
12113 are shown as superscripts.
12114 If you want to use a citation as normal text, you should use the
12119 \begin_inset space \thinspace{}
12123 \begin_inset space \space{}
12127 \begin_inset Quotes eld
12131 \begin_inset space \space{}
12141 \begin_inset Quotes erd
12147 \begin_layout Enumerate
12149 \begin_inset Quotes eld
12153 \begin_inset Quotes erd
12156 section in both packages.
12157 To put acknowledgments, just use the
12158 \begin_inset Quotes eld
12162 \begin_inset Quotes erd
12168 \begin_layout Enumerate
12169 Appendices may be added to the paper,
12173 the Acknowledgments and
12178 LyX provides a special environment, called
12179 \begin_inset Quotes eld
12183 \begin_inset Quotes erd
12186 which marks the beginning of the appendices.
12187 This environment should be left blank; it just sends a LaTeX command, but
12188 nothing is really printed.
12190 \begin_inset Quotes eld
12194 \begin_inset Quotes erd
12197 is printed with blue letters, as a signal that all sections after that
12198 point are appendices.
12199 To write an appendix, use the
12200 \begin_inset Quotes eld
12204 \begin_inset Quotes erd
12208 LyX will number each appendix with capital letters, as required by both
12211 \begin_inset Quotes eld
12215 \begin_inset Quotes erd
12222 be present before the first appendix; if not, all appendices will be numbered
12223 as normal sections in the output.
12226 \begin_layout Enumerate
12227 The ijmpc and the ijmpd packages use the
12231 command to implement table captions.
12232 As a result, a table created by LyX is printed correctly, but its caption
12234 However, you can use some TeX code to overcome this problem, so that captions
12235 are printed as expected.
12236 To do so, create a float table as usual, remove the caption, and replace
12237 it with the TeX code
12247 (sic); you must also the TeX code
12251 immediately after the tabular material.
12252 Study the example table included in the template files to see how this
12253 trick is implemented.
12254 Alternatively, If you need table captions, you should implement the whole
12259 file, then include this file to the LyX document (
12261 Insert\SpecialChar \menuseparator
12262 File\SpecialChar \menuseparator
12264 \begin_inset space ~
12270 Details on how to create a table float can be found in the files
12278 , included in the corresponding packages.
12281 \begin_layout Subsection
12282 Preparing a paper for submission
12285 \begin_layout Standard
12286 Before you submit your paper you must export the LyX document as a LaTeX
12289 File\SpecialChar \menuseparator
12290 Export\SpecialChar \menuseparator
12297 \begin_layout Plain Layout
12298 Actually you have the choice between LaTeX (plain) and pdflatex.
12299 If you intend to use pdflatex to prepare the paper, you should use the
12300 pdflatex option so that included graphics are converted to PDF format,
12301 ready for use by pdflatex.
12306 , then make the following changes to the resulting
12313 \begin_layout Enumerate
12314 Remove the comment lines before the
12323 \begin_layout Enumerate
12324 Remove everything between (and including) the
12336 commands, except for any commands you specifically put into the LaTeX preamble.
12339 \begin_layout Standard
12344 file should be saved and processed through LaTeX as many times as necessary.
12345 You may also want to check the resulting
12352 \begin_layout Subsection
12356 \begin_layout Standard
12357 The use of TeX code is reduced to two commands, which must be placed at
12358 the top of the document.
12359 If you started writing your paper by using the
12367 template, the TeX code needed is already in its place; you usually don't
12369 You may only modify the first TeX code to specify the information printed
12370 to the top of odd and even pages (authors' names and short paper's title,
12372 This TeX code must have the form
12376 markboth{Authors' Names}{Short Paper's Title}
12381 \begin_layout Section
12385 \begin_layout Standard
12391 \begin_layout Subsection
12395 \begin_layout Standard
12396 The iopart package provides a document class to create electronic manuscript
12397 submission to the journals published by the Institute of Physics.
12398 Instructions for the authors how to create a paper using the iopart class
12399 can be downloaded together with the iopart package from the site
12400 \begin_inset Flex URL
12403 \begin_layout Plain Layout
12405 ftp://ftp.iop.org/pub/journals/latex2e
12413 \begin_layout Subsection
12417 \begin_layout Standard
12418 The easiest way to write a paper is to start with the file
12422 that is available in LyX's examples files folder.
12423 Open this file, save it under a new name, and start writing.
12424 The example file explains how to use the special text environments.
12425 Here are the most important advices:
12428 \begin_layout Itemize
12429 To be able to compile your document to a PDF, PS, or DVI, ensure that the
12432 Use AMS math package
12434 in the document settings under
12441 \begin_layout Itemize
12444 The title environment defines the kind of your paper.
12445 So use one of the following environments for the title:
12449 \begin_layout Itemize
12458 \begin_layout Itemize
12467 \begin_layout Itemize
12473 for a Topical review
12476 \begin_layout Itemize
12485 \begin_layout Itemize
12494 \begin_layout Itemize
12500 for a Paper (same as Title)
12503 \begin_layout Itemize
12509 for a Preliminary communication
12512 \begin_layout Itemize
12518 for a Rapid communication
12521 \begin_layout Itemize
12527 for a Letter to the editor
12531 \begin_layout Itemize
12534 All title environments except of
12538 can have an optional short title.
12541 \begin_layout Itemize
12542 There is a general title environment
12546 which is not directly supported by the LyX.
12547 This can be used as TeX code when your document doesn't fit into one of
12548 the other title types.
12551 \begin_layout Standard
12552 For more informations like hints for special table and formula formatting,
12553 look at the IOP author guidelines.
12556 \begin_layout Section
12560 \begin_layout Standard
12563 Panayotis Papasotiriou
12566 \begin_layout Subsection
12570 \begin_layout Standard
12571 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
12572 that facilitates electronic manuscript submission to the journals they
12574 Most known of them (at least in my domain of interest) are
12576 Astrophysics and Space Science
12582 , but there are many others (see a complete list at
12583 \begin_inset Flex URL
12586 \begin_layout Plain Layout
12588 http://www.wkap.nl/jrnllist.htm/JRNLHOME
12594 The Kluwer package may be downloaded from the site
12595 \begin_inset Flex URL
12598 \begin_layout Plain Layout
12600 http://www.wkap.nl/kaphtml.htm/STYLEFILES
12606 A complete user guide is contained in that package (but it can also be
12607 downloaded separately).
12610 \begin_layout Standard
12611 LyX supports many features of the package but not everything.
12612 However, the TeX code needed is reduced to some
12613 \begin_inset Quotes eld
12617 \begin_inset Quotes erd
12620 commands of the package (see
12621 \begin_inset space ~
12625 \begin_inset CommandInset ref
12627 reference "subsec:kluwer_peculiarities"
12632 I have recently used LyX to write an article submitted to the
12634 Astrophysics and Space Science
12636 without any problem.
12639 \begin_layout Subsection
12643 \begin_layout Standard
12644 The easiest way to write a paper is to start with the Kluwer template file.
12647 File\SpecialChar \menuseparator
12659 This will give an (almost) empty document that includes the most common
12660 fields found in a manuscript and a short description of their use.
12661 As in most templates, simply overwrite the existing text (including the
12666 ) with the correct information.
12669 \begin_layout Subsection
12670 Preparing a paper for submission
12673 \begin_layout Standard
12674 As in the AASTeX package, before you submit your paper to a journal you
12676 \begin_inset Quotes eld
12680 \begin_inset Quotes erd
12686 \begin_layout Enumerate
12687 Export your paper as a LaTeX file.
12688 To do this, click on
12690 File\SpecialChar \menuseparator
12691 Export\SpecialChar \menuseparator
12698 \begin_layout Enumerate
12703 file with a text editor and make the following changes
12707 \begin_layout Enumerate
12708 remove the comment lines before the
12717 \begin_layout Enumerate
12718 remove everything between (and including) the
12730 commands, except for any commands you specifically put into the LaTeX preamble.
12733 \begin_layout Standard
12742 \begin_layout Enumerate
12747 file through LaTeX as many times as necessary (usually up to three).
12750 \begin_layout Enumerate
12756 \begin_inset space \thinspace{}
12760 \begin_inset space \space{}
12767 , and check if everything is OK (it should, if you didn't make any mistake).
12770 \begin_layout Subsection
12771 \begin_inset Quotes eld
12775 \begin_inset Quotes erd
12778 of the Kluwer package
12779 \begin_inset CommandInset label
12781 name "subsec:kluwer_peculiarities"
12788 \begin_layout Standard
12789 The Kluwer package has the following
12790 \begin_inset Quotes eld
12794 \begin_inset Quotes erd
12800 \begin_layout Enumerate
12801 It is possible to write multiple articles in the same LaTeX file
12805 \begin_layout Plain Layout
12806 I can't imagine any good reason to do this.
12812 Each article must be included in the environment
12813 \begin_inset Quotes eld
12817 \begin_inset Quotes erd
12821 Unfortunately, this environment cannot be omitted, even if you write just
12823 Therefore, each article starts with the command
12829 and, obviously, ends with the command
12836 Although this can be implemented in LyX, I didn't included it, since it
12837 looks ugly and can confuse the novice user.
12838 Therefore, you need to enter them directly and mark them as LaTeX code
12840 \begin_inset Quotes eld
12844 \begin_inset Quotes erd
12850 \begin_layout Enumerate
12851 Information given at the beginning of the article (i.
12852 \begin_inset space \thinspace{}
12856 \begin_inset space \space{}
12859 title, subtitle, author, institution, running title, running author, abstract
12860 and keywords) must be included in an environment called
12861 \begin_inset Quotes eld
12865 \begin_inset Quotes erd
12869 This is not implemented in LyX, so you must enter title, subtitle etc.
12870 \begin_inset space ~
12873 between two TeX code lines (
12888 \begin_layout Enumerate
12889 According to the user manual, the label of each bibliography item must be
12913 \begin_layout Standard
12918 template takes care of all these
12919 \begin_inset Quotes eld
12923 \begin_inset Quotes erd
12927 If you start a new paper using this template you don't need to do anything
12932 \begin_layout Enumerate
12933 don't delete the TeX code included in the template, and
12936 \begin_layout Enumerate
12937 copy the example bibliography item included in the template and modify it
12938 as necessary to enter new bibliography items.
12941 \begin_layout Section
12945 \begin_layout Standard
12951 \begin_layout Subsection
12955 \begin_layout Standard
12956 The LyX document classes
12958 article (koma-script)
12962 report (koma-script)
12980 correspond to the LaTeX document classes
12997 \begin_inset space ~
13000 of the Koma-Script family.
13001 They are replacements for the standard document classes
13017 , resp., and fit better to European typography conventions in a number of
13021 \begin_layout Itemize
13022 Standard character size is 11pt in
13024 article (koma-script)
13028 report (koma-script)
13036 letter (koma-script)
13041 \begin_layout Itemize
13042 Headings, labels of the description environment, and a number of elements
13045 letter (koma-script)
13047 document class are set in a bold sans serif font.
13051 \begin_layout Plain Layout
13052 There is a big difference between the bold sans serif old cm fonts and new
13053 ec fonts, especially in the appearance of headings.
13054 In comparison, the ec bold sans serif fonts look a bit thin.
13055 Here the LaTeX package
13063 helps to produce the
13064 \begin_inset Quotes eld
13068 \begin_inset Quotes erd
13071 appearance when using the ec fonts.
13076 The numbering of chapter headings is made in the same way as the numbering
13077 of section headings, that is without the extra line
13078 \begin_inset Quotes eld
13081 Chapter\SpecialChar \ldots{}
13083 \begin_inset Quotes erd
13087 In addition, the appearance of the headings can be modified by using a
13088 number of options (in LyX to be entered in the field
13091 \begin_inset space ~
13098 Layout\SpecialChar \menuseparator
13105 \begin_layout Itemize
13106 The main means in the Koma-Script document classes to design the type area
13115 (in LyX to be entered in the extra class options field in the dialog
13117 Document\SpecialChar \menuseparator
13121 They make a clearer modification of page margins possible as do the options
13124 Document\SpecialChar \menuseparator
13131 \begin_layout Itemize
13132 The LaTeX document classes of the Koma-Script family define a number of
13133 additional commands.
13134 Those part of it which makes sense in LyX is implemented in corresponding
13138 \begin_layout Standard
13139 Detailed descriptions of the LaTeX document classes of the Koma-Script family
13140 can be found in the Koma-Script documentation
13151 \begin_layout Subsection
13152 article (koma-script), report (koma-script), and book (koma-script)
13155 \begin_layout Standard
13156 The document classes
13158 article (koma-script)
13162 report (koma-script)
13172 are implemented in the layout files
13185 They contain all the paragraph types of the corresponding standard document
13198 , resp., partly modified, with the exception of the LyX specific
13202 -type, which is replaced by the new
13206 -type having the same functionality.
13211 -Type there is a number of new paragraph types added.
13218 letter (koma-script)
13223 \begin_layout Itemize
13232 : are equivalents to
13240 , resp., additionally inserting an entry in the table of contents.
13249 are not contained in
13251 article (koma-script)
13256 \begin_layout Itemize
13265 : behave exactly as
13273 , resp., additionally clearing running heads.
13278 is not contained in
13280 article (koma-script)
13286 \begin_layout Plain Layout
13299 report (koma-script)
13301 , but since this is identical to
13305 , is has not been implemented in LyX.
13313 \begin_layout Itemize
13318 : generates a heading directly above the following paragraph in the standard
13319 character size without affecting the structure of the document.
13322 \begin_layout Itemize
13331 are special captions which respect the different space settings needed
13332 for captions placed above or below an element (if you follow strict typographic
13333 rules, you might want to place table captions always above the table).
13334 You can also use the class option
13338 , which will switch
13351 You need at least Koma-Script version 2.8q to use this.
13354 \begin_layout Itemize
13359 : can be used to set a bonmot, e.
13360 \begin_inset space \thinspace{}
13364 \begin_inset space \space{}
13367 at the beginning of a chapter.
13368 If you use the optional argument (
13370 Insert\SpecialChar \menuseparator
13372 \begin_inset space ~
13377 ), you can insert the dictum's author there.
13378 Dictum and author are separated by a line.
13379 You need at least Koma-Script version 2.8q to use this.
13384 is not contained in
13386 article (koma-script)
13391 \begin_layout Standard
13392 The following types, together with the standard types
13404 , form the title area of the document.
13405 They must be entered ahead of the first
13406 \begin_inset Quotes eld
13410 \begin_inset Quotes erd
13417 \begin_layout Plain Layout
13418 The corresponding LaTeX commands must appear before the
13429 When such a type is used more than once, the latter usage overwrites the
13430 former one, that means, for every type only the latest usage is valid.
13431 The order of the different types however has, like
13443 , no effect on the appearance of the produced document.
13446 \begin_layout Itemize
13451 : produces a centered paragraph above the ordinary title (
13463 ) for the subject of the document.
13466 \begin_layout Itemize
13471 : produces a centered paragraph below the ordinary title (
13483 ) for the publishers' name.
13486 \begin_layout Itemize
13493 report (koma-script)
13499 produces a centered paragraph on its own page behind the title page, or
13502 article (koma-script)
13504 produces a centered paragraph below the ordinary title (
13520 ) for a dedication.
13523 \begin_layout Itemize
13528 : produces a left aligned paragraph above the ordinary title (
13544 ) for a document`s head.
13547 \begin_layout Itemize
13552 : produces in a double-sided print in
13554 report (koma-script)
13560 a left-aligned paragraph at the top of the title page`s back or has no
13561 effect in a single-sided print or in
13563 article (koma-script)
13568 \begin_layout Itemize
13573 : produces in a double-sided print in
13575 report (koma-script)
13581 a left-aligned paragraph at the bottom of the title page`s back or has
13582 no effect in a single-sided print or in
13584 article (koma-script)
13589 \begin_layout Itemize
13594 : produces a special
13595 \begin_inset Quotes eld
13599 \begin_inset Quotes erd
13602 page ahead of the actual document containing a paragraph without special
13606 \begin_layout Standard
13607 The layout files for the document classes
13609 article (koma-script)
13613 report (koma-script)
13619 do include the file
13624 This is thought of as a place to define your own types.
13629 in your personal layout directory and edit the file!
13632 \begin_layout Subsection
13633 letter (koma-script)
13636 \begin_layout Standard
13640 letter (koma-script)
13642 is implemented in the layout file
13647 It contains all the paragraph types of the corresponding standard document
13652 , partly modified, with the exception of the LyX specific types
13664 type, which is replaced by the new
13669 In addition, it contains, in contrast to the standard document class, the
13687 Furthermore, there are a number of new letter specific types.
13690 \begin_layout Standard
13691 The appearance of the letter produced by this document class can be controlled
13692 by a number of LaTeX commands, which you can put in the LaTeX preamble.
13696 \begin_layout Plain Layout
13697 For example, the standard appearance of the letter`s heading, consisting
13698 of name and address, is quite self-willed.
13700 \begin_inset Quotes eld
13704 \begin_inset Quotes erd
13707 heading is produced by the following LaTeX commands in the preamble:
13710 \begin_layout LyX-Code
13720 \begin_layout LyX-Code
13736 \begin_layout LyX-Code
13746 \begin_layout LyX-Code
13766 A detailed German description of such LaTeX commands can be found in the
13767 Koma-Script documentation
13772 With it, the letter's author can produce his personal letter layout.
13775 \begin_layout Standard
13784 define the beginning of the letter and must be used in every letter.
13785 To emphasize them in the LyX document class, they are marked with the letter
13795 \begin_inset space ~
13798 in the left margin.
13799 It is possible to write any number of letters in one file.
13804 type produces a new letter using the same addressee and a
13808 type produces a new addressee.
13825 are ordinary paragraph types and can also be used several times in one
13826 and the same letter.
13829 \begin_layout Itemize
13834 : produces a paragraph for the addressee and implicitly defines the beginning
13838 \begin_layout Itemize
13843 : produces a paragraph for the form of address and implicitly produces a
13847 \begin_layout Itemize
13852 : produces a paragraph for a close.
13855 \begin_layout Itemize
13860 : produces a paragraph for a postscript.
13863 \begin_layout Itemize
13868 : produces a paragraph for a distribution list.
13871 \begin_layout Itemize
13876 : produces a paragraph for enclosures.
13879 \begin_layout Standard
13920 are input types provided with a label to enter information, which will
13921 be processed by the document class.
13925 \begin_layout Plain Layout
13926 It could be seen as a matter of inconsequence, that the types
13934 described above are not such input types as well.
13935 Because of the special meaning of those types, however, I have implemented
13936 them as ordinary paragraph types with a one letter mark in the left margin.
13937 Moreover, it would affect my feeling of symmetry, if the
13945 type had such a serious different appearance.
13950 The types must be used ahead of the corresponding
13957 \begin_layout Standard
13958 An implementation of these types in a WYSIWYG fashion does not seem to make
13959 sense, because the real appearance of the produced letter does not only
13960 depend on the usage of the particular type, but also on other factors.
13961 For example, a signature entered in the
13965 type will in the standard behavior appear in the produced letter only,
13966 when in the same letter also a
13971 The entered value of the
13975 type will in the standard behavior not appear in the produced letter at
13977 The possibility to design the letter`s heading freely is already indicated
13978 in a footnote above.
13981 \begin_layout Standard
13982 The input types can also be used as empty paragraphs.
13983 This makes sense e.
13984 \begin_inset space \thinspace{}
13988 \begin_inset space \space{}
14000 type is not used at all, in the standard behavior the value of the
14004 type is used as signature, whereas if an empty
14008 type is used, no signature value is defined.
14011 \begin_layout Standard
14012 By using the input types it is possible to write a letter template, containing
14013 filled input types with your personal dates (name, address, etc.) and empty
14014 input types for other dates you want to enter.
14017 \begin_layout Itemize
14022 : sender's name, in the standard behavior appears as a centered paragraph
14023 in small caps in the letter`s heading.
14026 \begin_layout Itemize
14031 : sender's signature, in the standard behavior appears below the
14040 type is used, the value of the
14044 type appears instead.
14047 \begin_layout Itemize
14052 : sender's address, in the standard behavior appears in a centered paragraph
14053 in the letter`s heading below the sender's name.
14056 \begin_layout Itemize
14061 : sender's telephone number, in the standard behavior only sets the LaTeX
14071 \begin_layout Itemize
14076 : place of the letter`s making.
14079 \begin_layout Itemize
14084 : date of the letter`s making.
14093 , in the standard behavior, produce the place and the date in a right-aligned
14094 line below the addressee's field.
14099 type is used, neither place nor date appear, independent of the value of
14109 type is used, the date of the letter `s production is used.
14112 \begin_layout Itemize
14117 : sender`s back address, in the standard behavior appears above the addressee's
14118 field in a small sans serif font.
14121 \begin_layout Itemize
14126 : special mail information, in the standard behavior appears underlined
14127 above the addressee's field below the back address.
14130 \begin_layout Itemize
14135 : additional information, in the standard behavior appears on right side
14136 below the addressee`s field.
14139 \begin_layout Itemize
14144 : the letter's title, in the standard behavior appears in a big, bold, sans
14145 serif font above the subject.
14148 \begin_layout Itemize
14153 : the letter's subject, in the standard behavior appears in a bold font
14161 \begin_layout Standard
14182 produce a business letter like line above the
14186 line containing the fields
14187 \begin_inset Quotes eld
14191 \begin_inset Quotes erd
14195 \begin_inset Quotes eld
14199 \begin_inset Quotes erd
14203 \begin_inset Quotes eld
14207 \begin_inset Quotes erd
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 For the date field, the value of the
14241 \begin_inset Quotes eld
14244 business letter types
14245 \begin_inset Quotes erd
14248 is used, the value of the
14252 type however does not appear, but only the LaTeX variable
14259 The ordinary output of place and date in a right-aligned line below the
14260 addressee`s field is suppressed.
14261 The types are implemented as input types provided with a label and must
14262 be used ahead of the corresponding
14269 \begin_layout Itemize
14277 \begin_layout Itemize
14285 \begin_layout Itemize
14293 \begin_layout Itemize
14301 \begin_layout Itemize
14309 \begin_layout Subsection
14310 The new letter class: letter (koma-script v.2)
14313 \begin_layout Standard
14319 \begin_layout Standard
14320 \begin_inset VSpace medskip
14326 \begin_layout Standard
14328 Koma-Script version 2.8 has introduced a new letter class
14332 which supersedes the now unsupported
14337 It has — on the LaTeX side — a completely new interface and is not compatible
14338 with the old class.
14339 Therefore, LyX supports both, though it is recommended you use the new
14343 \begin_layout Standard
14344 This class covers the same functionality as
14346 letter (koma-script),
14349 The basic items are
14353 (receiver's address, same as
14357 in the old layout),
14370 will start a new letter (i.
14371 \begin_inset space \thinspace{}
14375 \begin_inset space \space{}
14378 you can write several letters per document).
14379 New elements are sender's
14395 and the possibility to use a
14401 Insert\SpecialChar \menuseparator
14407 \begin_layout Standard
14408 The biggest improvement is, though, that the letter's layout is configurable
14409 to meet almost any needs.
14410 This can be done via the preamble or with a special style file (Letter
14411 Class Option, extension
14415 ), that will be read in as a class option.
14419 \begin_layout Plain Layout
14420 The KOMA package comes with some default
14425 There is, for instance, a
14429 file that follows german typesetting rules, or a
14433 that provides the default layout of the old
14438 The latter can be loaded with the class option
14447 ayout\SpecialChar \menuseparator
14452 ocument\SpecialChar \menuseparator
14464 template that is included in LyX for examples.
14465 A detailed description is to be found in the Koma-Script documentation
14473 \begin_layout Subsection
14477 \begin_layout Standard
14478 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
14482 \begin_layout Itemize
14483 The chapter number of a
14487 type appears on a line of its own above the chapter heading instead of
14488 appearing in the same line ahead of it.
14489 The cause for that is the LyX internal behavior for the labeltype
14493 in the layout file.
14496 \begin_layout Itemize
14497 The headings of the types
14505 are only put in the
14506 \begin_inset Quotes eld
14510 \begin_inset Quotes erd
14513 LaTeX table of contents, but not in the LyX table of contents (
14515 Document\SpecialChar \menuseparator
14517 \begin_inset space ~
14521 \begin_inset space ~
14529 \begin_layout Itemize
14530 The paragraphs in a
14534 document class appear in a skip separation mode, not indented.
14535 This is the standard behavior, no special LaTeX commands are needed for
14539 Document\SpecialChar \menuseparator
14542 dialog the corresponding radio button indicates
14551 value always has the effect that extra LaTeX commands are inserted in the
14552 document to produce the gap, which is not what is wanted in this case.
14555 \begin_layout Section
14559 \begin_layout Standard
14565 \begin_layout Subsection
14569 \begin_layout Standard
14570 Memoir is a very powerful and constantly evolving class.
14571 It has been designed with regard to fictional and non-fictional literature.
14572 Its aim is to let the user have maximum control over the typesetting of
14574 Memoir is based on the standard book class, but it can also emulate the
14575 article class (see below).
14578 \begin_layout Standard
14579 Peter Wilson, the developer of Memoir, is known as the author of lots of
14580 useful packages in the LaTeX world.
14581 Most of them have been merged with Memoir.
14582 Therefore, it is much easier to layout the table of contents, appendices,
14583 chapter designs and such.
14584 LyX, though, does not support all of these goodies natively.
14585 Some of them might be added to forthcoming releases
14589 \begin_layout Plain Layout
14590 You are invited to send suggestions to
14591 \begin_inset Flex URL
14594 \begin_layout Plain Layout
14596 lyx-devel@lists.lyx.org
14606 , lots will probably never be supported, due to the limitations of LyX's
14608 Of course you can still use all features with the help of some native LaTeX
14613 \begin_layout Plain Layout
14618 \begin_layout Plain Layout
14628 \begin_inset space ~
14632 \begin_inset CommandInset ref
14634 reference "sec:Inserting-TeX-Code"
14644 In this section, we can only list those features that are natively supported
14646 For detailed descriptions (and for the rest of features) we recommend you
14647 have a look at the detailed manual of the Memoir class
14651 \begin_layout Plain Layout
14656 \begin_layout Plain Layout
14666 \begin_inset Flex URL
14669 \begin_layout Plain Layout
14671 CTAN:/macros/latex/memoir/memman.pdf
14681 , which is not only a user guide for the class, but also both a comprehensive
14682 description on good typesetting and a superb example for good typesetting
14686 \begin_layout Subsection
14687 Basic features and restrictions
14690 \begin_layout Standard
14691 Memoir supports basically all features of the standard book classes.
14692 There are, however, some differences, as follows:
14695 \begin_layout Description
14697 \begin_inset space ~
14700 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
14703 \begin_layout Description
14705 \begin_inset space ~
14708 style: The fancy page style is not supported, due to a command clash between
14709 Memoir and the fancyhdr package (they both define a command with the same
14710 name, which confuses LaTeX).
14711 Instead, Memoir comes with a number of its own page styles (see
14713 Layout\SpecialChar \menuseparator
14714 Document\SpecialChar \menuseparator
14716 \begin_inset space ~
14722 If you want to use these for the chapter pages, you have to use the command
14729 in the main text or in preamble (e.
14730 \begin_inset space \thinspace{}
14734 \begin_inset space \space{}
14741 chapterstyle{companion}
14746 \begin_layout Description
14747 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
14748 optional argument in the standard classes.
14749 With this, you can specify an alternative version of the title for the
14750 table of contents and the headers (for instance, if the title is too long).
14751 In LyX, you can do this via
14753 Insert\SpecialChar \menuseparator
14755 \begin_inset space ~
14760 at the beginning of a chapter/section.
14761 Memoir features a second optional argument and thus separates the table
14762 of contents from the header.
14763 You can define three variants of a title with this: one for the main text,
14764 one for the table of contents, and one for the headers.
14765 Simply insert two optional arguments if you need this feature, the first
14766 one containing the short title for the Table of Contents, the second one
14767 containing an alternative short title for the headers.
14770 \begin_layout Description
14771 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14772 of contents, the list of figures and the list of table start a new page
14774 Memoir does not follow this route.
14775 You have to insert a page break yourself, if you want to have one.
14778 \begin_layout Description
14779 Titlepage: For some unknown reason, Memoir uses pagination on the title
14780 page (in the standard classes, title pages are
14781 \begin_inset Quotes eld
14785 \begin_inset Quotes erd
14789 If you want an empty title page, type
14793 aliaspagestyle{title}{empty}
14798 \begin_layout Description
14799 Article: With the class option
14805 Layout\SpecialChar \menuseparator
14806 Document\SpecialChar \menuseparator
14808 \begin_inset space ~
14813 ), you can emulate article style.
14814 That is, counters (footnotes, figures, tables etc.) will not be reset on
14815 new chapters, chapters don't start a new page (but are—in contrary to
14816 \begin_inset Quotes eld
14820 \begin_inset Quotes erd
14823 article classes—still allowed), parts, though, use their own page, as in
14827 \begin_layout Description
14828 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14829 font commands, which have been used in the old LaTeX version 2.09 (e.
14830 \begin_inset space \thinspace{}
14834 \begin_inset space \space{}
14850 It produces an error and stops LaTeX whenever such a command appears.
14855 reallows the commands and spits out warnings instead (which does at least
14857 Since a lot of packages and particularly BibTeX style files are still using
14858 those commands, we have decided to use this option by default.
14861 \begin_layout Subsection
14865 \begin_layout Standard
14866 We will only describe the features supported by LyX (which is not much currently
14868 Please consult the Memoir manual
14872 \begin_layout Plain Layout
14877 \begin_layout Plain Layout
14887 \begin_inset Flex URL
14890 \begin_layout Plain Layout
14892 CTAN:/macros/latex/memoir/memman.pdf
14905 \begin_layout Description
14906 Abstract: You may wonder why an abstract is an extra feature.
14907 Well, it is in book class.
14908 Usually books don't have abstracts.
14909 Memoir, however, has.
14910 You can use it wherever and how often you like.
14913 \begin_layout Description
14914 Chapterprecis: You may know this older typesetting style: The contents of
14915 a chapter are summarized below the title and also in the table of contents
14917 \begin_inset space \thinspace{}
14921 \begin_inset space \space{}
14926 Our hero arrives in Troia; he loses some friends; he finds others
14929 Chapterprecis does exactly this.
14930 It is therefore only sensible below a chapter.
14933 \begin_layout Description
14934 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14935 The epigraph environment provides an elegant way of typesetting such a
14937 The motto itself (text) and its author (source) are divided by a short
14939 Unfortunately, we have to fool LyX a bit here again, since the environment
14940 needs two arguments (text and source).
14941 In this case, we have to use curly brackets (in TeX mode) between the two
14952 <author of the slogan>.
14955 \begin_layout Description
14956 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14957 complex figurative poems).
14958 LyX can only support a few of them.
14959 One is poemtitle, which is a centered title for poems, which will also
14960 be added to the table of contents (verse is the standard environment for
14962 Memoir has some enhanced versions of verse, but you need to use TeX code,
14963 because they have to be nested inside regular verse environments, which
14964 is not possible with LyX).
14967 \begin_layout Description
14968 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14971 \begin_layout Section
14972 Article (mwart), book (mwbk) and report (mwrep)
14973 \begin_inset Argument
14976 \begin_layout Plain Layout
14989 \begin_layout Standard
14995 \begin_layout Standard
14996 The LyX document classes
15012 correspond to the LaTeX document classes
15025 They are replacements for the standard document classes
15037 , resp., and fit better to Polish typography conventions in a number of points.
15041 \begin_layout Standard
15045 \begin_layout Itemize
15046 Unnumbered titles (with star, e.
15047 \begin_inset space \thinspace{}
15051 \begin_inset space \space{}
15058 ) are added into table of contents,
15061 \begin_layout Itemize
15062 Additional page styles:
15066 \begin_layout Description
15067 uheadings header with separated lines,
15070 \begin_layout Description
15071 myheadings custom header, contents headers via commands:
15086 \begin_layout Description
15087 myuheadings custom header with separated lines,
15090 \begin_layout Description
15091 outer page number is placed on outer side of page
15095 \begin_layout Itemize
15100 \begin_layout Description
15101 rmheadings serif titles — default,
15104 \begin_layout Description
15105 sfheadings sansserif titles,
15108 \begin_layout Description
15109 authortitle on title page first placed is author next title — default,
15112 \begin_layout Description
15113 titleauthor on title page first placed is title next author,
15116 \begin_layout Description
15117 withmarginpar reserve place on page for margins.
15121 \begin_layout Section
15125 \begin_layout Standard
15130 provides an alternative to the standard
15135 It provides similar functionality, but you might prefer this layout with
15136 sans serif sections, headings, and more.
15139 \begin_layout Section
15143 \begin_layout Standard
15149 \begin_layout Standard
15150 \begin_inset VSpace bigskip
15156 \begin_layout Standard
15161 \begin_inset space ~
15166 textclass works with the American Physical Sociey's RevTeX 4.0 (the
15167 \begin_inset Formula $\beta$
15170 release of May, 1999) class.
15173 \begin_layout Standard
15178 textclass, which works with RevTeX 3.1.
15179 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
15180 That means that it doesn't interact very well with LyX, which requires
15181 LaTeX2e, although it has been kludged to work.
15182 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
15186 \begin_inset space ~
15191 textclass should also be pretty easy to use.
15194 \begin_layout Standard
15195 These documents are supposed to be used in
15199 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
15200 macros, and assume you'll know what to put in the preamble if necessary.
15203 \begin_layout Subsection
15207 \begin_layout Standard
15208 All you need to do is install RevTeX 4, as described in the package's README
15210 The package can be found at The RevTeX 4 Web Site
15211 \begin_inset Flex URL
15214 \begin_layout Plain Layout
15216 http://publish.aps.org/revtex4/
15222 Install it somewhere that LaTeX can see it.
15223 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
15225 \begin_inset space \thinspace{}
15229 \begin_inset space \space{}
15232 not the directory where you installed the class file.) Then, if you reconfigure
15233 LyX, it will find the class file and let you use the RevTeX4 textclass.
15236 \begin_layout Standard
15237 Probably the easiest way to get started is either to import a RevTeX 4 document
15245 \begin_inset space ~
15250 template, found in the templates directory.
15253 \begin_layout Subsection
15257 \begin_layout Standard
15258 Optional arguments to
15265 \begin_inset Quotes eld
15269 \begin_inset Quotes erd
15273 \begin_inset Quotes eld
15277 \begin_inset Quotes erd
15287 \begin_inset space ~
15295 \begin_inset space ~
15301 Remember that in RevTeX, at least one optional argument is required!
15304 \begin_layout Standard
15305 Other preamble matter, like
15312 \begin_inset space ~
15318 \begin_inset space ~
15323 dialog, also as usual.
15326 \begin_layout Subsection
15330 \begin_layout Standard
15331 The layouts basically correspond to the commands in RevTeX4.0.
15332 For example, the Email layout corresponds to
15339 Note that (at least as of RevTeX 4.0 Beta), the
15347 layouts are exactly equivalent, so you shouldn't need to use both.
15351 \begin_layout Plain Layout
15352 In case you're curious, both were included so that
15356 would be able to translate both
15376 \begin_layout Subsection
15380 \begin_layout Standard
15381 There are a couple of important unique aspects of RevTeX 4 which might cause
15382 bugs that will be even more confusing in LyX.
15385 \begin_layout Standard
15403 The LyX equivalent is that there is a separate Thanks layout.
15408 write footnotes in the
15412 layout, or weird things may happen.
15413 See the RevTeX 4 documentation for more details.
15416 \begin_layout Standard
15420 \begin_inset space ~
15428 \begin_inset space ~
15437 layouts must be placed
15445 layout and the corresponding
15462 , the LaTeX won't compile.
15465 \begin_layout Subsection
15469 \begin_layout Standard
15470 The main problem with this layout is that you can't use the optional arguments
15471 to layouts like Email and Title.
15472 (The problem is not unique to this layout; you can't use optional arguments
15473 to the Section layouts either.) This means that after you export that file
15474 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
15475 need to edit the LaTeX file with a text editor to add the optional arguments
15477 \begin_inset space \thinspace{}
15481 \begin_inset space \space{}
15484 the running title for the page headers.
15485 Lacking these layouts makes the
15491 (and the equivalent
15497 ) useless, so the corresponding layouts don't exist, and will have to be
15502 \begin_layout Plain Layout
15507 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
15508 has not been updated yet to take advantage of it.
15516 \begin_layout Section
15517 Springer Journals (
15524 \begin_layout Standard
15530 \begin_layout Subsection
15534 \begin_layout Standard
15535 These are the layout files for some of the journal formats used by Springer
15536 Verlag and listed on
15537 \begin_inset Flex URL
15540 \begin_layout Plain Layout
15542 http://www.springer.de/author/tex/help-journals.html
15547 , where you should also go to fetch the class files (yes, these are LaTeX2e
15549 It is a modular system: the things common to all journals are implemented
15554 , which journal-specific layout files (such as, e.
15555 \begin_inset space \thinspace{}
15559 \begin_inset space \space{}
15566 for Journal of Geodesy) can include.
15569 \begin_layout Standard
15570 This means that implementing support for any other Springer journal on this
15571 list is as simple as writing your own
15579 file following the outline given in
15587 \begin_layout Standard
15588 It is reasonably well tested only for the Journal of Geodesy.
15597 come with the standard LyX distribution.
15598 Install the relevant class file (downloaded from Springer) in a proper
15599 directory, reconfigure LaTeX (in the teTeX case by running
15603 , as root if necessary — doesn't LyX take care of this?), reconfigure LyX
15604 and it should work.
15607 \begin_layout Subsection
15611 \begin_layout Standard
15612 A large number of theorem-like styles —
15618 \SpecialChar \ldots{}
15624 \begin_layout Standard
15627 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
15628 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
15631 See the Springer class file documentation for details.
15634 \begin_layout Subsection
15638 \begin_layout Itemize
15650 \begin_layout Itemize
15653 Probability Theory and Related Fields
15659 — Jean-Marc Lasgouttes
15662 \begin_layout Standard
15663 Add your own, it isn't so hard!
15666 \begin_layout Subsection
15670 \begin_layout Standard
15671 These files are partly based on the older
15675 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
15676 file from Springer.
15681 layout, are now defunct.
15682 Jean-Marc Lasgouttes helped out big in making me find my way around the
15683 LyX layout file mechanism.
15686 \begin_layout Subsection
15690 \begin_layout Standard
15692 But probably less than in the old hacked-LaTeX
15699 \begin_layout Standard
15701 \begin_inset space \thinspace{}
15704 g.: does not display the number for theorem-like layouts, just #.
15707 \begin_layout Section
15713 \begin_inset CommandInset label
15722 \begin_layout Standard
15730 \begin_layout Subsection
15734 \begin_layout Standard
15735 This section describes how to use LyX to make slides for overhead projectors.
15736 There are two document classes that can do this: the default slides class
15742 This section documents the former.
15745 \begin_layout Standard
15746 I'm going to say this again, nice and clear, so that there's no misunderstanding
15750 \begin_layout Standard
15751 \begin_inset VSpace bigskip
15757 \begin_layout Standard
15761 This section documents the class
15762 \begin_inset Quotes eld
15770 \begin_inset Quotes erd
15778 \begin_layout Standard
15779 \begin_inset VSpace bigskip
15785 \begin_layout Standard
15786 If you're looking for the documentation for
15787 \begin_inset Quotes eld
15795 \begin_inset Quotes erd
15798 , check out section
15799 \begin_inset space ~
15803 \begin_inset CommandInset ref
15805 reference "sec:foiltex"
15815 \begin_inset Quotes eld
15823 \begin_inset Quotes erd
15826 ] is actually somewhat better than the default
15834 \begin_layout Plain Layout
15835 \SpecialChar \ldots{}
15836 or so I've been told repeatedly by its advocates.
15837 Having never used it, I have no idea if this claim is true or not.
15842 which this section documents.
15845 \begin_layout Standard
15846 This class is the LaTeX2e improvement of the old
15851 Every LaTeX2e distribution includes this class [which I'll just refer to
15853 \begin_inset Quotes eld
15861 \begin_inset Quotes erd
15864 from now on], so you're bound to have it.
15865 As I noted earlier, there are other classes, such as
15869 , which also produce slides for overhead projectors and do a better job
15871 However, there are some things which
15875 can do which the others can't, such as generate overlays.
15876 Read on to learn more!
15879 \begin_layout Subsection
15881 \begin_inset CommandInset label
15883 name "sec:slidesetup"
15890 \begin_layout Standard
15891 Obviously, to use this document class, you need to select
15892 \begin_inset Quotes eld
15900 \begin_inset Quotes erd
15903 from the class list in the
15905 Document\SpecialChar \menuseparator
15909 There are some other special things you should know about this class:
15912 \begin_layout Itemize
15913 Don't bother changing the options
15918 They're not supported by the
15925 \begin_layout Itemize
15929 \begin_inset space ~
15934 behaves a bit differently for this class.
15935 The possible choices and what they do are as follows:
15939 \begin_layout Description
15944 The final output contains page numbers in the lower right corner.
15947 \begin_layout Description
15956 , but also prints out any time markers you've put in.
15957 This is the default.
15960 \begin_layout Description
15965 The final output contains no page numbers, time markers, or alignment markers.
15969 \begin_layout Itemize
15974 class has an extra option:
15980 \begin_inset Quotes eld
15988 \begin_inset Quotes erd
15991 in the extra class options.
15995 \begin_layout Standard
15996 Using this options allows you to add time markers to
16002 \begin_inset space ~
16006 \begin_inset CommandInset ref
16008 reference "sec:slideNote"
16016 \begin_layout Standard
16017 You can also use the template file
16018 \begin_inset Quotes eld
16026 \begin_inset Quotes erd
16029 to automatically set up a document to use the
16035 File\SpecialChar \menuseparator
16037 \begin_inset space ~
16041 \begin_inset space ~
16046 to open your new document].
16047 The template file also contains some examples of the special paragraph
16048 environments used by this class.
16049 I'll describe those next.
16052 \begin_layout Subsection
16053 Paragraph Environments
16056 \begin_layout Subsubsection
16057 Supported Environments
16060 \begin_layout Standard
16061 The first thing you'll notice when you start up a new
16065 document is the font size and type: it's the equivalent of the size
16066 \begin_inset Quotes eld
16074 \begin_inset Quotes erd
16080 \begin_inset space ~
16086 This is also what's used in the output.
16088 \begin_inset Quotes eld
16092 \begin_inset Quotes erd
16095 to remind you that this is a slide.
16096 Your final slides will use a larger font; ergo, you'll have less space.
16097 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
16100 \begin_layout Standard
16101 The next thing that becomes obvious is the changes to the paragraph environment
16102 pull-down box [at the far-left end of the toolbar].
16103 Most of the paragraph environments you're used to seeing are missing.
16104 There are also five new ones.
16109 class itself only supports certain paragraph environments:
16112 \begin_layout Itemize
16118 \begin_layout Itemize
16124 \begin_layout Itemize
16130 \begin_layout Itemize
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 Standard
16179 All of the other standard environments, including the section-heading environmen
16180 ts, aren't used in the
16187 \begin_layout Standard
16188 On the other hand, you'll notice the following new environments:
16191 \begin_layout Itemize
16197 \begin_layout Itemize
16203 \begin_layout Itemize
16209 \begin_layout Itemize
16215 \begin_layout Itemize
16221 \begin_layout Standard
16222 These five are kind of quirky, due to a
16223 \begin_inset Quotes eld
16227 \begin_inset Quotes erd
16231 You see, LyX doesn't permit you to nest any other paragraph environment
16232 into an empty environment.
16233 Now, that's fine and dandy, but it means that you wouldn't be able to start
16234 a slide with anything except plain text.
16235 To deal with this, I've performed a little
16236 \begin_inset Quotes eld
16240 \begin_inset Quotes erd
16246 \begin_layout Subsubsection
16247 Quirks of the New Environments
16248 \begin_inset CommandInset label
16250 name "sec:slideQuirk"
16257 \begin_layout Standard
16258 All five of the new paragraph environments are somewhat quirky due to inherent
16259 limitiations in the current version of LyX.
16260 As I just mentioned, LyX forbids environments that begin with another environme
16262 To get around this, the
16266 environment isn't a paragraph environment as described in the
16274 \begin_layout Standard
16275 You should consider
16288 \begin_inset Quotes eld
16291 pseudo-environments.
16292 \begin_inset Quotes erd
16295 They look like a section heading or a
16296 \begin_inset Quotes eld
16304 \begin_inset Quotes erd
16307 but really begin a [and, if necessary, end the previous] paragraph environment.
16317 \begin_inset Quotes eld
16321 \begin_inset Quotes erd
16324 These two perform some action.
16327 \begin_layout Standard
16328 A common feature of all five environments,
16348 , is a rather long-ish label.
16349 The text following this label — ordinarily the contents of the paragraph
16350 environment — is utterly irrelevant for
16371 LyX completely ignores it.
16372 In fact, you can leave these five environments completely empty.
16376 \begin_layout Standard
16381 to put any text after the rather long-ish label, you might want to.
16382 This could be a short description of the contents of the
16387 In that case, enter your descriptive comment and hit
16391 as you normally would.
16394 \begin_layout Standard
16395 If, on the other hand, you don't want to enter any descriptive text, you'll
16396 hit another LyX quirk.
16397 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
16398 environment until you put something in the old one.
16402 \begin_layout Itemize
16403 Start entering the text that will
16431 \begin_layout Itemize
16432 Now move to the beginning of that paragraph.
16436 \begin_layout Itemize
16445 \begin_layout Itemize
16446 Finally, change this new, empty paragraph to a
16470 \begin_layout Standard
16471 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
16475 \begin_layout Subsection
16476 Making a Presentation with
16489 \begin_layout Subsubsection
16497 \begin_layout Standard
16498 If you're expecting this section to teach you how to actually make a presentatio
16499 n, you'll be sorely disappointed.
16500 Naturally, I'll describe all of the ways the
16504 class can assist you in preparing the materials for a presentation.
16505 Filling in the contents, however, is up to you.
16510 the LyX philosophy.]
16513 \begin_layout Standard
16518 environment [in the manner described in section
16519 \begin_inset space ~
16523 \begin_inset CommandInset ref
16525 reference "sec:slideQuirk"
16529 ] tells LyX to begin a new slide [duh].
16530 The label for this environment/
16531 \begin_inset Quotes erd
16535 \begin_inset Quotes erd
16539 \begin_inset Quotes eld
16543 \begin_inset Quotes erd
16546 in cool blue, followed by the label,
16547 \begin_inset Quotes eld
16551 \begin_inset Quotes erd
16555 Any text or paragraph environments that follow this one go on the new slide.
16559 \begin_layout Standard
16560 Slides are probably the only time you'll need to forcibly end pages in LyX
16561 (this can be specified in the
16566 In fact, you'll want to, once you finish entering the contents of one slide.
16567 If you've entered more text than can physically fit on a slide, the extra
16568 overflows onto a new slide.
16569 I don't recommend doing this, however, since the overflow slide won't have
16570 any page number on it.
16571 Furthermore, it may interfere with any
16575 you've made to accompany the oversized
16582 \begin_layout Standard
16591 environments work the same way as the
16596 They both create an
16597 \begin_inset Quotes eld
16601 \begin_inset Quotes erd
16604 followed by a label [
16605 \begin_inset Quotes eld
16609 \begin_inset Quotes erd
16613 \begin_inset Quotes eld
16617 \begin_inset Quotes erd
16621 The color is a stunning magenta instead of blue, and the
16622 \begin_inset Quotes eld
16626 \begin_inset Quotes erd
16629 will look different, in style and in length.
16630 The label fonts of all three also differ from one another.
16633 \begin_layout Standard
16638 , if the contents of a
16646 exceed the physical size of a slide or sheet of paper, the extra will overflow
16648 Again, you should avoid this.
16649 It defeats the whole purpose of
16660 \begin_layout Subsubsection
16670 \begin_layout Standard
16675 is a slide that sits atop another slide.
16676 Perhaps you wish to discuss a figure on the main
16680 before displaying the text associated with it.
16681 One way to accomplish this is tape a flap of dark paper over the part of
16686 you want to display later.
16687 This method fails, however, if you wish to overlap one graph with another,
16689 You would then have to fumble while speaking to align the two separate,
16694 s to align the two graphs.
16699 environment in both cases makes life much easier.
16702 \begin_layout Standard
16707 receives the page number of its
16708 \begin_inset Quotes eld
16712 \begin_inset Quotes erd
16720 \begin_inset Quotes eld
16728 \begin_inset Quotes erd
16735 \begin_layout Plain Layout
16736 Presumably, mutliple
16741 \begin_inset Quotes eld
16749 \begin_inset Quotes erd
16753 \begin_inset Quotes eld
16761 \begin_inset Quotes erd
16765 \begin_inset Quotes eld
16773 \begin_inset Quotes erd
16777 \begin_inset space ~
16780 appended to the page number of the parent
16790 Clearly, you want the contents of both the
16798 to each fit on a single physical slide! You should probably consider an
16804 \begin_inset Quotes eld
16808 \begin_inset Quotes erd
16820 class provides a visual cue for this: the label at the start of an
16824 is shorter than that at the start of a
16829 Lastly, when you generate printable output, you'll find alignment markers
16830 in all four corners of both the
16834 page and its parent
16839 These will assist you in lining up the two physical slides.
16842 \begin_layout Standard
16843 The major problem in overlaying two slides is aligning the contents of the
16844 two transparencies.
16845 How much space should you leave for that graph on the second slide? Worse
16846 still, what if you want a graph and a sentence on second slide, but there
16847 is text on the main transparency that goes in between them? You could try
16848 and insert vertical space of the right size.
16849 The better way is to use
16860 \begin_layout Standard
16861 As their names imply,
16869 are two command-like paragraph environments that make all subsequent text
16870 invisible and visible, respectively.
16872 \begin_inset space ~
16876 \begin_inset CommandInset ref
16878 reference "sec:slideQuirk"
16882 that you don't place anything
16886 these two environments, however.
16891 , it inserts a centered, sky-blue label into the page reading
16892 \begin_inset Quotes eld
16895 <Invisible Text Follows>
16896 \begin_inset Quotes erd
16900 For paragraphs following this label, the parts of the
16908 ; it doesn't matter which] where they would be contain instead blank space.
16912 \begin_layout Standard
16917 , the corresponding centered label is
16918 \begin_inset Quotes eld
16921 <Visible Text Follows>
16922 \begin_inset Quotes erd
16926 Paragraphs following this label behave normally.
16927 Note that the beginning of a new
16939 automatically shuts off an
16944 It's therefore not necessary to use
16955 \begin_layout Standard
16956 By now, it should be obvious how to create overlay transparencies using
16957 the proper combination of
16976 \begin_layout Enumerate
16981 , including everything that will appear on it, whether on the main slide
16989 \begin_layout Enumerate
16990 Before each figure or paragraph that will appear only on the
16999 If necessary, insert a
17003 environment after the
17010 \begin_layout Enumerate
17015 immediately following the
17022 \begin_layout Enumerate
17023 Copy the contents of this
17034 \begin_layout Enumerate
17039 , change all of the
17050 \begin_layout Standard
17052 You've just made an
17059 \begin_layout Standard
17060 There's one problem with the way I've designed the LyX
17064 class: you can't make text in the middle of a paragraph invisible, nor
17065 make text in the middle of an invisible paragraph visible again.
17066 To accomplish this feat, you'll need to use some inlined LaTeX codes.
17070 \begin_layout Plain Layout
17071 The commands of interest are:
17074 \begin_layout Itemize
17079 invisible \SpecialChar \ldots{}
17083 \begin_layout Itemize
17088 visible \SpecialChar \ldots{}
17092 \begin_layout Plain Layout
17093 \SpecialChar \ldots{}
17094 and need to be marked as TeX.
17096 \begin_inset Quotes eld
17100 \begin_inset Quotes erd
17103 you wish to change goes in between the brackets [and after the
17116 If you don't know how to mark text as TeX, see the appropriate section
17129 \begin_layout Subsubsection
17139 \begin_inset CommandInset label
17141 name "sec:slideNote"
17148 \begin_layout Standard
17157 is associated with a
17158 \begin_inset Quotes eld
17162 \begin_inset Quotes erd
17174 class provides visual cues.
17179 is shorter than that of a
17183 [yet longer than that of an
17187 ] and, like the label of an
17191 is shockingly magenta.
17192 Additionally, the printed
17196 has the page number of its
17197 \begin_inset Quotes eld
17201 \begin_inset Quotes erd
17209 \begin_inset Quotes eld
17217 \begin_inset Quotes erd
17221 \begin_inset Quotes eld
17229 \begin_inset Quotes erd
17233 \begin_inset Quotes eld
17241 \begin_inset Quotes erd
17245 You can have multiple
17249 s associated with a single
17261 , you'll probably want to break up long
17265 s so that they fit on a single sheet of paper.
17268 \begin_layout Standard
17273 is obvious: it contains anything additional you might want to say about
17279 It could also be used as a sheet of reminders for a particular
17284 In the case of the latter, you might want to make use of time markers.
17290 \begin_inset Quotes eld
17294 \begin_inset Quotes erd
17297 support for time markers, a
17302 So, you'll have to resort to using the LaTeX codes.
17305 \begin_layout Standard
17306 To use time markers, you'll need to specify the extra class option
17307 \begin_inset Quotes eld
17315 \begin_inset Quotes erd
17319 \begin_inset space ~
17323 \begin_inset CommandInset ref
17325 reference "sec:slidesetup"
17330 This option turns on timing marks, which will appear in the lower-left-hand
17336 To set what appears in the time marker, you use the LaTeX commands
17337 \begin_inset Quotes eld
17347 \begin_inset Quotes erd
17351 \begin_inset Quotes eld
17361 \begin_inset Quotes erd
17365 The arguments of both commands are time measured in seconds.
17367 \begin_inset Quotes eld
17377 \begin_inset Quotes erd
17380 sets the time marker to a given time.
17382 \begin_inset Quotes eld
17392 \begin_inset Quotes erd
17395 increments the time marker by the specified amount.
17396 Using time markers and
17400 s in this fashion, you can remind yourself how much time to spend on a particula
17408 \begin_layout Standard
17409 There's one last feature to describe.
17410 Clearly, you'd like to print out all of your
17418 s on transparencies while printing all of your
17435 with which it is associated.
17436 What's a person to do?
17439 \begin_layout Standard
17440 Luckily, there are two LaTeX commands that allow you to select what to print
17442 Both must be placed into the preamble of your document.
17444 \begin_inset Quotes eld
17456 \begin_inset Quotes erd
17459 will cause the output to contain only the
17468 Correspondingly, the command
17469 \begin_inset Quotes eld
17481 \begin_inset Quotes erd
17484 prevents the output of anything but
17489 I'd advise placing both commands in the preamble and initially comment
17491 You can then preview your entire presentation as you write.
17492 When you're done writing, you can then uncomment one of the two to select
17493 what you want to print.
17494 I like to uncomment
17495 \begin_inset Quotes eld
17507 \begin_inset Quotes erd
17510 , print to a file with
17511 \begin_inset Quotes eld
17519 \begin_inset Quotes erd
17522 in its name, comment it back out, then uncomment
17523 \begin_inset Quotes eld
17535 \begin_inset Quotes erd
17539 \begin_inset Quotes eld
17547 \begin_inset Quotes erd
17551 I can then send either file to a printer, loading transparencies or plain
17552 paper as appropriate.
17555 \begin_layout Standard
17556 You can also provide other arguments to the
17557 \begin_inset Quotes eld
17567 \begin_inset Quotes erd
17571 \begin_inset Quotes eld
17581 \begin_inset Quotes erd
17585 See a good LaTeX book for details.
17588 \begin_layout Subsection
17593 Class Template File
17596 \begin_layout Standard
17597 I have also provided a template file,
17598 \begin_inset Quotes eld
17606 \begin_inset Quotes erd
17614 To use it, begin your new presentation with
17619 ile\SpecialChar \menuseparator
17621 \begin_inset space ~
17625 \begin_inset space ~
17635 Your new LyX presentation file will contain an example
17656 additionally contain an example of the use of
17665 Lastly, the preamble will contain:
17668 \begin_layout LyX-Code
17669 % Uncomment to print out only slides and overlays
17672 \begin_layout LyX-Code
17676 \begin_layout LyX-Code
17682 \begin_inset Newline newline
17688 \begin_layout LyX-Code
17689 % Uncomment to print out only notes
17692 \begin_layout LyX-Code
17696 \begin_layout LyX-Code
17704 \begin_layout Standard
17705 One final thing: I created this class to support the LaTeX2e
17706 \begin_inset Quotes eld
17714 \begin_inset Quotes erd
17717 class, one of the built-in LaTeX2e classes.
17718 Neither I nor the rest of the LyX Team endorse or oppose the use of this
17719 built-in slide class.
17720 It's here if you want it or need it.
17721 There exist other LaTeX2e classes for creating presentations, such as the
17727 \begin_inset space ~
17731 \begin_inset CommandInset ref
17733 reference "sec:foiltex"
17738 \begin_inset Quotes eld
17746 \begin_inset Quotes erd
17749 package [present on some TeX distributions].
17750 The latter is not yet supported under LyX.
17754 \begin_layout Plain Layout
17755 Perhaps you can take on the task\SpecialChar \ldots{}
17761 I know nothing about these other classes.
17762 Try them out to see what sort of alternative they provide.
17765 \begin_layout Chapter
17766 LyX Features needing Extra Software
17769 \begin_layout Section
17773 \begin_layout Standard
17779 \begin_layout Subsection
17783 \begin_layout Standard
17792 \begin_layout Plain Layout
17797 is not yet available when you are using the LaTeX distribution MiKTeX.
17802 , you'll find in the
17809 \begin_inset space ~
17820 \begin_inset CommandInset href
17822 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
17829 \begin_layout Standard
17834 package is a program that was written by
17835 \begin_inset Flex Noun
17838 \begin_layout Plain Layout
17840 \begin_inset space ~
17848 in frustration because some constructs in LaTeX are sometimes non-intuitive,
17849 and easy to forget.
17850 The program runs over your LaTeX file, checks the integrity of the file,
17851 and flags some common errors.
17852 In other technical words, it is
17859 \begin_layout Standard
17860 Well, what is a syntax checker doing in LyX which is supposed to produce
17861 correct LaTeX anyways? The answer is simple: Just as
17865 not only checks the
17869 of C programs, but also does
17873 checks for type-errors,
17877 catches some common
17881 errors, in addition to the syntactical ones.
17886 is capable of detecting several common errors, such as
17889 \begin_layout Itemize
17890 Ellipsis detection:
17891 \begin_inset Newline newline
17894 Use \SpecialChar \ldots{}
17898 \begin_layout Itemize
17899 No space in front of/after parenthesis:
17900 \begin_inset Newline newline
17906 \begin_layout Itemize
17907 Enforcement of normal space after common abbreviations:
17908 \begin_inset Newline newline
17912 \begin_inset space \thinspace{}
17916 \begin_inset space \space{}
17919 is too wide spacing.
17922 \begin_layout Itemize
17923 Enforcement of end-of-sentence space when the last sentence ends with a
17925 \begin_inset Newline newline
17929 And this is wrong spacing.
17932 \begin_layout Itemize
17933 Space in front of labels and similar commands:
17934 \begin_inset Newline newline
17937 The label should stick right up to the text to avoid falling to a wrong
17940 \begin_inset CommandInset label
17950 \begin_layout Plain Layout
17951 This footnote is in danger of falling off to a wrong page
17956 The label is separated too much.
17959 \begin_layout Itemize
17960 Space in front of references, instead of hard spaces:
17961 \begin_inset Newline newline
17964 If you have bad luck, the text will break right between the referenced text
17965 and reference number, and that's a pity.
17967 \begin_inset CommandInset ref
17969 reference "sec:chktex"
17976 \begin_layout Itemize
17978 \begin_inset Quotes eld
17982 \begin_inset Quotes erd
17986 \begin_inset Formula $\times$
17990 \begin_inset Newline newline
17993 2x2 looks cheap compared to
17994 \begin_inset Formula $2\times2$
18000 \begin_layout Standard
18001 and more \SpecialChar \ldots{}
18002 It is an invaluable tool when you are
18003 \begin_inset Quotes eld
18007 \begin_inset Quotes erd
18010 your document before printing, and you should run it right after the obligatory
18011 spelling check, and before you go fine tuning the typesetting.
18014 \begin_layout Subsection
18018 \begin_layout Standard
18019 If you have the program installed, usage is as simple as choosing
18021 Tools\SpecialChar \menuseparator
18023 \begin_inset space ~
18029 This will make LyX generate a LaTeX file of your document, start
18033 to check it, and then make LyX insert
18034 \begin_inset Quotes eld
18038 \begin_inset Quotes erd
18041 with the warnings from
18045 , if there were any.
18046 The warnings will be placed close to the point of the mistake, and you
18047 can quickly find them by using the
18049 Navigate\SpecialChar \menuseparator
18052 menu item, or the shortcut key
18061 Open the error boxes by clicking on them with the mouse, or use the shortcut
18070 bindings, or the corresponding
18079 Read the warning and correct the mistake, if it is a mistake.
18080 If you have trouble understanding what the warning is about, you can safely
18082 Remember that there is a hidden layer between the document on screen and
18083 the technical details in invoking
18087 , and this gap can make some warnings seem arcane or just plain silly.
18090 \begin_layout Standard
18091 This document is an excellent testing bed for the feature, and it should
18092 provide quite a few warnings for you to fiddle with.
18093 Since computers are only so smart, expect most of the warnings to be false
18097 \begin_layout Subsection
18098 How to fine tune it
18101 \begin_layout Standard
18102 Sometimes, you'll find that
18106 makes more noise than suits your mood.
18107 Then you can choose not to use it, wait until your mood changes, or try
18112 to get better along with you.
18115 \begin_layout Standard
18124 very configurable and extensible, you shouldn't expect to solve all problems
18130 Since LyX has to generate a somewhat special LaTeX file to be able to match
18131 the line numbers from the
18139 \begin_layout Plain Layout
18140 You can inspect the specific output from
18146 Edit\SpecialChar \menuseparator
18148 \begin_inset space ~
18152 \begin_inset space ~
18166 to the internal document structure, some of the warnings will not appear
18168 There are two things you can do about this:
18171 \begin_layout Itemize
18176 invocation command line in
18177 \begin_inset Flex MenuItem
18180 \begin_layout Plain Layout
18181 Tools\SpecialChar \menuseparator
18182 Preferences\SpecialChar \menuseparator
18183 Output\SpecialChar \menuseparator
18184 LaTeX\SpecialChar \menuseparator
18194 installation configuration file (usually with the file
18199 See below to learn what warnings can be enabled and disabled on the command
18203 \begin_layout Itemize
18204 Export your document as a raw LaTeX file using
18206 File\SpecialChar \menuseparator
18207 Export\SpecialChar \menuseparator
18215 Invoked in this way, it can be a hassle to find the corresponding place
18216 in the document inside LyX, but with a little patience, you should be able
18220 \begin_layout Standard
18221 Here follows the warning messages that can be enabled and disabled in
18230 to disable a warning, and
18234 to enable a warning.
18235 The emphasized entries are disabled by default, because the default is
18238 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
18243 \begin_layout Standard
18244 Notice that you should only use the options that enable and disable warnings,
18245 because LyX relies on some of the other command line parameters to be set
18246 in a specific way to have a chance to communicate with
18253 \begin_layout Enumerate
18257 Command terminated with space.
18260 \begin_layout Enumerate
18263 Non-breaking space (
18264 \begin_inset Quotes eld
18272 \begin_inset Quotes erd
18275 ) should have been used.
18278 \begin_layout Enumerate
18282 You should enclose the previous parenthesis with
18283 \begin_inset Quotes eld
18291 \begin_inset Quotes erd
18297 \begin_layout Enumerate
18300 Italic correction (
18301 \begin_inset Quotes eld
18311 \begin_inset Quotes erd
18314 ) found in non-italic buffer.
18317 \begin_layout Enumerate
18320 Italic correction (
18321 \begin_inset Quotes eld
18331 \begin_inset Quotes erd
18334 ) found more than once.
18337 \begin_layout Enumerate
18341 No italic correction (
18342 \begin_inset Quotes eld
18352 \begin_inset Quotes erd
18358 \begin_layout Enumerate
18362 \begin_inset Quotes eld
18370 \begin_inset Quotes erd
18374 \begin_inset Quotes eld
18382 \begin_inset Quotes erd
18388 \begin_layout Enumerate
18391 Wrong length of dash may have been used.
18394 \begin_layout Enumerate
18398 \begin_inset Quotes eld
18406 \begin_inset Quotes erd
18410 \begin_inset Quotes eld
18418 \begin_inset Quotes erd
18424 \begin_layout Enumerate
18428 \begin_inset Quotes eld
18436 \begin_inset Quotes erd
18442 \begin_layout Enumerate
18446 \begin_inset Quotes eld
18454 \begin_inset Quotes erd
18457 to achieve an ellipsis.
18460 \begin_layout Enumerate
18463 Inter-word spacing (
18464 \begin_inset Quotes eld
18474 \begin_inset Quotes eld
18477 ) should perhaps be used.
18480 \begin_layout Enumerate
18483 Inter-sentence spacing (
18484 \begin_inset Quotes eld
18494 \begin_inset Quotes erd
18497 ) should perhaps be used.
18500 \begin_layout Enumerate
18503 Could not find argument for command.
18506 \begin_layout Enumerate
18510 \begin_inset Quotes eld
18518 \begin_inset Quotes erd
18524 \begin_layout Enumerate
18527 Math mode still on at end of LaTeX file.
18530 \begin_layout Enumerate
18534 \begin_inset Quotes eld
18542 \begin_inset Quotes erd
18545 doesn't match the number of
18546 \begin_inset Quotes eld
18554 \begin_inset Quotes erd
18560 \begin_layout Enumerate
18563 You should use either
18566 \begin_inset Quotes eld
18574 \begin_inset Quotes erd
18579 as an alternative to
18580 \begin_inset Quotes eld
18588 \begin_inset Quotes erd
18594 \begin_layout Enumerate
18601 " (ASCII 39) instead of "
18608 \begin_layout Enumerate
18611 User-specified pattern found.
18614 \begin_layout Enumerate
18617 This command might not be intended.
18620 \begin_layout Enumerate
18627 \begin_layout Enumerate
18645 \begin_layout Enumerate
18648 Delete this space to maintain correct page references.
18651 \begin_layout Enumerate
18655 You might wish to put this between a pair of
18656 \begin_inset Quotes eld
18664 \begin_inset Quotes erd
18670 \begin_layout Enumerate
18673 You ought to remove spaces in front of punctuation.
18676 \begin_layout Enumerate
18679 Could not execute LaTeX command.
18682 \begin_layout Enumerate
18691 in front of small punctuation.
18694 \begin_layout Enumerate
18702 may look prettier here.
18705 \begin_layout Enumerate
18709 Multiple spaces detected in output.
18712 \begin_layout Enumerate
18715 This text may be ignored.
18718 \begin_layout Enumerate
18724 \begin_inset Quotes eld
18729 to begin quotation, not
18736 \begin_layout Enumerate
18743 to end quotation, not
18746 \begin_inset Quotes eld
18754 \begin_layout Enumerate
18760 \begin_layout Enumerate
18763 You should perhaps use
18764 \begin_inset Quotes eld
18772 \begin_inset Quotes erd
18778 \begin_layout Enumerate
18781 You should put a space in front of/after parenthesis.
18784 \begin_layout Enumerate
18787 You should avoid spaces in front of/after parenthesis.
18790 \begin_layout Enumerate
18794 You should not use punctuation in front of/after quotes.
18797 \begin_layout Enumerate
18800 Double space found.
18803 \begin_layout Enumerate
18806 You should put punctuation outside inner/inside display math mode.
18809 \begin_layout Enumerate
18812 You ought to not use primitive TeX in LaTeX code.
18815 \begin_layout Enumerate
18818 You should remove spaces in front of
18819 \begin_inset Quotes eld
18827 \begin_inset Quotes erd
18833 \begin_layout Enumerate
18836 \begin_inset Quotes eld
18844 \begin_inset Quotes erd
18847 is normally not followed by
18848 \begin_inset Quotes eld
18856 \begin_inset Quotes erd
18862 \begin_layout Standard
18863 In later versions of LyX, we hope to provide a more complete interface to
18864 this tool (and it's smaller cousin
18868 ) to exploit the full power of it.
18869 But it's not exactly useless as it is now: go try it on one of your existing
18870 documents of a certain length and be surprised.
18873 \begin_layout Section
18874 Version Control in LyX
18877 \begin_layout Standard
18880 Lars Gullik Bjønnes
18887 \begin_layout Subsection
18891 \begin_layout Standard
18892 LyX supports some of the most basic RCS/CVS/SVN commands.
18893 If you need something a bit more sophisticated you will have to do that
18894 manually in a terminal.
18897 \begin_layout Standard
18898 Also note that CVS support is not as good as subversion support so we advise
18900 A good place to start learning Subversion is SVN Book
18904 \begin_layout Plain Layout
18905 \begin_inset CommandInset href
18907 target "http://svnbook.red-bean.com/"
18917 In the case of RCS you should read
18918 \begin_inset Quotes eld
18922 \begin_inset Quotes erd
18925 (a man file, read it with
18930 This file describes all the basic features of RCS.
18931 You should especially notice the comment about a RCS directory, and the
18932 notion of a master RCS file (the file ending in
18939 \begin_layout Standard
18940 Before you begin to use the version control features in LyX, you should
18941 be familiar with RCS/CVS/SVN usage.
18942 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
18943 package—no guarantees are made for older versions.
18944 Most of the log messages are not currently displayed after operations —
18945 you can check them in the Messages pane if unsure.
18946 Regular users of version control will appreciate VC toolbar, which can
18949 View\SpecialChar \menuseparator
18950 Toolbars\SpecialChar \menuseparator
18952 \begin_inset space ~
18960 \begin_layout Standard
18961 For introducing your own external commands consult vc-command in the manual
18965 \begin_layout Subsection
18966 RCS commands in LyX
18969 \begin_layout Standard
18970 The following sections describe the RCS commands supported by LyX.
18971 You can find them in the
18973 File\SpecialChar \menuseparator
18975 \begin_inset space ~
18981 LyX was tested against RCS 5.7/5.8
18985 \begin_layout Plain Layout
18986 Note that old DOS / MS Windows builds (5.7) need to setup environment variables
18987 in order to work properly with LyX.
18988 In particular time zone (TZ) should be set and more importantly RCSINIT
18989 in order to change default archive location ("SET RCSINIT=-x,v/") --- LyX
18990 expects archive to be found in file.lyx,v within the original document directory.
18991 See also README shipped with Windows RCS binaries.
18999 \begin_layout Subsubsection
19005 \begin_layout Standard
19006 If your document is not under revision control, this is the only item shown
19008 And if it is under revision control, the
19012 item is not visible.
19016 \begin_layout Standard
19017 This command registers your document with RCS (unless you are under the
19018 directory managed by CVS)\SpecialChar \@.
19019 You are asked interactively to supply an initial
19020 description of the document.
19021 The document is now set in Read-Only mode and you have to
19024 \begin_inset space ~
19028 \begin_inset space ~
19032 \begin_inset space ~
19037 , before making any changes to it.
19038 A document under revision control has a
19039 \begin_inset Quotes eld
19042 [RCS:<version> <locker>]
19043 \begin_inset Quotes erd
19046 item tagged to the filename in the minibuffer.
19049 \begin_layout Standard
19050 RCS command that is run:
19052 ci -q -u -i -t-"<initial description>" <file-name>
19055 \begin_layout Standard
19060 to understand the switches.
19064 \begin_layout Subsubsection
19070 \begin_layout Standard
19071 When you are finished editing a file, you check in your changes.
19072 When you do this, you are asked for a description of the changes.
19073 This is stored in the history log.
19074 The version number is bumped, your changes are applied to the master RCS
19075 file, the document is unlocked and set to Read-Only mode.
19079 \begin_layout Standard
19082 ci -q -u -m"<description>" <file-name>
19085 \begin_layout Subsubsection
19091 \begin_layout Standard
19092 By doing this you lock the document so that only you can edit it.
19093 This will also make the document Read-Write only for you.
19094 You will usually continue editing for a while and when you are finished
19095 you check in your changes.
19096 The status line is changed to reflect that you have locked the file.
19100 \begin_layout Standard
19103 co -q -l <file-name>
19106 \begin_layout Subsubsection
19109 Revert To Repository Version
19112 \begin_layout Standard
19113 This will discard all changes made to the document since the last check
19115 You get a warning before changes are discarded.
19118 \begin_layout Standard
19121 co -f -u<version> <file-name>
19124 \begin_layout Subsubsection
19130 \begin_layout Standard
19131 This makes as if the last check in never happened.
19132 No changes are made to the document loaded into LyX, but the last version
19133 is removed from the master RCS file.
19137 \begin_layout Standard
19140 rcs -o<version> <file-name>
19143 \begin_layout Subsubsection
19149 \begin_layout Standard
19150 This shows the complete history of the RCS document.
19155 is shown in a browser.
19163 \begin_layout Subsubsection
19167 \begin_layout Standard
19168 LyX supports RCS version number, author name, date and time of last commit.
19169 All those are extracted from
19171 rlog -r <file-name>
19174 For other details see
19175 \begin_inset CommandInset ref
19177 reference "sub:VCS-Revision-Information"
19184 \begin_layout Subsection
19185 CVS commands in LyX
19188 \begin_layout Standard
19189 A subset of CVS operations is supported by LyX.
19190 You can find the commands in the
19192 File\SpecialChar \menuseparator
19194 \begin_inset space ~
19200 The version control system SVN is more powerful, so please use it instead
19201 of CVS if possible.
19204 \begin_layout Subsubsection
19210 \begin_layout Standard
19211 If you start from scratch with CVS you have to create your repository and
19212 checkout the working copy with external tools.
19213 If you're using a client-server setup you may need to login before doing
19214 the first repository checkout.
19217 \begin_layout Standard
19218 If your documents are under revision control and others are using the same
19219 repository problems arise when different changes to the same document at
19220 the same location happen.
19221 Standard CVS repositories doesn't operate with a file locking mechanism.
19222 This may be surprising, but conflicts only occur if people disagree on
19223 the proper content of the same part of a document.
19224 So, if co-workers are used to communicate regularly, these conflicts occur
19226 If they don't communicate they have a fundamental problem anyway.
19227 Nevertheless some people like to work with so called
19228 \begin_inset Quotes eld
19232 \begin_inset Quotes erd
19236 If they do so the working copy of all files is readonly when checked out
19237 first and the user starts editing after using a special command to make
19238 the working copy writable.
19239 When the changes are checked in the working copy returns to readonly state.
19240 With LyX one has to edit the
19241 \begin_inset Flex Code
19244 \begin_layout Plain Layout
19250 file and add the line
19251 \begin_inset Flex Code
19254 \begin_layout Plain Layout
19260 to work with reserved checkouts.
19261 The benefit is the possibility to see who is using a writable copy of some
19263 It's not guaranteed only one user makes a copy writable.
19266 \begin_layout Standard
19267 LyX tries to guess if you're using reserved or non-reserved checkouts.
19268 If your working copy is readonly or it is writable and an additional copy
19269 of your document exists in the CVS/Base sub-directory a reserved otherwise
19270 a non-reserved checkout is assumed.
19271 When a reserved checkout is detected you have to use
19272 \begin_inset Flex MenuItem
19275 \begin_layout Plain Layout
19281 to make your working copy writable if it's readonly.
19283 \begin_inset Flex MenuItem
19286 \begin_layout Plain Layout
19292 operation is possible and that makes your working copy readonly again after
19293 transferring your changes to the repository.
19296 \begin_layout Standard
19297 More information about CVS can be found here
19298 \begin_inset Flex URL
19301 \begin_layout Plain Layout
19303 http://www.nongnu.org/cvs
19309 \begin_inset Flex URL
19312 \begin_layout Plain Layout
19314 http://ximbiot.com/cvs
19322 \begin_layout Standard
19327 to understand the sub-commands and the switches mentioned below.
19330 \begin_layout Subsubsection
19336 \begin_layout Standard
19337 If your document is not under revision control, this is the only item shown
19339 And if it is under revision control, the
19346 item is not visible.
19350 \begin_layout Standard
19351 This command registers in CVS your document
19352 \begin_inset Flex Strong
19355 \begin_layout Plain Layout
19363 in the case you have already the documents directory under CVS control
19369 This means you have to create or checkout the archive by yourself using
19371 (In case you forget that step LyX registers the document with RCS.)
19374 \begin_layout Standard
19375 Then you are asked interactively to supply an initial description of the
19377 Don't forget that registered file is not yet checked in.
19380 \begin_layout Standard
19381 CVS command that is run:
19383 cvs -q add -m"<entered message>" "<file-name>"
19386 \begin_layout Standard
19391 above and for all other CVS commands is an abbreviation for
19392 \begin_inset Quotes eld
19395 change the current working directory to file location and use the file name
19396 without path component as argument
19397 \begin_inset Quotes erd
19403 \begin_layout Subsubsection
19409 \begin_layout Standard
19410 When you are finished editing a file, you commit your changes.
19411 When you do this and you had changed the document, you are asked for a
19412 description of the changes.
19413 After that changes are written to the repository.
19414 In case you didn't change the document and a reserved checkout is detected
19415 the reservation made on
19416 \begin_inset Flex MenuItem
19419 \begin_layout Plain Layout
19428 \begin_layout Labeling
19429 \labelwidthstring 00.00.0000
19431 \begin_inset space ~
19435 \begin_inset space ~
19439 \begin_inset Newline newline
19443 \begin_inset Flex Code
19446 \begin_layout Plain Layout
19449 -q commit -m"<description>" "<file-name>"
19455 \begin_inset Newline newline
19459 \begin_inset Flex Code
19462 \begin_layout Plain Layout
19473 \begin_layout Subsubsection
19479 \begin_layout Standard
19480 When you are sharing a repository with others, you may have to incorporate
19481 their changes into your working copy.
19484 \begin_layout Standard
19487 cvs -q update "<file-name>"
19490 \begin_layout Standard
19491 If a readonly checkout is detected the working copy is made writable and
19495 \begin_layout Standard
19498 cvs -q edit "<file-name>"
19501 \begin_layout Subsubsection
19504 Revert To Repository Version
19507 \begin_layout Standard
19508 This will discard all changes made to the document since the last check
19510 You get a warning before changes are discarded.
19511 Firstly the file is deleted, secondly CVS update command is run.
19514 \begin_layout Standard
19517 cvs -q update "<file-name>"
19520 \begin_layout Standard
19521 If a reserved checkout is detected and the working copy has no changes only
19522 the reservation is undone.
19525 \begin_layout Standard
19528 cvs -q unedit "<file-name>"
19531 \begin_layout Subsubsection
19532 Update of the local directory checkout from repository
19535 \begin_layout Standard
19536 Once your documents gets more complex, containing sub-documents and pictures,
19538 \begin_inset Flex Code
19541 \begin_layout Plain Layout
19547 files and so on using version control becomes more complicated.
19548 LyX supports updating the whole tree in which resides the document.
19549 This become especially useful once you cooperate with people which neither
19550 have detailed knowledge about CVS usage nor they have ambition to commit
19551 additional material to the repository.
19552 You have to organize the files structure so that all external files are
19553 in the same directory or subdirectories of the document.
19554 It's good practice anyway to store multipart documents in an extra directory.
19557 \begin_layout Standard
19559 \begin_inset Flex Code
19562 \begin_layout Plain Layout
19563 Update local directory from repository
19568 command updates the whole directory.
19569 If local changes are detected user is warned before update starts.
19570 In case of merge conflicts both versions of the conflicting document parts
19571 are placed in the final document.
19572 You have to review and correct the result of the merge.
19573 You'll find the conflicts enclosed in pairs of
19574 \begin_inset Flex Code
19577 \begin_layout Plain Layout
19584 \begin_inset Flex Code
19587 \begin_layout Plain Layout
19594 \begin_inset Flex Code
19597 \begin_layout Plain Layout
19604 The first part is your version as before the update operation with the
19605 document name prepended.
19606 The second one is the repository version with the version number after
19608 \begin_inset Flex Code
19611 \begin_layout Plain Layout
19620 \begin_layout Labeling
19621 \labelwidthstring 00.00.0000
19623 \begin_inset space ~
19627 \begin_inset space ~
19631 \begin_inset Newline newline
19635 \begin_inset Flex Code
19638 \begin_layout Plain Layout
19646 (Ask if changes are detected.)
19647 \begin_inset Newline newline
19651 \begin_inset Flex Code
19654 \begin_layout Plain Layout
19655 cd $path; cvs -q update
19665 \begin_layout Standard
19667 \begin_inset Flex Code
19670 \begin_layout Plain Layout
19676 stands for the path to the document.
19679 \begin_layout Subsubsection
19685 \begin_layout Standard
19686 This shows the complete history of the CVS document.
19689 cvs log "<file-name>"
19691 is shown in a browser.
19694 \begin_layout Subsection
19695 SVN commands in LyX
19698 \begin_layout Standard
19699 SVN is now partially supported by LyX.
19700 You can find the commands in the
19702 File\SpecialChar \menuseparator
19704 \begin_inset space ~
19710 Please note that if you use password protected access to repository via
19711 ssh, you will be asked in terminal window.
19712 LyX was tested against SVN 1.5 and 1.6
19716 \begin_layout Plain Layout
19717 Most of the commands will work with 1.4 too, see
19718 \begin_inset CommandInset ref
19720 reference "sub:SVN-Repo-Update"
19732 \begin_layout Subsubsection
19738 \begin_layout Standard
19739 If your document is not under revision control, this is the only item shown
19741 And if it is under revision control, the
19748 item is not visible.
19752 \begin_layout Standard
19753 This command registers in SVN your document ONLY in case you have already
19754 the documents directory under SVN control (in particular
19759 This means you have to checkout the archive by yourself.
19763 \begin_layout Standard
19764 Then you are asked interactively to supply an initial description of the
19766 Don't forget that registered file is not yet commited.
19769 \begin_layout Standard
19770 SVN command that is run:
19773 \begin_inset Quotes eld
19777 \begin_inset Quotes erd
19783 \begin_layout Standard
19788 to understand the switches.
19792 \begin_layout Subsubsection
19798 \begin_layout Standard
19799 When you are finished editing a file, you commit your changes.
19800 When you do this, you are asked for a description of the changes.
19801 After that changes are commited.
19804 \begin_layout Standard
19809 \begin_layout Plain Layout
19810 In case locking is not enabled.
19812 \begin_inset CommandInset ref
19814 reference "subsec:SVN-File-Locking"
19825 svn commit -q -m"<description>" <file-name>
19828 \begin_layout Subsubsection
19834 \begin_layout Standard
19835 Updates the changes of this file from the repository.
19836 Be sure you understand SVN merging and conflicts resolving before using
19837 this function, because all conflicts has to be resolved manually by you!
19840 \begin_layout Standard
19845 \begin_layout Plain Layout
19853 svn update --non-interactive
19854 \begin_inset Quotes eld
19858 \begin_inset Quotes erd
19864 \begin_layout Subsubsection
19867 Revert To Repository Version
19870 \begin_layout Standard
19871 This will discard all changes made to the document since the last check
19873 You get a warning before changes are discarded.
19877 \begin_layout Standard
19881 \begin_inset Quotes eld
19885 \begin_inset Quotes erd
19891 \begin_layout Subsubsection
19892 \begin_inset CommandInset label
19894 name "sub:SVN-Repo-Update"
19898 Update of the local directory checkout from repository
19902 \begin_layout Plain Layout
19903 Note that this command will work only with subversion
19904 \begin_inset Formula $\geqq1.5$
19915 \begin_layout Standard
19916 All the commands above have one shortcomming - they deal with the current
19918 Once your document contains pictures, includes external
19919 \begin_inset Flex Code
19922 \begin_layout Plain Layout
19928 files and so on administration becomes more complicated.
19929 LyX now supports updating the whole tree in which resides the document
19933 \begin_layout Plain Layout
19934 One need to organize the files structure so that all external files are
19935 in the same directory or subdirectories of the document.
19942 This become especially useful once you cooperate with people which neither
19943 know about subversion management nor they have ambition to commit additional
19944 material to the repository.
19948 \begin_layout Standard
19949 \begin_inset Flex Code
19952 \begin_layout Plain Layout
19953 Update local directory from repository
19958 command updates the whole directory and in case of merge conflicts local
19959 version of the files are left, so no unintended data loss occurs.
19960 If local changes are detected user is warned before update starts.
19963 \begin_layout Labeling
19964 \labelwidthstring 00.00.0000
19966 \begin_inset space ~
19970 \begin_inset space ~
19974 \begin_inset Newline newline
19978 \begin_inset Flex Code
19981 \begin_layout Plain Layout
19987 (Ask if changes are detected.)
19988 \begin_inset Newline newline
19992 \begin_inset Flex Code
19995 \begin_layout Plain Layout
19996 svn update --accept mine-full $path
20004 \begin_layout Standard
20006 \begin_inset Flex Code
20009 \begin_layout Plain Layout
20015 stands for the path to the document.
20018 \begin_layout Subsubsection
20024 \begin_layout Standard
20025 This shows the complete history of the SVN document.
20029 \begin_inset Quotes eld
20033 \begin_inset Quotes erd
20038 is shown in a browser.
20041 \begin_layout Subsubsection
20043 \begin_inset CommandInset label
20045 name "subsec:SVN-File-Locking"
20052 \begin_layout Standard
20053 The file exchange through various revision control systems brings the problem
20054 of merge conflicts in case two different users try to edit the same (parts
20056 When such a conflict happens it needs manual resolving and one reasonable
20057 alternative is to provide some kind of locking mechanism, which guarantees
20058 that only one user is allowed to edit file at the given time.
20061 \begin_layout Standard
20062 SVN has two such mechanisms to provide mutual exclusivity for file access
20063 - locks and automatic setting of write permissions (see sec.
20065 \begin_inset CommandInset ref
20067 reference "subsec:Automatical-Locking-Property"
20072 \begin_inset Flex Code
20075 \begin_layout Plain Layout
20085 \begin_layout Plain Layout
20086 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
20092 If this property is detected for a given document LyX starts to use SVN
20093 locks for document editing automatically and the whole check-in/out mechanism
20094 switches to the same regimen as for RCS.
20095 This in particular means there are two different modes of file use in LyX:
20098 \begin_layout Itemize
20100 The loaded file is in the read-only mode.
20101 For editing on needs to check-out.
20106 consists of updating from the repository and gaining write lock.
20107 If the lock is not possible to obtain, we remain in unlocked state.
20110 \begin_layout Itemize
20112 The loaded file is in the 'normal' edit mode.
20113 No other user is allowed to edit the file.
20118 consists of commiting changes and releasing write-lock.
20119 If no changes have been made to the document, no commit will be produced
20123 \begin_layout Plain Layout
20124 Don't be puzzled by the fact that you will be asked for commit message anyway.
20129 and only the write-lock will be released.
20132 \begin_layout Standard
20136 \begin_layout Labeling
20137 \labelwidthstring 00.00.0000
20140 svn commit -q -m"<description>" "<file-name>"
20141 \begin_inset Newline newline
20144 svn unlock "<file-name>"
20147 \begin_layout Labeling
20148 \labelwidthstring 00.00.0000
20151 svn update "<file-name>"
20152 \begin_inset Newline newline
20155 svn lock "<file-name>"
20158 \begin_layout Subsubsection
20161 \begin_inset CommandInset label
20163 name "subsec:Automatical-Locking-Property"
20169 Automatic Locking Property
20172 \begin_layout Standard
20173 The above mentioned automatic setting of write permissions of the .lyx file
20179 ile\SpecialChar \menuseparator
20185 \begin_inset space ~
20188 Control\SpecialChar \menuseparator
20193 oggle locking property
20196 This command is active only when the file is not locked on the svn server
20198 you need to check-out before proceeding).
20201 \begin_layout Labeling
20202 \labelwidthstring 00.00.0000
20204 \begin_inset space ~
20210 \begin_layout Labeling
20211 \labelwidthstring 00.00.0000
20214 svn propset svn:needs-lock ON "<file-name>"
20217 \begin_layout Labeling
20218 \labelwidthstring 00.00.0000
20221 svn propdel svn:needs-lock "<file-name>"
20224 \begin_layout Subsubsection
20225 \begin_inset CommandInset label
20227 name "sub:VCS-Revision-Information"
20231 Revision Information in Documents
20234 \begin_layout Standard
20235 There are more possibilities how to activate revision information in our
20239 \begin_layout Itemize
20240 LyX supports directly:
20244 \begin_layout Itemize
20245 tree revision information (
20246 \begin_inset Flex Code
20249 \begin_layout Plain Layout
20256 The result is the output of the
20257 \begin_inset Flex Code
20260 \begin_layout Plain Layout
20266 command, the following table gives you an idea, how to read the results.
20269 \begin_layout Standard
20271 \begin_inset Tabular
20272 <lyxtabular version="3" rows="6" columns="2">
20273 <features rotate="0" tabularvalignment="middle">
20274 <column alignment="center" valignment="top" width="0">
20275 <column alignment="center" valignment="top" width="0">
20277 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
20280 \begin_layout Plain Layout
20286 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
20289 \begin_layout Plain Layout
20297 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20300 \begin_layout Plain Layout
20306 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20309 \begin_layout Plain Layout
20310 mixed revision working copy
20317 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20320 \begin_layout Plain Layout
20326 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20329 \begin_layout Plain Layout
20330 modified working copy
20337 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20340 \begin_layout Plain Layout
20346 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20349 \begin_layout Plain Layout
20350 switched working copy
20357 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20360 \begin_layout Plain Layout
20366 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20369 \begin_layout Plain Layout
20370 partial working copy, from a sparse checkout
20377 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
20380 \begin_layout Plain Layout
20386 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
20389 \begin_layout Plain Layout
20390 mixed revision, modified, switched working copy
20403 \begin_layout Itemize
20404 file revision information.
20405 The result comes from parsing the output of
20406 \begin_inset Flex Code
20409 \begin_layout Plain Layout
20411 \begin_inset space ~
20415 \begin_inset space ~
20419 \begin_inset space ~
20428 Supported flags are:
20432 \begin_layout Itemize
20433 version number of the last commit (
20434 \begin_inset Flex Code
20437 \begin_layout Plain Layout
20446 \begin_layout Itemize
20447 author of the last commit (
20448 \begin_inset Flex Code
20451 \begin_layout Plain Layout
20460 \begin_layout Itemize
20461 date of the last commit (
20462 \begin_inset Flex Code
20465 \begin_layout Plain Layout
20474 \begin_layout Itemize
20475 time of the last commit (
20476 \begin_inset Flex Code
20479 \begin_layout Plain Layout
20489 \begin_layout Standard
20490 You can obtain this info via InsetInfo (e.g.
20492 \begin_inset Flex Code
20495 \begin_layout Plain Layout
20496 info-insert buffer vcs-date
20502 The information will be available only when you have the file stored under
20503 svn managment (i.e.
20505 \begin_inset Flex Code
20508 \begin_layout Plain Layout
20514 directory is available with your document).
20518 \begin_layout Itemize
20519 Another---a hacking one---possibility is to use svn keywords
20523 \begin_layout Plain Layout
20524 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
20530 In short -- you set file keywords property (e.g.
20533 svn propset svn:keywords 'Rev' file.lyx
20535 ) and then paste keyword TeX code
20539 \begin_layout Plain Layout
20540 This is an easy way how to ensure that LyX won't break the line in the middle
20546 tag in your document (e.g.
20551 \begin_layout Plain Layout
20559 This way svn client will automatically substitute revision number (e.g.
20564 \begin_layout Plain Layout
20571 ) after each update and commit.
20572 There are more problems with this approach.
20573 Firstly, the '$' character is used in TeX world for math equations, so
20574 any occurence of math formula
20575 \begin_inset Formula $Rev$
20579 \begin_inset Formula $Rev:59$
20582 in your LyX document.
20583 Similarly for other keywords like Id, Date, Author, etc.
20584 Secondly svn output is dependent on your locales, so its very easy that
20585 svn would produce some problematic strings once Date is used.
20586 Thirdly you get the whole 'Rev: 59' string in your document instead of
20588 Until subversion implements user's custom keywords it will be hard to use
20589 this approach reliably or let LyX to support it directly.
20592 \begin_layout Subsection
20593 SVN and Windows Environment
20596 \begin_layout Quote
20597 My inclination is to say that if the user cannot figure out the command
20598 line operations on their own fairly quickly, they would be well advised
20599 to use TortoiseSVN.
20605 \begin_layout Subsubsection
20609 \begin_layout Standard
20610 In addition to installing LyX, and having access to a Subversion repository,
20611 the user will need to install the Subversion client program.
20612 A Windows installer for the client program is available from
20613 \begin_inset CommandInset href
20616 target "http://www.collab.net/nonav/downloads/subversion/"
20621 The user may also want to install
20622 \begin_inset CommandInset href
20625 target "http://tortoisesvn.tigris.org/"
20629 , which integrates Subversion operations into the context (rightclick) menu
20630 of Windows Explorer.
20631 Operations done outside LyX will typically be more convenient using the
20632 Explorer context menu.
20633 Note that TortoiseSVN is not a replacement for the client program, which
20634 is what LyX itself will use.
20637 \begin_layout Subsubsection
20638 Bringing a document under Subversion control
20641 \begin_layout Standard
20642 Before a LyX document can be brought under version control in Subversion,
20643 its parent directory needs to be under version control.
20644 If the document is being added to a project already in the repository,
20645 this is accomplished by checking the project out to the directory where
20646 the new document will be placed.
20647 If the project itself is not yet under version control (for instance, if
20648 this document starts a new project), the directory must be imported into
20650 This is done outside LyX.
20651 Both import and checkout are easily accomplished from the Explorer context
20652 menu using TortoiseSVN, or alternatively can be done using the command
20653 line client at a DOS prompt.
20654 The procedure for importing the project using TortoiseSVN is described
20655 below, assuming an existing repository and a new project being started
20663 For information on using the Subversion client program, run
20670 \begin_layout Enumerate
20677 in Windows Explorer, right click it, and select
20679 TortoiseSVN > Repo-browser
20682 If necessary, adjust the URL for the repository, then click OK.
20685 \begin_layout Enumerate
20686 Right click the level of the repository under which you want to place the
20687 new project folder (typically the top level) and click
20689 Create folder\SpecialChar \ldots{}
20692 Supply a name for the project folder and click OK.
20693 Add a message for the log file if desired, then click OK again.
20694 The new project folder should appear in the repository.
20695 Finally, click OK again to exit the repository browser.
20698 \begin_layout Enumerate
20699 Once again right click
20705 , this time selecting SVN Checkout\SpecialChar \ldots{}
20706 Select the URL of the project folder
20707 you just created in the repository, and set the checkout directory to
20715 You will be warned about a non-empty folder; click OK to proceed.
20716 You should now have a
20727 \begin_layout Enumerate
20728 Create or open your document in LyX and click
20733 ile\SpecialChar \menuseparator
20739 \begin_inset space ~
20742 Control\SpecialChar \menuseparator
20750 Add a log message and click OK to commit the document to version control.
20753 \begin_layout Standard
20754 From this point onward, you should have full functionality in the
20759 ile\SpecialChar \menuseparator
20765 \begin_inset space ~
20771 You also have the option of checking the document in and out, viewing its
20773 using the TortoiseSVN context menu in Windows Explorer or the Subversion
20774 client program from a command prompt.
20777 \begin_layout Subsubsection
20778 SSH tunnel used with SVN under Windows
20781 \begin_layout Standard
20782 Compared with Linux setting up an svn client to communicate over ssh under
20783 Windows is a rather troublesome task.
20784 We will at least offer some hints how to setup the client side but prior
20785 knowledge about ssh and the Windows command line is needed, also be prepared
20786 for a great deal of frustration\SpecialChar \ldots{}
20790 \begin_layout Enumerate
20791 Get an svn client for windows, as described in the previous sections.
20792 When it is a fresh install run some svn command (e.g.
20794 \begin_inset Flex Code
20797 \begin_layout Plain Layout
20803 ) to create config files, which you will need to change later on.
20806 \begin_layout Enumerate
20807 Choose an ssh client for Windows.
20808 There are several possibilities, we will use the one from Putty tools
20812 \begin_layout Plain Layout
20813 \begin_inset Flex URL
20816 \begin_layout Plain Layout
20818 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
20829 You will need to set the connection up so that the client doesn't ask for
20830 any password from you.
20831 To keep things easy we will use only keys without any additional password
20836 \begin_layout Enumerate
20838 \begin_inset Flex Code
20841 \begin_layout Plain Layout
20848 Save your private .ppk key file and put the public one on the server side.
20849 If the SVN server runs on Linux, note that the format of the public key
20850 is not compatible with Linux openssh and you will need to direcly copy-paste
20853 Public key for pasting into OpenSSH authorized_keys file
20855 :” edit field into the server's
20856 \begin_inset Flex Code
20859 \begin_layout Plain Layout
20860 ~/.ssh/authorized_keys
20866 \begin_inset Flex Code
20869 \begin_layout Plain Layout
20878 \begin_layout Enumerate
20880 \begin_inset Flex Code
20883 \begin_layout Plain Layout
20890 In the SVN config file
20894 \begin_layout Plain Layout
20895 Exact path depends on Windows version, usually somewhere around
20896 \begin_inset Flex Code
20899 \begin_layout Plain Layout
20902 Documents and Settings
20916 \begin_inset Flex Code
20919 \begin_layout Plain Layout
20934 , section [tunnels], setup ssh command, e.g.
20936 \begin_inset Flex Code
20939 \begin_layout Plain Layout
20940 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
20949 \begin_layout Plain Layout
20950 It will usually take a lot of time to get exact command right and it depends
20952 For example do not have some remote server saved as a default session in
20954 If things fail, try to connect via plink without SVN first.
20963 \begin_layout Enumerate
20964 Checkout the SVN archive, e.g.
20966 \begin_inset Flex Code
20969 \begin_layout Plain Layout
20970 svn co svn+ssh://user@server/repository_path
20978 \begin_layout Subsubsection
20979 End-of-Line Conversions
20982 \begin_layout Standard
20983 When the collaborators are mixing Linux and Windows environments, LyX will
20984 use different line endings inside the .lyx files.
20985 This is not a problem as far as LyX functionality is concerned, but the
20986 commit diffs will be huge and merge-conflicts prone.
20987 Fortunately SVN itself knows
20991 \begin_layout Plain Layout
20992 \begin_inset Flex URL
20995 \begin_layout Plain Layout
20997 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
21007 how to deal with CR/LF problems when switching .lyx files to the
21008 \begin_inset Flex Code
21011 \begin_layout Plain Layout
21021 \begin_layout Plain Layout
21023 \begin_inset Flex Code
21026 \begin_layout Plain Layout
21027 svn propset svn:eol-style native FILE_NAME
21040 \begin_layout Subsection
21044 \begin_layout Standard
21045 With the recent addition of the vc-command function LyX power users are
21046 allowed to create their own commands for revision control.
21049 \begin_layout Standard
21050 As an example you can see how two TortoiseSVN commands could be integrated
21054 \begin_layout Description
21056 \begin_inset Flex Code
21059 \begin_layout Plain Layout
21060 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
21068 \begin_layout Description
21070 \begin_inset Flex Code
21073 \begin_layout Plain Layout
21074 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
21082 \begin_layout Subsection
21083 Version control and Document comparison
21086 \begin_layout Standard
21087 One of the typical uses of version control is to inspect the changes between
21088 revisions, usually by creating
21089 \begin_inset Flex Code
21092 \begin_layout Plain Layout
21099 While this is useful for plain text files, it is much less useful in the
21100 case of LyX files, which have more a complicated structure.
21101 Hence we provide binding to the Document comparison feature.
21102 There are two ways of calling this feature - either by direct call of
21103 \begin_inset Flex Code
21106 \begin_layout Plain Layout
21112 LyX function (for details see LyX functions manual) or by icon/menu item
21114 \begin_inset Flex MenuItem
21117 \begin_layout Plain Layout
21118 Compare with older revision...
21124 One can either compare two chosen revisions of the document or he can simply
21125 compare the current version of edited text with older revisions (where
21127 \begin_inset Flex MenuItem
21130 \begin_layout Plain Layout
21136 ' revisions back means comparison of the edited file with last commited
21141 \begin_layout Standard
21142 This feature is supported for SVN and RCS though due to the more complicated
21143 versioning scheme of RCS there is a constraint -- when addressing the revisions
21144 in dialog, numbers always point to the last number in RCS revision number,
21149 \begin_layout Section
21150 Literate Programming
21153 \begin_layout Standard
21158 (kayvan@sylvan.com)
21162 original documentation written by
21164 Edmar Wienskoski Jr.
21167 (edmar-w-jr@technologist.com)
21170 \begin_layout Subsection
21174 \begin_layout Standard
21175 The main purpose of this documentation is to show you how to use LyX for
21176 literate programming, where it is assumed that you are familiar with this
21177 programming technique, and know what
21178 \begin_inset Quotes eld
21182 \begin_inset Quotes erd
21186 \begin_inset Quotes eld
21190 \begin_inset Quotes erd
21194 If that is not the case, please follow the web links provided in the following
21196 There is a lot of good documentation out there covering old development
21197 history to the latest tools tips.
21200 \begin_layout Standard
21201 It is also assumed that you are familiar with LyX itself to a point that
21202 you are comfortable changing your LyX preferences, and X resources file.
21203 If that is not the case please refer to other LyX documentation to cover
21204 your specific needs.
21207 \begin_layout Subsection
21208 Literate Programming
21211 \begin_layout Standard
21212 From the Literate Programming FAQ:
21215 \begin_layout Quotation
21216 Literate programming is the combination of documentation and source together
21217 in a fashion suited for reading by human beings.
21218 In fact, literate programs should be enjoyable reading, even inviting!
21219 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
21220 and documentation in a single file.
21221 Literate programming tools then parse the file to produce either readable
21222 documentation or compilable source.
21223 The WEB style of literate programming was created by D.
21224 \begin_inset space \thinspace{}
21228 Knuth during the development of his TeX typesetting software.
21232 \begin_layout Standard
21233 Another excerpt says:
21236 \begin_layout Quotation
21239 How is literate programming different from verbose commenting?
21242 \begin_layout Quotation
21243 There are three distinguishing characteristics.
21244 In order of importance, they are:
21248 \begin_layout Itemize
21249 flexible order of elaboration
21252 \begin_layout Itemize
21253 automatic support for browsing
21256 \begin_layout Itemize
21257 typeset documentation, especially diagrams and mathematics
21261 \begin_layout Standard
21262 Now that I sparked your curiosity, take a look in the references.
21265 \begin_layout Subsubsection
21269 \begin_layout Standard
21270 The complete Literate Programming FAQ can be found at:
21273 \begin_layout Quote
21274 Literate Programming FAQ
21275 \begin_inset Flex URL
21278 \begin_layout Plain Layout
21280 http://www.literateprogramming.com/lpfaq.pdf
21288 \begin_layout Standard
21289 The FAQ lists 23 (twenty three!) different literate programming tools.
21290 Where some are specialized or
21291 \begin_inset Quotes eld
21295 \begin_inset Quotes erd
21298 for particular programming languages, while other have general scope.
21303 for my own use for several reasons:
21306 \begin_layout Itemize
21307 It can generate the documentation either in LaTeX or HTML.
21310 \begin_layout Itemize
21311 It has a open architecture, i.
21312 \begin_inset space \thinspace{}
21316 \begin_inset space \space{}
21319 it is easy to plug in new filters and to perform special processing that
21324 \begin_layout Itemize
21325 There is a good selection of filters available already (the HTML is one
21329 \begin_layout Itemize
21333 \begin_layout Standard
21334 The Noweb web page can be found at:
21337 \begin_layout Quote
21339 \begin_inset Flex URL
21342 \begin_layout Plain Layout
21344 http://www.cs.virginia.edu/~nr/noweb/
21352 \begin_layout Standard
21353 Starting from there you can reach many other interesting links and even
21354 some literate program examples.
21357 \begin_layout Subsection
21358 LyX and Literate Programming
21361 \begin_layout Standard
21362 The LyX support for Literate Programming is provided by using the generic
21363 LyX converters mechanism.
21364 This support is provided in a
21365 \begin_inset Quotes eld
21369 \begin_inset Quotes erd
21373 \begin_inset space \thinspace{}
21377 \begin_inset space \space{}
21380 you will be able to use this new LyX feature with some other literate programmin
21381 g tool of your choice by just changing your LyX preferences.
21384 \begin_layout Subsubsection
21385 Generating documents and code (weaving and tangling)
21388 \begin_layout Paragraph
21389 Selecting the document class
21392 \begin_layout Standard
21393 If you have installed Noweb and LyX successfully, whenever you open a new
21394 document or try to change the document class of an existing one, you will
21395 find that there are three new document classes available:
21398 \begin_layout Itemize
21402 \begin_layout Itemize
21406 \begin_layout Itemize
21410 \begin_layout Standard
21411 You must select one of them to create your literate documents from.
21415 \begin_layout Standard
21416 Note that literate documents are not limited to these three classes.
21417 New classes can be generated from other styles like letter or in combination
21418 with other class variations like Article (AMS).
21419 If you have special needs that cannot be covered by one of the existing
21420 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
21421 will arrange to insert a new entry, or teach you how to do it.
21425 \begin_layout Plain Layout
21426 It is very simple, it involves the creation of a file with four lines, and
21427 re-running of the auto configuration.
21432 Moreover, if you use a literate tool other than Noweb you may need to create
21433 a new set of document classes for it.
21436 \begin_layout Paragraph
21440 \begin_layout Standard
21441 LyX enables you to write code with a layout named
21449 \begin_layout Plain Layout
21450 The equivalent Noweb term is
21451 \begin_inset Quotes eld
21455 \begin_inset Quotes erd
21459 For historical reasons, I got used to the term
21460 \begin_inset Quotes eld
21464 \begin_inset Quotes erd
21467 introduced by other literate tool named Nuweb, which I used for many years
21468 before rendering myself to Noweb.
21473 Noweb delimits scraps like this:
21476 \begin_layout LyX-Code
21480 \begin_layout LyX-Code
21484 \begin_layout LyX-Code
21488 \begin_layout LyX-Code
21492 \begin_layout LyX-Code
21496 \begin_layout Standard
21497 The problem is that whatever is written in between the << and the
21501 must be taken literally, i.
21502 \begin_inset space \thinspace{}
21506 \begin_inset space \space{}
21509 LyX should be prevented from making any special interpretation of what has
21511 This is handled by a special layout named Scrap, that works like a normal
21512 paragraph but has a free spacing capability.
21515 \begin_layout Standard
21516 The down side of the Scrap paragraph layout is that consecutive paragraphs
21517 of code will be spaced with one empty line in the source code and also
21518 in the printed documentation.
21519 The work around is to enter each line of code within a single Scrap, with
21520 a newline (ctrl-return).
21521 The example above will look like this:
21525 \begin_layout Plain Layout
21526 If you have a printed version of this document you will not see any difference
21527 between the previous example and this one.
21535 \begin_layout LyX-Code
21537 \begin_inset Newline newline
21541 \begin_inset Newline newline
21545 \begin_inset Newline newline
21549 \begin_inset Newline newline
21555 \begin_layout Standard
21556 This layout works fine.
21557 The only real inconvenience is that you have to type ctrl-return instead
21562 \begin_layout Plain Layout
21563 It is in my list of
21564 \begin_inset Quotes eld
21568 \begin_inset Quotes erd
21579 \begin_layout Standard
21580 As a special note, you can also use the
21581 \begin_inset Quotes eld
21585 \begin_inset Quotes erd
21588 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
21592 \begin_layout LyX-Code
21594 \begin_inset Newline newline
21597 def some_function(args):
21598 \begin_inset Newline newline
21601 "This is the doc string for this function."
21602 \begin_inset Newline newline
21605 print "My args: ", args
21608 \begin_layout LyX-Code
21609 @ %def some_function
21612 \begin_layout Standard
21613 For an example of this usage and the resulting cross-reference output, look
21614 at the Literate python program in
21616 LIBDIR/examples/listerrors.lyx
21618 which should make this all clear.
21621 \begin_layout Paragraph
21622 Generating the documentation
21625 \begin_layout Standard
21626 At this point you already have a new document file with a proper document
21627 class, and with some code and text on it.
21628 How do I print it? The answer is simple, you select
21630 View\SpecialChar \menuseparator
21634 Just like you would do for a plain document.
21635 No special procedure is required.
21638 \begin_layout Standard
21639 To help orientate you, I will now explain what happens inside LyX:
21642 \begin_layout Enumerate
21645 Update\SpecialChar \menuseparator
21648 menu option is chosen, a LaTeX file is generated.
21653 \begin_layout Standard
21654 If the document is of any literate class the generated file will be named
21655 with an extension name defined by the
21656 \begin_inset Quotes eld
21660 \begin_inset Quotes erd
21663 format (defined in the Preferences panel), otherwise the file will have
21672 \begin_layout Enumerate
21673 Note that the only difference so far is in the name of the file, no special
21674 processing is required by LyX.
21675 Given that you formatted the code using the Scrap layout that, by itself,
21676 takes care of the business.
21679 \begin_layout Enumerate
21680 If the document is of any literate class LyX will then use the internal
21681 LyX to Noweb converter, followed by the Noweb to LaTeX converter
21685 \begin_layout Plain Layout
21686 The converters are defined in the
21688 Tools\SpecialChar \menuseparator
21692 \begin_inset Quotes eld
21696 \begin_inset Quotes erd
21708 manual for general information about converters.
21713 to generate the LaTeX file.
21717 \begin_layout Standard
21718 Otherwise it will just skip this step.
21722 \begin_layout Enumerate
21723 Finally, LaTeX is invoked and the regular post processing continues as in
21727 \begin_layout Standard
21728 Independence from a particular
21729 \begin_inset Quotes eld
21733 \begin_inset Quotes erd
21736 is easily achieved by changing the commands that are run by the various
21740 \begin_layout Paragraph
21741 Generating the code
21744 \begin_layout Standard
21745 When the build menu option is chosen or the corresponding button in the
21746 toolbar is pressed, a LaTeX file is generated just like step 1 above.
21747 Next, LyX invokes the
21752 This converter needs to be defined by the user and is not installed by
21753 default, though the Program format is.
21754 This converter (like any other converter) will have two parts:
21757 \begin_layout Enumerate
21758 The converter program itself.
21759 This program performs the conversion from the one format to the other (in
21760 this case, from the Noweb format to the Program pseudo-format).
21763 \begin_layout Enumerate
21764 The error log parser.
21765 This is a program whose sole purpose is to rewrite error messages in a
21766 format that LyX understands.
21767 This makes it possible for LyX to place error boxes in the right places
21768 in the file buffer.
21771 \begin_layout Standard
21772 The first part, the
21773 \begin_inset Quotes eld
21777 \begin_inset Quotes erd
21780 setting, should be set to
21781 \begin_inset Quotes eld
21789 \begin_inset Quotes erd
21793 This basically means that LyX will call
21794 \begin_inset Quotes eld
21798 \begin_inset Quotes erd
21801 (a program or script) with the name of the Noweb file (normally a file
21802 in the LyX temp directory).
21806 \begin_layout Standard
21807 This is an implementation of
21808 \begin_inset Quotes eld
21812 \begin_inset Quotes erd
21815 that you can place in a directory on your path:
21818 \begin_layout LyX-Code
21822 \begin_layout LyX-Code
21826 \begin_layout LyX-Code
21827 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
21830 \begin_layout Standard
21831 The next part of the converter setting is the
21832 \begin_inset Quotes eld
21836 \begin_inset Quotes erd
21839 which is to be set to
21840 \begin_inset Quotes eld
21845 parselog=listerrors
21848 \begin_inset Quotes erd
21852 This will run any errors that are generated by the
21853 \begin_inset Quotes eld
21857 \begin_inset Quotes erd
21860 process through the
21861 \begin_inset Quotes eld
21865 \begin_inset Quotes erd
21871 \begin_layout Standard
21872 The converter code looks in
21880 then on the path for the
21881 \begin_inset Quotes eld
21885 \begin_inset Quotes erd
21891 \begin_layout Standard
21892 The build will normally take place in LyX's temporary directory, so the
21893 files produced by the conversion will be in that directory.
21894 LyX will copy out what it regards as the `main' file, but the
21898 conversion may produce several files, and so most of these would then be
21899 deleted when LyX was closed.
21900 The present solution is to use a `copier',
21904 \begin_layout Plain Layout
21913 manual for information on these.
21922 script in its default mode, so that the entire contents of the temporary
21923 directory is copied.
21924 More will get copied than is needed, to be sure, but nothing will be lost.
21925 If, however, you know what extensions the generated files will have, this
21926 can be improved by using the
21935 This option takes a comma-separated list of extensions to copy.
21936 So, for example, if the conversion will generate only files with the extensions
21945 , then the correct definition would be:
21948 \begin_layout LyX-Code
21949 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
21952 \begin_layout Standard
21953 The result will be that only files with these two extensions will be copied
21957 \begin_layout Paragraph
21958 Build instructions in the document
21961 \begin_layout Standard
21962 The last piece of the integration between LyX and noweb is the
21963 \begin_inset Quotes eld
21967 \begin_inset Quotes erd
21971 Generally, the instructions for building your program should be embedded
21972 in a scrap of its own.
21974 \begin_inset Quotes eld
21978 \begin_inset Quotes erd
21981 above uses the notangle command to look for this scrap (called
21982 \begin_inset Quotes eld
21986 \begin_inset Quotes erd
21989 ) and runs its contents through
21990 \begin_inset Quotes eld
21994 \begin_inset Quotes erd
22000 \begin_layout Standard
22001 Typically, such a scrap would look something like this:
22004 \begin_layout LyX-Code
22006 \begin_inset Newline newline
22010 \begin_inset Newline newline
22014 \begin_inset Newline newline
22017 if [ -z "${NOWEB_SOURCE}" ]
22018 \begin_inset Newline newline
22022 \begin_inset Newline newline
22025 NOWEB_SOURCE=myfile.nw
22026 \begin_inset Newline newline
22030 \begin_inset Newline newline
22034 code to extract files ...]
22035 \begin_inset Newline newline
22039 code to compile files ...]
22040 \begin_inset Newline newline
22046 \begin_layout Standard
22049 LIBDIR/examples/listerrors.lyx
22053 LIBDIR/examples/Literate.lyx
22055 which implement two versions of the
22056 \begin_inset Quotes eld
22060 \begin_inset Quotes erd
22063 program for some illustrations of how all of these pieces go together or
22066 LIBDIR/examples/noweb2lyx.lyx.
22069 Interestingly, these three files show off the language-indepence of the
22070 LyX literate programming support since they are written in Python, C and
22074 \begin_layout Subsubsection
22078 \begin_layout Standard
22079 All the Literate Programming support is configured by the
22081 Tools\SpecialChar \menuseparator
22085 \begin_inset Quotes eld
22089 \begin_inset Quotes erd
22093 The important parts are:
22096 \begin_layout Description
22098 \begin_inset space ~
22102 \begin_inset Quotes eld
22106 \begin_inset Quotes erd
22110 \begin_inset space ~
22113 format Set up via the Formats tab, this is where the Noweb-specific pieces
22123 , the file extension is set to
22128 This tells LyX to create a file with a
22132 extension in the first step of the conversion process.
22135 \begin_layout Description
22137 \begin_inset space ~
22145 \begin_inset space ~
22148 format This is an empty format whose sole purpose is to be the endpoint
22149 of a conversion (which then allows us to set up a converter for it).
22152 \begin_layout Description
22161 This converter performs the
22162 \begin_inset Quotes eld
22166 \begin_inset Quotes erd
22169 of the literate document.
22170 For Noweb, it is set to
22171 \begin_inset Quotes eld
22176 noweave -delay -index $$i > $$o
22179 \begin_inset Quotes erd
22185 \begin_layout Description
22195 \begin_inset Quotes eld
22199 \begin_inset Quotes erd
22203 As stated above, the Converter is set to
22204 \begin_inset Quotes eld
22212 \begin_inset Quotes erd
22215 , with Flags set to
22216 \begin_inset Quotes eld
22221 originaldir,parselog=listerrors
22224 \begin_inset Quotes erd
22230 \begin_layout Subsubsection
22234 \begin_layout Standard
22235 There is also a new function implemented in the LyX server, the
22236 \begin_inset Quotes eld
22239 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
22243 \begin_layout Standard
22244 When debugging code with ddd/gdb, it is possible to invoke a text editor
22245 at the current execution position with a single key stroke.
22246 The default ddd configuration for that is shift-ctrl-V.
22247 It happens that you can define the editor command line invocation in ddd
22250 Edit\SpecialChar \menuseparator
22251 Preferences\SpecialChar \menuseparator
22254 dialog and changing the "Edit Sources" entry.
22257 \begin_layout Standard
22258 I take advantage of the new created LyX server function and this ddd feature,
22260 \begin_inset Quotes eld
22264 \begin_inset Quotes erd
22270 \begin_layout LyX-Code
22271 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
22274 \begin_layout Standard
22275 With this, whenever you are using ddd and find a point in the program that
22276 you want to edit, you just press shift-ctrl-V (in the ddd window), and
22277 ddd you forward this information to LyX through the LyX server and then
22278 the LyX window will show the same file with the cursor at the same position
22279 ddd was pointing to.
22280 No more guessing or long scrolling to locate a point in the program back
22284 \begin_layout Standard
22285 Note however that you must enable the LyX server to get this feature working
22286 (it is disabled by default).
22287 You can enable it in
22299 ) by entering in the
22304 \begin_inset Quotes eld
22309 /home/<your-home-directory>/.lyx/lyxpipe
22312 \begin_inset Quotes erd
22318 \begin_layout Standard
22319 Read the LyX server documentation in the
22321 Customization Manual
22323 for further information.
22326 \begin_layout Subsubsection
22330 \begin_layout Standard
22331 There are six new buttons that can be added to your LyX toolbar.
22332 Five of these buttons are short cuts to layout styles:
22353 The last one is a short cut to the
22354 \begin_inset Quotes eld
22358 \begin_inset Quotes erd
22365 \begin_layout Standard
22366 LyX has a range of buttons that are available for tool bar customization.
22367 In my toolbar I like to combine the six short cuts above with two more:
22372 \SpecialChar \menuseparator
22377 \SpecialChar \menuseparator
22384 View\SpecialChar \menuseparator
22388 Here is how it looks like:
22391 \begin_layout LyX-Code
22395 \begin_layout LyX-Code
22399 \begin_layout LyX-Code
22400 Icon "layout Standard"
22403 \begin_layout LyX-Code
22404 Icon "layout Section"
22407 \begin_layout LyX-Code
22408 Icon "layout LaTeX"
22411 \begin_layout LyX-Code
22412 Icon "layout LyX-Code"
22415 \begin_layout LyX-Code
22416 Icon "layout Scrap"
22419 \begin_layout LyX-Code
22423 \begin_layout LyX-Code
22427 \begin_layout LyX-Code
22428 Icon "buffer-typeset"
22431 \begin_layout LyX-Code
22432 Icon "build-program"
22435 \begin_layout LyX-Code
22439 \begin_layout LyX-Code
22443 \begin_layout LyX-Code
22447 \begin_layout LyX-Code
22451 \begin_layout LyX-Code
22455 \begin_layout Subsubsection
22456 Colors customization
22459 \begin_layout Standard
22460 There are a number of colors in LyX that can be customized in
22465 One of the things that bothers people is the LaTeX font color.
22466 The default color is red, since the scraps uses LaTeX font, and there is
22467 a lot of scraps in literate documents, you may get tired of seeing everything
22469 You can change it by going to the tabs
22478 \begin_layout Standard
22479 The next thing is the visible presence of the newline character in the screen.
22480 You can choose the color of this particular character and make it blend
22482 I recommend you choosing a color that is close to the background but not
22483 equal, that way you still can see it is there, but it is not bothering
22488 \begin_layout Chapter
22492 \begin_layout Standard
22493 You can do everything with LyX that you can do with LaTeX.
22494 However, LyX cannot support every LaTeX feature directly.
22495 But you can always use TeX Code.
22496 This chapter shows you some more special things you might want to use.
22497 For other special things you can do with figures, tables, floats, boxes
22498 and notes, have a look at the
22501 \begin_inset space ~
22509 \begin_layout Section
22510 Multiple Text Columns
22513 \begin_layout Standard
22514 This feature is independent of the option
22516 Two-column document
22518 in the document settings under
22523 If you want to have 2
22524 \begin_inset space ~
22527 columns for the whole document, it is recommended to use the
22529 Two-column document
22532 For all other cases use this feature.
22535 \begin_layout Standard
22536 To use multiple text columns in your document, you have to load the module
22543 Document\SpecialChar \menuseparator
22544 Settings\SpecialChar \menuseparator
22547 ) and must have the LaTeX-package
22552 \begin_inset Index idx
22555 \begin_layout Plain Layout
22556 LaTeX-packages ! multicol
22564 \begin_layout Standard
22565 Footnotes within multiple columns will be placed at the bottom of the page
22566 and not under each column.
22567 Within the different columns you can use everything, with the limitation
22568 that for floats you need to use the float option
22575 \begin_layout Subsection
22579 \begin_layout Standard
22580 If you want to have 2
22581 \begin_inset space ~
22584 columns in your text, use the style
22586 Begin Multiple Columns
22588 where the columns should start.
22589 The content of the style is the number of the columns, so in this case
22591 \begin_inset Quotes eld
22595 \begin_inset Quotes erd
22599 At the point where the columns should end use the style
22601 End Multiple Columns
22606 \begin_layout Standard
22607 Here is an example:
22610 \begin_layout Begin Multiple Columns
22614 \begin_layout Standard
22619 The Adventure of the Empty House
22622 \begin_inset Newline newline
22627 Sir Arthur Conan Doyle
22630 \begin_layout Standard
22633 It was in the spring of the year 1894 that all London was interested, and
22634 the fashionable world dismayed, by the murder of the Honourable Ronald
22635 Adair under most unusual and inexplicable circumstances.
22636 The public has already learned those particulars of the crime which came
22637 out in the police investigation, but a good deal was suppressed upon that
22638 occasion, since the case for the prosecution was so overwhelmingly strong
22639 that it was not necessary to bring forward all the facts.
22640 Only now, at the end of nearly ten years, am I allowed to supply those
22641 missing links which make up the whole of that remarkable chain.
22642 The crime was of interest in itself, but that interest was as nothing to
22643 me compared to the inconceivable sequel, which afforded me the greatest
22644 shock and surprise of any event in my adventurous life.
22645 Even now, after this long interval, I find myself thrilling as I think
22646 of it, and feeling once more that sudden flood of joy, amazement, and increduli
22647 ty which utterly submerged my mind.
22648 Let me say to that public, which has shown some interest in those glimpses
22649 which I have occasionally given them of the thoughts and actions of a very
22650 remarkable man, that they are not to blame me if I have not shared my knowledge
22651 with them, for I should have considered it my first duty to do so, had
22652 I not been barred by a positive prohibition from his own lips, which was
22653 only withdrawn upon the third of last month.
22656 \begin_layout End Multiple Columns
22660 \begin_layout Standard
22661 Here is an example with 3
22662 \begin_inset space ~
22668 \begin_layout Begin Multiple Columns
22672 \begin_layout Standard
22675 It can be imagined that my close intimacy with Sherlock Holmes had interested
22676 me deeply in crime, and that after his disappearance I never failed to
22677 read with care the various problems which came before the public.
22678 And I even attempted, more than once, for my own private satisfaction,
22679 to employ his methods in their solution, though with indifferent success.
22680 There was none, however, which appealed to me like this tragedy of Ronald
22682 As I read the evidence at the inquest, which led up to a verdict of willful
22683 murder against some person or persons unknown, I realized more clearly
22684 than I had ever done the loss which the community had sustained by the
22685 death of Sherlock Holmes.
22686 There were points about this strange business which would, I was sure,
22687 have specially appealed to him, and the efforts of the police would have
22688 been supplemented, or more probably anticipated, by the trained observation
22689 and the alert mind of the first criminal agent in Europe.
22690 All day, as I drove upon my round, I turned over the case in my mind and
22691 found no explanation which appeared to me to be adequate.
22692 At the risk of telling a twice-told tale, I will recapitulate the facts
22693 as they were known to the public at the conclusion of the inquest.
22696 \begin_layout End Multiple Columns
22700 \begin_layout Standard
22701 You can have up to 10
22702 \begin_inset space ~
22705 columns if you want to, but that might not be very pleasant for the readers
22709 \begin_layout Standard
22710 \begin_inset Newpage newpage
22716 \begin_layout Subsection
22717 Columns inside Columns
22720 \begin_layout Standard
22721 You can also have columns inside columns:
22724 \begin_layout Begin Multiple Columns
22728 \begin_layout Standard
22731 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
22732 at that time governor of one of the Australian colonies.
22733 Adair's mother had returned from Australia to undergo the operation for
22734 cataract, and she, her son Ronald, and her daughter Hilda were living together
22738 \begin_layout Begin Multiple Columns
22742 \begin_layout Standard
22745 The youth moved in the best society–had, so far as was known, no enemies
22746 and no particular vices.
22747 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
22748 had been broken off by mutual consent some months before, and there was
22749 no sign that it had left any very profound feeling behind it.
22750 For the rest {sic} the man's life moved in a narrow and conventional circle,
22751 for his habits were quiet and his nature unemotional.
22752 Yet it was upon this easy-going young aristocrat that death came, in most
22753 strange and unexpected form, between the hours of ten and eleven-twenty
22754 on the night of March 30, 1894.
22757 \begin_layout End Multiple Columns
22761 \begin_layout Standard
22764 Ronald Adair was fond of cards–playing continually, but never for such stakes
22766 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
22767 It was shown that, after dinner on the day of his death, he had played
22768 a rubber of whist at the latter club.
22769 He had also played there in the afternoon.
22774 The evidence of those who had played with him– Mr.
22775 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
22776 and that there was a fairly equal fall of the cards.
22777 Adair might have lost five pounds, but not more.
22778 His fortune was a considerable one, and such a loss could not in any way
22780 He had played nearly every day at one club or other, but he was a cautious
22781 player, and usually rose a winner.
22782 It came out in evidence that, in partnership with Colonel Moran, he had
22783 actually won as much as four hundred and twenty pounds in a sitting, some
22784 weeks before, from Godfrey Milner and Lord Balmoral.
22785 So much for his recent history as it came out at the inquest.
22788 \begin_layout End Multiple Columns
22792 \begin_layout Subsection
22796 \begin_layout Standard
22797 The examples in this section show some more special features of multiple
22801 \begin_layout Standard
22802 For more features of multiple columns, have a look at the documentation
22803 of the LaTeX-package
22808 \begin_inset Index idx
22811 \begin_layout Plain Layout
22812 LaTeX-packages ! multicol
22818 \begin_inset CommandInset citation
22827 \begin_layout Subsubsection
22831 \begin_layout Standard
22832 To add a preface text for multiple columns, add the command
22835 \begin_layout Standard
22841 \begin_layout Standard
22842 as TeX Code behind the number of columns in the
22844 Begin Multiple Columns
22847 Behind the command follows the preface text.
22848 At the end of the style use the command
22851 \begin_layout Standard
22857 \begin_layout Standard
22859 An example with some preface text:
22862 \begin_layout Standard
22863 \begin_inset VSpace bigskip
22869 \begin_layout Begin Multiple Columns
22874 \begin_layout Plain Layout
22881 And the story continues and continues and continues and continues\SpecialChar \ldots{}
22886 \begin_layout Plain Layout
22896 \begin_layout Standard
22899 On the evening of the crime, he returned from the club exactly at ten.
22900 His mother and sister were out spending the evening with a relation.
22901 The servant deposed that she heard him enter the front room on the second
22902 floor, generally used as his sitting-room.
22903 She had lit a fire there, and as it smoked she had opened the window.
22904 No sound was heard from the room until eleven-twenty, the hour of the return
22905 of Lady Maynooth and her daughter.
22906 Desiring to say good-night, she attempted to enter her son's room.
22907 The door was locked on the inside, and no answer could be got to their
22908 cries and knocking.
22909 Help was obtained, and the door forced.
22910 The unfortunate young man was found lying near the table.
22911 His head had been horribly mutilated by an expanding revolver bullet, but
22912 no weapon of any sort was to be found in the room.
22915 \begin_layout End Multiple Columns
22919 \begin_layout Standard
22920 You can also use a section heading as the preface if you use a section command
22921 as TeX Code behind the first TeX Code.
22922 For example the command
22925 \begin_layout Standard
22930 subsection{subsection title}
22933 \begin_layout Standard
22934 creates a subsection.
22935 In this example the preface is a subsubsection:
22938 \begin_layout Begin Multiple Columns
22943 \begin_layout Plain Layout
22954 \begin_layout Plain Layout
22963 This is a subsubsection heading as a preface
22967 \begin_layout Plain Layout
22978 \begin_layout Plain Layout
22988 \begin_layout Standard
22991 A minute examination of the circumstances served only to make the case more
22993 In the first place, no reason could be given why the young man should have
22994 fastened the door upon the inside.
22995 There was the possibility that the murderer had done this, and had afterwards
22996 escaped by the window.
22997 The drop was at least twenty feet, however, and a bed of crocuses in full
22999 Neither the flowers nor the earth showed any sign of having been disturbed,
23000 nor were there any marks upon the narrow strip of grass which separated
23001 the house from the road.
23002 Apparently, therefore, it was the young man himself who had fastened the
23004 But how did he come by his death? No one could have climbed up to the window
23005 without leaving traces.
23006 Suppose a man had fired through the window, he would indeed be a remarkable
23007 shot who could with a revolver inflict so deadly a wound.
23008 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
23009 a hundred yards of the house.
23010 No one had heard a shot.
23013 \begin_layout End Multiple Columns
23017 \begin_layout Standard
23018 If there is less vertical space left on the page at the beginning of the
23019 multiple columns than needed for 6
23020 \begin_inset space ~
23023 text lines, a page break will be inserted before the multiple columns.
23024 Depending on the number of lines of the preface text, you might want to
23026 It is determined by inserting the command
23029 \begin_layout Standard
23037 \begin_layout Standard
23038 as TeX Code behind the preface definition but before the final
23047 is hereby the number of text lines.
23048 In this example the space is set to 7
23049 \begin_inset space ~
23055 \begin_layout Begin Multiple Columns
23060 \begin_layout Plain Layout
23071 \begin_layout Plain Layout
23080 This is the sectioning command
23081 \begin_inset Newline newline
23085 \begin_inset Newline newline
23088 with multiple text lines
23092 \begin_layout Plain Layout
23103 \begin_layout Plain Layout
23116 \begin_layout Plain Layout
23126 \begin_layout Standard
23129 On the evening of the crime, he returned from the club exactly at ten.
23130 His mother and sister were out spending the evening with a relation.
23131 The servant deposed that she heard him enter the front room on the second
23132 floor, generally used as his sitting-room.
23133 She had lit a fire there, and as it smoked she had opened the window.
23134 No sound was heard from the room until eleven-twenty, the hour of the return
23135 of Lady Maynooth and her daughter.
23136 Desiring to say good-night, she attempted to enter her son's room.
23137 The door was locked on the inside, and no answer could be got to their
23138 cries and knocking.
23139 Help was obtained, and the door forced.
23140 The unfortunate young man was found lying near the table.
23141 His head had been horribly mutilated by an expanding revolver bullet, but
23142 no weapon of any sort was to be found in the room.
23145 \begin_layout End Multiple Columns
23149 \begin_layout Subsubsection
23153 \begin_layout Standard
23154 The amount of space before and after multiple columns can be changed by
23155 changing the length
23162 For example the command
23165 \begin_layout Standard
23175 \begin_layout Standard
23176 in TeX Code changes its value to 3
23177 \begin_inset space \thinspace{}
23181 The change must be made before the multiple columns' start.
23182 The predefined value is 13
23183 \begin_inset space \thinspace{}
23189 \begin_layout Standard
23197 \begin_inset space \thinspace{}
23203 \begin_layout Standard
23207 \begin_layout Plain Layout
23213 multicolsep}{2.5cm}
23221 \begin_layout Begin Multiple Columns
23225 \begin_layout Standard
23228 All day I turned these facts over in my mind, endeavouring to hit upon some
23229 theory which could reconcile them all, and to find that line of least resistanc
23230 e which my poor friend had declared to be the starting-point of every investigat
23232 I confess that I made little progress.
23233 In the evening I strolled across the Park, and found myself about six o'clock
23234 at the Oxford Street end of Park Lane.
23235 A group of loafers upon the pavements, all staring up at a particular window,
23236 directed me to the house which I had come to see.
23237 A tall, thin man with coloured glasses, whom I strongly suspected of being
23238 a plain-clothes detective, was pointing out some theory of his own, while
23239 the others crowded round to listen to what he said.
23240 I got as near him as I could, but his observations seemed to me to be absurd,
23241 so I withdrew again in some disgust.
23242 As I did so I struck against an elderly, deformed man, who had been behind
23243 me, and I knocked down several books which he was carrying.
23246 \begin_layout End Multiple Columns
23250 \begin_layout Standard
23251 \begin_inset Note Greyedout
23254 \begin_layout Plain Layout
23259 The values you set with
23265 will be used for all following multiple columns until you change them again.
23273 \begin_layout Standard
23277 \begin_layout Plain Layout
23289 \begin_inset Note Note
23292 \begin_layout Plain Layout
23293 go back to the default
23301 \begin_layout Standard
23302 \begin_inset Newpage newpage
23308 \begin_layout Subsubsection
23312 \begin_layout Standard
23313 The width of the columns is automatically calculated, but you can modify
23314 the space between the columns.
23315 This is done by changing the length
23322 Its predefined value is 10
23323 \begin_inset space \thinspace{}
23327 Here is an example where
23334 \begin_inset space \thinspace{}
23340 \begin_layout Standard
23344 \begin_layout Plain Layout
23358 \begin_layout Begin Multiple Columns
23362 \begin_layout Standard
23365 My observations of No.
23366 \begin_inset space \space{}
23369 427 Park Lane did little to clear up the problem in which I was interested.
23370 The house was separated from the street by a low wall and railing, the
23371 whole not more than five feet high.
23372 It was perfectly easy, therefore, for anyone to get into the garden, but
23373 the window was entirely inaccessible, since there was no water pipe or
23374 anything which could help the most active man to climb it.
23375 More puzzled than ever, I retraced my steps to Kensington.
23376 I had not been in my study five minutes when the maid entered to say that
23377 a person desired to see me.
23378 To my astonishment it was none other than my strange old book collector,
23379 his sharp, wizened face peering out from a frame of white hair, and his
23380 precious volumes, a dozen of them at least, wedged under his right arm.
23383 \begin_layout End Multiple Columns
23387 \begin_layout Standard
23391 \begin_layout Plain Layout
23403 \begin_inset Note Note
23406 \begin_layout Plain Layout
23407 go back to the default
23415 \begin_layout Subsubsection
23419 \begin_layout Standard
23420 Between the columns a rule with a width of the length
23427 If this rule width is set to 0
23428 \begin_inset space \thinspace{}
23431 pt (this is the default), the rule is suppressed.
23432 In the following example the line is 2
23433 \begin_inset space \thinspace{}
23439 \begin_layout Standard
23443 \begin_layout Plain Layout
23449 columnseprule}{2pt}
23457 \begin_layout Begin Multiple Columns
23461 \begin_layout Standard
23464 \begin_inset Quotes eld
23467 You're surprised to see me, sir,
23468 \begin_inset Quotes erd
23471 said he, in a strange, croaking voice.
23474 \begin_layout Standard
23477 I acknowledged that I was.
23480 \begin_layout Standard
23483 \begin_inset Quotes eld
23486 Well, I've a conscience, sir, and when I chanced to see you go into this
23487 house, as I came hobbling after you, I thought to myself, I'll just step
23488 in and see that kind gentleman, and tell him that if I was a bit gruff
23489 in my manner there was not any harm meant, and that I am much obliged to
23490 him for picking up my books.
23491 \begin_inset Quotes erd
23497 \begin_layout Standard
23500 \begin_inset Quotes eld
23503 You make too much of a trifle,
23504 \begin_inset Quotes erd
23509 \begin_inset Quotes eld
23512 May I ask how you knew who I was?
23513 \begin_inset Quotes erd
23519 \begin_layout Standard
23522 \begin_inset Quotes eld
23525 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
23526 you'll find my little bookshop at the corner of Church Street, and very
23527 happy to see you, I am sure.
23528 Maybe you collect yourself, sir.
23532 \begin_inset space ~
23545 --a bargain, every one of them.
23546 With five volumes you could just fill that gap on that second shelf.
23547 It looks untidy, does it not, sir?
23548 \begin_inset Quotes erd
23554 \begin_layout End Multiple Columns
23558 \begin_layout Standard
23562 \begin_layout Plain Layout
23568 columnseprule}{0pt}
23574 \begin_inset Note Note
23577 \begin_layout Plain Layout
23578 go back to the default
23586 \begin_layout Standard
23587 \begin_inset Newpage newpage
23593 \begin_layout Section
23594 Non-standard Paragraph Shapes
23597 \begin_layout Standard
23601 \begin_layout Plain Layout
23613 \begin_layout Standard
23617 \begin_layout Plain Layout
23626 \begin_layout Plain Layout
23640 \begin_layout Standard
23645 \begin_layout Plain Layout
23656 \begin_layout Plain Layout
23665 \begin_layout Plain Layout
23674 \begin_layout Plain Layout
23683 \begin_layout Plain Layout
23692 \begin_layout Plain Layout
23701 \begin_layout Plain Layout
23710 \begin_layout Plain Layout
23719 \begin_layout Plain Layout
23728 \begin_layout Plain Layout
23737 \begin_layout Plain Layout
23746 \begin_layout Plain Layout
23755 \begin_layout Plain Layout
23764 \begin_layout Plain Layout
23773 \begin_layout Plain Layout
23782 \begin_layout Plain Layout
23791 \begin_layout Plain Layout
23800 \begin_layout Plain Layout
23809 \begin_layout Plain Layout
23818 \begin_layout Plain Layout
23824 There are times when the tyranny of rectangular paragraphs must be overthrown.
23825 In such situations, a call to the delightful plain TeX command
23832 As you can see, completely arbitrary shapes can be laid out with a suitable
23833 set of line length definitions.
23834 While this parshape may look a bit silly and useless, one could conceive
23835 of situations such as finely tuned dropped capitals, word wrapping around
23836 non-rectangular graphics, etc.
23837 which will benefit from such handcrafting.
23840 \begin_layout Standard
23841 \begin_inset VSpace bigskip
23847 \begin_layout Standard
23852 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
23859 is the number of lines of text which define the paragraph.
23860 If there turn out to be fewer lines, the shape is truncated; if there are
23861 more, the excess lines have the same dimensions as the last line of the
23871 entries specify the indentation of the line from the left margin, and the
23872 length of the line as measured from that point.
23873 The shape applies only to the current paragraph; everything is reset to
23874 normal for the next paragraph.
23877 \begin_layout Standard
23881 \begin_layout Plain Layout
23893 \begin_layout Bibliography
23894 \begin_inset CommandInset bibitem
23895 LatexCommand bibitem
23900 Documentation of the LaTeX-package
23901 \begin_inset CommandInset href
23904 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
23909 \begin_inset Index idx
23912 \begin_layout Plain Layout
23913 LaTeX-packages ! multicol