1 #LyX 2.0 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 % redefine the \LyX macro for PDF bookmarks
37 \def\LyX{\texorpdfstring{%
38 L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
41 % used for multi-column text
44 % extra space for tables
45 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
47 % test for installed LaTeX packages
50 % for wrapped figures/tables
53 \IfFileExists{picinpar.sty}
54 {\usepackage{picinpar}
55 \setboolean{picinpar}{true}}
56 {\setboolean{picinpar}{false}}
58 \options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
59 \use_default_options false
65 \maintain_unincluded_children false
68 InsetLayout CharStyle:MenuItem
77 \newcommand*{\menuitem}[1]{{\sffamily #1}}
82 \language_package default
87 \font_typewriter default
88 \font_default_family default
89 \use_non_tex_fonts false
96 \default_output_format default
98 \bibtex_command default
99 \index_command default
103 \pdf_title "LyX's Additional Features manual"
104 \pdf_author "LyX Team"
105 \pdf_subject "LyX's additional features documentation"
106 \pdf_keywords "LyX, Documentation, Additional"
108 \pdf_bookmarksnumbered true
109 \pdf_bookmarksopen false
110 \pdf_bookmarksopenlevel 1
111 \pdf_breaklinks false
115 \pdf_pdfusetitle false
116 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
126 \paperorientation portrait
135 \paragraph_separation indent
136 \paragraph_indentation default
137 \quotes_language english
140 \paperpagestyle headings
141 \tracking_changes false
142 \output_changes false
151 Additional LyX Features
154 \begin_layout Subtitle
163 \begin_layout Plain Layout
165 Principal maintainer of this file is
170 If you have comments or error corrections, please send them to the LyX
171 Documentation mailing list,
172 \begin_inset Flex Code
175 \begin_layout Plain Layout
177 <lyx-docs@lists.lyx.org>
190 \begin_layout Standard
191 \begin_inset CommandInset toc
192 LatexCommand tableofcontents
199 \begin_layout Chapter
203 \begin_layout Standard
204 This manual is essentially Part II of the
206 User's Guide\SpecialChar \@.
209 The reason for separating this document out is simple: the
213 is already quite lengthy, and it contains information on all of the basic
214 features one needs to know in order to prepare most documents.
215 However, the LyX Team has worked to make LyX extensible through various
216 configuration files and external packages.
217 That means that if you want to support the Fizzwizzle LaTeX package, you
218 can create a layout file (or module) for it without having to alter LyX
220 We've already had contributions of several new features this way, and some
221 of them are documented here.
222 There are also some more `advanced' features, such as how to control the
223 presentation of bibliographies and how to work with multi-part documents,
224 that are not covered in the
228 and are discussed here.
231 \begin_layout Standard
232 This manual also documents some special features, like fax support, version
233 control, and SGML support, which require additional software to work properly.
234 There is also a chapter on LyX's support for HTML.
235 And lastly, there's a chapter of LaTeX tools and tips, things you can use
236 to spruce up your documents by directly using the powerful features of
242 only WYSIWYM and will only ever interface to some, not all, LaTeX features.
245 \begin_layout Standard
246 If you haven't read the
250 yet, you are definitely in the wrong manual.
255 is the first place to go, since it describes the notation and format of
257 You should also be thoroughly familiar with the
261 and all of the basic features of LyX before attempting to read this one.
264 \begin_layout Standard
265 Since many of the topics in this manual depend heavily on LyX's interaction
266 with LaTeX, this first chapter covers the inner workings of LyX and how
267 to direct LyX to generate exactly the LaTeX code you want.
268 It is obviously for more seasoned LyX users.
271 \begin_layout Chapter
275 \begin_layout Section
279 \begin_layout Standard
280 This chapter is for both TeX-nicians and the LaTeX-curious.
281 In it, we'll explain how LyX and LaTeX work together to produce printable
283 This is the only place in any of the manuals where we assume you know something
287 \begin_layout Standard
288 At one time, LyX was called a
289 \begin_inset Quotes eld
292 WYSIWYM frontend to LaTeX,
293 \begin_inset Quotes erd
296 but that's no longer true.
297 There are frontends to LaTeX out there.
301 \begin_layout Plain Layout
302 Some familar ones are TeXmaker and kile, on Linux, and TeXshop, OSX.
303 There are also the LaTeX modes for vi and emacs, of course.
308 These are basically text editors with the ability to run LaTeX and mark
309 any errors in the file you're editing.
318 run LaTeX, and it also indicates errors in the file, it also does much,
320 For one thing, you don't need to know LaTeX to use LyX effectively.
321 And LyX has added its own extensions to LaTeX.
322 Try the following sometime: select
323 \begin_inset Flex MenuItem
326 \begin_layout Plain Layout
327 Export\SpecialChar \menuseparator
334 \begin_inset Flex MenuItem
337 \begin_layout Plain Layout
344 \begin_inset Flex MenuItem
347 \begin_layout Plain Layout
348 View\SpecialChar \menuseparator
354 ), then look at the preamble of the resulting
355 \begin_inset Flex Code
358 \begin_layout Plain Layout
365 You'll notice a variety of new macros defined specifically by LyX.
366 These macros are defined automatically, according to the features you use
370 \begin_layout Standard
371 There are several commands that automatically invoke LaTeX.
375 \begin_layout Itemize
376 \begin_inset Flex MenuItem
379 \begin_layout Plain Layout
380 View\SpecialChar \menuseparator
389 \begin_layout Itemize
390 \begin_inset Flex MenuItem
393 \begin_layout Plain Layout
394 View\SpecialChar \menuseparator
395 Update\SpecialChar \menuseparator
404 \begin_layout Itemize
405 \begin_inset Flex MenuItem
408 \begin_layout Plain Layout
409 File\SpecialChar \menuseparator
418 \begin_layout Itemize
419 \begin_inset Flex MenuItem
422 \begin_layout Plain Layout
423 File\SpecialChar \menuseparator
432 \begin_layout Standard
433 They will only invoke LaTeX if the file has changed since the last time
438 \begin_layout Standard
439 When LyX runs LaTeX on the file you're editing, it performs these steps:
442 \begin_layout Enumerate
443 Convert the document to LaTeX and save to a file with the extension
444 \begin_inset Flex Code
447 \begin_layout Plain Layout
454 \begin_inset Flex Code
457 \begin_layout Plain Layout
466 \begin_layout Enumerate
468 \begin_inset Flex Code
471 \begin_layout Plain Layout
477 file (maybe several times), and run any other commands (such as
478 \begin_inset Flex Code
481 \begin_layout Plain Layout
488 \begin_inset Flex Code
491 \begin_layout Plain Layout
497 ) needed to compile the LaTeX file.
500 \begin_layout Enumerate
501 If there are any errors, show the error log.
504 \begin_layout Standard
505 If you've run LaTeX using
506 \begin_inset Flex MenuItem
509 \begin_layout Plain Layout
512 \SpecialChar \menuseparator
520 , LyX then runs a DVI viewer to display the DVI-file.
522 \begin_inset Flex MenuItem
525 \begin_layout Plain Layout
528 \SpecialChar \menuseparator
536 , LyX performs further steps:
539 \begin_layout Itemize
541 \begin_inset Flex Code
544 \begin_layout Plain Layout
550 to convert the DVI file to PostScript.
553 \begin_layout Itemize
554 Run a PostScript viewer, such as
555 \begin_inset Flex Code
558 \begin_layout Plain Layout
564 , to display the PostScript file.
567 \begin_layout Standard
568 LyX does similar things when viewing, or exporting, other formats.
571 \begin_layout Section
572 Translating LaTeX files into LyX
575 \begin_layout Standard
576 You can import a LaTeX file into LyX by using the
577 \begin_inset Flex MenuItem
580 \begin_layout Plain Layout
581 File\SpecialChar \menuseparator
582 Import\SpecialChar \menuseparator
589 This will call a program named
590 \begin_inset Flex Code
593 \begin_layout Plain Layout
599 which will create a file
600 \begin_inset Flex Code
603 \begin_layout Plain Layout
610 \begin_inset Flex Code
613 \begin_layout Plain Layout
620 LyX will then open that file.
624 \begin_layout Plain Layout
625 \begin_inset Flex Code
628 \begin_layout Plain Layout
634 can also be run from the command line, of course.
642 \begin_layout Standard
643 \begin_inset Flex Code
646 \begin_layout Plain Layout
652 will translate most legal LaTeX, but not everything.
653 It will put things it doesn't understand into TeX code, so after translating
655 \begin_inset Flex Code
658 \begin_layout Plain Layout
664 , you can look for TeX code and hand-edit it until it looks right.
667 \begin_layout Standard
668 If you don't know what TeX code is, read the next section.
671 \begin_layout Section
672 \begin_inset CommandInset label
674 name "sec:Inserting-TeX-Code"
678 Inserting TeX Code into LyX Documents
681 \begin_layout Standard
682 Anything you can do in LaTeX you can do in LyX, for a very simple reason:
683 You can always insert TeX code into any LyX document.
684 LyX cannot, and will never be able to, display every possible LaTeX construct.
685 If ever you need to insert LaTeX commands into your LyX document, you can
687 \begin_inset Flex Code
690 \begin_layout Plain Layout
696 box, which you can insert into your document with
697 \begin_inset Flex MenuItem
700 \begin_layout Plain Layout
701 Insert\SpecialChar \menuseparator
710 \begin_layout Standard
711 Here's an example of inserting LaTeX commands in a LyX document.
712 The code looks like this:
715 \begin_layout LyX-Code
719 \begin_inset Newline newline
725 \begin_inset Newline newline
728 This is an example for a minipage environment.
730 \begin_inset Newline newline
733 can put nearly everything in it, even (non-floating)
734 \begin_inset Newline newline
739 \begin_inset Newline newline
745 \begin_inset Newline newline
749 \begin_inset Newline newline
755 \begin_inset Newline newline
761 \begin_inset Newline newline
767 \begin_inset Newline newline
772 \begin_inset Newline newline
778 \begin_inset Newline newline
784 \begin_inset Newline newline
790 \begin_inset Newline newline
798 \begin_layout LyX-Code
802 \begin_layout Standard
804 \begin_inset Flex Code
807 \begin_layout Plain Layout
813 box containing this text is directly after this paragraph.
814 Those of you reading the manual in LyX will only see the TeX code inset.
815 Those reading a printed version of the manuals will see the actual results:
818 \begin_layout Standard
822 \begin_layout Plain Layout
829 \begin_layout Plain Layout
836 \begin_layout Plain Layout
838 This is an example for a minipage environment.
839 You can put nearly everything in it, even (non-floating) figures and tables.
843 \begin_layout Plain Layout
850 \begin_layout Plain Layout
855 \begin_layout Plain Layout
862 \begin_layout Plain Layout
869 \begin_layout Plain Layout
876 \begin_layout Plain Layout
882 \begin_layout Plain Layout
889 \begin_layout Plain Layout
896 \begin_layout Plain Layout
903 \begin_layout Plain Layout
915 \begin_layout Standard
916 In addition to using TeX code, you can also create a separate file containing
917 some complex LaTeX structure and then use
918 \begin_inset Flex MenuItem
921 \begin_layout Plain Layout
922 Insert\SpecialChar \menuseparator
932 to include your file (you should select the type
933 \begin_inset Flex Code
936 \begin_layout Plain Layout
943 We recommend that you only do this if you have a
944 \begin_inset Flex Code
947 \begin_layout Plain Layout
958 Otherwise, you'll have a big job tracking down LaTeX errors.
961 \begin_layout Standard
962 There are a few last points to emphasize:
965 \begin_layout Itemize
970 check if your LaTeX code is correct.
973 \begin_layout Itemize
974 Beware reinventing the wheel.
977 \begin_layout Standard
978 On that last point, LyX does have quite a few features tucked into it, and
980 Be sure to check the manuals to make sure that LyX doesn't have such-and-such
981 feature before you decide you have to do it by hand.
982 Moreover, there are numerous LaTeX packages out there to do all sorts of
983 things, from labels to envelopes to fancy multipage tables.
985 \begin_inset CommandInset href
988 target "http://www.ctan.org/"
992 for details, and see chapter
993 \begin_inset CommandInset ref
995 reference "cha:secrets"
1002 \begin_layout Standard
1003 If you do need to do some wild and fancy things within your document, be
1004 sure to check out a good LaTeX book for assistance.
1005 There are a number of them listed in the bibliography of the
1012 \begin_layout Section
1013 LyX and the LaTeX Preamble
1016 \begin_layout Subsection
1017 About the LaTeX Preamble
1020 \begin_layout Standard
1021 If you already know LaTeX, there is no need to explain here what the preamble
1023 If you don't, the following will give you some ideas—we recommend again
1024 that you consult a LaTeX book for further information.
1025 In any case, you should read the points below, because they explain what
1026 you can do and what you don't need to do in the LaTeX preamble of a LyX
1030 \begin_layout Standard
1031 The LaTeX preamble comes at the very beginning of a document,
1039 \begin_layout Itemize
1040 Declare the document class.
1042 \begin_inset Newline newline
1045 LyX already does this for you.
1046 If you're a seasoned LaTeX-nician, and you have a custom document class
1047 you want to use, check out the
1049 Customization Manual
1051 for information on how to make LyX interface to it.
1054 \begin_layout Itemize
1055 Declare the usage of packages.
1057 \begin_inset Newline newline
1060 LaTeX packages provide special commands, which are only available within
1061 a document when the package has been declared in the preamble.
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 which
1087 be set globally from within the preamble in order to have the desired effect.
1088 (There are variables which you can set and reset inside the document, too.)
1089 Margins are a good example of something which 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.
1578 Also, there are more examples and an assortment of LaTeX
1579 \begin_inset Quotes eld
1583 \begin_inset Quotes erd
1587 \begin_inset space ~
1591 \begin_inset CommandInset ref
1593 reference "cha:secrets"
1601 \begin_layout Section
1602 LyX and LaTeX Errors
1605 \begin_layout Standard
1606 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1608 It then uses the logfile from the LaTeX run to do a post-mortem.
1609 After analyzing the logfile,LyX displays a dialog listing the errors.
1610 Clicking on any one of them will take you to the position in your LyX file
1611 where the error occurred.
1615 \begin_layout Plain Layout
1617 Analyzing the logfile is a tough job, and LyX doesn't always go to the
1619 There are also cases where LaTeX reports the error on one line, but the
1620 actual error is earlier.
1621 This is not unlike forgetting a closing brace in a program: You'll get
1622 an error, but only later.
1630 \begin_layout Standard
1631 Some folks also like to look at the log file directly: It is available from
1633 \begin_inset Flex MenuItem
1636 \begin_layout Plain Layout
1639 \SpecialChar \menuseparator
1643 \begin_inset space ~
1652 There are some fairly common error messages and warnings.
1653 We'll cover those here.
1654 You should look at a good LaTeX book for a complete listing.
1657 \begin_layout Itemize
1658 \begin_inset Flex Code
1661 \begin_layout Plain Layout
1668 \begin_inset Newline newline
1671 Anything beginning with these words is a warning message for the purpose
1673 \begin_inset Quotes eld
1677 \begin_inset Quotes erd
1680 the LaTeX code itself.
1681 You'll get messages like this if you added or changed cross-references
1682 or bibliography entries, in which case, LaTeX is trying to tell you that
1683 you need to make another run.
1684 You can by-and-large ignore these.
1687 \begin_layout Itemize
1688 \begin_inset Flex Code
1691 \begin_layout Plain Layout
1698 \begin_inset Newline newline
1701 Another warning message, this time about fonts which LaTeX couldn't find.
1702 The rest of the message will often say something about a replacement font
1704 You can safely ignore these, too.
1707 \begin_layout Itemize
1708 \begin_inset Flex Code
1711 \begin_layout Plain Layout
1720 \begin_inset Newline newline
1728 They are warnings about lines that were too long and run past the right
1730 Almost always, this is unnoticeable in the final output.
1731 (It can be just a point or two.) Or, only one or two characters extend past
1733 LaTeX seems to generate at least one of these messages for just about any
1735 \begin_inset Newline newline
1738 You can ignore these messages.
1739 Your eyes will tell you if there's a problem with something that's too
1740 wide; just look at the output.
1744 \begin_layout Plain Layout
1745 You can also enable the `draft' option in
1746 \begin_inset Flex MenuItem
1749 \begin_layout Plain Layout
1752 \SpecialChar \menuseparator
1760 , and then LaTeX will draw a black box in the margin of lines that are overfull.
1768 \begin_layout Itemize
1769 \begin_inset Flex Code
1772 \begin_layout Plain Layout
1781 \begin_inset Newline newline
1784 Not quite as common as its cousin.
1785 LaTeX seems to like to print lines that are a bit too wide as opposed to
1786 ones that are a bit too narrow.
1787 We have no idea why.
1790 \begin_layout Itemize
1791 \begin_inset Flex Code
1794 \begin_layout Plain Layout
1803 \begin_inset Flex Code
1806 \begin_layout Plain Layout
1815 \begin_inset Newline newline
1818 Warnings about troubles breaking the page.
1819 Once again, just look at the output.
1820 Your eyes will tell you where something has gone wrong.
1823 \begin_layout Itemize
1824 \begin_inset Flex Code
1827 \begin_layout Plain Layout
1829 \begin_inset Quotes els
1833 \begin_inset Quotes ers
1842 \begin_inset Newline newline
1846 \begin_inset Quotes eld
1850 \begin_inset Quotes erd
1853 isn't installed on this system.
1854 This usually appears because some package your document needs isn't installed.
1855 If you didn't touch the preamble or didn't use the
1856 \begin_inset Flex Code
1859 \begin_layout Plain Layout
1867 command, then one of the packages LyX tried to load is missing.
1869 \begin_inset Flex MenuItem
1872 \begin_layout Plain Layout
1873 Help\SpecialChar \menuseparator
1879 to get a list of packages that LyX knows about.
1880 This file is updated whenever you reconfigure LyX (using
1881 \begin_inset Flex MenuItem
1884 \begin_layout Plain Layout
1885 Tools\SpecialChar \menuseparator
1891 ) and tells you which packages have been detected and what they do.
1892 \begin_inset Newline newline
1896 \begin_inset Flex Code
1899 \begin_layout Plain Layout
1907 command and the package in question isn't installed, then you'll need to
1908 install it yourself.
1911 \begin_layout Itemize
1912 \begin_inset Flex Code
1915 \begin_layout Plain Layout
1916 LaTeX Error: Unknown option
1922 \begin_inset Newline newline
1925 Error messages beginning with this are trying to tell you that you specified
1926 a bad or undefined option to a package.
1927 Check the package's documentation.
1930 \begin_layout Itemize
1931 \begin_inset Flex Code
1934 \begin_layout Plain Layout
1935 Undefined control sequence
1941 \begin_inset Newline newline
1944 If you've inserted LaTeX code into your document, but made a typo, you'll
1946 You may have forgotten to load a package.
1947 In any case, this error message usually means that you used an undefined
1952 \begin_layout Standard
1953 There are other error and warning messages.
1954 Some are self-explanatory.
1955 These are usually LaTeX messages.
1956 Others are downright cryptic.
1957 These are usually TeX error messages, and we really have
1961 what they mean or how to decipher them.
1965 \begin_layout Standard
1966 There's a general sequence you should follow if you get error messages:
1969 \begin_layout Enumerate
1970 Look at the LaTeX code you inserted for typos.
1973 \begin_layout Enumerate
1974 If there are no typos, check that you used the command(s) correctly.
1977 \begin_layout Enumerate
1978 If you get a bunch of error boxes piled up at the very top of the document—and
1979 especially if you see a
1980 \begin_inset Quotes eld
1984 \begin_inset Flex Code
1987 \begin_layout Plain Layout
1996 \begin_inset Quotes erd
1999 error—it means that there are errors in the preamble.
2000 Start debugging your preamble.
2003 \begin_layout Enumerate
2004 If you didn't add anything to the preamble and didn't add any LaTeX code
2005 to the document, the first suspect is your LaTeX distribution itself.
2006 Check for missing packages and install them.
2009 \begin_layout Enumerate
2010 Okay, so there are no missing packages.
2011 Did you use any of the fine-tuning options in LyX? Specifically, did you
2016 any of them, like trying to manually insert lots of
2017 \begin_inset Flex Code
2020 \begin_layout Plain Layout
2022 \begin_inset space ~
2031 \begin_inset Flex Code
2034 \begin_layout Plain Layout
2041 \begin_inset Flex Code
2044 \begin_layout Plain Layout
2050 ? Did you try to kludge something together with these instead of using the
2051 appropriate paragraph environment?
2054 \begin_layout Enumerate
2055 All right, you didn't use any of the fine-tuning options, you played by
2057 Did you try to pull a fancy maneuver? Did you do something funky inside
2058 a table or an equation, like inserting a graphic into a table cell?
2061 \begin_layout Enumerate
2062 Do you have long sections of text where LaTeX cannot find a place to break
2063 a line? By default, LaTeX is rather strict about how much extra inter-word
2064 spacing it will add in order to break a line.
2065 Preferably, you should rework the paragraph to avoid the problem.
2066 If this isn't an option, you can wrap your text in
2067 \begin_inset Flex Code
2070 \begin_layout Plain Layout
2078 to make LaTeX's line breaking more, well, sloppy.
2081 \begin_layout Enumerate
2082 Did you go overboard with the nesting? LyX (currently) doesn't check to
2083 make sure you're in the limits for nesting environments.
2084 If you nested a bunch of environments to the
2085 \begin_inset Formula $17^{\mathrm{th}}$
2088 level, that's the problem.
2089 (The limit in LaTeX is five.)
2092 \begin_layout Enumerate
2093 Okay, you didn't get any error messages, but your output looks awful.
2094 If you have a table or figure that's too wide or long for the page, you
2099 \begin_layout Enumerate
2100 rescale the figure so it fits.
2103 \begin_layout Enumerate
2104 trim down the table so it fits.
2108 \begin_layout Enumerate
2109 If something else is wrong with the output, and you didn't try to pull anything
2110 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2113 \begin_layout Standard
2114 If all this doesn't help—well, then
2118 you might have found a bug in LyX\SpecialChar \ldots{}
2122 \begin_layout Chapter
2126 \begin_layout Section
2127 Customizing Bibliographies with BibTeX
2130 \begin_layout Standard
2131 The most basic information about how to use BibTeX with LyX is contained
2134 Bibliography databases (BibTeX)
2141 The following subsections explain special bibliography features supported
2145 \begin_layout Subsection
2146 Alternative Citation Styles
2149 \begin_layout Standard
2150 Standard BibTeX uses numbers (e.
2151 \begin_inset space \thinspace{}
2155 \begin_inset space \space{}
2159 \begin_inset Quotes eld
2163 \begin_inset Quotes erd
2166 ) to refer to a cited work.
2167 However, in many scientific disciplines, other citation styles are in use.
2168 The most common one is the author-year style (e.
2169 \begin_inset space \thinspace{}
2173 \begin_inset space \space{}
2177 \begin_inset Quotes eld
2181 \begin_inset Quotes erd
2185 LyX supports two packages that provide this style,
2186 \begin_inset Flex Code
2189 \begin_layout Plain Layout
2196 \begin_inset Flex Code
2199 \begin_layout Plain Layout
2206 Both packages have their pros and cons, which cannot be listed in detail.
2207 If you only want to have simple author-year (or author-numerical) style,
2208 or if you want to use one of the countless style files for
2209 \begin_inset Flex Code
2212 \begin_layout Plain Layout
2218 , than the established
2219 \begin_inset Flex Code
2222 \begin_layout Plain Layout
2228 package is probably your choice.
2229 If you need special features like short title references, ibidem etc., you
2231 \begin_inset Flex Code
2234 \begin_layout Plain Layout
2243 \begin_layout Standard
2244 The handling of both packages in LyX is basically the same.
2246 \begin_inset Flex MenuItem
2249 \begin_layout Plain Layout
2250 Document\SpecialChar \menuseparator
2257 \begin_inset Flex MenuItem
2260 \begin_layout Plain Layout
2267 \begin_inset Flex MenuItem
2270 \begin_layout Plain Layout
2277 \begin_inset Flex MenuItem
2280 \begin_layout Plain Layout
2287 With both packages, you will get some extra features in the citation dialog
2288 and you can select the style of the reference (
2289 \begin_inset Quotes eld
2293 \begin_inset Quotes erd
2297 \begin_inset Quotes eld
2301 \begin_inset Quotes erd
2305 \begin_inset Quotes eld
2309 \begin_inset Quotes erd
2313 \begin_inset Quotes eld
2317 \begin_inset Quotes erd
2321 Note that both packages need specifically designed style files.
2322 They both ship their own, but there are lots of additional style files,
2323 and there is even an interactive style file builder
2327 \begin_layout Plain Layout
2329 \begin_inset Flex URL
2332 \begin_layout Plain Layout
2334 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2345 \begin_inset Flex Code
2348 \begin_layout Plain Layout
2357 \begin_layout Subsection
2358 Sectioned Bibliographies
2361 \begin_layout Standard
2362 Sometimes you might need to divide your bibliography into several sections.
2363 If you are for instance a historian, the possibility to separate sources
2364 and scientific works is most likely a
2365 \begin_inset Quotes eld
2369 \begin_inset Quotes erd
2373 Unfortunately, BibTeX itself does not allow you to do this.
2374 But with the help of some LaTeX packages, BibTeX can be extended to fit
2378 \begin_layout Standard
2379 LyX provides native support for one of these packages,
2387 \begin_layout Plain Layout
2389 \begin_inset Flex URL
2392 \begin_layout Plain Layout
2394 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2404 The advantage of this package (compared to other packages like
2408 ) is that you don't need to define new citation commands.
2409 Instead, you need to prepare different bibliographic databases which include
2410 the entries for the different sections of the bibliography.
2411 For example: If you want to divide your bibliography into the sections
2413 \begin_inset Quotes eld
2417 \begin_inset Quotes erd
2421 \begin_inset Quotes eld
2425 \begin_inset Quotes erd
2428 , you first need to create two bibliographic databases, e.
2429 \begin_inset space \thinspace{}
2433 \begin_inset space \space{}
2437 \begin_inset Flex Code
2440 \begin_layout Plain Layout
2447 \begin_inset Flex Code
2450 \begin_layout Plain Layout
2460 \begin_layout Standard
2462 \begin_inset Flex MenuItem
2465 \begin_layout Plain Layout
2466 Document\SpecialChar \menuseparator
2473 \begin_inset Flex MenuItem
2476 \begin_layout Plain Layout
2483 \begin_inset Flex MenuItem
2486 \begin_layout Plain Layout
2487 Sectioned bibliography
2493 Now you can insert multiple BibTeX bibliographies, one for each section
2494 of your bibliography.
2495 Returning to our example: Insert the BibTeX bibliography
2496 \begin_inset Flex Code
2499 \begin_layout Plain Layout
2505 and a second one for the database
2506 \begin_inset Flex Code
2509 \begin_layout Plain Layout
2516 You are free to use the same or different styles for each section.
2517 Additionally, you can chose if the bibliography section should contain
2519 \begin_inset Quotes eld
2522 all cited references
2523 \begin_inset Quotes erd
2526 of the specified database(s) (which is the default),
2527 \begin_inset Quotes eld
2530 all uncited references
2531 \begin_inset Quotes erd
2535 \begin_inset Quotes eld
2539 \begin_inset Quotes erd
2543 This might be useful if you would like to separate your bibliography into
2545 \begin_inset Quotes eld
2549 \begin_inset Quotes erd
2553 \begin_inset Quotes eld
2557 \begin_inset Quotes erd
2561 \begin_inset Quotes eld
2565 \begin_inset Quotes erd
2569 The titles for the sections can be added as ordinary sections or subsections.
2571 \begin_inset Flex Code
2574 \begin_layout Plain Layout
2580 removes the bibliography title, you have manually re-add that, too (as
2581 a chapter* or section*, for instance).
2584 \begin_layout Subsection
2585 Multiple Bibliographies
2588 \begin_layout Standard
2589 Multiple bibliographies, e.
2590 \begin_inset space \thinspace{}
2594 \begin_inset space \space{}
2597 a bibliography for each section or chapter of the document, are not supported
2600 \begin_inset Flex Code
2603 \begin_layout Plain Layout
2609 package, which is used for the creation of sectioned bibliographies in
2610 LyX (see the previous section), provides an easy way to solve this task,
2611 if you are willing to use some
2612 \begin_inset Flex MenuItem
2615 \begin_layout Plain Layout
2622 \begin_inset space ~
2626 \begin_inset CommandInset ref
2628 reference "sec:Inserting-TeX-Code"
2636 \begin_layout Plain Layout
2637 An alternative approach is to use the
2638 \begin_inset Flex Code
2641 \begin_layout Plain Layout
2648 \begin_inset Flex Code
2651 \begin_layout Plain Layout
2657 package, respectively.
2665 \begin_layout Standard
2667 \begin_inset Flex MenuItem
2670 \begin_layout Plain Layout
2671 Document\SpecialChar \menuseparator
2678 \begin_inset Flex MenuItem
2681 \begin_layout Plain Layout
2688 \begin_inset Flex MenuItem
2691 \begin_layout Plain Layout
2692 Sectioned bibliography
2698 In the document, you have to enclose the sections, which shall contain
2699 their own bibliography (including the BibTeX bibliography itself), between
2701 \begin_inset Flex Code
2704 \begin_layout Plain Layout
2713 \begin_inset Flex Code
2716 \begin_layout Plain Layout
2724 (those commands have to be inserted as TeX code).
2725 The bibliography will contain all references which have been cited in the
2727 \begin_inset Flex Code
2730 \begin_layout Plain Layout
2741 If you are using this approach, then every citation reference has to be
2743 \begin_inset Flex Code
2746 \begin_layout Plain Layout
2754 \begin_inset Flex Code
2757 \begin_layout Plain Layout
2766 \begin_layout Section
2770 \begin_layout Subsection
2774 \begin_layout Standard
2775 When you are working on a large file with many sections, it is often convenient
2776 to break up the document into several files, or perhaps you have something
2777 where a table may change from time to time, but the preceding text does
2779 In these cases, you should seriously consider using multipart documents.
2780 For example, scientific papers often have five major sections: the introduction
2781 , observations, results, discussion, and conclusion.
2782 Each of these could be its own separate LyX file, with one
2783 \begin_inset Quotes eld
2787 \begin_inset Quotes erd
2790 file which contains the title, authors, abstract, references, etc., plus
2791 the five included files.
2792 It is important to note that each of these files is a full LyX file which
2793 can be formatted and printed on its own, as well as included in a master
2795 Each of these files must have the same document class, however—don't attempt
2796 to mix book classes with article classes.
2797 You may also include LaTeX files; however, these files must not have their
2799 \begin_inset space \thinspace{}
2803 \begin_inset space \space{}
2806 everything up to and including the
2807 \begin_inset Flex Code
2810 \begin_layout Plain Layout
2819 \begin_inset Flex Code
2822 \begin_layout Plain Layout
2830 line must be deleted) or else errors will be generated when you try to
2834 \begin_layout Standard
2835 LyX allows you to include files quite easily with
2836 \begin_inset Flex MenuItem
2839 \begin_layout Plain Layout
2840 Insert\SpecialChar \menuseparator
2842 \begin_inset space ~
2851 When you click on this selection a small box is inserted into the file
2852 at the current cursor location.
2853 Clicking on the box raises a dialog which allows you to select the file
2854 to be included, and the method of its inclusion.
2858 \begin_layout Standard
2859 The file selection box should by now be obvious.
2860 The three inclusion methods are
2861 \begin_inset Quotes eld
2865 \begin_inset Quotes erd
2869 \begin_inset Quotes eld
2873 \begin_inset Quotes erd
2877 \begin_inset Quotes eld
2881 \begin_inset Quotes erd
2885 The difference between
2886 \begin_inset Quotes eld
2890 \begin_inset Quotes erd
2894 \begin_inset Quotes eld
2898 \begin_inset Quotes erd
2901 is really only meaningful to LaTeXperts, but the practical difference is
2902 that files which are
2903 \begin_inset Quotes eld
2907 \begin_inset Quotes erd
2910 are typeset beginning on a new page, while files which are
2911 \begin_inset Quotes eld
2915 \begin_inset Quotes erd
2918 are typeset starting on the current page.
2921 \begin_layout Standard
2922 Generally, the master file is converted into a full LaTeX file before typesettin
2923 g, while the included files are converted to LaTeX files which do not have
2924 all the preamble information.
2927 \begin_layout Standard
2929 \begin_inset Quotes eld
2933 \begin_inset Quotes erd
2936 included file allows you to include a file typeset exactly as it appears
2938 \begin_inset space \thinspace{}
2942 \begin_inset space \space{}
2946 \begin_inset Flex Code
2949 \begin_layout Plain Layout
2955 mode, with the characters set in a fixed-width typewriter font.
2956 Normally, spaces in this file are invisible, though two consecutive spaces
2957 are conserved, unlike LyX's normal treatment of spaces.
2958 However, setting the
2959 \begin_inset Flex MenuItem
2962 \begin_layout Plain Layout
2964 \begin_inset space ~
2968 \begin_inset space ~
2972 \begin_inset space ~
2980 checkbox typesets a mark to unambiguously define the presence of a space.
2984 \begin_layout Subsection
2985 Cross-References Between Files
2988 \begin_layout Standard
2989 \begin_inset Box Shadowbox
2999 height_special "totalheight"
3002 \begin_layout Plain Layout
3003 This section is somewhat out of date.
3004 Need to describe default master documents and how children are opened when
3014 \begin_layout Standard
3015 It is possible to set up cross-references between the different files.
3016 First, open all the files in question: let's call them A and B in a two
3017 file example, where B is included in A.
3018 Let's say you insert a label in A, then want to reference it in B.
3019 Open the cross-reference dialog in whilst in document B, and you can select
3021 \begin_inset Quotes eld
3025 \begin_inset Quotes erd
3031 \begin_layout Subsection
3032 Bibliography Lists in all Subdocuments
3035 \begin_layout Standard
3036 \begin_inset Box Frameless
3046 height_special "totalheight"
3049 \begin_layout Plain Layout
3050 This section also needs updating.
3051 There is now material about this on the wiki, and it could be copied here.
3059 \begin_layout Standard
3060 Copy the bibliography list with all entries to all subdocuments and transform
3062 This way LyX will find the
3063 \begin_inset Flex Code
3066 \begin_layout Plain Layout
3072 -files and you can easily insert references without making the bibliography
3076 \begin_layout Standard
3077 As the bibliography list is in a comment, LaTeX won't use use it and the
3078 references will look like this: [?], instead of like this: [1].
3079 One solution is to use the LaTeX-package
3080 \begin_inset Flex Code
3083 \begin_layout Plain Layout
3089 that will only include comments by processing the files separately.
3090 To do this, add in the LaTeX preamble of every subdocument the following:
3093 \begin_layout LyX-Code
3099 \begin_layout LyX-Code
3102 includecomment{comment}
3105 \begin_layout Standard
3107 \begin_inset Flex URL
3110 \begin_layout Plain Layout
3112 http://wiki.lyx.org/FAQ/Unsorted#toc31
3120 \begin_layout Section
3124 \begin_layout Standard
3125 Users sometimes need to be able to
3126 \begin_inset Quotes eld
3130 \begin_inset Quotes erd
3133 a LyX file together with all the images (and other files) on which it depends,
3134 either for sending to a publisher or for sharing with a co-author.
3135 LyX 2.0 includes a Python script (
3136 \begin_inset Flex Code
3139 \begin_layout Plain Layout
3145 ) that automates this process.
3146 To use it, you must have either the
3147 \begin_inset Flex Code
3150 \begin_layout Plain Layout
3157 \begin_inset Flex Code
3160 \begin_layout Plain Layout
3166 python modules installed on your system.
3167 By default, the script prefers the
3168 \begin_inset Flex Code
3171 \begin_layout Plain Layout
3178 \begin_inset Flex Code
3181 \begin_layout Plain Layout
3187 format on Unix-like systems and the
3188 \begin_inset Flex Code
3191 \begin_layout Plain Layout
3200 \begin_layout Standard
3201 LyX's configuration process will set the script up to export a `LyX Archive',
3202 and this format will then be available under
3203 \begin_inset Flex Code
3206 \begin_layout Plain Layout
3207 File\SpecialChar \menuseparator
3216 \begin_layout Standard
3217 Independently of the platform, the generation of a particular archive format
3218 can be forced by adding either the
3219 \begin_inset Flex Code
3222 \begin_layout Plain Layout
3229 \begin_inset Flex Code
3232 \begin_layout Plain Layout
3239 \begin_inset Flex Code
3242 \begin_layout Plain Layout
3249 \begin_inset Flex Code
3252 \begin_layout Plain Layout
3258 format) switch to the
3259 \begin_inset Flex Code
3262 \begin_layout Plain Layout
3263 LyX\SpecialChar \menuseparator
3270 \begin_inset Flex Code
3273 \begin_layout Plain Layout
3274 Tools\SpecialChar \menuseparator
3275 Preferences\SpecialChar \menuseparator
3276 File Handling\SpecialChar \menuseparator
3283 (Make sure you add the switch after the script name, not before it.)
3286 \begin_layout Section
3287 Fancy Headers and Footers
3290 \begin_layout Standard
3291 The default page layout is rather plain; for an
3292 \begin_inset Flex Code
3295 \begin_layout Plain Layout
3301 document class, all you get is a centered page number at the bottom of
3303 This document uses KOMA-script's book class, so it appears to be a bit
3305 But to really put on a show, you need to set the document page style to
3307 \begin_inset Quotes eld
3311 \begin_inset Quotes erd
3314 , as mentioned in the
3319 This section describes the LaTeX code you need to insert in your LaTeX
3320 preamble in order to get the desired effects.
3323 \begin_layout Standard
3324 For more information on fancy headers, see the
3325 \begin_inset Flex Code
3328 \begin_layout Plain Layout
3334 package documentation.
3336 \begin_inset Flex URL
3339 \begin_layout Plain Layout
3341 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
3349 \begin_layout Standard
3350 The page header is divided into three fields, not surprisingly labeled
3351 \begin_inset Quotes eld
3355 \begin_inset Quotes erd
3359 \begin_inset Quotes eld
3363 \begin_inset Quotes erd
3367 \begin_inset Quotes eld
3371 \begin_inset Quotes erd
3375 The footer is also divided into these three fields.
3376 The LaTeX commands to set these fields in the simplest manner are
3377 \begin_inset Flex Code
3380 \begin_layout Plain Layout
3389 \begin_inset Flex Code
3392 \begin_layout Plain Layout
3401 \begin_inset Flex Code
3404 \begin_layout Plain Layout
3413 \begin_inset Flex Code
3416 \begin_layout Plain Layout
3425 Suppose you wish to put your name in the upper left hand corner of each
3427 Simply insert the following command in the preamble:
3430 \begin_layout Standard
3439 \begin_layout Standard
3440 You will now see your name in the upper left.
3441 If a field has a default entry that you would like to get rid of (often
3442 the page number appears in the central footer, simply include a command
3443 with a blank argument, e.
3444 \begin_inset space \thinspace{}
3450 \begin_layout Standard
3458 \begin_layout Standard
3459 Let's get really fancy: lets put the section number with the word
3460 \begin_inset Quotes eld
3464 \begin_inset Quotes erd
3468 \begin_inset space \thinspace{}
3472 \begin_inset space \space{}
3475 Section 3) in the upper left, the page number (e.
3476 \begin_inset space \thinspace{}
3480 \begin_inset space \space{}
3483 Page 4) in the upper right, your name in the lower left, and the date in
3485 The following commands should now appear in the preamble:
3488 \begin_layout Standard
3498 \begin_layout Standard
3506 \begin_layout Standard
3516 \begin_layout Standard
3525 \begin_layout Standard
3533 \begin_layout Standard
3543 \begin_layout Standard
3545 \begin_inset Flex Code
3548 \begin_layout Plain Layout
3557 \begin_inset Flex Code
3560 \begin_layout Plain Layout
3568 access LaTeX's section and page counters, and so print out the current
3569 section and page numbers.
3571 \begin_inset Flex Code
3574 \begin_layout Plain Layout
3582 simply prints out today's date.
3585 \begin_layout Standard
3586 The thicknesses of the horizontal rules drawn beneath the header and above
3587 the footer can also be modified.
3588 If you don't want one of the rules, set its thickness to 0.
3589 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3595 \begin_inset Flex Code
3598 \begin_layout Plain Layout
3603 headrulewidth}{0.4pt}
3609 \begin_inset Flex Code
3612 \begin_layout Plain Layout
3617 footrulewidth}{0.4pt}
3622 to set the thicknesses.
3625 \begin_layout Standard
3626 You can switch the header/footer settings on and off for individual pages
3628 \begin_inset Flex Code
3631 \begin_layout Plain Layout
3634 thispagestyle{empty}
3640 \begin_inset Flex Code
3643 \begin_layout Plain Layout
3646 thispagestyle{plain}
3652 \begin_inset Flex Code
3655 \begin_layout Plain Layout
3658 thispagestyle{fancy}
3664 Simply insert them in the text on the page you want changed and mark them
3666 In fact, title pages are marked as plain by default, while following pages
3667 are marked fancy when using the global fancy setting.
3670 \begin_layout Standard
3671 As a final example, it is possible to include an image in the header or
3673 Suppose you want to put a company logo in the upper lefthand corner.
3674 You might try something like
3677 \begin_layout Standard
3686 includegraphics{logo.eps}}}
3689 \begin_layout Standard
3691 (you may need to preface this with
3692 \begin_inset Flex Code
3695 \begin_layout Plain Layout
3699 usepackage{graphics}
3704 if you don't include graphics elsewhere in your document).
3707 \begin_layout Section
3708 Itemize Bullet Selection
3709 \begin_inset CommandInset label
3718 \begin_layout Standard
3724 \begin_layout Subsection
3728 \begin_layout Standard
3729 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
3730 Using this dialog you can easily specify what bullet shape to use at each
3731 level of an itemized list.
3732 These settings are document-wide so you won't be able to specify different
3733 sets of bullets for different paragraphs.
3737 \begin_layout Plain Layout
3738 Well, actually you can but you'll have to do it by hand.
3746 \begin_layout Subsection
3750 \begin_layout Standard
3751 Open the dialog by selecting the
3752 \begin_inset Flex MenuItem
3755 \begin_layout Plain Layout
3756 Document\SpecialChar \menuseparator
3762 menu item and then select the
3763 \begin_inset Flex MenuItem
3766 \begin_layout Plain Layout
3775 \begin_layout Standard
3776 The dialog provides you with a table of bullet shapes.
3777 A column of buttons on the left of the table provides access to the six
3778 different panels of bullet shapes.
3779 The row of buttons across the top is used to select which bullet depth
3781 A text entry under the table shows the currently selected bullet shape's
3782 LaTeX equivalent and this can be edited if desired.
3783 If you do modify the text you will also need to specify any needed packages
3784 in the LaTeX preamble.
3787 \begin_layout Standard
3788 The six panels are divided up by the packages they require.
3789 The following table shows the mappings from button name to LaTeX packages.
3792 \begin_layout Standard
3794 \begin_inset Tabular
3795 <lyxtabular version="3" rows="7" columns="2">
3796 <features tabularvalignment="middle">
3797 <column alignment="center" valignment="top" width="0pt">
3798 <column alignment="center" valignment="top" width="0pt">
3800 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3803 \begin_layout Plain Layout
3818 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3821 \begin_layout Plain Layout
3838 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3841 \begin_layout Plain Layout
3856 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3859 \begin_layout Plain Layout
3875 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3878 \begin_layout Plain Layout
3893 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3896 \begin_layout Plain Layout
3913 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3916 \begin_layout Plain Layout
3931 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3934 \begin_layout Plain Layout
3951 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3954 \begin_layout Plain Layout
3969 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3972 \begin_layout Plain Layout
3989 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3992 \begin_layout Plain Layout
4007 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4010 \begin_layout Plain Layout
4027 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4030 \begin_layout Plain Layout
4045 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4048 \begin_layout Plain Layout
4071 \begin_layout Standard
4072 LyX doesn't stop you using bullets from packages you don't have.
4073 If you get errors from LaTeX when you try to view or print the file, then
4074 it is likely you are missing a package.
4078 \begin_layout Plain Layout
4079 LyX doesn't restrict your use since you may be editing locally and exporting
4088 \begin_layout Subsection
4092 \begin_layout Standard
4093 Select which bullet depth you want to change then select the bullet shape
4095 Any changes will not be visible in LyX, but are visible when viewing the
4099 \begin_layout Standard
4100 You can reset a bullet shape to the default simply by clicking your right
4101 mouse button on the appropriate bullet depth button.
4105 \begin_layout Plain Layout
4110 want to have multiple sets of paragraphs with different sets of bullets
4111 in each, then you're going to have to get your hands dirty with TeX code.
4112 The bullet selection dialog can help though because it provides you with
4113 the LaTeX code for a wide range of bullet shapes.
4114 To make your own custom paragraphs you have the following options:
4117 \begin_layout Plain Layout
4121 \begin_layout Plain Layout
4137 \begin_layout Plain Layout
4141 \begin_layout Plain Layout
4163 \begin_layout Itemize
4164 Use the LaTeX command
4165 \begin_inset Flex Code
4168 \begin_layout Plain Layout
4176 to specify a new bullet shape for a given depth.
4177 You'll also need to save the current bullet shape so you can restore it
4179 In this itemized list the following LaTeX code was used to change the bullet
4180 used for the first depth.
4184 \begin_layout LyX-Code
4194 \begin_layout LyX-Code
4211 \begin_layout Itemize
4212 Note that the itemize depth is specified in Roman numerals as part of the
4222 \begin_layout Itemize
4226 \begin_layout Plain Layout
4239 Specify each individual entry by starting each item with the bullet shape
4240 enclosed in square brackets and set as
4241 \begin_inset Flex MenuItem
4244 \begin_layout Plain Layout
4251 For example, this item was started with
4252 \begin_inset Flex Code
4255 \begin_layout Plain Layout
4270 \begin_layout Plain Layout
4274 \begin_layout Plain Layout
4290 \begin_layout Plain Layout
4291 You'll also need to revert the labelitem back to its previous setting for
4292 the global bullet shape settings to remain in effect.
4293 The way used here was:
4296 \begin_layout LyX-Code
4311 \begin_layout Chapter
4312 LyX and the World Wide Web
4315 \begin_layout Standard
4316 LyX has long supported the export of documents to various web-friendly formats,
4318 Before verson 2.0, however, HTML export was always accomplished by the use
4319 of external converters.
4323 \begin_layout Plain Layout
4324 For details on the use of external converters with LyX, see the
4328 section of the Customization manual.
4333 These fall into two large groups: there are converters that use LaTeX as
4334 an intermediate format, such as
4335 \begin_inset Flex Code
4338 \begin_layout Plain Layout
4345 \begin_inset Flex Code
4348 \begin_layout Plain Layout
4355 \begin_inset Flex Code
4358 \begin_layout Plain Layout
4364 , relying upon LyX to produce the LaTeX; and there is a converter that works
4365 directly on LyX files,
4366 \begin_inset Flex Code
4369 \begin_layout Plain Layout
4376 All of these have different advantages and disadvantages.
4380 \begin_layout Standard
4381 The LaTeX-based converters have the advantage that, in principle, they know
4382 everything about the exported document that LaTeX does.
4383 Such converters do not care, for example, if a certain block of code was
4384 produced by LyX or was Evil Red Text.
4385 These converters know about
4386 \begin_inset Flex Code
4389 \begin_layout Plain Layout
4395 files, counters, and references, and can often make use of the
4396 \begin_inset Flex Code
4399 \begin_layout Plain Layout
4405 files generated by BibTeX.
4406 On the other hand, LaTeX is a very hard language to parse---it is sometimes
4407 said that only TeX itself understands TeX---and LaTeX-based converters
4408 will often choke on what seem to be quite simple constructs; complex ones
4409 can throw them completely, and as of this writing, for example, the
4413 manual will not export with
4414 \begin_inset Flex Code
4417 \begin_layout Plain Layout
4423 , though the others will.
4424 The other issue concerns how math is handled.
4425 These converters typically convert the formulae into little pictures that
4426 are then linked from the HTML document.
4427 Since these are actually generated by LaTeX, they are accurate.
4428 But they do not scale well, and just getting them to look as if they are
4429 actually meant to be in your document---so that the font sizes seem to
4430 be roughly the same---can be a challenge.
4433 \begin_layout Standard
4435 \begin_inset Flex Code
4438 \begin_layout Plain Layout
4445 \begin_inset CommandInset href
4447 name "http://elyxer.nongnu.org/"
4448 target "http://elyxer.nongnu.org/"
4452 ) solves some of these problems.
4453 In particular, the formulae it produces scale perfectly, since it renders
4454 math using a combination of HTML and CSS rather than converting the formulae
4456 But even moderately complex formula are rendered less well than with
4457 \begin_inset Flex Code
4460 \begin_layout Plain Layout
4466 ; this reflects the limitations of HTML.
4470 \begin_layout Plain Layout
4472 \begin_inset Flex Code
4475 \begin_layout Plain Layout
4481 can also use jsMath and MathJax for equations, but this setting is only
4482 available globally and requires one to have access to a server that runs
4488 More importantly (as of version 1.1.1, at least),
4489 \begin_inset Flex Code
4492 \begin_layout Plain Layout
4498 has limited support for math macros and no support for user-defined paragraph
4499 or character styles.
4500 These limitations make
4501 \begin_inset Flex Code
4504 \begin_layout Plain Layout
4510 unsuitable for many of the documents LyX users produce.
4511 In principle, of course, these problems could be solved, but the LyX developers
4512 have decided to follow a different path and have made LyX itself capable
4513 of writing XHTML, just as it is capable of writing LaTeX, DocBook, and
4517 \begin_layout Standard
4518 As of this writing, XHTML output remains under development and should probably
4520 \begin_inset Quotes eld
4524 \begin_inset Quotes erd
4531 \begin_layout Plain Layout
4533 \begin_inset Flex Code
4536 \begin_layout Plain Layout
4537 development/HTML.notes
4542 , which can be found in the LyX source tree or
4543 \begin_inset CommandInset href
4545 name "accessed online"
4546 target "http://www.lyx.org/trac/browser/lyx-devel/trunk/development/HTML/HTML.notes"
4550 , usually contains up-to-date information about the state of XHTML output.
4551 See also the list of XHTML bugs on
4552 \begin_inset CommandInset href
4554 name "the bug tracker"
4555 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"
4564 Still, the developers have chosen this approach because it has several
4565 potential advantages over the other two.
4568 \begin_layout Standard
4569 These advantages are primarily due to the fact that the XHTML output routines,
4570 since they are part of LyX, know everything LyX knows about the document
4575 \begin_layout Plain Layout
4576 Another advantage is that, since these routines are internal to LyX, they
4577 are immune to changes in LyX's file format, or to changes in the semantics
4583 So they know about the table of contents (as displayed in the outline),
4584 about the counters associated with different paragraph styles, and about
4585 user-defined styles.
4586 The XHTML output routines know what LyX knows about internationalization,
4587 too, so they will output
4588 \begin_inset Quotes eld
4592 \begin_inset Quotes erd
4596 \begin_inset Quotes eld
4604 \begin_inset Quotes erd
4607 , depending upon the language in effect at the time.
4611 \begin_layout Standard
4612 Quite generally, the output routines know what LyX knows about document
4613 layout, that is, about how the document is to be rendered on screen.
4614 We use this information when we output the document as XHTML.
4619 generates CSS style information corresponding to the layout information
4620 it uses to render the document on screen: if section headings are supposed
4621 to be sans-serif and bold as seen in LyX, then (by default) they will be
4622 sans-serif and bold when viewed in a web browser, too.
4623 And this is true not just for pre-defined styles, like Section, but for
4624 any style, including user-defined styles.
4625 Indeed, the XHTML output routines make no distinction between user-defined
4626 paragraph and character styles and LyX's own pre-defined styles: in each
4627 case, everything LyX knows about the styles is contained in the layout
4629 And much the same is true as regards pre-defined textual insets, such as
4630 footnotes, and various custom insets.
4634 \begin_layout Standard
4635 The result is that XHTML output can be customized and extended in exactly
4636 the same way LaTeX output can be customized and extended: through layout
4638 See chapter five of the
4642 manual for the details.
4645 \begin_layout Standard
4646 The remainder of this chapter contains more detailed information on XHTML
4647 output, its limitations, and ways to work around those limitations.
4650 \begin_layout Section
4651 Math Output in XHTML
4654 \begin_layout Standard
4655 LyX offers four choices for how math is rendered.
4656 These have various advantages and disadvantages:
4659 \begin_layout Itemize
4661 \begin_inset Newline newline
4664 MathML is a dialect of XML designed specifically for mathematics on the
4665 web, and it typically renders very well in browsers that support it.
4666 The disadvantage is that not all browsers support MathML, and support is
4667 not complete even in the Gecko-based browsers, such as Firefox.
4668 \begin_inset Newline newline
4671 If LyX is unable to render a formula as MathML---for example, if the formula
4673 \begin_inset Flex Code
4676 \begin_layout Plain Layout
4682 package or ERT---then it will instead output the formula as an image.
4686 \begin_layout Itemize
4688 \begin_inset Newline newline
4692 \begin_inset Flex Code
4695 \begin_layout Plain Layout
4701 outputs math as HTML, styled by CSS.
4705 \begin_layout Plain Layout
4706 LyX has borrowed some of the CSS for its HTML output from
4707 \begin_inset Flex Code
4710 \begin_layout Plain Layout
4721 For simple formulae, this can work quite well, though with more complicated
4722 formulae it tends to break down.
4723 Still, this method has the advantage that it is very widely supported and
4724 so it may be appropriate for documents that contain only a little, fairly
4726 \begin_inset Newline newline
4729 If Lyx is unable to render a formula as HTML---for example, if the formula
4731 \begin_inset Flex Code
4734 \begin_layout Plain Layout
4740 package or ERT---then it will instead output the formula as an image.
4744 \begin_layout Itemize
4746 \begin_inset Newline newline
4750 \begin_inset Flex Code
4753 \begin_layout Plain Layout
4759 , LyX will output formulae as images, the very same images, in fact, that
4760 are used for instant preview.
4764 \begin_layout Plain Layout
4765 Instant preview does
4769 have to be on for images to be output, however.
4774 The advantage to this method is that the images are simply generated by
4775 LaTeX, so they are very accurate.
4776 The disadvantage, as mentioned earlier, is that these are bitmapped images,
4777 so they do not scale terribly well, and one cannot copy them, etc.
4778 (As of this writing, there are also problems about equation numbering.
4780 \begin_inset CommandInset href
4783 target "http://www.lyx.org/trac/ticket/6894"
4788 \begin_inset Newline newline
4791 The size of the images can be controlled by setting the
4792 \begin_inset Quotes eld
4796 \begin_inset Quotes erd
4800 \begin_inset Flex MenuItem
4803 \begin_layout Plain Layout
4804 Document\SpecialChar \menuseparator
4805 Settings\SpecialChar \menuseparator
4815 \begin_layout Plain Layout
4816 For those who want to know, this controls the resolution of the image in
4817 dots per inch and is based upon a default of 75 dpi.
4823 \begin_inset Newline newline
4826 If LyX for some reason fails to create an image for a formula (e.g., if a
4827 required LaTeX package is not installed), then it will fall back to outputing
4831 \begin_layout Itemize
4833 \begin_inset Newline newline
4836 Finally, LyX will happily output math as LaTeX.
4837 As well as being the output of last resort, this method can be used with
4839 \begin_inset CommandInset href
4842 target "http://www.math.union.edu/~dpvc/jsMath/"
4846 , which uses JavaScript to render LaTeX embedded in HTML documents.
4847 LyX wraps the LaTeX in either a
4848 \begin_inset Flex Code
4851 \begin_layout Plain Layout
4857 (for inline formulas) or
4858 \begin_inset Flex Code
4861 \begin_layout Plain Layout
4867 (for displayed formulas) with
4868 \begin_inset Flex Code
4871 \begin_layout Plain Layout
4877 , as is required for jsMath.
4880 \begin_layout Standard
4881 One of these output methods must be selected under
4882 \begin_inset Flex MenuItem
4885 \begin_layout Plain Layout
4886 Document\SpecialChar \menuseparator
4887 Settings\SpecialChar \menuseparator
4894 By default, LyX outputs MathML.
4895 This is a document-wide setting, therefore.
4898 \begin_layout Standard
4899 Eventually, LyX will offer the user the option to select an alternate output
4900 method for a particular inset, say, one that isn't being rendered very
4905 \begin_layout Plain Layout
4906 That said, since LyX falls back to images if the inset contains ERT, then
4907 one can force output as an image by putting some harmless ERT into the
4909 \begin_inset Formula $a=b\relax$
4920 \begin_layout Section
4921 Bibliography and Citations
4924 \begin_layout Standard
4925 XHTML output fully supports bibliographies and citations.
4929 \begin_layout Standard
4930 Citation labels are generated by the same machinery that generates LyX's
4931 on-screen labels, so the labels will look in the output much as they do
4932 in LyX, though better.
4933 If you are using numerical citations, then LyX will output numerical labels,
4934 such as [1] or [17], rather than simply showing the citation key in square
4935 brackets, as it does on-screen.
4936 If you are using author-year citations, then LyX will add lowercase letters
4937 to the years, just as BibTeX does, if it finds more than one citation for
4938 a given author-year combination.
4939 The labels will be printed with the bibliography entries.
4940 Note that there is, at present, no way to customize the appearance of the
4941 labels, for example, to choose between square brackets and parentheses.
4944 \begin_layout Standard
4945 Bibliography output is handled by the same machinery that handles the presentati
4946 on of reference information in the citation dialog, so you will see in the
4947 XHTML output pretty much what you would see if you were to look at a given
4948 entry in the citation dialog.
4949 The formatting can be customized in your layout file or, preferably, in
4955 manual for the details.
4958 \begin_layout Standard
4959 The main defect at present is that cross-referenced information is printed
4960 with every entry with which it is associated.
4961 So you can see things like this:
4966 \begin_inset Quotes eld
4969 Context and Logical Form
4970 \begin_inset Quotes erd
4975 Language in Context: Selected Essays
4977 (Oxford: Oxford University Press, 2007), pp.
4983 \begin_inset Quotes eld
4986 Semantics in Context
4987 \begin_inset Quotes erd
4992 Language in Context: Selected Essays
4994 (Oxford: Oxford University Press, 2007), pp.
4998 \begin_layout Standard
4999 This should be fixed before long.
5002 \begin_layout Standard
5003 There is no support at present for sectioned bibliographies.
5004 If you have multiple bibliographies, then LyX will print the same bibliography
5008 \begin_layout Section
5012 \begin_layout Standard
5013 LyX will happily export indexes as XHTML, but with certain limitations at
5017 \begin_layout Standard
5018 Index export will be most reliable when you do not attempt to use the fancy
5019 constructs that are described in the section on indexes in the
5027 \begin_layout Plain Layout
5028 The main issue here is that LyX itself does not really handle these.
5029 It just lets you enter what you would have to enter in raw LaTeX.
5034 We'll describe how they are handled using the subsection headings from
5038 \begin_layout Itemize
5039 Grouping Index Entries (aka, sub-entries): LyX makes an effort to support
5040 these, but the entries must be separated by
5041 \begin_inset Quotes eld
5045 \begin_inset Quotes erd
5048 , that is, there must be spaces around the exclamation point.
5049 This is because it is otherwise too difficult to check for escaped exclamation
5050 points, ones in math, and so forth.
5053 \begin_layout Itemize
5054 Page Ranges: There is no support at all for page ranges, since these make
5055 no sense with XHMTL.
5056 Instead, you will just get two index entries, one at either end.
5059 \begin_layout Itemize
5060 Cross-referencing: There is no support for cross-referencing.
5061 If LyX finds an entry containing the
5062 \begin_inset Quotes eld
5065 |see\SpecialChar \ldots{}
5067 \begin_inset Quotes erd
5070 construct, it is just dropped, and the rest is treated as an ordinary index
5074 \begin_layout Itemize
5075 Index Entry Order: LyX does support attempts to fix the sorting order.
5076 It will take what is before the first `@' it finds and use that for sorting,
5077 taking what follows the first `@' to be the actual entry.
5078 At present, LyX does not check for escaped `@', so do not try to index
5082 \begin_layout Itemize
5083 Index Entry Layout: You can format entries by using the text style dialog,
5084 or by using any other method available within LyX itself.
5085 There is no support for constructs like:
5086 \begin_inset Quotes eld
5090 \begin_inset Quotes erd
5094 Indeed, if LyX finds a pipe symbol, `|', in an entry, it will delete it
5095 and everything that follows it.
5098 \begin_layout Itemize
5099 Multiple Indexes: There is no support for multiple indexes.
5100 Rather, all index entries will be printed as one large index.
5101 To avoid our printing several versions of the index, we print only the
5102 main index, so make sure you have one.
5105 \begin_layout Section
5106 Nomenclature and Glossary
5109 \begin_layout Standard
5110 There is at present no support for glossaries.
5111 Adding it would be fairly trivial, and welcome.
5114 \begin_layout Chapter
5118 \begin_layout Section
5122 \begin_layout Standard
5123 The `LyX server' allows other programs to talk to LyX, invoke LyX commands,
5124 and retrieve information about the LyX internal state.
5125 This is only intended for advanced users, but they should find it useful.
5126 It is by writing to the LyX server, for example, that bibliography managers,
5127 such as JabRef, are able to
5128 \begin_inset Quotes eld
5132 \begin_inset Quotes erd
5138 \begin_layout Section
5139 Starting the LyX Server
5142 \begin_layout Standard
5143 The LyX server works through the use of a pair of named pipes.
5144 These are usually located in
5145 \begin_inset Flex Code
5148 \begin_layout Plain Layout
5154 , (except on Windows, where
5158 named pipes are special objects located in
5159 \begin_inset Flex Code
5162 \begin_layout Plain Layout
5174 ) and have the names
5175 \begin_inset Quotes eld
5179 \begin_inset Flex Code
5182 \begin_layout Plain Layout
5189 \begin_inset Quotes erd
5193 \begin_inset Quotes eld
5197 \begin_inset Flex Code
5200 \begin_layout Plain Layout
5207 \begin_inset Quotes erd
5211 External programs write into
5212 \begin_inset Flex Code
5215 \begin_layout Plain Layout
5221 and read back data from
5222 \begin_inset Flex Code
5225 \begin_layout Plain Layout
5232 The stem of the pipe names can be defined in the
5233 \begin_inset Flex MenuItem
5236 \begin_layout Plain Layout
5237 Tools\SpecialChar \menuseparator
5244 \begin_inset Flex Code
5247 \begin_layout Plain Layout
5248 "/home/myhome/lyxpipe"
5254 \begin_inset Flex Code
5257 \begin_layout Plain Layout
5271 on Windows (but any working path can be used).
5276 configure this manually in order for the server to start.
5279 \begin_layout Standard
5281 \begin_inset Flex Code
5284 \begin_layout Plain Layout
5291 \begin_inset Flex Code
5294 \begin_layout Plain Layout
5300 ' to create the pipes.
5301 If one of the pipes already exists, LyX will assume that another LyX process
5302 is already running and will not start the server.
5303 On POSIX (Unix like) systems, if for some other reason, an unused
5304 \begin_inset Quotes eld
5308 \begin_inset Quotes erd
5311 pipe is left in existence when LyX closes, then LyX will try to delete
5313 If this fails for some reason, you will need to delete the pipes manually
5314 and then restart LyX.
5315 On Windows, pipes are deleted by the OS on program termination or crash,
5317 \begin_inset Quotes eld
5321 \begin_inset Quotes erd
5324 pipes should not be possible.
5327 \begin_layout Standard
5328 To have several LyX processes with servers at the same time, you have to
5329 use different configurations, perhaps by using separate user directories,
5331 \begin_inset Flex Code
5334 \begin_layout Plain Layout
5340 file, for each process.
5343 \begin_layout Standard
5344 If you are developing a client program, you might find it useful to enable
5345 debugging information from the LyX server.
5346 Do this by starting LyX as
5347 \begin_inset Flex Code
5350 \begin_layout Plain Layout
5359 \begin_layout Standard
5360 You can find a complete example client written in C in the source distribution
5362 \begin_inset Flex Code
5365 \begin_layout Plain Layout
5366 development/lyxserver/server_monitor.c
5374 \begin_layout Standard
5375 Another useful tool is command-line based client you will find in
5376 \begin_inset Flex Code
5379 \begin_layout Plain Layout
5380 src/client/lyxclient
5388 \begin_layout Section
5389 Normal communication
5392 \begin_layout Standard
5393 To issue a LyX call, the client writes a line of ASCII text into the input
5395 This line has the following format:
5412 \begin_layout Description
5413 clientname is a name that the client can choose arbitrarily.
5414 Its only use is that LyX will echo it if it sends an answer—so a client
5415 can dispatch results from different requesters.
5418 \begin_layout Description
5419 function is the function you want LyX to perform.
5420 It is the same as the commands you'd use in the minibuffer.
5423 \begin_layout Description
5424 argument is an optional argument which is meaningful only to some functions
5426 \begin_inset Quotes eld
5430 \begin_inset Quotes erd
5433 LFUN will insert the argument as text at the cursor position).
5436 \begin_layout Standard
5437 The answer from LyX will arrive in the output pipe and be of the form
5454 \begin_layout Standard
5463 are just echoed from the command request, while
5467 is more or less useful information filled according to how the command
5468 execution worked out.
5469 Some commands, such as
5470 \begin_inset Quotes eld
5474 \begin_inset Quotes erd
5477 , will return information about the internal state of LyX, while other will
5478 return an empty data-response.
5479 This means that the command execution went fine.
5482 \begin_layout Standard
5483 In case of errors, the response from LyX will have this form
5500 \begin_layout Standard
5505 should contain an explanation of why the command failed.
5508 \begin_layout Standard
5512 \begin_layout LyX-Code
5513 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
5514 \begin_inset Newline newline
5517 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
5518 \begin_inset Newline newline
5521 read a <~/.lyxpipe.out
5522 \begin_inset Newline newline
5528 \begin_layout Section
5532 \begin_layout Standard
5533 LyX can notify clients of events going on asynchronously.
5534 Currently it will only do this if the user binds a key sequence with the
5536 \begin_inset Quotes eld
5540 \begin_inset Quotes erd
5544 The format of the string LyX sends is as follows:
5548 \begin_inset Flex Code
5551 \begin_layout Plain Layout
5562 \begin_layout Standard
5567 is the printed representation of the key sequence that was actually typed
5571 \begin_layout Standard
5572 This mechanism can be used to extend LyX's command set and implement macros.
5573 Bind some key sequence to
5574 \begin_inset Quotes eld
5578 \begin_inset Quotes erd
5582 Then start a client that listens on the output pipe, dispatches the command
5583 according to the sequence, and starts a function that may use LyX calls
5584 and LyX requests to issue a command or a series of commands to LyX.
5587 \begin_layout Section
5588 The simple LyX Server Protocol
5591 \begin_layout Standard
5592 LyX implements a simple protocol that can be used for session management.
5593 All messages are of the form
5606 \begin_layout Standard
5612 \begin_inset Quotes eld
5616 \begin_inset Quotes erd
5620 \begin_inset Quotes eld
5624 \begin_inset Quotes erd
5629 \begin_inset Quotes eld
5633 \begin_inset Quotes erd
5636 is received from a client, LyX will report back to inform the client that
5637 it's listening to it's messages, while
5638 \begin_inset Quotes eld
5642 \begin_inset Quotes erd
5645 sent from LyX will inform clients that LyX is closing.
5648 \begin_layout Section
5649 Reverse DVI/PDF search
5652 \begin_layout Standard
5653 Some DVI/PDF viewers
5657 \begin_layout Plain Layout
5658 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
5659 Skim on Mac OSX and SumatraPDF on Windows.
5668 facility (also called
5673 This means that you can tell LyX to put the cursor to a specific line in
5674 the document by clicking at the respective position in the DVI/PDF output.
5675 To achieve this, the viewer must be able to communicate with LyX.
5676 This is done via the LyX server either by using the named pipe (
5680 ), or the UNIX domain socket (
5684 ) that LyX creates in its temporary directory (this is the way the
5685 \begin_inset Flex Code
5688 \begin_layout Plain Layout
5694 program communicates with LyX).
5695 In some cases, you need a helper script that mediates between the viewer
5696 and LyX, in others, the viewer can communicate with LyX directly.
5697 This depends on the selected viewer and on your operating system.
5698 The same applies to the way viewers need to be configured and the way the
5699 reverse search is actually performed.
5700 In what follows, we will thus describe how to setup reverse search for
5702 Before we turn to this, though, we will explain what needs to be done generally
5703 to enable reverse search in the DVI/PDF output.
5706 \begin_layout Subsection
5708 \begin_inset CommandInset label
5710 name "sub:rev-search"
5717 \begin_layout Standard
5718 In most cases LyX will do the work for you by enabling
5719 \begin_inset Flex MenuItem
5722 \begin_layout Plain Layout
5723 Document\SpecialChar \menuseparator
5724 Output\SpecialChar \menuseparator
5725 Synchronize with Output
5731 In such a case LyX will automatically insert the necessary SyncTeX macro
5732 (for PDF) or load the srcltx package (for DVI) respectively.
5733 This option can be easily reached also on
5734 \begin_inset Flex Code
5737 \begin_layout Plain Layout
5746 \begin_layout Standard
5747 If you need a different setting, you can select or input a custom macro
5748 from the drop down box just below
5749 \begin_inset Flex MenuItem
5752 \begin_layout Plain Layout
5753 Document\SpecialChar \menuseparator
5754 Settings\SpecialChar \menuseparator
5755 Output\SpecialChar \menuseparator
5756 Synchronize with Output
5764 \begin_layout Standard
5765 Please note that including the
5766 \begin_inset Flex Code
5769 \begin_layout Plain Layout
5776 \begin_inset Flex Code
5779 \begin_layout Plain Layout
5785 sometimes has an undesired impact on the typesetting.
5786 Thus, you should switch output synchronization off for the final typesetting
5788 \begin_inset Flex Code
5791 \begin_layout Plain Layout
5798 \begin_inset Flex Code
5801 \begin_layout Plain Layout
5810 \begin_layout Standard
5811 In case you need some more special settings that are not covered by the
5812 automatic settings, read the next section about how to set up output synchroniz
5814 If the automatic setup suits your needs, you can readily jump to section
5815 \begin_inset space ~
5819 \begin_inset CommandInset ref
5821 reference "sub:configuring-viewers"
5825 , where the necessary configuration steps in your viewer -- needed both
5826 with the automatic and the manual setup -- are described.
5829 \begin_layout Subsection
5833 \begin_layout Standard
5834 LaTeX provides several different methods for reverse search.
5835 Some are built-in in the
5836 \begin_inset Flex Code
5839 \begin_layout Plain Layout
5845 program, some are provided by external packages.
5846 Your choice depends on whether your LaTeX distribution already provides
5847 a given method (the built-in methods are rather new) and whether your viewer
5849 The available methods are described in the following.
5852 \begin_layout Subsubsection*
5853 Built-in DVI-search via src-specials (DVI only)
5856 \begin_layout Standard
5857 This method provides the DVI file with the necessary information for reverse
5859 It is available in LaTeX since quite some time (any somewhat recent LaTeX
5860 distribution should include it), and it works reliably.
5861 To enable it, change the
5862 \begin_inset Flex MenuItem
5865 \begin_layout Plain Layout
5870 \begin_layout Plain Layout
5883 \begin_inset Flex MenuItem
5886 \begin_layout Plain Layout
5891 \begin_layout Plain Layout
5898 eX (plain)->DraftDVI
5904 \begin_inset Flex MenuItem
5907 \begin_layout Plain Layout
5908 Preferences\SpecialChar \menuseparator
5909 File Handling\SpecialChar \menuseparator
5916 \begin_inset Flex Code
5919 \begin_layout Plain Layout
5920 latex -src-specials $$i
5926 If this doesn't work, check if your TeX engine needs different options
5927 (the syntax might differ in some distributions).
5930 \begin_layout Subsubsection*
5931 External Packages (PDFSync and scrltx)
5934 \begin_layout Standard
5943 provide reverse search facility for PDF output (via pdflatex) and DVI output,
5945 In order to enable it, load the packages in the LyX preamble:
5948 \begin_layout Itemize
5949 \begin_inset Flex Code
5952 \begin_layout Plain Layout
5960 for reverse PDF search,
5963 \begin_layout Itemize
5964 \begin_inset Flex Code
5967 \begin_layout Plain Layout
5970 usepackage[active]{srcltx}
5975 for reverse DVI search.
5978 \begin_layout Standard
5979 If you want to be able to perform both DVI and PDF reverse searches, you
5980 can also insert in the preamble the following lines
5983 \begin_layout LyX-Code
5987 \begin_inset Newline newline
5993 \begin_inset Newline newline
5999 \begin_inset Newline newline
6005 \begin_inset Newline newline
6010 usepackage[active]{srcltx}
6011 \begin_inset Newline newline
6019 \begin_layout Standard
6020 This way, you can preview the file as either DVI or PDF (pdflatex) and the
6021 right package will be used.
6024 \begin_layout Standard
6025 Note that PDFSync might affect the output layout of your document.
6026 It is therefore advised to disable PDFsync for final documents.
6029 \begin_layout Subsubsection*
6030 Built-in reverse search via SyncTeX (DVI and PDF)
6033 \begin_layout Standard
6035 \begin_inset Flex Code
6038 \begin_layout Plain Layout
6044 have built-in support for both PDF and DVI reverse search.
6049 facility is basically the result of the integration of the PDFSync package
6050 to the pdftex program and its merge with the
6055 You need at least TeXLive 2008 or a recent MikTeX distribution in order
6057 Also note that only a few PDF viewers (Skim on the Mac, SumatraPDF on Windows)
6058 already provide SyncTeX support.
6061 \begin_layout Standard
6062 To enable SyncTeX for DVI output, change the
6063 \begin_inset Flex MenuItem
6066 \begin_layout Plain Layout
6071 \begin_layout Plain Layout
6084 \begin_inset Flex MenuItem
6087 \begin_layout Plain Layout
6092 \begin_layout Plain Layout
6099 eX (plain) -> DraftDVI
6105 \begin_inset Flex MenuItem
6108 \begin_layout Plain Layout
6109 Preferences\SpecialChar \menuseparator
6110 File Handling\SpecialChar \menuseparator
6117 \begin_inset Flex Code
6120 \begin_layout Plain Layout
6121 latex -synctex=1 $$i
6126 , and for PDF output, change the
6127 \begin_inset Flex MenuItem
6130 \begin_layout Plain Layout
6135 \begin_layout Plain Layout
6142 eX (pdflatex) -> PDF (pdflatex)
6148 \begin_inset Flex Code
6151 \begin_layout Plain Layout
6152 pdflatex -synctex=1 $$i
6158 Check the documentation of your viewer whether the viewer needs to be configure
6159 d for the use with SyncTeX.
6163 \begin_layout Plain Layout
6165 \begin_inset Flex Code
6168 \begin_layout Plain Layout
6174 option enables gzip compression.
6175 If your viewer does not support it, you should instead use
6176 \begin_inset Flex Code
6179 \begin_layout Plain Layout
6193 \begin_layout Subsection
6194 Configuring and using specific viewers
6195 \begin_inset CommandInset label
6197 name "sub:configuring-viewers"
6204 \begin_layout Subsubsection*
6205 Xdvi (all platforms)
6208 \begin_layout Standard
6210 \begin_inset Flex Code
6213 \begin_layout Plain Layout
6219 , you don't need to do anything else for performing a reverse DVI search,
6220 as LyX already provides the necessary hooks for automatically using the
6222 \begin_inset Flex Code
6225 \begin_layout Plain Layout
6232 Just setup your document as described above (reverse search is triggered
6233 by Ctrl-click or Alt-click on Mac OSX, respectively).
6236 \begin_layout Standard
6237 However, if for whatever reason you want to use the named pipe instead of
6238 the socket for communicating with LyX, simply change the DVI viewer in
6240 \begin_inset Flex MenuItem
6243 \begin_layout Plain Layout
6244 Preferences\SpecialChar \menuseparator
6245 File Handling\SpecialChar \menuseparator
6255 \begin_layout Plain Layout
6256 On Mac OSX you have to use
6257 \begin_inset Flex Code
6260 \begin_layout Plain Layout
6261 DISPLAY=:0.0 xdvi -editor 'lyxeditor.sh %f %l'
6272 \begin_inset Flex Code
6275 \begin_layout Plain Layout
6276 xdvi -editor 'lyxeditor.sh %f %l'
6282 \begin_inset Flex Code
6285 \begin_layout Plain Layout
6291 is a suitable script.
6292 For example, a minimal shell script is the following one:
6295 \begin_layout LyX-Code
6297 \begin_inset Newline newline
6300 LYXPIPE="/path/to/lyxpipe"
6301 \begin_inset Newline newline
6304 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
6305 \begin_inset Newline newline
6308 echo "$COMMAND" > "${LYXPIPE}".in || exit
6309 \begin_inset Newline newline
6312 read < "${LYXPIPE}".out || exit
6315 \begin_layout Standard
6317 \begin_inset Flex Code
6320 \begin_layout Plain Layout
6330 \begin_layout Plain Layout
6337 XServer pipe path specified in
6338 \begin_inset Flex MenuItem
6341 \begin_layout Plain Layout
6342 Preferences\SpecialChar \menuseparator
6352 \begin_layout Plain Layout
6354 \begin_inset Flex Code
6357 \begin_layout Plain Layout
6363 folder of a source distribution you can find a
6364 \begin_inset Flex Code
6367 \begin_layout Plain Layout
6373 script which is able to locate the
6377 based on your preferences.
6385 \begin_layout Subsubsection*
6389 \begin_layout Standard
6391 \begin_inset Flex Code
6394 \begin_layout Plain Layout
6395 /Applications/MacDviX_Folder/calleditor.script
6400 , add the following lines:
6403 \begin_layout LyX-Code
6408 \begin_layout Plain Layout
6415 X.app/Contents/MacOS/lyxeditor "$2" $1
6416 \begin_inset Newline newline
6422 \begin_layout Standard
6423 Modify the lines accordingly if you install LyX somewhere else than in the
6424 Applications folder.
6427 \begin_layout Standard
6428 Reverse search is triggered by Alt-click (OPTION-click).
6431 \begin_layout Subsubsection*
6435 \begin_layout Standard
6437 \begin_inset Flex Code
6440 \begin_layout Plain Layout
6441 open -a Skim.app $$i
6446 to the viewer setting in
6447 \begin_inset Flex MenuItem
6450 \begin_layout Plain Layout
6451 Preferences\SpecialChar \menuseparator
6452 File Handling\SpecialChar \menuseparator
6453 File formats\SpecialChar \menuseparator
6460 \begin_inset Flex MenuItem
6463 \begin_layout Plain Layout
6464 Skim\SpecialChar \menuseparator
6465 Preferences\SpecialChar \menuseparator
6475 \begin_layout Plain Layout
6485 \begin_layout Standard
6486 Reverse search is triggered by COMMAND-SHIFT-click
6489 \begin_layout Subsubsection*
6493 \begin_layout Standard
6495 \begin_inset Flex MenuItem
6498 \begin_layout Plain Layout
6499 Settings\SpecialChar \menuseparator
6500 Configure Okular\SpecialChar \ldots{}
6501 \SpecialChar \menuseparator
6508 \begin_inset Quotes eld
6512 \begin_inset Quotes erd
6516 \begin_inset Flex Code
6519 \begin_layout Plain Layout
6528 \begin_layout Standard
6529 Reverse search is triggered by SHIFT-click.
6532 \begin_layout Subsubsection*
6536 \begin_layout Standard
6537 Launch yap, choose its
6538 \begin_inset Flex MenuItem
6541 \begin_layout Plain Layout
6542 View\SpecialChar \menuseparator
6549 \begin_inset Quotes eld
6553 \begin_inset Quotes erd
6558 \begin_inset Quotes eld
6561 New\SpecialChar \ldots{}
6563 \begin_inset Quotes erd
6566 button and, in the window that opens, enter
6567 \begin_inset Quotes eld
6571 \begin_inset Quotes erd
6574 (or any other name you like) in the
6575 \begin_inset Quotes eld
6579 \begin_inset Quotes erd
6583 Now click on the button labeled
6584 \begin_inset Quotes eld
6587 \SpecialChar \ldots{}
6589 \begin_inset Quotes erd
6592 to open a file dialog and navigate to the directory containing the batch
6594 \begin_inset Flex Code
6597 \begin_layout Plain Layout
6605 \begin_inset Flex Code
6608 \begin_layout Plain Layout
6614 and then specify the program arguments as
6615 \begin_inset Flex Code
6618 \begin_layout Plain Layout
6626 \begin_inset Flex Code
6629 \begin_layout Plain Layout
6635 wrapper is used for communicating with LyX through the
6642 \begin_layout LyX-Code
6644 \begin_inset Newline newline
6647 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
6656 \begin_inset Newline newline
6670 \begin_layout Standard
6671 Make sure that the LyXServer pipe path you specified in LyX is
6672 \begin_inset Flex Code
6675 \begin_layout Plain Layout
6689 , otherwise change the
6690 \begin_inset Flex Code
6693 \begin_layout Plain Layout
6699 wrapper accordingly.
6702 \begin_layout Standard
6703 In yap, reverse search is triggered by double-click.
6706 \begin_layout Subsubsection*
6707 SumatraPDF (Windows)
6710 \begin_layout Standard
6711 In order to use SumatraPDF for inverse search, enter
6712 \begin_inset Flex Code
6715 \begin_layout Plain Layout
6716 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
6721 in the viewer setting in
6722 \begin_inset Flex MenuItem
6725 \begin_layout Plain Layout
6726 Preferences\SpecialChar \menuseparator
6727 File Handling\SpecialChar \menuseparator
6728 File formats\SpecialChar \menuseparator
6735 \begin_inset Flex Code
6738 \begin_layout Plain Layout
6744 is the previous wrapper.
6745 If SumatraPDF.exe is not in your command PATH, use its full file name.
6748 \begin_layout Standard
6749 Reverse search is triggered by double-click.
6752 \begin_layout Subsubsection*
6756 \begin_layout Standard
6757 First of all, make sure that yap is your default DVI viewer in the Windows
6758 environment, then launch it, choose its
6759 \begin_inset Flex MenuItem
6762 \begin_layout Plain Layout
6763 View\SpecialChar \menuseparator
6770 \begin_inset Quotes eld
6774 \begin_inset Quotes erd
6779 \begin_inset Quotes eld
6782 New\SpecialChar \ldots{}
6784 \begin_inset Quotes erd
6787 button and, in the window that opens, enter
6788 \begin_inset Quotes eld
6792 \begin_inset Quotes erd
6795 (or any other name you like) in the
6796 \begin_inset Quotes eld
6800 \begin_inset Quotes erd
6804 Now click on the button labeled
6805 \begin_inset Quotes eld
6808 \SpecialChar \ldots{}
6810 \begin_inset Quotes erd
6813 to open a file dialog and navigate to the directory containing the
6814 \begin_inset Flex Code
6817 \begin_layout Plain Layout
6823 program (which is installed by default on Cygwin along with the LyX executable).
6825 \begin_inset Flex Code
6828 \begin_layout Plain Layout
6834 and then specify the program arguments as
6835 \begin_inset Flex Code
6838 \begin_layout Plain Layout
6845 In this way, you will be using the
6849 for communicating with LyX.
6850 If, for whatever reason, you want to use the
6855 \begin_inset Flex Code
6858 \begin_layout Plain Layout
6864 option and be sure to specify the LyXServer pipe path in the LyX preferences.
6867 \begin_layout Standard
6868 In yap, reverse search is triggered by double-click.
6871 \begin_layout Subsubsection*
6875 \begin_layout Standard
6876 In order to use SumatraPDF for inverse search, enter
6877 \begin_inset Flex Code
6880 \begin_layout Plain Layout
6886 in the viewer setting in
6887 \begin_inset Flex MenuItem
6890 \begin_layout Plain Layout
6891 Preferences\SpecialChar \menuseparator
6892 File Handling\SpecialChar \menuseparator
6893 File formats\SpecialChar \menuseparator
6900 \begin_inset Flex Code
6903 \begin_layout Plain Layout
6909 is the following script (to be placed in your command PATH,
6910 \begin_inset Flex Code
6913 \begin_layout Plain Layout
6919 being the best choice):
6922 \begin_layout LyX-Code
6924 \begin_inset Newline newline
6928 \begin_inset Newline newline
6931 SumatraPDF -inverse-search "lyxeditor -g %f %l" $(basename $1)
6934 \begin_layout Standard
6935 This wrapper script is needed because SumatraPDF is a native Windows application
6936 and does not understand the posix paths used by the Cygwin version of LyX.
6937 If SumatraPDF.exe is not in your command PATH, use its full posix path in
6940 \begin_inset Flex Code
6943 \begin_layout Plain Layout
6949 enables communication via the
6955 \begin_inset Flex Code
6958 \begin_layout Plain Layout
6964 option if you want to use the
6968 , and be sure to specify the LyXServer pipe path in the LyX preferences.
6971 \begin_layout Standard
6972 Reverse search is triggered by double-click.
6975 \begin_layout Section
6979 \begin_layout Standard
6980 Forward search is, as the name implies, in a sense the
6981 \begin_inset Quotes eld
6985 \begin_inset Quotes erd
6989 It allows you to let the viewer jump to a given position from within LyX.
6990 If forward search is set up (as described in what follows), you can put
6991 the cursor anywhere in your LyX document, and hit
6992 \begin_inset Flex MenuItem
6995 \begin_layout Plain Layout
6996 Navigate\SpecialChar \menuseparator
7003 \begin_inset Flex MenuItem
7006 \begin_layout Plain Layout
7012 in the context menu via right mouse click), and then the viewer will jump
7013 to that position as well.
7014 This implies, of course, that your viewer supports this function.
7017 \begin_layout Standard
7018 To make forward search possible, you first need to provide the generated
7019 output PDF/DVI file with additional information about the TeX sources.
7020 This can be done via the methods described in the section
7021 \begin_inset CommandInset ref
7023 reference "sub:rev-search"
7030 \begin_layout Standard
7031 Additionally, you need to configure LyX for using your viewers in
7032 \begin_inset Flex MenuItem
7035 \begin_layout Plain Layout
7036 Tools\SpecialChar \menuseparator
7037 Preferences\SpecialChar \menuseparator
7038 Output\SpecialChar \menuseparator
7045 We provide a range of tested configurations for some viewers, which you
7046 can select from the drop down list.
7047 If none of these configurations suits you, you have to find out and enter
7048 a suitable configuration yourself.
7049 The definition syntax uses the following placeholders:
7052 \begin_layout Itemize
7054 \begin_inset Flex Code
7057 \begin_layout Plain Layout
7066 \begin_layout Itemize
7068 \begin_inset Flex Code
7071 \begin_layout Plain Layout
7077 : name of the (temporary) exported .tex file
7080 \begin_layout Itemize
7082 \begin_inset Flex Code
7085 \begin_layout Plain Layout
7091 : name of the exported output file (either dvi or pdf, depending on which
7092 one exists in the temporary directory)
7095 \begin_layout Standard
7096 Note that only some of the viewers provide full forward search functionality,
7097 among them yap, xdvi, okular and Sumatra PDF
7101 \begin_layout Plain Layout
7102 For Sumatra CMCDDE is needed --- downloadable from http://www.istri.fr/zip/CMCDDE.z
7109 While many of the widespread PDF viewers (most notably Adobe Reader) do
7110 not support forward search at all, some other viewers -- e.
7111 \begin_inset space \thinspace{}
7115 evince and xpdf -- allow at least to reload the document and jump to a
7116 specific page of the file, so you can at least navigate
7117 \begin_inset Quotes eld
7121 \begin_inset Quotes erd
7125 These latter functionality is provided by an external call of synctex (see
7126 the predefined example configurations).
7130 \begin_layout Standard
7131 Forward search works both with DVI and PDF output.
7132 LyX simply checks which preview format you have used before (i.
7133 \begin_inset space \thinspace{}
7136 e., which format is already there in the temporary directory) and chooses
7137 the appropriate configuration for the respective format.
7140 \begin_layout Chapter
7141 Special Document Classes
7144 \begin_layout Section
7148 \begin_layout Standard
7154 \begin_layout Subsection
7158 \begin_layout Standard
7159 This section describes how LyX can be used to write articles for submission
7160 to the scientific journal
7162 Astronomy and Astrophysics
7164 (www.edpsciences.fr/aa/
7165 \begin_inset Flex URL
7168 \begin_layout Plain Layout
7170 http://www.edpsciences.fr/aa/
7175 ) using Version 5.01 of the document class
7180 This package can be downloaded from the ftp site
7183 \begin_layout Standard
7184 \begin_inset VSpace medskip
7190 \begin_layout Standard
7192 \begin_inset Flex URL
7195 \begin_layout Plain Layout
7197 ftp://ftp.edpsciences.org/pub/aa/readme.html
7205 \begin_layout Standard
7206 \begin_inset VSpace medskip
7212 \begin_layout Standard
7213 A manual comes together with that package, and this text is not meant to
7214 replace the original manual but is merely a short guide in how to realize
7215 the correct form of your paper.
7219 \begin_layout Standard
7220 Please note that the publisher of the journal was changed from Springer
7221 to EDP Sciences starting January 1, 2001.
7222 That change involved also some slight changes to the style files, namely
7223 the removal of the thesaurus command.
7224 The LyX class aa supports the newest version of these style files, V 5.01.
7225 If you have an older version installed, please upgrade.
7226 For compatibility, the old (version 4) layout has been kept as
7231 Please refer to the comments in
7233 LyXDir/layouts/aapaper.layout
7238 \begin_layout Subsection
7242 \begin_layout Standard
7243 It is recommended you start from the example template distributed with LyX.
7244 If you are not using a template, note the following settings:
7247 \begin_layout Itemize
7254 Document\SpecialChar \menuseparator
7257 dialog (OK, that one was obvious).
7260 \begin_layout Itemize
7261 Don't change the option
7264 \begin_inset space ~
7274 The whole layout is done by the macros, you shouldn't change anything.
7277 \begin_layout Subsection
7281 \begin_layout Standard
7282 First thing to enter is the header information.
7283 It consists of seven entries, of which some are optional.
7287 \begin_layout Itemize
7295 \begin_layout Itemize
7303 \begin_layout Itemize
7311 \begin_layout Itemize
7319 \begin_layout Itemize
7324 : [optional] if more than one author: whom to contact for offprint requests.
7327 \begin_layout Itemize
7332 : [optional] mail address for contacts.
7335 \begin_layout Itemize
7343 Received: <date>; Accepted <date>
7346 \begin_layout Standard
7347 There is no need to issue the
7353 command, this is done automatically by LyX when the header is finished.
7354 Although the order of the single header entries doesn't matter it is advised
7355 to keep the above sequence, just to get the best optics and meets the layout
7356 of the real document.
7359 \begin_layout Standard
7360 If you want to place footnotes in the header block, e.
7361 \begin_inset space \thinspace{}
7365 \begin_inset space \space{}
7368 to state your present address, just use the standard footnote via the menu
7371 Insert\SpecialChar \menuseparator
7375 LyX will automagically use the term
7384 \begin_layout Standard
7385 In addition to these topics, the macros use three additional LaTeX commands
7386 that have no counterpart in LyX:
7389 \begin_layout Itemize
7396 to separate different names for more than one author and institute, respectivel
7400 \begin_layout Itemize
7407 to mark corresponding author/institute pairs.
7408 The institutes are numbered sequentially as they appear in the
7412 field, so you have to put a marker to each author.
7415 \begin_layout Itemize
7422 to supply an email address for fast contact.
7425 \begin_layout Standard
7426 In all cases, the appropriate command has to be entered in LyX and marked
7432 \begin_layout Subsection
7436 \begin_layout Standard
7437 The abstract should immediately follow the header block.
7438 With version 5 the abstract environment was changed to a command, and there
7439 is now a resctriction to only one paragraph.
7440 In addition, it should contain an entry with the keywords.
7441 This is not yet implemented for LyX, therefore you have to enter the LaTeX
7448 by hand and mark it as LaTeX code.
7449 Refer to the example paper.
7452 \begin_layout Subsection
7453 Supported environments
7456 \begin_layout Standard
7457 The A&A paper layout supports the following environments for structuring
7461 \begin_layout Itemize
7467 \begin_layout Itemize
7473 \begin_layout Itemize
7479 \begin_layout Itemize
7485 \begin_layout Itemize
7491 \begin_layout Itemize
7497 \begin_layout Itemize
7503 \begin_layout Itemize
7509 \begin_layout Itemize
7515 \begin_layout Itemize
7521 \begin_layout Itemize
7527 \begin_layout Itemize
7533 \begin_layout Subsection
7534 Commands not supported by LyX
7537 \begin_layout Standard
7538 Some commands are not yet supported by the
7543 Some have already been mentioned.
7544 For the sake of completeness, they are listed all together here:
7547 \begin_layout Itemize
7555 \begin_layout Itemize
7563 \begin_layout Itemize
7571 \begin_layout Itemize
7579 \begin_layout Itemize
7587 \begin_layout Itemize
7595 \begin_layout Itemize
7603 \begin_layout Itemize
7611 \begin_layout Standard
7612 If you want to use any of these commands, you have to enter them yourself.
7615 Do not forget to mark them as LaTeX code!
7618 \begin_layout Subsection
7619 Figure and Table Floats
7622 \begin_layout Standard
7623 LyX provides support for the necessary float environments
7625 figure, figure*, table
7631 , therefore we won't tell much about it here.
7635 \begin_inset space ~
7641 Just remember that tables should be left-aligned.
7642 For that, select the table and change the alignment in
7644 Edit\SpecialChar \menuseparator
7646 \begin_inset space ~
7652 \begin_layout Standard
7653 There is only one special thing: the figures with caption besides the figure.
7654 To create such a figure, you have to do the following:
7657 \begin_layout Enumerate
7658 Create a wide figure float:
7660 Insert\SpecialChar \menuseparator
7661 Float\SpecialChar \menuseparator
7664 , then right click in the figure and select
7670 \begin_inset space ~
7678 \begin_layout Enumerate
7679 Enter your caption text.
7682 \begin_layout Enumerate
7687 to move the cursor above the caption.
7690 \begin_layout Enumerate
7694 \begin_layout Enumerate
7695 Position the cursor behind the figure and insert a horizontal fill:
7697 Insert\SpecialChar \menuseparator
7699 \begin_inset space ~
7702 Character\SpecialChar \menuseparator
7704 \begin_inset space ~
7712 \begin_layout Enumerate
7713 Switch to LaTeX mode:
7716 \begin_inset space ~
7724 \begin_layout Enumerate
7734 Do not close the brace!
7737 \begin_layout Enumerate
7738 Position the cursor behind the caption text, switch to LaTeX mode and insert
7742 \begin_inset space ~
7754 \begin_layout Standard
7755 Also, refer to the figures in the example paper.
7758 \begin_layout Subsection
7762 \begin_layout Standard
7763 For submission, the paper has to be formated in a special double-spacing
7765 For this purpose, you have to give the option
7769 to the documentclass.
7770 This must be done using the extra class options field in the
7772 Document\SpecialChar \menuseparator
7776 Just enter the string
7783 \begin_layout Subsection
7787 \begin_layout Standard
7792 directory contains an example paper written with LyX.
7793 It is the example paper from the original macro package, translated to
7795 Use it for inspiration, and compare the original LaTeX code with LyX way
7799 \begin_layout Section
7803 \begin_layout Standard
7809 \begin_layout Subsection
7813 \begin_layout Standard
7814 AASTeX is a set of macros produced by the American Astronomical Society
7815 to facilitate electronic manuscript submission to the three journals they
7816 publish: the Astrophysical Journal (including the Letters and Supplement),
7817 the Astronomical Journal, and the Publications of the Astronomical Society
7819 LyX has proven to be an excellent tool for generating these documents,
7820 especially given its equation, citation, and figure handling capabilities.
7821 LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
7822 is the version described here, or higher.
7823 Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
7824 incompatible with LyX.
7825 The AASTeX package may be downloaded from the AASTeX Web site
7828 \begin_layout Standard
7829 \begin_inset VSpace medskip
7835 \begin_layout Standard
7837 \begin_inset Flex URL
7840 \begin_layout Plain Layout
7842 http://www.journals.uchicago.edu/AAS/AASTeX
7850 \begin_layout Standard
7851 \begin_inset VSpace medskip
7857 \begin_layout Standard
7858 A complete user guide is contained in that package and you should familiarize
7859 yourself with it thoroughly before embarking on writing a paper in LyX.
7860 LyX will not reduce the need to figure out all the AASTeX commands, it
7861 will only reduce the drudgery of typing everything in.
7862 It is your responsibility to ensure that the final exported LaTeX document
7863 conforms completely to the requirements of the journal to which you are
7864 submitting your paper.
7867 \begin_layout Subsection
7868 Starting a New Paper
7871 \begin_layout Standard
7872 I strongly suggest that you start with the AASTeX template file.
7875 File\SpecialChar \menuseparator
7882 , enter the new file name, then choose the
7887 This will show the most common fields found in a manuscript.
7888 Simply overwrite the existing text (including the brackets,
7892 ) with the correct information.
7893 Many of the AASTeX commands and environments can be implemented directly
7894 in LyX, but some cannot: most noticeably
7906 , which should stick out like a sore thumb if you actually just opened the
7908 For commands such as these, the LaTeX code must be entered directly and
7910 Such commands are referred to as TeX code, or Evil Red Text.
7911 I tried to minimize the amount of TeX code needed in an AASTeX document,
7912 but there is still a bit more required than any of us would like.
7915 \begin_layout Subsection
7916 Finishing Your Paper
7919 \begin_layout Standard
7920 When the paper is finished to your satisfaction and previews/prints correctly,
7922 \begin_inset Quotes eld
7926 \begin_inset Quotes erd
7929 actions which need to be done before you submit it to the journals.
7933 \begin_layout Enumerate
7934 Export your paper as a LaTeX file (
7936 File\SpecialChar \menuseparator
7937 Export\SpecialChar \menuseparator
7944 \begin_layout Enumerate
7949 file with your favorite text editor
7953 \begin_layout Enumerate
7954 remove the comment lines before the
7963 \begin_layout Enumerate
7968 usepackage...{fontenc}
7970 line if it appears (usually just after
7985 \begin_layout Enumerate
7986 remove everything between (and including) the
7998 commands, except for any commands you specifically put into the LaTeX preamble
7999 (which should appear immediately after the
8000 \begin_inset Quotes eld
8003 User specified LaTeX commands
8004 \begin_inset Quotes erd
8015 \begin_layout Enumerate
8016 Run the resulting file through LaTeX to make sure it still processes correctly.
8019 \begin_layout Enumerate
8020 Reread the journal requirements to make sure your filenames and formats
8024 \begin_layout Enumerate
8028 \begin_layout Subsection
8029 Comments On Specific Commands
8032 \begin_layout Standard
8033 I will not describe the detailed usage of the individual AASTeX commands:
8034 the AASTeX User Guide (
8038 ) gives a good description of each.
8039 Thus it's probably easiest for me to go down the list as found in the guide
8040 and offer comments where necessary.
8041 So let's begin \SpecialChar \ldots{}
8045 \begin_layout Subsubsection
8046 Things that work as expected
8049 \begin_layout Standard
8050 Because they work as you might expect, I simply list them and the section
8151 begin{thebibliography}
8159 (2.13.2), all the cite commands and their variations (2.13.2), the generic
8160 graphicx figure commands (2.14.1),
8184 (2.15.4, amongst other places),
8211 \begin_layout Standard
8212 The following style options also work correctly:
8233 Simply put them in the
8239 Layout\SpecialChar \menuseparator
8245 \begin_layout Subsubsection
8246 Things that work, but require more comment
8249 \begin_layout Standard
8250 The following items work, but require a little more discussion:
8253 \begin_layout Itemize
8254 These items are reserved for use by the journal editors, but you can put
8255 them into the LaTeX preamble if you feel compelled to do so:
8288 \begin_layout Itemize
8289 These items may be placed in the LaTeX preamble, and are included as blanks
8290 in the template file:
8311 \begin_layout Itemize
8318 (2.3) – can only be used
8319 \begin_inset Quotes eld
8323 \begin_inset Quotes erd
8326 , not in the middle of a paragraph.
8327 Use TeX code if you need to embed it.
8330 \begin_layout Itemize
8337 (2.3) – will have extra {} after it.
8338 This should not cause an error.
8341 \begin_layout Itemize
8348 (2.6) – can only be used
8349 \begin_inset Quotes eld
8353 \begin_inset Quotes erd
8356 , not in the middle of a paragraph.
8357 Use TeX code if you need to embed it.
8360 \begin_layout Itemize
8367 (2.8) – can't insert a cross-reference tag, you must type the tag name by
8371 \begin_layout Itemize
8385 \begin_layout Itemize
8392 (2.9) – will have extra {} after it.
8393 This should not cause an error.
8396 \begin_layout Itemize
8403 (2.11) – will have extra {} after it.
8404 This should not cause an error.
8407 \begin_layout Itemize
8414 (2.14.2) – you can insert an optional filename argument by placing the cursor
8415 at the beginning of the text and selecting
8417 Insert\SpecialChar \menuseparator
8422 \begin_inset Quotes eld
8426 \begin_inset Quotes erd
8429 inserts an optional argument of the type needed by
8436 Hopefully it will be renamed someday.
8439 \begin_layout Itemize
8452 for the catalog ID optional parameter
8455 \begin_layout Itemize
8468 for the catalog ID optional parameter
8471 \begin_layout Subsubsection
8472 Things not implemented, use TeX code
8475 \begin_layout Standard
8498 setcounter{equation}
8500 (2.12), Journal name abbreviations (2.13.4),
8536 (2.15.4, insert it as the first element in the lefthand cell after where
8538 Don't use any of LyX's rules in the table),
8550 (2.15.5), much of Misc (2.17, except
8601 \begin_layout Subsubsection
8602 Things that cannot be implemented
8605 \begin_layout Standard
8606 \SpecialChar \ldots{}
8607 at least in any meaningful sort of way, so I suggest ignoring them.
8608 They are the references environment (2.13.3), and the deluxetable environment
8610 If you really, really need to use deluxetable, I suggest editing it in
8611 a separate file with a text editor, then using
8613 Insert\SpecialChar \menuseparator
8615 \begin_inset space ~
8620 to include it in your LyX document.
8625 file to see an example of this.
8628 \begin_layout Subsection
8629 FAQs, Tips, Tricks, and Other Ruminations
8632 \begin_layout Subsubsection
8633 Getting LyX and AASTeX to cooperate
8636 \begin_layout Standard
8637 It can be a bit tricky to get LyX to recognize a new layout and document
8639 When all else fails, do this:
8642 \begin_layout Enumerate
8643 Make certain that LaTeX can find AASTeX.
8644 Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
8645 a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
8652 \begin_layout Enumerate
8664 \begin_layout Enumerate
8667 Tools\SpecialChar \menuseparator
8670 in LyX, then restart LyX.
8673 \begin_layout Enumerate
8674 Open a regular new file, not from a template.
8675 Does AASTeX appear in the class list in
8677 Document\SpecialChar \menuseparator
8683 \begin_layout Standard
8684 If you get a warning from an existing AASTeX document about not being able
8685 to find the AASTeX layout or a message about
8686 \begin_inset Quotes eld
8689 You should not mix title layouts with normal ones
8690 \begin_inset Quotes erd
8693 , things haven't been installed correctly.
8696 \begin_layout Subsubsection
8697 LaTeX error processing a table
8700 \begin_layout Standard
8701 LyX, by default, attempts to center the table caption/title.
8702 This seems to produce a bad interaction in AASTeX so you should click somewhere
8703 in the caption/title, then select
8705 Edit\SpecialChar \menuseparator
8707 \begin_inset space ~
8721 This took care of it for me.
8724 \begin_layout Subsubsection
8728 \begin_layout Standard
8729 A couple of things: 1) I have noticed some funny spacing in the reference
8730 entries in the text.
8731 When you enter the bibliography item data, make sure their is
8735 space between the last author and the parenthesis setting off the year;
8739 \begin_inset space \thinspace{}
8743 \begin_inset space \space{}
8757 2) Entering the references at all is not obvious.
8758 The easiest thing is to start typing your first reference at the end of
8759 the document, then mark it as type
8764 That will put a small gray box in front of what you just typed.
8765 Click on the box to fill in the rest of the information.
8766 For new references, go to the end of an existing reference and press return.
8767 That will create a new line with its own box, etc.
8770 \begin_layout Subsubsection
8774 \begin_layout Standard
8775 Even though AASTeX provides its own figure commands (
8781 , for example), I much prefer LaTeX's standard figure commands (with the
8790 \begin_inset space ~
8793 commands as TeX code into a Figure Float box if you desire, but I never
8794 have much luck getting the layout right.
8795 With the standard graphics, LyX will insert a
8799 usepackage{graphicx}
8801 command into the LaTeX preamble and handle the figures in the standard
8802 LaTeX2e way, interspersing the figures in the text.
8803 I believe ApJ accepts figures exactly this way now; AJ might still use
8805 \begin_inset Quotes eld
8808 stack everything at the end
8809 \begin_inset Quotes erd
8815 \begin_layout Subsubsection
8816 Things I could have done, but didn't
8819 \begin_layout Standard
8821 \begin_inset Quotes eld
8825 \begin_inset Quotes erd
8828 things I could have implemented, but chose not to.
8829 For instance, I saw no point in double-spacing the text in the LyX window,
8830 even though it is double-spaced in the paper manuscript.
8831 Also, I chose not to make separate layouts for the preprint and preprint2
8833 Since I assume you will spend most of your time in the plain manuscript
8834 mode anyway, I decided not to chew up more disk space with this.
8838 \begin_layout Subsection
8842 \begin_layout Standard
8843 Your mileage may vary.
8844 I've now had papers published by both ApJ and AJ that have had 98% of the
8845 effort done in LyX; the last 2% was the LaTeX post-processing and a few
8847 I have had no trouble with the submission process, and I'm sure the journals
8848 were never aware that there might be a difference.
8849 So, go forth and publish!
8852 \begin_layout Section
8856 \begin_layout Standard
8866 \begin_layout Standard
8867 \begin_inset VSpace bigskip
8873 \begin_layout Standard
8875 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
8876 papers to be submitted to American Mathematical Society publications.
8877 The layouts are not tailored to a specific journal, but easily can be.
8878 You should refer to the AMS documentation for specific instructions for
8879 each journal (usually it will entail only changing a single line in the
8881 That documentation is available on the Web at
8882 \begin_inset Flex URL
8885 \begin_layout Plain Layout
8893 \begin_inset Flex URL
8896 \begin_layout Plain Layout
8898 ftp://ftp.ams.org/pub/tex/amslatex/
8904 These layouts are appropriate, and useful, for any mathematical writing.
8908 \begin_layout Standard
8909 There are two basic AMS LaTeX layouts:
8912 \begin_layout Itemize
8913 amsart: The standard AMS article format.
8916 \begin_layout Itemize
8917 amsbook: the standard AMS book (really, monograph) format.
8921 \begin_layout Standard
8922 The layouts themselves contain only the minimum necessary to use the AMS
8924 They do not, in particular, contain any of the `theorem' environments used
8925 for setting theorems, lemmas, and the like.
8926 These are contained, instead, in the
8927 \begin_inset Flex Code
8930 \begin_layout Plain Layout
8936 module, which is loaded by default when when you select one of the AMS
8938 (It can also be used with other classes and can be removed, if you would
8939 rather use something else.) Less commonly used environments are in the
8940 \begin_inset Flex Code
8943 \begin_layout Plain Layout
8944 Theorems (AMS-Extended)
8949 module, which must be loaded manually.
8952 \begin_layout Standard
8953 By default, theorems and the like are numbered consecutively throughout
8954 the document, but this may be modified by loading the module
8955 \begin_inset Flex Code
8958 \begin_layout Plain Layout
8959 Theorems (Order by Section)
8964 or, if you are using
8965 \begin_inset Flex Code
8968 \begin_layout Plain Layout
8975 \begin_inset Flex Code
8978 \begin_layout Plain Layout
8979 Theorems (Order by Chapter)
8985 These will number the results as
8986 \begin_inset Formula $n.m$
8989 , where the first number refers to the section (or chapter) and the second
8990 refers to the total number of results so far in that section (or chapter).
8991 Many environments are also available unnumbered.
8992 These are indicated by an asterisk at the end.
8993 If you happen to want
8997 unnumbered results, the module
8998 \begin_inset Flex Code
9001 \begin_layout Plain Layout
9007 provides that option.
9010 \begin_layout Standard
9011 Note that these modules do not
9015 to be used with the AMS classes.
9016 It is perfectly possible to use the
9017 \begin_inset Flex Code
9020 \begin_layout Plain Layout
9026 module, and the others mentioned, with other classes, such as
9027 \begin_inset Flex Code
9030 \begin_layout Plain Layout
9037 \begin_inset Flex Code
9040 \begin_layout Plain Layout
9047 \begin_inset Flex Code
9050 \begin_layout Plain Layout
9059 \begin_layout Subsection
9060 What these layouts provide
9063 \begin_layout Standard
9064 There is a long list of included environments provided by these layouts.
9065 In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
9066 variety of `theorem' environments.
9067 However, the AMS recommends the environments that are available in LyX.
9071 \begin_layout Standard
9072 The following environments—as well as the standard environments, such as
9074 \begin_inset Flex Noun
9077 \begin_layout Plain Layout
9084 \begin_inset Flex Noun
9087 \begin_layout Plain Layout
9094 \begin_inset Flex Noun
9097 \begin_layout Plain Layout
9104 \begin_inset Flex Noun
9107 \begin_layout Plain Layout
9114 \begin_inset Flex Noun
9117 \begin_layout Plain Layout
9124 \begin_inset Flex Code
9127 \begin_layout Plain Layout
9134 \begin_inset Flex Code
9137 \begin_layout Plain Layout
9146 \begin_layout Description
9147 Address This should be the author's permanent address.
9150 \begin_layout Description
9152 \begin_inset space ~
9155 Address This should be the author's temporary address at the time of submission,
9156 if different from the Address.
9159 \begin_layout Description
9160 Email Author's e-mail address
9163 \begin_layout Description
9164 URL Author's Web address, if desired.
9167 \begin_layout Description
9168 Keywords Key words or phrases used to identify specific topics discussed
9172 \begin_layout Description
9173 Subjectclass These refer to the AMS Subject Classifications, published and
9176 Mathematical Reviews
9179 These are also available online at the AMS cites listed above.
9182 \begin_layout Description
9186 \begin_layout Description
9190 \begin_layout Description
9194 \begin_layout Standard
9195 The following environments are provided by both the
9196 \begin_inset Flex Code
9199 \begin_layout Plain Layout
9206 \begin_inset Flex Code
9209 \begin_layout Plain Layout
9215 modules, in the latter case in both starred (unnumbered) and unstarred
9216 (numbered) versions.
9217 These same environments are provided only in the starred versions by the
9219 \begin_inset Flex Code
9222 \begin_layout Plain Layout
9231 \begin_layout Theorem
9232 This is typically used for the statements of major results.
9236 \begin_layout Corollary*
9237 This is used for statements which follow fairly directly from previous statement
9239 Again, these can be major results.
9244 These are smaller results needed to prove other statements.
9247 \begin_layout Proposition
9248 These are less major results which (hopefully) add to the general theory
9252 \begin_layout Conjecture
9253 These are statements provided without justification, which the author does
9254 not know how to prove, but which seem to be true (to the author, at least).
9257 \begin_layout Definition*
9258 Guess what this is for.
9259 The font is different for this environment than for the previous ones.
9263 \begin_layout Example*
9264 Used for examples illustrating proven results.
9267 \begin_layout Problem
9268 It's not really known what this is for.
9269 You should figure it out.
9272 \begin_layout Exercise*
9273 Write a description for this one.
9276 \begin_layout Remark
9277 This environment is also a type of theorem, usually a lesser sort of observation.
9280 \begin_layout Claim*
9281 Often used in the course of giving a proof of a larger result.
9285 Generally, these are used to break up long arguments, using specific instances
9291 The numbering scheme for cases is on its own, not together with other numbered
9297 At the end of this environment, a QED symbol (usually a square, but it can
9298 vary with different styles) is placed.
9299 If you want to have other environments within this one—for example, Case
9300 environments—and have the QED symbol appear only after them, then the other
9301 environments need to be nested within the proof environment.
9304 Nesting Environments
9310 for information on nesting.
9313 \begin_layout Standard
9314 And these environments are provided by
9315 \begin_inset Flex Code
9318 \begin_layout Plain Layout
9319 Theorems (AMS-Extended)
9327 \begin_layout Criterion*
9328 A required condition.
9331 \begin_layout Algorithm*
9332 A general procedure to be used.
9335 \begin_layout Axiom*
9336 This is a property or statement taken as true within the system being discussed.
9339 \begin_layout Condition*
9340 Sometimes used to state a condition assumed within the present context of
9345 Similar to a Remark.
9348 \begin_layout Notation*
9349 Used for the explanation of, yes, notation.
9352 \begin_layout Summary
9353 Do we really need to tell you?
9356 \begin_layout Acknowledgement*
9360 \begin_layout Conclusion*
9361 Sometimes used at the end of a long train of argument.
9365 Used in a way similar to Proposition, though perhaps lower on the scale.
9368 \begin_layout Standard
9369 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
9371 They need to be available on your system in order to use these environments.
9374 \begin_layout Section
9382 \begin_layout Standard
9388 \begin_layout Subsection
9392 \begin_layout Standard
9393 These are the layout files for some of the journals of the American Geophysical
9395 It is assumed that you have both the AGU's own class files and AGUplus
9396 installed (everything to be found at
9397 \begin_inset Flex URL
9400 \begin_layout Plain Layout
9402 ftp://ftp.agu.org/journals/latex/journals
9410 \begin_layout Subsection
9414 \begin_layout Standard
9424 They are still called this in the LyX GUI, though their LaTeX equivalents
9425 in the AGU classes are
9436 \begin_layout Standard
9437 Newly defined styles are
9474 These are mostly manuscript attributes and defined in the AGU class documentati
9478 \begin_layout Standard
9479 I suspect this is still badly incomplete.
9482 \begin_layout Subsection
9486 \begin_layout Standard
9503 \begin_layout Subsection
9507 \begin_layout Itemize
9510 Journal of Geophysical Research
9519 \begin_layout Standard
9520 Add your own, it isn't so hard! Look at the
9531 \begin_layout Subsection
9532 Bugs and things to remember
9535 \begin_layout Standard
9536 In order to use the new layouts, you must remember to do the following for
9540 \begin_layout Enumerate
9546 This can be done in the
9548 Layout\SpecialChar \menuseparator
9553 Document\SpecialChar \menuseparator
9557 (AGU articles are always in English, right? So
9564 \begin_layout Enumerate
9574 (Yes, this is a bug.)
9577 \begin_layout Enumerate
9578 Make sure you use the
9582 bibliography style, by entering
9586 into the second field of the BibTeX inset.
9587 None of the standard styles will do.
9590 \begin_layout Section
9594 \begin_layout Standard
9600 \begin_layout Subsection
9604 \begin_layout Standard
9605 Broadway is for writing plays.
9606 The format is more decorative than Hollywood, and much less standardized.
9607 This format should be suitable for workshops.
9610 \begin_layout Subsection
9614 \begin_layout Standard
9615 The same as in Hollywood.
9618 \begin_layout Subsection
9622 \begin_layout Standard
9627 names as labels then cross-reference the label to insert the name.
9628 The cross-reference dialog will show the current cast of characters.
9631 \begin_layout Subsection
9632 Paper size and Margins
9635 \begin_layout Standard
9636 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
9639 \begin_layout Subsection
9643 \begin_layout Standard
9644 The following environments are available.
9645 You can use broadway.bind to get the bind keys shown at the right.
9648 \begin_layout Itemize
9652 \begin_inset Newline newline
9657 You should not have to use this, but it is here for anything that does not
9661 \begin_layout Itemize
9665 \begin_inset space \hfill{}
9669 \begin_inset Newline newline
9674 Used to describe stage setting and the action.
9675 First use of speaker names in all CAPs.
9678 \begin_layout Itemize
9682 \begin_inset space \hfill{}
9686 \begin_inset Newline newline
9691 Automatically numbered.
9692 On screen it will be arabic, but will print as Roman.
9695 \begin_layout Itemize
9699 \begin_inset space \hfill{}
9703 \begin_inset Newline newline
9713 It is just centered text.
9716 \begin_layout Itemize
9720 \begin_inset space \hfill{}
9724 \begin_inset Newline newline
9729 Not automatically numbered.
9730 You supply the number.
9731 This is because I couldn't figure out how.
9734 \begin_layout Itemize
9738 \begin_inset space \hfill{}
9742 \begin_inset Newline newline
9747 A special case of Narrative to describe the setting and action as the curtain
9751 \begin_layout Itemize
9755 \begin_inset space \hfill{}
9759 \begin_inset Newline newline
9764 The speaker's (actor's) title, centered in all CAPS.
9767 \begin_layout Itemize
9771 \begin_inset space \hfill{}
9775 \begin_inset Newline newline
9780 Instructions to the speaker.
9781 The parentheses are automatically inserted.
9782 The ( will appear on screen, but both will be in the printed play.
9783 This environment is only used within
9790 \begin_layout Itemize
9794 \begin_inset space \hfill{}
9798 \begin_inset Newline newline
9803 What the Speaker says.
9806 \begin_layout Itemize
9810 \begin_inset space \hfill{}
9814 \begin_inset Newline newline
9819 The curtain comes down.
9822 \begin_layout Itemize
9826 \begin_inset space \hfill{}
9832 \begin_layout Itemize
9836 \begin_inset space \hfill{}
9842 \begin_layout Itemize
9846 \begin_inset space \hfill{}
9852 \begin_layout Standard
9856 \begin_layout Section
9860 \begin_layout Standard
9865 can be used to type letters according to German conventions.
9866 A template file is included in
9868 .../lyx/share/templates
9870 for you to use as a starting point.
9873 \begin_layout Section
9881 \begin_layout Standard
9887 \begin_layout Subsection
9891 \begin_layout Standard
9892 This is the layout file for the European Geophysical Society journals.
9897 can be downloaded from the web site of the EGS under
9898 \begin_inset Flex URL
9901 \begin_layout Plain Layout
9911 \begin_layout Subsection
9915 \begin_layout Standard
9918 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9926 The current layout file is unfortunately very unmodular and would benefit
9927 from using the various
9934 \begin_layout Section
9938 \begin_layout Standard
9939 See the LyX template file
9944 It contains all infos you need.
9947 \begin_layout Section
9953 \begin_inset CommandInset label
9962 \begin_layout Standard
9968 \begin_layout Subsection
9972 \begin_layout Standard
9973 This section describes how to use LyX to make slides for overhead projectors.
9974 There are two document classes that can do this: the default slides class
9980 This section documents the latter.
9983 \begin_layout Standard
9984 I'm going to say this again, nice and clear, so that there's no misunderstanding
9988 \begin_layout Standard
9989 \begin_inset VSpace bigskip
9995 \begin_layout Standard
9999 This section documents the class
10000 \begin_inset Quotes eld
10008 \begin_inset Quotes erd
10016 \begin_layout Standard
10017 \begin_inset VSpace bigskip
10023 \begin_layout Standard
10024 If you're looking for the documentation for
10025 \begin_inset Quotes eld
10033 \begin_inset Quotes erd
10036 , check out section
10037 \begin_inset space ~
10041 \begin_inset CommandInset ref
10043 reference "sec:slitex"
10048 If your machine doesn't have the
10053 \begin_inset Quotes eld
10061 \begin_inset Quotes erd
10064 ] installed, you'll probably have to use the default
10068 class, which isn't quite as good as
10073 \begin_layout Standard
10078 class is designed for use with version 2.1 of the
10082 LaTeX class file which is now an integral part of LaTeX2e.
10085 \begin_layout Subsection
10089 \begin_layout Standard
10090 Obviously, to use this document class, you need to select
10091 \begin_inset Quotes eld
10099 \begin_inset Quotes erd
10109 \begin_inset space ~
10115 There are some settings in the
10118 \begin_inset space ~
10123 dialog that you should know about that are specific to this class:
10126 \begin_layout Itemize
10127 Don't change the options
10138 \begin_inset space ~
10144 They're ignored by the
10151 \begin_layout Itemize
10152 The default font size is 20
10153 \begin_inset space \thinspace{}
10156 pt with the other options being 17
10157 \begin_inset space \thinspace{}
10161 \begin_inset space \thinspace{}
10165 \begin_inset space \thinspace{}
10171 \begin_layout Itemize
10172 The default font is
10180 but all math equations are still typeset in the usual roman font.
10183 \begin_layout Itemize
10188 supports A4 and Letter paper sizes as well as a special size for working
10190 \begin_inset space \thinspace{}
10194 It doesn't support A5, B5, legal or executive paper sizes.
10197 \begin_layout Itemize
10198 Don't bother changing the
10202 settings because they are ignored anyway.
10203 All floats appear where they are defined in the text.
10206 \begin_layout Itemize
10211 setting behaves a bit differently for this class.
10216 provides extensive footer and header capabilities including a user-defined
10219 \begin_inset space ~
10223 \begin_inset CommandInset ref
10225 reference "sec:foilfoot"
10230 The title page is treated differently to all other pages in the document
10239 has the logo centered at the bottom of the page (if one is defined).
10240 The possible page style choices and what they do are as follows:
10244 \begin_layout Labeling
10245 \labelwidthstring MMMMMMM
10252 The final output contains no page numbers, or other headers or footers
10253 (except footnotes of course).
10257 \begin_layout Labeling
10258 \labelwidthstring MMMMMMM
10265 The final output contains page numbers centered at the bottom of the page.
10266 No other headings or footers (other than footnotes).
10269 \begin_layout Labeling
10270 \labelwidthstring MMMMMMM
10275 Page numbers in lower right corner.
10276 Additional headers and footers are also shown.
10277 This is also the default.
10280 \begin_layout Labeling
10281 \labelwidthstring MMMMMMM
10286 Gives you access to the
10290 package although its use with
10294 is discouraged by the writer of the
10298 package because of some potential page layout clashes.
10302 \begin_layout Subsubsection
10306 \begin_layout Standard
10307 The following options may be used in the extra class options in the
10309 Document\SpecialChar \menuseparator
10315 \begin_layout Labeling
10316 \labelwidthstring MMMMMMx
10321 This sets up the page layout for 7.33
10322 \begin_inset space \thinspace{}
10326 \begin_inset space \thinspace{}
10329 in paper, which is about the same aspect ratio as a 35
10330 \begin_inset space \thinspace{}
10333 mm slide, making it a bit easier to work with this medium.
10336 \begin_layout Labeling
10337 \labelwidthstring MMMMMMx
10342 Places a rule across the page below the header on every page except the
10346 \begin_layout Labeling
10347 \labelwidthstring MMMMMMx
10352 Places a rule across the page above the footer on every page except the
10356 \begin_layout Labeling
10357 \labelwidthstring MMMMMMx
10362 This is automatically set each time you create a new
10371 to use the dvips driver to rotate those pages that are set as landscape
10375 \begin_layout Labeling
10376 \labelwidthstring MMMMMMx
10381 Simply changes the page dimensions to those of a landscape page but doesn't
10383 Thus if you use this option you need to use an external program to rotate
10384 each page or feed your paper through your printer as landscape.
10385 Note that this option effectively reverses the roles of the
10393 environments (don't worry these are described in the next section).
10396 \begin_layout Labeling
10397 \labelwidthstring MMMMMMx
10402 Equation numbers on the left.
10405 \begin_layout Labeling
10406 \labelwidthstring MMMMMMx
10411 Flush-left equations.
10414 \begin_layout Subsection
10415 Supported Environments
10418 \begin_layout Standard
10419 Most of the environments commonly supported in other classes are also supported
10425 There are several additional environments provided by
10429 as well as a couple added by LyX.
10430 The following environments are shared with other classes:
10433 \begin_layout Standard
10437 \begin_layout Plain Layout
10441 begin{multicols}{2}
10449 \begin_layout Itemize
10455 \begin_layout Itemize
10461 \begin_layout Itemize
10467 \begin_layout Itemize
10473 \begin_layout Itemize
10479 \begin_layout Itemize
10485 \begin_layout Itemize
10491 \begin_layout Itemize
10497 \begin_layout Itemize
10503 \begin_layout Itemize
10509 \begin_layout Itemize
10515 \begin_layout Itemize
10521 \begin_layout Itemize
10527 \begin_layout Itemize
10533 \begin_layout Itemize
10539 \begin_layout Itemize
10545 \begin_layout Itemize
10551 \begin_layout Itemize
10557 \begin_layout Standard
10561 \begin_layout Plain Layout
10573 \begin_layout Standard
10574 That is, all the major environments apart from the sectioning environments.
10575 Since foils are essentially self-contained sections, with a title and body,
10580 provides specific commands for starting new foils and these are:
10583 \begin_layout Itemize
10589 \begin_layout Itemize
10595 \begin_layout Standard
10596 LyX also provides slightly modified versions of these two environments called:
10599 \begin_layout Itemize
10605 \begin_layout Itemize
10608 ShortRotatefoilhead
10611 \begin_layout Standard
10612 and the differences will be explained in the next section.
10615 \begin_layout Standard
10616 Since foils are often used in presenting ideas or new theorems and such
10621 also provides a comprehensive box of goodies for presenting them:
10624 \begin_layout Standard
10628 \begin_layout Plain Layout
10632 begin{multicols}{2}
10640 \begin_layout Itemize
10646 \begin_layout Itemize
10652 \begin_layout Itemize
10658 \begin_layout Itemize
10664 \begin_layout Itemize
10670 \begin_layout Itemize
10676 \begin_layout Itemize
10682 \begin_layout Itemize
10688 \begin_layout Itemize
10694 \begin_layout Itemize
10700 \begin_layout Itemize
10706 \begin_layout Standard
10710 \begin_layout Plain Layout
10722 \begin_layout Standard
10723 The starred versions are unnumbered while the unstarred versions are numbered.
10724 There are also two list environments added by LyX and these are:
10727 \begin_layout Itemize
10733 \begin_layout Itemize
10739 \begin_layout Standard
10744 provides some powerful header and footer capabilities that are best set
10745 in the preamble although they may be set at any point in a document.
10746 If you want to change these settings in your document the best place to
10747 do so is at the very top of a foil, i.
10748 \begin_inset space \thinspace{}
10754 \begin_inset space \space{}
10759 straight after the foilhead.
10762 \begin_layout Standard
10763 For this purpose, the following command styles are provided [
10770 \begin_layout Standard
10774 \begin_layout Plain Layout
10778 begin{multicols}{2}
10786 \begin_layout Itemize
10790 \begin_inset space ~
10796 \begin_layout Itemize
10802 \begin_layout Itemize
10806 \begin_inset space ~
10812 \begin_layout Itemize
10816 \begin_inset space ~
10822 \begin_layout Itemize
10826 \begin_inset space ~
10833 \begin_layout Standard
10834 \begin_inset space ~
10841 \begin_layout Standard
10845 \begin_layout Plain Layout
10857 \begin_layout Standard
10858 There are also a few commands provided by
10862 that aren't directly supported by LyX but I'll tell you what they do and
10863 how to use them in section
10864 \begin_inset space ~
10868 \begin_inset CommandInset ref
10870 reference "sec:unsuppfoils"
10877 \begin_layout Subsection
10878 Building a Set of Foils
10881 \begin_layout Standard
10882 This section will give a simple introduction to using the different environments
10883 to build a set of foils.
10884 If you want to see an example set of foils, take a look at the
10888 file you find in LyX's
10895 \begin_layout Subsubsection
10896 Give It a Title Page
10899 \begin_layout Standard
10900 Unlike other classes that provide
10920 creates the title on a page of its own.
10921 If you leave out the
10925 environment LaTeX will substitute the current date (every time you regenerate
10929 \begin_layout Subsubsection
10933 \begin_layout Standard
10934 As I mentioned earlier, there are four ways of starting a new foil.
10935 For portrait foils you should use
10944 The difference between these two environments is the amount of space between
10945 the title of the foil (the foilhead) and the body of the foil.
10948 \begin_layout Standard
10949 Landscape foils are generated using the
10955 ShortRotatefoilhead
10958 Again the only difference is the spacing between foilhead and body.
10959 Both of the short versions have 0.5 inches less separation between the foilhead
10964 \begin_layout Standard
10965 One problem with the support for landscape foils is the requirement that
10966 you have to use the
10970 driver to generate the PostScript output otherwise the foils won't be rotated.
10971 It is possible to get landscape foils even if you haven't got the
10975 driver provided you can feed your foils sideways through your printer ;-)
10978 \begin_layout Subsubsection
10979 Theorems, Lemmas, Proofs and more
10982 \begin_layout Standard
10983 Due to a small bug in LyX you can't have two of the same type of these environme
10984 nts directly following each other.
10985 They must be separated by something.
10986 If you try, you will just be extending the previous environment as if you
10987 had merged the two environments together.
10988 So, how do you get around this problem? The simplest option is to insert
10989 some text between the two environments or add a
10993 environment between the two with just a
10994 \begin_inset Quotes eld
11002 \begin_inset Quotes erd
11006 This will force LyX to produce two separate environments and hence the
11007 correct LaTeX output.
11008 An example is provided in the example file included with the LyX distribution.
11009 Remember, this problem only occurs if you are trying to place two of the
11010 same type of theorem-like environments one directly after the other.
11013 \begin_layout Subsubsection
11017 \begin_layout Standard
11018 You get all the commonly supported list styles found in other classes as
11019 well as two new ones.
11020 I'll only describe the new ones here.
11021 If you want to find out more about the other list environments check out
11027 If you intend to use itemized lists you might also want to read about the
11031 \begin_inset space ~
11035 \begin_inset space ~
11040 dialog described above in section
11041 \begin_inset space ~
11045 \begin_inset CommandInset ref
11047 reference "sec:bullet"
11054 \begin_layout Standard
11055 The two new list styles,
11063 , are designed to make it easier for you to create lists of do's and don'ts
11064 or right and wrong by providing dedicated environments that use a tick
11065 or a cross as the label of the list.
11066 These lists are in fact dedicated variants of the
11071 They do however require that you have the
11075 packages installed.
11078 \begin_layout Subsubsection
11082 \begin_layout Standard
11087 redefines the floating tables and figures so that they appear exactly where
11088 they are in the text rather than pushing them to the top of the page or
11089 to some user specified location.
11090 In fact if you change the float placement settings they are simply ignored.
11093 \begin_layout Subsubsection
11094 Page Headers and Footers
11095 \begin_inset CommandInset label
11097 name "sec:foilfoot"
11104 \begin_layout Standard
11108 \begin_inset space ~
11117 are two commands used to control the left-footer text string.
11118 The first is meant to allow you to include a graphic logo on your foils
11120 \begin_inset Quotes eld
11128 \begin_inset Quotes erd
11132 While the second is meant to provide a classification for the audience,
11136 \begin_inset space \thinspace{}
11142 \begin_inset space \space{}
11146 It is empty by default.
11149 \begin_layout Standard
11150 The remaining page corners can be filled by
11153 \begin_inset space ~
11158 (which defaults to page numbers),
11161 \begin_inset space ~
11169 \begin_inset space ~
11177 \begin_layout Subsection
11183 \begin_inset CommandInset label
11185 name "sec:unsuppfoils"
11192 \begin_layout Standard
11193 All the commands mentioned below need to be set in a
11201 within another environment.
11204 \begin_layout Subsubsection
11208 \begin_layout Standard
11209 All lengths are adjusted using the
11232 should be replaced by the name given to the length you want to change and
11237 is the length value.
11238 All lengths should be specified in units of length such as inches (
11250 ) or relative to some document or font-based length such as
11260 \begin_layout Standard
11261 It's possible to change the spacing between a foilhead and the body of the
11262 foil by adjusting the length specified by
11269 For example, to make
11274 \begin_inset space \space{}
11277 in closer to their bodies put the following in the preamble:
11283 foilheadskip}{-0.5in}
11286 \begin_layout Standard
11287 The spacings around floats can be adjusted by setting these lengths:
11290 \begin_layout Labeling
11291 \labelwidthstring MMMMMMMMMMM
11298 Separation between the text and the top of the float
11301 \begin_layout Labeling
11302 \labelwidthstring MMMMMMMMMMM
11309 Separation between the float and the caption
11312 \begin_layout Labeling
11313 \labelwidthstring MMMMMMMMMMM
11320 Separation between the caption and the following text
11323 \begin_layout Labeling
11324 \labelwidthstring MMMMMMMMMMM
11331 You can make the captions narrower than the surrounding text by adjusting
11333 Best done relative to
11342 \begin_layout Standard
11343 There are also several title page related lengths that you may find useful
11344 if you have a long title or several authors:
11347 \begin_layout Labeling
11348 \labelwidthstring MMMMMMMMMMM
11355 Separation from headers to
11360 \begin_layout Labeling
11361 \labelwidthstring MMMMMMMMMMM
11379 \begin_layout Labeling
11380 \labelwidthstring MMMMMMMMMMM
11394 \begin_layout Labeling
11395 \labelwidthstring MMMMMMMMMMM
11411 \begin_layout Labeling
11412 \labelwidthstring MMMMMMMMMMM
11428 \begin_layout Standard
11429 The last length related command affects all the list environments.
11440 a list environment then all the vertical spacing between the list items
11442 Note that this is a command not a length so it doesn't require
11448 like the stuff mentioned above.
11451 \begin_layout Subsubsection
11452 Headers and Footers
11455 \begin_layout Standard
11468 commands control whether the logo in the
11472 definition appear on a given page.
11479 in the preamble then none of the foils will have the logo on them.
11480 If you don't want the logo on a particular page place the
11486 directly after the foilhead of that page and the
11492 directly after the next foilhead.
11495 \begin_layout Standard
11496 If you decide to use the
11500 page style setting in the
11503 \begin_inset space ~
11508 dialog you should probably add
11518 to your preamble so headers and footers on landscape pages are correctly
11519 placed when rotated.
11520 This is due to some clashes between the page layouts provided by the
11531 \begin_layout Section
11532 Hollywood (Hollywood spec scripts)
11535 \begin_layout Standard
11541 \begin_layout Subsection
11545 \begin_layout Standard
11546 Getting the format of a Hollywood script right is a
11547 \begin_inset Quotes eld
11551 \begin_inset Quotes erd
11554 It is designed to make the readers focus on content and to be easy and
11555 familiar for the actors to read.
11556 Each page of a script should be one minute of film.
11557 Nothing goes in a script that you cannot see or hear on screen.
11558 The courier 12 pt font should be used throughout.
11562 \begin_layout Subsection
11566 \begin_layout Standard
11567 Speakers' lines should NEVER break in mid-sentence.
11568 If a speaker's lines continue over a page break, repeat the
11572 title followed by (Cont'd).
11575 \begin_layout Subsection
11579 \begin_layout Standard
11584 names as labels then cross-reference the label to insert the name.
11585 The cross-reference dialog will show the current cast of characters.
11586 You can use this to insert the speaker name in narratives also.
11589 \begin_layout Subsection
11590 Paper size and Margins
11593 \begin_layout Standard
11594 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
11597 \begin_layout Subsection
11601 \begin_layout Standard
11602 The following environments are available.
11603 You can use hollywood.bind to get the bind keys shown at the right.
11606 \begin_layout Itemize
11610 \begin_inset Newline newline
11615 Used where nothing else works.
11619 \begin_layout Itemize
11625 \begin_inset space \hfill{}
11633 \begin_inset Newline newline
11636 Usually followed by something like
11637 \begin_inset Quotes eld
11640 on Sally waking up.
11641 \begin_inset Quotes erd
11647 \begin_layout Itemize
11651 \begin_inset space \hfill{}
11655 \begin_inset Newline newline
11660 Introduces a new INTERIOR camera set-up.
11661 Always followed by DAY or NIGHT, or something similar to define the lighting
11663 Everthing on this line in CAPS.
11666 \begin_layout Itemize
11670 \begin_inset space \hfill{}
11674 \begin_inset Newline newline
11679 Introduces a new EXTERIOR camera set-up.
11680 Everthing on this line in CAPS.
11683 \begin_layout Itemize
11687 \begin_inset space \hfill{}
11691 \begin_inset Newline newline
11696 The character speaking.
11699 \begin_layout Itemize
11703 \begin_inset space \hfill{}
11707 \begin_inset Newline newline
11712 Instructions to the speaker.
11713 The () are automatically inserted, but only the ( will show in LyX.
11714 Both will be printed.
11717 \begin_layout Itemize
11721 \begin_inset space \hfill{}
11725 \begin_inset Newline newline
11737 \begin_layout Itemize
11741 \begin_inset space \hfill{}
11745 \begin_inset Newline newline
11750 Camera movement instruction.
11752 \begin_inset space \thinspace{}
11756 \begin_inset space \space{}
11762 \begin_layout Itemize
11766 \begin_inset space \hfill{}
11772 \begin_layout Itemize
11776 \begin_inset space \hfill{}
11782 \begin_layout Itemize
11786 \begin_inset space \hfill{}
11792 \begin_layout Itemize
11796 \begin_inset space \hfill{}
11802 \begin_layout Subsection
11806 \begin_layout Itemize
11810 \begin_layout Itemize
11814 \begin_layout Itemize
11816 \begin_inset space \thinspace{}
11823 \begin_layout Itemize
11828 \begin_layout Itemize
11829 PAN — camera movement
11832 \begin_layout Itemize
11833 INSERT — cut to close-up of
11836 \begin_layout Section
11840 \begin_layout Standard
11843 Panayotis Papasotiriou
11846 \begin_layout Subsection
11850 \begin_layout Standard
11851 The ijmpc package is a set of macros that facilitates electronic manuscript
11854 International Journal of Modern Physics C
11857 Similarly, the ijmpd package is for creating manuscripts to be submitted
11860 International Journal of Modern Physics D
11863 Both journals are published by World Scientific.
11864 The corresponding document classes are named
11873 These files, together with instructions for the authors, can be downloaded
11875 \begin_inset Flex URL
11878 \begin_layout Plain Layout
11880 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
11886 \begin_inset Flex URL
11889 \begin_layout Plain Layout
11891 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
11897 Both packages are modified versions of the standard
11898 \begin_inset Quotes eld
11902 \begin_inset Quotes erd
11905 package, and they are almost (but not exactly) identical.
11906 Most of their features are supported by LyX.
11907 I have used LyX successfully to write articles submitted to both journals
11908 without any problem.
11911 \begin_layout Subsection
11915 \begin_layout Standard
11916 As usual, the easiest way to write a paper is to start with a template.
11919 File\SpecialChar \menuseparator
11938 This will give an (almost) empty document that includes the most common
11939 fields found in a manuscript.
11940 Simply overwrite the existing text (including the brackets,
11945 You should keep in mind the following remarks.
11948 \begin_layout Enumerate
11949 LyX won't let you change the font size and the page style of the document,
11950 because such modifications are not allowed by both packages.
11953 \begin_layout Enumerate
11954 The language of the document should not be changed.
11955 Before previewing your paper, be sure that the babel package is not used.
11956 To do this, click on
11958 Tools\SpecialChar \menuseparator
11969 checkbox in the language settings, and click on
11977 , if you wish to make this change permanent).
11980 \begin_layout Enumerate
11982 \begin_inset Quotes eld
11986 \begin_inset Quotes erd
11989 style must be used to define keywords.
11992 \begin_layout Enumerate
11993 The ijmpc package provides a style named
11994 \begin_inset Quotes eld
11997 Classification Codes
11998 \begin_inset Quotes erd
12001 , which can be used to define classification codes, such as PACS numbers.
12002 Note that this facility is not supported by the ijmpd package.
12005 \begin_layout Enumerate
12006 Several new environments are available:
12007 \begin_inset Quotes eld
12011 \begin_inset Quotes erd
12015 \begin_inset Quotes eld
12019 \begin_inset Quotes erd
12023 \begin_inset Quotes eld
12027 \begin_inset Quotes erd
12031 \begin_inset Quotes eld
12035 \begin_inset Quotes erd
12039 \begin_inset Quotes eld
12043 \begin_inset Quotes erd
12047 \begin_inset Quotes eld
12051 \begin_inset Quotes erd
12055 \begin_inset Quotes eld
12059 \begin_inset Quotes erd
12063 \begin_inset Quotes eld
12067 \begin_inset Quotes erd
12071 \begin_inset Quotes eld
12075 \begin_inset Quotes erd
12079 \begin_inset Quotes eld
12083 \begin_inset Quotes erd
12087 \begin_inset Quotes eld
12091 \begin_inset Quotes erd
12095 \begin_inset Quotes eld
12099 \begin_inset Quotes erd
12103 \begin_inset Quotes eld
12107 \begin_inset Quotes erd
12111 \begin_inset Quotes eld
12115 \begin_inset Quotes erd
12119 Their use is more or less obvious.
12120 LyX supports all these environments; it will use the proper label, text
12121 style, and numbering scheme for each of them.
12124 \begin_layout Enumerate
12125 Both packages use basic citations; the natbib package should not be used.
12126 In LyX, citation references are shown as usual; in the output, citations
12127 are shown as superscripts.
12128 If you want to use a citation as normal text, you should use the
12133 \begin_inset space \thinspace{}
12137 \begin_inset space \space{}
12141 \begin_inset Quotes eld
12145 \begin_inset space \space{}
12155 \begin_inset Quotes erd
12161 \begin_layout Enumerate
12163 \begin_inset Quotes eld
12167 \begin_inset Quotes erd
12170 section in both packages.
12171 To put acknowledgments, just use the
12172 \begin_inset Quotes eld
12176 \begin_inset Quotes erd
12182 \begin_layout Enumerate
12183 Appendices may be added to the paper,
12187 the Acknowledgments and
12192 LyX provides a special environment, called
12193 \begin_inset Quotes eld
12197 \begin_inset Quotes erd
12200 which marks the beginning of the appendices.
12201 This environment should be left blank; it just sends a LaTeX command, but
12202 nothing is really printed.
12204 \begin_inset Quotes eld
12208 \begin_inset Quotes erd
12211 is printed with blue letters, as a signal that all sections after that
12212 point are appendices.
12213 To write an appendix, use the
12214 \begin_inset Quotes eld
12218 \begin_inset Quotes erd
12222 LyX will number each appendix with capital letters, as required by both
12225 \begin_inset Quotes eld
12229 \begin_inset Quotes erd
12236 be present before the first appendix; if not, all appendices will be numbered
12237 as normal sections in the output.
12240 \begin_layout Enumerate
12241 The ijmpc and the ijmpd packages use the
12245 command to implement table captions.
12246 As a result, a table created by LyX is printed correctly, but its caption
12248 However, you can use some TeX code to overcome this problem, so that captions
12249 are printed as expected.
12250 To do so, create a float table as usual, remove the caption, and replace
12251 it with the TeX code
12261 (sic); you must also the TeX code
12265 immediately after the tabular material.
12266 Study the example table included in the template files to see how this
12267 trick is implemented.
12268 Alternatively, If you need table captions, you should implement the whole
12273 file, then include this file to the LyX document (
12275 Insert\SpecialChar \menuseparator
12276 File\SpecialChar \menuseparator
12278 \begin_inset space ~
12284 Details on how to create a table float can be found in the files
12292 , included in the corresponding packages.
12295 \begin_layout Subsection
12296 Preparing a paper for submission
12299 \begin_layout Standard
12300 Before you submit your paper you must export the LyX document as a LaTeX
12303 File\SpecialChar \menuseparator
12304 Export\SpecialChar \menuseparator
12311 \begin_layout Plain Layout
12312 Actually you have the choice between LaTeX (plain) and pdflatex.
12313 If you intend to use pdflatex to prepare the paper, you should use the
12314 pdflatex option so that included graphics are converted to PDF format,
12315 ready for use by pdflatex.
12320 , then make the following changes to the resulting
12327 \begin_layout Enumerate
12328 Remove the comment lines before the
12337 \begin_layout Enumerate
12338 Remove everything between (and including) the
12350 commands, except for any commands you specifically put into the LaTeX preamble.
12353 \begin_layout Standard
12358 file should be saved and processed through LaTeX as many times as necessary.
12359 You may also want to check the resulting
12366 \begin_layout Subsection
12370 \begin_layout Standard
12371 The use of TeX code is reduced to two commands, which must be placed at
12372 the top of the document.
12373 If you started writing your paper by using the
12381 template, the TeX code needed is already in its place; you usually don't
12383 You may only modify the first TeX code to specify the information printed
12384 to the top of odd and even pages (authors' names and short paper's title,
12386 This TeX code must have the form
12390 markboth{Authors' Names}{Short Paper's Title}
12395 \begin_layout Section
12399 \begin_layout Standard
12405 \begin_layout Subsection
12409 \begin_layout Standard
12410 The iopart package provides a document class to create electronic manuscript
12411 submission to the journals published by the Institute of Physics.
12412 Instructions for the authors how to create a paper using the iopart class
12413 can be downloaded together with the iopart package from the site
12414 \begin_inset Flex URL
12417 \begin_layout Plain Layout
12419 ftp://ftp.iop.org/pub/journals/latex2e
12427 \begin_layout Subsection
12431 \begin_layout Standard
12432 The easiest way to write a paper is to start with the file
12436 that is available in LyX's examples files folder.
12437 Open this file, save it under a new name, and start writing.
12438 The example file explains how to use the special text environments.
12439 Here are the most important advices:
12442 \begin_layout Itemize
12443 To be able to compile your document to a PDF, PS, or DVI, ensure that the
12446 Use AMS math package
12448 in the document settings under
12455 \begin_layout Itemize
12458 The title environment defines the kind of your paper.
12459 So use one of the following environments for the title:
12463 \begin_layout Itemize
12472 \begin_layout Itemize
12481 \begin_layout Itemize
12487 for a Topical review
12490 \begin_layout Itemize
12499 \begin_layout Itemize
12508 \begin_layout Itemize
12514 for a Paper (same as Title)
12517 \begin_layout Itemize
12523 for a Preliminary communication
12526 \begin_layout Itemize
12532 for a Rapid communication
12535 \begin_layout Itemize
12541 for a Letter to the editor
12545 \begin_layout Itemize
12548 All title environments except of
12552 can have an optional short title.
12555 \begin_layout Itemize
12556 There is a general title environment
12560 which is not directly supported by the LyX.
12561 This can be used as TeX code when your document doesn't fit into one of
12562 the other title types.
12565 \begin_layout Standard
12566 For more informations like hints for special table and formula formatting,
12567 look at the IOP author guidelines.
12570 \begin_layout Section
12574 \begin_layout Standard
12577 Panayotis Papasotiriou
12580 \begin_layout Subsection
12584 \begin_layout Standard
12585 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
12586 that facilitates electronic manuscript submission to the journals they
12588 Most known of them (at least in my domain of interest) are
12590 Astrophysics and Space Science
12596 , but there are many others (see a complete list at
12597 \begin_inset Flex URL
12600 \begin_layout Plain Layout
12602 http://www.wkap.nl/jrnllist.htm/JRNLHOME
12608 The Kluwer package may be downloaded from the site
12609 \begin_inset Flex URL
12612 \begin_layout Plain Layout
12614 http://www.wkap.nl/kaphtml.htm/STYLEFILES
12620 A complete user guide is contained in that package (but it can also be
12621 downloaded separately).
12624 \begin_layout Standard
12625 LyX supports many features of the package but not everything.
12626 However, the TeX code needed is reduced to some
12627 \begin_inset Quotes eld
12631 \begin_inset Quotes erd
12634 commands of the package (see
12635 \begin_inset space ~
12639 \begin_inset CommandInset ref
12641 reference "subsec:kluwer_peculiarities"
12646 I have recently used LyX to write an article submitted to the
12648 Astrophysics and Space Science
12650 without any problem.
12653 \begin_layout Subsection
12657 \begin_layout Standard
12658 The easiest way to write a paper is to start with the Kluwer template file.
12661 File\SpecialChar \menuseparator
12673 This will give an (almost) empty document that includes the most common
12674 fields found in a manuscript and a short description of their use.
12675 As in most templates, simply overwrite the existing text (including the
12680 ) with the correct information.
12683 \begin_layout Subsection
12684 Preparing a paper for submission
12687 \begin_layout Standard
12688 As in the AASTeX package, before you submit your paper to a journal you
12690 \begin_inset Quotes eld
12694 \begin_inset Quotes erd
12700 \begin_layout Enumerate
12701 Export your paper as a LaTeX file.
12702 To do this, click on
12704 File\SpecialChar \menuseparator
12705 Export\SpecialChar \menuseparator
12712 \begin_layout Enumerate
12717 file with a text editor and make the following changes
12721 \begin_layout Enumerate
12722 remove the comment lines before the
12731 \begin_layout Enumerate
12732 remove everything between (and including) the
12744 commands, except for any commands you specifically put into the LaTeX preamble.
12747 \begin_layout Standard
12756 \begin_layout Enumerate
12761 file through LaTeX as many times as necessary (usually up to three).
12764 \begin_layout Enumerate
12770 \begin_inset space \thinspace{}
12774 \begin_inset space \space{}
12781 , and check if everything is OK (it should, if you didn't make any mistake).
12784 \begin_layout Subsection
12785 \begin_inset Quotes eld
12789 \begin_inset Quotes erd
12792 of the Kluwer package
12793 \begin_inset CommandInset label
12795 name "subsec:kluwer_peculiarities"
12802 \begin_layout Standard
12803 The Kluwer package has the following
12804 \begin_inset Quotes eld
12808 \begin_inset Quotes erd
12814 \begin_layout Enumerate
12815 It is possible to write multiple articles in the same LaTeX file
12819 \begin_layout Plain Layout
12820 I can't imagine any good reason to do this.
12826 Each article must be included in the environment
12827 \begin_inset Quotes eld
12831 \begin_inset Quotes erd
12835 Unfortunately, this environment cannot be omitted, even if you write just
12837 Therefore, each article starts with the command
12843 and, obviously, ends with the command
12850 Although this can be implemented in LyX, I didn't included it, since it
12851 looks ugly and can confuse the novice user.
12852 Therefore, you need to enter them directly and mark them as LaTeX code
12854 \begin_inset Quotes eld
12858 \begin_inset Quotes erd
12864 \begin_layout Enumerate
12865 Information given at the beginning of the article (i.
12866 \begin_inset space \thinspace{}
12870 \begin_inset space \space{}
12873 title, subtitle, author, institution, running title, running author, abstract
12874 and keywords) must be included in an environment called
12875 \begin_inset Quotes eld
12879 \begin_inset Quotes erd
12883 This is not implemented in LyX, so you must enter title, subtitle etc.
12884 \begin_inset space ~
12887 between two TeX code lines (
12902 \begin_layout Enumerate
12903 According to the user manual, the label of each bibliography item must be
12927 \begin_layout Standard
12932 template takes care of all these
12933 \begin_inset Quotes eld
12937 \begin_inset Quotes erd
12941 If you start a new paper using this template you don't need to do anything
12946 \begin_layout Enumerate
12947 don't delete the TeX code included in the template, and
12950 \begin_layout Enumerate
12951 copy the example bibliography item included in the template and modify it
12952 as necessary to enter new bibliography items.
12955 \begin_layout Section
12959 \begin_layout Standard
12965 \begin_layout Subsection
12969 \begin_layout Standard
12970 The LyX document classes
12972 article (koma-script)
12976 report (koma-script)
12994 correspond to the LaTeX document classes
13011 \begin_inset space ~
13014 of the Koma-Script family.
13015 They are replacements for the standard document classes
13031 , resp., and fit better to European typography conventions in a number of
13035 \begin_layout Itemize
13036 Standard character size is 11pt in
13038 article (koma-script)
13042 report (koma-script)
13050 letter (koma-script)
13055 \begin_layout Itemize
13056 Headings, labels of the description environment, and a number of elements
13059 letter (koma-script)
13061 document class are set in a bold sans serif font.
13065 \begin_layout Plain Layout
13066 There is a big difference between the bold sans serif old cm fonts and new
13067 ec fonts, especially in the appearance of headings.
13068 In comparison, the ec bold sans serif fonts look a bit thin.
13069 Here the LaTeX package
13077 helps to produce the
13078 \begin_inset Quotes eld
13082 \begin_inset Quotes erd
13085 appearance when using the ec fonts.
13090 The numbering of chapter headings is made in the same way as the numbering
13091 of section headings, that is without the extra line
13092 \begin_inset Quotes eld
13095 Chapter\SpecialChar \ldots{}
13097 \begin_inset Quotes erd
13101 In addition, the appearance of the headings can be modified by using a
13102 number of options (in LyX to be entered in the field
13105 \begin_inset space ~
13112 Layout\SpecialChar \menuseparator
13119 \begin_layout Itemize
13120 The main means in the Koma-Script document classes to design the type area
13129 (in LyX to be entered in the extra class options field in the dialog
13131 Document\SpecialChar \menuseparator
13135 They make a clearer modification of page margins possible as do the options
13138 Document\SpecialChar \menuseparator
13145 \begin_layout Itemize
13146 The LaTeX document classes of the Koma-Script family define a number of
13147 additional commands.
13148 Those part of it which makes sense in LyX is implemented in corresponding
13152 \begin_layout Standard
13153 Detailed descriptions of the LaTeX document classes of the Koma-Script family
13154 can be found in the Koma-Script documentation
13165 \begin_layout Subsection
13166 article (koma-script), report (koma-script), and book (koma-script)
13169 \begin_layout Standard
13170 The document classes
13172 article (koma-script)
13176 report (koma-script)
13186 are implemented in the layout files
13199 They contain all the paragraph types of the corresponding standard document
13212 , resp., partly modified, with the exception of the LyX specific
13216 -type, which is replaced by the new
13220 -type having the same functionality.
13225 -Type there is a number of new paragraph types added.
13232 letter (koma-script)
13237 \begin_layout Itemize
13246 : are equivalents to
13254 , resp., additionally inserting an entry in the table of contents.
13263 are not contained in
13265 article (koma-script)
13270 \begin_layout Itemize
13279 : behave exactly as
13287 , resp., additionally clearing running heads.
13292 is not contained in
13294 article (koma-script)
13300 \begin_layout Plain Layout
13313 report (koma-script)
13315 , but since this is identical to
13319 , is has not been implemented in LyX.
13327 \begin_layout Itemize
13332 : generates a heading directly above the following paragraph in the standard
13333 character size without affecting the structure of the document.
13336 \begin_layout Itemize
13345 are special captions which respect the different space settings needed
13346 for captions placed above or below an element (if you follow strict typographic
13347 rules, you might want to place table captions always above the table).
13348 You can also use the class option
13352 , which will switch
13365 You need at least Koma-Script version 2.8q to use this.
13368 \begin_layout Itemize
13373 : can be used to set a bonmot, e.
13374 \begin_inset space \thinspace{}
13378 \begin_inset space \space{}
13381 at the beginning of a chapter.
13382 If you use the optional argument (
13384 Insert\SpecialChar \menuseparator
13386 \begin_inset space ~
13391 ), you can insert the dictum's author there.
13392 Dictum and author are separated by a line.
13393 You need at least Koma-Script version 2.8q to use this.
13398 is not contained in
13400 article (koma-script)
13405 \begin_layout Standard
13406 The following types, together with the standard types
13418 , form the title area of the document.
13419 They must be entered ahead of the first
13420 \begin_inset Quotes eld
13424 \begin_inset Quotes erd
13431 \begin_layout Plain Layout
13432 The corresponding LaTeX commands must appear before the
13443 When such a type is used more than once, the latter usage overwrites the
13444 former one, that means, for every type only the latest usage is valid.
13445 The order of the different types however has, like
13457 , no effect on the appearance of the produced document.
13460 \begin_layout Itemize
13465 : produces a centered paragraph above the ordinary title (
13477 ) for the subject of the document.
13480 \begin_layout Itemize
13485 : produces a centered paragraph below the ordinary title (
13497 ) for the publishers' name.
13500 \begin_layout Itemize
13507 report (koma-script)
13513 produces a centered paragraph on its own page behind the title page, or
13516 article (koma-script)
13518 produces a centered paragraph below the ordinary title (
13534 ) for a dedication.
13537 \begin_layout Itemize
13542 : produces a left aligned paragraph above the ordinary title (
13558 ) for a document`s head.
13561 \begin_layout Itemize
13566 : produces in a double-sided print in
13568 report (koma-script)
13574 a left-aligned paragraph at the top of the title page`s back or has no
13575 effect in a single-sided print or in
13577 article (koma-script)
13582 \begin_layout Itemize
13587 : produces in a double-sided print in
13589 report (koma-script)
13595 a left-aligned paragraph at the bottom of the title page`s back or has
13596 no effect in a single-sided print or in
13598 article (koma-script)
13603 \begin_layout Itemize
13608 : produces a special
13609 \begin_inset Quotes eld
13613 \begin_inset Quotes erd
13616 page ahead of the actual document containing a paragraph without special
13620 \begin_layout Standard
13621 The layout files for the document classes
13623 article (koma-script)
13627 report (koma-script)
13633 do include the file
13638 This is thought of as a place to define your own types.
13643 in your personal layout directory and edit the file!
13646 \begin_layout Subsection
13647 letter (koma-script)
13650 \begin_layout Standard
13654 letter (koma-script)
13656 is implemented in the layout file
13661 It contains all the paragraph types of the corresponding standard document
13666 , partly modified, with the exception of the LyX specific types
13678 type, which is replaced by the new
13683 In addition, it contains, in contrast to the standard document class, the
13701 Furthermore, there are a number of new letter specific types.
13704 \begin_layout Standard
13705 The appearance of the letter produced by this document class can be controlled
13706 by a number of LaTeX commands, which you can put in the LaTeX preamble.
13710 \begin_layout Plain Layout
13711 For example, the standard appearance of the letter`s heading, consisting
13712 of name and address, is quite self-willed.
13714 \begin_inset Quotes eld
13718 \begin_inset Quotes erd
13721 heading is produced by the following LaTeX commands in the preamble:
13724 \begin_layout LyX-Code
13734 \begin_layout LyX-Code
13750 \begin_layout LyX-Code
13760 \begin_layout LyX-Code
13780 A detailed German description of such LaTeX commands can be found in the
13781 Koma-Script documentation
13786 With it, the letter's author can produce his personal letter layout.
13789 \begin_layout Standard
13798 define the beginning of the letter and must be used in every letter.
13799 To emphasize them in the LyX document class, they are marked with the letter
13809 \begin_inset space ~
13812 in the left margin.
13813 It is possible to write any number of letters in one file.
13818 type produces a new letter using the same addressee and a
13822 type produces a new addressee.
13839 are ordinary paragraph types and can also be used several times in one
13840 and the same letter.
13843 \begin_layout Itemize
13848 : produces a paragraph for the addressee and implicitly defines the beginning
13852 \begin_layout Itemize
13857 : produces a paragraph for the form of address and implicitly produces a
13861 \begin_layout Itemize
13866 : produces a paragraph for a close.
13869 \begin_layout Itemize
13874 : produces a paragraph for a postscript.
13877 \begin_layout Itemize
13882 : produces a paragraph for a distribution list.
13885 \begin_layout Itemize
13890 : produces a paragraph for enclosures.
13893 \begin_layout Standard
13934 are input types provided with a label to enter information, which will
13935 be processed by the document class.
13939 \begin_layout Plain Layout
13940 It could be seen as a matter of inconsequence, that the types
13948 described above are not such input types as well.
13949 Because of the special meaning of those types, however, I have implemented
13950 them as ordinary paragraph types with a one letter mark in the left margin.
13951 Moreover, it would affect my feeling of symmetry, if the
13959 type had such a serious different appearance.
13964 The types must be used ahead of the corresponding
13971 \begin_layout Standard
13972 An implementation of these types in a WYSIWYG fashion does not seem to make
13973 sense, because the real appearance of the produced letter does not only
13974 depend on the usage of the particular type, but also on other factors.
13975 For example, a signature entered in the
13979 type will in the standard behavior appear in the produced letter only,
13980 when in the same letter also a
13985 The entered value of the
13989 type will in the standard behavior not appear in the produced letter at
13991 The possibility to design the letter`s heading freely is already indicated
13992 in a footnote above.
13995 \begin_layout Standard
13996 The input types can also be used as empty paragraphs.
13997 This makes sense e.
13998 \begin_inset space \thinspace{}
14002 \begin_inset space \space{}
14014 type is not used at all, in the standard behavior the value of the
14018 type is used as signature, whereas if an empty
14022 type is used, no signature value is defined.
14025 \begin_layout Standard
14026 By using the input types it is possible to write a letter template, containing
14027 filled input types with your personal dates (name, address, etc.) and empty
14028 input types for other dates you want to enter.
14031 \begin_layout Itemize
14036 : sender's name, in the standard behavior appears as a centered paragraph
14037 in small caps in the letter`s heading.
14040 \begin_layout Itemize
14045 : sender's signature, in the standard behavior appears below the
14054 type is used, the value of the
14058 type appears instead.
14061 \begin_layout Itemize
14066 : sender's address, in the standard behavior appears in a centered paragraph
14067 in the letter`s heading below the sender's name.
14070 \begin_layout Itemize
14075 : sender's telephone number, in the standard behavior only sets the LaTeX
14085 \begin_layout Itemize
14090 : place of the letter`s making.
14093 \begin_layout Itemize
14098 : date of the letter`s making.
14107 , in the standard behavior, produce the place and the date in a right-aligned
14108 line below the addressee's field.
14113 type is used, neither place nor date appear, independent of the value of
14123 type is used, the date of the letter `s production is used.
14126 \begin_layout Itemize
14131 : sender`s back address, in the standard behavior appears above the addressee's
14132 field in a small sans serif font.
14135 \begin_layout Itemize
14140 : special mail information, in the standard behavior appears underlined
14141 above the addressee's field below the back address.
14144 \begin_layout Itemize
14149 : additional information, in the standard behavior appears on right side
14150 below the addressee`s field.
14153 \begin_layout Itemize
14158 : the letter's title, in the standard behavior appears in a big, bold, sans
14159 serif font above the subject.
14162 \begin_layout Itemize
14167 : the letter's subject, in the standard behavior appears in a bold font
14175 \begin_layout Standard
14196 produce a business letter like line above the
14200 line containing the fields
14201 \begin_inset Quotes eld
14205 \begin_inset Quotes erd
14209 \begin_inset Quotes eld
14213 \begin_inset Quotes erd
14217 \begin_inset Quotes eld
14221 \begin_inset Quotes erd
14225 \begin_inset Quotes eld
14229 \begin_inset Quotes erd
14233 \begin_inset Quotes eld
14237 \begin_inset Quotes erd
14241 \begin_inset Quotes eld
14245 \begin_inset Quotes erd
14249 For the date field, the value of the
14255 \begin_inset Quotes eld
14258 business letter types
14259 \begin_inset Quotes erd
14262 is used, the value of the
14266 type however does not appear, but only the LaTeX variable
14273 The ordinary output of place and date in a right-aligned line below the
14274 addressee`s field is suppressed.
14275 The types are implemented as input types provided with a label and must
14276 be used ahead of the corresponding
14283 \begin_layout Itemize
14291 \begin_layout Itemize
14299 \begin_layout Itemize
14307 \begin_layout Itemize
14315 \begin_layout Itemize
14323 \begin_layout Subsection
14324 The new letter class: letter (koma-script v.2)
14327 \begin_layout Standard
14333 \begin_layout Standard
14334 \begin_inset VSpace medskip
14340 \begin_layout Standard
14342 Koma-Script version 2.8 has introduced a new letter class
14346 which supersedes the now unsupported
14351 It has — on the LaTeX side — a completely new interface and is not compatible
14352 with the old class.
14353 Therefore, LyX supports both, though it is recommended you use the new
14357 \begin_layout Standard
14358 This class covers the same functionality as
14360 letter (koma-script),
14363 The basic items are
14367 (receiver's address, same as
14371 in the old layout),
14384 will start a new letter (i.
14385 \begin_inset space \thinspace{}
14389 \begin_inset space \space{}
14392 you can write several letters per document).
14393 New elements are sender's
14409 and the possibility to use a
14415 Insert\SpecialChar \menuseparator
14421 \begin_layout Standard
14422 The biggest improvement is, though, that the letter's layout is configurable
14423 to meet almost any needs.
14424 This can be done via the preamble or with a special style file (Letter
14425 Class Option, extension
14429 ), that will be read in as a class option.
14433 \begin_layout Plain Layout
14434 The KOMA package comes with some default
14439 There is, for instance, a
14443 file that follows german typesetting rules, or a
14447 that provides the default layout of the old
14452 The latter can be loaded with the class option
14461 ayout\SpecialChar \menuseparator
14466 ocument\SpecialChar \menuseparator
14478 template that is included in LyX for examples.
14479 A detailed description is to be found in the Koma-Script documentation
14487 \begin_layout Subsection
14491 \begin_layout Standard
14492 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
14496 \begin_layout Itemize
14497 The chapter number of a
14501 type appears on a line of its own above the chapter heading instead of
14502 appearing in the same line ahead of it.
14503 The cause for that is the LyX internal behavior for the labeltype
14507 in the layout file.
14510 \begin_layout Itemize
14511 The headings of the types
14519 are only put in the
14520 \begin_inset Quotes eld
14524 \begin_inset Quotes erd
14527 LaTeX table of contents, but not in the LyX table of contents (
14529 Document\SpecialChar \menuseparator
14531 \begin_inset space ~
14535 \begin_inset space ~
14543 \begin_layout Itemize
14544 The paragraphs in a
14548 document class appear in a skip separation mode, not indented.
14549 This is the standard behavior, no special LaTeX commands are needed for
14553 Document\SpecialChar \menuseparator
14556 dialog the corresponding radio button indicates
14565 value always has the effect that extra LaTeX commands are inserted in the
14566 document to produce the gap, which is not what is wanted in this case.
14569 \begin_layout Section
14573 \begin_layout Standard
14579 \begin_layout Subsection
14583 \begin_layout Standard
14584 Memoir is a very powerful and constantly evolving class.
14585 It has been designed with regard to fictional and non-fictional literature.
14586 Its aim is to let the user have maximum control over the typesetting of
14588 Memoir is based on the standard book class, but it can also emulate the
14589 article class (see below).
14592 \begin_layout Standard
14593 Peter Wilson, the developer of Memoir, is known as the author of lots of
14594 useful packages in the LaTeX world.
14595 Most of them have been merged with Memoir.
14596 Therefore, it is much easier to layout the table of contents, appendices,
14597 chapter designs and such.
14598 LyX, though, does not support all of these goodies natively.
14599 Some of them might be added to forthcoming releases
14603 \begin_layout Plain Layout
14604 You are invited to send suggestions to
14605 \begin_inset Flex URL
14608 \begin_layout Plain Layout
14610 lyx-devel@lists.lyx.org
14620 , lots will probably never, due to the limitations of LyX's framework.
14621 Of course you can still use all features with the help of some native LaTeX
14626 \begin_layout Plain Layout
14631 \begin_layout Plain Layout
14641 \begin_inset space ~
14645 \begin_inset CommandInset ref
14647 reference "sec:Inserting-TeX-Code"
14657 In this section, we can only list those features which are natively supported
14659 For detailed descriptions (and for the rest of features) we recommend you
14660 have a look at the detailed manual of the Memoir class
14664 \begin_layout Plain Layout
14669 \begin_layout Plain Layout
14679 \begin_inset Flex URL
14682 \begin_layout Plain Layout
14684 CTAN:/macros/latex/memoir/memman.pdf
14694 , which is not only a user guide for the class, but also both a comprehensive
14695 description on good typesetting and a superb example for good typesetting
14699 \begin_layout Subsection
14700 Basic features and restrictions
14703 \begin_layout Standard
14704 Memoir supports basically all features of the standard book classes.
14705 There are, however, some differences, as follows:
14708 \begin_layout Description
14710 \begin_inset space ~
14713 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
14716 \begin_layout Description
14718 \begin_inset space ~
14721 style: The fancy page style is not supported, due to a command clash between
14722 Memoir and the fancyhdr package (they both define a command with the same
14723 name, which confuses LaTeX).
14724 Instead, Memoir comes with a number of its own page styles (see
14726 Layout\SpecialChar \menuseparator
14727 Document\SpecialChar \menuseparator
14729 \begin_inset space ~
14735 If you want to use these for the chapter pages, you have to use the command
14742 in the main text or in preamble (e.
14743 \begin_inset space \thinspace{}
14747 \begin_inset space \space{}
14754 chapterstyle{companion}
14759 \begin_layout Description
14760 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
14761 optional argument in the standard classes.
14762 With this, you can specify an alternative version of the title for the
14763 table of contents and the headers (for instance, if the title is too long).
14764 In LyX, you can do this via
14766 Insert\SpecialChar \menuseparator
14768 \begin_inset space ~
14773 at the beginning of a chapter/section.
14774 Memoir features a second optional argument and thus separates the table
14775 of contents from the header.
14776 You can define three variants of a title with this: one for the main text,
14777 one for the table of contents, and one for the headers.
14778 Simply insert two optional arguments if you need this feature, the first
14779 one containing the short title for the Table of Contents, the second one
14780 containing an alternative short title for the headers.
14783 \begin_layout Description
14784 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14785 of contents, the list of figures and the list of table start a new page
14787 Memoir does not follow this route.
14788 You have to insert a page break yourself, if you want to have one.
14791 \begin_layout Description
14792 Titlepage: For some unknown reason, Memoir uses pagination on the title
14793 page (in the standard classes, title pages are
14794 \begin_inset Quotes eld
14798 \begin_inset Quotes erd
14802 \begin_inset space \thinspace{}
14806 \begin_inset space \space{}
14810 If you want an empty title page, type
14814 aliaspagestyle{title}{empty}
14819 \begin_layout Description
14820 Article: With the class option
14826 Layout\SpecialChar \menuseparator
14827 Document\SpecialChar \menuseparator
14829 \begin_inset space ~
14834 ), you can emulate article style.
14835 That is, counters (footnotes, figures, tables etc.) will not be reset on
14836 new chapters, chapters don't start a new page (but are—in contrary to
14837 \begin_inset Quotes eld
14841 \begin_inset Quotes erd
14844 article classes—still allowed), parts, though, use their own page, as in
14848 \begin_layout Description
14849 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14850 font commands, which have been used in the old LaTeX version 2.09 (e.
14851 \begin_inset space \thinspace{}
14855 \begin_inset space \space{}
14871 It produces an error and stops LaTeX whenever such a command appears.
14876 reallows the commands and spits out warnings instead (which does at least
14878 Since a lot of packages and particularly BibTeX style files are still using
14879 those commands, we have decided to use this option by default.
14882 \begin_layout Subsection
14886 \begin_layout Standard
14887 We will only describe the features supported by LyX (which is not much currently
14889 Please consult the Memoir manual
14893 \begin_layout Plain Layout
14898 \begin_layout Plain Layout
14908 \begin_inset Flex URL
14911 \begin_layout Plain Layout
14913 CTAN:/macros/latex/memoir/memman.pdf
14926 \begin_layout Description
14927 Abstract: You may wonder why an abstract is an extra feature.
14928 Well, it is in book class.
14929 Usually books don't have abstracts.
14930 Memoir, however, has.
14931 You can use it wherever and how often you like.
14934 \begin_layout Description
14935 Chapterprecis: You may know this older typesetting style: The contents of
14936 a chapter are summarized below the title and also in the table of contents
14938 \begin_inset space \thinspace{}
14942 \begin_inset space \space{}
14947 Our hero arrives in Troia; he loses some friends; he finds others
14950 Chapterprecis does exactly this.
14951 It is therefore only sensible below a chapter.
14954 \begin_layout Description
14955 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14956 The epigraph environment provides an elegant way of typesetting such a
14958 The motto itself (text) and its author (source) are divided by a short
14960 Unfortunately, we have to fool LyX a bit here again, since the environment
14961 needs two arguments (text and source).
14962 In this case, we have to use curly brackets (in TeX mode) between the two
14973 <author of the slogan>.
14976 \begin_layout Description
14977 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14978 complex figurative poems).
14979 LyX can only support a few of them.
14980 One is poemtitle, which is a centered title for poems, which will also
14981 be added to the table of contents (verse is the standard environment for
14983 Memoir has some enhanced versions of verse, but you need to use TeX code,
14984 because they have to be nested inside regular verse environments, which
14985 is not possible with LyX).
14988 \begin_layout Description
14989 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14992 \begin_layout Section
14993 Article (mwart), book (mwbk) and report (mwrep)
14994 \begin_inset Argument
14997 \begin_layout Plain Layout
15010 \begin_layout Standard
15016 \begin_layout Standard
15017 The LyX document classes
15033 correspond to the LaTeX document classes
15046 They are replacements for the standard document classes
15058 , resp., and fit better to Polish typography conventions in a number of points.
15062 \begin_layout Standard
15066 \begin_layout Itemize
15067 Unnumbered titles (with star, e.
15068 \begin_inset space \thinspace{}
15072 \begin_inset space \space{}
15079 ) are added into table of contents,
15082 \begin_layout Itemize
15083 Additional page styles:
15087 \begin_layout Description
15088 uheadings header with separated lines,
15091 \begin_layout Description
15092 myheadings custom header, contents headers via commands:
15107 \begin_layout Description
15108 myuheadings custom header with separated lines,
15111 \begin_layout Description
15112 outer page number is placed on outer side of page
15116 \begin_layout Itemize
15121 \begin_layout Description
15122 rmheadings serif titles — default,
15125 \begin_layout Description
15126 sfheadings sansserif titles,
15129 \begin_layout Description
15130 authortitle on title page first placed is author next title — default,
15133 \begin_layout Description
15134 titleauthor on title page first placed is title next author,
15137 \begin_layout Description
15138 withmarginpar reserve place on page for margins.
15142 \begin_layout Section
15146 \begin_layout Standard
15151 provides an alternative to the standard
15156 It provides similar functionality, but you might prefer this layout with
15157 sans serif sections, headings, and more.
15160 \begin_layout Section
15164 \begin_layout Standard
15170 \begin_layout Standard
15171 \begin_inset VSpace bigskip
15177 \begin_layout Standard
15182 \begin_inset space ~
15187 textclass works with the American Physical Sociey's RevTeX 4.0 (the
15188 \begin_inset Formula $\beta$
15191 release of May, 1999) class.
15194 \begin_layout Standard
15199 textclass, which works with RevTeX 3.1.
15200 However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
15201 That means that it doesn't interact very well with LyX, which requires
15202 LaTeX2e, although it has been kludged to work.
15203 Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
15207 \begin_inset space ~
15212 textclass should also be pretty easy to use.
15215 \begin_layout Standard
15216 These documents are supposed to be used in
15220 to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
15221 macros, and assume you'll know what to put in the preamble if necessary.
15224 \begin_layout Subsection
15228 \begin_layout Standard
15229 All you need to do is install RevTeX 4, as described in the package's README
15231 The package can be found at The RevTeX 4 Web Site
15232 \begin_inset Flex URL
15235 \begin_layout Plain Layout
15237 http://publish.aps.org/revtex4/
15243 Install it somewhere that LaTeX can see it.
15244 Test it by trying to LaTeX a short RevTeX 4 document in some random directory
15246 \begin_inset space \thinspace{}
15250 \begin_inset space \space{}
15253 not the directory where you installed the class file.) Then, if you reconfigure
15254 LyX, it will find the class file and let you use the RevTeX4 textclass.
15257 \begin_layout Standard
15258 Probably the easiest way to get started is either to import a RevTeX 4 document
15266 \begin_inset space ~
15271 template, found in the templates directory.
15274 \begin_layout Subsection
15278 \begin_layout Standard
15279 Optional arguments to
15286 \begin_inset Quotes eld
15290 \begin_inset Quotes erd
15294 \begin_inset Quotes eld
15298 \begin_inset Quotes erd
15308 \begin_inset space ~
15316 \begin_inset space ~
15322 Remember that in RevTeX, at least one optional argument is required!
15325 \begin_layout Standard
15326 Other preamble matter, like
15333 \begin_inset space ~
15339 \begin_inset space ~
15344 dialog, also as usual.
15347 \begin_layout Subsection
15351 \begin_layout Standard
15352 The layouts basically correspond to the commands in RevTeX4.0.
15353 For example, the Email layout corresponds to
15360 Note that (at least as of RevTeX 4.0 Beta), the
15368 layouts are exactly equivalent, so you shouldn't need to use both.
15372 \begin_layout Plain Layout
15373 In case you're curious, both were included so that
15377 would be able to translate both
15397 \begin_layout Subsection
15401 \begin_layout Standard
15402 There are a couple of important unique aspects of RevTeX 4 which might cause
15403 bugs that will be even more confusing in LyX.
15406 \begin_layout Standard
15424 The LyX equivalent is that there is a separate Thanks layout.
15429 write footnotes in the
15433 layout, or weird things may happen.
15434 See the RevTeX 4 documentation for more details.
15437 \begin_layout Standard
15441 \begin_inset space ~
15449 \begin_inset space ~
15458 layouts must be placed
15466 layout and the corresponding
15483 , the LaTeX won't compile.
15486 \begin_layout Subsection
15490 \begin_layout Standard
15491 The main problem with this layout is that you can't use the optional arguments
15492 to layouts like Email and Title.
15493 (The problem is not unique to this layout; you can't use optional arguments
15494 to the Section layouts either.) This means that after you export that file
15495 to LaTeX (which you'll need to do eventually to send it in to APS), you'll
15496 need to edit the LaTeX file with a text editor to add the optional arguments
15498 \begin_inset space \thinspace{}
15502 \begin_inset space \space{}
15505 the running title for the page headers.
15506 Lacking these layouts makes the
15512 (and the equivalent
15518 ) useless, so the corresponding layouts don't exist, and will have to be
15523 \begin_layout Plain Layout
15528 actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
15529 has not been updated yet to take advantage of it.
15537 \begin_layout Section
15538 Springer Journals (
15545 \begin_layout Standard
15551 \begin_layout Subsection
15555 \begin_layout Standard
15556 These are the layout files for some of the journal formats used by Springer
15557 Verlag and listed on
15558 \begin_inset Flex URL
15561 \begin_layout Plain Layout
15563 http://www.springer.de/author/tex/help-journals.html
15568 , where you should also go to fetch the class files (yes, these are LaTeX2e
15570 It is a modular system: the things common to all journals are implemented
15575 , which journal-specific layout files (such as, e.
15576 \begin_inset space \thinspace{}
15580 \begin_inset space \space{}
15587 for Journal of Geodesy) can include.
15590 \begin_layout Standard
15591 This means that implementing support for any other Springer journal on this
15592 list is as simple as writing your own
15600 file following the outline given in
15608 \begin_layout Standard
15609 It is reasonably well tested only for the Journal of Geodesy.
15618 come with the standard LyX distribution.
15619 Install the relevant class file (downloaded from Springer) in a proper
15620 directory, reconfigure LaTeX (in the teTeX case by running
15624 , as root if necessary — doesn't LyX take care of this?), reconfigure LyX
15625 and it should work.
15628 \begin_layout Subsection
15632 \begin_layout Standard
15633 A large number of theorem-like styles —
15639 \SpecialChar \ldots{}
15645 \begin_layout Standard
15648 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
15649 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
15652 See the Springer class file documentation for details.
15655 \begin_layout Subsection
15659 \begin_layout Itemize
15671 \begin_layout Itemize
15674 Probability Theory and Related Fields
15680 — Jean-Marc Lasgouttes
15683 \begin_layout Standard
15684 Add your own, it isn't so hard!
15687 \begin_layout Subsection
15691 \begin_layout Standard
15692 These files are partly based on the older
15696 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
15697 file from Springer.
15702 layout, are now defunct.
15703 Jean-Marc Lasgouttes helped out big in making me find my way around the
15704 LyX layout file mechanism.
15707 \begin_layout Subsection
15711 \begin_layout Standard
15713 But probably less than in the old hacked-LaTeX
15720 \begin_layout Standard
15722 \begin_inset space \thinspace{}
15725 g.: does not display the number for theorem-like layouts, just #.
15728 \begin_layout Section
15734 \begin_inset CommandInset label
15743 \begin_layout Standard
15751 \begin_layout Subsection
15755 \begin_layout Standard
15756 This section describes how to use LyX to make slides for overhead projectors.
15757 There are two document classes that can do this: the default slides class
15763 This section documents the former.
15766 \begin_layout Standard
15767 I'm going to say this again, nice and clear, so that there's no misunderstanding
15771 \begin_layout Standard
15772 \begin_inset VSpace bigskip
15778 \begin_layout Standard
15782 This section documents the class
15783 \begin_inset Quotes eld
15791 \begin_inset Quotes erd
15799 \begin_layout Standard
15800 \begin_inset VSpace bigskip
15806 \begin_layout Standard
15807 If you're looking for the documentation for
15808 \begin_inset Quotes eld
15816 \begin_inset Quotes erd
15819 , check out section
15820 \begin_inset space ~
15824 \begin_inset CommandInset ref
15826 reference "sec:foiltex"
15836 \begin_inset Quotes eld
15844 \begin_inset Quotes erd
15847 ] is actually somewhat better than the default
15855 \begin_layout Plain Layout
15856 \SpecialChar \ldots{}
15857 or so I've been told repeatedly by its advocates.
15858 Having never used it, I have no idea if this claim is true or not.
15863 which this section documents.
15866 \begin_layout Standard
15867 This class is the LaTeX2e improvement of the old
15872 Every LaTeX2e distribution includes this class [which I'll just refer to
15874 \begin_inset Quotes eld
15882 \begin_inset Quotes erd
15885 from now on], so you're bound to have it.
15886 As I noted earlier, there are other classes, such as
15890 , which also produce slides for overhead projectors and do a better job
15892 However, there are some things which
15896 can do which the others can't, such as generate overlays.
15897 Read on to learn more!
15900 \begin_layout Subsection
15902 \begin_inset CommandInset label
15904 name "sec:slidesetup"
15911 \begin_layout Standard
15912 Obviously, to use this document class, you need to select
15913 \begin_inset Quotes eld
15921 \begin_inset Quotes erd
15924 from the class list in the
15926 Document\SpecialChar \menuseparator
15930 There are some other special things you should know about this class:
15933 \begin_layout Itemize
15934 Don't bother changing the options
15939 They're not supported by the
15946 \begin_layout Itemize
15950 \begin_inset space ~
15955 behaves a bit differently for this class.
15956 The possible choices and what they do are as follows:
15960 \begin_layout Description
15965 The final output contains page numbers in the lower right corner.
15968 \begin_layout Description
15977 , but also prints out any time markers you've put in.
15978 This is the default.
15981 \begin_layout Description
15986 The final output contains no page numbers, time markers, or alignment markers.
15990 \begin_layout Itemize
15995 class has an extra option:
16001 \begin_inset Quotes eld
16009 \begin_inset Quotes erd
16012 in the extra class options.
16016 \begin_layout Standard
16017 Using this options allows you to add time markers to
16023 \begin_inset space ~
16027 \begin_inset CommandInset ref
16029 reference "sec:slideNote"
16037 \begin_layout Standard
16038 You can also use the template file
16039 \begin_inset Quotes eld
16047 \begin_inset Quotes erd
16050 to automatically set up a document to use the
16056 File\SpecialChar \menuseparator
16058 \begin_inset space ~
16062 \begin_inset space ~
16067 to open your new document].
16068 The template file also contains some examples of the special paragraph
16069 environments used by this class.
16070 I'll describe those next.
16073 \begin_layout Subsection
16074 Paragraph Environments
16077 \begin_layout Subsubsection
16078 Supported Environments
16081 \begin_layout Standard
16082 The first thing you'll notice when you start up a new
16086 document is the font size and type: it's the equivalent of the size
16087 \begin_inset Quotes eld
16095 \begin_inset Quotes erd
16101 \begin_inset space ~
16107 This is also what's used in the output.
16109 \begin_inset Quotes eld
16113 \begin_inset Quotes erd
16116 to remind you that this is a slide.
16117 Your final slides will use a larger font; ergo, you'll have less space.
16118 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
16121 \begin_layout Standard
16122 The next thing that becomes obvious is the changes to the paragraph environment
16123 pull-down box [at the far-left end of the toolbar].
16124 Most of the paragraph environments you're used to seeing are missing.
16125 There are also five new ones.
16130 class itself only supports certain paragraph environments:
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 Itemize
16193 \begin_layout Itemize
16199 \begin_layout Standard
16200 All of the other standard environments, including the section-heading environmen
16201 ts, aren't used in the
16208 \begin_layout Standard
16209 On the other hand, you'll notice the following new environments:
16212 \begin_layout Itemize
16218 \begin_layout Itemize
16224 \begin_layout Itemize
16230 \begin_layout Itemize
16236 \begin_layout Itemize
16242 \begin_layout Standard
16243 These five are kind of quirky, due to a
16244 \begin_inset Quotes eld
16248 \begin_inset Quotes erd
16252 You see, LyX doesn't permit you to nest any other paragraph environment
16253 into an empty environment.
16254 Now, that's fine and dandy, but it means that you wouldn't be able to start
16255 a slide with anything except plain text.
16256 To deal with this, I've performed a little
16257 \begin_inset Quotes eld
16261 \begin_inset Quotes erd
16267 \begin_layout Subsubsection
16268 Quirks of the New Environments
16269 \begin_inset CommandInset label
16271 name "sec:slideQuirk"
16278 \begin_layout Standard
16279 All five of the new paragraph environments are somewhat quirky due to inherent
16280 limitiations in the current version of LyX.
16281 As I just mentioned, LyX forbids environments that begin with another environme
16283 To get around this, the
16287 environment isn't a paragraph environment as described in the
16295 \begin_layout Standard
16296 You should consider
16309 \begin_inset Quotes eld
16312 pseudo-environments.
16313 \begin_inset Quotes erd
16316 They look like a section heading or a
16317 \begin_inset Quotes eld
16325 \begin_inset Quotes erd
16328 but really begin a [and, if necessary, end the previous] paragraph environment.
16338 \begin_inset Quotes eld
16342 \begin_inset Quotes erd
16345 These two perform some action.
16348 \begin_layout Standard
16349 A common feature of all five environments,
16369 , is a rather long-ish label.
16370 The text following this label — ordinarily the contents of the paragraph
16371 environment — is utterly irrelevant for
16392 LyX completely ignores it.
16393 In fact, you can leave these five environments completely empty.
16397 \begin_layout Standard
16402 to put any text after the rather long-ish label, you might want to.
16403 This could be a short description of the contents of the
16408 In that case, enter your descriptive comment and hit
16412 as you normally would.
16415 \begin_layout Standard
16416 If, on the other hand, you don't want to enter any descriptive text, you'll
16417 hit another LyX quirk.
16418 LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
16419 environment until you put something in the old one.
16423 \begin_layout Itemize
16424 Start entering the text that will
16452 \begin_layout Itemize
16453 Now move to the beginning of that paragraph.
16457 \begin_layout Itemize
16466 \begin_layout Itemize
16467 Finally, change this new, empty paragraph to a
16491 \begin_layout Standard
16492 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
16496 \begin_layout Subsection
16497 Making a Presentation with
16510 \begin_layout Subsubsection
16518 \begin_layout Standard
16519 If you're expecting this section to teach you how to actually make a presentatio
16520 n, you'll be sorely disappointed.
16521 Naturally, I'll describe all of the ways the
16525 class can assist you in preparing the materials for a presentation.
16526 Filling in the contents, however, is up to you.
16531 the LyX philosophy.]
16534 \begin_layout Standard
16539 environment [in the manner described in section
16540 \begin_inset space ~
16544 \begin_inset CommandInset ref
16546 reference "sec:slideQuirk"
16550 ] tells LyX to begin a new slide [duh].
16551 The label for this environment/
16552 \begin_inset Quotes erd
16556 \begin_inset Quotes erd
16560 \begin_inset Quotes eld
16564 \begin_inset Quotes erd
16567 in cool blue, followed by the label,
16568 \begin_inset Quotes eld
16572 \begin_inset Quotes erd
16576 Any text or paragraph environments that follow this one go on the new slide.
16580 \begin_layout Standard
16581 Slides are probably the only time you'll need to forcibly end pages in LyX
16582 (this can be specified in the
16587 In fact, you'll want to, once you finish entering the contents of one slide.
16588 If you've entered more text than can physically fit on a slide, the extra
16589 overflows onto a new slide.
16590 I don't recommend doing this, however, since the overflow slide won't have
16591 any page number on it.
16592 Furthermore, it may interfere with any
16596 you've made to accompany the oversized
16603 \begin_layout Standard
16612 environments work the same way as the
16617 They both create an
16618 \begin_inset Quotes eld
16622 \begin_inset Quotes erd
16625 followed by a label [
16626 \begin_inset Quotes eld
16630 \begin_inset Quotes erd
16634 \begin_inset Quotes eld
16638 \begin_inset Quotes erd
16642 The color is a stunning magenta instead of blue, and the
16643 \begin_inset Quotes eld
16647 \begin_inset Quotes erd
16650 will look different, in style and in length.
16651 The label fonts of all three also differ from one another.
16654 \begin_layout Standard
16659 , if the contents of a
16667 exceed the physical size of a slide or sheet of paper, the extra will overflow
16669 Again, you should avoid this.
16670 It defeats the whole purpose of
16681 \begin_layout Subsubsection
16691 \begin_layout Standard
16696 is a slide that sits atop another slide.
16697 Perhaps you wish to discuss a figure on the main
16701 before displaying the text associated with it.
16702 One way to accomplish this is tape a flap of dark paper over the part of
16707 you want to display later.
16708 This method fails, however, if you wish to overlap one graph with another,
16710 You would then have to fumble while speaking to align the two separate,
16715 s to align the two graphs.
16720 environment in both cases makes life much easier.
16723 \begin_layout Standard
16728 receives the page number of its
16729 \begin_inset Quotes eld
16733 \begin_inset Quotes erd
16741 \begin_inset Quotes eld
16749 \begin_inset Quotes erd
16756 \begin_layout Plain Layout
16757 Presumably, mutliple
16762 \begin_inset Quotes eld
16770 \begin_inset Quotes erd
16774 \begin_inset Quotes eld
16782 \begin_inset Quotes erd
16786 \begin_inset Quotes eld
16794 \begin_inset Quotes erd
16798 \begin_inset space ~
16801 appended to the page number of the parent
16811 Clearly, you want the contents of both the
16819 to each fit on a single physical slide! You should probably consider an
16825 \begin_inset Quotes eld
16829 \begin_inset Quotes erd
16841 class provides a visual cue for this: the label at the start of an
16845 is shorter than that at the start of a
16850 Lastly, when you generate printable output, you'll find alignment markers
16851 in all four corners of both the
16855 page and its parent
16860 These will assist you in lining up the two physical slides.
16863 \begin_layout Standard
16864 The major problem in overlaying two slides is aligning the contents of the
16865 two transparencies.
16866 How much space should you leave for that graph on the second slide? Worse
16867 still, what if you want a graph and a sentence on second slide, but there
16868 is text on the main transparency that goes in between them? You could try
16869 and insert vertical space of the right size.
16870 The better way is to use
16881 \begin_layout Standard
16882 As their names imply,
16890 are two command-like paragraph environments that make all subsequent text
16891 invisible and visible, respectively.
16893 \begin_inset space ~
16897 \begin_inset CommandInset ref
16899 reference "sec:slideQuirk"
16903 that you don't place anything
16907 these two environments, however.
16912 , it inserts a centered, sky-blue label into the page reading
16913 \begin_inset Quotes eld
16916 <Invisible Text Follows>
16917 \begin_inset Quotes erd
16921 For paragraphs following this label, the parts of the
16929 ; it doesn't matter which] where they would be contain instead blank space.
16933 \begin_layout Standard
16938 , the corresponding centered label is
16939 \begin_inset Quotes eld
16942 <Visible Text Follows>
16943 \begin_inset Quotes erd
16947 Paragraphs following this label behave normally.
16948 Note that the beginning of a new
16960 automatically shuts off an
16965 It's therefore not necessary to use
16976 \begin_layout Standard
16977 By now, it should be obvious how to create overlay transparencies using
16978 the proper combination of
16997 \begin_layout Enumerate
17002 , including everything that will appear on it, whether on the main slide
17010 \begin_layout Enumerate
17011 Before each figure or paragraph that will appear only on the
17020 If necessary, insert a
17024 environment after the
17031 \begin_layout Enumerate
17036 immediately following the
17043 \begin_layout Enumerate
17044 Copy the contents of this
17055 \begin_layout Enumerate
17060 , change all of the
17071 \begin_layout Standard
17073 You've just made an
17080 \begin_layout Standard
17081 There's one problem with the way I've designed the LyX
17085 class: you can't make text in the middle of a paragraph invisible, nor
17086 make text in the middle of an invisible paragraph visible again.
17087 To accomplish this feat, you'll need to use some inlined LaTeX codes.
17091 \begin_layout Plain Layout
17092 The commands of interest are:
17095 \begin_layout Itemize
17100 invisible \SpecialChar \ldots{}
17104 \begin_layout Itemize
17109 visible \SpecialChar \ldots{}
17113 \begin_layout Plain Layout
17114 \SpecialChar \ldots{}
17115 and need to be marked as TeX.
17117 \begin_inset Quotes eld
17121 \begin_inset Quotes erd
17124 you wish to change goes in between the brackets [and after the
17137 If you don't know how to mark text as TeX, see the appropriate section
17150 \begin_layout Subsubsection
17160 \begin_inset CommandInset label
17162 name "sec:slideNote"
17169 \begin_layout Standard
17178 is associated with a
17179 \begin_inset Quotes eld
17183 \begin_inset Quotes erd
17195 class provides visual cues.
17200 is shorter than that of a
17204 [yet longer than that of an
17208 ] and, like the label of an
17212 is shockingly magenta.
17213 Additionally, the printed
17217 has the page number of its
17218 \begin_inset Quotes eld
17222 \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 \begin_inset Quotes eld
17262 \begin_inset Quotes erd
17266 You can have multiple
17270 s associated with a single
17282 , you'll probably want to break up long
17286 s so that they fit on a single sheet of paper.
17289 \begin_layout Standard
17294 is obvious: it contains anything additional you might want to say about
17300 It could also be used as a sheet of reminders for a particular
17305 In the case of the latter, you might want to make use of time markers.
17311 \begin_inset Quotes eld
17315 \begin_inset Quotes erd
17318 support for time markers, a
17323 So, you'll have to resort to using the LaTeX codes.
17326 \begin_layout Standard
17327 To use time markers, you'll need to specify the extra class option
17328 \begin_inset Quotes eld
17336 \begin_inset Quotes erd
17340 \begin_inset space ~
17344 \begin_inset CommandInset ref
17346 reference "sec:slidesetup"
17351 This option turns on timing marks, which will appear in the lower-left-hand
17357 To set what appears in the time marker, you use the LaTeX commands
17358 \begin_inset Quotes eld
17368 \begin_inset Quotes erd
17372 \begin_inset Quotes eld
17382 \begin_inset Quotes erd
17386 The arguments of both commands are time measured in seconds.
17388 \begin_inset Quotes eld
17398 \begin_inset Quotes erd
17401 sets the time marker to a given time.
17403 \begin_inset Quotes eld
17413 \begin_inset Quotes erd
17416 increments the time marker by the specified amount.
17417 Using time markers and
17421 s in this fashion, you can remind yourself how much time to spend on a particula
17429 \begin_layout Standard
17430 There's one last feature to describe.
17431 Clearly, you'd like to print out all of your
17439 s on transparencies while printing all of your
17456 with which it is associated.
17457 What's a person to do?
17460 \begin_layout Standard
17461 Luckily, there are two LaTeX commands that allow you to select what to print
17463 Both must be placed into the preamble of your document.
17465 \begin_inset Quotes eld
17477 \begin_inset Quotes erd
17480 will cause the output to contain only the
17489 Correspondingly, the command
17490 \begin_inset Quotes eld
17502 \begin_inset Quotes erd
17505 prevents the output of anything but
17510 I'd advise placing both commands in the preamble and initially comment
17512 You can then preview your entire presentation as you write.
17513 When you're done writing, you can then uncomment one of the two to select
17514 what you want to print.
17515 I like to uncomment
17516 \begin_inset Quotes eld
17528 \begin_inset Quotes erd
17531 , print to a file with
17532 \begin_inset Quotes eld
17540 \begin_inset Quotes erd
17543 in its name, comment it back out, then uncomment
17544 \begin_inset Quotes eld
17556 \begin_inset Quotes erd
17560 \begin_inset Quotes eld
17568 \begin_inset Quotes erd
17572 I can then send either file to a printer, loading transparencies or plain
17573 paper as appropriate.
17576 \begin_layout Standard
17577 You can also provide other arguments to the
17578 \begin_inset Quotes eld
17588 \begin_inset Quotes erd
17592 \begin_inset Quotes eld
17602 \begin_inset Quotes erd
17606 See a good LaTeX book for details.
17609 \begin_layout Subsection
17614 Class Template File
17617 \begin_layout Standard
17618 I have also provided a template file,
17619 \begin_inset Quotes eld
17627 \begin_inset Quotes erd
17635 To use it, begin your new presentation with
17640 ile\SpecialChar \menuseparator
17642 \begin_inset space ~
17646 \begin_inset space ~
17656 Your new LyX presentation file will contain an example
17677 additionally contain an example of the use of
17686 Lastly, the preamble will contain:
17689 \begin_layout LyX-Code
17690 % Uncomment to print out only slides and overlays
17693 \begin_layout LyX-Code
17697 \begin_layout LyX-Code
17703 \begin_inset Newline newline
17709 \begin_layout LyX-Code
17710 % Uncomment to print out only notes
17713 \begin_layout LyX-Code
17717 \begin_layout LyX-Code
17725 \begin_layout Standard
17726 One final thing: I created this class to support the LaTeX2e
17727 \begin_inset Quotes eld
17735 \begin_inset Quotes erd
17738 class, one of the built-in LaTeX2e classes.
17739 Neither I nor the rest of the LyX Team endorse or oppose the use of this
17740 built-in slide class.
17741 It's here if you want it or need it.
17742 There exist other LaTeX2e classes for creating presentations, such as the
17748 \begin_inset space ~
17752 \begin_inset CommandInset ref
17754 reference "sec:foiltex"
17759 \begin_inset Quotes eld
17767 \begin_inset Quotes erd
17770 package [present on some TeX distributions].
17771 The latter is not yet supported under LyX.
17775 \begin_layout Plain Layout
17776 Perhaps you can take on the task\SpecialChar \ldots{}
17782 I know nothing about these other classes.
17783 Try them out to see what sort of alternative they provide.
17786 \begin_layout Chapter
17787 LyX Features needing Extra Software
17790 \begin_layout Section
17794 \begin_layout Standard
17800 \begin_layout Subsection
17804 \begin_layout Standard
17813 \begin_layout Plain Layout
17818 is not yet available when you are using the LaTeX distribution MiKTeX.
17823 , you'll find in the
17830 \begin_inset space ~
17841 \begin_inset CommandInset href
17843 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
17850 \begin_layout Standard
17855 package is a program that was written by
17856 \begin_inset Flex Noun
17859 \begin_layout Plain Layout
17861 \begin_inset space ~
17869 in frustration because some constructs in LaTeX are sometimes non-intuitive,
17870 and easy to forget.
17871 The program runs over your LaTeX file, checks the integrity of the file,
17872 and flags some common errors.
17873 In other technical words, it is
17880 \begin_layout Standard
17881 Well, what is a syntax checker doing in LyX which is supposed to produce
17882 correct LaTeX anyways? The answer is simple: Just as
17886 not only checks the
17890 of C programs, but also does
17894 checks for type-errors,
17898 catches some common
17902 errors, in addition to the syntactical ones.
17907 is capable of detecting several common errors, such as
17910 \begin_layout Itemize
17911 Ellipsis detection:
17912 \begin_inset Newline newline
17915 Use \SpecialChar \ldots{}
17919 \begin_layout Itemize
17920 No space in front of/after parenthesis:
17921 \begin_inset Newline newline
17927 \begin_layout Itemize
17928 Enforcement of normal space after common abbreviations:
17929 \begin_inset Newline newline
17933 \begin_inset space \thinspace{}
17937 \begin_inset space \space{}
17940 is too wide spacing.
17943 \begin_layout Itemize
17944 Enforcement of end-of-sentence space when the last sentence ends with a
17946 \begin_inset Newline newline
17950 And this is wrong spacing.
17953 \begin_layout Itemize
17954 Space in front of labels and similar commands:
17955 \begin_inset Newline newline
17958 The label should stick right up to the text to avoid falling to a wrong
17961 \begin_inset CommandInset label
17971 \begin_layout Plain Layout
17972 This footnote is in danger of falling off to a wrong page
17977 The label is separated too much.
17980 \begin_layout Itemize
17981 Space in front of references, instead of hard spaces:
17982 \begin_inset Newline newline
17985 In you are in bad luck, the text will break right between the referenced
17986 text and reference number, and that's a pity.
17988 \begin_inset CommandInset ref
17990 reference "sec:chktex"
17997 \begin_layout Itemize
17999 \begin_inset Quotes eld
18003 \begin_inset Quotes erd
18007 \begin_inset Formula $\times$
18011 \begin_inset Newline newline
18014 2x2 looks cheap compared to
18015 \begin_inset Formula $2\times2$
18021 \begin_layout Standard
18022 and more \SpecialChar \ldots{}
18023 It is an invaluable tool when you are
18024 \begin_inset Quotes eld
18028 \begin_inset Quotes erd
18031 your document before printing, and you should run it right after the obligatory
18032 spelling check, and before you go fine tuning the typesetting.
18035 \begin_layout Subsection
18039 \begin_layout Standard
18040 If you have the program installed, usage is as simple as choosing
18042 Tools\SpecialChar \menuseparator
18044 \begin_inset space ~
18050 This will make LyX generate a LaTeX file of your document, start
18054 to check it, and then make LyX insert
18055 \begin_inset Quotes eld
18059 \begin_inset Quotes erd
18062 with the warnings from
18066 , if there were any.
18067 The warnings will be placed close to the point of the mistake, and you
18068 can quickly find them by using the
18070 Navigate\SpecialChar \menuseparator
18073 menu item, or the shortcut key
18082 Open the error boxes by clicking on them with the mouse, or use the shortcut
18091 bindings, or the corresponding
18100 Read the warning and correct the mistake, if it is a mistake.
18101 If you have trouble understanding what the warning is about, you can safely
18103 Remember that there is a hidden layer between the document on screen and
18104 the technical details in invoking
18108 , and this gap can make some warnings seem arcane or just right down plain
18112 \begin_layout Standard
18113 This document is an excellent testing bed for the feature, and it should
18114 provide quite a few warnings for you to fiddle with.
18115 Since computers are only so smart, expect most of the warnings to be false
18119 \begin_layout Subsection
18120 How to fine tune it
18123 \begin_layout Standard
18124 Sometimes, you'll find that
18128 makes more noise than suits your mood.
18129 Then you can choose not to use it, wait until your mood changes, or try
18134 to get better along with you.
18137 \begin_layout Standard
18146 very configurable and extensible, you shouldn't expect to solve all problems
18152 Since LyX has to generate a somewhat special LaTeX file to be able to match
18153 the line numbers from the
18161 \begin_layout Plain Layout
18162 You can inspect the specific output from
18168 Edit\SpecialChar \menuseparator
18170 \begin_inset space ~
18174 \begin_inset space ~
18188 to the internal document structure, some of the warnings will not seen
18189 to appear correctly.
18190 There are two things you can do about this:
18193 \begin_layout Itemize
18198 invocation command line in
18214 installation configuration file (usually with the file
18219 See below to learn what warnings can be enabled and disabled on the command
18224 \begin_layout Itemize
18225 Export your document as a raw LaTeX file using
18227 File\SpecialChar \menuseparator
18228 Export\SpecialChar \menuseparator
18236 Invoked in this way, it can be a hassle to find the corresponding place
18237 in the document inside LyX, but with a little patience, you should be able
18241 \begin_layout Standard
18242 Here follows the warning messages that can be enabled and disabled in
18251 to disable a warning, and
18255 to enable a warning.
18256 The emphasized entries are disabled by default, because the default is
18259 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
18264 \begin_layout Standard
18265 Notice that you should only use the options that enable and disable warnings,
18266 because LyX relies on some of the other command line parameters to be set
18267 in a specific way to have a chance to communicate with
18274 \begin_layout Enumerate
18278 Command terminated with space.
18281 \begin_layout Enumerate
18284 Non-breaking space (
18285 \begin_inset Quotes eld
18293 \begin_inset Quotes erd
18296 ) should have been used.
18299 \begin_layout Enumerate
18303 You should enclose the previous parenthesis with
18304 \begin_inset Quotes eld
18312 \begin_inset Quotes erd
18318 \begin_layout Enumerate
18321 Italic correction (
18322 \begin_inset Quotes eld
18332 \begin_inset Quotes erd
18335 ) found in non-italic buffer.
18338 \begin_layout Enumerate
18341 Italic correction (
18342 \begin_inset Quotes eld
18352 \begin_inset Quotes erd
18355 ) found more than once.
18358 \begin_layout Enumerate
18362 No italic correction (
18363 \begin_inset Quotes eld
18373 \begin_inset Quotes erd
18379 \begin_layout Enumerate
18383 \begin_inset Quotes eld
18391 \begin_inset Quotes erd
18395 \begin_inset Quotes eld
18403 \begin_inset Quotes erd
18409 \begin_layout Enumerate
18412 Wrong length of dash may have been used.
18415 \begin_layout Enumerate
18419 \begin_inset Quotes eld
18427 \begin_inset Quotes erd
18431 \begin_inset Quotes eld
18439 \begin_inset Quotes erd
18445 \begin_layout Enumerate
18449 \begin_inset Quotes eld
18457 \begin_inset Quotes erd
18463 \begin_layout Enumerate
18467 \begin_inset Quotes eld
18475 \begin_inset Quotes erd
18478 to achieve an ellipsis.
18481 \begin_layout Enumerate
18484 Inter-word spacing (
18485 \begin_inset Quotes eld
18495 \begin_inset Quotes eld
18498 ) should perhaps be used.
18501 \begin_layout Enumerate
18504 Inter-sentence spacing (
18505 \begin_inset Quotes eld
18515 \begin_inset Quotes erd
18518 ) should perhaps be used.
18521 \begin_layout Enumerate
18524 Could not find argument for command.
18527 \begin_layout Enumerate
18531 \begin_inset Quotes eld
18539 \begin_inset Quotes erd
18545 \begin_layout Enumerate
18548 Math mode still on at end of LaTeX file.
18551 \begin_layout Enumerate
18555 \begin_inset Quotes eld
18563 \begin_inset Quotes erd
18566 doesn't match the number of
18567 \begin_inset Quotes eld
18575 \begin_inset Quotes erd
18581 \begin_layout Enumerate
18584 You should use either
18587 \begin_inset Quotes eld
18595 \begin_inset Quotes erd
18600 as an alternative to
18601 \begin_inset Quotes eld
18609 \begin_inset Quotes erd
18615 \begin_layout Enumerate
18622 " (ASCII 39) instead of "
18629 \begin_layout Enumerate
18632 User-specified pattern found.
18635 \begin_layout Enumerate
18638 This command might not be intended.
18641 \begin_layout Enumerate
18648 \begin_layout Enumerate
18666 \begin_layout Enumerate
18669 Delete this space to maintain correct page references.
18672 \begin_layout Enumerate
18676 You might wish to put this between a pair of
18677 \begin_inset Quotes eld
18685 \begin_inset Quotes erd
18691 \begin_layout Enumerate
18694 You ought to remove spaces in front of punctuation.
18697 \begin_layout Enumerate
18700 Could not execute LaTeX command.
18703 \begin_layout Enumerate
18712 in front of small punctuation.
18715 \begin_layout Enumerate
18723 may look prettier here.
18726 \begin_layout Enumerate
18730 Multiple spaces detected in output.
18733 \begin_layout Enumerate
18736 This text may be ignored.
18739 \begin_layout Enumerate
18745 \begin_inset Quotes eld
18750 to begin quotation, not
18757 \begin_layout Enumerate
18764 to end quotation, not
18767 \begin_inset Quotes eld
18775 \begin_layout Enumerate
18781 \begin_layout Enumerate
18784 You should perhaps use
18785 \begin_inset Quotes eld
18793 \begin_inset Quotes erd
18799 \begin_layout Enumerate
18802 You should put a space in front of/after parenthesis.
18805 \begin_layout Enumerate
18808 You should avoid spaces in front of/after parenthesis.
18811 \begin_layout Enumerate
18815 You should not use punctuation in front of/after quotes.
18818 \begin_layout Enumerate
18821 Double space found.
18824 \begin_layout Enumerate
18827 You should put punctuation outside inner/inside display math mode.
18830 \begin_layout Enumerate
18833 You ought to not use primitive TeX in LaTeX code.
18836 \begin_layout Enumerate
18839 You should remove spaces in front of
18840 \begin_inset Quotes eld
18848 \begin_inset Quotes erd
18854 \begin_layout Enumerate
18857 \begin_inset Quotes eld
18865 \begin_inset Quotes erd
18868 is normally not followed by
18869 \begin_inset Quotes eld
18877 \begin_inset Quotes erd
18883 \begin_layout Standard
18884 In later versions of LyX, we hope to provide a more complete interface to
18885 this tool (and it's smaller cousin
18889 ) to exploit the full power of it.
18890 But it's not exactly useless as it is now: go try it on one of your existing
18891 documents of a certain length and be surprised.
18894 \begin_layout Section
18895 Version Control in LyX
18898 \begin_layout Standard
18901 Lars Gullik Bjønnes
18908 \begin_layout Subsection
18912 \begin_layout Standard
18913 A friend of mine wanted to try LyX for a group project.
18914 When he didn't find support for version control or file locking, he dropped
18916 This angered me a bit, so I thought that I should at least make support
18917 for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
18918 This has been done.
18919 LyX now supports some of the most basic RCS/CVS/SVN commands.
18920 If you need something a bit more sophisticated you will have to do that
18921 manually in a terminal.
18924 \begin_layout Standard
18925 Also note that CVS support is not as good as subversion support so we advice
18927 Good place to start with Subversion is SVN Book
18931 \begin_layout Plain Layout
18932 \begin_inset CommandInset href
18934 target "http://svnbook.red-bean.com/"
18944 In case of RCS you should read
18945 \begin_inset Quotes eld
18949 \begin_inset Quotes erd
18952 (a man file, read it with
18957 This file describes all the basic features of RCS.
18958 You should especially notice the comment about a RCS directory, and the
18959 notion of a master RCS file (the file ending in
18966 \begin_layout Standard
18967 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
18968 package—no guarantees are made for older versions.
18969 Most of the log messages are not currently displayed after operations —
18970 you can check them in Messages pane if unsure.
18973 \begin_layout Standard
18974 For introducing your own external commands consult vc-command in the manual
18978 \begin_layout Subsection
18979 RCS commands in LyX
18982 \begin_layout Standard
18983 The following sections describe the RCS commands supported by LyX.
18984 You can find them in the
18986 File\SpecialChar \menuseparator
18988 \begin_inset space ~
18994 LyX was tested against RCS 5.7.
18997 \begin_layout Subsubsection
19003 \begin_layout Standard
19004 If your document is not under revision control, this is the only item shown
19006 And if it is under revision control, the
19010 item is not visible.
19014 \begin_layout Standard
19015 This command registers your document with RCS (unless you are under the
19016 directory managed by CVS)\SpecialChar \@.
19017 You are asked interactively to supply an initial
19018 description of the document.
19019 The document is now set in Read-Only mode and you have to
19022 \begin_inset space ~
19026 \begin_inset space ~
19030 \begin_inset space ~
19035 , before making any changes to it.
19036 A document under revision control has a
19037 \begin_inset Quotes eld
19040 [RCS:<version> <locker>]
19041 \begin_inset Quotes erd
19044 item tagged to the filename in the minibuffer.
19047 \begin_layout Standard
19048 RCS command that is run:
19050 ci -q -u -i -t-"<initial description>" <file-name>
19053 \begin_layout Standard
19058 to understand the switches.
19062 \begin_layout Subsubsection
19068 \begin_layout Standard
19069 When you are finished editing a file, you check in your changes.
19070 When you do this, you are asked for a description of the changes.
19071 This is stored in the history log.
19072 The version number is bumped, your changes are applied to the master RCS
19073 file, the document is unlocked and set to Read-Only mode.
19077 \begin_layout Standard
19080 ci -q -u -m"<description>" <file-name>
19083 \begin_layout Subsubsection
19089 \begin_layout Standard
19090 By doing this you lock the document so that only you can edit it.
19091 This will also make the document Read-Write only for you.
19092 You will usually continue editing for a while and when you are finished
19093 you check in your changes.
19094 The status line is changed to reflect that you have locked the file.
19098 \begin_layout Standard
19101 co -q -l <file-name>
19104 \begin_layout Subsubsection
19107 Revert To Repository Version
19110 \begin_layout Standard
19111 This will discard all changes made to the document since the last check
19113 You get a warning before changes are discarded.
19116 \begin_layout Standard
19119 co -f -u<version> <file-name>
19122 \begin_layout Subsubsection
19128 \begin_layout Standard
19129 This makes as if the last check in never happened.
19130 No changes are made to the document loaded into LyX, but the last version
19131 is removed from the master RCS file.
19135 \begin_layout Standard
19138 rcs -o<version> <file-name>
19141 \begin_layout Subsubsection
19147 \begin_layout Standard
19148 This shows the complete history of the RCS document.
19153 is shown in a browser.
19161 \begin_layout Subsubsection
19165 \begin_layout Standard
19166 LyX supports RCS version number, author name, date and time of last commit.
19167 All those are extracted from
19169 rlog -r <file-name>
19172 For other details see
19173 \begin_inset CommandInset ref
19175 reference "sub:VCS-Revision-Information"
19182 \begin_layout Subsection
19183 CVS commands in LyX
19186 \begin_layout Standard
19187 A subset of CVS operations is supported by LyX.
19188 You can find the commands in the
19190 File\SpecialChar \menuseparator
19192 \begin_inset space ~
19198 The version control system SVN is more powerful, so please use it instead
19199 of CVS if possible.
19202 \begin_layout Subsubsection
19208 \begin_layout Standard
19209 If you start from scratch with CVS you have to create your repository and
19210 checkout the working copy with external tools.
19211 If you're using a client-server setup you may need to login before doing
19212 the first repository checkout.
19215 \begin_layout Standard
19216 If your documents are under revision control and others are using the same
19217 repository problems arise when different changes to the same document at
19218 the same location happen.
19219 Standard CVS repositories doesn't operate with a file locking mechanism.
19220 This may be surprising, but conflicts only occur if people disagree on
19221 the proper content of the same part of a document.
19222 So, if co-workers are used to communicate regularly, these conflicts occur
19224 If they don't communicate they have a fundamental problem anyway.
19225 Nevertheless some people like to work with so called
19226 \begin_inset Quotes eld
19230 \begin_inset Quotes erd
19234 If they do so the working copy of all files is readonly when checked out
19235 first and the user starts editing after using a special command to make
19236 the working copy writable.
19237 When the changes are checked in the working copy returns to readonly state.
19238 With LyX one has to edit the
19239 \begin_inset Flex Code
19242 \begin_layout Plain Layout
19248 file and add the line
19249 \begin_inset Flex Code
19252 \begin_layout Plain Layout
19258 to work with reserved checkouts.
19259 The benefit is the possibility to see who is using a writable copy of some
19261 It's not guaranteed only one user makes a copy writable.
19264 \begin_layout Standard
19265 LyX tries to guess if you're using reserved or non-reserved checkouts.
19266 If your working copy is readonly or it is writable and an additional copy
19267 of your document exists in the CVS/Base sub-directory a reserved otherwise
19268 a non-reserved checkout is assumed.
19269 When a reserved checkout is detected you have to use
19270 \begin_inset Flex MenuItem
19273 \begin_layout Plain Layout
19279 to make your working copy writable if it's readonly.
19281 \begin_inset Flex MenuItem
19284 \begin_layout Plain Layout
19290 operation is possible and that makes your working copy readonly again after
19291 transferring your changes to the repository.
19294 \begin_layout Standard
19295 More information about CVS can be found here
19296 \begin_inset Flex URL
19299 \begin_layout Plain Layout
19301 http://www.nongnu.org/cvs
19307 \begin_inset Flex URL
19310 \begin_layout Plain Layout
19312 http://ximbiot.com/cvs
19320 \begin_layout Standard
19325 to understand the sub-commands and the switches mentioned below.
19328 \begin_layout Subsubsection
19334 \begin_layout Standard
19335 If your document is not under revision control, this is the only item shown
19337 And if it is under revision control, the
19344 item is not visible.
19348 \begin_layout Standard
19349 This command registers in CVS your document
19350 \begin_inset Flex Strong
19353 \begin_layout Plain Layout
19361 in case you have already the documents directory under CVS control (in
19367 This means you have to create or checkout the archive by yourself using
19369 (In case you forget that step LyX registers the document with RCS.)
19372 \begin_layout Standard
19373 Then you are asked interactively to supply an initial description of the
19375 Don't forget that registered file is not yet checked in.
19378 \begin_layout Standard
19379 CVS command that is run:
19381 cvs -q add -m"<entered message>" "<file-name>"
19384 \begin_layout Standard
19389 above and for all other CVS commands is an abbreviation for
19390 \begin_inset Quotes eld
19393 change the current working directory to file location and use the file name
19394 without path component as argument
19395 \begin_inset Quotes erd
19401 \begin_layout Subsubsection
19407 \begin_layout Standard
19408 When you are finished editing a file, you commit your changes.
19409 When you do this and you had changed the document, you are asked for a
19410 description of the changes.
19411 After that changes are written to the repository.
19412 In case you didn't change the document and a reserved checkout is detected
19413 the reservation made on
19414 \begin_inset Flex MenuItem
19417 \begin_layout Plain Layout
19426 \begin_layout Labeling
19427 \labelwidthstring 00.00.0000
19429 \begin_inset space ~
19433 \begin_inset space ~
19437 \begin_inset Newline newline
19441 \begin_inset Flex Code
19444 \begin_layout Plain Layout
19447 -q commit -m"<description>" "<file-name>"
19453 \begin_inset Newline newline
19457 \begin_inset Flex Code
19460 \begin_layout Plain Layout
19471 \begin_layout Subsubsection
19477 \begin_layout Standard
19478 When you are sharing a repository with others, you may have to incorporate
19479 their changes into your working copy.
19482 \begin_layout Standard
19485 cvs -q update "<file-name>"
19488 \begin_layout Standard
19489 If a readonly checkout is detected the working copy is made writable and
19493 \begin_layout Standard
19496 cvs -q edit "<file-name>"
19499 \begin_layout Subsubsection
19502 Revert To Repository Version
19505 \begin_layout Standard
19506 This will discard all changes made to the document since the last check
19508 You get a warning before changes are discarded.
19509 Firstly the file is deleted, secondly CVS update command is run.
19512 \begin_layout Standard
19515 cvs -q update "<file-name>"
19518 \begin_layout Standard
19519 If a reserved checkout is detected and the working copy has no changes only
19520 the reservation is undone.
19523 \begin_layout Standard
19526 cvs -q unedit "<file-name>"
19529 \begin_layout Subsubsection
19530 Update of the local directory checkout from repository
19533 \begin_layout Standard
19534 Once your documents gets more complex, containing sub-documents and pictures,
19536 \begin_inset Flex Code
19539 \begin_layout Plain Layout
19545 files and so on using version control becomes more complicated.
19546 LyX supports updating the whole tree in which resides the document.
19547 This become especially useful once you cooperate with people which neither
19548 have detailed knowledge about CVS usage nor they have ambition to commit
19549 additional material to the repository.
19550 You have to organize the files structure so that all external files are
19551 in the same directory or subdirectories of the document.
19552 It's good practice anyway to store multipart documents in an extra directory.
19555 \begin_layout Standard
19557 \begin_inset Flex Code
19560 \begin_layout Plain Layout
19561 Update local directory from repository
19566 command updates the whole directory.
19567 If local changes are detected user is warned before update starts.
19568 In case of merge conflicts both versions of the conflicting document parts
19569 are placed in the final document.
19570 You have to review and correct the result of the merge.
19571 You'll find the conflicts enclosed in pairs of
19572 \begin_inset Flex Code
19575 \begin_layout Plain Layout
19582 \begin_inset Flex Code
19585 \begin_layout Plain Layout
19592 \begin_inset Flex Code
19595 \begin_layout Plain Layout
19602 The first part is your version as before the update operation with the
19603 document name prepended.
19604 The second one is the repository version with the version number after
19606 \begin_inset Flex Code
19609 \begin_layout Plain Layout
19618 \begin_layout Labeling
19619 \labelwidthstring 00.00.0000
19621 \begin_inset space ~
19625 \begin_inset space ~
19629 \begin_inset Newline newline
19633 \begin_inset Flex Code
19636 \begin_layout Plain Layout
19644 (Ask if changes are detected.)
19645 \begin_inset Newline newline
19649 \begin_inset Flex Code
19652 \begin_layout Plain Layout
19653 cd $path; cvs -q update
19663 \begin_layout Standard
19665 \begin_inset Flex Code
19668 \begin_layout Plain Layout
19674 stands for the path to the document.
19677 \begin_layout Subsubsection
19683 \begin_layout Standard
19684 This shows the complete history of the CVS document.
19687 cvs log "<file-name>"
19689 is shown in a browser.
19692 \begin_layout Subsection
19693 SVN commands in LyX
19696 \begin_layout Standard
19697 SVN is now partially supported by LyX.
19698 You can find the commands in the
19700 File\SpecialChar \menuseparator
19702 \begin_inset space ~
19708 Please note that if you use password protected access to repository via
19709 ssh, you will be asked in terminal window.
19710 LyX was tested against SVN 1.5 and 1.6
19714 \begin_layout Plain Layout
19715 Most of the commands will work with 1.4 too, see
19716 \begin_inset CommandInset ref
19718 reference "sub:SVN-Repo-Update"
19730 \begin_layout Subsubsection
19736 \begin_layout Standard
19737 If your document is not under revision control, this is the only item shown
19739 And if it is under revision control, the
19746 item is not visible.
19750 \begin_layout Standard
19751 This command registers in SVN your document ONLY in case you have already
19752 the documents directory under SVN control (in particular
19757 This means you have to checkout the archive by yourself.
19761 \begin_layout Standard
19762 Then you are asked interactively to supply an initial description of the
19764 Don't forget that registered file is not yet commited.
19767 \begin_layout Standard
19768 SVN command that is run:
19771 \begin_inset Quotes eld
19775 \begin_inset Quotes erd
19781 \begin_layout Standard
19786 to understand the switches.
19790 \begin_layout Subsubsection
19796 \begin_layout Standard
19797 When you are finished editing a file, you commit your changes.
19798 When you do this, you are asked for a description of the changes.
19799 After that changes are commited.
19802 \begin_layout Standard
19807 \begin_layout Plain Layout
19808 In case locking is not enabled.
19810 \begin_inset CommandInset ref
19812 reference "subsec:SVN-File-Locking"
19823 svn commit -q -m"<description>" <file-name>
19826 \begin_layout Subsubsection
19832 \begin_layout Standard
19833 Updates the changes of this file from the repository.
19834 Be sure you understand SVN merging and conflicts resolving before using
19835 this function, because all conflicts has to be resolved manually by you!
19838 \begin_layout Standard
19843 \begin_layout Plain Layout
19851 svn update --non-interactive
19852 \begin_inset Quotes eld
19856 \begin_inset Quotes erd
19862 \begin_layout Subsubsection
19865 Revert To Repository Version
19868 \begin_layout Standard
19869 This will discard all changes made to the document since the last check
19871 You get a warning before changes are discarded.
19875 \begin_layout Standard
19879 \begin_inset Quotes eld
19883 \begin_inset Quotes erd
19889 \begin_layout Subsubsection
19890 \begin_inset CommandInset label
19892 name "sub:SVN-Repo-Update"
19896 Update of the local directory checkout from repository
19900 \begin_layout Plain Layout
19901 Note that this command will work only with subversion
19902 \begin_inset Formula $\geqq1.5$
19913 \begin_layout Standard
19914 All the commands above have one shortcomming - they deal with the current
19916 Once your document contains pictures, includes external
19917 \begin_inset Flex Code
19920 \begin_layout Plain Layout
19926 files and so on administration becomes more complicated.
19927 LyX now supports updating the whole tree in which resides the document
19931 \begin_layout Plain Layout
19932 One need to organize the files structure so that all external files are
19933 in the same directory or subdirectories of the document.
19940 This become especially useful once you cooperate with people which neither
19941 know about subversion management nor they have ambition to commit additional
19942 material to the repository.
19946 \begin_layout Standard
19947 \begin_inset Flex Code
19950 \begin_layout Plain Layout
19951 Update local directory from repository
19956 command updates the whole directory and in case of merge conflicts local
19957 version of the files are left, so no unintended data loss occurs.
19958 If local changes are detected user is warned before update starts.
19961 \begin_layout Labeling
19962 \labelwidthstring 00.00.0000
19964 \begin_inset space ~
19968 \begin_inset space ~
19972 \begin_inset Newline newline
19976 \begin_inset Flex Code
19979 \begin_layout Plain Layout
19985 (Ask if changes are detected.)
19986 \begin_inset Newline newline
19990 \begin_inset Flex Code
19993 \begin_layout Plain Layout
19994 svn update --accept mine-full $path
20002 \begin_layout Standard
20004 \begin_inset Flex Code
20007 \begin_layout Plain Layout
20013 stands for the path to the document.
20016 \begin_layout Subsubsection
20022 \begin_layout Standard
20023 This shows the complete history of the SVN document.
20027 \begin_inset Quotes eld
20031 \begin_inset Quotes erd
20036 is shown in a browser.
20039 \begin_layout Subsubsection
20041 \begin_inset CommandInset label
20043 name "subsec:SVN-File-Locking"
20050 \begin_layout Standard
20051 The file exchange through various revision control systems brings the problem
20052 of merge conflicts in case two different users try to edit the same (parts
20054 When such a conflict happens it needs manual resolving and one reasonable
20055 alternative is to provide some kind of locking mechanism, which guarantees
20056 that only one user is allowed to edit file at the given time.
20059 \begin_layout Standard
20060 SVN has two such mechanisms to provide mutual exclusivity for file access
20061 - locks and automatic setting of write permissions (see sec.
20063 \begin_inset CommandInset ref
20065 reference "subsec:Automatical-Locking-Property"
20070 \begin_inset Flex Code
20073 \begin_layout Plain Layout
20083 \begin_layout Plain Layout
20084 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
20090 If this property is detected for a given document LyX starts to use SVN
20091 locks for document editing automatically and the whole check-in/out mechanism
20092 switches to the same regimen as for RCS.
20093 This in particular means there are two different modes of file use in LyX:
20096 \begin_layout Itemize
20098 The loaded file is in the read-only mode.
20099 For editing on needs to check-out.
20104 consists of updating from the repository and gaining write lock.
20105 If the lock is not possible to obtain, we remain in unlocked state.
20108 \begin_layout Itemize
20110 The loaded file is in the 'normal' edit mode.
20111 No other user is allowed to edit the file.
20116 consists of commiting changes and releasing write-lock.
20117 If no changes have been made to the document, no commit will be produced
20121 \begin_layout Plain Layout
20122 Don't be puzzled by the fact that you will be asked for commit message anyway.
20127 and only the write-lock will be released.
20130 \begin_layout Standard
20134 \begin_layout Labeling
20135 \labelwidthstring 00.00.0000
20138 svn commit -q -m"<description>" "<file-name>"
20139 \begin_inset Newline newline
20142 svn unlock "<file-name>"
20145 \begin_layout Labeling
20146 \labelwidthstring 00.00.0000
20149 svn update "<file-name>"
20150 \begin_inset Newline newline
20153 svn lock "<file-name>"
20156 \begin_layout Subsubsection
20159 \begin_inset CommandInset label
20161 name "subsec:Automatical-Locking-Property"
20167 Automatic Locking Property
20170 \begin_layout Standard
20171 The above mentioned automatic setting of write permissions of the .lyx file
20177 ile\SpecialChar \menuseparator
20183 \begin_inset space ~
20186 Control\SpecialChar \menuseparator
20191 oggle locking property
20194 This command is active only when the file is not locked on the svn server
20196 you need to check-out before proceeding).
20199 \begin_layout Labeling
20200 \labelwidthstring 00.00.0000
20202 \begin_inset space ~
20208 \begin_layout Labeling
20209 \labelwidthstring 00.00.0000
20212 svn propset svn:needs-lock ON "<file-name>"
20215 \begin_layout Labeling
20216 \labelwidthstring 00.00.0000
20219 svn propdel svn:needs-lock "<file-name>"
20222 \begin_layout Subsubsection
20223 \begin_inset CommandInset label
20225 name "sub:VCS-Revision-Information"
20229 Revision Information in Documents
20232 \begin_layout Standard
20233 There are more possibilities how to activate revision information in our
20237 \begin_layout Itemize
20238 LyX supports directly:
20242 \begin_layout Itemize
20243 tree revision information (
20244 \begin_inset Flex Code
20247 \begin_layout Plain Layout
20254 The result is the output of the
20255 \begin_inset Flex Code
20258 \begin_layout Plain Layout
20264 command, the following table gives you an idea, how to read the results.
20267 \begin_layout Standard
20269 \begin_inset Tabular
20270 <lyxtabular version="3" rows="6" columns="2">
20271 <features tabularvalignment="middle">
20272 <column alignment="center" valignment="top" width="0">
20273 <column alignment="center" valignment="top" width="0">
20275 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
20278 \begin_layout Plain Layout
20284 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
20287 \begin_layout Plain Layout
20295 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20298 \begin_layout Plain Layout
20304 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20307 \begin_layout Plain Layout
20308 mixed revision working copy
20315 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20318 \begin_layout Plain Layout
20324 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20327 \begin_layout Plain Layout
20328 modified working copy
20335 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20338 \begin_layout Plain Layout
20344 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20347 \begin_layout Plain Layout
20348 switched working copy
20355 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
20358 \begin_layout Plain Layout
20364 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
20367 \begin_layout Plain Layout
20368 partial working copy, from a sparse checkout
20375 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
20378 \begin_layout Plain Layout
20384 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
20387 \begin_layout Plain Layout
20388 mixed revision, modified, switched working copy
20401 \begin_layout Itemize
20402 file revision information.
20403 The result comes from parsing the output of
20404 \begin_inset Flex Code
20407 \begin_layout Plain Layout
20409 \begin_inset space ~
20413 \begin_inset space ~
20417 \begin_inset space ~
20426 Supported flags are:
20430 \begin_layout Itemize
20431 version number of the last commit (
20432 \begin_inset Flex Code
20435 \begin_layout Plain Layout
20444 \begin_layout Itemize
20445 author of the last commit (
20446 \begin_inset Flex Code
20449 \begin_layout Plain Layout
20458 \begin_layout Itemize
20459 date of the last commit (
20460 \begin_inset Flex Code
20463 \begin_layout Plain Layout
20472 \begin_layout Itemize
20473 time of the last commit (
20474 \begin_inset Flex Code
20477 \begin_layout Plain Layout
20487 \begin_layout Standard
20488 You can obtain this info via InsetInfo (e.g.
20490 \begin_inset Flex Code
20493 \begin_layout Plain Layout
20494 info-insert buffer vcs-date
20500 The information will be available only when you have the file stored under
20501 svn managment (i.e.
20503 \begin_inset Flex Code
20506 \begin_layout Plain Layout
20512 directory is available with your document).
20516 \begin_layout Itemize
20517 Another---a hacking one---possibility is to use svn keywords
20521 \begin_layout Plain Layout
20522 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
20528 In short -- you set file keywords property (e.g.
20531 svn propset svn:keywords 'Rev' file.lyx
20533 ) and then paste keyword TeX code
20537 \begin_layout Plain Layout
20538 This is an easy way how to ensure that LyX won't break the line in the middle
20544 tag in your document (e.g.
20549 \begin_layout Plain Layout
20557 This way svn client will automatically substitute revision number (e.g.
20562 \begin_layout Plain Layout
20569 ) after each update and commit.
20570 There are more problems with this approach.
20571 Firstly, the '$' character is used in TeX world for math equations, so
20572 any occurence of math formula
20573 \begin_inset Formula $Rev$
20577 \begin_inset Formula $Rev:59$
20580 in your LyX document.
20581 Similarly for other keywords like Id, Date, Author, etc.
20582 Secondly svn output is dependent on your locales, so its very easy that
20583 svn would produce some problematic strings once Date is used.
20584 Thirdly you get the whole 'Rev: 59' string in your document instead of
20586 Until subversion implements user's custom keywords it will be hard to use
20587 this approach reliably or let LyX to support it directly.
20590 \begin_layout Subsection
20591 SVN and Windows Environment
20594 \begin_layout Quote
20595 My inclination is to say that if the user cannot figure out the command
20596 line operations on their own fairly quickly, they would be well advised
20597 to use TortoiseSVN.
20603 \begin_layout Subsubsection
20607 \begin_layout Standard
20608 In addition to installing LyX, and having access to a Subversion repository,
20609 the user will need to install the Subversion client program.
20610 A Windows installer for the client program is available from
20611 \begin_inset CommandInset href
20614 target "http://www.collab.net/nonav/downloads/subversion/"
20619 The user may also want to install
20620 \begin_inset CommandInset href
20623 target "http://tortoisesvn.tigris.org/"
20627 , which integrates Subversion operations into the context (rightclick) menu
20628 of Windows Explorer.
20629 Operations done outside LyX will typically be more convenient using the
20630 Explorer context menu.
20631 Note that TortoiseSVN is not a replacement for the client program, which
20632 is what LyX itself will use.
20635 \begin_layout Subsubsection
20636 Bringing a document under Subversion control
20639 \begin_layout Standard
20640 Before a LyX document can be brought under version control in Subversion,
20641 its parent directory needs to be under version control.
20642 If the document is being added to a project already in the repository,
20643 this is accomplished by checking the project out to the directory where
20644 the new document will be placed.
20645 If the project itself is not yet under version control (for instance, if
20646 this document starts a new project), the directory must be imported into
20648 This is done outside LyX.
20649 Both import and checkout are easily accomplished from the Explorer context
20650 menu using TortoiseSVN, or alternatively can be done using the command
20651 line client at a DOS prompt.
20652 The procedure for importing the project using TortoiseSVN is described
20653 below, assuming an existing repository and a new project being started
20661 For information on using the Subversion client program, run
20668 \begin_layout Enumerate
20675 in Windows Explorer, right click it, and select
20677 TortoiseSVN > Repo-browser
20680 If necessary, adjust the URL for the repository, then click OK.
20683 \begin_layout Enumerate
20684 Right click the level of the repository under which you want to place the
20685 new project folder (typically the top level) and click
20687 Create folder\SpecialChar \ldots{}
20690 Supply a name for the project folder and click OK.
20691 Add a message for the log file if desired, then click OK again.
20692 The new project folder should appear in the repository.
20693 Finally, click OK again to exit the repository browser.
20696 \begin_layout Enumerate
20697 Once again right click
20703 , this time selecting SVN Checkout\SpecialChar \ldots{}
20704 Select the URL of the project folder
20705 you just created in the repository, and set the checkout directory to
20713 You will be warned about a non-empty folder; click OK to proceed.
20714 You should now have a
20725 \begin_layout Enumerate
20726 Create or open your document in LyX and click
20731 ile\SpecialChar \menuseparator
20737 \begin_inset space ~
20740 Control\SpecialChar \menuseparator
20748 Add a log message and click OK to commit the document to version control.
20751 \begin_layout Standard
20752 From this point onward, you should have full functionality in the
20757 ile\SpecialChar \menuseparator
20763 \begin_inset space ~
20769 You also have the option of checking the document in and out, viewing its
20771 using the TortoiseSVN context menu in Windows Explorer or the Subversion
20772 client program from a command prompt.
20775 \begin_layout Subsubsection
20776 SSH tunnel used with SVN under Windows
20779 \begin_layout Standard
20780 Compared with Linux setting up svn client to communicate over ssh under
20781 Windows is a rather troublesome task.
20782 We will at least offer some hints how to setup the client side but prior
20783 knowledge about ssh and the Windows command line is needed, also be prepared
20784 for a great deal of frustration\SpecialChar \ldots{}
20788 \begin_layout Enumerate
20789 Get a svn client for windows, as described in the previous sections.
20790 When it is a fresh install run some svn command (e.g.
20792 \begin_inset Flex Code
20795 \begin_layout Plain Layout
20801 ) to create config files, which you will need to change later on.
20804 \begin_layout Enumerate
20805 Choose a ssh client for Windows.
20806 There are several possibilities, we will use the one from Putty tools
20810 \begin_layout Plain Layout
20811 \begin_inset Flex URL
20814 \begin_layout Plain Layout
20816 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
20827 You will need to set the connection up so that the client doesn't ask for
20828 any password from you.
20829 To keep things easy we will use only keys without any additional password
20834 \begin_layout Enumerate
20836 \begin_inset Flex Code
20839 \begin_layout Plain Layout
20846 Save your private .ppk key file and put the public one on the server side.
20847 If the SVN server runs on Linux, note that the format of the public key
20848 is not compatible with Linux openssh and you will need to direcly copy-paste
20851 Public key for pasting into OpenSSH authorized_keys file
20853 :” edit field into the server's
20854 \begin_inset Flex Code
20857 \begin_layout Plain Layout
20858 ~/.ssh/authorized_keys
20864 \begin_inset Flex Code
20867 \begin_layout Plain Layout
20876 \begin_layout Enumerate
20878 \begin_inset Flex Code
20881 \begin_layout Plain Layout
20888 In the SVN config file
20892 \begin_layout Plain Layout
20893 Exact path depends on Windows version, usually somewhere around
20894 \begin_inset Flex Code
20897 \begin_layout Plain Layout
20900 Documents and Settings
20914 \begin_inset Flex Code
20917 \begin_layout Plain Layout
20932 , section [tunnels], setup ssh command, e.g.
20934 \begin_inset Flex Code
20937 \begin_layout Plain Layout
20938 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
20947 \begin_layout Plain Layout
20948 It will usually take a lot of time to get exact command right and it depends
20950 For example do not have some remote server saved as a default session in
20952 If things fail, try to connect via plink without SVN first.
20961 \begin_layout Enumerate
20962 Checkout the SVN archive, e.g.
20964 \begin_inset Flex Code
20967 \begin_layout Plain Layout
20968 svn co svn+ssh://user@server/repository_path
20976 \begin_layout Subsubsection
20977 End-of-Line Conversions
20980 \begin_layout Standard
20981 When the collsraborators are mixing Linux and Windows environments, LyX
20982 will use different line endings inside the .lyx files.
20983 This is not a problem as far as LyX functionality is concerned, but the
20984 commit diffs will be huge and merge-conflicts prone.
20985 Fortunately SVN itself knows
20989 \begin_layout Plain Layout
20990 \begin_inset Flex URL
20993 \begin_layout Plain Layout
20995 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
21005 how to deal with CR/LF problems when switching .lyx files to the
21006 \begin_inset Flex Code
21009 \begin_layout Plain Layout
21019 \begin_layout Plain Layout
21021 \begin_inset Flex Code
21024 \begin_layout Plain Layout
21025 svn propset svn:eol-style native FILE_NAME
21038 \begin_layout Subsection
21042 \begin_layout Standard
21043 With the recent addition of the vc-command function LyX power users are
21044 allowed to create their own commands for revision control.
21047 \begin_layout Standard
21048 As an example you can see how two TortoiseSVN commands could be integrated
21052 \begin_layout Description
21054 \begin_inset Flex Code
21057 \begin_layout Plain Layout
21058 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
21066 \begin_layout Description
21068 \begin_inset Flex Code
21071 \begin_layout Plain Layout
21072 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
21080 \begin_layout Subsection
21081 Version control and Document comparison
21084 \begin_layout Standard
21085 One of the typical uses of version control is to inspect the changes between
21086 revisions, usually by creating
21087 \begin_inset Flex Code
21090 \begin_layout Plain Layout
21097 While this is useful for plain text files, it is much less useful in the
21098 case of LyX files, which have more complicated structure.
21099 Hence we provide binding to the Document comparison feature.
21100 They are two ways of calling this feature - either by direct call of
21101 \begin_inset Flex Code
21104 \begin_layout Plain Layout
21110 LyX function (for details see LyX functions manual) or by icon/menu item
21112 \begin_inset Flex MenuItem
21115 \begin_layout Plain Layout
21116 Compare with older revision...
21122 One can either compare two chosen revisions of the document or he can simply
21123 compare the current version of edited text with older revisions (where
21125 \begin_inset Flex MenuItem
21128 \begin_layout Plain Layout
21134 ' revisions back means comparison of the edited file with last commited
21139 \begin_layout Standard
21140 This feature is supported for SVN and RCS though due to the more complicated
21141 versioning scheme of RCS there is a constraint -- when addressing the revisions
21142 in dialog, numbers always point to the last number in RCS revision number,
21147 \begin_layout Section
21148 Literate Programming
21151 \begin_layout Standard
21156 (kayvan@sylvan.com)
21160 original documentation written by
21162 Edmar Wienskoski Jr.
21165 (edmar-w-jr@technologist.com)
21168 \begin_layout Subsection
21172 \begin_layout Standard
21173 The main purpose of this documentation is to show you how to use LyX for
21174 literate programming, where it is assumed that you are familiar with this
21175 programming technique, and know what
21176 \begin_inset Quotes eld
21180 \begin_inset Quotes erd
21184 \begin_inset Quotes eld
21188 \begin_inset Quotes erd
21192 If that is not the case, please follow the web links provided in the following
21194 There is a lot of good documentation out there covering old development
21195 history to the latest tools tips.
21198 \begin_layout Standard
21199 It is also assumed that you are familiar with LyX itself to a point that
21200 you are comfortable changing your LyX preferences, and X resources file.
21201 If that is not the case please refer to other LyX documentation to cover
21202 your specific needs.
21205 \begin_layout Subsection
21206 Literate Programming
21209 \begin_layout Standard
21210 From the Literate Programming FAQ:
21213 \begin_layout Quotation
21214 Literate programming is the combination of documentation and source together
21215 in a fashion suited for reading by human beings.
21216 In fact, literate programs should be enjoyable reading, even inviting!
21217 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
21218 and documentation in a single file.
21219 Literate programming tools then parse the file to produce either readable
21220 documentation or compilable source.
21221 The WEB style of literate programming was created by D.
21222 \begin_inset space \thinspace{}
21226 Knuth during the development of his TeX typesetting software.
21230 \begin_layout Standard
21231 Another excerpt says:
21234 \begin_layout Quotation
21237 How is literate programming different from verbose commenting?
21240 \begin_layout Quotation
21241 There are three distinguishing characteristics.
21242 In order of importance, they are:
21246 \begin_layout Itemize
21247 flexible order of elaboration
21250 \begin_layout Itemize
21251 automatic support for browsing
21254 \begin_layout Itemize
21255 typeset documentation, especially diagrams and mathematics
21259 \begin_layout Standard
21260 Now that I sparked your curiosity, take a look in the references.
21263 \begin_layout Subsubsection
21267 \begin_layout Standard
21268 The complete Literate Programming FAQ can be found at:
21271 \begin_layout Quote
21272 Literate Programming FAQ
21273 \begin_inset Flex URL
21276 \begin_layout Plain Layout
21278 http://www.literateprogramming.com/lpfaq.pdf
21286 \begin_layout Standard
21287 The FAQ lists 23 (twenty three!) different literate programming tools.
21288 Where some are specialized or
21289 \begin_inset Quotes eld
21293 \begin_inset Quotes erd
21296 for particular programming languages, while other have general scope.
21301 for my own use for several reasons:
21304 \begin_layout Itemize
21305 It can generate the documentation either in LaTeX or HTML.
21308 \begin_layout Itemize
21309 It has a open architecture, i.
21310 \begin_inset space \thinspace{}
21314 \begin_inset space \space{}
21317 it is easy to plug in new filters and to perform special processing that
21322 \begin_layout Itemize
21323 There is a good selection of filters available already (the HTML is one
21327 \begin_layout Itemize
21331 \begin_layout Standard
21332 The Noweb web page can be found at:
21335 \begin_layout Quote
21337 \begin_inset Flex URL
21340 \begin_layout Plain Layout
21342 http://www.cs.virginia.edu/~nr/noweb/
21350 \begin_layout Standard
21351 Starting from there you can reach many other interesting links and even
21352 some literate program examples.
21355 \begin_layout Subsection
21356 LyX and Literate Programming
21359 \begin_layout Standard
21360 The LyX support for Literate Programming is provided by using the generic
21361 LyX converters mechanism.
21362 This support is provided in a
21363 \begin_inset Quotes eld
21367 \begin_inset Quotes erd
21371 \begin_inset space \thinspace{}
21375 \begin_inset space \space{}
21378 you will be able to use this new LyX feature with some other literate programmin
21379 g tool of your choice by just changing your LyX preferences.
21382 \begin_layout Subsubsection
21383 Generating documents and code (weaving and tangling)
21386 \begin_layout Paragraph
21387 Selecting the document class
21390 \begin_layout Standard
21391 If you have installed Noweb and LyX successfully, whenever you open a new
21392 document or try to change the document class of an existing one, you will
21393 find that there are three new document classes available:
21396 \begin_layout Itemize
21400 \begin_layout Itemize
21404 \begin_layout Itemize
21408 \begin_layout Standard
21409 You must select one of them to create your literate documents from.
21413 \begin_layout Standard
21414 Note that literate documents are not limited to these three classes.
21415 New classes can be generated from other styles like letter or in combination
21416 with other class variations like Article (AMS).
21417 If you have special needs that cannot be covered by one of the existing
21418 classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
21419 will arrange to insert a new entry, or teach you how to do it.
21423 \begin_layout Plain Layout
21424 It is very simple, it involves the creation of a file with four lines, and
21425 re-running of the auto configuration.
21430 Moreover, if you use a literate tool other than Noweb you may need to create
21431 a new set of document classes for it.
21434 \begin_layout Paragraph
21438 \begin_layout Standard
21439 LyX enables you to write code with a layout named
21447 \begin_layout Plain Layout
21448 The equivalent Noweb term is
21449 \begin_inset Quotes eld
21453 \begin_inset Quotes erd
21457 For historical reasons, I got used to the term
21458 \begin_inset Quotes eld
21462 \begin_inset Quotes erd
21465 introduced by other literate tool named Nuweb, which I used for many years
21466 before rendering myself to Noweb.
21471 Noweb delimits scraps like this:
21474 \begin_layout LyX-Code
21478 \begin_layout LyX-Code
21482 \begin_layout LyX-Code
21486 \begin_layout LyX-Code
21490 \begin_layout LyX-Code
21494 \begin_layout Standard
21495 The problem is that whatever is written in between the << and the
21499 must be taken literally, i.
21500 \begin_inset space \thinspace{}
21504 \begin_inset space \space{}
21507 LyX should be prevented from making any special interpretation of what has
21509 This is handled by a special layout named Scrap, that works like a normal
21510 paragraph but has a free spacing capability.
21513 \begin_layout Standard
21514 The down side of the Scrap paragraph layout is that consecutive paragraphs
21515 of code will be spaced with one empty line in the source code and also
21516 in the printed documentation.
21517 The work around is to enter each line of code within a single Scrap, with
21518 a newline (ctrl-return).
21519 The example above will look like this:
21523 \begin_layout Plain Layout
21524 If you have a printed version of this document you will not see any difference
21525 between the previous example and this one.
21533 \begin_layout LyX-Code
21535 \begin_inset Newline newline
21539 \begin_inset Newline newline
21543 \begin_inset Newline newline
21547 \begin_inset Newline newline
21553 \begin_layout Standard
21554 This layout works fine.
21555 The only real inconvenience is that you have to type ctrl-return instead
21560 \begin_layout Plain Layout
21561 It is in my list of
21562 \begin_inset Quotes eld
21566 \begin_inset Quotes erd
21577 \begin_layout Standard
21578 As a special note, you can also use the
21579 \begin_inset Quotes eld
21583 \begin_inset Quotes erd
21586 construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
21590 \begin_layout LyX-Code
21592 \begin_inset Newline newline
21595 def some_function(args):
21596 \begin_inset Newline newline
21599 "This is the doc string for this function."
21600 \begin_inset Newline newline
21603 print "My args: ", args
21606 \begin_layout LyX-Code
21607 @ %def some_function
21610 \begin_layout Standard
21611 For an example of this usage and the resulting cross-reference output, look
21612 at the Literate python program in
21614 LIBDIR/examples/listerrors.lyx
21616 which should make this all clear.
21619 \begin_layout Paragraph
21620 Generating the documentation
21623 \begin_layout Standard
21624 At this point you already have a new document file with a proper document
21625 class, and with some code and text on it.
21626 How do I print it? The answer is simple, you select
21628 View\SpecialChar \menuseparator
21632 Just like you would do for a plain document.
21633 No special procedure is required.
21636 \begin_layout Standard
21637 To help orientate you, I will now explain what happens inside LyX:
21640 \begin_layout Enumerate
21643 Update\SpecialChar \menuseparator
21646 menu option is chosen, a LaTeX file is generated.
21651 \begin_layout Standard
21652 If the document is of any literate class the generated file will be named
21653 with an extension name defined by the
21654 \begin_inset Quotes eld
21658 \begin_inset Quotes erd
21661 format (defined in the Preferences panel), otherwise the file will have
21670 \begin_layout Enumerate
21671 Note that the only difference so far is in the name of the file, no special
21672 processing is required by LyX.
21673 Given that you formatted the code using the Scrap layout that, by itself,
21674 takes care of the business.
21677 \begin_layout Enumerate
21678 If the document is of any literate class LyX will then use the internal
21679 LyX to Noweb converter, followed by the Noweb to LaTeX converter
21683 \begin_layout Plain Layout
21684 The converters are defined in the
21686 Tools\SpecialChar \menuseparator
21690 \begin_inset Quotes eld
21694 \begin_inset Quotes erd
21706 manual for general information about converters.
21711 to generate the LaTeX file.
21715 \begin_layout Standard
21716 Otherwise it will just skip this step.
21720 \begin_layout Enumerate
21721 Finally, LaTeX is invoked and the regular post processing continues as in
21725 \begin_layout Standard
21726 Independence from a particular
21727 \begin_inset Quotes eld
21731 \begin_inset Quotes erd
21734 is easily achieved by changing the commands that are run by the various
21738 \begin_layout Paragraph
21739 Generating the code
21742 \begin_layout Standard
21743 When the build menu option is chosen or the corresponding button in the
21744 toolbar is pressed, a LaTeX file is generated just like step 1 above.
21745 Next, LyX invokes the
21750 This converter needs to be defined by the user and is not installed by
21751 default, though the Program format is.
21752 This converter (like any other converter) will have two parts:
21755 \begin_layout Enumerate
21756 The converter program itself.
21757 This program performs the conversion from the one format to the other (in
21758 this case, from the Noweb format to the Program pseudo-format).
21761 \begin_layout Enumerate
21762 The error log parser.
21763 This is a program whose sole purpose is to rewrite error messages in a
21764 format that LyX understands.
21765 This makes it possible for LyX to place error boxes in the right places
21766 in the file buffer.
21769 \begin_layout Standard
21770 The first part, the
21771 \begin_inset Quotes eld
21775 \begin_inset Quotes erd
21778 setting, should be set to
21779 \begin_inset Quotes eld
21787 \begin_inset Quotes erd
21791 This basically means that LyX will call
21792 \begin_inset Quotes eld
21796 \begin_inset Quotes erd
21799 (a program or script) with the name of the Noweb file (normally a file
21800 in the LyX temp directory).
21804 \begin_layout Standard
21805 This is an implementation of
21806 \begin_inset Quotes eld
21810 \begin_inset Quotes erd
21813 that you can place in a directory on your path:
21816 \begin_layout LyX-Code
21820 \begin_layout LyX-Code
21824 \begin_layout LyX-Code
21825 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
21828 \begin_layout Standard
21829 The next part of the converter setting is the
21830 \begin_inset Quotes eld
21834 \begin_inset Quotes erd
21837 which is to be set to
21838 \begin_inset Quotes eld
21843 parselog=listerrors
21846 \begin_inset Quotes erd
21850 This will run any errors that are generated by the
21851 \begin_inset Quotes eld
21855 \begin_inset Quotes erd
21858 process through the
21859 \begin_inset Quotes eld
21863 \begin_inset Quotes erd
21869 \begin_layout Standard
21870 The converter code looks in
21878 then on the path for the
21879 \begin_inset Quotes eld
21883 \begin_inset Quotes erd
21889 \begin_layout Standard
21890 The build will normally take place in LyX's temporary directory, so the
21891 files produced by the conversion will be in that directory.
21892 LyX will copy out what it regards as the `main' file, but the
21896 conversion may produce several files, and so most of these would then be
21897 deleted when LyX was closed.
21898 The present solution is to use a `copier',
21902 \begin_layout Plain Layout
21911 manual for information on these.
21920 script in its default mode, so that the entire contents of the temporary
21921 directory is copied.
21922 More will get copied than is needed, to be sure, but nothing will be lost.
21923 If, however, you know what extensions the generated files will have, this
21924 can be improved by using the
21933 This option takes a comma-separated list of extensions to copy.
21934 So, for example, if the conversion will generate only files with the extensions
21943 , then the correct definition would be:
21946 \begin_layout LyX-Code
21947 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
21950 \begin_layout Standard
21951 The result will be that only files with these two extensions will be copied
21955 \begin_layout Paragraph
21956 Build instructions in the document
21959 \begin_layout Standard
21960 The last piece of the integration between LyX and noweb is the
21961 \begin_inset Quotes eld
21965 \begin_inset Quotes erd
21969 Generally, the instructions for building your program should be embedded
21970 in a scrap of its own.
21972 \begin_inset Quotes eld
21976 \begin_inset Quotes erd
21979 above uses the notangle command to look for this scrap (called
21980 \begin_inset Quotes eld
21984 \begin_inset Quotes erd
21987 ) and runs its contents through
21988 \begin_inset Quotes eld
21992 \begin_inset Quotes erd
21998 \begin_layout Standard
21999 Typically, such a scrap would look something like this:
22002 \begin_layout LyX-Code
22004 \begin_inset Newline newline
22008 \begin_inset Newline newline
22012 \begin_inset Newline newline
22015 if [ -z "${NOWEB_SOURCE}" ]
22016 \begin_inset Newline newline
22020 \begin_inset Newline newline
22023 NOWEB_SOURCE=myfile.nw
22024 \begin_inset Newline newline
22028 \begin_inset Newline newline
22032 code to extract files ...]
22033 \begin_inset Newline newline
22037 code to compile files ...]
22038 \begin_inset Newline newline
22044 \begin_layout Standard
22047 LIBDIR/examples/listerrors.lyx
22051 LIBDIR/examples/Literate.lyx
22053 which implement two versions of the
22054 \begin_inset Quotes eld
22058 \begin_inset Quotes erd
22061 program for some illustrations of how all of these pieces go together or
22064 LIBDIR/examples/noweb2lyx.lyx.
22067 Interestingly, these three files show off the language-indepence of the
22068 LyX literate programming support since they are written in Python, C and
22072 \begin_layout Subsubsection
22076 \begin_layout Standard
22077 All the Literate Programming support is configured by the
22079 Tools\SpecialChar \menuseparator
22083 \begin_inset Quotes eld
22087 \begin_inset Quotes erd
22091 The important parts are:
22094 \begin_layout Description
22096 \begin_inset space ~
22100 \begin_inset Quotes eld
22104 \begin_inset Quotes erd
22108 \begin_inset space ~
22111 format Set up via the Formats tab, this is where the Noweb-specific pieces
22121 , the file extension is set to
22126 This tells LyX to create a file with a
22130 extension in the first step of the conversion process.
22133 \begin_layout Description
22135 \begin_inset space ~
22143 \begin_inset space ~
22146 format This is an empty format whose sole purpose is to be the endpoint
22147 of a conversion (which then allows us to set up a converter for it).
22150 \begin_layout Description
22159 This converter performs the
22160 \begin_inset Quotes eld
22164 \begin_inset Quotes erd
22167 of the literate document.
22168 For Noweb, it is set to
22169 \begin_inset Quotes eld
22174 noweave -delay -index $$i > $$o
22177 \begin_inset Quotes erd
22183 \begin_layout Description
22193 \begin_inset Quotes eld
22197 \begin_inset Quotes erd
22201 As stated above, the Converter is set to
22202 \begin_inset Quotes eld
22210 \begin_inset Quotes erd
22213 , with Flags set to
22214 \begin_inset Quotes eld
22219 originaldir,parselog=listerrors
22222 \begin_inset Quotes erd
22228 \begin_layout Subsubsection
22232 \begin_layout Standard
22233 There is also a new function implemented in the LyX server, the
22234 \begin_inset Quotes eld
22237 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
22241 \begin_layout Standard
22242 When debugging code with ddd/gdb, it is possible to invoke a text editor
22243 at the current execution position with a single key stroke.
22244 The default ddd configuration for that is shift-ctrl-V.
22245 It happens that you can define the editor command line invocation in ddd
22248 Edit\SpecialChar \menuseparator
22249 Preferences\SpecialChar \menuseparator
22252 dialog and changing the "Edit Sources" entry.
22255 \begin_layout Standard
22256 I take advantage of the new created LyX server function and this ddd feature,
22258 \begin_inset Quotes eld
22262 \begin_inset Quotes erd
22268 \begin_layout LyX-Code
22269 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
22272 \begin_layout Standard
22273 With this, whenever you are using ddd and find a point in the program that
22274 you want to edit, you just press shift-ctrl-V (in the ddd window), and
22275 ddd you forward this information to LyX through the LyX server and then
22276 the LyX window will show the same file with the cursor at the same position
22277 ddd was pointing to.
22278 No more guessing or long scrolling to locate a point in the program back
22282 \begin_layout Standard
22283 Note however that you must enable the LyX server to get this feature working
22284 (it is disabled by default).
22285 You can enable it in
22297 ) by entering in the
22302 \begin_inset Quotes eld
22307 /home/<your-home-directory>/.lyx/lyxpipe
22310 \begin_inset Quotes erd
22316 \begin_layout Standard
22317 Read the LyX server documentation in the
22319 Customization Manual
22321 for further information.
22324 \begin_layout Subsubsection
22328 \begin_layout Standard
22329 There are six new buttons that can be added to your LyX toolbar.
22330 Five of these buttons are short cuts to layout styles:
22351 The last one is a short cut to the
22352 \begin_inset Quotes eld
22356 \begin_inset Quotes erd
22363 \begin_layout Standard
22364 LyX has a range of buttons that are available for tool bar customization.
22365 In my toolbar I like to combine the six short cuts above with two more:
22370 \SpecialChar \menuseparator
22375 \SpecialChar \menuseparator
22382 View\SpecialChar \menuseparator
22386 Here is how it looks like:
22389 \begin_layout LyX-Code
22393 \begin_layout LyX-Code
22397 \begin_layout LyX-Code
22398 Icon "layout Standard"
22401 \begin_layout LyX-Code
22402 Icon "layout Section"
22405 \begin_layout LyX-Code
22406 Icon "layout LaTeX"
22409 \begin_layout LyX-Code
22410 Icon "layout LyX-Code"
22413 \begin_layout LyX-Code
22414 Icon "layout Scrap"
22417 \begin_layout LyX-Code
22421 \begin_layout LyX-Code
22425 \begin_layout LyX-Code
22426 Icon "buffer-typeset"
22429 \begin_layout LyX-Code
22430 Icon "build-program"
22433 \begin_layout LyX-Code
22437 \begin_layout LyX-Code
22441 \begin_layout LyX-Code
22445 \begin_layout LyX-Code
22449 \begin_layout LyX-Code
22453 \begin_layout Subsubsection
22454 Colors customization
22457 \begin_layout Standard
22458 There are a number of colors in LyX that can be customized in
22463 One of the things that bothers people is the LaTeX font color.
22464 The default color is red, since the scraps uses LaTeX font, and there is
22465 a lot of scraps in literate documents, you may get tired of seeing everything
22467 You can change it by going to the tabs
22476 \begin_layout Standard
22477 The next thing is the visible presence of the newline character in the screen.
22478 You can choose the color of this particular character and make it blend
22480 I recommend you choosing a color that is close to the background but not
22481 equal, that way you still can see it is there, but it is not bothering
22486 \begin_layout Chapter
22490 \begin_layout Standard
22491 You can do everything with LyX that you can do with LaTeX.
22492 However, LyX cannot support every LaTeX feature directly.
22493 But you can always use TeX Code.
22494 This chapter shows you some more special things that are possible with
22495 LyX that you might want to use.
22496 For spcial things you can do with the features that are directly supported
22497 by LyX, have a look at the
22504 \begin_layout Section
22508 \begin_layout Subsection
22512 \begin_layout Standard
22513 The aim for this chapter
22517 \begin_layout Plain Layout
22518 Editor's note: Lars' original chapter was a masterful description of how
22524 However, it was too long to flow smoothly in this document.
22525 I have therefore chosen to excerpt the most important sections here (sorry,
22526 Lars); you can read the original chapter (and more of the story!) in the
22529 examples/multicol.lyx
22537 is to show how the LaTeX package
22541 can be used in a LyX document.
22542 As LyX doesn't support the
22546 package natively yet, we have to use some small hacks.
22547 By reading this section it should be obvious how to do this.
22550 \begin_layout Subsection
22554 \begin_layout Standard
22559 package allows switching between one and multicolumn format on the same
22561 Footnotes are handled correctly (for the most part), but will be placed
22562 at the bottom of the page and not under each column.
22563 LaTeX's float mechanism, however, is partly disabled in the current implementat
22565 At the moment only page-wide floats can be used within the scope of the
22569 \begin_layout Subsection
22573 \begin_layout Subsubsection
22577 \begin_layout Standard
22578 If you want to have two columns in your text, you have use LaTeX mode to
22583 begin{multicols}{2}
22585 at the point where you want the two column layout to start, and then
22591 where you want it to end.
22595 \begin_layout Standard
22599 \begin_layout Plain Layout
22603 begin{multicols}{2}
22611 \begin_layout Standard
22616 The Adventure of the Empty House
22619 \begin_inset Newline newline
22624 Sir Arthur Conan Doyle
22627 \begin_layout Standard
22630 It was in the spring of the year 1894 that all London was interested, and
22631 the fashionable world dismayed, by the murder of the Honourable Ronald
22632 Adair under most unusual and inexplicable circumstances.
22633 The public has already learned those particulars of the crime which came
22634 out in the police investigation, but a good deal was suppressed upon that
22635 occasion, since the case for the prosecution was so overwhelmingly strong
22636 that it was not necessary to bring forward all the facts.
22637 Only now, at the end of nearly ten years, am I allowed to supply those
22638 missing links which make up the whole of that remarkable chain.
22639 The crime was of interest in itself, but that interest was as nothing to
22640 me compared to the inconceivable sequel, which afforded me the greatest
22641 shock and surprise of any event in my adventurous life.
22642 Even now, after this long interval, I find myself thrilling as I think
22643 of it, and feeling once more that sudden flood of joy, amazement, and increduli
22644 ty which utterly submerged my mind.
22645 Let me say to that public, which has shown some interest in those glimpses
22646 which I have occasionally given them of the thoughts and actions of a very
22647 remarkable man, that they are not to blame me if I have not shared my knowledge
22648 with them, for I should have considered it my first duty to do so, had
22649 I not been barred by a positive prohibition from his own lips, which was
22650 only withdrawn upon the third of last month.
22653 \begin_layout Standard
22657 \begin_layout Plain Layout
22669 \begin_layout Subsubsection
22673 \begin_layout Standard
22674 The same pattern is used when you want more than two columns:
22677 \begin_layout Standard
22681 \begin_layout Plain Layout
22685 begin{multicols}{3}
22693 \begin_layout Standard
22696 It can be imagined that my close intimacy with Sherlock Holmes had interested
22697 me deeply in crime, and that after his disappearance I never failed to
22698 read with care the various problems which came before the public.
22699 And I even attempted, more than once, for my own private satisfaction,
22700 to employ his methods in their solution, though with indifferent success.
22701 There was none, however, which appealed to me like this tragedy of Ronald
22703 As I read the evidence at the inquest, which led up to a verdict of willful
22704 murder against some person or persons unknown, I realized more clearly
22705 than I had ever done the loss which the community had sustained by the
22706 death of Sherlock Holmes.
22707 There were points about this strange business which would, I was sure,
22708 have specially appealed to him, and the efforts of the police would have
22709 been supplemented, or more probably anticipated, by the trained observation
22710 and the alert mind of the first criminal agent in Europe.
22711 All day, as I drove upon my round, I turned over the case in my mind and
22712 found no explanation which appeared to me to be adequate.
22713 At the risk of telling a twice-told tale, I will recapitulate the facts
22714 as they were known to the public at the conclusion of the inquest.
22717 \begin_layout Standard
22721 \begin_layout Plain Layout
22733 \begin_layout Standard
22734 You can have more than 3 columns if you want to, but that might not be very
22735 pleasant for the eye.
22738 \begin_layout Subsubsection
22739 Columns inside columns
22742 \begin_layout Standard
22743 You can even have columns inside columns:
22746 \begin_layout Standard
22750 \begin_layout Plain Layout
22754 begin{multicols}{2}
22762 \begin_layout Standard
22765 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
22766 at that time governor of one of the Australian colonies.
22767 Adair's mother had returned from Australia to undergo the operation for
22768 cataract, and she, her son Ronald, and her daughter Hilda were living together
22772 \begin_layout Standard
22776 \begin_layout Plain Layout
22780 begin{multicols}{2}
22788 \begin_layout Standard
22791 The youth moved in the best society–had, so far as was known, no enemies
22792 and no particular vices.
22793 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
22794 had been broken off by mutual consent some months before, and there was
22795 no sign that it had left any very profound feeling behind it.
22796 For the rest {sic} the man's life moved in a narrow and conventional circle,
22797 for his habits were quiet and his nature unemotional.
22798 Yet it was upon this easy-going young aristocrat that death came, in most
22799 strange and unexpected form, between the hours of ten and eleven-twenty
22800 on the night of March 30, 1894.
22803 \begin_layout Standard
22807 \begin_layout Plain Layout
22819 \begin_layout Standard
22822 Ronald Adair was fond of cards–playing continually, but never for such stakes
22824 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
22825 It was shown that, after dinner on the day of his death, he had played
22826 a rubber of whist at the latter club.
22827 He had also played there in the afternoon.
22832 The evidence of those who had played with him– Mr.
22833 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
22834 and that there was a fairly equal fall of the cards.
22835 Adair might have lost five pounds, but not more.
22836 His fortune was a considerable one, and such a loss could not in any way
22838 He had played nearly every day at one club or other, but he was a cautious
22839 player, and usually rose a winner.
22840 It came out in evidence that, in partnership with Colonel Moran, he had
22841 actually won as much as four hundred and twenty pounds in a sitting, some
22842 weeks before, from Godfrey Milner and Lord Balmoral.
22843 So much for his recent history as it came out at the inquest.
22846 \begin_layout Standard
22850 \begin_layout Plain Layout
22862 \begin_layout Standard
22863 Please do read the file
22865 examples/multicol.lyx
22867 for more advanced examples including column and header spacing, vertical
22868 separator lines, and more.
22871 \begin_layout Section
22876 Paragraph Environment
22877 \begin_inset Argument
22880 \begin_layout Plain Layout
22881 Numbering in Enumerate
22889 \begin_layout Standard
22890 \begin_inset VSpace bigskip
22896 \begin_layout Standard
22898 The default numbering for the
22902 paragraph environment begins with Arabic numbers and ends with uppercase
22904 Suppose, however, you wanted a different type of numbering scheme.
22905 Here's a quickie example of how to change the numbering scheme:
22908 \begin_layout LyX-Code
22918 \begin_layout LyX-Code
22928 \begin_layout LyX-Code
22938 \begin_layout LyX-Code
22948 \begin_layout Standard
22949 \SpecialChar \ldots{}
22950 which changes the numbering scheme to uppercase Roman numerals, uppercase
22951 letters, Arabic numbers, and lowercase letter.
22954 \begin_layout Standard
22955 Additionally, the previous example also adds a little bit extra to the numbering
22957 For example, the first level label actually looks like:
22958 \begin_inset Quotes eld
22962 \begin_inset Quotes erd
22966 For ease of reading, we'll describe what the numbering schemes look like
22967 using a notation something like this: <
22968 \begin_inset Quotes eld
22972 \begin_inset Quotes erd
22976 \begin_inset space ~
22980 \begin_inset Quotes erd
22984 \begin_inset Quotes erd
22988 \begin_inset space ~
22992 \begin_inset Quotes erd
22996 \begin_inset Quotes erd
23000 \begin_inset space ~
23004 \begin_inset Quotes eld
23008 \begin_inset Quotes erd
23015 \begin_layout Standard
23016 As you can see in the example, there is a label command for each nesting
23023 \SpecialChar \ldots{}
23030 , as well as a counter,
23034 \SpecialChar \ldots{}
23040 There are also five
23041 \begin_inset Quotes eld
23045 \begin_inset Quotes erd
23078 , each of which take one counter as an argument.
23079 You can add characters before or after these, but there's no need to add
23083 \begin_layout Standard
23084 You can get really fancy with these.
23088 \begin_layout LyX-Code
23102 \begin_layout LyX-Code
23114 \begin_layout LyX-Code
23124 \begin_layout LyX-Code
23134 \begin_layout Standard
23135 produces the somewhat out of hand numbering scheme: <
23136 \begin_inset Quotes eld
23140 \begin_inset Quotes erd
23144 \begin_inset space ~
23148 \begin_inset Quotes erd
23152 \begin_inset Quotes erd
23156 \begin_inset space ~
23160 \begin_inset Quotes erd
23164 \begin_inset Quotes erd
23168 \begin_inset space ~
23172 \begin_inset Quotes eld
23176 \begin_inset Quotes erd
23183 \begin_layout Section
23187 \begin_layout Standard
23188 \begin_inset VSpace bigskip
23194 \begin_layout Standard
23199 \begin_layout Plain Layout
23205 tmpfont}{cmr17 scaled 2500}{
23217 \begin_layout Standard
23222 \begin_layout Plain Layout
23233 hose of you who like the style of old books probably also like
23234 \begin_inset Quotes eld
23238 \begin_inset Quotes erd
23241 —those large capital letters which begin each new chapter or section.
23242 Implementing them with plain LyX/LaTeX is straightforward (assuming you
23243 know some plain TeX!) but does require a lot of work and many iterations,
23244 as you can see by all the ugly TeX-mode stuff at the beginning of this
23248 \begin_layout Standard
23252 \begin_layout Plain Layout
23258 bigdrop{-1em}{3}{ptmri}{T}+
23263 here is a much easier way of doing this, of course.
23272 ) package from CTAN allows a simple way to add such letters to your documents.
23273 Since this package is not a standard part of TeXLive, I can't demonstrate
23274 it within this document, but if you copy this paragraph to a new document,
23276 \begin_inset Quotes eld
23286 \begin_inset Quotes erd
23289 and the pluses from the TeX code at the beginning of the paragraph, and
23294 usepackage{dropcaps}
23296 to your LaTeX preamble, you will get a nice Times Roman Italic
23297 \begin_inset Quotes eld
23301 \begin_inset Quotes erd
23304 , whose height is three lines of text and which protrudes 1 em into the
23306 (Make certain you have copied
23307 \begin_inset Quotes eld
23315 \begin_inset Quotes erd
23318 into a directory where TeX can see it.) The first argument is the amount
23319 of indentation; in this case the negative sign moves it into the margin.
23320 The second argument is the height of the letter in number of lines of text.
23321 The third argument is the font name: virtually anything which has a tfm
23322 file should work (wade through the
23324 .../texmf/fonts/tfm
23326 directory for possibilities).
23327 My personal favorite is
23328 \begin_inset Quotes eld
23336 \begin_inset Quotes erd
23339 , a fancy German font specifically designed for dropped capitals.
23340 The fourth argument is the letter (or letters) to be dropped.
23345 package also offers the
23351 command, as well as a slightly simplified
23360 \begin_layout Section
23363 Textumflossene Bilder und Tabellen
23366 \begin_layout Standard
23371 Eingebettete Objekte
23373 Handbuch werden Umflossene Gleitobjekte beschrieben.
23374 Sie liefern Folgendes:
23377 \begin_layout Standard
23380 \begin_inset Tabular
23381 <lyxtabular version="3" rows="2" columns="2">
23382 <features tabularvalignment="middle">
23383 <column alignment="center" valignment="top" width="0">
23384 <column alignment="center" valignment="top" width="0">
23386 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
23389 \begin_layout Plain Layout
23390 \begin_inset Graphics
23391 filename ../images/dialog-show-new-inset_graphics.png
23393 scaleBeforeRotation
23394 BoundingBox 0bp 6bp 22bp 22bp
23403 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
23406 \begin_layout Plain Layout
23414 <cell alignment="center" valignment="top" bottomline="true" leftline="true" usebox="none">
23417 \begin_layout Plain Layout
23423 <cell alignment="center" valignment="top" bottomline="true" rightline="true" usebox="none">
23426 \begin_layout Plain Layout
23438 \begin_inset Tabular
23439 <lyxtabular version="3" rows="2" columns="2">
23440 <features tabularvalignment="middle">
23441 <column alignment="center" valignment="top" width="0">
23442 <column alignment="center" valignment="top" width="0">
23444 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
23447 \begin_layout Plain Layout
23453 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
23456 \begin_layout Plain Layout
23457 \begin_inset Graphics
23458 filename ../images/dialog-show-new-inset_graphics.png
23460 scaleBeforeRotation
23461 BoundingBox 0bp 6bp 22bp 22bp
23472 <cell alignment="center" valignment="top" bottomline="true" leftline="true" usebox="none">
23475 \begin_layout Plain Layout
23481 <cell alignment="center" valignment="top" bottomline="true" rightline="true" usebox="none">
23484 \begin_layout Plain Layout
23498 \begin_layout Standard
23501 Wenn Sie aber text richtig um Bilder oder Tabellen fließen lassen wollen,
23502 also auch so etwas:
23505 \begin_inset VSpace defskip
23511 \begin_layout Standard
23514 \begin_inset Tabular
23515 <lyxtabular version="3" rows="2" columns="2">
23516 <features tabularvalignment="middle">
23517 <column alignment="center" valignment="top" width="0">
23518 <column alignment="center" valignment="top" width="0">
23520 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
23523 \begin_layout Plain Layout
23529 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
23532 \begin_layout Plain Layout
23540 <cell alignment="center" valignment="top" bottomline="true" leftline="true" usebox="none">
23543 \begin_layout Plain Layout
23544 \begin_inset Graphics
23545 filename ../images/dialog-show-new-inset_graphics.png
23547 scaleBeforeRotation
23548 BoundingBox 0bp 6bp 22bp 22bp
23557 <cell alignment="center" valignment="top" bottomline="true" rightline="true" usebox="none">
23560 \begin_layout Plain Layout
23572 \begin_inset Tabular
23573 <lyxtabular version="3" rows="2" columns="2">
23574 <features tabularvalignment="middle">
23575 <column alignment="center" valignment="top" width="0">
23576 <column alignment="center" valignment="top" width="0">
23578 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
23581 \begin_layout Plain Layout
23587 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
23590 \begin_layout Plain Layout
23598 <cell alignment="center" valignment="top" bottomline="true" leftline="true" usebox="none">
23601 \begin_layout Plain Layout
23607 <cell alignment="center" valignment="top" bottomline="true" rightline="true" usebox="none">
23610 \begin_layout Plain Layout
23611 \begin_inset Graphics
23612 filename ../images/dialog-show-new-inset_graphics.png
23614 scaleBeforeRotation
23615 BoundingBox 0bp 6bp 22bp 22bp
23630 \begin_inset Tabular
23631 <lyxtabular version="3" rows="2" columns="3">
23632 <features tabularvalignment="middle">
23633 <column alignment="center" valignment="top" width="0">
23634 <column alignment="center" valignment="top" width="0">
23635 <column alignment="center" valignment="top" width="0">
23637 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
23640 \begin_layout Plain Layout
23646 <cell alignment="center" valignment="top" topline="true" usebox="none">
23649 \begin_layout Plain Layout
23650 \begin_inset Graphics
23651 filename ../images/dialog-show-new-inset_graphics.png
23653 scaleBeforeRotation
23654 BoundingBox 0bp 6bp 22bp 22bp
23663 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
23666 \begin_layout Plain Layout
23674 <cell alignment="center" valignment="top" bottomline="true" leftline="true" usebox="none">
23677 \begin_layout Plain Layout
23683 <cell alignment="center" valignment="top" bottomline="true" usebox="none">
23686 \begin_layout Plain Layout
23692 <cell alignment="center" valignment="top" bottomline="true" rightline="true" usebox="none">
23695 \begin_layout Plain Layout
23707 \begin_inset Tabular
23708 <lyxtabular version="3" rows="2" columns="3">
23709 <features tabularvalignment="middle">
23710 <column alignment="center" valignment="top" width="0">
23711 <column alignment="center" valignment="top" width="0">
23712 <column alignment="center" valignment="top" width="0">
23714 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
23717 \begin_layout Plain Layout
23723 <cell alignment="center" valignment="top" topline="true" usebox="none">
23726 \begin_layout Plain Layout
23732 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
23735 \begin_layout Plain Layout
23743 <cell alignment="center" valignment="top" bottomline="true" leftline="true" usebox="none">
23746 \begin_layout Plain Layout
23752 <cell alignment="center" valignment="top" bottomline="true" usebox="none">
23755 \begin_layout Plain Layout
23756 \begin_inset Graphics
23757 filename ../images/dialog-show-new-inset_graphics.png
23759 scaleBeforeRotation
23760 BoundingBox 0bp 6bp 22bp 22bp
23769 <cell alignment="center" valignment="top" bottomline="true" rightline="true" usebox="none">
23772 \begin_layout Plain Layout
23786 \begin_layout Standard
23789 \begin_inset Tabular
23790 <lyxtabular version="3" rows="3" columns="2">
23791 <features tabularvalignment="middle">
23792 <column alignment="center" valignment="top" width="0">
23793 <column alignment="center" valignment="top" width="0">
23795 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
23798 \begin_layout Plain Layout
23804 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
23807 \begin_layout Plain Layout
23815 <cell alignment="center" valignment="top" leftline="true" usebox="none">
23818 \begin_layout Plain Layout
23819 \begin_inset Graphics
23820 filename ../images/dialog-show-new-inset_graphics.png
23822 scaleBeforeRotation
23823 BoundingBox 0bp 6bp 22bp 22bp
23832 <cell alignment="center" valignment="top" rightline="true" usebox="none">
23835 \begin_layout Plain Layout
23843 <cell alignment="center" valignment="top" bottomline="true" leftline="true" usebox="none">
23846 \begin_layout Plain Layout
23852 <cell alignment="center" valignment="top" bottomline="true" rightline="true" usebox="none">
23855 \begin_layout Plain Layout
23867 \begin_inset Tabular
23868 <lyxtabular version="3" rows="3" columns="3">
23869 <features tabularvalignment="middle">
23870 <column alignment="center" valignment="top" width="0">
23871 <column alignment="center" valignment="top" width="0">
23872 <column alignment="center" valignment="top" width="0">
23874 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
23877 \begin_layout Plain Layout
23883 <cell alignment="center" valignment="top" topline="true" usebox="none">
23886 \begin_layout Plain Layout
23892 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
23895 \begin_layout Plain Layout
23903 <cell alignment="center" valignment="top" leftline="true" usebox="none">
23906 \begin_layout Plain Layout
23912 <cell alignment="center" valignment="top" usebox="none">
23915 \begin_layout Plain Layout
23916 \begin_inset Graphics
23917 filename ../images/dialog-show-new-inset_graphics.png
23919 scaleBeforeRotation
23920 BoundingBox 0bp 6bp 22bp 22bp
23929 <cell alignment="center" valignment="top" rightline="true" usebox="none">
23932 \begin_layout Plain Layout
23940 <cell alignment="center" valignment="top" bottomline="true" leftline="true" usebox="none">
23943 \begin_layout Plain Layout
23949 <cell alignment="center" valignment="top" bottomline="true" usebox="none">
23952 \begin_layout Plain Layout
23958 <cell alignment="center" valignment="top" bottomline="true" rightline="true" usebox="none">
23961 \begin_layout Plain Layout
23973 \begin_inset Tabular
23974 <lyxtabular version="3" rows="3" columns="2">
23975 <features tabularvalignment="middle">
23976 <column alignment="center" valignment="top" width="0">
23977 <column alignment="center" valignment="top" width="0">
23979 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
23982 \begin_layout Plain Layout
23988 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
23991 \begin_layout Plain Layout
23999 <cell alignment="center" valignment="top" leftline="true" usebox="none">
24002 \begin_layout Plain Layout
24008 <cell alignment="center" valignment="top" rightline="true" usebox="none">
24011 \begin_layout Plain Layout
24012 \begin_inset Graphics
24013 filename ../images/dialog-show-new-inset_graphics.png
24015 scaleBeforeRotation
24016 BoundingBox 0bp 6bp 22bp 22bp
24027 <cell alignment="center" valignment="top" bottomline="true" leftline="true" usebox="none">
24030 \begin_layout Plain Layout
24036 <cell alignment="center" valignment="top" bottomline="true" rightline="true" usebox="none">
24039 \begin_layout Plain Layout
24053 \begin_layout Standard
24057 sollten Sie das LaTeX-Paket
24062 Hier ist ein Beispiel:
24065 \begin_layout Standard
24069 \begin_layout Plain Layout
24081 \begin_inset Note Note
24084 \begin_layout Plain Layout
24087 Das folgende Beispiel wird nur gedruckt, wenn das LaTeX-Paket
24099 \begin_layout Standard
24103 \begin_layout Plain Layout
24107 begin{window}[2,c,{
24113 \begin_inset Graphics
24114 filename clipart/mobius.eps
24116 scaleBeforeRotation
24117 rotateOrigin center
24125 \begin_layout Plain Layout
24130 \begin_layout Plain Layout
24143 \begin_layout Plain Layout
24154 Textumflossene Bilder oder Tabellen sind keine Gleitobjekte, weil sie dort
24155 gedruckt werden, wo sie definiert wurden.
24156 Dieser Typ wird benutzt, um text um eine Abbildung herum
24160 zu lassen, wobei der text nur den Teil der Zeile benutzt, den die Abbildung
24162 Er wird so eingefügt, wie Sie hier sehen, wenn das La\SpecialChar \-
24168 Der erste Parameter in der eckigen
24169 \begin_inset Newline linebreak
24172 Klammer, hier 2, definiert die Anzahl der Zeilen über dem Bild, der zweite,
24173 hier c, die Position des Bildes.
24174 Die Abbildung nimmt 40
24175 \begin_inset space \thinspace{}
24178 % der Spaltenbreite ein.
24179 Weitere Einzelheiten finden Sie in der Dokumentation von
24184 Die Bildparameter können Sie mit einem Klick auf das Bild wie gewohnt ändern.
24190 \begin_layout Plain Layout
24202 \begin_layout Standard
24206 \begin_layout Plain Layout
24218 \begin_inset Note Note
24221 \begin_layout Plain Layout
24224 Der folgende Teil wird gedruckt, wenn das LaTeX-Paket
24228 nicht installiert ist:
24236 \begin_layout Standard
24239 Sie müssen das LaTeX-Paket
24243 installiert haben, um das Beispiel in der Ausgabe zu sehen.
24246 \begin_layout Standard
24250 \begin_layout Plain Layout
24262 \begin_layout Section
24263 Non-standard Paragraph Shapes
24266 \begin_layout Standard
24267 \begin_inset VSpace bigskip
24273 \begin_layout Standard
24277 \begin_layout Plain Layout
24289 \begin_layout Standard
24293 \begin_layout Plain Layout
24302 \begin_layout Plain Layout
24316 \begin_layout Standard
24321 \begin_layout Plain Layout
24332 \begin_layout Plain Layout
24341 \begin_layout Plain Layout
24350 \begin_layout Plain Layout
24359 \begin_layout Plain Layout
24368 \begin_layout Plain Layout
24377 \begin_layout Plain Layout
24386 \begin_layout Plain Layout
24395 \begin_layout Plain Layout
24404 \begin_layout Plain Layout
24413 \begin_layout Plain Layout
24422 \begin_layout Plain Layout
24431 \begin_layout Plain Layout
24440 \begin_layout Plain Layout
24449 \begin_layout Plain Layout
24458 \begin_layout Plain Layout
24467 \begin_layout Plain Layout
24476 \begin_layout Plain Layout
24485 \begin_layout Plain Layout
24494 \begin_layout Plain Layout
24500 There are times when the tyranny of rectangular paragraphs must be overthrown.
24501 In such situations, a call to the delightful plain TeX command
24508 As you can see, completely arbitrary shapes can be laid out with a suitable
24509 set of linelength definitions.
24510 While this parshape may look a bit silly and useless, one could conceive
24511 of situations such as finely tuned dropped capitals, word wrapping around
24512 non-rectangular graphics, etc.
24513 which will benefit from such handcrafting.
24516 \begin_layout Standard
24517 \begin_inset VSpace bigskip
24523 \begin_layout Standard
24528 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
24535 is the number of lines of text which define the paragraph.
24536 If there turn out to be fewer lines, the shape is truncated; if there are
24537 more, the excess lines have the same dimensions as the last line of the
24547 entries specify the indentation of the line from the left margin, and the
24548 length of the line as measured from that point.
24549 The shape applies only to the current paragraph; everything is reset to
24550 normal for the next paragraph.
24553 \begin_layout Standard
24557 \begin_layout Plain Layout