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
6491 \begin_inset Flex MenuItem
6494 \begin_layout Plain Layout
6500 preset and enter command
6501 \begin_inset Flex MenuItem
6504 \begin_layout Plain Layout
6505 /Applications/LyX.app/Contents/MacOS/lyxeditor
6513 \begin_layout Standard
6514 Reverse search is triggered by COMMAND-SHIFT-click
6517 \begin_layout Subsubsection*
6521 \begin_layout Standard
6523 \begin_inset Flex MenuItem
6526 \begin_layout Plain Layout
6527 Settings\SpecialChar \menuseparator
6528 Configure Okular\SpecialChar \ldots{}
6529 \SpecialChar \menuseparator
6536 \begin_inset Quotes eld
6540 \begin_inset Quotes erd
6544 \begin_inset Flex Code
6547 \begin_layout Plain Layout
6556 \begin_layout Standard
6557 Reverse search is triggered by SHIFT-click.
6560 \begin_layout Subsubsection*
6564 \begin_layout Standard
6565 Launch yap, choose its
6566 \begin_inset Flex MenuItem
6569 \begin_layout Plain Layout
6570 View\SpecialChar \menuseparator
6577 \begin_inset Quotes eld
6581 \begin_inset Quotes erd
6586 \begin_inset Quotes eld
6589 New\SpecialChar \ldots{}
6591 \begin_inset Quotes erd
6594 button and, in the window that opens, enter
6595 \begin_inset Quotes eld
6599 \begin_inset Quotes erd
6602 (or any other name you like) in the
6603 \begin_inset Quotes eld
6607 \begin_inset Quotes erd
6611 Now click on the button labeled
6612 \begin_inset Quotes eld
6615 \SpecialChar \ldots{}
6617 \begin_inset Quotes erd
6620 to open a file dialog and navigate to the directory containing the batch
6622 \begin_inset Flex Code
6625 \begin_layout Plain Layout
6633 \begin_inset Flex Code
6636 \begin_layout Plain Layout
6642 and then specify the program arguments as
6643 \begin_inset Flex Code
6646 \begin_layout Plain Layout
6654 \begin_inset Flex Code
6657 \begin_layout Plain Layout
6663 wrapper is used for communicating with LyX through the
6670 \begin_layout LyX-Code
6672 \begin_inset Newline newline
6675 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
6684 \begin_inset Newline newline
6698 \begin_layout Standard
6699 Make sure that the LyXServer pipe path you specified in LyX is
6700 \begin_inset Flex Code
6703 \begin_layout Plain Layout
6717 , otherwise change the
6718 \begin_inset Flex Code
6721 \begin_layout Plain Layout
6727 wrapper accordingly.
6730 \begin_layout Standard
6731 In yap, reverse search is triggered by double-click.
6734 \begin_layout Subsubsection*
6735 SumatraPDF (Windows)
6738 \begin_layout Standard
6739 In order to use SumatraPDF for inverse search, enter
6740 \begin_inset Flex Code
6743 \begin_layout Plain Layout
6744 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
6749 in the viewer setting in
6750 \begin_inset Flex MenuItem
6753 \begin_layout Plain Layout
6754 Preferences\SpecialChar \menuseparator
6755 File Handling\SpecialChar \menuseparator
6756 File formats\SpecialChar \menuseparator
6763 \begin_inset Flex Code
6766 \begin_layout Plain Layout
6772 is the previous wrapper.
6773 If SumatraPDF.exe is not in your command PATH, use its full file name.
6776 \begin_layout Standard
6777 Reverse search is triggered by double-click.
6780 \begin_layout Subsubsection*
6784 \begin_layout Standard
6785 First of all, make sure that yap is your default DVI viewer in the Windows
6786 environment, then launch it, choose its
6787 \begin_inset Flex MenuItem
6790 \begin_layout Plain Layout
6791 View\SpecialChar \menuseparator
6798 \begin_inset Quotes eld
6802 \begin_inset Quotes erd
6807 \begin_inset Quotes eld
6810 New\SpecialChar \ldots{}
6812 \begin_inset Quotes erd
6815 button and, in the window that opens, enter
6816 \begin_inset Quotes eld
6820 \begin_inset Quotes erd
6823 (or any other name you like) in the
6824 \begin_inset Quotes eld
6828 \begin_inset Quotes erd
6832 Now click on the button labeled
6833 \begin_inset Quotes eld
6836 \SpecialChar \ldots{}
6838 \begin_inset Quotes erd
6841 to open a file dialog and navigate to the directory containing the
6842 \begin_inset Flex Code
6845 \begin_layout Plain Layout
6851 program (which is installed by default on Cygwin along with the LyX executable).
6853 \begin_inset Flex Code
6856 \begin_layout Plain Layout
6862 and then specify the program arguments as
6863 \begin_inset Flex Code
6866 \begin_layout Plain Layout
6873 In this way, you will be using the
6877 for communicating with LyX.
6878 If, for whatever reason, you want to use the
6883 \begin_inset Flex Code
6886 \begin_layout Plain Layout
6892 option and be sure to specify the LyXServer pipe path in the LyX preferences.
6895 \begin_layout Standard
6896 In yap, reverse search is triggered by double-click.
6899 \begin_layout Subsubsection*
6903 \begin_layout Standard
6904 In order to use SumatraPDF for inverse search, enter
6905 \begin_inset Flex Code
6908 \begin_layout Plain Layout
6909 SumatraPDF -inverse-search "lyxeditor -g %f %l"
6914 in the viewer setting in
6915 \begin_inset Flex MenuItem
6918 \begin_layout Plain Layout
6919 Preferences\SpecialChar \menuseparator
6920 File Handling\SpecialChar \menuseparator
6921 File formats\SpecialChar \menuseparator
6928 If SumatraPDF.exe is not in your command PATH, use its full posix path.
6930 \begin_inset Flex Code
6933 \begin_layout Plain Layout
6939 enables communication via the
6945 \begin_inset Flex Code
6948 \begin_layout Plain Layout
6954 option if you want to use the
6958 , and be sure to specify the LyXServer pipe path in the LyX preferences.
6961 \begin_layout Standard
6962 Reverse search is triggered by double-click.
6965 \begin_layout Section
6969 \begin_layout Standard
6970 Forward search is, as the name implies, in a sense the
6971 \begin_inset Quotes eld
6975 \begin_inset Quotes erd
6979 It allows you to let the viewer jump to a given position from within LyX.
6980 If forward search is set up (as described in what follows), you can put
6981 the cursor anywhere in your LyX document, and hit
6982 \begin_inset Flex MenuItem
6985 \begin_layout Plain Layout
6986 Navigate\SpecialChar \menuseparator
6993 \begin_inset Flex MenuItem
6996 \begin_layout Plain Layout
7002 in the context menu via right mouse click), and then the viewer will jump
7003 to that position as well.
7004 This implies, of course, that your viewer supports this function.
7007 \begin_layout Standard
7008 To make forward search possible, you first need to provide the generated
7009 output PDF/DVI file with additional information about the TeX sources.
7010 This can be done via the methods described in the section
7011 \begin_inset CommandInset ref
7013 reference "sub:rev-search"
7020 \begin_layout Standard
7021 Additionally, you need to configure LyX for using your viewers in
7022 \begin_inset Flex MenuItem
7025 \begin_layout Plain Layout
7026 Tools\SpecialChar \menuseparator
7027 Preferences\SpecialChar \menuseparator
7028 Output\SpecialChar \menuseparator
7035 We provide a range of tested configurations for some viewers, which you
7036 can select from the drop down list.
7037 If none of these configurations suits you, you have to find out and enter
7038 a suitable configuration yourself.
7039 The definition syntax uses the following placeholders:
7042 \begin_layout Itemize
7044 \begin_inset Flex Code
7047 \begin_layout Plain Layout
7056 \begin_layout Itemize
7058 \begin_inset Flex Code
7061 \begin_layout Plain Layout
7067 : name of the (temporary) exported .tex file
7070 \begin_layout Itemize
7072 \begin_inset Flex Code
7075 \begin_layout Plain Layout
7081 : name of the exported output file (either dvi or pdf, depending on which
7082 one exists in the temporary directory)
7085 \begin_layout Standard
7086 Note that only some of the viewers provide full forward search functionality,
7087 among them yap, xdvi, okular and Sumatra PDF.
7091 \begin_layout Plain Layout
7092 For Sumatra CMCDDE is needed --- downloadable from
7093 \begin_inset CommandInset href
7095 target "http://www.istri.fr/zip/CMCDDE.zip"
7104 While many of the widespread PDF viewers (most notably Adobe Reader) do
7105 not support forward search at all, some other viewers -- e.
7106 \begin_inset space \thinspace{}
7110 evince and xpdf -- allow at least to reload the document and jump to a
7111 specific page of the file, so you can at least navigate
7112 \begin_inset Quotes eld
7116 \begin_inset Quotes erd
7120 This latter functionality is provided by an external call of synctex (see
7121 the predefined example configurations).
7125 \begin_layout Standard
7126 Forward search works both with DVI and PDF output.
7127 LyX simply checks which preview format you have used before (i.
7128 \begin_inset space \thinspace{}
7131 e., which format is already there in the temporary directory) and chooses
7132 the appropriate configuration for the respective format.
7135 \begin_layout Chapter
7136 Special Document Classes
7139 \begin_layout Section
7143 \begin_layout Standard
7149 \begin_layout Subsection
7153 \begin_layout Standard
7154 This section describes how LyX can be used to write articles for submission
7155 to the scientific journal
7157 Astronomy and Astrophysics
7159 (www.edpsciences.fr/aa/
7160 \begin_inset Flex URL
7163 \begin_layout Plain Layout
7165 http://www.edpsciences.fr/aa/
7170 ) using Version 5.01 of the document class
7175 This package can be downloaded from the ftp site
7178 \begin_layout Standard
7179 \begin_inset VSpace medskip
7185 \begin_layout Standard
7187 \begin_inset Flex URL
7190 \begin_layout Plain Layout
7192 ftp://ftp.edpsciences.org/pub/aa/readme.html
7200 \begin_layout Standard
7201 \begin_inset VSpace medskip
7207 \begin_layout Standard
7208 A manual comes together with that package, and this text is not meant to
7209 replace the original manual but is merely a short guide in how to realize
7210 the correct form of your paper.
7214 \begin_layout Standard
7215 Please note that the publisher of the journal was changed from Springer
7216 to EDP Sciences starting January 1, 2001.
7217 That change involved also some slight changes to the style files, namely
7218 the removal of the thesaurus command.
7219 The LyX class aa supports the newest version of these style files, V 5.01.
7220 If you have an older version installed, please upgrade.
7221 For compatibility, the old (version 4) layout has been kept as
7226 Please refer to the comments in
7228 LyXDir/layouts/aapaper.layout
7233 \begin_layout Subsection
7237 \begin_layout Standard
7238 It is recommended you start from the example template distributed with LyX.
7239 If you are not using a template, note the following settings:
7242 \begin_layout Itemize
7249 Document\SpecialChar \menuseparator
7252 dialog (OK, that one was obvious).
7255 \begin_layout Itemize
7256 Don't change the option
7259 \begin_inset space ~
7269 The whole layout is done by the macros, you shouldn't change anything.
7272 \begin_layout Subsection
7276 \begin_layout Standard
7277 First thing to enter is the header information.
7278 It consists of seven entries, of which some are optional.
7282 \begin_layout Itemize
7290 \begin_layout Itemize
7298 \begin_layout Itemize
7306 \begin_layout Itemize
7314 \begin_layout Itemize
7319 : [optional] if more than one author: whom to contact for offprint requests.
7322 \begin_layout Itemize
7327 : [optional] mail address for contacts.
7330 \begin_layout Itemize
7338 Received: <date>; Accepted <date>
7341 \begin_layout Standard
7342 There is no need to issue the
7348 command, this is done automatically by LyX when the header is finished.
7349 Although the order of the single header entries doesn't matter it is advised
7350 to keep the above sequence, just to get the best optics and meets the layout
7351 of the real document.
7354 \begin_layout Standard
7355 If you want to place footnotes in the header block, e.
7356 \begin_inset space \thinspace{}
7360 \begin_inset space \space{}
7363 to state your present address, just use the standard footnote via the menu
7366 Insert\SpecialChar \menuseparator
7370 LyX will automagically use the term
7379 \begin_layout Standard
7380 In addition to these topics, the macros use three additional LaTeX commands
7381 that have no counterpart in LyX:
7384 \begin_layout Itemize
7391 to separate different names for more than one author and institute, respectivel
7395 \begin_layout Itemize
7402 to mark corresponding author/institute pairs.
7403 The institutes are numbered sequentially as they appear in the
7407 field, so you have to put a marker to each author.
7410 \begin_layout Itemize
7417 to supply an email address for fast contact.
7420 \begin_layout Standard
7421 In all cases, the appropriate command has to be entered in LyX and marked
7427 \begin_layout Subsection
7431 \begin_layout Standard
7432 The abstract should immediately follow the header block.
7433 With version 5 the abstract environment was changed to a command, and there
7434 is now a resctriction to only one paragraph.
7435 In addition, it should contain an entry with the keywords.
7436 This is not yet implemented for LyX, therefore you have to enter the LaTeX
7443 by hand and mark it as LaTeX code.
7444 Refer to the example paper.
7447 \begin_layout Subsection
7448 Supported environments
7451 \begin_layout Standard
7452 The A&A paper layout supports the following environments for structuring
7456 \begin_layout Itemize
7462 \begin_layout Itemize
7468 \begin_layout Itemize
7474 \begin_layout Itemize
7480 \begin_layout Itemize
7486 \begin_layout Itemize
7492 \begin_layout Itemize
7498 \begin_layout Itemize
7504 \begin_layout Itemize
7510 \begin_layout Itemize
7516 \begin_layout Itemize
7522 \begin_layout Itemize
7528 \begin_layout Subsection
7529 Commands not supported by LyX
7532 \begin_layout Standard
7533 Some commands are not yet supported by the
7538 Some have already been mentioned.
7539 For the sake of completeness, they are listed all together here:
7542 \begin_layout Itemize
7550 \begin_layout Itemize
7558 \begin_layout Itemize
7566 \begin_layout Itemize
7574 \begin_layout Itemize
7582 \begin_layout Itemize
7590 \begin_layout Itemize
7598 \begin_layout Itemize
7606 \begin_layout Standard
7607 If you want to use any of these commands, you have to enter them yourself.
7610 Do not forget to mark them as LaTeX code!
7613 \begin_layout Subsection
7614 Figure and Table Floats
7617 \begin_layout Standard
7618 LyX provides support for the necessary float environments
7620 figure, figure*, table
7626 , therefore we won't tell much about it here.
7630 \begin_inset space ~
7636 Just remember that tables should be left-aligned.
7637 For that, select the table and change the alignment in
7639 Edit\SpecialChar \menuseparator
7641 \begin_inset space ~
7647 \begin_layout Standard
7648 There is only one special thing: the figures with caption besides the figure.
7649 To create such a figure, you have to do the following:
7652 \begin_layout Enumerate
7653 Create a wide figure float:
7655 Insert\SpecialChar \menuseparator
7656 Float\SpecialChar \menuseparator
7659 , then right click in the figure and select
7665 \begin_inset space ~
7673 \begin_layout Enumerate
7674 Enter your caption text.
7677 \begin_layout Enumerate
7682 to move the cursor above the caption.
7685 \begin_layout Enumerate
7689 \begin_layout Enumerate
7690 Position the cursor behind the figure and insert a horizontal fill:
7692 Insert\SpecialChar \menuseparator
7694 \begin_inset space ~
7697 Character\SpecialChar \menuseparator
7699 \begin_inset space ~
7707 \begin_layout Enumerate
7708 Switch to LaTeX mode:
7711 \begin_inset space ~
7719 \begin_layout Enumerate
7729 Do not close the brace!
7732 \begin_layout Enumerate
7733 Position the cursor behind the caption text, switch to LaTeX mode and insert
7737 \begin_inset space ~
7749 \begin_layout Standard
7750 Also, refer to the figures in the example paper.
7753 \begin_layout Subsection
7757 \begin_layout Standard
7758 For submission, the paper has to be formated in a special double-spacing
7760 For this purpose, you have to give the option
7764 to the documentclass.
7765 This must be done using the extra class options field in the
7767 Document\SpecialChar \menuseparator
7771 Just enter the string
7778 \begin_layout Subsection
7782 \begin_layout Standard
7787 directory contains an example paper written with LyX.
7788 It is the example paper from the original macro package, translated to
7790 Use it for inspiration, and compare the original LaTeX code with LyX way
7794 \begin_layout Section
7798 \begin_layout Standard
7804 \begin_layout Subsection
7808 \begin_layout Standard
7809 AASTeX is a set of macros produced by the American Astronomical Society
7810 to facilitate electronic manuscript submission to the three journals they
7811 publish: the Astrophysical Journal (including the Letters and Supplement),
7812 the Astronomical Journal, and the Publications of the Astronomical Society
7814 LyX has proven to be an excellent tool for generating these documents,
7815 especially given its equation, citation, and figure handling capabilities.
7816 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
7817 is the version described here, or higher.
7818 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
7819 incompatible with LyX.
7820 The AASTeX package may be downloaded from the AASTeX Web site
7823 \begin_layout Standard
7824 \begin_inset VSpace medskip
7830 \begin_layout Standard
7832 \begin_inset Flex URL
7835 \begin_layout Plain Layout
7837 http://www.journals.uchicago.edu/AAS/AASTeX
7845 \begin_layout Standard
7846 \begin_inset VSpace medskip
7852 \begin_layout Standard
7853 A complete user guide is contained in that package and you should familiarize
7854 yourself with it thoroughly before embarking on writing a paper in LyX.
7855 LyX will not reduce the need to figure out all the AASTeX commands, it
7856 will only reduce the drudgery of typing everything in.
7857 It is your responsibility to ensure that the final exported LaTeX document
7858 conforms completely to the requirements of the journal to which you are
7859 submitting your paper.
7862 \begin_layout Subsection
7863 Starting a New Paper
7866 \begin_layout Standard
7867 I strongly suggest that you start with the AASTeX template file.
7870 File\SpecialChar \menuseparator
7877 , enter the new file name, then choose the
7882 This will show the most common fields found in a manuscript.
7883 Simply overwrite the existing text (including the brackets,
7887 ) with the correct information.
7888 Many of the AASTeX commands and environments can be implemented directly
7889 in LyX, but some cannot: most noticeably
7901 , which should stick out like a sore thumb if you actually just opened the
7903 For commands such as these, the LaTeX code must be entered directly and
7905 Such commands are referred to as TeX code, or Evil Red Text.
7906 I tried to minimize the amount of TeX code needed in an AASTeX document,
7907 but there is still a bit more required than any of us would like.
7910 \begin_layout Subsection
7911 Finishing Your Paper
7914 \begin_layout Standard
7915 When the paper is finished to your satisfaction and previews/prints correctly,
7917 \begin_inset Quotes eld
7921 \begin_inset Quotes erd
7924 actions which need to be done before you submit it to the journals.
7928 \begin_layout Enumerate
7929 Export your paper as a LaTeX file (
7931 File\SpecialChar \menuseparator
7932 Export\SpecialChar \menuseparator
7939 \begin_layout Enumerate
7944 file with your favorite text editor
7948 \begin_layout Enumerate
7949 remove the comment lines before the
7958 \begin_layout Enumerate
7963 usepackage...{fontenc}
7965 line if it appears (usually just after
7980 \begin_layout Enumerate
7981 remove everything between (and including) the
7993 commands, except for any commands you specifically put into the LaTeX preamble
7994 (which should appear immediately after the
7995 \begin_inset Quotes eld
7998 User specified LaTeX commands
7999 \begin_inset Quotes erd
8010 \begin_layout Enumerate
8011 Run the resulting file through LaTeX to make sure it still processes correctly.
8014 \begin_layout Enumerate
8015 Reread the journal requirements to make sure your filenames and formats
8019 \begin_layout Enumerate
8023 \begin_layout Subsection
8024 Comments On Specific Commands
8027 \begin_layout Standard
8028 I will not describe the detailed usage of the individual AASTeX commands:
8029 the AASTeX User Guide (
8033 ) gives a good description of each.
8034 Thus it's probably easiest for me to go down the list as found in the guide
8035 and offer comments where necessary.
8036 So let's begin \SpecialChar \ldots{}
8040 \begin_layout Subsubsection
8041 Things that work as expected
8044 \begin_layout Standard
8045 Because they work as you might expect, I simply list them and the section
8146 begin{thebibliography}
8154 (2.13.2), all the cite commands and their variations (2.13.2), the generic
8155 graphicx figure commands (2.14.1),
8179 (2.15.4, amongst other places),
8206 \begin_layout Standard
8207 The following style options also work correctly:
8228 Simply put them in the
8234 Layout\SpecialChar \menuseparator
8240 \begin_layout Subsubsection
8241 Things that work, but require more comment
8244 \begin_layout Standard
8245 The following items work, but require a little more discussion:
8248 \begin_layout Itemize
8249 These items are reserved for use by the journal editors, but you can put
8250 them into the LaTeX preamble if you feel compelled to do so:
8283 \begin_layout Itemize
8284 These items may be placed in the LaTeX preamble, and are included as blanks
8285 in the template file:
8306 \begin_layout Itemize
8313 (2.3) – can only be used
8314 \begin_inset Quotes eld
8318 \begin_inset Quotes erd
8321 , not in the middle of a paragraph.
8322 Use TeX code if you need to embed it.
8325 \begin_layout Itemize
8332 (2.3) – will have extra {} after it.
8333 This should not cause an error.
8336 \begin_layout Itemize
8343 (2.6) – can only be used
8344 \begin_inset Quotes eld
8348 \begin_inset Quotes erd
8351 , not in the middle of a paragraph.
8352 Use TeX code if you need to embed it.
8355 \begin_layout Itemize
8362 (2.8) – can't insert a cross-reference tag, you must type the tag name by
8366 \begin_layout Itemize
8380 \begin_layout Itemize
8387 (2.9) – will have extra {} after it.
8388 This should not cause an error.
8391 \begin_layout Itemize
8398 (2.11) – will have extra {} after it.
8399 This should not cause an error.
8402 \begin_layout Itemize
8409 (2.14.2) – you can insert an optional filename argument by placing the cursor
8410 at the beginning of the text and selecting
8412 Insert\SpecialChar \menuseparator
8417 \begin_inset Quotes eld
8421 \begin_inset Quotes erd
8424 inserts an optional argument of the type needed by
8431 Hopefully it will be renamed someday.
8434 \begin_layout Itemize
8447 for the catalog ID optional parameter
8450 \begin_layout Itemize
8463 for the catalog ID optional parameter
8466 \begin_layout Subsubsection
8467 Things not implemented, use TeX code
8470 \begin_layout Standard
8493 setcounter{equation}
8495 (2.12), Journal name abbreviations (2.13.4),
8531 (2.15.4, insert it as the first element in the lefthand cell after where
8533 Don't use any of LyX's rules in the table),
8545 (2.15.5), much of Misc (2.17, except
8596 \begin_layout Subsubsection
8597 Things that cannot be implemented
8600 \begin_layout Standard
8601 \SpecialChar \ldots{}
8602 at least in any meaningful sort of way, so I suggest ignoring them.
8603 They are the references environment (2.13.3), and the deluxetable environment
8605 If you really, really need to use deluxetable, I suggest editing it in
8606 a separate file with a text editor, then using
8608 Insert\SpecialChar \menuseparator
8610 \begin_inset space ~
8615 to include it in your LyX document.
8620 file to see an example of this.
8623 \begin_layout Subsection
8624 FAQs, Tips, Tricks, and Other Ruminations
8627 \begin_layout Subsubsection
8628 Getting LyX and AASTeX to cooperate
8631 \begin_layout Standard
8632 It can be a bit tricky to get LyX to recognize a new layout and document
8634 When all else fails, do this:
8637 \begin_layout Enumerate
8638 Make certain that LaTeX can find AASTeX.
8639 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
8640 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
8647 \begin_layout Enumerate
8659 \begin_layout Enumerate
8662 Tools\SpecialChar \menuseparator
8665 in LyX, then restart LyX.
8668 \begin_layout Enumerate
8669 Open a regular new file, not from a template.
8670 Does AASTeX appear in the class list in
8672 Document\SpecialChar \menuseparator
8678 \begin_layout Standard
8679 If you get a warning from an existing AASTeX document about not being able
8680 to find the AASTeX layout or a message about
8681 \begin_inset Quotes eld
8684 You should not mix title layouts with normal ones
8685 \begin_inset Quotes erd
8688 , things haven't been installed correctly.
8691 \begin_layout Subsubsection
8692 LaTeX error processing a table
8695 \begin_layout Standard
8696 LyX, by default, attempts to center the table caption/title.
8697 This seems to produce a bad interaction in AASTeX so you should click somewhere
8698 in the caption/title, then select
8700 Edit\SpecialChar \menuseparator
8702 \begin_inset space ~
8716 This took care of it for me.
8719 \begin_layout Subsubsection
8723 \begin_layout Standard
8724 A couple of things: 1) I have noticed some funny spacing in the reference
8725 entries in the text.
8726 When you enter the bibliography item data, make sure their is
8730 space between the last author and the parenthesis setting off the year;
8734 \begin_inset space \thinspace{}
8738 \begin_inset space \space{}
8752 2) Entering the references at all is not obvious.
8753 The easiest thing is to start typing your first reference at the end of
8754 the document, then mark it as type
8759 That will put a small gray box in front of what you just typed.
8760 Click on the box to fill in the rest of the information.
8761 For new references, go to the end of an existing reference and press return.
8762 That will create a new line with its own box, etc.
8765 \begin_layout Subsubsection
8769 \begin_layout Standard
8770 Even though AASTeX provides its own figure commands (
8776 , for example), I much prefer LaTeX's standard figure commands (with the
8785 \begin_inset space ~
8788 commands as TeX code into a Figure Float box if you desire, but I never
8789 have much luck getting the layout right.
8790 With the standard graphics, LyX will insert a
8794 usepackage{graphicx}
8796 command into the LaTeX preamble and handle the figures in the standard
8797 LaTeX2e way, interspersing the figures in the text.
8798 I believe ApJ accepts figures exactly this way now; AJ might still use
8800 \begin_inset Quotes eld
8803 stack everything at the end
8804 \begin_inset Quotes erd
8810 \begin_layout Subsubsection
8811 Things I could have done, but didn't
8814 \begin_layout Standard
8816 \begin_inset Quotes eld
8820 \begin_inset Quotes erd
8823 things I could have implemented, but chose not to.
8824 For instance, I saw no point in double-spacing the text in the LyX window,
8825 even though it is double-spaced in the paper manuscript.
8826 Also, I chose not to make separate layouts for the preprint and preprint2
8828 Since I assume you will spend most of your time in the plain manuscript
8829 mode anyway, I decided not to chew up more disk space with this.
8833 \begin_layout Subsection
8837 \begin_layout Standard
8838 Your mileage may vary.
8839 I've now had papers published by both ApJ and AJ that have had 98% of the
8840 effort done in LyX; the last 2% was the LaTeX post-processing and a few
8842 I have had no trouble with the submission process, and I'm sure the journals
8843 were never aware that there might be a difference.
8844 So, go forth and publish!
8847 \begin_layout Section
8851 \begin_layout Standard
8861 \begin_layout Standard
8862 \begin_inset VSpace bigskip
8868 \begin_layout Standard
8870 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
8871 papers to be submitted to American Mathematical Society publications.
8872 The layouts are not tailored to a specific journal, but easily can be.
8873 You should refer to the AMS documentation for specific instructions for
8874 each journal (usually it will entail only changing a single line in the
8876 That documentation is available on the Web at
8877 \begin_inset Flex URL
8880 \begin_layout Plain Layout
8888 \begin_inset Flex URL
8891 \begin_layout Plain Layout
8893 ftp://ftp.ams.org/pub/tex/amslatex/
8899 These layouts are appropriate, and useful, for any mathematical writing.
8903 \begin_layout Standard
8904 There are two basic AMS LaTeX layouts:
8907 \begin_layout Itemize
8908 amsart: The standard AMS article format.
8911 \begin_layout Itemize
8912 amsbook: the standard AMS book (really, monograph) format.
8916 \begin_layout Standard
8917 The layouts themselves contain only the minimum necessary to use the AMS
8919 They do not, in particular, contain any of the `theorem' environments used
8920 for setting theorems, lemmas, and the like.
8921 These are contained, instead, in the
8922 \begin_inset Flex Code
8925 \begin_layout Plain Layout
8931 module, which is loaded by default when when you select one of the AMS
8933 (It can also be used with other classes and can be removed, if you would
8934 rather use something else.) Less commonly used environments are in the
8935 \begin_inset Flex Code
8938 \begin_layout Plain Layout
8939 Theorems (AMS-Extended)
8944 module, which must be loaded manually.
8947 \begin_layout Standard
8948 By default, theorems and the like are numbered consecutively throughout
8949 the document, but this may be modified by loading the module
8950 \begin_inset Flex Code
8953 \begin_layout Plain Layout
8954 Theorems (Order by Section)
8959 or, if you are using
8960 \begin_inset Flex Code
8963 \begin_layout Plain Layout
8970 \begin_inset Flex Code
8973 \begin_layout Plain Layout
8974 Theorems (Order by Chapter)
8980 These will number the results as
8981 \begin_inset Formula $n.m$
8984 , where the first number refers to the section (or chapter) and the second
8985 refers to the total number of results so far in that section (or chapter).
8986 Many environments are also available unnumbered.
8987 These are indicated by an asterisk at the end.
8988 If you happen to want
8992 unnumbered results, the module
8993 \begin_inset Flex Code
8996 \begin_layout Plain Layout
9002 provides that option.
9005 \begin_layout Standard
9006 Note that these modules do not
9010 to be used with the AMS classes.
9011 It is perfectly possible to use the
9012 \begin_inset Flex Code
9015 \begin_layout Plain Layout
9021 module, and the others mentioned, with other classes, such as
9022 \begin_inset Flex Code
9025 \begin_layout Plain Layout
9032 \begin_inset Flex Code
9035 \begin_layout Plain Layout
9042 \begin_inset Flex Code
9045 \begin_layout Plain Layout
9054 \begin_layout Subsection
9055 What these layouts provide
9058 \begin_layout Standard
9059 There is a long list of included environments provided by these layouts.
9060 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
9061 variety of `theorem' environments.
9062 However, the AMS recommends the environments that are available in LyX.
9066 \begin_layout Standard
9067 The following environments—as well as the standard environments, such as
9069 \begin_inset Flex Noun
9072 \begin_layout Plain Layout
9079 \begin_inset Flex Noun
9082 \begin_layout Plain Layout
9089 \begin_inset Flex Noun
9092 \begin_layout Plain Layout
9099 \begin_inset Flex Noun
9102 \begin_layout Plain Layout
9109 \begin_inset Flex Noun
9112 \begin_layout Plain Layout
9119 \begin_inset Flex Code
9122 \begin_layout Plain Layout
9129 \begin_inset Flex Code
9132 \begin_layout Plain Layout
9141 \begin_layout Description
9142 Address This should be the author's permanent address.
9145 \begin_layout Description
9147 \begin_inset space ~
9150 Address This should be the author's temporary address at the time of submission,
9151 if different from the Address.
9154 \begin_layout Description
9155 Email Author's e-mail address
9158 \begin_layout Description
9159 URL Author's Web address, if desired.
9162 \begin_layout Description
9163 Keywords Key words or phrases used to identify specific topics discussed
9167 \begin_layout Description
9168 Subjectclass These refer to the AMS Subject Classifications, published and
9171 Mathematical Reviews
9174 These are also available online at the AMS cites listed above.
9177 \begin_layout Description
9181 \begin_layout Description
9185 \begin_layout Description
9189 \begin_layout Standard
9190 The following environments are provided by both the
9191 \begin_inset Flex Code
9194 \begin_layout Plain Layout
9201 \begin_inset Flex Code
9204 \begin_layout Plain Layout
9210 modules, in the latter case in both starred (unnumbered) and unstarred
9211 (numbered) versions.
9212 These same environments are provided only in the starred versions by the
9214 \begin_inset Flex Code
9217 \begin_layout Plain Layout
9226 \begin_layout Theorem
9227 This is typically used for the statements of major results.
9231 \begin_layout Corollary*
9232 This is used for statements which follow fairly directly from previous statement
9234 Again, these can be major results.
9239 These are smaller results needed to prove other statements.
9242 \begin_layout Proposition
9243 These are less major results which (hopefully) add to the general theory
9247 \begin_layout Conjecture
9248 These are statements provided without justification, which the author does
9249 not know how to prove, but which seem to be true (to the author, at least).
9252 \begin_layout Definition*
9253 Guess what this is for.
9254 The font is different for this environment than for the previous ones.
9258 \begin_layout Example*
9259 Used for examples illustrating proven results.
9262 \begin_layout Problem
9263 It's not really known what this is for.
9264 You should figure it out.
9267 \begin_layout Exercise*
9268 Write a description for this one.
9271 \begin_layout Remark
9272 This environment is also a type of theorem, usually a lesser sort of observation.
9275 \begin_layout Claim*
9276 Often used in the course of giving a proof of a larger result.
9280 Generally, these are used to break up long arguments, using specific instances
9286 The numbering scheme for cases is on its own, not together with other numbered
9292 At the end of this environment, a QED symbol (usually a square, but it can
9293 vary with different styles) is placed.
9294 If you want to have other environments within this one—for example, Case
9295 environments—and have the QED symbol appear only after them, then the other
9296 environments need to be nested within the proof environment.
9299 Nesting Environments
9305 for information on nesting.
9308 \begin_layout Standard
9309 And these environments are provided by
9310 \begin_inset Flex Code
9313 \begin_layout Plain Layout
9314 Theorems (AMS-Extended)
9322 \begin_layout Criterion*
9323 A required condition.
9326 \begin_layout Algorithm*
9327 A general procedure to be used.
9330 \begin_layout Axiom*
9331 This is a property or statement taken as true within the system being discussed.
9334 \begin_layout Condition*
9335 Sometimes used to state a condition assumed within the present context of
9340 Similar to a Remark.
9343 \begin_layout Notation*
9344 Used for the explanation of, yes, notation.
9347 \begin_layout Summary
9348 Do we really need to tell you?
9351 \begin_layout Acknowledgement*
9355 \begin_layout Conclusion*
9356 Sometimes used at the end of a long train of argument.
9360 Used in a way similar to Proposition, though perhaps lower on the scale.
9363 \begin_layout Standard
9364 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
9366 They need to be available on your system in order to use these environments.
9369 \begin_layout Section
9377 \begin_layout Standard
9383 \begin_layout Subsection
9387 \begin_layout Standard
9388 These are the layout files for some of the journals of the American Geophysical
9390 It is assumed that you have both the AGU's own class files and AGUplus
9391 installed (everything to be found at
9392 \begin_inset Flex URL
9395 \begin_layout Plain Layout
9397 ftp://ftp.agu.org/journals/latex/journals
9405 \begin_layout Subsection
9409 \begin_layout Standard
9419 They are still called this in the LyX GUI, though their LaTeX equivalents
9420 in the AGU classes are
9431 \begin_layout Standard
9432 Newly defined styles are
9469 These are mostly manuscript attributes and defined in the AGU class documentati
9473 \begin_layout Standard
9474 I suspect this is still badly incomplete.
9477 \begin_layout Subsection
9481 \begin_layout Standard
9498 \begin_layout Subsection
9502 \begin_layout Itemize
9505 Journal of Geophysical Research
9514 \begin_layout Standard
9515 Add your own, it isn't so hard! Look at the
9526 \begin_layout Subsection
9527 Bugs and things to remember
9530 \begin_layout Standard
9531 In order to use the new layouts, you must remember to do the following for
9535 \begin_layout Enumerate
9541 This can be done in the
9543 Layout\SpecialChar \menuseparator
9548 Document\SpecialChar \menuseparator
9552 (AGU articles are always in English, right? So
9559 \begin_layout Enumerate
9569 (Yes, this is a bug.)
9572 \begin_layout Enumerate
9573 Make sure you use the
9577 bibliography style, by entering
9581 into the second field of the BibTeX inset.
9582 None of the standard styles will do.
9585 \begin_layout Section
9589 \begin_layout Standard
9595 \begin_layout Subsection
9599 \begin_layout Standard
9600 Broadway is for writing plays.
9601 The format is more decorative than Hollywood, and much less standardized.
9602 This format should be suitable for workshops.
9605 \begin_layout Subsection
9609 \begin_layout Standard
9610 The same as in Hollywood.
9613 \begin_layout Subsection
9617 \begin_layout Standard
9622 names as labels then cross-reference the label to insert the name.
9623 The cross-reference dialog will show the current cast of characters.
9626 \begin_layout Subsection
9627 Paper size and Margins
9630 \begin_layout Standard
9631 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
9634 \begin_layout Subsection
9638 \begin_layout Standard
9639 The following environments are available.
9640 You can use broadway.bind to get the bind keys shown at the right.
9643 \begin_layout Itemize
9647 \begin_inset Newline newline
9652 You should not have to use this, but it is here for anything that does not
9656 \begin_layout Itemize
9660 \begin_inset space \hfill{}
9664 \begin_inset Newline newline
9669 Used to describe stage setting and the action.
9670 First use of speaker names in all CAPs.
9673 \begin_layout Itemize
9677 \begin_inset space \hfill{}
9681 \begin_inset Newline newline
9686 Automatically numbered.
9687 On screen it will be arabic, but will print as Roman.
9690 \begin_layout Itemize
9694 \begin_inset space \hfill{}
9698 \begin_inset Newline newline
9708 It is just centered text.
9711 \begin_layout Itemize
9715 \begin_inset space \hfill{}
9719 \begin_inset Newline newline
9724 Not automatically numbered.
9725 You supply the number.
9726 This is because I couldn't figure out how.
9729 \begin_layout Itemize
9733 \begin_inset space \hfill{}
9737 \begin_inset Newline newline
9742 A special case of Narrative to describe the setting and action as the curtain
9746 \begin_layout Itemize
9750 \begin_inset space \hfill{}
9754 \begin_inset Newline newline
9759 The speaker's (actor's) title, centered in all CAPS.
9762 \begin_layout Itemize
9766 \begin_inset space \hfill{}
9770 \begin_inset Newline newline
9775 Instructions to the speaker.
9776 The parentheses are automatically inserted.
9777 The ( will appear on screen, but both will be in the printed play.
9778 This environment is only used within
9785 \begin_layout Itemize
9789 \begin_inset space \hfill{}
9793 \begin_inset Newline newline
9798 What the Speaker says.
9801 \begin_layout Itemize
9805 \begin_inset space \hfill{}
9809 \begin_inset Newline newline
9814 The curtain comes down.
9817 \begin_layout Itemize
9821 \begin_inset space \hfill{}
9827 \begin_layout Itemize
9831 \begin_inset space \hfill{}
9837 \begin_layout Itemize
9841 \begin_inset space \hfill{}
9847 \begin_layout Standard
9851 \begin_layout Section
9855 \begin_layout Standard
9860 can be used to type letters according to German conventions.
9861 A template file is included in
9863 .../lyx/share/templates
9865 for you to use as a starting point.
9868 \begin_layout Section
9876 \begin_layout Standard
9882 \begin_layout Subsection
9886 \begin_layout Standard
9887 This is the layout file for the European Geophysical Society journals.
9892 can be downloaded from the web site of the EGS under
9893 \begin_inset Flex URL
9896 \begin_layout Plain Layout
9906 \begin_layout Subsection
9910 \begin_layout Standard
9913 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9921 The current layout file is unfortunately very unmodular and would benefit
9922 from using the various
9929 \begin_layout Section
9933 \begin_layout Standard
9934 See the LyX template file
9939 It contains all infos you need.
9942 \begin_layout Section
9948 \begin_inset CommandInset label
9957 \begin_layout Standard
9963 \begin_layout Subsection
9967 \begin_layout Standard
9968 This section describes how to use LyX to make slides for overhead projectors.
9969 There are two document classes that can do this: the default slides class
9975 This section documents the latter.
9978 \begin_layout Standard
9979 I'm going to say this again, nice and clear, so that there's no misunderstanding
9983 \begin_layout Standard
9984 \begin_inset VSpace bigskip
9990 \begin_layout Standard
9994 This section documents the class
9995 \begin_inset Quotes eld
10003 \begin_inset Quotes erd
10011 \begin_layout Standard
10012 \begin_inset VSpace bigskip
10018 \begin_layout Standard
10019 If you're looking for the documentation for
10020 \begin_inset Quotes eld
10028 \begin_inset Quotes erd
10031 , check out section
10032 \begin_inset space ~
10036 \begin_inset CommandInset ref
10038 reference "sec:slitex"
10043 If your machine doesn't have the
10048 \begin_inset Quotes eld
10056 \begin_inset Quotes erd
10059 ] installed, you'll probably have to use the default
10063 class, which isn't quite as good as
10068 \begin_layout Standard
10073 class is designed for use with version 2.1 of the
10077 LaTeX class file which is now an integral part of LaTeX2e.
10080 \begin_layout Subsection
10084 \begin_layout Standard
10085 Obviously, to use this document class, you need to select
10086 \begin_inset Quotes eld
10094 \begin_inset Quotes erd
10104 \begin_inset space ~
10110 There are some settings in the
10113 \begin_inset space ~
10118 dialog that you should know about that are specific to this class:
10121 \begin_layout Itemize
10122 Don't change the options
10133 \begin_inset space ~
10139 They're ignored by the
10146 \begin_layout Itemize
10147 The default font size is 20
10148 \begin_inset space \thinspace{}
10151 pt with the other options being 17
10152 \begin_inset space \thinspace{}
10156 \begin_inset space \thinspace{}
10160 \begin_inset space \thinspace{}
10166 \begin_layout Itemize
10167 The default font is
10175 but all math equations are still typeset in the usual roman font.
10178 \begin_layout Itemize
10183 supports A4 and Letter paper sizes as well as a special size for working
10185 \begin_inset space \thinspace{}
10189 It doesn't support A5, B5, legal or executive paper sizes.
10192 \begin_layout Itemize
10193 Don't bother changing the
10197 settings because they are ignored anyway.
10198 All floats appear where they are defined in the text.
10201 \begin_layout Itemize
10206 setting behaves a bit differently for this class.
10211 provides extensive footer and header capabilities including a user-defined
10214 \begin_inset space ~
10218 \begin_inset CommandInset ref
10220 reference "sec:foilfoot"
10225 The title page is treated differently to all other pages in the document
10234 has the logo centered at the bottom of the page (if one is defined).
10235 The possible page style choices and what they do are as follows:
10239 \begin_layout Labeling
10240 \labelwidthstring MMMMMMM
10247 The final output contains no page numbers, or other headers or footers
10248 (except footnotes of course).
10252 \begin_layout Labeling
10253 \labelwidthstring MMMMMMM
10260 The final output contains page numbers centered at the bottom of the page.
10261 No other headings or footers (other than footnotes).
10264 \begin_layout Labeling
10265 \labelwidthstring MMMMMMM
10270 Page numbers in lower right corner.
10271 Additional headers and footers are also shown.
10272 This is also the default.
10275 \begin_layout Labeling
10276 \labelwidthstring MMMMMMM
10281 Gives you access to the
10285 package although its use with
10289 is discouraged by the writer of the
10293 package because of some potential page layout clashes.
10297 \begin_layout Subsubsection
10301 \begin_layout Standard
10302 The following options may be used in the extra class options in the
10304 Document\SpecialChar \menuseparator
10310 \begin_layout Labeling
10311 \labelwidthstring MMMMMMx
10316 This sets up the page layout for 7.33
10317 \begin_inset space \thinspace{}
10321 \begin_inset space \thinspace{}
10324 in paper, which is about the same aspect ratio as a 35
10325 \begin_inset space \thinspace{}
10328 mm slide, making it a bit easier to work with this medium.
10331 \begin_layout Labeling
10332 \labelwidthstring MMMMMMx
10337 Places a rule across the page below the header on every page except the
10341 \begin_layout Labeling
10342 \labelwidthstring MMMMMMx
10347 Places a rule across the page above the footer on every page except the
10351 \begin_layout Labeling
10352 \labelwidthstring MMMMMMx
10357 This is automatically set each time you create a new
10366 to use the dvips driver to rotate those pages that are set as landscape
10370 \begin_layout Labeling
10371 \labelwidthstring MMMMMMx
10376 Simply changes the page dimensions to those of a landscape page but doesn't
10378 Thus if you use this option you need to use an external program to rotate
10379 each page or feed your paper through your printer as landscape.
10380 Note that this option effectively reverses the roles of the
10388 environments (don't worry these are described in the next section).
10391 \begin_layout Labeling
10392 \labelwidthstring MMMMMMx
10397 Equation numbers on the left.
10400 \begin_layout Labeling
10401 \labelwidthstring MMMMMMx
10406 Flush-left equations.
10409 \begin_layout Subsection
10410 Supported Environments
10413 \begin_layout Standard
10414 Most of the environments commonly supported in other classes are also supported
10420 There are several additional environments provided by
10424 as well as a couple added by LyX.
10425 The following environments are shared with other classes:
10428 \begin_layout Standard
10432 \begin_layout Plain Layout
10436 begin{multicols}{2}
10444 \begin_layout Itemize
10450 \begin_layout Itemize
10456 \begin_layout Itemize
10462 \begin_layout Itemize
10468 \begin_layout Itemize
10474 \begin_layout Itemize
10480 \begin_layout Itemize
10486 \begin_layout Itemize
10492 \begin_layout Itemize
10498 \begin_layout Itemize
10504 \begin_layout Itemize
10510 \begin_layout Itemize
10516 \begin_layout Itemize
10522 \begin_layout Itemize
10528 \begin_layout Itemize
10534 \begin_layout Itemize
10540 \begin_layout Itemize
10546 \begin_layout Itemize
10552 \begin_layout Standard
10556 \begin_layout Plain Layout
10568 \begin_layout Standard
10569 That is, all the major environments apart from the sectioning environments.
10570 Since foils are essentially self-contained sections, with a title and body,
10575 provides specific commands for starting new foils and these are:
10578 \begin_layout Itemize
10584 \begin_layout Itemize
10590 \begin_layout Standard
10591 LyX also provides slightly modified versions of these two environments called:
10594 \begin_layout Itemize
10600 \begin_layout Itemize
10603 ShortRotatefoilhead
10606 \begin_layout Standard
10607 and the differences will be explained in the next section.
10610 \begin_layout Standard
10611 Since foils are often used in presenting ideas or new theorems and such
10616 also provides a comprehensive box of goodies for presenting them:
10619 \begin_layout Standard
10623 \begin_layout Plain Layout
10627 begin{multicols}{2}
10635 \begin_layout Itemize
10641 \begin_layout Itemize
10647 \begin_layout Itemize
10653 \begin_layout Itemize
10659 \begin_layout Itemize
10665 \begin_layout Itemize
10671 \begin_layout Itemize
10677 \begin_layout Itemize
10683 \begin_layout Itemize
10689 \begin_layout Itemize
10695 \begin_layout Itemize
10701 \begin_layout Standard
10705 \begin_layout Plain Layout
10717 \begin_layout Standard
10718 The starred versions are unnumbered while the unstarred versions are numbered.
10719 There are also two list environments added by LyX and these are:
10722 \begin_layout Itemize
10728 \begin_layout Itemize
10734 \begin_layout Standard
10739 provides some powerful header and footer capabilities that are best set
10740 in the preamble although they may be set at any point in a document.
10741 If you want to change these settings in your document the best place to
10742 do so is at the very top of a foil, i.
10743 \begin_inset space \thinspace{}
10749 \begin_inset space \space{}
10754 straight after the foilhead.
10757 \begin_layout Standard
10758 For this purpose, the following command styles are provided [
10765 \begin_layout Standard
10769 \begin_layout Plain Layout
10773 begin{multicols}{2}
10781 \begin_layout Itemize
10785 \begin_inset space ~
10791 \begin_layout Itemize
10797 \begin_layout Itemize
10801 \begin_inset space ~
10807 \begin_layout Itemize
10811 \begin_inset space ~
10817 \begin_layout Itemize
10821 \begin_inset space ~
10828 \begin_layout Standard
10829 \begin_inset space ~
10836 \begin_layout Standard
10840 \begin_layout Plain Layout
10852 \begin_layout Standard
10853 There are also a few commands provided by
10857 that aren't directly supported by LyX but I'll tell you what they do and
10858 how to use them in section
10859 \begin_inset space ~
10863 \begin_inset CommandInset ref
10865 reference "sec:unsuppfoils"
10872 \begin_layout Subsection
10873 Building a Set of Foils
10876 \begin_layout Standard
10877 This section will give a simple introduction to using the different environments
10878 to build a set of foils.
10879 If you want to see an example set of foils, take a look at the
10883 file you find in LyX's
10890 \begin_layout Subsubsection
10891 Give It a Title Page
10894 \begin_layout Standard
10895 Unlike other classes that provide
10915 creates the title on a page of its own.
10916 If you leave out the
10920 environment LaTeX will substitute the current date (every time you regenerate
10924 \begin_layout Subsubsection
10928 \begin_layout Standard
10929 As I mentioned earlier, there are four ways of starting a new foil.
10930 For portrait foils you should use
10939 The difference between these two environments is the amount of space between
10940 the title of the foil (the foilhead) and the body of the foil.
10943 \begin_layout Standard
10944 Landscape foils are generated using the
10950 ShortRotatefoilhead
10953 Again the only difference is the spacing between foilhead and body.
10954 Both of the short versions have 0.5 inches less separation between the foilhead
10959 \begin_layout Standard
10960 One problem with the support for landscape foils is the requirement that
10961 you have to use the
10965 driver to generate the PostScript output otherwise the foils won't be rotated.
10966 It is possible to get landscape foils even if you haven't got the
10970 driver provided you can feed your foils sideways through your printer ;-)
10973 \begin_layout Subsubsection
10974 Theorems, Lemmas, Proofs and more
10977 \begin_layout Standard
10978 Due to a small bug in LyX you can't have two of the same type of these environme
10979 nts directly following each other.
10980 They must be separated by something.
10981 If you try, you will just be extending the previous environment as if you
10982 had merged the two environments together.
10983 So, how do you get around this problem? The simplest option is to insert
10984 some text between the two environments or add a
10988 environment between the two with just a
10989 \begin_inset Quotes eld
10997 \begin_inset Quotes erd
11001 This will force LyX to produce two separate environments and hence the
11002 correct LaTeX output.
11003 An example is provided in the example file included with the LyX distribution.
11004 Remember, this problem only occurs if you are trying to place two of the
11005 same type of theorem-like environments one directly after the other.
11008 \begin_layout Subsubsection
11012 \begin_layout Standard
11013 You get all the commonly supported list styles found in other classes as
11014 well as two new ones.
11015 I'll only describe the new ones here.
11016 If you want to find out more about the other list environments check out
11022 If you intend to use itemized lists you might also want to read about the
11026 \begin_inset space ~
11030 \begin_inset space ~
11035 dialog described above in section
11036 \begin_inset space ~
11040 \begin_inset CommandInset ref
11042 reference "sec:bullet"
11049 \begin_layout Standard
11050 The two new list styles,
11058 , are designed to make it easier for you to create lists of do's and don'ts
11059 or right and wrong by providing dedicated environments that use a tick
11060 or a cross as the label of the list.
11061 These lists are in fact dedicated variants of the
11066 They do however require that you have the
11070 packages installed.
11073 \begin_layout Subsubsection
11077 \begin_layout Standard
11082 redefines the floating tables and figures so that they appear exactly where
11083 they are in the text rather than pushing them to the top of the page or
11084 to some user specified location.
11085 In fact if you change the float placement settings they are simply ignored.
11088 \begin_layout Subsubsection
11089 Page Headers and Footers
11090 \begin_inset CommandInset label
11092 name "sec:foilfoot"
11099 \begin_layout Standard
11103 \begin_inset space ~
11112 are two commands used to control the left-footer text string.
11113 The first is meant to allow you to include a graphic logo on your foils
11115 \begin_inset Quotes eld
11123 \begin_inset Quotes erd
11127 While the second is meant to provide a classification for the audience,
11131 \begin_inset space \thinspace{}
11137 \begin_inset space \space{}
11141 It is empty by default.
11144 \begin_layout Standard
11145 The remaining page corners can be filled by
11148 \begin_inset space ~
11153 (which defaults to page numbers),
11156 \begin_inset space ~
11164 \begin_inset space ~
11172 \begin_layout Subsection
11178 \begin_inset CommandInset label
11180 name "sec:unsuppfoils"
11187 \begin_layout Standard
11188 All the commands mentioned below need to be set in a
11196 within another environment.
11199 \begin_layout Subsubsection
11203 \begin_layout Standard
11204 All lengths are adjusted using the
11227 should be replaced by the name given to the length you want to change and
11232 is the length value.
11233 All lengths should be specified in units of length such as inches (
11245 ) or relative to some document or font-based length such as
11255 \begin_layout Standard
11256 It's possible to change the spacing between a foilhead and the body of the
11257 foil by adjusting the length specified by
11264 For example, to make
11269 \begin_inset space \space{}
11272 in closer to their bodies put the following in the preamble:
11278 foilheadskip}{-0.5in}
11281 \begin_layout Standard
11282 The spacings around floats can be adjusted by setting these lengths:
11285 \begin_layout Labeling
11286 \labelwidthstring MMMMMMMMMMM
11293 Separation between the text and the top of the float
11296 \begin_layout Labeling
11297 \labelwidthstring MMMMMMMMMMM
11304 Separation between the float and the caption
11307 \begin_layout Labeling
11308 \labelwidthstring MMMMMMMMMMM
11315 Separation between the caption and the following text
11318 \begin_layout Labeling
11319 \labelwidthstring MMMMMMMMMMM
11326 You can make the captions narrower than the surrounding text by adjusting
11328 Best done relative to
11337 \begin_layout Standard
11338 There are also several title page related lengths that you may find useful
11339 if you have a long title or several authors:
11342 \begin_layout Labeling
11343 \labelwidthstring MMMMMMMMMMM
11350 Separation from headers to
11355 \begin_layout Labeling
11356 \labelwidthstring MMMMMMMMMMM
11374 \begin_layout Labeling
11375 \labelwidthstring MMMMMMMMMMM
11389 \begin_layout Labeling
11390 \labelwidthstring MMMMMMMMMMM
11406 \begin_layout Labeling
11407 \labelwidthstring MMMMMMMMMMM
11423 \begin_layout Standard
11424 The last length related command affects all the list environments.
11435 a list environment then all the vertical spacing between the list items
11437 Note that this is a command not a length so it doesn't require
11443 like the stuff mentioned above.
11446 \begin_layout Subsubsection
11447 Headers and Footers
11450 \begin_layout Standard
11463 commands control whether the logo in the
11467 definition appear on a given page.
11474 in the preamble then none of the foils will have the logo on them.
11475 If you don't want the logo on a particular page place the
11481 directly after the foilhead of that page and the
11487 directly after the next foilhead.
11490 \begin_layout Standard
11491 If you decide to use the
11495 page style setting in the
11498 \begin_inset space ~
11503 dialog you should probably add
11513 to your preamble so headers and footers on landscape pages are correctly
11514 placed when rotated.
11515 This is due to some clashes between the page layouts provided by the
11526 \begin_layout Section
11527 Hollywood (Hollywood spec scripts)
11530 \begin_layout Standard
11536 \begin_layout Subsection
11540 \begin_layout Standard
11541 Getting the format of a Hollywood script right is a
11542 \begin_inset Quotes eld
11546 \begin_inset Quotes erd
11549 It is designed to make the readers focus on content and to be easy and
11550 familiar for the actors to read.
11551 Each page of a script should be one minute of film.
11552 Nothing goes in a script that you cannot see or hear on screen.
11553 The courier 12 pt font should be used throughout.
11557 \begin_layout Subsection
11561 \begin_layout Standard
11562 Speakers' lines should NEVER break in mid-sentence.
11563 If a speaker's lines continue over a page break, repeat the
11567 title followed by (Cont'd).
11570 \begin_layout Subsection
11574 \begin_layout Standard
11579 names as labels then cross-reference the label to insert the name.
11580 The cross-reference dialog will show the current cast of characters.
11581 You can use this to insert the speaker name in narratives also.
11584 \begin_layout Subsection
11585 Paper size and Margins
11588 \begin_layout Standard
11589 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
11592 \begin_layout Subsection
11596 \begin_layout Standard
11597 The following environments are available.
11598 You can use hollywood.bind to get the bind keys shown at the right.
11601 \begin_layout Itemize
11605 \begin_inset Newline newline
11610 Used where nothing else works.
11614 \begin_layout Itemize
11620 \begin_inset space \hfill{}
11628 \begin_inset Newline newline
11631 Usually followed by something like
11632 \begin_inset Quotes eld
11635 on Sally waking up.
11636 \begin_inset Quotes erd
11642 \begin_layout Itemize
11646 \begin_inset space \hfill{}
11650 \begin_inset Newline newline
11655 Introduces a new INTERIOR camera set-up.
11656 Always followed by DAY or NIGHT, or something similar to define the lighting
11658 Everthing on this line in CAPS.
11661 \begin_layout Itemize
11665 \begin_inset space \hfill{}
11669 \begin_inset Newline newline
11674 Introduces a new EXTERIOR camera set-up.
11675 Everthing on this line in CAPS.
11678 \begin_layout Itemize
11682 \begin_inset space \hfill{}
11686 \begin_inset Newline newline
11691 The character speaking.
11694 \begin_layout Itemize
11698 \begin_inset space \hfill{}
11702 \begin_inset Newline newline
11707 Instructions to the speaker.
11708 The () are automatically inserted, but only the ( will show in LyX.
11709 Both will be printed.
11712 \begin_layout Itemize
11716 \begin_inset space \hfill{}
11720 \begin_inset Newline newline
11732 \begin_layout Itemize
11736 \begin_inset space \hfill{}
11740 \begin_inset Newline newline
11745 Camera movement instruction.
11747 \begin_inset space \thinspace{}
11751 \begin_inset space \space{}
11757 \begin_layout Itemize
11761 \begin_inset space \hfill{}
11767 \begin_layout Itemize
11771 \begin_inset space \hfill{}
11777 \begin_layout Itemize
11781 \begin_inset space \hfill{}
11787 \begin_layout Itemize
11791 \begin_inset space \hfill{}
11797 \begin_layout Subsection
11801 \begin_layout Itemize
11805 \begin_layout Itemize
11809 \begin_layout Itemize
11811 \begin_inset space \thinspace{}
11818 \begin_layout Itemize
11823 \begin_layout Itemize
11824 PAN — camera movement
11827 \begin_layout Itemize
11828 INSERT — cut to close-up of
11831 \begin_layout Section
11835 \begin_layout Standard
11838 Panayotis Papasotiriou
11841 \begin_layout Subsection
11845 \begin_layout Standard
11846 The ijmpc package is a set of macros that facilitates electronic manuscript
11849 International Journal of Modern Physics C
11852 Similarly, the ijmpd package is for creating manuscripts to be submitted
11855 International Journal of Modern Physics D
11858 Both journals are published by World Scientific.
11859 The corresponding document classes are named
11868 These files, together with instructions for the authors, can be downloaded
11870 \begin_inset Flex URL
11873 \begin_layout Plain Layout
11875 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
11881 \begin_inset Flex URL
11884 \begin_layout Plain Layout
11886 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
11892 Both packages are modified versions of the standard
11893 \begin_inset Quotes eld
11897 \begin_inset Quotes erd
11900 package, and they are almost (but not exactly) identical.
11901 Most of their features are supported by LyX.
11902 I have used LyX successfully to write articles submitted to both journals
11903 without any problem.
11906 \begin_layout Subsection
11910 \begin_layout Standard
11911 As usual, the easiest way to write a paper is to start with a template.
11914 File\SpecialChar \menuseparator
11933 This will give an (almost) empty document that includes the most common
11934 fields found in a manuscript.
11935 Simply overwrite the existing text (including the brackets,
11940 You should keep in mind the following remarks.
11943 \begin_layout Enumerate
11944 LyX won't let you change the font size and the page style of the document,
11945 because such modifications are not allowed by both packages.
11948 \begin_layout Enumerate
11949 The language of the document should not be changed.
11950 Before previewing your paper, be sure that the babel package is not used.
11951 To do this, click on
11953 Tools\SpecialChar \menuseparator
11964 checkbox in the language settings, and click on
11972 , if you wish to make this change permanent).
11975 \begin_layout Enumerate
11977 \begin_inset Quotes eld
11981 \begin_inset Quotes erd
11984 style must be used to define keywords.
11987 \begin_layout Enumerate
11988 The ijmpc package provides a style named
11989 \begin_inset Quotes eld
11992 Classification Codes
11993 \begin_inset Quotes erd
11996 , which can be used to define classification codes, such as PACS numbers.
11997 Note that this facility is not supported by the ijmpd package.
12000 \begin_layout Enumerate
12001 Several new environments are available:
12002 \begin_inset Quotes eld
12006 \begin_inset Quotes erd
12010 \begin_inset Quotes eld
12014 \begin_inset Quotes erd
12018 \begin_inset Quotes eld
12022 \begin_inset Quotes erd
12026 \begin_inset Quotes eld
12030 \begin_inset Quotes erd
12034 \begin_inset Quotes eld
12038 \begin_inset Quotes erd
12042 \begin_inset Quotes eld
12046 \begin_inset Quotes erd
12050 \begin_inset Quotes eld
12054 \begin_inset Quotes erd
12058 \begin_inset Quotes eld
12062 \begin_inset Quotes erd
12066 \begin_inset Quotes eld
12070 \begin_inset Quotes erd
12074 \begin_inset Quotes eld
12078 \begin_inset Quotes erd
12082 \begin_inset Quotes eld
12086 \begin_inset Quotes erd
12090 \begin_inset Quotes eld
12094 \begin_inset Quotes erd
12098 \begin_inset Quotes eld
12102 \begin_inset Quotes erd
12106 \begin_inset Quotes eld
12110 \begin_inset Quotes erd
12114 Their use is more or less obvious.
12115 LyX supports all these environments; it will use the proper label, text
12116 style, and numbering scheme for each of them.
12119 \begin_layout Enumerate
12120 Both packages use basic citations; the natbib package should not be used.
12121 In LyX, citation references are shown as usual; in the output, citations
12122 are shown as superscripts.
12123 If you want to use a citation as normal text, you should use the
12128 \begin_inset space \thinspace{}
12132 \begin_inset space \space{}
12136 \begin_inset Quotes eld
12140 \begin_inset space \space{}
12150 \begin_inset Quotes erd
12156 \begin_layout Enumerate
12158 \begin_inset Quotes eld
12162 \begin_inset Quotes erd
12165 section in both packages.
12166 To put acknowledgments, just use the
12167 \begin_inset Quotes eld
12171 \begin_inset Quotes erd
12177 \begin_layout Enumerate
12178 Appendices may be added to the paper,
12182 the Acknowledgments and
12187 LyX provides a special environment, called
12188 \begin_inset Quotes eld
12192 \begin_inset Quotes erd
12195 which marks the beginning of the appendices.
12196 This environment should be left blank; it just sends a LaTeX command, but
12197 nothing is really printed.
12199 \begin_inset Quotes eld
12203 \begin_inset Quotes erd
12206 is printed with blue letters, as a signal that all sections after that
12207 point are appendices.
12208 To write an appendix, use the
12209 \begin_inset Quotes eld
12213 \begin_inset Quotes erd
12217 LyX will number each appendix with capital letters, as required by both
12220 \begin_inset Quotes eld
12224 \begin_inset Quotes erd
12231 be present before the first appendix; if not, all appendices will be numbered
12232 as normal sections in the output.
12235 \begin_layout Enumerate
12236 The ijmpc and the ijmpd packages use the
12240 command to implement table captions.
12241 As a result, a table created by LyX is printed correctly, but its caption
12243 However, you can use some TeX code to overcome this problem, so that captions
12244 are printed as expected.
12245 To do so, create a float table as usual, remove the caption, and replace
12246 it with the TeX code
12256 (sic); you must also the TeX code
12260 immediately after the tabular material.
12261 Study the example table included in the template files to see how this
12262 trick is implemented.
12263 Alternatively, If you need table captions, you should implement the whole
12268 file, then include this file to the LyX document (
12270 Insert\SpecialChar \menuseparator
12271 File\SpecialChar \menuseparator
12273 \begin_inset space ~
12279 Details on how to create a table float can be found in the files
12287 , included in the corresponding packages.
12290 \begin_layout Subsection
12291 Preparing a paper for submission
12294 \begin_layout Standard
12295 Before you submit your paper you must export the LyX document as a LaTeX
12298 File\SpecialChar \menuseparator
12299 Export\SpecialChar \menuseparator
12306 \begin_layout Plain Layout
12307 Actually you have the choice between LaTeX (plain) and pdflatex.
12308 If you intend to use pdflatex to prepare the paper, you should use the
12309 pdflatex option so that included graphics are converted to PDF format,
12310 ready for use by pdflatex.
12315 , then make the following changes to the resulting
12322 \begin_layout Enumerate
12323 Remove the comment lines before the
12332 \begin_layout Enumerate
12333 Remove everything between (and including) the
12345 commands, except for any commands you specifically put into the LaTeX preamble.
12348 \begin_layout Standard
12353 file should be saved and processed through LaTeX as many times as necessary.
12354 You may also want to check the resulting
12361 \begin_layout Subsection
12365 \begin_layout Standard
12366 The use of TeX code is reduced to two commands, which must be placed at
12367 the top of the document.
12368 If you started writing your paper by using the
12376 template, the TeX code needed is already in its place; you usually don't
12378 You may only modify the first TeX code to specify the information printed
12379 to the top of odd and even pages (authors' names and short paper's title,
12381 This TeX code must have the form
12385 markboth{Authors' Names}{Short Paper's Title}
12390 \begin_layout Section
12394 \begin_layout Standard
12400 \begin_layout Subsection
12404 \begin_layout Standard
12405 The iopart package provides a document class to create electronic manuscript
12406 submission to the journals published by the Institute of Physics.
12407 Instructions for the authors how to create a paper using the iopart class
12408 can be downloaded together with the iopart package from the site
12409 \begin_inset Flex URL
12412 \begin_layout Plain Layout
12414 ftp://ftp.iop.org/pub/journals/latex2e
12422 \begin_layout Subsection
12426 \begin_layout Standard
12427 The easiest way to write a paper is to start with the file
12431 that is available in LyX's examples files folder.
12432 Open this file, save it under a new name, and start writing.
12433 The example file explains how to use the special text environments.
12434 Here are the most important advices:
12437 \begin_layout Itemize
12438 To be able to compile your document to a PDF, PS, or DVI, ensure that the
12441 Use AMS math package
12443 in the document settings under
12450 \begin_layout Itemize
12453 The title environment defines the kind of your paper.
12454 So use one of the following environments for the title:
12458 \begin_layout Itemize
12467 \begin_layout Itemize
12476 \begin_layout Itemize
12482 for a Topical review
12485 \begin_layout Itemize
12494 \begin_layout Itemize
12503 \begin_layout Itemize
12509 for a Paper (same as Title)
12512 \begin_layout Itemize
12518 for a Preliminary communication
12521 \begin_layout Itemize
12527 for a Rapid communication
12530 \begin_layout Itemize
12536 for a Letter to the editor
12540 \begin_layout Itemize
12543 All title environments except of
12547 can have an optional short title.
12550 \begin_layout Itemize
12551 There is a general title environment
12555 which is not directly supported by the LyX.
12556 This can be used as TeX code when your document doesn't fit into one of
12557 the other title types.
12560 \begin_layout Standard
12561 For more informations like hints for special table and formula formatting,
12562 look at the IOP author guidelines.
12565 \begin_layout Section
12569 \begin_layout Standard
12572 Panayotis Papasotiriou
12575 \begin_layout Subsection
12579 \begin_layout Standard
12580 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
12581 that facilitates electronic manuscript submission to the journals they
12583 Most known of them (at least in my domain of interest) are
12585 Astrophysics and Space Science
12591 , but there are many others (see a complete list at
12592 \begin_inset Flex URL
12595 \begin_layout Plain Layout
12597 http://www.wkap.nl/jrnllist.htm/JRNLHOME
12603 The Kluwer package may be downloaded from the site
12604 \begin_inset Flex URL
12607 \begin_layout Plain Layout
12609 http://www.wkap.nl/kaphtml.htm/STYLEFILES
12615 A complete user guide is contained in that package (but it can also be
12616 downloaded separately).
12619 \begin_layout Standard
12620 LyX supports many features of the package but not everything.
12621 However, the TeX code needed is reduced to some
12622 \begin_inset Quotes eld
12626 \begin_inset Quotes erd
12629 commands of the package (see
12630 \begin_inset space ~
12634 \begin_inset CommandInset ref
12636 reference "subsec:kluwer_peculiarities"
12641 I have recently used LyX to write an article submitted to the
12643 Astrophysics and Space Science
12645 without any problem.
12648 \begin_layout Subsection
12652 \begin_layout Standard
12653 The easiest way to write a paper is to start with the Kluwer template file.
12656 File\SpecialChar \menuseparator
12668 This will give an (almost) empty document that includes the most common
12669 fields found in a manuscript and a short description of their use.
12670 As in most templates, simply overwrite the existing text (including the
12675 ) with the correct information.
12678 \begin_layout Subsection
12679 Preparing a paper for submission
12682 \begin_layout Standard
12683 As in the AASTeX package, before you submit your paper to a journal you
12685 \begin_inset Quotes eld
12689 \begin_inset Quotes erd
12695 \begin_layout Enumerate
12696 Export your paper as a LaTeX file.
12697 To do this, click on
12699 File\SpecialChar \menuseparator
12700 Export\SpecialChar \menuseparator
12707 \begin_layout Enumerate
12712 file with a text editor and make the following changes
12716 \begin_layout Enumerate
12717 remove the comment lines before the
12726 \begin_layout Enumerate
12727 remove everything between (and including) the
12739 commands, except for any commands you specifically put into the LaTeX preamble.
12742 \begin_layout Standard
12751 \begin_layout Enumerate
12756 file through LaTeX as many times as necessary (usually up to three).
12759 \begin_layout Enumerate
12765 \begin_inset space \thinspace{}
12769 \begin_inset space \space{}
12776 , and check if everything is OK (it should, if you didn't make any mistake).
12779 \begin_layout Subsection
12780 \begin_inset Quotes eld
12784 \begin_inset Quotes erd
12787 of the Kluwer package
12788 \begin_inset CommandInset label
12790 name "subsec:kluwer_peculiarities"
12797 \begin_layout Standard
12798 The Kluwer package has the following
12799 \begin_inset Quotes eld
12803 \begin_inset Quotes erd
12809 \begin_layout Enumerate
12810 It is possible to write multiple articles in the same LaTeX file
12814 \begin_layout Plain Layout
12815 I can't imagine any good reason to do this.
12821 Each article must be included in the environment
12822 \begin_inset Quotes eld
12826 \begin_inset Quotes erd
12830 Unfortunately, this environment cannot be omitted, even if you write just
12832 Therefore, each article starts with the command
12838 and, obviously, ends with the command
12845 Although this can be implemented in LyX, I didn't included it, since it
12846 looks ugly and can confuse the novice user.
12847 Therefore, you need to enter them directly and mark them as LaTeX code
12849 \begin_inset Quotes eld
12853 \begin_inset Quotes erd
12859 \begin_layout Enumerate
12860 Information given at the beginning of the article (i.
12861 \begin_inset space \thinspace{}
12865 \begin_inset space \space{}
12868 title, subtitle, author, institution, running title, running author, abstract
12869 and keywords) must be included in an environment called
12870 \begin_inset Quotes eld
12874 \begin_inset Quotes erd
12878 This is not implemented in LyX, so you must enter title, subtitle etc.
12879 \begin_inset space ~
12882 between two TeX code lines (
12897 \begin_layout Enumerate
12898 According to the user manual, the label of each bibliography item must be
12922 \begin_layout Standard
12927 template takes care of all these
12928 \begin_inset Quotes eld
12932 \begin_inset Quotes erd
12936 If you start a new paper using this template you don't need to do anything
12941 \begin_layout Enumerate
12942 don't delete the TeX code included in the template, and
12945 \begin_layout Enumerate
12946 copy the example bibliography item included in the template and modify it
12947 as necessary to enter new bibliography items.
12950 \begin_layout Section
12954 \begin_layout Standard
12960 \begin_layout Subsection
12964 \begin_layout Standard
12965 The LyX document classes
12967 article (koma-script)
12971 report (koma-script)
12989 correspond to the LaTeX document classes
13006 \begin_inset space ~
13009 of the Koma-Script family.
13010 They are replacements for the standard document classes
13026 , resp., and fit better to European typography conventions in a number of
13030 \begin_layout Itemize
13031 Standard character size is 11pt in
13033 article (koma-script)
13037 report (koma-script)
13045 letter (koma-script)
13050 \begin_layout Itemize
13051 Headings, labels of the description environment, and a number of elements
13054 letter (koma-script)
13056 document class are set in a bold sans serif font.
13060 \begin_layout Plain Layout
13061 There is a big difference between the bold sans serif old cm fonts and new
13062 ec fonts, especially in the appearance of headings.
13063 In comparison, the ec bold sans serif fonts look a bit thin.
13064 Here the LaTeX package
13072 helps to produce the
13073 \begin_inset Quotes eld
13077 \begin_inset Quotes erd
13080 appearance when using the ec fonts.
13085 The numbering of chapter headings is made in the same way as the numbering
13086 of section headings, that is without the extra line
13087 \begin_inset Quotes eld
13090 Chapter\SpecialChar \ldots{}
13092 \begin_inset Quotes erd
13096 In addition, the appearance of the headings can be modified by using a
13097 number of options (in LyX to be entered in the field
13100 \begin_inset space ~
13107 Layout\SpecialChar \menuseparator
13114 \begin_layout Itemize
13115 The main means in the Koma-Script document classes to design the type area
13124 (in LyX to be entered in the extra class options field in the dialog
13126 Document\SpecialChar \menuseparator
13130 They make a clearer modification of page margins possible as do the options
13133 Document\SpecialChar \menuseparator
13140 \begin_layout Itemize
13141 The LaTeX document classes of the Koma-Script family define a number of
13142 additional commands.
13143 Those part of it which makes sense in LyX is implemented in corresponding
13147 \begin_layout Standard
13148 Detailed descriptions of the LaTeX document classes of the Koma-Script family
13149 can be found in the Koma-Script documentation
13160 \begin_layout Subsection
13161 article (koma-script), report (koma-script), and book (koma-script)
13164 \begin_layout Standard
13165 The document classes
13167 article (koma-script)
13171 report (koma-script)
13181 are implemented in the layout files
13194 They contain all the paragraph types of the corresponding standard document
13207 , resp., partly modified, with the exception of the LyX specific
13211 -type, which is replaced by the new
13215 -type having the same functionality.
13220 -Type there is a number of new paragraph types added.
13227 letter (koma-script)
13232 \begin_layout Itemize
13241 : are equivalents to
13249 , resp., additionally inserting an entry in the table of contents.
13258 are not contained in
13260 article (koma-script)
13265 \begin_layout Itemize
13274 : behave exactly as
13282 , resp., additionally clearing running heads.
13287 is not contained in
13289 article (koma-script)
13295 \begin_layout Plain Layout
13308 report (koma-script)
13310 , but since this is identical to
13314 , is has not been implemented in LyX.
13322 \begin_layout Itemize
13327 : generates a heading directly above the following paragraph in the standard
13328 character size without affecting the structure of the document.
13331 \begin_layout Itemize
13340 are special captions which respect the different space settings needed
13341 for captions placed above or below an element (if you follow strict typographic
13342 rules, you might want to place table captions always above the table).
13343 You can also use the class option
13347 , which will switch
13360 You need at least Koma-Script version 2.8q to use this.
13363 \begin_layout Itemize
13368 : can be used to set a bonmot, e.
13369 \begin_inset space \thinspace{}
13373 \begin_inset space \space{}
13376 at the beginning of a chapter.
13377 If you use the optional argument (
13379 Insert\SpecialChar \menuseparator
13381 \begin_inset space ~
13386 ), you can insert the dictum's author there.
13387 Dictum and author are separated by a line.
13388 You need at least Koma-Script version 2.8q to use this.
13393 is not contained in
13395 article (koma-script)
13400 \begin_layout Standard
13401 The following types, together with the standard types
13413 , form the title area of the document.
13414 They must be entered ahead of the first
13415 \begin_inset Quotes eld
13419 \begin_inset Quotes erd
13426 \begin_layout Plain Layout
13427 The corresponding LaTeX commands must appear before the
13438 When such a type is used more than once, the latter usage overwrites the
13439 former one, that means, for every type only the latest usage is valid.
13440 The order of the different types however has, like
13452 , no effect on the appearance of the produced document.
13455 \begin_layout Itemize
13460 : produces a centered paragraph above the ordinary title (
13472 ) for the subject of the document.
13475 \begin_layout Itemize
13480 : produces a centered paragraph below the ordinary title (
13492 ) for the publishers' name.
13495 \begin_layout Itemize
13502 report (koma-script)
13508 produces a centered paragraph on its own page behind the title page, or
13511 article (koma-script)
13513 produces a centered paragraph below the ordinary title (
13529 ) for a dedication.
13532 \begin_layout Itemize
13537 : produces a left aligned paragraph above the ordinary title (
13553 ) for a document`s head.
13556 \begin_layout Itemize
13561 : produces in a double-sided print in
13563 report (koma-script)
13569 a left-aligned paragraph at the top of the title page`s back or has no
13570 effect in a single-sided print or in
13572 article (koma-script)
13577 \begin_layout Itemize
13582 : produces in a double-sided print in
13584 report (koma-script)
13590 a left-aligned paragraph at the bottom of the title page`s back or has
13591 no effect in a single-sided print or in
13593 article (koma-script)
13598 \begin_layout Itemize
13603 : produces a special
13604 \begin_inset Quotes eld
13608 \begin_inset Quotes erd
13611 page ahead of the actual document containing a paragraph without special
13615 \begin_layout Standard
13616 The layout files for the document classes
13618 article (koma-script)
13622 report (koma-script)
13628 do include the file
13633 This is thought of as a place to define your own types.
13638 in your personal layout directory and edit the file!
13641 \begin_layout Subsection
13642 letter (koma-script)
13645 \begin_layout Standard
13649 letter (koma-script)
13651 is implemented in the layout file
13656 It contains all the paragraph types of the corresponding standard document
13661 , partly modified, with the exception of the LyX specific types
13673 type, which is replaced by the new
13678 In addition, it contains, in contrast to the standard document class, the
13696 Furthermore, there are a number of new letter specific types.
13699 \begin_layout Standard
13700 The appearance of the letter produced by this document class can be controlled
13701 by a number of LaTeX commands, which you can put in the LaTeX preamble.
13705 \begin_layout Plain Layout
13706 For example, the standard appearance of the letter`s heading, consisting
13707 of name and address, is quite self-willed.
13709 \begin_inset Quotes eld
13713 \begin_inset Quotes erd
13716 heading is produced by the following LaTeX commands in the preamble:
13719 \begin_layout LyX-Code
13729 \begin_layout LyX-Code
13745 \begin_layout LyX-Code
13755 \begin_layout LyX-Code
13775 A detailed German description of such LaTeX commands can be found in the
13776 Koma-Script documentation
13781 With it, the letter's author can produce his personal letter layout.
13784 \begin_layout Standard
13793 define the beginning of the letter and must be used in every letter.
13794 To emphasize them in the LyX document class, they are marked with the letter
13804 \begin_inset space ~
13807 in the left margin.
13808 It is possible to write any number of letters in one file.
13813 type produces a new letter using the same addressee and a
13817 type produces a new addressee.
13834 are ordinary paragraph types and can also be used several times in one
13835 and the same letter.
13838 \begin_layout Itemize
13843 : produces a paragraph for the addressee and implicitly defines the beginning
13847 \begin_layout Itemize
13852 : produces a paragraph for the form of address and implicitly produces a
13856 \begin_layout Itemize
13861 : produces a paragraph for a close.
13864 \begin_layout Itemize
13869 : produces a paragraph for a postscript.
13872 \begin_layout Itemize
13877 : produces a paragraph for a distribution list.
13880 \begin_layout Itemize
13885 : produces a paragraph for enclosures.
13888 \begin_layout Standard
13929 are input types provided with a label to enter information, which will
13930 be processed by the document class.
13934 \begin_layout Plain Layout
13935 It could be seen as a matter of inconsequence, that the types
13943 described above are not such input types as well.
13944 Because of the special meaning of those types, however, I have implemented
13945 them as ordinary paragraph types with a one letter mark in the left margin.
13946 Moreover, it would affect my feeling of symmetry, if the
13954 type had such a serious different appearance.
13959 The types must be used ahead of the corresponding
13966 \begin_layout Standard
13967 An implementation of these types in a WYSIWYG fashion does not seem to make
13968 sense, because the real appearance of the produced letter does not only
13969 depend on the usage of the particular type, but also on other factors.
13970 For example, a signature entered in the
13974 type will in the standard behavior appear in the produced letter only,
13975 when in the same letter also a
13980 The entered value of the
13984 type will in the standard behavior not appear in the produced letter at
13986 The possibility to design the letter`s heading freely is already indicated
13987 in a footnote above.
13990 \begin_layout Standard
13991 The input types can also be used as empty paragraphs.
13992 This makes sense e.
13993 \begin_inset space \thinspace{}
13997 \begin_inset space \space{}
14009 type is not used at all, in the standard behavior the value of the
14013 type is used as signature, whereas if an empty
14017 type is used, no signature value is defined.
14020 \begin_layout Standard
14021 By using the input types it is possible to write a letter template, containing
14022 filled input types with your personal dates (name, address, etc.) and empty
14023 input types for other dates you want to enter.
14026 \begin_layout Itemize
14031 : sender's name, in the standard behavior appears as a centered paragraph
14032 in small caps in the letter`s heading.
14035 \begin_layout Itemize
14040 : sender's signature, in the standard behavior appears below the
14049 type is used, the value of the
14053 type appears instead.
14056 \begin_layout Itemize
14061 : sender's address, in the standard behavior appears in a centered paragraph
14062 in the letter`s heading below the sender's name.
14065 \begin_layout Itemize
14070 : sender's telephone number, in the standard behavior only sets the LaTeX
14080 \begin_layout Itemize
14085 : place of the letter`s making.
14088 \begin_layout Itemize
14093 : date of the letter`s making.
14102 , in the standard behavior, produce the place and the date in a right-aligned
14103 line below the addressee's field.
14108 type is used, neither place nor date appear, independent of the value of
14118 type is used, the date of the letter `s production is used.
14121 \begin_layout Itemize
14126 : sender`s back address, in the standard behavior appears above the addressee's
14127 field in a small sans serif font.
14130 \begin_layout Itemize
14135 : special mail information, in the standard behavior appears underlined
14136 above the addressee's field below the back address.
14139 \begin_layout Itemize
14144 : additional information, in the standard behavior appears on right side
14145 below the addressee`s field.
14148 \begin_layout Itemize
14153 : the letter's title, in the standard behavior appears in a big, bold, sans
14154 serif font above the subject.
14157 \begin_layout Itemize
14162 : the letter's subject, in the standard behavior appears in a bold font
14170 \begin_layout Standard
14191 produce a business letter like line above the
14195 line containing the fields
14196 \begin_inset Quotes eld
14200 \begin_inset Quotes erd
14204 \begin_inset Quotes eld
14208 \begin_inset Quotes erd
14212 \begin_inset Quotes eld
14216 \begin_inset Quotes erd
14220 \begin_inset Quotes eld
14224 \begin_inset Quotes erd
14228 \begin_inset Quotes eld
14232 \begin_inset Quotes erd
14236 \begin_inset Quotes eld
14240 \begin_inset Quotes erd
14244 For the date field, the value of the
14250 \begin_inset Quotes eld
14253 business letter types
14254 \begin_inset Quotes erd
14257 is used, the value of the
14261 type however does not appear, but only the LaTeX variable
14268 The ordinary output of place and date in a right-aligned line below the
14269 addressee`s field is suppressed.
14270 The types are implemented as input types provided with a label and must
14271 be used ahead of the corresponding
14278 \begin_layout Itemize
14286 \begin_layout Itemize
14294 \begin_layout Itemize
14302 \begin_layout Itemize
14310 \begin_layout Itemize
14318 \begin_layout Subsection
14319 The new letter class: letter (koma-script v.2)
14322 \begin_layout Standard
14328 \begin_layout Standard
14329 \begin_inset VSpace medskip
14335 \begin_layout Standard
14337 Koma-Script version 2.8 has introduced a new letter class
14341 which supersedes the now unsupported
14346 It has — on the LaTeX side — a completely new interface and is not compatible
14347 with the old class.
14348 Therefore, LyX supports both, though it is recommended you use the new
14352 \begin_layout Standard
14353 This class covers the same functionality as
14355 letter (koma-script),
14358 The basic items are
14362 (receiver's address, same as
14366 in the old layout),
14379 will start a new letter (i.
14380 \begin_inset space \thinspace{}
14384 \begin_inset space \space{}
14387 you can write several letters per document).
14388 New elements are sender's
14404 and the possibility to use a
14410 Insert\SpecialChar \menuseparator
14416 \begin_layout Standard
14417 The biggest improvement is, though, that the letter's layout is configurable
14418 to meet almost any needs.
14419 This can be done via the preamble or with a special style file (Letter
14420 Class Option, extension
14424 ), that will be read in as a class option.
14428 \begin_layout Plain Layout
14429 The KOMA package comes with some default
14434 There is, for instance, a
14438 file that follows german typesetting rules, or a
14442 that provides the default layout of the old
14447 The latter can be loaded with the class option
14456 ayout\SpecialChar \menuseparator
14461 ocument\SpecialChar \menuseparator
14473 template that is included in LyX for examples.
14474 A detailed description is to be found in the Koma-Script documentation
14482 \begin_layout Subsection
14486 \begin_layout Standard
14487 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
14491 \begin_layout Itemize
14492 The chapter number of a
14496 type appears on a line of its own above the chapter heading instead of
14497 appearing in the same line ahead of it.
14498 The cause for that is the LyX internal behavior for the labeltype
14502 in the layout file.
14505 \begin_layout Itemize
14506 The headings of the types
14514 are only put in the
14515 \begin_inset Quotes eld
14519 \begin_inset Quotes erd
14522 LaTeX table of contents, but not in the LyX table of contents (
14524 Document\SpecialChar \menuseparator
14526 \begin_inset space ~
14530 \begin_inset space ~
14538 \begin_layout Itemize
14539 The paragraphs in a
14543 document class appear in a skip separation mode, not indented.
14544 This is the standard behavior, no special LaTeX commands are needed for
14548 Document\SpecialChar \menuseparator
14551 dialog the corresponding radio button indicates
14560 value always has the effect that extra LaTeX commands are inserted in the
14561 document to produce the gap, which is not what is wanted in this case.
14564 \begin_layout Section
14568 \begin_layout Standard
14574 \begin_layout Subsection
14578 \begin_layout Standard
14579 Memoir is a very powerful and constantly evolving class.
14580 It has been designed with regard to fictional and non-fictional literature.
14581 Its aim is to let the user have maximum control over the typesetting of
14583 Memoir is based on the standard book class, but it can also emulate the
14584 article class (see below).
14587 \begin_layout Standard
14588 Peter Wilson, the developer of Memoir, is known as the author of lots of
14589 useful packages in the LaTeX world.
14590 Most of them have been merged with Memoir.
14591 Therefore, it is much easier to layout the table of contents, appendices,
14592 chapter designs and such.
14593 LyX, though, does not support all of these goodies natively.
14594 Some of them might be added to forthcoming releases
14598 \begin_layout Plain Layout
14599 You are invited to send suggestions to
14600 \begin_inset Flex URL
14603 \begin_layout Plain Layout
14605 lyx-devel@lists.lyx.org
14615 , lots will probably never be supported, due to the limitations of LyX's
14617 Of course you can still use all features with the help of some native LaTeX
14622 \begin_layout Plain Layout
14627 \begin_layout Plain Layout
14637 \begin_inset space ~
14641 \begin_inset CommandInset ref
14643 reference "sec:Inserting-TeX-Code"
14653 In this section, we can only list those features that are natively supported
14655 For detailed descriptions (and for the rest of features) we recommend you
14656 have a look at the detailed manual of the Memoir class
14660 \begin_layout Plain Layout
14665 \begin_layout Plain Layout
14675 \begin_inset Flex URL
14678 \begin_layout Plain Layout
14680 CTAN:/macros/latex/memoir/memman.pdf
14690 , which is not only a user guide for the class, but also both a comprehensive
14691 description on good typesetting and a superb example for good typesetting
14695 \begin_layout Subsection
14696 Basic features and restrictions
14699 \begin_layout Standard
14700 Memoir supports basically all features of the standard book classes.
14701 There are, however, some differences, as follows:
14704 \begin_layout Description
14706 \begin_inset space ~
14709 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
14712 \begin_layout Description
14714 \begin_inset space ~
14717 style: The fancy page style is not supported, due to a command clash between
14718 Memoir and the fancyhdr package (they both define a command with the same
14719 name, which confuses LaTeX).
14720 Instead, Memoir comes with a number of its own page styles (see
14722 Layout\SpecialChar \menuseparator
14723 Document\SpecialChar \menuseparator
14725 \begin_inset space ~
14731 If you want to use these for the chapter pages, you have to use the command
14738 in the main text or in preamble (e.
14739 \begin_inset space \thinspace{}
14743 \begin_inset space \space{}
14750 chapterstyle{companion}
14755 \begin_layout Description
14756 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
14757 optional argument in the standard classes.
14758 With this, you can specify an alternative version of the title for the
14759 table of contents and the headers (for instance, if the title is too long).
14760 In LyX, you can do this via
14762 Insert\SpecialChar \menuseparator
14764 \begin_inset space ~
14769 at the beginning of a chapter/section.
14770 Memoir features a second optional argument and thus separates the table
14771 of contents from the header.
14772 You can define three variants of a title with this: one for the main text,
14773 one for the table of contents, and one for the headers.
14774 Simply insert two optional arguments if you need this feature, the first
14775 one containing the short title for the Table of Contents, the second one
14776 containing an alternative short title for the headers.
14779 \begin_layout Description
14780 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14781 of contents, the list of figures and the list of table start a new page
14783 Memoir does not follow this route.
14784 You have to insert a page break yourself, if you want to have one.
14787 \begin_layout Description
14788 Titlepage: For some unknown reason, Memoir uses pagination on the title
14789 page (in the standard classes, title pages are
14790 \begin_inset Quotes eld
14794 \begin_inset Quotes erd
14798 If you want an empty title page, type
14802 aliaspagestyle{title}{empty}
14807 \begin_layout Description
14808 Article: With the class option
14814 Layout\SpecialChar \menuseparator
14815 Document\SpecialChar \menuseparator
14817 \begin_inset space ~
14822 ), you can emulate article style.
14823 That is, counters (footnotes, figures, tables etc.) will not be reset on
14824 new chapters, chapters don't start a new page (but are—in contrary to
14825 \begin_inset Quotes eld
14829 \begin_inset Quotes erd
14832 article classes—still allowed), parts, though, use their own page, as in
14836 \begin_layout Description
14837 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14838 font commands, which have been used in the old LaTeX version 2.09 (e.
14839 \begin_inset space \thinspace{}
14843 \begin_inset space \space{}
14859 It produces an error and stops LaTeX whenever such a command appears.
14864 reallows the commands and spits out warnings instead (which does at least
14866 Since a lot of packages and particularly BibTeX style files are still using
14867 those commands, we have decided to use this option by default.
14870 \begin_layout Subsection
14874 \begin_layout Standard
14875 We will only describe the features supported by LyX (which is not much currently
14877 Please consult the Memoir manual
14881 \begin_layout Plain Layout
14886 \begin_layout Plain Layout
14896 \begin_inset Flex URL
14899 \begin_layout Plain Layout
14901 CTAN:/macros/latex/memoir/memman.pdf
14914 \begin_layout Description
14915 Abstract: You may wonder why an abstract is an extra feature.
14916 Well, it is in book class.
14917 Usually books don't have abstracts.
14918 Memoir, however, has.
14919 You can use it wherever and how often you like.
14922 \begin_layout Description
14923 Chapterprecis: You may know this older typesetting style: The contents of
14924 a chapter are summarized below the title and also in the table of contents
14926 \begin_inset space \thinspace{}
14930 \begin_inset space \space{}
14935 Our hero arrives in Troia; he loses some friends; he finds others
14938 Chapterprecis does exactly this.
14939 It is therefore only sensible below a chapter.
14942 \begin_layout Description
14943 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14944 The epigraph environment provides an elegant way of typesetting such a
14946 The motto itself (text) and its author (source) are divided by a short
14948 Unfortunately, we have to fool LyX a bit here again, since the environment
14949 needs two arguments (text and source).
14950 In this case, we have to use curly brackets (in TeX mode) between the two
14961 <author of the slogan>.
14964 \begin_layout Description
14965 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14966 complex figurative poems).
14967 LyX can only support a few of them.
14968 One is poemtitle, which is a centered title for poems, which will also
14969 be added to the table of contents (verse is the standard environment for
14971 Memoir has some enhanced versions of verse, but you need to use TeX code,
14972 because they have to be nested inside regular verse environments, which
14973 is not possible with LyX).
14976 \begin_layout Description
14977 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14980 \begin_layout Section
14981 Article (mwart), book (mwbk) and report (mwrep)
14982 \begin_inset Argument
14985 \begin_layout Plain Layout
14998 \begin_layout Standard
15004 \begin_layout Standard
15005 The LyX document classes
15021 correspond to the LaTeX document classes
15034 They are replacements for the standard document classes
15046 , resp., and fit better to Polish typography conventions in a number of points.
15050 \begin_layout Standard
15054 \begin_layout Itemize
15055 Unnumbered titles (with star, e.
15056 \begin_inset space \thinspace{}
15060 \begin_inset space \space{}
15067 ) are added into table of contents,
15070 \begin_layout Itemize
15071 Additional page styles:
15075 \begin_layout Description
15076 uheadings header with separated lines,
15079 \begin_layout Description
15080 myheadings custom header, contents headers via commands:
15095 \begin_layout Description
15096 myuheadings custom header with separated lines,
15099 \begin_layout Description
15100 outer page number is placed on outer side of page
15104 \begin_layout Itemize
15109 \begin_layout Description
15110 rmheadings serif titles — default,
15113 \begin_layout Description
15114 sfheadings sansserif titles,
15117 \begin_layout Description
15118 authortitle on title page first placed is author next title — default,
15121 \begin_layout Description
15122 titleauthor on title page first placed is title next author,
15125 \begin_layout Description
15126 withmarginpar reserve place on page for margins.
15130 \begin_layout Section
15134 \begin_layout Standard
15139 provides an alternative to the standard
15144 It provides similar functionality, but you might prefer this layout with
15145 sans serif sections, headings, and more.
15148 \begin_layout Section
15152 \begin_layout Standard
15158 \begin_layout Standard
15159 \begin_inset VSpace bigskip
15165 \begin_layout Standard
15170 \begin_inset space ~
15175 textclass works with the American Physical Sociey's RevTeX 4.0 (the
15176 \begin_inset Formula $\beta$
15179 release of May, 1999) class.
15182 \begin_layout Standard
15187 textclass, which works with RevTeX 3.1.
15188 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
15189 That means that it doesn't interact very well with LyX, which requires
15190 LaTeX2e, although it has been kludged to work.
15191 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
15195 \begin_inset space ~
15200 textclass should also be pretty easy to use.
15203 \begin_layout Standard
15204 These documents are supposed to be used in
15208 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
15209 macros, and assume you'll know what to put in the preamble if necessary.
15212 \begin_layout Subsection
15216 \begin_layout Standard
15217 All you need to do is install RevTeX 4, as described in the package's README
15219 The package can be found at The RevTeX 4 Web Site
15220 \begin_inset Flex URL
15223 \begin_layout Plain Layout
15225 http://publish.aps.org/revtex4/
15231 Install it somewhere that LaTeX can see it.
15232 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
15234 \begin_inset space \thinspace{}
15238 \begin_inset space \space{}
15241 not the directory where you installed the class file.) Then, if you reconfigure
15242 LyX, it will find the class file and let you use the RevTeX4 textclass.
15245 \begin_layout Standard
15246 Probably the easiest way to get started is either to import a RevTeX 4 document
15254 \begin_inset space ~
15259 template, found in the templates directory.
15262 \begin_layout Subsection
15266 \begin_layout Standard
15267 Optional arguments to
15274 \begin_inset Quotes eld
15278 \begin_inset Quotes erd
15282 \begin_inset Quotes eld
15286 \begin_inset Quotes erd
15296 \begin_inset space ~
15304 \begin_inset space ~
15310 Remember that in RevTeX, at least one optional argument is required!
15313 \begin_layout Standard
15314 Other preamble matter, like
15321 \begin_inset space ~
15327 \begin_inset space ~
15332 dialog, also as usual.
15335 \begin_layout Subsection
15339 \begin_layout Standard
15340 The layouts basically correspond to the commands in RevTeX4.0.
15341 For example, the Email layout corresponds to
15348 Note that (at least as of RevTeX 4.0 Beta), the
15356 layouts are exactly equivalent, so you shouldn't need to use both.
15360 \begin_layout Plain Layout
15361 In case you're curious, both were included so that
15365 would be able to translate both
15385 \begin_layout Subsection
15389 \begin_layout Standard
15390 There are a couple of important unique aspects of RevTeX 4 which might cause
15391 bugs that will be even more confusing in LyX.
15394 \begin_layout Standard
15412 The LyX equivalent is that there is a separate Thanks layout.
15417 write footnotes in the
15421 layout, or weird things may happen.
15422 See the RevTeX 4 documentation for more details.
15425 \begin_layout Standard
15429 \begin_inset space ~
15437 \begin_inset space ~
15446 layouts must be placed
15454 layout and the corresponding
15471 , the LaTeX won't compile.
15474 \begin_layout Subsection
15478 \begin_layout Standard
15479 The main problem with this layout is that you can't use the optional arguments
15480 to layouts like Email and Title.
15481 (The problem is not unique to this layout; you can't use optional arguments
15482 to the Section layouts either.) This means that after you export that file
15483 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
15484 need to edit the LaTeX file with a text editor to add the optional arguments
15486 \begin_inset space \thinspace{}
15490 \begin_inset space \space{}
15493 the running title for the page headers.
15494 Lacking these layouts makes the
15500 (and the equivalent
15506 ) useless, so the corresponding layouts don't exist, and will have to be
15511 \begin_layout Plain Layout
15516 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
15517 has not been updated yet to take advantage of it.
15525 \begin_layout Section
15526 Springer Journals (
15533 \begin_layout Standard
15539 \begin_layout Subsection
15543 \begin_layout Standard
15544 These are the layout files for some of the journal formats used by Springer
15545 Verlag and listed on
15546 \begin_inset Flex URL
15549 \begin_layout Plain Layout
15551 http://www.springer.de/author/tex/help-journals.html
15556 , where you should also go to fetch the class files (yes, these are LaTeX2e
15558 It is a modular system: the things common to all journals are implemented
15563 , which journal-specific layout files (such as, e.
15564 \begin_inset space \thinspace{}
15568 \begin_inset space \space{}
15575 for Journal of Geodesy) can include.
15578 \begin_layout Standard
15579 This means that implementing support for any other Springer journal on this
15580 list is as simple as writing your own
15588 file following the outline given in
15596 \begin_layout Standard
15597 It is reasonably well tested only for the Journal of Geodesy.
15606 come with the standard LyX distribution.
15607 Install the relevant class file (downloaded from Springer) in a proper
15608 directory, reconfigure LaTeX (in the teTeX case by running
15612 , as root if necessary — doesn't LyX take care of this?), reconfigure LyX
15613 and it should work.
15616 \begin_layout Subsection
15620 \begin_layout Standard
15621 A large number of theorem-like styles —
15627 \SpecialChar \ldots{}
15633 \begin_layout Standard
15636 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
15637 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
15640 See the Springer class file documentation for details.
15643 \begin_layout Subsection
15647 \begin_layout Itemize
15659 \begin_layout Itemize
15662 Probability Theory and Related Fields
15668 — Jean-Marc Lasgouttes
15671 \begin_layout Standard
15672 Add your own, it isn't so hard!
15675 \begin_layout Subsection
15679 \begin_layout Standard
15680 These files are partly based on the older
15684 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
15685 file from Springer.
15690 layout, are now defunct.
15691 Jean-Marc Lasgouttes helped out big in making me find my way around the
15692 LyX layout file mechanism.
15695 \begin_layout Subsection
15699 \begin_layout Standard
15701 But probably less than in the old hacked-LaTeX
15708 \begin_layout Standard
15710 \begin_inset space \thinspace{}
15713 g.: does not display the number for theorem-like layouts, just #.
15716 \begin_layout Section
15722 \begin_inset CommandInset label
15731 \begin_layout Standard
15739 \begin_layout Subsection
15743 \begin_layout Standard
15744 This section describes how to use LyX to make slides for overhead projectors.
15745 There are two document classes that can do this: the default slides class
15751 This section documents the former.
15754 \begin_layout Standard
15755 I'm going to say this again, nice and clear, so that there's no misunderstanding
15759 \begin_layout Standard
15760 \begin_inset VSpace bigskip
15766 \begin_layout Standard
15770 This section documents the class
15771 \begin_inset Quotes eld
15779 \begin_inset Quotes erd
15787 \begin_layout Standard
15788 \begin_inset VSpace bigskip
15794 \begin_layout Standard
15795 If you're looking for the documentation for
15796 \begin_inset Quotes eld
15804 \begin_inset Quotes erd
15807 , check out section
15808 \begin_inset space ~
15812 \begin_inset CommandInset ref
15814 reference "sec:foiltex"
15824 \begin_inset Quotes eld
15832 \begin_inset Quotes erd
15835 ] is actually somewhat better than the default
15843 \begin_layout Plain Layout
15844 \SpecialChar \ldots{}
15845 or so I've been told repeatedly by its advocates.
15846 Having never used it, I have no idea if this claim is true or not.
15851 which this section documents.
15854 \begin_layout Standard
15855 This class is the LaTeX2e improvement of the old
15860 Every LaTeX2e distribution includes this class [which I'll just refer to
15862 \begin_inset Quotes eld
15870 \begin_inset Quotes erd
15873 from now on], so you're bound to have it.
15874 As I noted earlier, there are other classes, such as
15878 , which also produce slides for overhead projectors and do a better job
15880 However, there are some things which
15884 can do which the others can't, such as generate overlays.
15885 Read on to learn more!
15888 \begin_layout Subsection
15890 \begin_inset CommandInset label
15892 name "sec:slidesetup"
15899 \begin_layout Standard
15900 Obviously, to use this document class, you need to select
15901 \begin_inset Quotes eld
15909 \begin_inset Quotes erd
15912 from the class list in the
15914 Document\SpecialChar \menuseparator
15918 There are some other special things you should know about this class:
15921 \begin_layout Itemize
15922 Don't bother changing the options
15927 They're not supported by the
15934 \begin_layout Itemize
15938 \begin_inset space ~
15943 behaves a bit differently for this class.
15944 The possible choices and what they do are as follows:
15948 \begin_layout Description
15953 The final output contains page numbers in the lower right corner.
15956 \begin_layout Description
15965 , but also prints out any time markers you've put in.
15966 This is the default.
15969 \begin_layout Description
15974 The final output contains no page numbers, time markers, or alignment markers.
15978 \begin_layout Itemize
15983 class has an extra option:
15989 \begin_inset Quotes eld
15997 \begin_inset Quotes erd
16000 in the extra class options.
16004 \begin_layout Standard
16005 Using this options allows you to add time markers to
16011 \begin_inset space ~
16015 \begin_inset CommandInset ref
16017 reference "sec:slideNote"
16025 \begin_layout Standard
16026 You can also use the template file
16027 \begin_inset Quotes eld
16035 \begin_inset Quotes erd
16038 to automatically set up a document to use the
16044 File\SpecialChar \menuseparator
16046 \begin_inset space ~
16050 \begin_inset space ~
16055 to open your new document].
16056 The template file also contains some examples of the special paragraph
16057 environments used by this class.
16058 I'll describe those next.
16061 \begin_layout Subsection
16062 Paragraph Environments
16065 \begin_layout Subsubsection
16066 Supported Environments
16069 \begin_layout Standard
16070 The first thing you'll notice when you start up a new
16074 document is the font size and type: it's the equivalent of the size
16075 \begin_inset Quotes eld
16083 \begin_inset Quotes erd
16089 \begin_inset space ~
16095 This is also what's used in the output.
16097 \begin_inset Quotes eld
16101 \begin_inset Quotes erd
16104 to remind you that this is a slide.
16105 Your final slides will use a larger font; ergo, you'll have less space.
16106 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
16109 \begin_layout Standard
16110 The next thing that becomes obvious is the changes to the paragraph environment
16111 pull-down box [at the far-left end of the toolbar].
16112 Most of the paragraph environments you're used to seeing are missing.
16113 There are also five new ones.
16118 class itself only supports certain paragraph environments:
16121 \begin_layout Itemize
16127 \begin_layout Itemize
16133 \begin_layout Itemize
16139 \begin_layout Itemize
16145 \begin_layout Itemize
16151 \begin_layout Itemize
16157 \begin_layout Itemize
16163 \begin_layout Itemize
16169 \begin_layout Itemize
16175 \begin_layout Itemize
16181 \begin_layout Itemize
16187 \begin_layout Standard
16188 All of the other standard environments, including the section-heading environmen
16189 ts, aren't used in the
16196 \begin_layout Standard
16197 On the other hand, you'll notice the following new environments:
16200 \begin_layout Itemize
16206 \begin_layout Itemize
16212 \begin_layout Itemize
16218 \begin_layout Itemize
16224 \begin_layout Itemize
16230 \begin_layout Standard
16231 These five are kind of quirky, due to a
16232 \begin_inset Quotes eld
16236 \begin_inset Quotes erd
16240 You see, LyX doesn't permit you to nest any other paragraph environment
16241 into an empty environment.
16242 Now, that's fine and dandy, but it means that you wouldn't be able to start
16243 a slide with anything except plain text.
16244 To deal with this, I've performed a little
16245 \begin_inset Quotes eld
16249 \begin_inset Quotes erd
16255 \begin_layout Subsubsection
16256 Quirks of the New Environments
16257 \begin_inset CommandInset label
16259 name "sec:slideQuirk"
16266 \begin_layout Standard
16267 All five of the new paragraph environments are somewhat quirky due to inherent
16268 limitiations in the current version of LyX.
16269 As I just mentioned, LyX forbids environments that begin with another environme
16271 To get around this, the
16275 environment isn't a paragraph environment as described in the
16283 \begin_layout Standard
16284 You should consider
16297 \begin_inset Quotes eld
16300 pseudo-environments.
16301 \begin_inset Quotes erd
16304 They look like a section heading or a
16305 \begin_inset Quotes eld
16313 \begin_inset Quotes erd
16316 but really begin a [and, if necessary, end the previous] paragraph environment.
16326 \begin_inset Quotes eld
16330 \begin_inset Quotes erd
16333 These two perform some action.
16336 \begin_layout Standard
16337 A common feature of all five environments,
16357 , is a rather long-ish label.
16358 The text following this label — ordinarily the contents of the paragraph
16359 environment — is utterly irrelevant for
16380 LyX completely ignores it.
16381 In fact, you can leave these five environments completely empty.
16385 \begin_layout Standard
16390 to put any text after the rather long-ish label, you might want to.
16391 This could be a short description of the contents of the
16396 In that case, enter your descriptive comment and hit
16400 as you normally would.
16403 \begin_layout Standard
16404 If, on the other hand, you don't want to enter any descriptive text, you'll
16405 hit another LyX quirk.
16406 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
16407 environment until you put something in the old one.
16411 \begin_layout Itemize
16412 Start entering the text that will
16440 \begin_layout Itemize
16441 Now move to the beginning of that paragraph.
16445 \begin_layout Itemize
16454 \begin_layout Itemize
16455 Finally, change this new, empty paragraph to a
16479 \begin_layout Standard
16480 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
16484 \begin_layout Subsection
16485 Making a Presentation with
16498 \begin_layout Subsubsection
16506 \begin_layout Standard
16507 If you're expecting this section to teach you how to actually make a presentatio
16508 n, you'll be sorely disappointed.
16509 Naturally, I'll describe all of the ways the
16513 class can assist you in preparing the materials for a presentation.
16514 Filling in the contents, however, is up to you.
16519 the LyX philosophy.]
16522 \begin_layout Standard
16527 environment [in the manner described in section
16528 \begin_inset space ~
16532 \begin_inset CommandInset ref
16534 reference "sec:slideQuirk"
16538 ] tells LyX to begin a new slide [duh].
16539 The label for this environment/
16540 \begin_inset Quotes erd
16544 \begin_inset Quotes erd
16548 \begin_inset Quotes eld
16552 \begin_inset Quotes erd
16555 in cool blue, followed by the label,
16556 \begin_inset Quotes eld
16560 \begin_inset Quotes erd
16564 Any text or paragraph environments that follow this one go on the new slide.
16568 \begin_layout Standard
16569 Slides are probably the only time you'll need to forcibly end pages in LyX
16570 (this can be specified in the
16575 In fact, you'll want to, once you finish entering the contents of one slide.
16576 If you've entered more text than can physically fit on a slide, the extra
16577 overflows onto a new slide.
16578 I don't recommend doing this, however, since the overflow slide won't have
16579 any page number on it.
16580 Furthermore, it may interfere with any
16584 you've made to accompany the oversized
16591 \begin_layout Standard
16600 environments work the same way as the
16605 They both create an
16606 \begin_inset Quotes eld
16610 \begin_inset Quotes erd
16613 followed by a label [
16614 \begin_inset Quotes eld
16618 \begin_inset Quotes erd
16622 \begin_inset Quotes eld
16626 \begin_inset Quotes erd
16630 The color is a stunning magenta instead of blue, and the
16631 \begin_inset Quotes eld
16635 \begin_inset Quotes erd
16638 will look different, in style and in length.
16639 The label fonts of all three also differ from one another.
16642 \begin_layout Standard
16647 , if the contents of a
16655 exceed the physical size of a slide or sheet of paper, the extra will overflow
16657 Again, you should avoid this.
16658 It defeats the whole purpose of
16669 \begin_layout Subsubsection
16679 \begin_layout Standard
16684 is a slide that sits atop another slide.
16685 Perhaps you wish to discuss a figure on the main
16689 before displaying the text associated with it.
16690 One way to accomplish this is tape a flap of dark paper over the part of
16695 you want to display later.
16696 This method fails, however, if you wish to overlap one graph with another,
16698 You would then have to fumble while speaking to align the two separate,
16703 s to align the two graphs.
16708 environment in both cases makes life much easier.
16711 \begin_layout Standard
16716 receives the page number of its
16717 \begin_inset Quotes eld
16721 \begin_inset Quotes erd
16729 \begin_inset Quotes eld
16737 \begin_inset Quotes erd
16744 \begin_layout Plain Layout
16745 Presumably, mutliple
16750 \begin_inset Quotes eld
16758 \begin_inset Quotes erd
16762 \begin_inset Quotes eld
16770 \begin_inset Quotes erd
16774 \begin_inset Quotes eld
16782 \begin_inset Quotes erd
16786 \begin_inset space ~
16789 appended to the page number of the parent
16799 Clearly, you want the contents of both the
16807 to each fit on a single physical slide! You should probably consider an
16813 \begin_inset Quotes eld
16817 \begin_inset Quotes erd
16829 class provides a visual cue for this: the label at the start of an
16833 is shorter than that at the start of a
16838 Lastly, when you generate printable output, you'll find alignment markers
16839 in all four corners of both the
16843 page and its parent
16848 These will assist you in lining up the two physical slides.
16851 \begin_layout Standard
16852 The major problem in overlaying two slides is aligning the contents of the
16853 two transparencies.
16854 How much space should you leave for that graph on the second slide? Worse
16855 still, what if you want a graph and a sentence on second slide, but there
16856 is text on the main transparency that goes in between them? You could try
16857 and insert vertical space of the right size.
16858 The better way is to use
16869 \begin_layout Standard
16870 As their names imply,
16878 are two command-like paragraph environments that make all subsequent text
16879 invisible and visible, respectively.
16881 \begin_inset space ~
16885 \begin_inset CommandInset ref
16887 reference "sec:slideQuirk"
16891 that you don't place anything
16895 these two environments, however.
16900 , it inserts a centered, sky-blue label into the page reading
16901 \begin_inset Quotes eld
16904 <Invisible Text Follows>
16905 \begin_inset Quotes erd
16909 For paragraphs following this label, the parts of the
16917 ; it doesn't matter which] where they would be contain instead blank space.
16921 \begin_layout Standard
16926 , the corresponding centered label is
16927 \begin_inset Quotes eld
16930 <Visible Text Follows>
16931 \begin_inset Quotes erd
16935 Paragraphs following this label behave normally.
16936 Note that the beginning of a new
16948 automatically shuts off an
16953 It's therefore not necessary to use
16964 \begin_layout Standard
16965 By now, it should be obvious how to create overlay transparencies using
16966 the proper combination of
16985 \begin_layout Enumerate
16990 , including everything that will appear on it, whether on the main slide
16998 \begin_layout Enumerate
16999 Before each figure or paragraph that will appear only on the
17008 If necessary, insert a
17012 environment after the
17019 \begin_layout Enumerate
17024 immediately following the
17031 \begin_layout Enumerate
17032 Copy the contents of this
17043 \begin_layout Enumerate
17048 , change all of the
17059 \begin_layout Standard
17061 You've just made an
17068 \begin_layout Standard
17069 There's one problem with the way I've designed the LyX
17073 class: you can't make text in the middle of a paragraph invisible, nor
17074 make text in the middle of an invisible paragraph visible again.
17075 To accomplish this feat, you'll need to use some inlined LaTeX codes.
17079 \begin_layout Plain Layout
17080 The commands of interest are:
17083 \begin_layout Itemize
17088 invisible \SpecialChar \ldots{}
17092 \begin_layout Itemize
17097 visible \SpecialChar \ldots{}
17101 \begin_layout Plain Layout
17102 \SpecialChar \ldots{}
17103 and need to be marked as TeX.
17105 \begin_inset Quotes eld
17109 \begin_inset Quotes erd
17112 you wish to change goes in between the brackets [and after the
17125 If you don't know how to mark text as TeX, see the appropriate section
17138 \begin_layout Subsubsection
17148 \begin_inset CommandInset label
17150 name "sec:slideNote"
17157 \begin_layout Standard
17166 is associated with a
17167 \begin_inset Quotes eld
17171 \begin_inset Quotes erd
17183 class provides visual cues.
17188 is shorter than that of a
17192 [yet longer than that of an
17196 ] and, like the label of an
17200 is shockingly magenta.
17201 Additionally, the printed
17205 has the page number of its
17206 \begin_inset Quotes eld
17210 \begin_inset Quotes erd
17218 \begin_inset Quotes eld
17226 \begin_inset Quotes erd
17230 \begin_inset Quotes eld
17238 \begin_inset Quotes erd
17242 \begin_inset Quotes eld
17250 \begin_inset Quotes erd
17254 You can have multiple
17258 s associated with a single
17270 , you'll probably want to break up long
17274 s so that they fit on a single sheet of paper.
17277 \begin_layout Standard
17282 is obvious: it contains anything additional you might want to say about
17288 It could also be used as a sheet of reminders for a particular
17293 In the case of the latter, you might want to make use of time markers.
17299 \begin_inset Quotes eld
17303 \begin_inset Quotes erd
17306 support for time markers, a
17311 So, you'll have to resort to using the LaTeX codes.
17314 \begin_layout Standard
17315 To use time markers, you'll need to specify the extra class option
17316 \begin_inset Quotes eld
17324 \begin_inset Quotes erd
17328 \begin_inset space ~
17332 \begin_inset CommandInset ref
17334 reference "sec:slidesetup"
17339 This option turns on timing marks, which will appear in the lower-left-hand
17345 To set what appears in the time marker, you use the LaTeX commands
17346 \begin_inset Quotes eld
17356 \begin_inset Quotes erd
17360 \begin_inset Quotes eld
17370 \begin_inset Quotes erd
17374 The arguments of both commands are time measured in seconds.
17376 \begin_inset Quotes eld
17386 \begin_inset Quotes erd
17389 sets the time marker to a given time.
17391 \begin_inset Quotes eld
17401 \begin_inset Quotes erd
17404 increments the time marker by the specified amount.
17405 Using time markers and
17409 s in this fashion, you can remind yourself how much time to spend on a particula
17417 \begin_layout Standard
17418 There's one last feature to describe.
17419 Clearly, you'd like to print out all of your
17427 s on transparencies while printing all of your
17444 with which it is associated.
17445 What's a person to do?
17448 \begin_layout Standard
17449 Luckily, there are two LaTeX commands that allow you to select what to print
17451 Both must be placed into the preamble of your document.
17453 \begin_inset Quotes eld
17465 \begin_inset Quotes erd
17468 will cause the output to contain only the
17477 Correspondingly, the command
17478 \begin_inset Quotes eld
17490 \begin_inset Quotes erd
17493 prevents the output of anything but
17498 I'd advise placing both commands in the preamble and initially comment
17500 You can then preview your entire presentation as you write.
17501 When you're done writing, you can then uncomment one of the two to select
17502 what you want to print.
17503 I like to uncomment
17504 \begin_inset Quotes eld
17516 \begin_inset Quotes erd
17519 , print to a file with
17520 \begin_inset Quotes eld
17528 \begin_inset Quotes erd
17531 in its name, comment it back out, then uncomment
17532 \begin_inset Quotes eld
17544 \begin_inset Quotes erd
17548 \begin_inset Quotes eld
17556 \begin_inset Quotes erd
17560 I can then send either file to a printer, loading transparencies or plain
17561 paper as appropriate.
17564 \begin_layout Standard
17565 You can also provide other arguments to the
17566 \begin_inset Quotes eld
17576 \begin_inset Quotes erd
17580 \begin_inset Quotes eld
17590 \begin_inset Quotes erd
17594 See a good LaTeX book for details.
17597 \begin_layout Subsection
17602 Class Template File
17605 \begin_layout Standard
17606 I have also provided a template file,
17607 \begin_inset Quotes eld
17615 \begin_inset Quotes erd
17623 To use it, begin your new presentation with
17628 ile\SpecialChar \menuseparator
17630 \begin_inset space ~
17634 \begin_inset space ~
17644 Your new LyX presentation file will contain an example
17665 additionally contain an example of the use of
17674 Lastly, the preamble will contain:
17677 \begin_layout LyX-Code
17678 % Uncomment to print out only slides and overlays
17681 \begin_layout LyX-Code
17685 \begin_layout LyX-Code
17691 \begin_inset Newline newline
17697 \begin_layout LyX-Code
17698 % Uncomment to print out only notes
17701 \begin_layout LyX-Code
17705 \begin_layout LyX-Code
17713 \begin_layout Standard
17714 One final thing: I created this class to support the LaTeX2e
17715 \begin_inset Quotes eld
17723 \begin_inset Quotes erd
17726 class, one of the built-in LaTeX2e classes.
17727 Neither I nor the rest of the LyX Team endorse or oppose the use of this
17728 built-in slide class.
17729 It's here if you want it or need it.
17730 There exist other LaTeX2e classes for creating presentations, such as the
17736 \begin_inset space ~
17740 \begin_inset CommandInset ref
17742 reference "sec:foiltex"
17747 \begin_inset Quotes eld
17755 \begin_inset Quotes erd
17758 package [present on some TeX distributions].
17759 The latter is not yet supported under LyX.
17763 \begin_layout Plain Layout
17764 Perhaps you can take on the task\SpecialChar \ldots{}
17770 I know nothing about these other classes.
17771 Try them out to see what sort of alternative they provide.
17774 \begin_layout Chapter
17775 LyX Features needing Extra Software
17778 \begin_layout Section
17782 \begin_layout Standard
17788 \begin_layout Subsection
17792 \begin_layout Standard
17801 \begin_layout Plain Layout
17806 is not yet available when you are using the LaTeX distribution MiKTeX.
17811 , you'll find in the
17818 \begin_inset space ~
17829 \begin_inset CommandInset href
17831 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
17838 \begin_layout Standard
17843 package is a program that was written by
17844 \begin_inset Flex Noun
17847 \begin_layout Plain Layout
17849 \begin_inset space ~
17857 in frustration because some constructs in LaTeX are sometimes non-intuitive,
17858 and easy to forget.
17859 The program runs over your LaTeX file, checks the integrity of the file,
17860 and flags some common errors.
17861 In other technical words, it is
17868 \begin_layout Standard
17869 Well, what is a syntax checker doing in LyX which is supposed to produce
17870 correct LaTeX anyways? The answer is simple: Just as
17874 not only checks the
17878 of C programs, but also does
17882 checks for type-errors,
17886 catches some common
17890 errors, in addition to the syntactical ones.
17895 is capable of detecting several common errors, such as
17898 \begin_layout Itemize
17899 Ellipsis detection:
17900 \begin_inset Newline newline
17903 Use \SpecialChar \ldots{}
17907 \begin_layout Itemize
17908 No space in front of/after parenthesis:
17909 \begin_inset Newline newline
17915 \begin_layout Itemize
17916 Enforcement of normal space after common abbreviations:
17917 \begin_inset Newline newline
17921 \begin_inset space \thinspace{}
17925 \begin_inset space \space{}
17928 is too wide spacing.
17931 \begin_layout Itemize
17932 Enforcement of end-of-sentence space when the last sentence ends with a
17934 \begin_inset Newline newline
17938 And this is wrong spacing.
17941 \begin_layout Itemize
17942 Space in front of labels and similar commands:
17943 \begin_inset Newline newline
17946 The label should stick right up to the text to avoid falling to a wrong
17949 \begin_inset CommandInset label
17959 \begin_layout Plain Layout
17960 This footnote is in danger of falling off to a wrong page
17965 The label is separated too much.
17968 \begin_layout Itemize
17969 Space in front of references, instead of hard spaces:
17970 \begin_inset Newline newline
17973 If you have bad luck, the text will break right between the referenced text
17974 and reference number, and that's a pity.
17976 \begin_inset CommandInset ref
17978 reference "sec:chktex"
17985 \begin_layout Itemize
17987 \begin_inset Quotes eld
17991 \begin_inset Quotes erd
17995 \begin_inset Formula $\times$
17999 \begin_inset Newline newline
18002 2x2 looks cheap compared to
18003 \begin_inset Formula $2\times2$
18009 \begin_layout Standard
18010 and more \SpecialChar \ldots{}
18011 It is an invaluable tool when you are
18012 \begin_inset Quotes eld
18016 \begin_inset Quotes erd
18019 your document before printing, and you should run it right after the obligatory
18020 spelling check, and before you go fine tuning the typesetting.
18023 \begin_layout Subsection
18027 \begin_layout Standard
18028 If you have the program installed, usage is as simple as choosing
18030 Tools\SpecialChar \menuseparator
18032 \begin_inset space ~
18038 This will make LyX generate a LaTeX file of your document, start
18042 to check it, and then make LyX insert
18043 \begin_inset Quotes eld
18047 \begin_inset Quotes erd
18050 with the warnings from
18054 , if there were any.
18055 The warnings will be placed close to the point of the mistake, and you
18056 can quickly find them by using the
18058 Navigate\SpecialChar \menuseparator
18061 menu item, or the shortcut key
18070 Open the error boxes by clicking on them with the mouse, or use the shortcut
18079 bindings, or the corresponding
18088 Read the warning and correct the mistake, if it is a mistake.
18089 If you have trouble understanding what the warning is about, you can safely
18091 Remember that there is a hidden layer between the document on screen and
18092 the technical details in invoking
18096 , and this gap can make some warnings seem arcane or just plain silly.
18099 \begin_layout Standard
18100 This document is an excellent testing bed for the feature, and it should
18101 provide quite a few warnings for you to fiddle with.
18102 Since computers are only so smart, expect most of the warnings to be false
18106 \begin_layout Subsection
18107 How to fine tune it
18110 \begin_layout Standard
18111 Sometimes, you'll find that
18115 makes more noise than suits your mood.
18116 Then you can choose not to use it, wait until your mood changes, or try
18121 to get better along with you.
18124 \begin_layout Standard
18133 very configurable and extensible, you shouldn't expect to solve all problems
18139 Since LyX has to generate a somewhat special LaTeX file to be able to match
18140 the line numbers from the
18148 \begin_layout Plain Layout
18149 You can inspect the specific output from
18155 Edit\SpecialChar \menuseparator
18157 \begin_inset space ~
18161 \begin_inset space ~
18175 to the internal document structure, some of the warnings will not appear
18177 There are two things you can do about this:
18180 \begin_layout Itemize
18185 invocation command line in
18186 \begin_inset Flex MenuItem
18189 \begin_layout Plain Layout
18190 Tools\SpecialChar \menuseparator
18191 Preferences\SpecialChar \menuseparator
18192 Output\SpecialChar \menuseparator
18193 LaTeX\SpecialChar \menuseparator
18203 installation configuration file (usually with the file
18208 See below to learn what warnings can be enabled and disabled on the command
18212 \begin_layout Itemize
18213 Export your document as a raw LaTeX file using
18215 File\SpecialChar \menuseparator
18216 Export\SpecialChar \menuseparator
18224 Invoked in this way, it can be a hassle to find the corresponding place
18225 in the document inside LyX, but with a little patience, you should be able
18229 \begin_layout Standard
18230 Here follows the warning messages that can be enabled and disabled in
18239 to disable a warning, and
18243 to enable a warning.
18244 The emphasized entries are disabled by default, because the default is
18247 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
18252 \begin_layout Standard
18253 Notice that you should only use the options that enable and disable warnings,
18254 because LyX relies on some of the other command line parameters to be set
18255 in a specific way to have a chance to communicate with
18262 \begin_layout Enumerate
18266 Command terminated with space.
18269 \begin_layout Enumerate
18272 Non-breaking space (
18273 \begin_inset Quotes eld
18281 \begin_inset Quotes erd
18284 ) should have been used.
18287 \begin_layout Enumerate
18291 You should enclose the previous parenthesis with
18292 \begin_inset Quotes eld
18300 \begin_inset Quotes erd
18306 \begin_layout Enumerate
18309 Italic correction (
18310 \begin_inset Quotes eld
18320 \begin_inset Quotes erd
18323 ) found in non-italic buffer.
18326 \begin_layout Enumerate
18329 Italic correction (
18330 \begin_inset Quotes eld
18340 \begin_inset Quotes erd
18343 ) found more than once.
18346 \begin_layout Enumerate
18350 No italic correction (
18351 \begin_inset Quotes eld
18361 \begin_inset Quotes erd
18367 \begin_layout Enumerate
18371 \begin_inset Quotes eld
18379 \begin_inset Quotes erd
18383 \begin_inset Quotes eld
18391 \begin_inset Quotes erd
18397 \begin_layout Enumerate
18400 Wrong length of dash may have been used.
18403 \begin_layout Enumerate
18407 \begin_inset Quotes eld
18415 \begin_inset Quotes erd
18419 \begin_inset Quotes eld
18427 \begin_inset Quotes erd
18433 \begin_layout Enumerate
18437 \begin_inset Quotes eld
18445 \begin_inset Quotes erd
18451 \begin_layout Enumerate
18455 \begin_inset Quotes eld
18463 \begin_inset Quotes erd
18466 to achieve an ellipsis.
18469 \begin_layout Enumerate
18472 Inter-word spacing (
18473 \begin_inset Quotes eld
18483 \begin_inset Quotes eld
18486 ) should perhaps be used.
18489 \begin_layout Enumerate
18492 Inter-sentence spacing (
18493 \begin_inset Quotes eld
18503 \begin_inset Quotes erd
18506 ) should perhaps be used.
18509 \begin_layout Enumerate
18512 Could not find argument for command.
18515 \begin_layout Enumerate
18519 \begin_inset Quotes eld
18527 \begin_inset Quotes erd
18533 \begin_layout Enumerate
18536 Math mode still on at end of LaTeX file.
18539 \begin_layout Enumerate
18543 \begin_inset Quotes eld
18551 \begin_inset Quotes erd
18554 doesn't match the number of
18555 \begin_inset Quotes eld
18563 \begin_inset Quotes erd
18569 \begin_layout Enumerate
18572 You should use either
18575 \begin_inset Quotes eld
18583 \begin_inset Quotes erd
18588 as an alternative to
18589 \begin_inset Quotes eld
18597 \begin_inset Quotes erd
18603 \begin_layout Enumerate
18610 " (ASCII 39) instead of "
18617 \begin_layout Enumerate
18620 User-specified pattern found.
18623 \begin_layout Enumerate
18626 This command might not be intended.
18629 \begin_layout Enumerate
18636 \begin_layout Enumerate
18654 \begin_layout Enumerate
18657 Delete this space to maintain correct page references.
18660 \begin_layout Enumerate
18664 You might wish to put this between a pair of
18665 \begin_inset Quotes eld
18673 \begin_inset Quotes erd
18679 \begin_layout Enumerate
18682 You ought to remove spaces in front of punctuation.
18685 \begin_layout Enumerate
18688 Could not execute LaTeX command.
18691 \begin_layout Enumerate
18700 in front of small punctuation.
18703 \begin_layout Enumerate
18711 may look prettier here.
18714 \begin_layout Enumerate
18718 Multiple spaces detected in output.
18721 \begin_layout Enumerate
18724 This text may be ignored.
18727 \begin_layout Enumerate
18733 \begin_inset Quotes eld
18738 to begin quotation, not
18745 \begin_layout Enumerate
18752 to end quotation, not
18755 \begin_inset Quotes eld
18763 \begin_layout Enumerate
18769 \begin_layout Enumerate
18772 You should perhaps use
18773 \begin_inset Quotes eld
18781 \begin_inset Quotes erd
18787 \begin_layout Enumerate
18790 You should put a space in front of/after parenthesis.
18793 \begin_layout Enumerate
18796 You should avoid spaces in front of/after parenthesis.
18799 \begin_layout Enumerate
18803 You should not use punctuation in front of/after quotes.
18806 \begin_layout Enumerate
18809 Double space found.
18812 \begin_layout Enumerate
18815 You should put punctuation outside inner/inside display math mode.
18818 \begin_layout Enumerate
18821 You ought to not use primitive TeX in LaTeX code.
18824 \begin_layout Enumerate
18827 You should remove spaces in front of
18828 \begin_inset Quotes eld
18836 \begin_inset Quotes erd
18842 \begin_layout Enumerate
18845 \begin_inset Quotes eld
18853 \begin_inset Quotes erd
18856 is normally not followed by
18857 \begin_inset Quotes eld
18865 \begin_inset Quotes erd
18871 \begin_layout Standard
18872 In later versions of LyX, we hope to provide a more complete interface to
18873 this tool (and it's smaller cousin
18877 ) to exploit the full power of it.
18878 But it's not exactly useless as it is now: go try it on one of your existing
18879 documents of a certain length and be surprised.
18882 \begin_layout Section
18883 Version Control in LyX
18886 \begin_layout Standard
18889 Lars Gullik Bjønnes
18896 \begin_layout Subsection
18900 \begin_layout Standard
18901 LyX supports some of the most basic RCS/CVS/SVN commands.
18902 If you need something a bit more sophisticated you will have to do that
18903 manually in a terminal.
18906 \begin_layout Standard
18907 Also note that CVS support is not as good as subversion support so we advise
18909 A good place to start learning Subversion is SVN Book
18913 \begin_layout Plain Layout
18914 \begin_inset CommandInset href
18916 target "http://svnbook.red-bean.com/"
18926 In the case of RCS you should read
18927 \begin_inset Quotes eld
18931 \begin_inset Quotes erd
18934 (a man file, read it with
18939 This file describes all the basic features of RCS.
18940 You should especially notice the comment about a RCS directory, and the
18941 notion of a master RCS file (the file ending in
18948 \begin_layout Standard
18949 Before you begin to use the version control features in LyX, you should
18950 be familiar with RCS/CVS/SVN usage.
18951 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
18952 package—no guarantees are made for older versions.
18953 Most of the log messages are not currently displayed after operations —
18954 you can check them in the Messages pane if unsure.
18955 Regular users of version control will appreciate VC toolbar, which can
18958 View\SpecialChar \menuseparator
18959 Toolbars\SpecialChar \menuseparator
18961 \begin_inset space ~
18969 \begin_layout Standard
18970 For introducing your own external commands consult vc-command in the manual
18974 \begin_layout Subsection
18975 RCS commands in LyX
18978 \begin_layout Standard
18979 The following sections describe the RCS commands supported by LyX.
18980 You can find them in the
18982 File\SpecialChar \menuseparator
18984 \begin_inset space ~
18990 LyX was tested against RCS 5.7/5.8
18994 \begin_layout Plain Layout
18995 Note that old DOS / MS Windows builds (5.7) need to setup environment variables
18996 in order to work properly with LyX.
18997 In particular time zone (TZ) should be set and more importantly RCSINIT
18998 in order to change default archive location ("SET RCSINIT=-x,v/") --- LyX
18999 expects archive to be found in file.lyx,v within the original document directory.
19000 See also README shipped with Windows RCS binaries.
19008 \begin_layout Subsubsection
19014 \begin_layout Standard
19015 If your document is not under revision control, this is the only item shown
19017 And if it is under revision control, the
19021 item is not visible.
19025 \begin_layout Standard
19026 This command registers your document with RCS (unless you are under the
19027 directory managed by CVS)\SpecialChar \@.
19028 You are asked interactively to supply an initial
19029 description of the document.
19030 The document is now set in Read-Only mode and you have to
19033 \begin_inset space ~
19037 \begin_inset space ~
19041 \begin_inset space ~
19046 , before making any changes to it.
19047 A document under revision control has a
19048 \begin_inset Quotes eld
19051 [RCS:<version> <locker>]
19052 \begin_inset Quotes erd
19055 item tagged to the filename in the minibuffer.
19058 \begin_layout Standard
19059 RCS command that is run:
19061 ci -q -u -i -t-"<initial description>" <file-name>
19064 \begin_layout Standard
19069 to understand the switches.
19073 \begin_layout Subsubsection
19079 \begin_layout Standard
19080 When you are finished editing a file, you check in your changes.
19081 When you do this, you are asked for a description of the changes.
19082 This is stored in the history log.
19083 The version number is bumped, your changes are applied to the master RCS
19084 file, the document is unlocked and set to Read-Only mode.
19088 \begin_layout Standard
19091 ci -q -u -m"<description>" <file-name>
19094 \begin_layout Subsubsection
19100 \begin_layout Standard
19101 By doing this you lock the document so that only you can edit it.
19102 This will also make the document Read-Write only for you.
19103 You will usually continue editing for a while and when you are finished
19104 you check in your changes.
19105 The status line is changed to reflect that you have locked the file.
19109 \begin_layout Standard
19112 co -q -l <file-name>
19115 \begin_layout Subsubsection
19118 Revert To Repository Version
19121 \begin_layout Standard
19122 This will discard all changes made to the document since the last check
19124 You get a warning before changes are discarded.
19127 \begin_layout Standard
19130 co -f -u<version> <file-name>
19133 \begin_layout Subsubsection
19139 \begin_layout Standard
19140 This makes as if the last check in never happened.
19141 No changes are made to the document loaded into LyX, but the last version
19142 is removed from the master RCS file.
19146 \begin_layout Standard
19149 rcs -o<version> <file-name>
19152 \begin_layout Subsubsection
19158 \begin_layout Standard
19159 This shows the complete history of the RCS document.
19164 is shown in a browser.
19172 \begin_layout Subsubsection
19176 \begin_layout Standard
19177 LyX supports RCS version number, author name, date and time of last commit.
19178 All those are extracted from
19180 rlog -r <file-name>
19183 For other details see
19184 \begin_inset CommandInset ref
19186 reference "sub:VCS-Revision-Information"
19193 \begin_layout Subsection
19194 CVS commands in LyX
19197 \begin_layout Standard
19198 A subset of CVS operations is supported by LyX.
19199 You can find the commands in the
19201 File\SpecialChar \menuseparator
19203 \begin_inset space ~
19209 The version control system SVN is more powerful, so please use it instead
19210 of CVS if possible.
19213 \begin_layout Subsubsection
19219 \begin_layout Standard
19220 If you start from scratch with CVS you have to create your repository and
19221 checkout the working copy with external tools.
19222 If you're using a client-server setup you may need to login before doing
19223 the first repository checkout.
19226 \begin_layout Standard
19227 If your documents are under revision control and others are using the same
19228 repository problems arise when different changes to the same document at
19229 the same location happen.
19230 Standard CVS repositories doesn't operate with a file locking mechanism.
19231 This may be surprising, but conflicts only occur if people disagree on
19232 the proper content of the same part of a document.
19233 So, if co-workers are used to communicate regularly, these conflicts occur
19235 If they don't communicate they have a fundamental problem anyway.
19236 Nevertheless some people like to work with so called
19237 \begin_inset Quotes eld
19241 \begin_inset Quotes erd
19245 If they do so the working copy of all files is readonly when checked out
19246 first and the user starts editing after using a special command to make
19247 the working copy writable.
19248 When the changes are checked in the working copy returns to readonly state.
19249 With LyX one has to edit the
19250 \begin_inset Flex Code
19253 \begin_layout Plain Layout
19259 file and add the line
19260 \begin_inset Flex Code
19263 \begin_layout Plain Layout
19269 to work with reserved checkouts.
19270 The benefit is the possibility to see who is using a writable copy of some
19272 It's not guaranteed only one user makes a copy writable.
19275 \begin_layout Standard
19276 LyX tries to guess if you're using reserved or non-reserved checkouts.
19277 If your working copy is readonly or it is writable and an additional copy
19278 of your document exists in the CVS/Base sub-directory a reserved otherwise
19279 a non-reserved checkout is assumed.
19280 When a reserved checkout is detected you have to use
19281 \begin_inset Flex MenuItem
19284 \begin_layout Plain Layout
19290 to make your working copy writable if it's readonly.
19292 \begin_inset Flex MenuItem
19295 \begin_layout Plain Layout
19301 operation is possible and that makes your working copy readonly again after
19302 transferring your changes to the repository.
19305 \begin_layout Standard
19306 More information about CVS can be found here
19307 \begin_inset Flex URL
19310 \begin_layout Plain Layout
19312 http://www.nongnu.org/cvs
19318 \begin_inset Flex URL
19321 \begin_layout Plain Layout
19323 http://ximbiot.com/cvs
19331 \begin_layout Standard
19336 to understand the sub-commands and the switches mentioned below.
19339 \begin_layout Subsubsection
19345 \begin_layout Standard
19346 If your document is not under revision control, this is the only item shown
19348 And if it is under revision control, the
19355 item is not visible.
19359 \begin_layout Standard
19360 This command registers in CVS your document
19361 \begin_inset Flex Strong
19364 \begin_layout Plain Layout
19372 in the case you have already the documents directory under CVS control
19378 This means you have to create or checkout the archive by yourself using
19380 (In case you forget that step LyX registers the document with RCS.)
19383 \begin_layout Standard
19384 Then you are asked interactively to supply an initial description of the
19386 Don't forget that registered file is not yet checked in.
19389 \begin_layout Standard
19390 CVS command that is run:
19392 cvs -q add -m"<entered message>" "<file-name>"
19395 \begin_layout Standard
19400 above and for all other CVS commands is an abbreviation for
19401 \begin_inset Quotes eld
19404 change the current working directory to file location and use the file name
19405 without path component as argument
19406 \begin_inset Quotes erd
19412 \begin_layout Subsubsection
19418 \begin_layout Standard
19419 When you are finished editing a file, you commit your changes.
19420 When you do this and you had changed the document, you are asked for a
19421 description of the changes.
19422 After that changes are written to the repository.
19423 In case you didn't change the document and a reserved checkout is detected
19424 the reservation made on
19425 \begin_inset Flex MenuItem
19428 \begin_layout Plain Layout
19437 \begin_layout Labeling
19438 \labelwidthstring 00.00.0000
19440 \begin_inset space ~
19444 \begin_inset space ~
19448 \begin_inset Newline newline
19452 \begin_inset Flex Code
19455 \begin_layout Plain Layout
19458 -q commit -m"<description>" "<file-name>"
19464 \begin_inset Newline newline
19468 \begin_inset Flex Code
19471 \begin_layout Plain Layout
19482 \begin_layout Subsubsection
19488 \begin_layout Standard
19489 When you are sharing a repository with others, you may have to incorporate
19490 their changes into your working copy.
19493 \begin_layout Standard
19496 cvs -q update "<file-name>"
19499 \begin_layout Standard
19500 If a readonly checkout is detected the working copy is made writable and
19504 \begin_layout Standard
19507 cvs -q edit "<file-name>"
19510 \begin_layout Subsubsection
19513 Revert To Repository Version
19516 \begin_layout Standard
19517 This will discard all changes made to the document since the last check
19519 You get a warning before changes are discarded.
19520 Firstly the file is deleted, secondly CVS update command is run.
19523 \begin_layout Standard
19526 cvs -q update "<file-name>"
19529 \begin_layout Standard
19530 If a reserved checkout is detected and the working copy has no changes only
19531 the reservation is undone.
19534 \begin_layout Standard
19537 cvs -q unedit "<file-name>"
19540 \begin_layout Subsubsection
19541 Update of the local directory checkout from repository
19544 \begin_layout Standard
19545 Once your documents gets more complex, containing sub-documents and pictures,
19547 \begin_inset Flex Code
19550 \begin_layout Plain Layout
19556 files and so on using version control becomes more complicated.
19557 LyX supports updating the whole tree in which resides the document.
19558 This become especially useful once you cooperate with people which neither
19559 have detailed knowledge about CVS usage nor they have ambition to commit
19560 additional material to the repository.
19561 You have to organize the files structure so that all external files are
19562 in the same directory or subdirectories of the document.
19563 It's good practice anyway to store multipart documents in an extra directory.
19566 \begin_layout Standard
19568 \begin_inset Flex Code
19571 \begin_layout Plain Layout
19572 Update local directory from repository
19577 command updates the whole directory.
19578 If local changes are detected user is warned before update starts.
19579 In case of merge conflicts both versions of the conflicting document parts
19580 are placed in the final document.
19581 You have to review and correct the result of the merge.
19582 You'll find the conflicts enclosed in pairs of
19583 \begin_inset Flex Code
19586 \begin_layout Plain Layout
19593 \begin_inset Flex Code
19596 \begin_layout Plain Layout
19603 \begin_inset Flex Code
19606 \begin_layout Plain Layout
19613 The first part is your version as before the update operation with the
19614 document name prepended.
19615 The second one is the repository version with the version number after
19617 \begin_inset Flex Code
19620 \begin_layout Plain Layout
19629 \begin_layout Labeling
19630 \labelwidthstring 00.00.0000
19632 \begin_inset space ~
19636 \begin_inset space ~
19640 \begin_inset Newline newline
19644 \begin_inset Flex Code
19647 \begin_layout Plain Layout
19655 (Ask if changes are detected.)
19656 \begin_inset Newline newline
19660 \begin_inset Flex Code
19663 \begin_layout Plain Layout
19664 cd $path; cvs -q update
19674 \begin_layout Standard
19676 \begin_inset Flex Code
19679 \begin_layout Plain Layout
19685 stands for the path to the document.
19688 \begin_layout Subsubsection
19694 \begin_layout Standard
19695 This shows the complete history of the CVS document.
19698 cvs log "<file-name>"
19700 is shown in a browser.
19703 \begin_layout Subsection
19704 SVN commands in LyX
19707 \begin_layout Standard
19708 SVN is now partially supported by LyX.
19709 You can find the commands in the
19711 File\SpecialChar \menuseparator
19713 \begin_inset space ~
19719 Please note that if you use password protected access to repository via
19720 ssh, you will be asked in terminal window.
19721 LyX was tested against SVN 1.5 and 1.6
19725 \begin_layout Plain Layout
19726 Most of the commands will work with 1.4 too, see
19727 \begin_inset CommandInset ref
19729 reference "sub:SVN-Repo-Update"
19741 \begin_layout Subsubsection
19747 \begin_layout Standard
19748 If your document is not under revision control, this is the only item shown
19750 And if it is under revision control, the
19757 item is not visible.
19761 \begin_layout Standard
19762 This command registers in SVN your document ONLY in case you have already
19763 the documents directory under SVN control (in particular
19768 This means you have to checkout the archive by yourself.
19772 \begin_layout Standard
19773 Then you are asked interactively to supply an initial description of the
19775 Don't forget that registered file is not yet commited.
19778 \begin_layout Standard
19779 SVN command that is run:
19782 \begin_inset Quotes eld
19786 \begin_inset Quotes erd
19792 \begin_layout Standard
19797 to understand the switches.
19801 \begin_layout Subsubsection
19807 \begin_layout Standard
19808 When you are finished editing a file, you commit your changes.
19809 When you do this, you are asked for a description of the changes.
19810 After that changes are commited.
19813 \begin_layout Standard
19818 \begin_layout Plain Layout
19819 In case locking is not enabled.
19821 \begin_inset CommandInset ref
19823 reference "subsec:SVN-File-Locking"
19834 svn commit -q -m"<description>" <file-name>
19837 \begin_layout Subsubsection
19843 \begin_layout Standard
19844 Updates the changes of this file from the repository.
19845 Be sure you understand SVN merging and conflicts resolving before using
19846 this function, because all conflicts has to be resolved manually by you!
19849 \begin_layout Standard
19854 \begin_layout Plain Layout
19862 svn update --non-interactive
19863 \begin_inset Quotes eld
19867 \begin_inset Quotes erd
19873 \begin_layout Subsubsection
19876 Revert To Repository Version
19879 \begin_layout Standard
19880 This will discard all changes made to the document since the last check
19882 You get a warning before changes are discarded.
19886 \begin_layout Standard
19890 \begin_inset Quotes eld
19894 \begin_inset Quotes erd
19900 \begin_layout Subsubsection
19901 \begin_inset CommandInset label
19903 name "sub:SVN-Repo-Update"
19907 Update of the local directory checkout from repository
19911 \begin_layout Plain Layout
19912 Note that this command will work only with subversion
19913 \begin_inset Formula $\geqq1.5$
19924 \begin_layout Standard
19925 All the commands above have one shortcomming - they deal with the current
19927 Once your document contains pictures, includes external
19928 \begin_inset Flex Code
19931 \begin_layout Plain Layout
19937 files and so on administration becomes more complicated.
19938 LyX now supports updating the whole tree in which resides the document
19942 \begin_layout Plain Layout
19943 One need to organize the files structure so that all external files are
19944 in the same directory or subdirectories of the document.
19951 This become especially useful once you cooperate with people which neither
19952 know about subversion management nor they have ambition to commit additional
19953 material to the repository.
19957 \begin_layout Standard
19958 \begin_inset Flex Code
19961 \begin_layout Plain Layout
19962 Update local directory from repository
19967 command updates the whole directory and in case of merge conflicts local
19968 version of the files are left, so no unintended data loss occurs.
19969 If local changes are detected user is warned before update starts.
19972 \begin_layout Labeling
19973 \labelwidthstring 00.00.0000
19975 \begin_inset space ~
19979 \begin_inset space ~
19983 \begin_inset Newline newline
19987 \begin_inset Flex Code
19990 \begin_layout Plain Layout
19996 (Ask if changes are detected.)
19997 \begin_inset Newline newline
20001 \begin_inset Flex Code
20004 \begin_layout Plain Layout
20005 svn update --accept mine-full $path
20013 \begin_layout Standard
20015 \begin_inset Flex Code
20018 \begin_layout Plain Layout
20024 stands for the path to the document.
20027 \begin_layout Subsubsection
20033 \begin_layout Standard
20034 This shows the complete history of the SVN document.
20038 \begin_inset Quotes eld
20042 \begin_inset Quotes erd
20047 is shown in a browser.
20050 \begin_layout Subsubsection
20052 \begin_inset CommandInset label
20054 name "subsec:SVN-File-Locking"
20061 \begin_layout Standard
20062 The file exchange through various revision control systems brings the problem
20063 of merge conflicts in case two different users try to edit the same (parts
20065 When such a conflict happens it needs manual resolving and one reasonable
20066 alternative is to provide some kind of locking mechanism, which guarantees
20067 that only one user is allowed to edit file at the given time.
20070 \begin_layout Standard
20071 SVN has two such mechanisms to provide mutual exclusivity for file access
20072 - locks and automatic setting of write permissions (see sec.
20074 \begin_inset CommandInset ref
20076 reference "subsec:Automatical-Locking-Property"
20081 \begin_inset Flex Code
20084 \begin_layout Plain Layout
20094 \begin_layout Plain Layout
20095 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
20101 If this property is detected for a given document LyX starts to use SVN
20102 locks for document editing automatically and the whole check-in/out mechanism
20103 switches to the same regimen as for RCS.
20104 This in particular means there are two different modes of file use in LyX:
20107 \begin_layout Itemize
20109 The loaded file is in the read-only mode.
20110 For editing on needs to check-out.
20115 consists of updating from the repository and gaining write lock.
20116 If the lock is not possible to obtain, we remain in unlocked state.
20119 \begin_layout Itemize
20121 The loaded file is in the 'normal' edit mode.
20122 No other user is allowed to edit the file.
20127 consists of commiting changes and releasing write-lock.
20128 If no changes have been made to the document, no commit will be produced
20132 \begin_layout Plain Layout
20133 Don't be puzzled by the fact that you will be asked for commit message anyway.
20138 and only the write-lock will be released.
20141 \begin_layout Standard
20145 \begin_layout Labeling
20146 \labelwidthstring 00.00.0000
20149 svn commit -q -m"<description>" "<file-name>"
20150 \begin_inset Newline newline
20153 svn unlock "<file-name>"
20156 \begin_layout Labeling
20157 \labelwidthstring 00.00.0000
20160 svn update "<file-name>"
20161 \begin_inset Newline newline
20164 svn lock "<file-name>"
20167 \begin_layout Subsubsection
20170 \begin_inset CommandInset label
20172 name "subsec:Automatical-Locking-Property"
20178 Automatic Locking Property
20181 \begin_layout Standard
20182 The above mentioned automatic setting of write permissions of the .lyx file
20188 ile\SpecialChar \menuseparator
20194 \begin_inset space ~
20197 Control\SpecialChar \menuseparator
20202 oggle locking property
20205 This command is active only when the file is not locked on the svn server
20207 you need to check-out before proceeding).
20210 \begin_layout Labeling
20211 \labelwidthstring 00.00.0000
20213 \begin_inset space ~
20219 \begin_layout Labeling
20220 \labelwidthstring 00.00.0000
20223 svn propset svn:needs-lock ON "<file-name>"
20226 \begin_layout Labeling
20227 \labelwidthstring 00.00.0000
20230 svn propdel svn:needs-lock "<file-name>"
20233 \begin_layout Subsubsection
20234 \begin_inset CommandInset label
20236 name "sub:VCS-Revision-Information"
20240 Revision Information in Documents
20243 \begin_layout Standard
20244 There are more possibilities how to activate revision information in our
20248 \begin_layout Itemize
20249 LyX supports directly:
20253 \begin_layout Itemize
20254 tree revision information (
20255 \begin_inset Flex Code
20258 \begin_layout Plain Layout
20265 The result is the output of the
20266 \begin_inset Flex Code
20269 \begin_layout Plain Layout
20275 command, the following table gives you an idea, how to read the results.
20278 \begin_layout Standard
20280 \begin_inset Tabular
20281 <lyxtabular version="3" rows="6" columns="2">
20282 <features rotate="0" tabularvalignment="middle">
20283 <column alignment="center" valignment="top" width="0">
20284 <column alignment="center" valignment="top" width="0">
20286 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
20289 \begin_layout Plain Layout
20295 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
20298 \begin_layout Plain Layout
20306 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20309 \begin_layout Plain Layout
20315 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20318 \begin_layout Plain Layout
20319 mixed revision working copy
20326 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20329 \begin_layout Plain Layout
20335 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20338 \begin_layout Plain Layout
20339 modified working copy
20346 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20349 \begin_layout Plain Layout
20355 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20358 \begin_layout Plain Layout
20359 switched working copy
20366 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20369 \begin_layout Plain Layout
20375 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20378 \begin_layout Plain Layout
20379 partial working copy, from a sparse checkout
20386 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
20389 \begin_layout Plain Layout
20395 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
20398 \begin_layout Plain Layout
20399 mixed revision, modified, switched working copy
20412 \begin_layout Itemize
20413 file revision information.
20414 The result comes from parsing the output of
20415 \begin_inset Flex Code
20418 \begin_layout Plain Layout
20420 \begin_inset space ~
20424 \begin_inset space ~
20428 \begin_inset space ~
20437 Supported flags are:
20441 \begin_layout Itemize
20442 version number of the last commit (
20443 \begin_inset Flex Code
20446 \begin_layout Plain Layout
20455 \begin_layout Itemize
20456 author of the last commit (
20457 \begin_inset Flex Code
20460 \begin_layout Plain Layout
20469 \begin_layout Itemize
20470 date of the last commit (
20471 \begin_inset Flex Code
20474 \begin_layout Plain Layout
20483 \begin_layout Itemize
20484 time of the last commit (
20485 \begin_inset Flex Code
20488 \begin_layout Plain Layout
20498 \begin_layout Standard
20499 You can obtain this info via InsetInfo (e.g.
20501 \begin_inset Flex Code
20504 \begin_layout Plain Layout
20505 info-insert buffer vcs-date
20511 The information will be available only when you have the file stored under
20512 svn managment (i.e.
20514 \begin_inset Flex Code
20517 \begin_layout Plain Layout
20523 directory is available with your document).
20527 \begin_layout Itemize
20528 Another---a hacking one---possibility is to use svn keywords
20532 \begin_layout Plain Layout
20533 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
20539 In short -- you set file keywords property (e.g.
20542 svn propset svn:keywords 'Rev' file.lyx
20544 ) and then paste keyword TeX code
20548 \begin_layout Plain Layout
20549 This is an easy way how to ensure that LyX won't break the line in the middle
20555 tag in your document (e.g.
20560 \begin_layout Plain Layout
20568 This way svn client will automatically substitute revision number (e.g.
20573 \begin_layout Plain Layout
20580 ) after each update and commit.
20581 There are more problems with this approach.
20582 Firstly, the '$' character is used in TeX world for math equations, so
20583 any occurence of math formula
20584 \begin_inset Formula $Rev$
20588 \begin_inset Formula $Rev:59$
20591 in your LyX document.
20592 Similarly for other keywords like Id, Date, Author, etc.
20593 Secondly svn output is dependent on your locales, so its very easy that
20594 svn would produce some problematic strings once Date is used.
20595 Thirdly you get the whole 'Rev: 59' string in your document instead of
20597 Until subversion implements user's custom keywords it will be hard to use
20598 this approach reliably or let LyX to support it directly.
20601 \begin_layout Subsection
20602 SVN and Windows Environment
20605 \begin_layout Quote
20606 My inclination is to say that if the user cannot figure out the command
20607 line operations on their own fairly quickly, they would be well advised
20608 to use TortoiseSVN.
20614 \begin_layout Subsubsection
20618 \begin_layout Standard
20619 In addition to installing LyX, and having access to a Subversion repository,
20620 the user will need to install the Subversion client program.
20621 A Windows installer for the client program is available from
20622 \begin_inset CommandInset href
20625 target "http://www.collab.net/nonav/downloads/subversion/"
20630 The user may also want to install
20631 \begin_inset CommandInset href
20634 target "http://tortoisesvn.tigris.org/"
20638 , which integrates Subversion operations into the context (rightclick) menu
20639 of Windows Explorer.
20640 Operations done outside LyX will typically be more convenient using the
20641 Explorer context menu.
20642 Note that TortoiseSVN is not a replacement for the client program, which
20643 is what LyX itself will use.
20646 \begin_layout Subsubsection
20647 Bringing a document under Subversion control
20650 \begin_layout Standard
20651 Before a LyX document can be brought under version control in Subversion,
20652 its parent directory needs to be under version control.
20653 If the document is being added to a project already in the repository,
20654 this is accomplished by checking the project out to the directory where
20655 the new document will be placed.
20656 If the project itself is not yet under version control (for instance, if
20657 this document starts a new project), the directory must be imported into
20659 This is done outside LyX.
20660 Both import and checkout are easily accomplished from the Explorer context
20661 menu using TortoiseSVN, or alternatively can be done using the command
20662 line client at a DOS prompt.
20663 The procedure for importing the project using TortoiseSVN is described
20664 below, assuming an existing repository and a new project being started
20672 For information on using the Subversion client program, run
20679 \begin_layout Enumerate
20686 in Windows Explorer, right click it, and select
20688 TortoiseSVN > Repo-browser
20691 If necessary, adjust the URL for the repository, then click OK.
20694 \begin_layout Enumerate
20695 Right click the level of the repository under which you want to place the
20696 new project folder (typically the top level) and click
20698 Create folder\SpecialChar \ldots{}
20701 Supply a name for the project folder and click OK.
20702 Add a message for the log file if desired, then click OK again.
20703 The new project folder should appear in the repository.
20704 Finally, click OK again to exit the repository browser.
20707 \begin_layout Enumerate
20708 Once again right click
20714 , this time selecting SVN Checkout\SpecialChar \ldots{}
20715 Select the URL of the project folder
20716 you just created in the repository, and set the checkout directory to
20724 You will be warned about a non-empty folder; click OK to proceed.
20725 You should now have a
20736 \begin_layout Enumerate
20737 Create or open your document in LyX and click
20742 ile\SpecialChar \menuseparator
20748 \begin_inset space ~
20751 Control\SpecialChar \menuseparator
20759 Add a log message and click OK to commit the document to version control.
20762 \begin_layout Standard
20763 From this point onward, you should have full functionality in the
20768 ile\SpecialChar \menuseparator
20774 \begin_inset space ~
20780 You also have the option of checking the document in and out, viewing its
20782 using the TortoiseSVN context menu in Windows Explorer or the Subversion
20783 client program from a command prompt.
20786 \begin_layout Subsubsection
20787 SSH tunnel used with SVN under Windows
20790 \begin_layout Standard
20791 Compared with Linux setting up an svn client to communicate over ssh under
20792 Windows is a rather troublesome task.
20793 We will at least offer some hints how to setup the client side but prior
20794 knowledge about ssh and the Windows command line is needed, also be prepared
20795 for a great deal of frustration\SpecialChar \ldots{}
20799 \begin_layout Enumerate
20800 Get an svn client for windows, as described in the previous sections.
20801 When it is a fresh install run some svn command (e.g.
20803 \begin_inset Flex Code
20806 \begin_layout Plain Layout
20812 ) to create config files, which you will need to change later on.
20815 \begin_layout Enumerate
20816 Choose an ssh client for Windows.
20817 There are several possibilities, we will use the one from Putty tools
20821 \begin_layout Plain Layout
20822 \begin_inset Flex URL
20825 \begin_layout Plain Layout
20827 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
20838 You will need to set the connection up so that the client doesn't ask for
20839 any password from you.
20840 To keep things easy we will use only keys without any additional password
20845 \begin_layout Enumerate
20847 \begin_inset Flex Code
20850 \begin_layout Plain Layout
20857 Save your private .ppk key file and put the public one on the server side.
20858 If the SVN server runs on Linux, note that the format of the public key
20859 is not compatible with Linux openssh and you will need to direcly copy-paste
20862 Public key for pasting into OpenSSH authorized_keys file
20864 :” edit field into the server's
20865 \begin_inset Flex Code
20868 \begin_layout Plain Layout
20869 ~/.ssh/authorized_keys
20875 \begin_inset Flex Code
20878 \begin_layout Plain Layout
20887 \begin_layout Enumerate
20889 \begin_inset Flex Code
20892 \begin_layout Plain Layout
20899 In the SVN config file
20903 \begin_layout Plain Layout
20904 Exact path depends on Windows version, usually somewhere around
20905 \begin_inset Flex Code
20908 \begin_layout Plain Layout
20911 Documents and Settings
20925 \begin_inset Flex Code
20928 \begin_layout Plain Layout
20943 , section [tunnels], setup ssh command, e.g.
20945 \begin_inset Flex Code
20948 \begin_layout Plain Layout
20949 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
20958 \begin_layout Plain Layout
20959 It will usually take a lot of time to get exact command right and it depends
20961 For example do not have some remote server saved as a default session in
20963 If things fail, try to connect via plink without SVN first.
20972 \begin_layout Enumerate
20973 Checkout the SVN archive, e.g.
20975 \begin_inset Flex Code
20978 \begin_layout Plain Layout
20979 svn co svn+ssh://user@server/repository_path
20987 \begin_layout Subsubsection
20988 End-of-Line Conversions
20991 \begin_layout Standard
20992 When the collaborators are mixing Linux and Windows environments, LyX will
20993 use different line endings inside the .lyx files.
20994 This is not a problem as far as LyX functionality is concerned, but the
20995 commit diffs will be huge and merge-conflicts prone.
20996 Fortunately SVN itself knows
21000 \begin_layout Plain Layout
21001 \begin_inset Flex URL
21004 \begin_layout Plain Layout
21006 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
21016 how to deal with CR/LF problems when switching .lyx files to the
21017 \begin_inset Flex Code
21020 \begin_layout Plain Layout
21030 \begin_layout Plain Layout
21032 \begin_inset Flex Code
21035 \begin_layout Plain Layout
21036 svn propset svn:eol-style native FILE_NAME
21049 \begin_layout Subsection
21053 \begin_layout Standard
21054 With the recent addition of the vc-command function LyX power users are
21055 allowed to create their own commands for revision control.
21058 \begin_layout Standard
21059 As an example you can see how two TortoiseSVN commands could be integrated
21063 \begin_layout Description
21065 \begin_inset Flex Code
21068 \begin_layout Plain Layout
21069 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
21077 \begin_layout Description
21079 \begin_inset Flex Code
21082 \begin_layout Plain Layout
21083 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
21091 \begin_layout Subsection
21092 Version control and Document comparison
21095 \begin_layout Standard
21096 One of the typical uses of version control is to inspect the changes between
21097 revisions, usually by creating
21098 \begin_inset Flex Code
21101 \begin_layout Plain Layout
21108 While this is useful for plain text files, it is much less useful in the
21109 case of LyX files, which have more a complicated structure.
21110 Hence we provide binding to the Document comparison feature.
21111 There are two ways of calling this feature - either by direct call of
21112 \begin_inset Flex Code
21115 \begin_layout Plain Layout
21121 LyX function (for details see LyX functions manual) or by icon/menu item
21123 \begin_inset Flex MenuItem
21126 \begin_layout Plain Layout
21127 Compare with older revision...
21133 One can either compare two chosen revisions of the document or he can simply
21134 compare the current version of edited text with older revisions (where
21136 \begin_inset Flex MenuItem
21139 \begin_layout Plain Layout
21145 ' revisions back means comparison of the edited file with last commited
21150 \begin_layout Standard
21151 This feature is supported for SVN and RCS though due to the more complicated
21152 versioning scheme of RCS there is a constraint -- when addressing the revisions
21153 in dialog, numbers always point to the last number in RCS revision number,
21158 \begin_layout Section
21159 Literate Programming
21162 \begin_layout Standard
21167 (kayvan@sylvan.com)
21171 original documentation written by
21173 Edmar Wienskoski Jr.
21176 (edmar-w-jr@technologist.com)
21179 \begin_layout Subsection
21183 \begin_layout Standard
21184 The main purpose of this documentation is to show you how to use LyX for
21185 literate programming, where it is assumed that you are familiar with this
21186 programming technique, and know what
21187 \begin_inset Quotes eld
21191 \begin_inset Quotes erd
21195 \begin_inset Quotes eld
21199 \begin_inset Quotes erd
21203 If that is not the case, please follow the web links provided in the following
21205 There is a lot of good documentation out there covering old development
21206 history to the latest tools tips.
21209 \begin_layout Standard
21210 It is also assumed that you are familiar with LyX itself to a point that
21211 you are comfortable changing your LyX preferences, and X resources file.
21212 If that is not the case please refer to other LyX documentation to cover
21213 your specific needs.
21216 \begin_layout Subsection
21217 Literate Programming
21220 \begin_layout Standard
21221 From the Literate Programming FAQ:
21224 \begin_layout Quotation
21225 Literate programming is the combination of documentation and source together
21226 in a fashion suited for reading by human beings.
21227 In fact, literate programs should be enjoyable reading, even inviting!
21228 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
21229 and documentation in a single file.
21230 Literate programming tools then parse the file to produce either readable
21231 documentation or compilable source.
21232 The WEB style of literate programming was created by D.
21233 \begin_inset space \thinspace{}
21237 Knuth during the development of his TeX typesetting software.
21241 \begin_layout Standard
21242 Another excerpt says:
21245 \begin_layout Quotation
21248 How is literate programming different from verbose commenting?
21251 \begin_layout Quotation
21252 There are three distinguishing characteristics.
21253 In order of importance, they are:
21257 \begin_layout Itemize
21258 flexible order of elaboration
21261 \begin_layout Itemize
21262 automatic support for browsing
21265 \begin_layout Itemize
21266 typeset documentation, especially diagrams and mathematics
21270 \begin_layout Standard
21271 Now that I sparked your curiosity, take a look in the references.
21274 \begin_layout Subsubsection
21278 \begin_layout Standard
21279 The complete Literate Programming FAQ can be found at:
21282 \begin_layout Quote
21283 Literate Programming FAQ
21284 \begin_inset Flex URL
21287 \begin_layout Plain Layout
21289 http://www.literateprogramming.com/lpfaq.pdf
21297 \begin_layout Standard
21298 The FAQ lists 23 (twenty three!) different literate programming tools.
21299 Where some are specialized or
21300 \begin_inset Quotes eld
21304 \begin_inset Quotes erd
21307 for particular programming languages, while other have general scope.
21312 for my own use for several reasons:
21315 \begin_layout Itemize
21316 It can generate the documentation either in LaTeX or HTML.
21319 \begin_layout Itemize
21320 It has a open architecture, i.
21321 \begin_inset space \thinspace{}
21325 \begin_inset space \space{}
21328 it is easy to plug in new filters and to perform special processing that
21333 \begin_layout Itemize
21334 There is a good selection of filters available already (the HTML is one
21338 \begin_layout Itemize
21342 \begin_layout Standard
21343 The Noweb web page can be found at:
21346 \begin_layout Quote
21348 \begin_inset Flex URL
21351 \begin_layout Plain Layout
21353 http://www.cs.virginia.edu/~nr/noweb/
21361 \begin_layout Standard
21362 Starting from there you can reach many other interesting links and even
21363 some literate program examples.
21366 \begin_layout Subsection
21367 LyX and Literate Programming
21370 \begin_layout Standard
21371 The LyX support for Literate Programming is provided by using the generic
21372 LyX converters mechanism.
21373 This support is provided in a
21374 \begin_inset Quotes eld
21378 \begin_inset Quotes erd
21382 \begin_inset space \thinspace{}
21386 \begin_inset space \space{}
21389 you will be able to use this new LyX feature with some other literate programmin
21390 g tool of your choice by just changing your LyX preferences.
21393 \begin_layout Subsubsection
21394 Generating documents and code (weaving and tangling)
21397 \begin_layout Paragraph
21398 Selecting the document class
21401 \begin_layout Standard
21402 If you have installed Noweb and LyX successfully, whenever you open a new
21403 document or try to change the document class of an existing one, you will
21404 find that there are three new document classes available:
21407 \begin_layout Itemize
21411 \begin_layout Itemize
21415 \begin_layout Itemize
21419 \begin_layout Standard
21420 You must select one of them to create your literate documents from.
21424 \begin_layout Standard
21425 Note that literate documents are not limited to these three classes.
21426 New classes can be generated from other styles like letter or in combination
21427 with other class variations like Article (AMS).
21428 If you have special needs that cannot be covered by one of the existing
21429 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
21430 will arrange to insert a new entry, or teach you how to do it.
21434 \begin_layout Plain Layout
21435 It is very simple, it involves the creation of a file with four lines, and
21436 re-running of the auto configuration.
21441 Moreover, if you use a literate tool other than Noweb you may need to create
21442 a new set of document classes for it.
21445 \begin_layout Paragraph
21449 \begin_layout Standard
21450 LyX enables you to write code with a layout named
21458 \begin_layout Plain Layout
21459 The equivalent Noweb term is
21460 \begin_inset Quotes eld
21464 \begin_inset Quotes erd
21468 For historical reasons, I got used to the term
21469 \begin_inset Quotes eld
21473 \begin_inset Quotes erd
21476 introduced by other literate tool named Nuweb, which I used for many years
21477 before rendering myself to Noweb.
21482 Noweb delimits scraps like this:
21485 \begin_layout LyX-Code
21489 \begin_layout LyX-Code
21493 \begin_layout LyX-Code
21497 \begin_layout LyX-Code
21501 \begin_layout LyX-Code
21505 \begin_layout Standard
21506 The problem is that whatever is written in between the << and the
21510 must be taken literally, i.
21511 \begin_inset space \thinspace{}
21515 \begin_inset space \space{}
21518 LyX should be prevented from making any special interpretation of what has
21520 This is handled by a special layout named Scrap, that works like a normal
21521 paragraph but has a free spacing capability.
21524 \begin_layout Standard
21525 The down side of the Scrap paragraph layout is that consecutive paragraphs
21526 of code will be spaced with one empty line in the source code and also
21527 in the printed documentation.
21528 The work around is to enter each line of code within a single Scrap, with
21529 a newline (ctrl-return).
21530 The example above will look like this:
21534 \begin_layout Plain Layout
21535 If you have a printed version of this document you will not see any difference
21536 between the previous example and this one.
21544 \begin_layout LyX-Code
21546 \begin_inset Newline newline
21550 \begin_inset Newline newline
21554 \begin_inset Newline newline
21558 \begin_inset Newline newline
21564 \begin_layout Standard
21565 This layout works fine.
21566 The only real inconvenience is that you have to type ctrl-return instead
21571 \begin_layout Plain Layout
21572 It is in my list of
21573 \begin_inset Quotes eld
21577 \begin_inset Quotes erd
21588 \begin_layout Standard
21589 As a special note, you can also use the
21590 \begin_inset Quotes eld
21594 \begin_inset Quotes erd
21597 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
21601 \begin_layout LyX-Code
21603 \begin_inset Newline newline
21606 def some_function(args):
21607 \begin_inset Newline newline
21610 "This is the doc string for this function."
21611 \begin_inset Newline newline
21614 print "My args: ", args
21617 \begin_layout LyX-Code
21618 @ %def some_function
21621 \begin_layout Standard
21622 For an example of this usage and the resulting cross-reference output, look
21623 at the Literate python program in
21625 LIBDIR/examples/listerrors.lyx
21627 which should make this all clear.
21630 \begin_layout Paragraph
21631 Generating the documentation
21634 \begin_layout Standard
21635 At this point you already have a new document file with a proper document
21636 class, and with some code and text on it.
21637 How do I print it? The answer is simple, you select
21639 View\SpecialChar \menuseparator
21643 Just like you would do for a plain document.
21644 No special procedure is required.
21647 \begin_layout Standard
21648 To help orientate you, I will now explain what happens inside LyX:
21651 \begin_layout Enumerate
21654 Update\SpecialChar \menuseparator
21657 menu option is chosen, a LaTeX file is generated.
21662 \begin_layout Standard
21663 If the document is of any literate class the generated file will be named
21664 with an extension name defined by the
21665 \begin_inset Quotes eld
21669 \begin_inset Quotes erd
21672 format (defined in the Preferences panel), otherwise the file will have
21681 \begin_layout Enumerate
21682 Note that the only difference so far is in the name of the file, no special
21683 processing is required by LyX.
21684 Given that you formatted the code using the Scrap layout that, by itself,
21685 takes care of the business.
21688 \begin_layout Enumerate
21689 If the document is of any literate class LyX will then use the internal
21690 LyX to Noweb converter, followed by the Noweb to LaTeX converter
21694 \begin_layout Plain Layout
21695 The converters are defined in the
21697 Tools\SpecialChar \menuseparator
21701 \begin_inset Quotes eld
21705 \begin_inset Quotes erd
21717 manual for general information about converters.
21722 to generate the LaTeX file.
21726 \begin_layout Standard
21727 Otherwise it will just skip this step.
21731 \begin_layout Enumerate
21732 Finally, LaTeX is invoked and the regular post processing continues as in
21736 \begin_layout Standard
21737 Independence from a particular
21738 \begin_inset Quotes eld
21742 \begin_inset Quotes erd
21745 is easily achieved by changing the commands that are run by the various
21749 \begin_layout Paragraph
21750 Generating the code
21753 \begin_layout Standard
21754 When the build menu option is chosen or the corresponding button in the
21755 toolbar is pressed, a LaTeX file is generated just like step 1 above.
21756 Next, LyX invokes the
21761 This converter needs to be defined by the user and is not installed by
21762 default, though the Program format is.
21763 This converter (like any other converter) will have two parts:
21766 \begin_layout Enumerate
21767 The converter program itself.
21768 This program performs the conversion from the one format to the other (in
21769 this case, from the Noweb format to the Program pseudo-format).
21772 \begin_layout Enumerate
21773 The error log parser.
21774 This is a program whose sole purpose is to rewrite error messages in a
21775 format that LyX understands.
21776 This makes it possible for LyX to place error boxes in the right places
21777 in the file buffer.
21780 \begin_layout Standard
21781 The first part, the
21782 \begin_inset Quotes eld
21786 \begin_inset Quotes erd
21789 setting, should be set to
21790 \begin_inset Quotes eld
21798 \begin_inset Quotes erd
21802 This basically means that LyX will call
21803 \begin_inset Quotes eld
21807 \begin_inset Quotes erd
21810 (a program or script) with the name of the Noweb file (normally a file
21811 in the LyX temp directory).
21815 \begin_layout Standard
21816 This is an implementation of
21817 \begin_inset Quotes eld
21821 \begin_inset Quotes erd
21824 that you can place in a directory on your path:
21827 \begin_layout LyX-Code
21831 \begin_layout LyX-Code
21835 \begin_layout LyX-Code
21836 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
21839 \begin_layout Standard
21840 The next part of the converter setting is the
21841 \begin_inset Quotes eld
21845 \begin_inset Quotes erd
21848 which is to be set to
21849 \begin_inset Quotes eld
21854 parselog=listerrors
21857 \begin_inset Quotes erd
21861 This will run any errors that are generated by the
21862 \begin_inset Quotes eld
21866 \begin_inset Quotes erd
21869 process through the
21870 \begin_inset Quotes eld
21874 \begin_inset Quotes erd
21880 \begin_layout Standard
21881 The converter code looks in
21889 then on the path for the
21890 \begin_inset Quotes eld
21894 \begin_inset Quotes erd
21900 \begin_layout Standard
21901 The build will normally take place in LyX's temporary directory, so the
21902 files produced by the conversion will be in that directory.
21903 LyX will copy out what it regards as the `main' file, but the
21907 conversion may produce several files, and so most of these would then be
21908 deleted when LyX was closed.
21909 The present solution is to use a `copier',
21913 \begin_layout Plain Layout
21922 manual for information on these.
21931 script in its default mode, so that the entire contents of the temporary
21932 directory is copied.
21933 More will get copied than is needed, to be sure, but nothing will be lost.
21934 If, however, you know what extensions the generated files will have, this
21935 can be improved by using the
21944 This option takes a comma-separated list of extensions to copy.
21945 So, for example, if the conversion will generate only files with the extensions
21954 , then the correct definition would be:
21957 \begin_layout LyX-Code
21958 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
21961 \begin_layout Standard
21962 The result will be that only files with these two extensions will be copied
21966 \begin_layout Paragraph
21967 Build instructions in the document
21970 \begin_layout Standard
21971 The last piece of the integration between LyX and noweb is the
21972 \begin_inset Quotes eld
21976 \begin_inset Quotes erd
21980 Generally, the instructions for building your program should be embedded
21981 in a scrap of its own.
21983 \begin_inset Quotes eld
21987 \begin_inset Quotes erd
21990 above uses the notangle command to look for this scrap (called
21991 \begin_inset Quotes eld
21995 \begin_inset Quotes erd
21998 ) and runs its contents through
21999 \begin_inset Quotes eld
22003 \begin_inset Quotes erd
22009 \begin_layout Standard
22010 Typically, such a scrap would look something like this:
22013 \begin_layout LyX-Code
22015 \begin_inset Newline newline
22019 \begin_inset Newline newline
22023 \begin_inset Newline newline
22026 if [ -z "${NOWEB_SOURCE}" ]
22027 \begin_inset Newline newline
22031 \begin_inset Newline newline
22034 NOWEB_SOURCE=myfile.nw
22035 \begin_inset Newline newline
22039 \begin_inset Newline newline
22043 code to extract files ...]
22044 \begin_inset Newline newline
22048 code to compile files ...]
22049 \begin_inset Newline newline
22055 \begin_layout Standard
22058 LIBDIR/examples/listerrors.lyx
22062 LIBDIR/examples/Literate.lyx
22064 which implement two versions of the
22065 \begin_inset Quotes eld
22069 \begin_inset Quotes erd
22072 program for some illustrations of how all of these pieces go together or
22075 LIBDIR/examples/noweb2lyx.lyx.
22078 Interestingly, these three files show off the language-indepence of the
22079 LyX literate programming support since they are written in Python, C and
22083 \begin_layout Subsubsection
22087 \begin_layout Standard
22088 All the Literate Programming support is configured by the
22090 Tools\SpecialChar \menuseparator
22094 \begin_inset Quotes eld
22098 \begin_inset Quotes erd
22102 The important parts are:
22105 \begin_layout Description
22107 \begin_inset space ~
22111 \begin_inset Quotes eld
22115 \begin_inset Quotes erd
22119 \begin_inset space ~
22122 format Set up via the Formats tab, this is where the Noweb-specific pieces
22132 , the file extension is set to
22137 This tells LyX to create a file with a
22141 extension in the first step of the conversion process.
22144 \begin_layout Description
22146 \begin_inset space ~
22154 \begin_inset space ~
22157 format This is an empty format whose sole purpose is to be the endpoint
22158 of a conversion (which then allows us to set up a converter for it).
22161 \begin_layout Description
22170 This converter performs the
22171 \begin_inset Quotes eld
22175 \begin_inset Quotes erd
22178 of the literate document.
22179 For Noweb, it is set to
22180 \begin_inset Quotes eld
22185 noweave -delay -index $$i > $$o
22188 \begin_inset Quotes erd
22194 \begin_layout Description
22204 \begin_inset Quotes eld
22208 \begin_inset Quotes erd
22212 As stated above, the Converter is set to
22213 \begin_inset Quotes eld
22221 \begin_inset Quotes erd
22224 , with Flags set to
22225 \begin_inset Quotes eld
22230 originaldir,parselog=listerrors
22233 \begin_inset Quotes erd
22239 \begin_layout Subsubsection
22243 \begin_layout Standard
22244 There is also a new function implemented in the LyX server, the
22245 \begin_inset Quotes eld
22248 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
22252 \begin_layout Standard
22253 When debugging code with ddd/gdb, it is possible to invoke a text editor
22254 at the current execution position with a single key stroke.
22255 The default ddd configuration for that is shift-ctrl-V.
22256 It happens that you can define the editor command line invocation in ddd
22259 Edit\SpecialChar \menuseparator
22260 Preferences\SpecialChar \menuseparator
22263 dialog and changing the "Edit Sources" entry.
22266 \begin_layout Standard
22267 I take advantage of the new created LyX server function and this ddd feature,
22269 \begin_inset Quotes eld
22273 \begin_inset Quotes erd
22279 \begin_layout LyX-Code
22280 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
22283 \begin_layout Standard
22284 With this, whenever you are using ddd and find a point in the program that
22285 you want to edit, you just press shift-ctrl-V (in the ddd window), and
22286 ddd you forward this information to LyX through the LyX server and then
22287 the LyX window will show the same file with the cursor at the same position
22288 ddd was pointing to.
22289 No more guessing or long scrolling to locate a point in the program back
22293 \begin_layout Standard
22294 Note however that you must enable the LyX server to get this feature working
22295 (it is disabled by default).
22296 You can enable it in
22308 ) by entering in the
22313 \begin_inset Quotes eld
22318 /home/<your-home-directory>/.lyx/lyxpipe
22321 \begin_inset Quotes erd
22327 \begin_layout Standard
22328 Read the LyX server documentation in the
22330 Customization Manual
22332 for further information.
22335 \begin_layout Subsubsection
22339 \begin_layout Standard
22340 There are six new buttons that can be added to your LyX toolbar.
22341 Five of these buttons are short cuts to layout styles:
22362 The last one is a short cut to the
22363 \begin_inset Quotes eld
22367 \begin_inset Quotes erd
22374 \begin_layout Standard
22375 LyX has a range of buttons that are available for tool bar customization.
22376 In my toolbar I like to combine the six short cuts above with two more:
22381 \SpecialChar \menuseparator
22386 \SpecialChar \menuseparator
22393 View\SpecialChar \menuseparator
22397 Here is how it looks like:
22400 \begin_layout LyX-Code
22404 \begin_layout LyX-Code
22408 \begin_layout LyX-Code
22409 Icon "layout Standard"
22412 \begin_layout LyX-Code
22413 Icon "layout Section"
22416 \begin_layout LyX-Code
22417 Icon "layout LaTeX"
22420 \begin_layout LyX-Code
22421 Icon "layout LyX-Code"
22424 \begin_layout LyX-Code
22425 Icon "layout Scrap"
22428 \begin_layout LyX-Code
22432 \begin_layout LyX-Code
22436 \begin_layout LyX-Code
22437 Icon "buffer-typeset"
22440 \begin_layout LyX-Code
22441 Icon "build-program"
22444 \begin_layout LyX-Code
22448 \begin_layout LyX-Code
22452 \begin_layout LyX-Code
22456 \begin_layout LyX-Code
22460 \begin_layout LyX-Code
22464 \begin_layout Subsubsection
22465 Colors customization
22468 \begin_layout Standard
22469 There are a number of colors in LyX that can be customized in
22474 One of the things that bothers people is the LaTeX font color.
22475 The default color is red, since the scraps uses LaTeX font, and there is
22476 a lot of scraps in literate documents, you may get tired of seeing everything
22478 You can change it by going to the tabs
22487 \begin_layout Standard
22488 The next thing is the visible presence of the newline character in the screen.
22489 You can choose the color of this particular character and make it blend
22491 I recommend you choosing a color that is close to the background but not
22492 equal, that way you still can see it is there, but it is not bothering
22497 \begin_layout Chapter
22501 \begin_layout Standard
22502 You can do everything with LyX that you can do with LaTeX.
22503 However, LyX cannot support every LaTeX feature directly.
22504 But you can always use TeX Code.
22505 This chapter shows you some more special things you might want to use.
22506 For other special things you can do with figures, tables, floats, boxes
22507 and notes, have a look at the
22510 \begin_inset space ~
22518 \begin_layout Section
22519 Multiple Text Columns
22522 \begin_layout Standard
22523 This feature is independent of the option
22525 Two-column document
22527 in the document settings under
22532 If you want to have 2
22533 \begin_inset space ~
22536 columns for the whole document, it is recommended to use the
22538 Two-column document
22541 For all other cases use this feature.
22544 \begin_layout Standard
22545 To use multiple text columns in your document, you have to load the module
22552 Document\SpecialChar \menuseparator
22553 Settings\SpecialChar \menuseparator
22556 ) and must have the LaTeX-package
22561 \begin_inset Index idx
22564 \begin_layout Plain Layout
22565 LaTeX-packages ! multicol
22573 \begin_layout Standard
22574 Footnotes within multiple columns will be placed at the bottom of the page
22575 and not under each column.
22576 Within the different columns you can use everything, with the limitation
22577 that for floats you need to use the float option
22584 \begin_layout Subsection
22588 \begin_layout Standard
22589 If you want to have 2
22590 \begin_inset space ~
22593 columns in your text, use the style
22595 Begin Multiple Columns
22597 where the columns should start.
22598 The content of the style is the number of the columns, so in this case
22600 \begin_inset Quotes eld
22604 \begin_inset Quotes erd
22608 At the point where the columns should end use the style
22610 End Multiple Columns
22615 \begin_layout Standard
22616 Here is an example:
22619 \begin_layout Begin Multiple Columns
22623 \begin_layout Standard
22628 The Adventure of the Empty House
22631 \begin_inset Newline newline
22636 Sir Arthur Conan Doyle
22639 \begin_layout Standard
22642 It was in the spring of the year 1894 that all London was interested, and
22643 the fashionable world dismayed, by the murder of the Honourable Ronald
22644 Adair under most unusual and inexplicable circumstances.
22645 The public has already learned those particulars of the crime which came
22646 out in the police investigation, but a good deal was suppressed upon that
22647 occasion, since the case for the prosecution was so overwhelmingly strong
22648 that it was not necessary to bring forward all the facts.
22649 Only now, at the end of nearly ten years, am I allowed to supply those
22650 missing links which make up the whole of that remarkable chain.
22651 The crime was of interest in itself, but that interest was as nothing to
22652 me compared to the inconceivable sequel, which afforded me the greatest
22653 shock and surprise of any event in my adventurous life.
22654 Even now, after this long interval, I find myself thrilling as I think
22655 of it, and feeling once more that sudden flood of joy, amazement, and increduli
22656 ty which utterly submerged my mind.
22657 Let me say to that public, which has shown some interest in those glimpses
22658 which I have occasionally given them of the thoughts and actions of a very
22659 remarkable man, that they are not to blame me if I have not shared my knowledge
22660 with them, for I should have considered it my first duty to do so, had
22661 I not been barred by a positive prohibition from his own lips, which was
22662 only withdrawn upon the third of last month.
22665 \begin_layout End Multiple Columns
22669 \begin_layout Standard
22670 Here is an example with 3
22671 \begin_inset space ~
22677 \begin_layout Begin Multiple Columns
22681 \begin_layout Standard
22684 It can be imagined that my close intimacy with Sherlock Holmes had interested
22685 me deeply in crime, and that after his disappearance I never failed to
22686 read with care the various problems which came before the public.
22687 And I even attempted, more than once, for my own private satisfaction,
22688 to employ his methods in their solution, though with indifferent success.
22689 There was none, however, which appealed to me like this tragedy of Ronald
22691 As I read the evidence at the inquest, which led up to a verdict of willful
22692 murder against some person or persons unknown, I realized more clearly
22693 than I had ever done the loss which the community had sustained by the
22694 death of Sherlock Holmes.
22695 There were points about this strange business which would, I was sure,
22696 have specially appealed to him, and the efforts of the police would have
22697 been supplemented, or more probably anticipated, by the trained observation
22698 and the alert mind of the first criminal agent in Europe.
22699 All day, as I drove upon my round, I turned over the case in my mind and
22700 found no explanation which appeared to me to be adequate.
22701 At the risk of telling a twice-told tale, I will recapitulate the facts
22702 as they were known to the public at the conclusion of the inquest.
22705 \begin_layout End Multiple Columns
22709 \begin_layout Standard
22710 You can have up to 10
22711 \begin_inset space ~
22714 columns if you want to, but that might not be very pleasant for the readers
22718 \begin_layout Standard
22719 \begin_inset Newpage newpage
22725 \begin_layout Subsection
22726 Columns inside Columns
22729 \begin_layout Standard
22730 You can also have columns inside columns:
22733 \begin_layout Begin Multiple Columns
22737 \begin_layout Standard
22740 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
22741 at that time governor of one of the Australian colonies.
22742 Adair's mother had returned from Australia to undergo the operation for
22743 cataract, and she, her son Ronald, and her daughter Hilda were living together
22747 \begin_layout Begin Multiple Columns
22751 \begin_layout Standard
22754 The youth moved in the best society–had, so far as was known, no enemies
22755 and no particular vices.
22756 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
22757 had been broken off by mutual consent some months before, and there was
22758 no sign that it had left any very profound feeling behind it.
22759 For the rest {sic} the man's life moved in a narrow and conventional circle,
22760 for his habits were quiet and his nature unemotional.
22761 Yet it was upon this easy-going young aristocrat that death came, in most
22762 strange and unexpected form, between the hours of ten and eleven-twenty
22763 on the night of March 30, 1894.
22766 \begin_layout End Multiple Columns
22770 \begin_layout Standard
22773 Ronald Adair was fond of cards–playing continually, but never for such stakes
22775 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
22776 It was shown that, after dinner on the day of his death, he had played
22777 a rubber of whist at the latter club.
22778 He had also played there in the afternoon.
22783 The evidence of those who had played with him– Mr.
22784 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
22785 and that there was a fairly equal fall of the cards.
22786 Adair might have lost five pounds, but not more.
22787 His fortune was a considerable one, and such a loss could not in any way
22789 He had played nearly every day at one club or other, but he was a cautious
22790 player, and usually rose a winner.
22791 It came out in evidence that, in partnership with Colonel Moran, he had
22792 actually won as much as four hundred and twenty pounds in a sitting, some
22793 weeks before, from Godfrey Milner and Lord Balmoral.
22794 So much for his recent history as it came out at the inquest.
22797 \begin_layout End Multiple Columns
22801 \begin_layout Subsection
22805 \begin_layout Standard
22806 The examples in this section show some more special features of multiple
22810 \begin_layout Standard
22811 For more features of multiple columns, have a look at the documentation
22812 of the LaTeX-package
22817 \begin_inset Index idx
22820 \begin_layout Plain Layout
22821 LaTeX-packages ! multicol
22827 \begin_inset CommandInset citation
22836 \begin_layout Subsubsection
22840 \begin_layout Standard
22841 To add a preface text for multiple columns, add the command
22844 \begin_layout Standard
22850 \begin_layout Standard
22851 as TeX Code behind the number of columns in the
22853 Begin Multiple Columns
22856 Behind the command follows the preface text.
22857 At the end of the style use the command
22860 \begin_layout Standard
22866 \begin_layout Standard
22868 An example with some preface text:
22871 \begin_layout Standard
22872 \begin_inset VSpace bigskip
22878 \begin_layout Begin Multiple Columns
22883 \begin_layout Plain Layout
22890 And the story continues and continues and continues and continues\SpecialChar \ldots{}
22895 \begin_layout Plain Layout
22905 \begin_layout Standard
22908 On the evening of the crime, he returned from the club exactly at ten.
22909 His mother and sister were out spending the evening with a relation.
22910 The servant deposed that she heard him enter the front room on the second
22911 floor, generally used as his sitting-room.
22912 She had lit a fire there, and as it smoked she had opened the window.
22913 No sound was heard from the room until eleven-twenty, the hour of the return
22914 of Lady Maynooth and her daughter.
22915 Desiring to say good-night, she attempted to enter her son's room.
22916 The door was locked on the inside, and no answer could be got to their
22917 cries and knocking.
22918 Help was obtained, and the door forced.
22919 The unfortunate young man was found lying near the table.
22920 His head had been horribly mutilated by an expanding revolver bullet, but
22921 no weapon of any sort was to be found in the room.
22924 \begin_layout End Multiple Columns
22928 \begin_layout Standard
22929 You can also use a section heading as the preface if you use a section command
22930 as TeX Code behind the first TeX Code.
22931 For example the command
22934 \begin_layout Standard
22939 subsection{subsection title}
22942 \begin_layout Standard
22943 creates a subsection.
22944 In this example the preface is a subsubsection:
22947 \begin_layout Begin Multiple Columns
22952 \begin_layout Plain Layout
22963 \begin_layout Plain Layout
22972 This is a subsubsection heading as a preface
22976 \begin_layout Plain Layout
22987 \begin_layout Plain Layout
22997 \begin_layout Standard
23000 A minute examination of the circumstances served only to make the case more
23002 In the first place, no reason could be given why the young man should have
23003 fastened the door upon the inside.
23004 There was the possibility that the murderer had done this, and had afterwards
23005 escaped by the window.
23006 The drop was at least twenty feet, however, and a bed of crocuses in full
23008 Neither the flowers nor the earth showed any sign of having been disturbed,
23009 nor were there any marks upon the narrow strip of grass which separated
23010 the house from the road.
23011 Apparently, therefore, it was the young man himself who had fastened the
23013 But how did he come by his death? No one could have climbed up to the window
23014 without leaving traces.
23015 Suppose a man had fired through the window, he would indeed be a remarkable
23016 shot who could with a revolver inflict so deadly a wound.
23017 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
23018 a hundred yards of the house.
23019 No one had heard a shot.
23022 \begin_layout End Multiple Columns
23026 \begin_layout Standard
23027 If there is less vertical space left on the page at the beginning of the
23028 multiple columns than needed for 6
23029 \begin_inset space ~
23032 text lines, a page break will be inserted before the multiple columns.
23033 Depending on the number of lines of the preface text, you might want to
23035 It is determined by inserting the command
23038 \begin_layout Standard
23046 \begin_layout Standard
23047 as TeX Code behind the preface definition but before the final
23056 is hereby the number of text lines.
23057 In this example the space is set to 7
23058 \begin_inset space ~
23064 \begin_layout Begin Multiple Columns
23069 \begin_layout Plain Layout
23080 \begin_layout Plain Layout
23089 This is the sectioning command
23090 \begin_inset Newline newline
23094 \begin_inset Newline newline
23097 with multiple text lines
23101 \begin_layout Plain Layout
23112 \begin_layout Plain Layout
23125 \begin_layout Plain Layout
23135 \begin_layout Standard
23138 On the evening of the crime, he returned from the club exactly at ten.
23139 His mother and sister were out spending the evening with a relation.
23140 The servant deposed that she heard him enter the front room on the second
23141 floor, generally used as his sitting-room.
23142 She had lit a fire there, and as it smoked she had opened the window.
23143 No sound was heard from the room until eleven-twenty, the hour of the return
23144 of Lady Maynooth and her daughter.
23145 Desiring to say good-night, she attempted to enter her son's room.
23146 The door was locked on the inside, and no answer could be got to their
23147 cries and knocking.
23148 Help was obtained, and the door forced.
23149 The unfortunate young man was found lying near the table.
23150 His head had been horribly mutilated by an expanding revolver bullet, but
23151 no weapon of any sort was to be found in the room.
23154 \begin_layout End Multiple Columns
23158 \begin_layout Subsubsection
23162 \begin_layout Standard
23163 The amount of space before and after multiple columns can be changed by
23164 changing the length
23171 For example the command
23174 \begin_layout Standard
23184 \begin_layout Standard
23185 in TeX Code changes its value to 3
23186 \begin_inset space \thinspace{}
23190 The change must be made before the multiple columns' start.
23191 The predefined value is 13
23192 \begin_inset space \thinspace{}
23198 \begin_layout Standard
23206 \begin_inset space \thinspace{}
23212 \begin_layout Standard
23216 \begin_layout Plain Layout
23222 multicolsep}{2.5cm}
23230 \begin_layout Begin Multiple Columns
23234 \begin_layout Standard
23237 All day I turned these facts over in my mind, endeavouring to hit upon some
23238 theory which could reconcile them all, and to find that line of least resistanc
23239 e which my poor friend had declared to be the starting-point of every investigat
23241 I confess that I made little progress.
23242 In the evening I strolled across the Park, and found myself about six o'clock
23243 at the Oxford Street end of Park Lane.
23244 A group of loafers upon the pavements, all staring up at a particular window,
23245 directed me to the house which I had come to see.
23246 A tall, thin man with coloured glasses, whom I strongly suspected of being
23247 a plain-clothes detective, was pointing out some theory of his own, while
23248 the others crowded round to listen to what he said.
23249 I got as near him as I could, but his observations seemed to me to be absurd,
23250 so I withdrew again in some disgust.
23251 As I did so I struck against an elderly, deformed man, who had been behind
23252 me, and I knocked down several books which he was carrying.
23255 \begin_layout End Multiple Columns
23259 \begin_layout Standard
23260 \begin_inset Note Greyedout
23263 \begin_layout Plain Layout
23268 The values you set with
23274 will be used for all following multiple columns until you change them again.
23282 \begin_layout Standard
23286 \begin_layout Plain Layout
23298 \begin_inset Note Note
23301 \begin_layout Plain Layout
23302 go back to the default
23310 \begin_layout Standard
23311 \begin_inset Newpage newpage
23317 \begin_layout Subsubsection
23321 \begin_layout Standard
23322 The width of the columns is automatically calculated, but you can modify
23323 the space between the columns.
23324 This is done by changing the length
23331 Its predefined value is 10
23332 \begin_inset space \thinspace{}
23336 Here is an example where
23343 \begin_inset space \thinspace{}
23349 \begin_layout Standard
23353 \begin_layout Plain Layout
23367 \begin_layout Begin Multiple Columns
23371 \begin_layout Standard
23374 My observations of No.
23375 \begin_inset space \space{}
23378 427 Park Lane did little to clear up the problem in which I was interested.
23379 The house was separated from the street by a low wall and railing, the
23380 whole not more than five feet high.
23381 It was perfectly easy, therefore, for anyone to get into the garden, but
23382 the window was entirely inaccessible, since there was no water pipe or
23383 anything which could help the most active man to climb it.
23384 More puzzled than ever, I retraced my steps to Kensington.
23385 I had not been in my study five minutes when the maid entered to say that
23386 a person desired to see me.
23387 To my astonishment it was none other than my strange old book collector,
23388 his sharp, wizened face peering out from a frame of white hair, and his
23389 precious volumes, a dozen of them at least, wedged under his right arm.
23392 \begin_layout End Multiple Columns
23396 \begin_layout Standard
23400 \begin_layout Plain Layout
23412 \begin_inset Note Note
23415 \begin_layout Plain Layout
23416 go back to the default
23424 \begin_layout Subsubsection
23428 \begin_layout Standard
23429 Between the columns a rule with a width of the length
23436 If this rule width is set to 0
23437 \begin_inset space \thinspace{}
23440 pt (this is the default), the rule is suppressed.
23441 In the following example the line is 2
23442 \begin_inset space \thinspace{}
23448 \begin_layout Standard
23452 \begin_layout Plain Layout
23458 columnseprule}{2pt}
23466 \begin_layout Begin Multiple Columns
23470 \begin_layout Standard
23473 \begin_inset Quotes eld
23476 You're surprised to see me, sir,
23477 \begin_inset Quotes erd
23480 said he, in a strange, croaking voice.
23483 \begin_layout Standard
23486 I acknowledged that I was.
23489 \begin_layout Standard
23492 \begin_inset Quotes eld
23495 Well, I've a conscience, sir, and when I chanced to see you go into this
23496 house, as I came hobbling after you, I thought to myself, I'll just step
23497 in and see that kind gentleman, and tell him that if I was a bit gruff
23498 in my manner there was not any harm meant, and that I am much obliged to
23499 him for picking up my books.
23500 \begin_inset Quotes erd
23506 \begin_layout Standard
23509 \begin_inset Quotes eld
23512 You make too much of a trifle,
23513 \begin_inset Quotes erd
23518 \begin_inset Quotes eld
23521 May I ask how you knew who I was?
23522 \begin_inset Quotes erd
23528 \begin_layout Standard
23531 \begin_inset Quotes eld
23534 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
23535 you'll find my little bookshop at the corner of Church Street, and very
23536 happy to see you, I am sure.
23537 Maybe you collect yourself, sir.
23541 \begin_inset space ~
23554 --a bargain, every one of them.
23555 With five volumes you could just fill that gap on that second shelf.
23556 It looks untidy, does it not, sir?
23557 \begin_inset Quotes erd
23563 \begin_layout End Multiple Columns
23567 \begin_layout Standard
23571 \begin_layout Plain Layout
23577 columnseprule}{0pt}
23583 \begin_inset Note Note
23586 \begin_layout Plain Layout
23587 go back to the default
23595 \begin_layout Standard
23596 \begin_inset Newpage newpage
23602 \begin_layout Section
23603 Non-standard Paragraph Shapes
23606 \begin_layout Standard
23610 \begin_layout Plain Layout
23622 \begin_layout Standard
23626 \begin_layout Plain Layout
23635 \begin_layout Plain Layout
23649 \begin_layout Standard
23654 \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
23827 \begin_layout Plain Layout
23833 There are times when the tyranny of rectangular paragraphs must be overthrown.
23834 In such situations, a call to the delightful plain TeX command
23841 As you can see, completely arbitrary shapes can be laid out with a suitable
23842 set of line length definitions.
23843 While this parshape may look a bit silly and useless, one could conceive
23844 of situations such as finely tuned dropped capitals, word wrapping around
23845 non-rectangular graphics, etc.
23846 which will benefit from such handcrafting.
23849 \begin_layout Standard
23850 \begin_inset VSpace bigskip
23856 \begin_layout Standard
23861 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
23868 is the number of lines of text which define the paragraph.
23869 If there turn out to be fewer lines, the shape is truncated; if there are
23870 more, the excess lines have the same dimensions as the last line of the
23880 entries specify the indentation of the line from the left margin, and the
23881 length of the line as measured from that point.
23882 The shape applies only to the current paragraph; everything is reset to
23883 normal for the next paragraph.
23886 \begin_layout Standard
23890 \begin_layout Plain Layout
23902 \begin_layout Bibliography
23903 \begin_inset CommandInset bibitem
23904 LatexCommand bibitem
23909 Documentation of the LaTeX-package
23910 \begin_inset CommandInset href
23913 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
23918 \begin_inset Index idx
23921 \begin_layout Plain Layout
23922 LaTeX-packages ! multicol