1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that the manual prints
12 % out as advertised. If you mess with this preamble,
13 % parts of the manual may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC are numbered roman
19 % and a PDF-bookmark for the TOC is added
21 \let\myTOC\tableofcontents
22 \renewcommand{\tableofcontents}{%
23 \pdfbookmark[1]{\contentsname}{}
26 \pagenumbering{arabic}}
28 % extra space for tables
29 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
31 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
32 \use_default_options false
40 \maintain_unincluded_children no
42 \language_package default
45 \font_roman "lmodern" "default"
46 \font_sans "lmss" "default"
47 \font_typewriter "lmtt" "default"
48 \font_math "auto" "auto"
49 \font_default_family default
50 \use_non_tex_fonts false
54 \font_typewriter_osf false
55 \font_sf_scale 100 100
56 \font_tt_scale 100 100
58 \use_dash_ligatures true
60 \default_output_format pdf2
62 \bibtex_command default
63 \index_command default
67 \pdf_title "LyX's Additional Features manual"
68 \pdf_author "LyX Team"
69 \pdf_subject "LyX's additional features documentation"
70 \pdf_keywords "LyX, Documentation, Additional"
72 \pdf_bookmarksnumbered true
73 \pdf_bookmarksopen false
74 \pdf_bookmarksopenlevel 1
79 \pdf_pdfusetitle false
80 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
83 \use_package amsmath 1
84 \use_package amssymb 1
87 \use_package mathdots 1
88 \use_package mathtools 1
90 \use_package stackrel 1
91 \use_package stmaryrd 1
92 \use_package undertilde 1
94 \cite_engine_type default
98 \paperorientation portrait
104 \notefontcolor #0000ff
111 \paragraph_separation indent
112 \paragraph_indentation default
114 \math_indentation default
115 \math_numbering_side default
116 \quotes_style english
120 \paperpagestyle headings
122 \tracking_changes true
123 \output_changes false
125 \postpone_fragile_content false
129 \docbook_table_output 0
130 \docbook_mathml_prefix 1
131 \author -712698321 "Jürgen Spitzmüller"
133 \author 244031559 "Yuriy"
134 \author 1075283030 "Thibaut"
135 \author 1119979965 "Joel A. Kulesza"
141 Additional \SpecialChar LyX
145 \begin_layout Subtitle
150 by the \SpecialChar LyX
155 \begin_layout Plain Layout
157 Principal maintainer of this file is
159 Richard Kimberly Heck
162 If you have comments or error corrections, please send them to the \SpecialChar LyX
165 \begin_inset Flex Code
168 \begin_layout Plain Layout
169 <lyx-docs@lists.lyx.org>
182 \begin_layout Standard
183 \begin_inset CommandInset toc
184 LatexCommand tableofcontents
191 \begin_layout Chapter
195 \begin_layout Standard
196 This manual is essentially Part II of the
198 User's Guide\SpecialChar endofsentence
201 The reason for separating the two documents is simple: the
205 is already quite lengthy, and it contains information on all of the basic
206 features one needs to know in order to prepare most documents.
207 However, the \SpecialChar LyX
208 Team has worked to make \SpecialChar LyX
209 extensible through various configuration
210 files and external packages.
211 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
213 create a layout file (or module) for it without having to alter \SpecialChar LyX
215 We've already had contributions of several new features this way, and some
216 of them are documented here.
217 There are also some more `advanced' features, such as how to control the
218 presentation of bibliographies and how to work with multi-part documents,
219 that are not covered in the
223 and are discussed here.
226 \begin_layout Standard
227 This manual also documents some special features, like fax support
228 \change_deleted 244031559 1603802929
230 \change_inserted 244031559 1603802931
234 \change_deleted 244031559 1603802954
237 , which require additional software to work properly.
238 There is also a chapter on \SpecialChar LyX
240 And lastly, there's a chapter of \SpecialChar LaTeX
241 tools and tips, things you can use to
242 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
244 After all, \SpecialChar LyX
249 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
253 \begin_layout Standard
254 If you haven't read the
258 yet, you are definitely in the wrong manual.
263 is the first place to go, since it describes the notation and format of
265 You should also be thoroughly familiar with the
269 and all of the basic features of \SpecialChar LyX
270 before attempting to read this one.
273 \begin_layout Standard
274 Since many of the topics in this manual depend heavily on \SpecialChar LyX
276 with \SpecialChar LaTeX
277 , this first chapter covers the inner workings of \SpecialChar LyX
280 to generate exactly the \SpecialChar LaTeX
282 It is obviously for more seasoned \SpecialChar LyX
286 \begin_layout Chapter
288 and \SpecialChar LaTeX
292 \begin_layout Section
294 Uses \SpecialChar LaTeX
298 \begin_layout Standard
299 This chapter is for both \SpecialChar TeX
300 -nicians and the \SpecialChar LaTeX
302 In it, we'll explain how \SpecialChar LyX
303 and \SpecialChar LaTeX
304 work together to produce printable output.
305 This is the only place in any of the manuals where we assume you know something
306 about \SpecialChar LaTeX
310 \begin_layout Standard
311 At one time, \SpecialChar LyX
313 \begin_inset Quotes eld
316 WYSIWYM frontend to \SpecialChar LaTeX
318 \begin_inset Quotes erd
321 but that's no longer true.
322 There are frontends to \SpecialChar LaTeX
327 \begin_layout Plain Layout
328 Some familar ones are \SpecialChar TeX
329 maker and kile, on Linux, and \SpecialChar TeX
331 There are also the \SpecialChar LaTeX
332 modes for vi and emacs, of course.
337 These are basically text editors with the ability to run \SpecialChar LaTeX
339 errors in the file you're editing.
340 Although \SpecialChar LyX
349 run \SpecialChar LaTeX
350 , and it also indicates errors in the file, it also does much, much
352 For one thing, you don't need to know \SpecialChar LaTeX
353 to use \SpecialChar LyX
356 has added its own extensions to \SpecialChar LaTeX
358 Try the following sometime: select
359 \begin_inset Flex Noun
362 \begin_layout Plain Layout
363 Export\SpecialChar menuseparator
370 \begin_inset Flex Noun
373 \begin_layout Plain Layout
380 \begin_inset Flex Noun
383 \begin_layout Plain Layout
384 View\SpecialChar menuseparator
394 ), then look at the preamble of the resulting
395 \begin_inset Flex Code
398 \begin_layout Plain Layout
405 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
407 These macros are defined automatically, according to the features you use
411 \begin_layout Standard
412 There are several commands that automatically invoke \SpecialChar LaTeX
417 \begin_layout Itemize
418 \begin_inset Flex Noun
421 \begin_layout Plain Layout
422 Document\SpecialChar menuseparator
431 \begin_layout Itemize
432 \begin_inset Flex Noun
435 \begin_layout Plain Layout
436 Document\SpecialChar menuseparator
445 \begin_layout Standard
446 They will only invoke \SpecialChar LaTeX
447 if the file has changed since the last time \SpecialChar LaTeX
453 \begin_layout Standard
454 When \SpecialChar LyX
455 runs \SpecialChar LaTeX
456 on the file you're editing, it performs these steps:
459 \begin_layout Enumerate
460 Convert the document to \SpecialChar LaTeX
461 and save to a file with the extension
462 \begin_inset Flex Code
465 \begin_layout Plain Layout
472 \begin_inset Flex Code
475 \begin_layout Plain Layout
484 \begin_layout Enumerate
485 Run \SpecialChar LaTeX
487 \begin_inset Flex Code
490 \begin_layout Plain Layout
496 file (maybe several times), and run any other commands (such as
497 \begin_inset Flex Code
500 \begin_layout Plain Layout
507 \begin_inset Flex Code
510 \begin_layout Plain Layout
516 ) needed to compile the \SpecialChar LaTeX
520 \begin_layout Enumerate
521 If there are any errors, show the error log.
524 \begin_layout Standard
525 If you have run \SpecialChar LaTeX
527 \begin_inset Flex Noun
530 \begin_layout Plain Layout
531 View\SpecialChar menuseparator
538 then runs a DVI viewer to display the DVI-file.
540 \begin_inset Flex Noun
543 \begin_layout Plain Layout
544 View\SpecialChar menuseparator
551 performs further steps:
554 \begin_layout Enumerate
556 \begin_inset Flex Code
559 \begin_layout Plain Layout
565 to convert the DVI file to PostScript.
568 \begin_layout Enumerate
569 Run a PostScript viewer, such as
570 \begin_inset Flex Code
573 \begin_layout Plain Layout
579 , to display the PostScript file.
582 \begin_layout Standard
584 does similar things when viewing, or exporting, other formats.
587 \begin_layout Section
588 Translating \SpecialChar LaTeX
589 files into \SpecialChar LyX
593 \begin_layout Standard
594 You can import a \SpecialChar LaTeX
595 file into \SpecialChar LyX
597 \begin_inset Flex Noun
600 \begin_layout Plain Layout
601 File\SpecialChar menuseparator
602 Import\SpecialChar menuseparator
608 command in \SpecialChar LyX
610 This will call a program named
611 \begin_inset Flex Code
614 \begin_layout Plain Layout
620 which will create a file
621 \begin_inset Flex Code
624 \begin_layout Plain Layout
631 \begin_inset Flex Code
634 \begin_layout Plain Layout
642 will then open that file.
646 \begin_layout Plain Layout
647 \begin_inset Flex Code
650 \begin_layout Plain Layout
656 can also be run from the command line, of course.
664 \begin_layout Standard
665 \begin_inset Flex Code
668 \begin_layout Plain Layout
674 will translate most legal \SpecialChar LaTeX
675 , but not everything.
676 It will put things it doesn't understand into \SpecialChar TeX
677 code, so after translating
679 \begin_inset Flex Code
682 \begin_layout Plain Layout
688 , you can look for \SpecialChar TeX
689 code and hand-edit it until it looks right.
692 \begin_layout Standard
693 If you don't know what \SpecialChar TeX
694 code is, read the next section.
697 \begin_layout Section
698 \begin_inset CommandInset label
700 name "sec:Inserting-TeX-Code"
704 Inserting \SpecialChar TeX
705 Code into \SpecialChar LyX
709 \begin_layout Standard
710 Anything you can do in \SpecialChar LaTeX
711 you can do in \SpecialChar LyX
712 , for a very simple reason: You can
713 always insert \SpecialChar TeX
714 code into any \SpecialChar LyX
717 cannot, and will never be able to, display every possible \SpecialChar LaTeX
719 If ever you need to insert \SpecialChar LaTeX
720 commands into your \SpecialChar LyX
721 document, you can use the
723 \begin_inset Flex Code
726 \begin_layout Plain Layout
733 box, which you can insert into your document with
734 \begin_inset Flex Noun
737 \begin_layout Plain Layout
738 Insert\SpecialChar menuseparator
748 or the keyboard shortcut
757 \begin_layout Standard
758 Here's an example of inserting \SpecialChar LaTeX
759 commands in a \SpecialChar LyX
761 The code looks like this:
764 \begin_layout LyX-Code
768 \begin_inset Newline newline
774 \begin_inset Newline newline
777 This is an example of a minipage environment.
779 \begin_inset Newline newline
782 can put nearly everything in it, even (non-floating)
783 \begin_inset Newline newline
788 \begin_inset Newline newline
794 \begin_inset Newline newline
798 \begin_inset Newline newline
804 \begin_inset Newline newline
810 \begin_inset Newline newline
816 \begin_inset Newline newline
821 \begin_inset Newline newline
827 \begin_inset Newline newline
833 \begin_inset Newline newline
839 \begin_inset Newline newline
847 \begin_layout LyX-Code
851 \begin_layout Standard
853 \begin_inset Flex Code
856 \begin_layout Plain Layout
863 box containing this text is directly after this paragraph.
864 Those of you reading the manual in \SpecialChar LyX
865 will only see the \SpecialChar TeX
867 Those reading a printed version of the manuals will see the actual results:
868 \begin_inset VSpace bigskip
874 \begin_layout Standard
878 \begin_layout Plain Layout
885 \begin_layout Plain Layout
892 \begin_layout Plain Layout
894 This is an example of a minipage environment.
895 You can put nearly everything in it, even (non-floating) figures and tables.
899 \begin_layout Plain Layout
906 \begin_layout Plain Layout
911 \begin_layout Plain Layout
918 \begin_layout Plain Layout
925 \begin_layout Plain Layout
932 \begin_layout Plain Layout
938 \begin_layout Plain Layout
945 \begin_layout Plain Layout
952 \begin_layout Plain Layout
959 \begin_layout Plain Layout
969 \begin_inset VSpace bigskip
975 \begin_layout Standard
976 In addition to using \SpecialChar TeX
977 code, you can also create a separate file containing
978 some complex \SpecialChar LaTeX
979 structure and then use
980 \begin_inset Flex Noun
983 \begin_layout Plain Layout
984 Insert\SpecialChar menuseparator
994 to include your file (you should select the type
995 \begin_inset Flex Code
998 \begin_layout Plain Layout
1005 We recommend that you only do this if you have a
1006 \begin_inset Flex Code
1009 \begin_layout Plain Layout
1020 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1024 \begin_layout Standard
1025 There are a few last points to emphasize:
1028 \begin_layout Itemize
1034 check if your \SpecialChar LaTeX
1038 \begin_layout Itemize
1039 Beware of reinventing the wheel.
1042 \begin_layout Standard
1043 On that last point, \SpecialChar LyX
1044 does have quite a few features tucked into it, and
1046 Be sure to check the manuals to make sure that \SpecialChar LyX
1047 doesn't have such-and-such
1048 feature before you decide you have to do it by hand.
1049 Moreover, there are numerous \SpecialChar LaTeX
1050 packages out there to do all sorts of things,
1051 from labels to envelopes to fancy multipage tables.
1053 \change_inserted 244031559 1603815732
1055 \begin_inset CommandInset href
1058 target "https://www.ctan.org/"
1064 \change_deleted 244031559 1603815732
1066 \begin_inset CommandInset href
1069 target "http://www.ctan.org/"
1079 \begin_layout Standard
1080 If you do need to do some wild and fancy things within your document, be
1081 sure to check out a good \SpecialChar LaTeX
1082 book for assistance.
1083 There are a number of them listed in the bibliography of the
1090 \begin_layout Section
1092 and the \SpecialChar LaTeX
1096 \begin_layout Subsection
1097 About the \SpecialChar LaTeX
1101 \begin_layout Standard
1102 If you already know \SpecialChar LaTeX
1103 , there is no need to explain here what the preamble
1105 If you don't, the following will give you some ideas—we recommend again
1106 that you consult a \SpecialChar LaTeX
1107 book for further information.
1108 In any case, you should read the points below, because they explain what
1109 you can do and what you don't need to do in the \SpecialChar LaTeX
1110 preamble of a \SpecialChar LyX
1114 \begin_layout Standard
1115 The \SpecialChar LaTeX
1116 preamble comes at the very beginning of a document,
1124 \begin_layout Itemize
1125 Declare the document class.
1127 \begin_inset Newline newline
1131 already does this for you.
1132 If you're a seasoned \SpecialChar LaTeX
1133 -nician, and you have a custom document class you
1134 want to use, check out the
1136 Customization Manual
1138 for information on how to make \SpecialChar LyX
1142 \begin_layout Itemize
1143 Declare the usage of packages.
1145 \begin_inset Newline newline
1149 packages provide special commands, which are only available within a document
1150 when the package has been declared in the preamble.
1151 In addition to providing special commands, the inclusion of a package can
1152 change the document.
1153 For example, the package
1154 \begin_inset Flex Code
1157 \begin_layout Plain Layout
1163 forces all paragraphs to be indented.
1164 There are other packages for labels, envelopes, margins, etc.
1168 \begin_layout Itemize
1169 Set counters, variables, lengths and widths.
1171 \begin_inset Newline newline
1174 There are several \SpecialChar LaTeX
1175 counters and variables that
1179 be set globally from within the preamble in order to have the desired effect.
1180 (There are variables that you can set and reset inside the document, too.)
1181 Margins are a good example of something that must be set in the preamble.
1182 Another example is the label format for lists.
1183 You can actually set these just about anywhere, but it's best to do it
1184 just once, inside the preamble.
1187 \begin_layout Itemize
1188 Declare user defined commands (with
1189 \begin_inset Flex Code
1192 \begin_layout Plain Layout
1201 \begin_inset Flex Code
1204 \begin_layout Plain Layout
1213 \begin_inset Newline newline
1216 These are abbreviations for \SpecialChar LaTeX
1217 commands which appear very often inside a document.
1218 Although the preamble is a good place to declare such commands, they
1222 be declared anywhere (before they are used for the first time, of course).
1223 This can be useful if there is a lot of raw \SpecialChar LaTeX
1224 code in your document, which
1225 normally should not be the case.
1228 \begin_layout Standard
1230 adds its own set of definitions to the preamble of the
1231 \begin_inset Flex Code
1234 \begin_layout Plain Layout
1241 This makes \SpecialChar LaTeX
1242 files generated by \SpecialChar LyX
1246 \begin_layout Subsection
1247 Changing the Preamble
1250 \begin_layout Standard
1251 The commands which \SpecialChar LyX
1252 adds to the preamble of a \SpecialChar LaTeX
1253 file are fixed; you can't
1254 change them without patching \SpecialChar LyX
1256 You can, however, add your own stuff to the preamble by selecting
1257 \begin_inset Flex Noun
1260 \begin_layout Plain Layout
1263 \begin_inset space ~
1272 \begin_inset Flex Noun
1275 \begin_layout Plain Layout
1276 Document\SpecialChar menuseparator
1284 adds anything in the
1285 \begin_inset Flex Noun
1288 \begin_layout Plain Layout
1294 dialog to its own built-in preamble.
1295 Before adding your own declarations in the preamble, you should make sure
1296 that \SpecialChar LyX
1297 doesn't already support what you want to do.
1298 (Remember what we said about reinventing the wheel?) Also,
1300 make sure your preamble code is correct
1304 doesn't check it for you.
1305 If there is an error, you're likely to get an error like
1306 \begin_inset Quotes eld
1310 \begin_inset Flex Code
1313 \begin_layout Plain Layout
1322 \begin_inset Quotes erd
1326 If you see this error, check your preamble.
1329 \begin_layout Subsection
1333 \begin_layout Standard
1334 Here are some examples of what you can add to a preamble, and what they
1338 \begin_layout Subsubsection
1342 \begin_layout Standard
1343 There are two variables under \SpecialChar LaTeX
1344 that control page position:
1345 \begin_inset Flex Code
1348 \begin_layout Plain Layout
1357 \begin_inset Flex Code
1360 \begin_layout Plain Layout
1369 Their names should be self-explanatory.
1370 These variables are useful if you think for a moment about computer labels.
1371 Sometimes, the size of a print medium and the area of the medium that you
1372 can actually print on aren't the same.
1374 \begin_inset Flex Code
1377 \begin_layout Plain Layout
1386 \begin_inset Flex Code
1389 \begin_layout Plain Layout
1400 \begin_layout Standard
1401 The default values for
1402 \begin_inset Flex Code
1405 \begin_layout Plain Layout
1414 \begin_inset Flex Code
1417 \begin_layout Plain Layout
1426 \begin_inset space \thinspace{}
1430 \begin_inset space \thinspace{}
1434 \begin_inset space \space{}
1437 the page isn't shifted.
1438 Unfortunately, some DVI drivers always seem to shift the page.
1439 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1440 If you're using \SpecialChar LyX
1441 on a system that you don't personally maintain, and your
1442 sysadmin is a doofus,
1443 \begin_inset Flex Code
1446 \begin_layout Plain Layout
1455 \begin_inset Flex Code
1458 \begin_layout Plain Layout
1467 Suppose your left and top margins are always 0.5
1468 \begin_inset space \thinspace{}
1472 You can add this to the preamble:
1475 \begin_layout LyX-Code
1483 \begin_layout LyX-Code
1491 \begin_layout Standard
1492 and your margins should now be correct.
1495 \begin_layout Subsubsection
1499 \begin_layout Standard
1500 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1501 There's a rather nice package, available at your nearest CTAN archive,
1502 for printing sheets of labels:
1503 \begin_inset Flex Code
1506 \begin_layout Plain Layout
1513 Now, your system may not have this package installed by default.
1514 We leave that up to you to check.
1515 You'll also want to read the documentation for it; we're not going to do
1517 Since this is an example, however, we'll give you an example of how you
1521 \begin_layout Standard
1522 First, make sure you're using the
1523 \begin_inset Flex Code
1526 \begin_layout Plain Layout
1533 Next, you need to put the following in your preamble:
1536 \begin_layout LyX-Code
1542 \begin_layout LyX-Code
1548 \begin_layout LyX-Code
1554 \begin_layout LyX-Code
1560 \begin_layout LyX-Code
1566 \begin_layout LyX-Code
1572 \begin_layout LyX-Code
1578 \begin_layout Standard
1579 This sets things up for Avery label sheets, stock #5360.
1580 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1583 \begin_inset Flex Code
1586 \begin_layout Plain Layout
1595 \begin_inset Flex Code
1598 \begin_layout Plain Layout
1606 around each label text.
1607 This and other special features of
1608 \begin_inset Flex Code
1611 \begin_layout Plain Layout
1617 are explained in its documentation.
1620 \begin_layout Standard
1621 Someday, someone may write a \SpecialChar LyX
1622 layout file to support this package directly.
1623 Maybe that someone is you.
1626 \begin_layout Subsubsection
1627 Example #3: Paragraph Indentation
1630 \begin_layout Standard
1631 Americans are trained to indent the first line of
1636 As with all of their other weird quirks, most Americans will whine and
1637 moan until they can have their way and indent the first line of all paragraphs.
1646 \begin_layout Standard
1647 Of course, this behavior isn't standard typography.
1648 In books, you typically only indent the first line of a paragraph
1652 it follows another one.
1653 The idea behind indenting the first line of a paragraph is to distinguish
1654 neighboring paragraphs from one another.
1655 If there is no previous paragraph—for example, if it follows a figure or
1656 is the first paragraph in a section—then there is no need for indentation.
1660 \begin_layout Standard
1661 If you're a typical American (we're still joking!), though, you don't care
1662 about such esoteric things; you want your indentation! Add this to the
1666 \begin_layout LyX-Code
1669 usepackage{indentfirst}
1672 \begin_layout Standard
1673 If your \SpecialChar TeX
1674 distribution isn't braindead, you'll have this package, and all
1675 of your paragraphs will get the indentation the Founding Fathers intended
1679 \begin_layout Subsubsection
1680 Example #4: This Document
1683 \begin_layout Standard
1684 You can also check out the preamble of this document to get an idea of some
1685 of the advanced things you can do.
1688 \begin_layout Section
1690 and \SpecialChar LaTeX
1694 \begin_layout Standard
1695 When \SpecialChar LyX
1696 calls \SpecialChar LaTeX
1697 , it tells \SpecialChar LaTeX
1698 to blithely ignore any errors and keep going.
1699 It then uses the logfile from the \SpecialChar LaTeX
1700 run to do a post-mortem.
1701 After analyzing the logfile, \SpecialChar LyX
1702 displays a dialog listing the errors.
1703 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1705 where the error occurred.
1709 \begin_layout Plain Layout
1711 Analyzing the logfile is a tough job, and \SpecialChar LyX
1712 doesn't always go to the right
1714 There are also cases where \SpecialChar LaTeX
1715 reports the error on one line, but the actual
1717 This is not unlike forgetting a closing brace in a program: You'll get
1718 an error, but only later.
1726 \begin_layout Standard
1727 Some folks also like to look at the log file directly: It is available from
1729 \begin_inset Flex Noun
1732 \begin_layout Plain Layout
1733 Document\SpecialChar menuseparator
1735 \begin_inset space ~
1744 There are some fairly common error messages and warnings.
1745 We'll cover those here.
1746 You should look at a good \SpecialChar LaTeX
1747 book for a complete listing.
1750 \begin_layout Itemize
1751 \begin_inset Flex Code
1754 \begin_layout Plain Layout
1761 \begin_inset Newline newline
1764 Anything beginning with these words is a warning message for the purpose
1766 \begin_inset Quotes eld
1770 \begin_inset Quotes erd
1773 the \SpecialChar LaTeX
1775 You'll get messages like this if you added or changed cross-references
1776 or bibliography entries, in which case, \SpecialChar LaTeX
1777 is trying to tell you that you
1778 need to make another run.
1779 You can by-and-large ignore these.
1782 \begin_layout Itemize
1783 \begin_inset Flex Code
1786 \begin_layout Plain Layout
1793 \begin_inset Newline newline
1796 Another warning message, this time about fonts which \SpecialChar LaTeX
1798 The rest of the message will often say something about a replacement font
1799 that \SpecialChar LaTeX
1801 You can safely ignore these, too.
1804 \begin_layout Itemize
1805 \begin_inset Flex Code
1808 \begin_layout Plain Layout
1817 \begin_inset Newline newline
1826 It seems to generate at least one of these messages for just about any
1828 They are warnings about lines that were too long and run past the right
1830 This happens if \SpecialChar LaTeX
1831 does not find a reasonable way to break the lines (notoriously
1832 often with typewriter font, since this does not allow for automatic break
1834 In many cases, this is unnoticeable in the final output.
1835 (It can be just a point or two.) Sometimes, however, the lines run rather
1836 visibly into the margin; something you will not want to have in your final
1839 \begin_inset Newline newline
1842 There are several global ways to try to minimize the overfull lines.
1845 Enable micro-typographic extensions
1849 Document\SpecialChar menuseparator
1850 Settings\SpecialChar menuseparator
1853 might already improve things a lot.
1854 Furthermore, \SpecialChar LaTeX
1855 code such as the following in
1857 Document\SpecialChar menuseparator
1858 Settings\SpecialChar menuseparator
1861 usually reduces the overfull lines drastically (we use this in the preamble
1866 \begin_layout LyX-Code
1870 \begin_inset Newline newline
1876 \begin_inset Newline newline
1881 emergencystretch 1.5em
1882 \begin_inset Newline newline
1890 \begin_layout Standard
1891 In some cases, however, you eventually have to rewrite the text to get the
1892 line breaking right.
1896 \begin_layout Plain Layout
1897 For more information, see
1898 \begin_inset Flex URL
1901 \begin_layout Plain Layout
1903 http://www.tex.ac.uk/FAQ-overfull.html
1916 \begin_layout Standard
1917 In any case, you should check the respective lines, at least for the final
1918 version of your document.
1919 Your eyes will tell you if there's a problem with something that's too
1924 \begin_layout Plain Layout
1925 You can also enable the `draft' option in
1926 \begin_inset Flex Noun
1929 \begin_layout Plain Layout
1930 Document\SpecialChar menuseparator
1936 , and then \SpecialChar LaTeX
1937 will draw a black box in the margin of lines that are overfull.
1946 \begin_layout Itemize
1947 \begin_inset Flex Code
1950 \begin_layout Plain Layout
1959 \begin_inset Newline newline
1962 Not quite as common as its cousin.
1963 This happens again if \SpecialChar LaTeX
1964 does not find a reasonable break point and consequently
1965 generates too loose lines.
1966 As with the overfull lines, you should check if this is a visible problem.
1969 \begin_layout Itemize
1970 \begin_inset Flex Code
1973 \begin_layout Plain Layout
1982 \begin_inset Flex Code
1985 \begin_layout Plain Layout
1994 \begin_inset Newline newline
1997 Warnings about troubles breaking the page.
1998 Once again, just look at the output.
1999 Your eyes will tell you where something has gone wrong.
2002 \begin_layout Itemize
2003 \begin_inset Flex Code
2006 \begin_layout Plain Layout
2008 \begin_inset Quotes els
2012 \begin_inset Quotes ers
2021 \begin_inset Newline newline
2025 \begin_inset Quotes eld
2029 \begin_inset Quotes erd
2032 isn't installed on this system.
2033 This usually appears because some package your document needs isn't installed.
2034 If you didn't touch the preamble or didn't use the
2035 \begin_inset Flex Code
2038 \begin_layout Plain Layout
2046 command, then one of the packages \SpecialChar LyX
2047 tried to load is missing.
2049 \begin_inset Flex Noun
2052 \begin_layout Plain Layout
2053 Help\SpecialChar menuseparator
2060 to get a list of packages that \SpecialChar LyX
2062 This file is updated whenever you reconfigure \SpecialChar LyX
2064 \begin_inset Flex Noun
2067 \begin_layout Plain Layout
2068 Tools\SpecialChar menuseparator
2074 ) and tells you which packages have been detected and what they do.
2075 \begin_inset Newline newline
2079 \begin_inset Flex Code
2082 \begin_layout Plain Layout
2090 command and the package in question isn't installed, then you'll need to
2091 install it yourself.
2094 \begin_layout Itemize
2095 \begin_inset Flex Code
2098 \begin_layout Plain Layout
2099 LaTeX Error: Unknown option
2105 \begin_inset Newline newline
2108 Error messages beginning with this are trying to tell you that you specified
2109 a bad or undefined option to a package.
2110 Check the package's documentation.
2113 \begin_layout Itemize
2114 \begin_inset Flex Code
2117 \begin_layout Plain Layout
2118 Undefined control sequence
2124 \begin_inset Newline newline
2127 If you've inserted \SpecialChar LaTeX
2128 code into your document, but made a typo, you'll get
2130 You may have forgotten to load a package.
2131 In any case, this error message usually means that you used an undefined
2136 \begin_layout Standard
2137 There are other error and warning messages.
2138 Some are self-explanatory.
2139 These are usually \SpecialChar LaTeX
2141 Others are downright cryptic.
2142 These are usually \SpecialChar TeX
2143 error messages, and we really have
2147 what they mean or how to decipher them.
2151 \begin_layout Standard
2152 There's a general sequence you should follow if you get error messages:
2155 \begin_layout Enumerate
2156 Look at the \SpecialChar LaTeX
2157 code you inserted for typos.
2160 \begin_layout Enumerate
2161 If there are no typos, check that you used the command(s) correctly.
2164 \begin_layout Enumerate
2165 If you get a bunch of error boxes piled up at the very top of the document—and
2166 especially if you see a
2167 \begin_inset Quotes eld
2171 \begin_inset Flex Code
2174 \begin_layout Plain Layout
2183 \begin_inset Quotes erd
2186 error—it means that there are errors in the preamble.
2187 Start debugging your preamble.
2190 \begin_layout Enumerate
2191 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2193 document, the first suspect is your \SpecialChar LaTeX
2194 distribution itself.
2195 Check for missing packages and install them.
2198 \begin_layout Enumerate
2199 Okay, so there are no missing packages.
2200 Did you use any of the fine-tuning options in \SpecialChar LyX
2201 ? Specifically, did you
2205 any of them, like trying to manually insert lots of
2206 \begin_inset Flex Code
2209 \begin_layout Plain Layout
2211 \begin_inset space ~
2220 \begin_inset Flex Code
2223 \begin_layout Plain Layout
2230 \begin_inset Flex Code
2233 \begin_layout Plain Layout
2239 ? Did you try to kludge something together with these instead of using the
2240 appropriate paragraph environment?
2243 \begin_layout Enumerate
2244 All right, you didn't use any of the fine-tuning options, you played by
2246 Did you try to pull a fancy maneuver? Did you do something funky inside
2247 a table or an equation, like inserting a graphic into a table cell?
2250 \begin_layout Enumerate
2251 Do you have long sections of text where \SpecialChar LaTeX
2252 cannot find a place to break a
2253 line? By default, \SpecialChar LaTeX
2254 is rather strict about how much extra inter-word spacing
2255 it will add in order to break a line.
2256 Preferably, you should rework the paragraph to avoid the problem.
2259 \begin_layout Enumerate
2260 Did you go overboard with the nesting? \SpecialChar LyX
2261 (currently) doesn't check to make
2262 sure you're in the limits for nesting environments.
2263 If you nested a bunch of environments to the
2264 \begin_inset Formula $17^{\mathrm{th}}$
2267 level, that's the problem.
2268 (The limit in \SpecialChar LaTeX
2272 \begin_layout Enumerate
2273 Okay, you didn't get any error messages, but your output looks awful.
2274 If you have a table or figure that's too wide or long for the page, you
2279 \begin_layout Enumerate
2280 rescale the figure so it fits.
2283 \begin_layout Enumerate
2284 trim down the table so it fits.
2288 \begin_layout Enumerate
2289 If something else is wrong with the output, and you didn't try to pull anything
2290 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2293 \begin_layout Standard
2294 If all this doesn't help—well, then
2298 you might have found a bug in \SpecialChar LyX
2303 \begin_layout Chapter
2307 \begin_layout Section
2308 Customizing Bibliographies with Bib\SpecialChar TeX
2312 \begin_layout Standard
2313 The most basic information about how to use Bib\SpecialChar TeX
2318 with \SpecialChar LyX
2319 is contained in the section
2321 Bibliography databases
2328 The following subsections explain special bibliography features supported
2333 \begin_layout Subsection
2334 Alternative Citation Styles
2337 \begin_layout Standard
2338 Standard Bib\SpecialChar TeX
2340 \begin_inset space \thinspace{}
2344 \begin_inset space \space{}
2348 \begin_inset Quotes eld
2352 \begin_inset Quotes erd
2355 ) to refer to a cited work.
2356 However, in many scientific disciplines, other citation styles are in use.
2357 The most common one is the author-year style (e.
2358 \begin_inset space \thinspace{}
2362 \begin_inset space \space{}
2366 \begin_inset Quotes eld
2370 \begin_inset Quotes erd
2375 supports three packages that provide this style,
2376 \begin_inset Flex Code
2379 \begin_layout Plain Layout
2386 \begin_inset Flex Code
2389 \begin_layout Plain Layout
2396 \begin_inset Flex Code
2399 \begin_layout Plain Layout
2406 Each of these packages has their pros and cons, which cannot be listed
2408 If you only want to have simple author-year (or author-numerical) style,
2409 or if you want to use one of the countless style files for
2410 \begin_inset Flex Code
2413 \begin_layout Plain Layout
2419 , then the established
2420 \begin_inset Flex Code
2423 \begin_layout Plain Layout
2429 package is probably your choice.
2430 If you look for specific citation styles common in law studies, you might
2432 \begin_inset Flex Code
2435 \begin_layout Plain Layout
2442 If you want to have full control over the formatting or look for advanced
2443 features such as ibidem, footnote citations, full title citations, advanced
2444 date formats (such as 400 BC) or full localization to other languages than
2445 English, you should definitely consider
2446 \begin_inset Flex Code
2449 \begin_layout Plain Layout
2455 , which exceeds all other packages in terms of features, but is also quite
2456 heavy and more resource-hungry.
2459 \begin_layout Standard
2460 The handling of these packages in \SpecialChar LyX
2461 is basically the same.
2463 \begin_inset Flex Noun
2466 \begin_layout Plain Layout
2467 Document\SpecialChar menuseparator
2474 \begin_inset Flex Noun
2477 \begin_layout Plain Layout
2484 \begin_inset Flex Noun
2487 \begin_layout Plain Layout
2494 \begin_inset Flex Noun
2497 \begin_layout Plain Layout
2504 \begin_inset Flex Noun
2507 \begin_layout Plain Layout
2514 \begin_inset Flex Noun
2517 \begin_layout Plain Layout
2518 Biblatex (Natbib mode)
2524 \begin_inset Flex Noun
2527 \begin_layout Plain Layout
2534 \begin_inset Flex Noun
2537 \begin_layout Plain Layout
2544 \begin_inset space ~
2547 6.5.3 in the User's Guide for more information on these choices).
2548 With all these packages, you will get some extra features in the citation
2549 dialog and you can select the style of the reference (
2550 \begin_inset Quotes eld
2554 \begin_inset Quotes erd
2558 \begin_inset Quotes eld
2562 \begin_inset Quotes erd
2566 \begin_inset Quotes eld
2570 \begin_inset Quotes erd
2574 \begin_inset Quotes eld
2578 \begin_inset Quotes erd
2582 Note that either package needs specifically designed style files.
2583 They all ship their own, but there are lots of additional style files,
2584 and there is even an interactive style file builder
2588 \begin_layout Plain Layout
2590 \begin_inset Flex URL
2593 \begin_layout Plain Layout
2595 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2606 \begin_inset Flex Code
2609 \begin_layout Plain Layout
2618 \begin_layout Subsection
2619 Subdivided Bibliographies
2622 \begin_layout Standard
2623 Sometimes you might need to divide your bibliography into several sections.
2624 If you are for instance a historian, the possibility to separate sources
2625 and scientific works is most likely a
2626 \begin_inset Quotes eld
2630 \begin_inset Quotes erd
2634 Unfortunately, Bib\SpecialChar TeX
2635 itself does not allow you to do this.
2636 But with the help of some \SpecialChar LaTeX
2637 packages, Bib\SpecialChar TeX
2638 can be extended to fit your needs.
2641 \begin_layout Standard
2643 provides native support for one of these packages,
2651 \begin_layout Plain Layout
2653 \begin_inset Flex URL
2656 \begin_layout Plain Layout
2658 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2668 The advantage of this package (compared to other packages such as
2672 ) is that you don't need to define new citation commands.
2673 Instead, you need to prepare different bibliographic databases which include
2674 the entries for the different sections of the bibliography.
2675 For example: If you want to divide your bibliography into the sections
2677 \begin_inset Quotes eld
2681 \begin_inset Quotes erd
2685 \begin_inset Quotes eld
2689 \begin_inset Quotes erd
2692 , you first need to create two bibliographic databases, e.
2693 \begin_inset space \thinspace{}
2697 \begin_inset space \space{}
2701 \begin_inset Flex Code
2704 \begin_layout Plain Layout
2711 \begin_inset Flex Code
2714 \begin_layout Plain Layout
2724 \begin_layout Standard
2726 \begin_inset Flex Noun
2729 \begin_layout Plain Layout
2730 Document\SpecialChar menuseparator
2737 \begin_inset Flex Noun
2740 \begin_layout Plain Layout
2747 \begin_inset Flex Noun
2750 \begin_layout Plain Layout
2751 Subdivided bibliography
2757 Now you can insert multiple Bib\SpecialChar TeX
2758 bibliographies, one for each section of
2760 Returning to our example: Insert the Bib\SpecialChar TeX
2762 \begin_inset Flex Code
2765 \begin_layout Plain Layout
2771 and a second one for the database
2772 \begin_inset Flex Code
2775 \begin_layout Plain Layout
2782 You are free to use the same or different styles for each section.
2783 Additionally, you can choose if the bibliography section should contain
2785 \begin_inset Quotes eld
2788 all cited references
2789 \begin_inset Quotes erd
2792 of the specified database(s) (which is the default),
2793 \begin_inset Quotes eld
2796 all uncited references
2797 \begin_inset Quotes erd
2801 \begin_inset Quotes eld
2805 \begin_inset Quotes erd
2809 This might be useful if you would like to separate your bibliography into
2811 \begin_inset Quotes eld
2815 \begin_inset Quotes erd
2819 \begin_inset Quotes eld
2823 \begin_inset Quotes erd
2827 \begin_inset Quotes eld
2831 \begin_inset Quotes erd
2835 The titles for the sections can be added as ordinary sections or subsections.
2837 \begin_inset Flex Code
2840 \begin_layout Plain Layout
2846 removes the bibliography title, you have to manually re-add that, too (as
2847 a chapter* or section*, for instance).
2850 \begin_layout Standard
2855 , the procedure is a bit different.
2864 , the aforementioned
2865 \begin_inset Flex Noun
2868 \begin_layout Plain Layout
2869 Subdivided bibliography
2874 option is disabled if you use
2883 provides its own means to generate subdivided bibliographies.
2884 You can either add keywords to bibliography entries via the
2885 \begin_inset Flex Code
2888 \begin_layout Plain Layout
2894 entry option and then filter bibliography sections by keyword (by adding
2896 \begin_inset Flex Code
2899 \begin_layout Plain Layout
2906 \begin_inset Flex Noun
2909 \begin_layout Plain Layout
2915 field of the dialog that opens if you left-click on the
2916 \begin_inset Flex Noun
2919 \begin_layout Plain Layout
2920 Biblatex Generated Bibliography
2925 button), or you can filter by entry types (such as
2934 \begin_inset space \thinspace{}
2939 \begin_inset Flex Code
2942 \begin_layout Plain Layout
2949 \begin_inset Flex Code
2952 \begin_layout Plain Layout
2959 \begin_inset Flex Noun
2962 \begin_layout Plain Layout
2968 field, or you can create so-called
2969 \begin_inset Quotes eld
2972 Bibliography Categories
2973 \begin_inset Quotes erd
2976 to which you can assign individual entries.
2977 Please refer to the Biblatex manual, section
2979 Subdivided Bibliographies
2984 \begin_layout Subsection
2985 Multiple Bibliographies
2986 \begin_inset CommandInset label
2988 name "subsec:Multiple-Bibliographies"
2995 \begin_layout Standard
2996 Multiple bibliographies, e.
2997 \begin_inset space \thinspace{}
3001 \begin_inset space \space{}
3004 a bibliography for each part, chapter, section, subsection or child (sub-documen
3005 t) of the document, are also supported by \SpecialChar LyX
3007 In order to enable it, go to
3008 \begin_inset Flex Noun
3011 \begin_layout Plain Layout
3012 Document\SpecialChar menuseparator
3013 Settings\SpecialChar menuseparator
3019 and select the relevant unit (e.
3020 \begin_inset space \thinspace{}
3024 \begin_inset Quotes eld
3028 \begin_inset Quotes erd
3032 \begin_inset Flex Noun
3035 \begin_layout Plain Layout
3036 Multiple Bibliographies
3042 Then add a Bib(la)\SpecialChar TeX
3043 bibliography to each unit (e.
3044 \begin_inset space \thinspace{}
3047 g., section) of your document.
3048 In the output, a separate bibliography, containing only the references
3049 done in the current unit is generated.
3052 \begin_layout Standard
3053 If you use Bib\SpecialChar TeX
3055 \begin_inset Flex Code
3058 \begin_layout Plain Layout
3065 \begin_inset Flex Code
3068 \begin_layout Plain Layout
3074 package is used to create multiple bibliographies.
3075 The former package is used if you select
3076 \begin_inset Quotes eld
3080 \begin_inset Quotes erd
3088 \begin_inset Flex Noun
3091 \begin_layout Plain Layout
3092 Sectioned Bibliography
3099 \begin_inset Flex Code
3102 \begin_layout Plain Layout
3112 \begin_layout Plain Layout
3113 An alternative approach, if you are willing to use some
3114 \begin_inset Flex Noun
3117 \begin_layout Plain Layout
3125 \begin_inset space ~
3129 \begin_inset CommandInset ref
3131 reference "sec:Inserting-TeX-Code"
3136 \begin_inset Flex Code
3139 \begin_layout Plain Layout
3151 \begin_inset Flex Code
3154 \begin_layout Plain Layout
3160 is used, \SpecialChar LyX
3161 encloses the specified units in
3162 \begin_inset Flex Code
3165 \begin_layout Plain Layout
3172 \begin_inset Flex Code
3175 \begin_layout Plain Layout
3184 \begin_inset Flex Code
3187 \begin_layout Plain Layout
3195 in order to create the units.
3196 Note that this approach has some limitations.
3197 First, every citation reference has to be inside some
3198 \begin_inset Flex Code
3201 \begin_layout Plain Layout
3208 So citations outside a defined unit (e.
3209 \begin_inset space \thinspace{}
3212 g., before the first section if you use
3213 \begin_inset Quotes eld
3217 \begin_inset Quotes erd
3221 \begin_inset Quotes eld
3225 \begin_inset Quotes erd
3229 You can also create your own units by entering
3230 \begin_inset Flex Code
3233 \begin_layout Plain Layout
3242 \begin_inset Flex Code
3245 \begin_layout Plain Layout
3254 code (for instance to work around the mentioned limitation).
3256 \begin_inset Flex Code
3259 \begin_layout Plain Layout
3266 A second limitation is that
3267 \begin_inset Flex Code
3270 \begin_layout Plain Layout
3276 always processes all references of a bibliography database, even if they
3278 This can result in odd labels (e.
3279 \begin_inset space \thinspace{}
3284 \begin_inset Quotes eld
3288 \begin_inset Quotes erd
3291 if two works of this author from 2014 are in the database, even if only
3295 \begin_layout Standard
3301 \begin_inset Flex Code
3304 \begin_layout Plain Layout
3310 option is used instead.
3311 If you need specific units, you can start them with the \SpecialChar TeX
3313 \begin_inset Flex Code
3316 \begin_layout Plain Layout
3325 \begin_inset Flex Code
3328 \begin_layout Plain Layout
3337 If you also want to control the end of the unit, use the environment
3338 \begin_inset Flex Code
3341 \begin_layout Plain Layout
3351 \begin_inset Flex Code
3354 \begin_layout Plain Layout
3364 \begin_inset Flex Code
3367 \begin_layout Plain Layout
3374 In addition to the individual bibliography of the current unit,
3378 also provides an easy way to output all bibliographies, subsequently, at
3380 \begin_inset space \thinspace{}
3383 g., at the end of the document).
3385 \begin_inset Quotes eld
3389 \begin_inset Quotes erd
3392 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
3398 manual for more information on this topic.
3401 \begin_layout Section
3405 \begin_layout Subsection
3409 \begin_layout Standard
3410 When you are working on a large file with many sections, it is often convenient
3411 to break up the document into several files, or perhaps you have something
3412 where a table may change from time to time, but the preceding text does
3414 In these cases, you should seriously consider using multipart documents.
3415 For example, scientific papers often have five major sections: the introduction
3416 , observations, results, discussion, and conclusion.
3417 Each of these could be its own separate \SpecialChar LyX
3419 \begin_inset Quotes eld
3423 \begin_inset Quotes erd
3426 file which contains the title, authors, abstract, references, etc., plus
3427 the five included files.
3428 It is important to note that each of these files is a full \SpecialChar LyX
3430 can be formatted and printed on its own, as well as included in a master
3432 Each of these files must have the same document class, however—don't attempt
3433 to mix book classes with article classes.
3434 You may also include \SpecialChar LaTeX
3435 files; however, these files must not have their own
3437 \begin_inset space \thinspace{}
3441 \begin_inset space \space{}
3444 everything up to and including the
3445 \begin_inset Flex Code
3448 \begin_layout Plain Layout
3457 \begin_inset Flex Code
3460 \begin_layout Plain Layout
3468 line must be deleted) or else errors will be generated when you try to
3472 \begin_layout Standard
3474 allows you to include files quite easily with
3475 \begin_inset Flex Noun
3478 \begin_layout Plain Layout
3479 Insert\SpecialChar menuseparator
3481 \begin_inset space ~
3490 When you click on this selection a small box is inserted into the file
3491 at the current cursor location.
3492 Clicking on the box raises a dialog which allows you to select the file
3493 to be included, and the method of its inclusion.
3497 \begin_layout Standard
3498 The file selection box should by now be obvious.
3499 The three inclusion methods are
3500 \begin_inset Quotes eld
3504 \begin_inset Quotes erd
3508 \begin_inset Quotes eld
3512 \begin_inset Quotes erd
3516 \begin_inset Quotes eld
3520 \begin_inset Quotes erd
3525 \begin_inset Quotes eld
3529 \begin_inset Quotes erd
3533 \begin_inset Quotes eld
3537 \begin_inset Quotes erd
3540 are similar in many ways, but there are also some notable differences:
3543 \begin_layout Enumerate
3545 \begin_inset Quotes eld
3549 \begin_inset Quotes erd
3552 are typeset beginning on a new page, while files that are
3553 \begin_inset Quotes eld
3557 \begin_inset Quotes erd
3560 are typeset starting on the current page.
3563 \begin_layout Enumerate
3564 \begin_inset Quotes eld
3568 \begin_inset Quotes erd
3571 files cannot themselves
3572 \begin_inset Quotes eld
3576 \begin_inset Quotes erd
3580 \begin_inset Quotes eld
3584 \begin_inset Quotes erd
3589 \begin_inset Quotes eld
3593 \begin_inset Quotes erd
3596 , on the other hand, infinite sub-inputting is possible.
3599 \begin_layout Enumerate
3600 \begin_inset Quotes eld
3604 \begin_inset Quotes erd
3607 allow for the output of only selected
3608 \begin_inset Quotes eld
3612 \begin_inset Quotes erd
3615 files, while maintaining the actual counters (pagination etc.) and references
3616 (please refer to the section
3619 \begin_inset space ~
3627 \begin_inset space ~
3632 manual for details).
3635 \begin_layout Standard
3637 \begin_inset Quotes eld
3641 \begin_inset Quotes erd
3644 is the preferred method for chapters that are outsourced to child documents,
3646 \begin_inset Quotes eld
3650 \begin_inset Quotes erd
3653 is more suitable for arbitrary file inheritance.
3656 \begin_layout Standard
3658 \begin_inset Quotes eld
3662 \begin_inset Quotes erd
3665 included file allows you to include a file typeset exactly as it appears
3667 \begin_inset space \thinspace{}
3671 \begin_inset space \space{}
3675 \begin_inset Flex Code
3678 \begin_layout Plain Layout
3684 mode, with the characters set in a fixed-width typewriter font.
3685 Normally, spaces in this file are invisible, though two consecutive spaces
3686 are conserved, unlike \SpecialChar LyX
3687 's normal treatment of spaces.
3688 However, setting the
3689 \begin_inset Flex Noun
3692 \begin_layout Plain Layout
3694 \begin_inset space ~
3698 \begin_inset space ~
3702 \begin_inset space ~
3710 checkbox typesets a mark to unambiguously define the presence of a space.
3714 \begin_layout Standard
3715 Generally, the master file is converted into a full \SpecialChar LaTeX
3716 file before typesetting,
3717 while the included files are converted to \SpecialChar LaTeX
3718 files that do not have all the
3719 preamble information.
3722 \begin_layout Subsection
3723 Cross-References Between Files
3726 \begin_layout Standard
3727 \begin_inset Box Shadowbox
3737 height_special "totalheight"
3742 backgroundcolor "none"
3745 \begin_layout Plain Layout
3746 This section is somewhat out of date.
3747 Need to describe default master documents and how children are opened when
3757 \begin_layout Standard
3758 It is possible to set up cross-references between the different files.
3759 First, open all the files in question: let's call them A and B in a two
3760 file example, where B is included in A.
3761 Let's say you insert a label in A, then want to reference it in B.
3762 Open the cross-reference dialog whilst in document B, and you can select
3764 \begin_inset Quotes eld
3768 \begin_inset Quotes erd
3774 \begin_layout Subsection
3775 Bibliography Lists in all Subdocuments
3778 \begin_layout Standard
3779 If you work with child documents, you might want to have only one main bibliogra
3780 phy at the end, but still be able to have a selected bibliography for the
3781 child if you output it on its own.
3782 Here is how to achieve this.
3785 \begin_layout Standard
3786 For the main document, you just insert a bibliography inset at the place
3787 where the main bibliography has to appear (within the master file or within
3789 If the bibliography inset is in the master file, the references will be
3790 inherited by all children, so they are available in the citation dialog
3794 \begin_layout Standard
3795 For child-specific bibliographies, insert bibliography insets within the
3796 child documents, at the place where the bibliography should appear when
3797 the child is compiled separately.
3798 However, the trick is to insert them into a branch (
3800 Insert\SpecialChar menuseparator
3801 Branch\SpecialChar menuseparator
3802 Insert New Branch...
3805 \begin_inset space \thinspace{}
3810 \begin_inset Quotes eld
3814 \begin_inset Quotes erd
3818 Within the children, activate the branch (
3820 Document\SpecialChar menuseparator
3821 Settings...\SpecialChar menuseparator
3825 Within the master, deactivate the branch (
3827 Document\SpecialChar menuseparator
3828 Settings...\SpecialChar menuseparator
3832 Now the child's bibliography will be ignored by the master, but considered
3836 \begin_layout Standard
3837 If you need multiple bibliographies (e.
3838 \begin_inset space \thinspace{}
3841 g., one per child in the
3845 ), please refer to sec.
3846 \begin_inset space ~
3850 \begin_inset CommandInset ref
3852 reference "subsec:Multiple-Bibliographies"
3859 \begin_layout Section
3864 \begin_layout Standard
3865 Users sometimes need to be able to
3866 \begin_inset Quotes eld
3870 \begin_inset Quotes erd
3874 file together with all the images (and other files) on which it depends,
3875 either for sending to a publisher or for sharing with a co-author.
3877 includes a Python script (
3878 \begin_inset Flex Code
3881 \begin_layout Plain Layout
3887 ) that automates this process.
3888 To use it, you must have either the
3889 \begin_inset Flex Code
3892 \begin_layout Plain Layout
3899 \begin_inset Flex Code
3902 \begin_layout Plain Layout
3908 python modules installed on your system.
3909 By default, the script prefers the
3910 \begin_inset Flex Code
3913 \begin_layout Plain Layout
3920 \begin_inset Flex Code
3923 \begin_layout Plain Layout
3929 format on Unix-like systems and the
3930 \begin_inset Flex Code
3933 \begin_layout Plain Layout
3942 \begin_layout Standard
3944 's configuration process will set the script up to export a `\SpecialChar LyX
3946 and this format will then be available under
3947 \begin_inset Flex Code
3950 \begin_layout Plain Layout
3951 File\SpecialChar menuseparator
3960 \begin_layout Standard
3961 Independently of the platform, the generation of a particular archive format
3962 can be forced by adding either the
3963 \begin_inset Flex Code
3966 \begin_layout Plain Layout
3973 \begin_inset Flex Code
3976 \begin_layout Plain Layout
3983 \begin_inset Flex Code
3986 \begin_layout Plain Layout
3993 \begin_inset Flex Code
3996 \begin_layout Plain Layout
4002 format) switch to the
4003 \begin_inset Flex Code
4006 \begin_layout Plain Layout
4008 \SpecialChar menuseparator
4016 \begin_inset Flex Code
4019 \begin_layout Plain Layout
4020 Tools\SpecialChar menuseparator
4021 Preferences\SpecialChar menuseparator
4022 File Handling\SpecialChar menuseparator
4029 (Make sure you add the switch after the script name, not before it.)
4032 \begin_layout Section
4033 Fancy Headers and Footers
4036 \begin_layout Standard
4037 The default page layout is rather plain; for an
4038 \begin_inset Flex Code
4041 \begin_layout Plain Layout
4047 document class, all you get is a centered page number at the bottom of
4049 This document uses KOMA-script's book class, so it appears to be a bit
4051 But to really put on a show, you need to set the document page style to
4053 \begin_inset Quotes eld
4057 \begin_inset Quotes erd
4060 , as mentioned in the
4065 This section describes the \SpecialChar LaTeX
4066 code you need to insert in your \SpecialChar LaTeX
4068 order to get the desired effects.
4071 \begin_layout Standard
4072 For more information on fancy headers, see the
4073 \begin_inset Flex Code
4076 \begin_layout Plain Layout
4082 package documentation.
4084 \begin_inset Flex URL
4087 \begin_layout Plain Layout
4089 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
4097 \begin_layout Standard
4098 The page header is divided into three fields, not surprisingly labeled
4099 \begin_inset Quotes eld
4103 \begin_inset Quotes erd
4107 \begin_inset Quotes eld
4111 \begin_inset Quotes erd
4115 \begin_inset Quotes eld
4119 \begin_inset Quotes erd
4123 The footer is also divided into these three fields.
4124 The \SpecialChar LaTeX
4125 commands to set these fields in the simplest manner are
4126 \begin_inset Flex Code
4129 \begin_layout Plain Layout
4138 \begin_inset Flex Code
4141 \begin_layout Plain Layout
4150 \begin_inset Flex Code
4153 \begin_layout Plain Layout
4162 \begin_inset Flex Code
4165 \begin_layout Plain Layout
4174 Suppose you wish to put your name in the upper left hand corner of each
4176 Simply insert the following command in the preamble:
4179 \begin_layout Standard
4188 \begin_layout Standard
4189 You will now see your name in the upper left.
4190 If a field has a default entry that you would like to get rid of (often
4191 the page number appears in the central footer) simply include a command
4192 with a blank argument, e.
4193 \begin_inset space \thinspace{}
4199 \begin_layout Standard
4207 \begin_layout Standard
4208 Let's get really fancy: lets put the section number with the word
4209 \begin_inset Quotes eld
4213 \begin_inset Quotes erd
4217 \begin_inset space \thinspace{}
4221 \begin_inset space \space{}
4224 Section 3) in the upper left, the page number (e.
4225 \begin_inset space \thinspace{}
4229 \begin_inset space \space{}
4232 Page 4) in the upper right, your name in the lower left, and the date in
4234 The following commands should now appear in the preamble:
4237 \begin_layout Standard
4247 \begin_layout Standard
4255 \begin_layout Standard
4265 \begin_layout Standard
4274 \begin_layout Standard
4282 \begin_layout Standard
4292 \begin_layout Standard
4294 \begin_inset Flex Code
4297 \begin_layout Plain Layout
4306 \begin_inset Flex Code
4309 \begin_layout Plain Layout
4317 access \SpecialChar LaTeX
4318 's section and page counters, and so print out the current section
4321 \begin_inset Flex Code
4324 \begin_layout Plain Layout
4332 simply prints out today's date.
4335 \begin_layout Standard
4336 The thicknesses of the horizontal rules drawn beneath the header and above
4337 the footer can also be modified.
4338 If you don't want one of the rules, set its thickness to 0.
4339 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
4345 \begin_inset Flex Code
4348 \begin_layout Plain Layout
4353 headrulewidth}{0.4pt}
4359 \begin_inset Flex Code
4362 \begin_layout Plain Layout
4367 footrulewidth}{0.4pt}
4372 to set the thicknesses.
4375 \begin_layout Standard
4376 You can switch the header/footer settings on and off for individual pages
4378 \begin_inset Flex Code
4381 \begin_layout Plain Layout
4384 thispagestyle{empty}
4390 \begin_inset Flex Code
4393 \begin_layout Plain Layout
4396 thispagestyle{plain}
4402 \begin_inset Flex Code
4405 \begin_layout Plain Layout
4408 thispagestyle{fancy}
4414 Simply insert them in the text on the page you want changed and mark them
4417 In fact, title pages are marked as plain by default, while following pages
4418 are marked fancy when using the global fancy setting.
4421 \begin_layout Standard
4422 As a final example, it is possible to include an image in the header or
4424 Suppose you want to put a company logo in the upper lefthand corner.
4425 You might try something like
4428 \begin_layout Standard
4437 includegraphics{logo.eps}}}
4440 \begin_layout Standard
4442 (you may need to preface this with
4443 \begin_inset Flex Code
4446 \begin_layout Plain Layout
4449 usepackage{graphics}
4454 if you don't include graphics elsewhere in your document).
4457 \begin_layout Section
4458 Itemize Bullet Selection
4459 \begin_inset CommandInset label
4468 \begin_layout Standard
4474 \begin_layout Subsection
4478 \begin_layout Standard
4480 provides 216 bullet shapes that can be accessed from a simple dialog.
4481 Using this dialog you can easily specify what bullet shape to use at each
4482 level of an itemized list.
4483 These settings are document-wide so you won't be able to specify different
4484 sets of bullets for different paragraphs.
4488 \begin_layout Plain Layout
4489 Well, actually you can but you'll have to do it by hand.
4497 \begin_layout Subsection
4501 \begin_layout Standard
4502 Open the dialog by selecting the
4503 \begin_inset Flex Noun
4506 \begin_layout Plain Layout
4507 Document\SpecialChar menuseparator
4513 menu item and then select the
4514 \begin_inset Flex Noun
4517 \begin_layout Plain Layout
4526 \begin_layout Standard
4527 The dialog provides you with a table of bullet shapes.
4528 A column of buttons on the left of the table provides access to the six
4529 different panels of bullet shapes.
4530 The row of buttons across the top is used to select which bullet depth
4533 \change_deleted 244031559 1603875981
4534 A text entry under the table shows the currently selected bullet shape's
4536 equivalent and this can be edited if desired.
4537 If you do modify the text you will also need to specify any needed packages
4538 in the \SpecialChar LaTeX
4544 \begin_layout Standard
4545 The six panels are divided up by the packages they require.
4546 The following table shows the mappings from button name to \SpecialChar LaTeX
4550 \begin_layout Standard
4552 \begin_inset Tabular
4553 <lyxtabular version="3" rows="7" columns="2">
4554 <features tabularvalignment="middle">
4555 <column alignment="center" valignment="top" width="0pt">
4556 <column alignment="center" valignment="top" width="0pt">
4558 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4561 \begin_layout Plain Layout
4576 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4579 \begin_layout Plain Layout
4596 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4599 \begin_layout Plain Layout
4614 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4617 \begin_layout Plain Layout
4626 base \SpecialChar LaTeX
4634 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4637 \begin_layout Plain Layout
4652 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4655 \begin_layout Plain Layout
4672 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4675 \begin_layout Plain Layout
4690 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4693 \begin_layout Plain Layout
4710 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4713 \begin_layout Plain Layout
4728 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4731 \begin_layout Plain Layout
4748 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4751 \begin_layout Plain Layout
4766 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4769 \begin_layout Plain Layout
4786 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4789 \begin_layout Plain Layout
4804 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4807 \begin_layout Plain Layout
4830 \begin_layout Standard
4832 doesn't stop you using bullets from packages you don't have.
4833 If you get errors from \SpecialChar LaTeX
4834 when you try to view or print the file, then it
4835 is likely you are missing a package.
4839 \begin_layout Plain Layout
4841 doesn't restrict your use since you may be editing locally and exporting
4850 \begin_layout Subsection
4854 \begin_layout Standard
4855 Select which bullet depth you want to change then select the bullet shape
4857 Any changes will not be visible in \SpecialChar LyX
4858 , but are visible when viewing the document.
4861 \begin_layout Standard
4862 You can reset a bullet shape to the default simply by clicking your right
4863 mouse button on the appropriate bullet depth button.
4867 \begin_layout Plain Layout
4872 want to have multiple sets of paragraphs with different sets of bullets
4873 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4875 The bullet selection dialog can help though because it provides you with
4876 the \SpecialChar LaTeX
4877 code for a wide range of bullet shapes.
4878 To make your own custom paragraphs you have the following options:
4881 \begin_layout Plain Layout
4885 \begin_layout Plain Layout
4901 \begin_layout Plain Layout
4905 \begin_layout Plain Layout
4927 \begin_layout Itemize
4928 Use the \SpecialChar LaTeX
4930 \begin_inset Flex Code
4933 \begin_layout Plain Layout
4941 to specify a new bullet shape for a given depth.
4942 You'll also need to save the current bullet shape so you can restore it
4944 In this itemized list the following \SpecialChar LaTeX
4945 code was used to change the bullet
4946 used for the first depth.
4950 \begin_layout LyX-Code
4960 \begin_layout LyX-Code
4977 \begin_layout Itemize
4978 Note that the itemize depth is specified in Roman numerals as part of the
4988 \begin_layout Itemize
4989 \begin_inset Argument item:1
4992 \begin_layout Plain Layout
4996 \begin_layout Plain Layout
5014 Specify each individual entry by starting each item with the bullet shape
5016 \begin_inset Quotes eld
5020 \begin_inset Quotes erd
5025 Insert\SpecialChar menuseparator
5029 \begin_inset Flex Noun
5032 \begin_layout Plain Layout
5040 For example, this item was started with
5041 \begin_inset Flex Code
5044 \begin_layout Plain Layout
5059 \begin_layout Plain Layout
5063 \begin_layout Plain Layout
5079 \begin_layout Plain Layout
5080 You'll also need to revert the labelitem back to its previous setting for
5081 the global bullet shape settings to remain in effect.
5082 The way used here was:
5085 \begin_layout LyX-Code
5100 \begin_layout Chapter
5102 and the World Wide Web
5105 \begin_layout Standard
5107 has long supported the export of documents to various web-friendly formats,
5109 Before version 2.0, however, HTML export was always accomplished by the
5110 use of external converters.
5114 \begin_layout Plain Layout
5115 For details on the use of external converters with \SpecialChar LyX
5120 section of the Customization manual.
5125 These fall into two large groups: there are converters that use \SpecialChar LaTeX
5127 intermediate format, such as
5128 \begin_inset Flex Code
5131 \begin_layout Plain Layout
5138 \begin_inset Flex Code
5141 \begin_layout Plain Layout
5148 \begin_inset Flex Code
5151 \begin_layout Plain Layout
5157 , relying upon \SpecialChar LyX
5158 to produce the \SpecialChar LaTeX
5159 ; and there is a converter that works directly
5162 \begin_inset Flex Code
5165 \begin_layout Plain Layout
5173 All of these have different advantages and disadvantages.
5177 \begin_layout Standard
5178 The \SpecialChar LaTeX
5179 -based converters have the advantage that, in principle, they know everythin
5180 g about the exported document that \SpecialChar LaTeX
5182 Such converters do not care, for example, if a certain block of code was
5183 produced by \SpecialChar LyX
5184 or was Evil Red Text.
5185 These converters know about
5186 \begin_inset Flex Code
5189 \begin_layout Plain Layout
5195 files, counters, and references, and can often make use of the
5196 \begin_inset Flex Code
5199 \begin_layout Plain Layout
5205 files generated by Bib\SpecialChar TeX
5207 On the other hand, \SpecialChar LaTeX
5208 is a very hard language to parse—it is sometimes said
5209 that only \SpecialChar TeX
5210 itself understands \SpecialChar TeX
5211 —and \SpecialChar LaTeX
5212 -based converters will often choke on
5213 what seem to be quite simple constructs; complex ones can throw them completely
5214 , and as of this writing, for example, the
5218 manual will not export with
5219 \begin_inset Flex Code
5222 \begin_layout Plain Layout
5228 , though the others will.
5229 The other issue concerns how math is handled.
5230 These converters typically convert the formulae into little pictures that
5231 are then linked from the HTML document.
5232 Since these are actually generated by \SpecialChar LaTeX
5233 , they are accurate.
5234 But they do not scale well, and just getting them to look as if they are
5235 actually meant to be in your document—so that the font sizes seem to be
5236 roughly the same—can be a challenge.
5239 \begin_layout Standard
5241 \begin_inset Flex Code
5244 \begin_layout Plain Layout
5252 \begin_inset CommandInset href
5254 name "http://pinchito.es/elyxer/"
5255 target "http://pinchito.es/elyxer/"
5260 ) solves some of these problems.
5261 In particular, the formulae it produces scale perfectly, since it renders
5262 math using a combination of HTML and CSS rather than converting the formulae
5264 But even moderately complex formula are rendered less well than with
5265 \begin_inset Flex Code
5268 \begin_layout Plain Layout
5274 ; this reflects the limitations of HTML.
5278 \begin_layout Plain Layout
5280 \begin_inset Flex Code
5283 \begin_layout Plain Layout
5290 can also use jsMath and MathJax for equations, but this setting is only
5291 available globally and requires one to have access to a server that runs
5297 More importantly (as of version 1.1.1, at least),
5298 \begin_inset Flex Code
5301 \begin_layout Plain Layout
5308 has limited support for math macros and no support for user-defined paragraph
5309 or character styles.
5310 These limitations make
5311 \begin_inset Flex Code
5314 \begin_layout Plain Layout
5321 unsuitable for many of the documents \SpecialChar LyX
5323 In principle, of course, these problems could be solved, but the \SpecialChar LyX
5325 have decided to follow a different path and have made \SpecialChar LyX
5327 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
5328 , DocBook, and plaintext.
5331 \begin_layout Standard
5332 As of this writing, XHTML output remains under development and should probably
5334 \begin_inset Quotes eld
5338 \begin_inset Quotes erd
5345 \begin_layout Plain Layout
5347 \begin_inset Flex Code
5350 \begin_layout Plain Layout
5351 development/HTML/HTML.notes
5356 , which can be found in the \SpecialChar LyX
5358 \begin_inset CommandInset href
5360 name "accessed online"
5361 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
5366 , usually contains up-to-date information about the state of XHTML output.
5367 See also the list of XHTML bugs on
5368 \begin_inset CommandInset href
5370 name "the bug tracker"
5371 target "https://www.lyx.org/trac/query?status=reopened&status=assigned&status=new&max=0&component=xhtml+export&order=id&col=id&col=summary&col=reporter&col=keywords&keywords=%21%7Efixedintrunk&desc=1"
5381 Still, the developers have chosen this approach because it has several
5382 potential advantages over the other two.
5385 \begin_layout Standard
5386 These advantages are primarily due to the fact that the XHTML output routines,
5387 since they are part of \SpecialChar LyX
5388 , know everything \SpecialChar LyX
5389 knows about the document being
5394 \begin_layout Plain Layout
5395 Another advantage is that, since these routines are internal to \SpecialChar LyX
5397 immune to changes in \SpecialChar LyX
5398 's file format, or to changes in the semantics of
5404 So they know about the table of contents (as displayed in the outline),
5405 about the counters associated with different paragraph styles, and about
5406 user-defined styles.
5407 The XHTML output routines know what \SpecialChar LyX
5408 knows about internationalization,
5409 too, so they will output
5410 \begin_inset Quotes eld
5414 \begin_inset Quotes erd
5418 \begin_inset Quotes eld
5426 \begin_inset Quotes erd
5429 , depending upon the language in effect at the time.
5433 \begin_layout Standard
5434 Quite generally, the output routines know what \SpecialChar LyX
5435 knows about document layout,
5436 that is, about how the document is to be rendered on screen.
5437 We use this information when we output the document as XHTML.
5438 In particular, \SpecialChar LyX
5443 generates CSS style information corresponding to the layout information
5444 it uses to render the document on screen: if section headings are supposed
5445 to be sans-serif and bold as seen in \SpecialChar LyX
5446 , then (by default) they will be sans-seri
5447 f and bold when viewed in a web browser, too.
5448 And this is true not just for pre-defined styles, like Section, but for
5449 any style, including user-defined styles.
5450 Indeed, the XHTML output routines make no distinction between user-defined
5452 \change_deleted 244031559 1603876931
5454 \change_inserted 244031559 1603876940
5457 styles and \SpecialChar LyX
5458 's own pre-defined styles: in each case, everything \SpecialChar LyX
5460 the styles is contained in the layout files.
5461 And much the same is true as regards pre-defined textual insets, such as
5462 footnotes, and various custom insets.
5466 \begin_layout Standard
5467 The result is that XHTML output can be customized and extended in exactly
5468 the same way \SpecialChar LaTeX
5469 output can be customized and extended: through layout files
5471 See chapter five of the
5475 manual for the details.
5478 \begin_layout Standard
5479 The remainder of this chapter contains more detailed information on XHTML
5480 output, its limitations, and ways to work around those limitations.
5483 \begin_layout Section
5484 Math Output in XHTML
5487 \begin_layout Standard
5489 offers four choices for how math is rendered.
5490 These have various advantages and disadvantages:
5493 \begin_layout Itemize
5495 \begin_inset Newline newline
5498 MathML is a dialect of XML designed specifically for mathematics on the
5499 web, and it typically renders very well in browsers that support it.
5500 The disadvantage is that not all browsers support MathML, and support is
5501 not complete even in the Gecko-based browsers, such as Firefox.
5502 \begin_inset Newline newline
5506 is unable to render a formula as MathML—for example, if the formula
5508 \begin_inset Flex Code
5511 \begin_layout Plain Layout
5517 package or ERT—then it will instead output the formula as an image.
5521 \begin_layout Itemize
5523 \begin_inset Newline newline
5527 \begin_inset Flex Code
5530 \begin_layout Plain Layout
5536 outputs math as HTML, styled by CSS.
5540 \begin_layout Plain Layout
5542 has borrowed some of the CSS for its HTML output from
5543 \begin_inset Flex Code
5546 \begin_layout Plain Layout
5557 For simple formulae, this can work quite well, though with more complicated
5558 formulae it tends to break down.
5559 Still, this method has the advantage that it is very widely supported and
5560 so it may be appropriate for documents that contain only a little, fairly
5562 \begin_inset Newline newline
5565 If Lyx is unable to render a formula as HTML—for example, if the formula
5567 \begin_inset Flex Code
5570 \begin_layout Plain Layout
5576 package or ERT—then it will instead output the formula as an image.
5580 \begin_layout Itemize
5582 \begin_inset Newline newline
5586 \begin_inset Flex Code
5589 \begin_layout Plain Layout
5596 will output formulae as images, the very same images, in fact, that are
5597 used for instant preview.
5601 \begin_layout Plain Layout
5602 Instant preview does
5606 have to be on for images to be output, however.
5611 The advantage to this method is that the images are simply generated by
5613 , so they are very accurate.
5614 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5615 so they do not scale terribly well, and one cannot copy them, etc.
5616 \begin_inset Newline newline
5619 The size of the images can be controlled by setting the
5620 \begin_inset Quotes eld
5624 \begin_inset Quotes erd
5628 \begin_inset Flex Noun
5631 \begin_layout Plain Layout
5632 Document\SpecialChar menuseparator
5633 Settings\SpecialChar menuseparator
5643 \begin_layout Plain Layout
5644 For those who want to know, this controls the resolution of the image in
5645 dots per inch and is based upon a default of 75 dpi.
5651 \begin_inset Newline newline
5655 for some reason fails to create an image for a formula (e.g., if a required
5657 package is not installed), then it will fall back to outputing the raw
5662 \begin_layout Itemize
5665 \begin_inset Newline newline
5668 Finally, \SpecialChar LyX
5669 will happily output math as \SpecialChar LaTeX
5671 As well as being the output of last resort, this method can be used with
5673 \begin_inset CommandInset href
5676 target "http://www.math.union.edu/~dpvc/jsMath/"
5681 , which uses JavaScript to render \SpecialChar LaTeX
5682 embedded in HTML documents.
5684 wraps the \SpecialChar LaTeX
5686 \begin_inset Flex Code
5689 \begin_layout Plain Layout
5695 (for inline formulas) or
5696 \begin_inset Flex Code
5699 \begin_layout Plain Layout
5705 (for displayed formulas) with
5706 \begin_inset Flex Code
5709 \begin_layout Plain Layout
5715 , as is required for jsMath.
5718 \begin_layout Standard
5719 One of these output methods must be selected under
5720 \begin_inset Flex Noun
5723 \begin_layout Plain Layout
5724 Document\SpecialChar menuseparator
5725 Settings\SpecialChar menuseparator
5732 By default, \SpecialChar LyX
5734 This is a document-wide setting, therefore.
5737 \begin_layout Standard
5738 Eventually, \SpecialChar LyX
5739 will offer the user the option to select an alternate output
5740 method for a particular inset, say, one that isn't being rendered very
5745 \begin_layout Plain Layout
5746 That said, since \SpecialChar LyX
5747 falls back to images if the inset contains ERT, then one
5748 can force output as an image by putting some harmless ERT into the math,
5750 \begin_inset Formula $a=b\relax$
5761 \begin_layout Section
5762 Bibliography and Citations
5765 \begin_layout Standard
5766 XHTML output fully supports bibliographies and citations.
5770 \begin_layout Standard
5771 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5773 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5776 If you are using numerical citations, then \SpecialChar LyX
5777 will output numerical labels,
5778 such as [1] or [17], rather than simply showing the citation key in square
5779 brackets, as it does on-screen.
5780 If you are using author-year citations, then \SpecialChar LyX
5781 will add lowercase letters
5782 to the years, just as Bib\SpecialChar TeX
5783 does, if it finds more than one citation for
5784 a given author-year combination.
5785 The labels will be printed with the bibliography entries.
5786 Note that there is, at present, no way to customize the appearance of the
5787 labels, for example, to choose between square brackets and parentheses.
5790 \begin_layout Standard
5791 Bibliography output is handled by the same machinery that handles the presentati
5792 on of reference information in the citation dialog, so you will see in the
5793 XHTML output pretty much what you would see if you were to look at a given
5794 entry in the citation dialog.
5795 The formatting can be customized in your layout file or, preferably, in
5801 manual for the details.
5804 \begin_layout Standard
5805 The main defect at present is that cross-referenced information is printed
5806 with every entry with which it is associated.
5807 So you can see things like this:
5812 \begin_inset Quotes eld
5815 Context and Logical Form
5816 \begin_inset Quotes erd
5821 Language in Context: Selected Essays
5823 (Oxford: Oxford University Press, 2007), pp.
5829 \begin_inset Quotes eld
5832 Semantics in Context
5833 \begin_inset Quotes erd
5838 Language in Context: Selected Essays
5840 (Oxford: Oxford University Press, 2007), pp.
5844 \begin_layout Standard
5845 This should be fixed before long.
5848 \begin_layout Standard
5849 There is no support at present for sectioned bibliographies.
5850 If you have multiple bibliographies, then \SpecialChar LyX
5851 will print the same bibliography
5855 \begin_layout Section
5859 \begin_layout Standard
5861 will happily export indexes as XHTML, but with certain limitations at the
5865 \begin_layout Standard
5866 Index export will be most reliable when you do not attempt to use the fancy
5867 constructs that are described in the section on indexes in the
5875 \begin_layout Plain Layout
5876 The main issue here is that \SpecialChar LyX
5877 itself does not really handle these.
5878 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5884 We'll describe how they are handled using the subsection headings from
5888 \begin_layout Itemize
5889 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5890 makes an effort to support these,
5891 but the entries must be separated by
5892 \begin_inset Quotes eld
5896 \begin_inset Quotes erd
5899 , that is, there must be spaces around the exclamation point.
5900 This is because it is otherwise too difficult to check for escaped exclamation
5901 points, ones in math, and so forth.
5904 \begin_layout Itemize
5905 Page Ranges: There is no support at all for page ranges, since these make
5906 no sense with XHMTL.
5907 Instead, you will just get two index entries, one at either end.
5910 \begin_layout Itemize
5911 Cross-referencing: There is no support for cross-referencing.
5913 finds an entry containing the
5914 \begin_inset Quotes eld
5917 |see\SpecialChar ldots
5919 \begin_inset Quotes erd
5922 construct, it is just dropped, and the rest is treated as an ordinary index
5926 \begin_layout Itemize
5927 Index Entry Order: \SpecialChar LyX
5928 does support attempts to fix the sorting order.
5929 It will take what is before the first `@' it finds and use that for sorting,
5930 taking what follows the first `@' to be the actual entry.
5931 At present, \SpecialChar LyX
5932 does not check for escaped `@', so do not try to index email
5936 \begin_layout Itemize
5937 Index Entry Layout: You can format entries by using the text style dialog,
5938 or by using any other method available within \SpecialChar LyX
5940 There is no support for constructs like:
5941 \begin_inset Quotes eld
5945 \begin_inset Quotes erd
5949 Indeed, if \SpecialChar LyX
5950 finds a pipe symbol, `|', in an entry, it will delete it and
5951 everything that follows it.
5954 \begin_layout Itemize
5955 Multiple Indexes: There is no support for multiple indexes.
5956 Rather, all index entries will be printed as one large index.
5957 To avoid our printing several versions of the index, we print only the
5958 main index, so make sure you have one.
5961 \begin_layout Section
5962 Nomenclature and Glossary
5965 \begin_layout Standard
5966 There is at present no support for glossaries.
5967 Adding it would be fairly trivial, and welcome.
5970 \begin_layout Chapter
5972 \change_inserted 1075283030 1616534180
5976 \begin_layout Standard
5978 \change_inserted 1075283030 1616534386
5979 Apart from HTML, \SpecialChar LyX
5980 can generate documents in the DocBook XML vocabulary.
5981 With versions 2.3 and before, only select templates could be used to generate
5982 DocBook documents (only version 4).
5983 Starting with \SpecialChar LyX
5984 2.4, most \SpecialChar LyX
5985 layouts can generate valid DocBook documents (only
5987 This feature is built into \SpecialChar LyX
5988 and does not require the use of external tools.
5991 \begin_layout Standard
5993 \change_inserted 1075283030 1616534437
5994 The result is that the DocBook output can be customized and extended in
5995 exactly the same way \SpecialChar LaTeX
5996 output can be customized and extended: through layout
5998 See chapter five of the
6002 manual for the details.
6005 \begin_layout Standard
6007 \change_inserted 1075283030 1616534475
6008 Most \SpecialChar LyX
6009 features are supported with DocBook, like math output.
6012 \begin_layout Itemize
6014 \change_inserted 1075283030 1616534741
6015 Math output is performed mostly in MathML (the major exception being constructio
6016 ns not supported by \SpecialChar LyX
6019 All formulae are also available in raw \SpecialChar TeX
6020 in the DocBook output for further
6024 \begin_layout Itemize
6026 \change_inserted 1075283030 1616534852
6027 Bibliographies and citations are implemented, including with an external
6029 Bibliography entries are not prerendered when the detailed information
6030 are available, but rather output with the standard DocBook constructs.
6031 The external DocBook processor is expected to handle the rendering of entries.
6034 \begin_layout Itemize
6036 \change_inserted 1075283030 1616534863
6037 Indexes are supported, including multiple indices.
6042 ), page ranges, and cross-references (
6046 ) are supported, with the exception of the same symbols escaped.
6055 ) are not supported.
6056 There is no support for escaping of index entries.
6059 \begin_layout Itemize
6061 \change_inserted 1075283030 1616534884
6062 Glossaries are implemented.
6065 \begin_layout Standard
6067 \change_inserted 1075283030 1616534894
6068 Two major parameters can be set at the document level.
6071 \begin_layout Itemize
6073 \change_inserted 1075283030 1616534948
6074 Format for tables: \SpecialChar LyX
6075 can generate tables either as HTML (default value) or
6076 CALS, depending on the user's requirements.
6077 Most DocBook processors accept both formats.
6080 \begin_layout Itemize
6082 \change_inserted 1075283030 1616535006
6083 MathML prefix: in DocBook, MathML is included within its own name space,
6085 The implication is that there must be an indication of the tags belonging
6086 to the MathML standard.
6087 Three choices are offered:
6091 \begin_layout Itemize
6093 \change_inserted 1075283030 1616535044
6094 Inline: the MathML name space is defined for each formula (using the
6098 attribute on each formula)
6101 \begin_layout Itemize
6103 \change_inserted 1075283030 1616535090
6108 prefix (default): the MathML name space is defined at the document level
6113 attribute on the root element).
6114 Each MathML is prefixed with
6123 \begin_layout Itemize
6125 \change_inserted 1075283030 1616535102
6130 prefix: similar to the
6142 \begin_layout Chapter
6143 The \SpecialChar LyX
6147 \begin_layout Section
6151 \begin_layout Standard
6152 The `\SpecialChar LyX
6153 server' allows other programs to talk to \SpecialChar LyX
6154 , invoke \SpecialChar LyX
6155 commands, and retrieve
6156 information about the \SpecialChar LyX
6158 This is only intended for advanced users, but they should find it useful.
6159 It is by writing to the \SpecialChar LyX
6160 server, for example, that bibliography managers,
6161 such as JabRef, are able to
6162 \begin_inset Quotes eld
6166 \begin_inset Quotes erd
6169 citations to \SpecialChar LyX
6173 \begin_layout Section
6174 Starting the \SpecialChar LyX
6176 \begin_inset CommandInset label
6178 name "sec:Starting-the-Server"
6185 \begin_layout Standard
6186 The \SpecialChar LyX
6187 server works through the use of a pair of named pipes.
6188 These are usually located in
6189 \begin_inset Flex Code
6192 \begin_layout Plain Layout
6198 , (except on Windows, where
6202 named pipes are special objects located in
6203 \begin_inset Flex Code
6206 \begin_layout Plain Layout
6218 ) and have the names
6219 \begin_inset Quotes eld
6223 \begin_inset Flex Code
6226 \begin_layout Plain Layout
6233 \begin_inset Quotes erd
6237 \begin_inset Quotes eld
6241 \begin_inset Flex Code
6244 \begin_layout Plain Layout
6251 \begin_inset Quotes erd
6255 External programs write into
6256 \begin_inset Flex Code
6259 \begin_layout Plain Layout
6265 and read back data from
6266 \begin_inset Flex Code
6269 \begin_layout Plain Layout
6276 The stem of the pipe names can be defined in the
6277 \begin_inset Flex Noun
6280 \begin_layout Plain Layout
6281 Tools\SpecialChar menuseparator
6288 \begin_inset Flex Code
6291 \begin_layout Plain Layout
6292 "/home/myhome/lyxpipe"
6298 \begin_inset Flex Code
6301 \begin_layout Plain Layout
6315 on Windows (where any working path instead of lyxpipe can be used, for
6317 \begin_inset Flex Code
6320 \begin_layout Plain Layout
6343 configure this manually in order for the server to start.
6346 \begin_layout Standard
6349 \begin_inset Flex Code
6352 \begin_layout Plain Layout
6359 \begin_inset Flex Code
6362 \begin_layout Plain Layout
6368 ' to create the pipes.
6369 If one of the pipes already exists, \SpecialChar LyX
6370 will assume that another \SpecialChar LyX
6372 is already running and will not start the server.
6373 On POSIX (Unix like) systems, if for some other reason, an unused
6374 \begin_inset Quotes eld
6378 \begin_inset Quotes erd
6381 pipe is left in existence when \SpecialChar LyX
6382 closes, then \SpecialChar LyX
6383 will try to delete it.
6384 If this fails for some reason, you will need to delete the pipes manually
6385 and then restart \SpecialChar LyX
6387 On Windows, pipes are deleted by the OS on program termination or crash,
6389 \begin_inset Quotes eld
6393 \begin_inset Quotes erd
6396 pipes should not be possible.
6399 \begin_layout Standard
6400 To have several \SpecialChar LyX
6401 processes with servers at the same time, you have to use
6402 different configurations, perhaps by using separate user directories, each
6404 \begin_inset Flex Code
6407 \begin_layout Plain Layout
6413 file, for each process.
6416 \begin_layout Standard
6417 If you are developing a client program, you might find it useful to enable
6418 debugging information from the \SpecialChar LyX
6420 Do this by starting \SpecialChar LyX
6422 \begin_inset Flex Code
6425 \begin_layout Plain Layout
6434 \begin_layout Standard
6435 You can find a complete example client written in C++ in the source distribution
6437 \begin_inset Flex Code
6440 \begin_layout Plain Layout
6441 development/lyxserver/server_monitor.cpp
6449 \begin_layout Standard
6450 Another useful tool is the command-line based client found in
6451 \begin_inset Flex Code
6454 \begin_layout Plain Layout
6455 src/client/lyxclient
6463 \begin_layout Section
6464 Normal communication
6467 \begin_layout Standard
6468 To issue a \SpecialChar LyX
6469 call, the client writes a line of ASCII text into the input
6471 This line has the following format:
6488 \begin_layout Description
6489 clientname is a name that the client can choose arbitrarily.
6490 Its only use is that \SpecialChar LyX
6491 will echo it if it sends an answer—so a client can
6492 dispatch results from different requesters.
6495 \begin_layout Description
6496 function is the function you want \SpecialChar LyX
6498 It is the same as the commands you'd use in the minibuffer.
6501 \begin_layout Description
6502 argument is an optional argument which is meaningful only to some functions
6504 \begin_inset Quotes eld
6508 \begin_inset Quotes erd
6511 LFUN will insert the argument as text at the cursor position).
6514 \begin_layout Standard
6515 The answer from \SpecialChar LyX
6516 will arrive in the output pipe and be of the form
6533 \begin_layout Standard
6542 are just echoed from the command request, while
6546 is more or less useful information filled according to how the command
6547 execution worked out.
6548 Some commands, such as
6549 \begin_inset Quotes eld
6553 \begin_inset Quotes erd
6556 , will return information about the internal state of \SpecialChar LyX
6558 return an empty data-response.
6559 This means that the command execution went fine.
6562 \begin_layout Standard
6563 In case of errors, the response from \SpecialChar LyX
6581 \begin_layout Standard
6586 should contain an explanation of why the command failed.
6589 \begin_layout Standard
6593 \begin_layout LyX-Code
6594 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
6595 \begin_inset Newline newline
6598 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
6599 \begin_inset Newline newline
6602 read a <~/.lyxpipe.out
6603 \begin_inset Newline newline
6609 \begin_layout Subsection
6610 AppleScript (Mac OS X)
6613 \begin_layout Standard
6614 Since \SpecialChar LyX
6615 2.1, \SpecialChar LyX
6616 supports basic interactions with AppleScript for normal communicatio
6617 n through the command run.
6618 This command takes a direct argument (the
6622 to perform) and an optional argument.
6623 It either returns the output of the function or triggers an error with
6624 the error message and code.
6627 \begin_layout Standard
6631 \begin_layout LyX-Code
6632 tell application "\SpecialChar LyX
6636 \begin_layout LyX-Code
6640 \begin_layout LyX-Code
6641 -- Stores the current file name into f
6644 \begin_layout LyX-Code
6645 set f to (run "server-get-filename" with argument "")
6648 \begin_layout LyX-Code
6649 on error the error_message number the error_number
6652 \begin_layout LyX-Code
6653 display dialog "Error: " & the error_number & ".
6657 \begin_layout LyX-Code
6658 & the error_message buttons {"OK"} default button 1
6661 \begin_layout LyX-Code
6665 \begin_layout LyX-Code
6669 \begin_layout Section
6673 \begin_layout Standard
6675 can notify clients of events going on asynchronously.
6676 Currently it will only do this if the user binds a key sequence with the
6678 \begin_inset Quotes eld
6682 \begin_inset Quotes erd
6686 The format of the string \SpecialChar LyX
6687 sends is as follows:
6691 \begin_inset Flex Code
6694 \begin_layout Plain Layout
6705 \begin_layout Standard
6710 is the printed representation of the key sequence that was actually typed
6714 \begin_layout Standard
6715 This mechanism can be used to extend \SpecialChar LyX
6716 's command set and implement macros.
6717 Bind some key sequence to
6718 \begin_inset Quotes eld
6722 \begin_inset Quotes erd
6726 Then start a client that listens on the output pipe, dispatches the command
6727 according to the sequence, and starts a function that may use \SpecialChar LyX
6730 requests to issue a command or a series of commands to \SpecialChar LyX
6734 \begin_layout Section
6735 The simple \SpecialChar LyX
6739 \begin_layout Standard
6741 implements a simple protocol that can be used for session management.
6742 All messages are of the form
6755 \begin_layout Standard
6761 \begin_inset Quotes eld
6765 \begin_inset Quotes erd
6769 \begin_inset Quotes eld
6773 \begin_inset Quotes erd
6778 \begin_inset Quotes eld
6782 \begin_inset Quotes erd
6785 is received from a client, \SpecialChar LyX
6786 will report back to inform the client that
6787 it's listening to it's messages, while
6788 \begin_inset Quotes eld
6792 \begin_inset Quotes erd
6795 sent from \SpecialChar LyX
6796 will inform clients that \SpecialChar LyX
6800 \begin_layout Section
6801 Reverse DVI/PDF search
6804 \begin_layout Standard
6805 Some DVI/PDF viewers
6809 \begin_layout Plain Layout
6810 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6811 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6820 facility (also called
6825 This means that you can tell \SpecialChar LyX
6826 to put the cursor to a specific line in the
6827 document by clicking at the respective position in the DVI/PDF output.
6828 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6830 This is done via the \SpecialChar LyX
6831 server either by using the named pipe (
6835 ), or the UNIX domain socket (
6839 ) that \SpecialChar LyX
6840 creates in its temporary directory (this is the way the
6841 \begin_inset Flex Code
6844 \begin_layout Plain Layout
6850 program communicates with \SpecialChar LyX
6852 In some cases, you need a helper script that mediates between the viewer
6853 and \SpecialChar LyX
6854 , in others, the viewer can communicate with \SpecialChar LyX
6856 This depends on the selected viewer and on your operating system.
6857 The same applies to the way viewers need to be configured and the way the
6858 reverse search is actually performed.
6859 In what follows, we will thus describe how to setup reverse search for
6861 Before we turn to this, though, we will explain what needs to be done generally
6862 to enable reverse search in the DVI/PDF output.
6865 \begin_layout Subsection
6867 \begin_inset CommandInset label
6869 name "subsec:rev-search"
6876 \begin_layout Standard
6877 In most cases \SpecialChar LyX
6878 will do the work for you by pressing the following button
6882 arg "buffer-toggle-output-sync"
6886 Alternatively, you can also enable the feature by checking
6888 Synchronize with Output
6891 \begin_inset Flex Noun
6894 \begin_layout Plain Layout
6895 Document\SpecialChar menuseparator
6896 Settings\SpecialChar menuseparator
6903 In such a case \SpecialChar LyX
6904 will automatically insert the necessary Sync\SpecialChar TeX
6906 PDF) or load the srcltx package (for DVI) respectively.
6907 This option can be easily reached also on
6908 \begin_inset Flex Code
6911 \begin_layout Plain Layout
6920 \begin_layout Standard
6921 If you need a different setting, you can select or input a custom macro
6922 from the drop down box just below
6923 \begin_inset Flex Noun
6926 \begin_layout Plain Layout
6927 Document\SpecialChar menuseparator
6928 Settings\SpecialChar menuseparator
6929 Output\SpecialChar menuseparator
6930 Synchronize with Output
6938 \begin_layout Standard
6939 Note that the method
6940 \begin_inset Flex Code
6943 \begin_layout Plain Layout
6951 enables gzip compression.
6952 If your viewer does not support it, you should instead use
6953 \begin_inset Flex Code
6956 \begin_layout Plain Layout
6967 \begin_layout Standard
6968 Please also note that including the
6969 \begin_inset Flex Code
6972 \begin_layout Plain Layout
6979 \begin_inset Flex Code
6982 \begin_layout Plain Layout
6988 sometimes has an undesired impact on the typesetting.
6989 Thus, you should switch output synchronization off for the final typesetting
6991 \begin_inset Flex Code
6994 \begin_layout Plain Layout
7001 \begin_inset Flex Code
7004 \begin_layout Plain Layout
7014 \begin_layout Standard
7015 In case you need some more special settings that are not covered by the
7016 automatic settings, read the next section about how to set up output synchroniz
7018 If the automatic setup suits your needs, you can readily jump to section
7019 \begin_inset space ~
7023 \begin_inset CommandInset ref
7025 reference "subsec:configuring-viewers"
7029 , where the necessary configuration steps in your viewer – needed both with
7030 the automatic and the manual setup – are described.
7033 \begin_layout Subsection
7037 \begin_layout Standard
7039 provides several different methods for reverse search.
7040 Some are built-in in the
7041 \begin_inset Flex Code
7044 \begin_layout Plain Layout
7050 program, some are provided by external packages.
7051 Your choice depends on whether your \SpecialChar LaTeX
7052 distribution already provides a given
7053 method (the built-in methods are rather new) and whether your viewer can
7055 The available methods are described in the following.
7058 \begin_layout Subsubsection*
7059 Built-in DVI-search via src-specials (DVI only)
7062 \begin_layout Standard
7063 This method provides the DVI file with the necessary information for reverse
7065 It is available in \SpecialChar LaTeX
7066 since quite some time (any somewhat recent \SpecialChar LaTeX
7068 should include it), and it works reliably.
7069 To enable it, change the
7070 \begin_inset Flex Noun
7073 \begin_layout Plain Layout
7084 \begin_inset Flex Noun
7087 \begin_layout Plain Layout
7098 \begin_inset Flex Noun
7101 \begin_layout Plain Layout
7102 Preferences\SpecialChar menuseparator
7103 File Handling\SpecialChar menuseparator
7110 \begin_inset Flex Code
7113 \begin_layout Plain Layout
7114 latex -src-specials $$i
7120 If this doesn't work, check if your \SpecialChar TeX
7121 engine needs different options (the
7122 syntax might differ in some distributions).
7125 \begin_layout Subsubsection*
7126 External Packages (PDFSync and scrltx)
7129 \begin_layout Standard
7138 provide reverse search facility for PDF output (via pdflatex) and DVI output,
7140 In order to enable it, load the packages in the \SpecialChar LyX
7144 \begin_layout Itemize
7145 \begin_inset Flex Code
7148 \begin_layout Plain Layout
7156 for reverse PDF search,
7159 \begin_layout Itemize
7160 \begin_inset Flex Code
7163 \begin_layout Plain Layout
7166 usepackage[active]{srcltx}
7171 for reverse DVI search.
7174 \begin_layout Standard
7175 If you want to be able to perform both DVI and PDF reverse searches, you
7176 can also insert in the preamble the following lines
7179 \begin_layout LyX-Code
7183 \begin_inset Newline newline
7189 \begin_inset Newline newline
7195 \begin_inset Newline newline
7201 \begin_inset Newline newline
7206 usepackage[active]{srcltx}
7207 \begin_inset Newline newline
7215 \begin_layout Standard
7216 This way, you can preview the file as either DVI or PDF (pdflatex) and the
7217 right package will be used.
7220 \begin_layout Standard
7221 Note that PDFSync might affect the output layout of your document.
7222 It is therefore advised to disable PDFsync for final documents.
7225 \begin_layout Subsubsection*
7226 Built-in reverse search via Sync\SpecialChar TeX
7230 \begin_layout Standard
7232 \begin_inset Flex Code
7235 \begin_layout Plain Layout
7241 have built-in support for both PDF and DVI reverse search.
7244 Sync\SpecialChar TeX
7247 facility is basically the result of the integration of the PDFSync package
7248 to the pdftex program and its merge with the
7253 You need at least \SpecialChar TeX
7254 Live 2008 or a recent Mik\SpecialChar TeX
7255 distribution in order to use
7260 \begin_layout Plain Layout
7261 For some reason, Mik\SpecialChar TeX
7262 does not understand/obey the command \SpecialChar LyX
7264 the preamble when you check the "Enable Forward/Reverse Search" button
7265 in the toolbar and does not generate the necessary info.
7268 \begin_layout Plain Layout
7269 The generation of the required info can be forced by changing the converter
7271 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
7272 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
7273 the -synctex=1 switch).
7278 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
7279 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
7280 already provide Sync\SpecialChar TeX
7284 \begin_layout Standard
7285 To enable Sync\SpecialChar TeX
7286 for DVI output, change the
7287 \begin_inset Flex Noun
7290 \begin_layout Plain Layout
7301 \begin_inset Flex Noun
7304 \begin_layout Plain Layout
7315 \begin_inset Flex Noun
7318 \begin_layout Plain Layout
7319 Preferences\SpecialChar menuseparator
7320 File Handling\SpecialChar menuseparator
7327 \begin_inset Flex Code
7330 \begin_layout Plain Layout
7331 latex -synctex=1 $$i
7336 , and for PDF output, change the
7337 \begin_inset Flex Noun
7340 \begin_layout Plain Layout
7345 (pdflatex) -> PDF (pdflatex)
7351 \begin_inset Flex Code
7354 \begin_layout Plain Layout
7355 pdflatex -synctex=1 $$i
7361 Should your viewer not be considered in the following description, or in
7362 case of missing success, please check the documentation of your viewer
7363 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
7368 \begin_layout Plain Layout
7369 Note that the option
7370 \begin_inset Flex Code
7373 \begin_layout Plain Layout
7379 option enables gzip compression.
7380 If your viewer does not support it, you should instead use
7381 \begin_inset Flex Code
7384 \begin_layout Plain Layout
7398 \begin_layout Subsection
7399 Configuring and using specific viewers
7400 \begin_inset CommandInset label
7402 name "subsec:configuring-viewers"
7409 \begin_layout Subsubsection*
7410 Xdvi (all platforms)
7413 \begin_layout Standard
7415 \begin_inset Flex Code
7418 \begin_layout Plain Layout
7424 , you don't need to do anything else for performing a reverse DVI search,
7426 already provides the necessary hooks for automatically using the
7427 \begin_inset Flex Code
7430 \begin_layout Plain Layout
7437 Just setup your document as described above (reverse search is triggered
7438 by Ctrl-click or Alt-click on Mac OSX, respectively).
7441 \begin_layout Standard
7442 However, if for whatever reason you want to use the named pipe instead of
7443 the socket for communicating with \SpecialChar LyX
7444 , simply change the DVI viewer in
7445 \begin_inset Flex Noun
7448 \begin_layout Plain Layout
7449 Preferences\SpecialChar menuseparator
7450 File Handling\SpecialChar menuseparator
7460 \begin_layout Plain Layout
7461 On Mac OSX you have to use
7462 \begin_inset Flex Code
7465 \begin_layout Plain Layout
7466 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
7477 \begin_inset Flex Code
7480 \begin_layout Plain Layout
7481 xdvi -editor "lyxeditor.sh %f %l"
7487 \begin_inset Flex Code
7490 \begin_layout Plain Layout
7496 is a suitable script.
7497 For example, a minimal shell script is the following one:
7500 \begin_layout LyX-Code
7502 \begin_inset Newline newline
7505 LYXPIPE="/path/to/lyxpipe"
7506 \begin_inset Newline newline
7509 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
7510 \begin_inset Newline newline
7513 echo "$COMMAND" > "${LYXPIPE}".in || exit
7514 \begin_inset Newline newline
7517 read TMP < "${LYXPIPE}".out || exit
7520 \begin_layout Standard
7522 \begin_inset Flex Code
7525 \begin_layout Plain Layout
7531 is the LyXServer pipe path specified in
7532 \begin_inset Flex Noun
7535 \begin_layout Plain Layout
7536 Preferences\SpecialChar menuseparator
7546 \begin_layout Plain Layout
7548 \begin_inset Flex Code
7551 \begin_layout Plain Layout
7557 folder of a source distribution you can find a
7558 \begin_inset Flex Code
7561 \begin_layout Plain Layout
7567 script which is able to locate the
7571 based on your preferences.
7579 \begin_layout Subsubsection*
7583 \begin_layout Standard
7585 \begin_inset Flex Code
7588 \begin_layout Plain Layout
7589 /Applications/MacDviX_Folder/calleditor.script
7594 , add the following lines:
7597 \begin_layout LyX-Code
7598 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
7599 \begin_inset Newline newline
7605 \begin_layout Standard
7606 Modify the lines accordingly if you install \SpecialChar LyX
7607 somewhere else than in the
7608 Applications folder.
7611 \begin_layout Standard
7612 Reverse search is triggered by Alt-click (OPTION-click).
7615 \begin_layout Subsubsection*
7619 \begin_layout Standard
7621 \begin_inset Flex Code
7624 \begin_layout Plain Layout
7625 open -a Skim.app $$i
7630 to the viewer setting in
7631 \begin_inset Flex Noun
7634 \begin_layout Plain Layout
7635 Preferences\SpecialChar menuseparator
7636 File Handling\SpecialChar menuseparator
7637 File formats\SpecialChar menuseparator
7644 \begin_inset Flex Noun
7647 \begin_layout Plain Layout
7648 Skim\SpecialChar menuseparator
7649 Preferences\SpecialChar menuseparator
7656 \begin_inset Flex Noun
7659 \begin_layout Plain Layout
7665 preset and enter command
7666 \begin_inset Flex Noun
7669 \begin_layout Plain Layout
7670 /Applications/\SpecialChar LyX
7671 .app/Contents/MacOS/lyxeditor
7679 \begin_layout Standard
7680 Reverse search is triggered by COMMAND-SHIFT-click
7683 \begin_layout Subsubsection*
7687 \begin_layout Standard
7688 Reverse search with evince does not work out of the box, but it can be achieved
7689 by means of some third party helper scripts.
7691 \begin_inset CommandInset href
7693 target "https://wiki.lyx.org/LyX/SyncTeX"
7701 \begin_layout Subsubsection*
7705 \begin_layout Standard
7707 \begin_inset Flex Noun
7710 \begin_layout Plain Layout
7711 Settings\SpecialChar menuseparator
7712 Configure Okular\SpecialChar menuseparator
7719 \begin_inset Quotes erd
7723 This inserts the appropriate command (
7724 \begin_inset Flex Code
7727 \begin_layout Plain Layout
7736 \begin_layout Standard
7737 Reverse search is triggered by SHIFT-click.
7739 \change_inserted -712698321 1578211026
7740 Note that this only works if Okular is in
7741 \begin_inset Quotes eld
7745 \begin_inset Quotes erd
7749 \begin_inset space \thinspace{}
7752 e., the hand symbol is clicked).
7757 \begin_layout Subsubsection*
7761 \begin_layout Standard
7762 Qpdfview supports Sync\SpecialChar TeX
7763 since version 0.3.5.
7765 \begin_inset Flex Noun
7768 \begin_layout Plain Layout
7769 Edit\SpecialChar menuseparator
7770 Settings\SpecialChar menuseparator
7776 , click on the input field of the
7777 \begin_inset Quotes eld
7781 \begin_inset Quotes erd
7784 item and add the command
7785 \begin_inset Flex Code
7788 \begin_layout Plain Layout
7797 \begin_layout Standard
7798 Reverse search is triggered by double-click or, in more recent versions,
7802 \begin_layout Subsubsection*
7806 \begin_layout Standard
7807 Launch yap, choose its
7808 \begin_inset Flex Noun
7811 \begin_layout Plain Layout
7812 View\SpecialChar menuseparator
7819 \begin_inset Quotes eld
7823 \begin_inset Quotes erd
7828 \begin_inset Quotes eld
7831 New\SpecialChar ldots
7833 \begin_inset Quotes erd
7836 button and, in the window that opens, enter
7837 \begin_inset Quotes eld
7842 \begin_inset Quotes erd
7845 (or any other name you like) in the
7846 \begin_inset Quotes eld
7850 \begin_inset Quotes erd
7854 Now click on the button labeled
7855 \begin_inset Quotes eld
7860 \begin_inset Quotes erd
7863 to open a file dialog and navigate to the directory containing the batch
7865 \begin_inset Flex Code
7868 \begin_layout Plain Layout
7876 \begin_inset Flex Code
7879 \begin_layout Plain Layout
7885 and then specify the program arguments as
7886 \begin_inset Flex Code
7889 \begin_layout Plain Layout
7897 \begin_inset Flex Code
7900 \begin_layout Plain Layout
7906 wrapper is used for communicating with \SpecialChar LyX
7914 \begin_layout LyX-Code
7916 \begin_inset Newline newline
7919 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
7928 \begin_inset Newline newline
7942 \begin_layout Standard
7943 Make sure that the \SpecialChar LyX
7944 Server pipe path you specified in \SpecialChar LyX
7946 \begin_inset Flex Code
7949 \begin_layout Plain Layout
7963 , otherwise change the
7964 \begin_inset Flex Code
7967 \begin_layout Plain Layout
7973 wrapper accordingly.
7976 \begin_layout Standard
7977 In yap, reverse search is triggered by double-click.
7980 \begin_layout Subsubsection*
7981 SumatraPDF (Windows)
7984 \begin_layout Standard
7985 In order to use SumatraPDF for inverse search, enter
7986 \begin_inset Flex Code
7989 \begin_layout Plain Layout
7990 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
7995 in the viewer setting in
7996 \begin_inset Flex Noun
7999 \begin_layout Plain Layout
8000 Preferences\SpecialChar menuseparator
8001 File Handling\SpecialChar menuseparator
8002 File formats\SpecialChar menuseparator
8009 \begin_inset Flex Code
8012 \begin_layout Plain Layout
8018 is the previous wrapper.
8019 If SumatraPDF.exe is not in your command PATH, use its full file name.
8022 \begin_layout Standard
8023 Reverse search is triggered by double-click.
8026 \begin_layout Subsubsection*
8030 \begin_layout Standard
8031 First of all, make sure that yap is your default DVI viewer in the Windows
8032 environment, then launch it, choose its
8033 \begin_inset Flex Noun
8036 \begin_layout Plain Layout
8037 View\SpecialChar menuseparator
8044 \begin_inset Quotes eld
8048 \begin_inset Quotes erd
8053 \begin_inset Quotes eld
8056 New\SpecialChar ldots
8058 \begin_inset Quotes erd
8061 button and, in the window that opens, enter
8062 \begin_inset Quotes eld
8067 \begin_inset Quotes erd
8070 (or any other name you like) in the
8071 \begin_inset Quotes eld
8075 \begin_inset Quotes erd
8079 Now click on the button labeled
8080 \begin_inset Quotes eld
8085 \begin_inset Quotes erd
8088 to open a file dialog and navigate to the directory containing the
8089 \begin_inset Flex Code
8092 \begin_layout Plain Layout
8098 program (which is installed by default on Cygwin along with the \SpecialChar LyX
8101 \begin_inset Flex Code
8104 \begin_layout Plain Layout
8110 and then specify the program arguments as
8111 \begin_inset Flex Code
8114 \begin_layout Plain Layout
8121 In this way, you will be using the
8125 for communicating with \SpecialChar LyX
8127 If, for whatever reason, you want to use the
8132 \begin_inset Flex Code
8135 \begin_layout Plain Layout
8141 option and be sure to specify the \SpecialChar LyX
8142 Server pipe path in the \SpecialChar LyX
8146 \begin_layout Standard
8147 In yap, reverse search is triggered by double-click.
8150 \begin_layout Subsubsection*
8154 \begin_layout Standard
8155 In order to use SumatraPDF for inverse search, enter
8156 \begin_inset Flex Code
8159 \begin_layout Plain Layout
8160 SumatraPDF -inverse-search "lyxeditor -g %f %l"
8165 in the viewer setting in
8166 \begin_inset Flex Noun
8169 \begin_layout Plain Layout
8170 Preferences\SpecialChar menuseparator
8171 File Handling\SpecialChar menuseparator
8172 File formats\SpecialChar menuseparator
8179 If SumatraPDF.exe is not in your command PATH, use its full posix path.
8181 \begin_inset Flex Code
8184 \begin_layout Plain Layout
8190 enables communication via the
8196 \begin_inset Flex Code
8199 \begin_layout Plain Layout
8205 option if you want to use the
8209 , and be sure to specify the \SpecialChar LyX
8210 Server pipe path in the \SpecialChar LyX
8214 \begin_layout Standard
8215 Reverse search is triggered by double-click.
8218 \begin_layout Section
8222 \begin_layout Standard
8223 Forward search is, as the name implies, in a sense the
8224 \begin_inset Quotes eld
8228 \begin_inset Quotes erd
8232 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
8234 If forward search is set up (as described in what follows), you can put
8235 the cursor anywhere in your \SpecialChar LyX
8237 \begin_inset Flex Noun
8240 \begin_layout Plain Layout
8241 Navigate\SpecialChar menuseparator
8248 \begin_inset Flex Noun
8251 \begin_layout Plain Layout
8257 in the context menu via right mouse click), and then the viewer will jump
8258 to that position as well.
8259 This implies, of course, that your viewer supports this function.
8262 \begin_layout Standard
8263 To make forward search possible, you first need to provide the generated
8264 output PDF/DVI file with additional information about the \SpecialChar TeX
8266 This can be done via the methods described in the section
8267 \begin_inset CommandInset ref
8269 reference "subsec:rev-search"
8276 \begin_layout Standard
8277 Additionally, you need to configure \SpecialChar LyX
8278 for using your viewers in
8279 \begin_inset Flex Noun
8282 \begin_layout Plain Layout
8283 Tools\SpecialChar menuseparator
8284 Preferences\SpecialChar menuseparator
8285 Output\SpecialChar menuseparator
8292 We provide a range of tested configurations for some viewers, which you
8293 can select from the drop down list.
8294 If none of these configurations suits you, you have to find out and enter
8295 a suitable configuration yourself.
8296 The definition syntax uses the following placeholders:
8299 \begin_layout Itemize
8301 \begin_inset Flex Code
8304 \begin_layout Plain Layout
8313 \begin_layout Itemize
8315 \begin_inset Flex Code
8318 \begin_layout Plain Layout
8324 : name of the (temporary) exported .tex file (without path)
8327 \begin_layout Itemize
8329 \begin_inset Flex Code
8332 \begin_layout Plain Layout
8338 : name of the (temporary) exported .tex file (including path)
8341 \begin_layout Itemize
8343 \begin_inset Flex Code
8346 \begin_layout Plain Layout
8352 : name of the exported output file (either dvi or pdf, depending on which
8353 one exists in the temporary directory)
8356 \begin_layout Standard
8357 Note that only some of the viewers provide full and usable forward search
8358 functionality out of the box, among them yap, xdvi, okular
8362 \begin_layout Plain Layout
8363 You might want to set
8364 \begin_inset Flex Code
8367 \begin_layout Plain Layout
8374 \begin_inset Flex Noun
8377 \begin_layout Plain Layout
8378 Tools\SpecialChar menuseparator
8379 Preferences\SpecialChar menuseparator
8380 File Handling\SpecialChar menuseparator
8382 \begin_inset space ~
8395 , qpdfview, and SumatraPDF
8399 \begin_layout Plain Layout
8400 SumatraPDF can also use DDE commands through the external program CMCDDE
8402 \begin_inset CommandInset href
8404 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
8415 Others, such as evince
8419 \begin_layout Plain Layout
8420 Forward search with evince can be achieved by means of third party helper
8423 \begin_inset CommandInset href
8425 target "https://wiki.lyx.org/LyX/SyncTeX"
8435 , require some extra tools in order to use forward search.
8436 While many of the widespread PDF viewers (most notably Adobe Reader) do
8437 not support forward search at all, some other viewers – e.
8438 \begin_inset space \thinspace{}
8442 xpdf – allow at least to reload the document and jump to a specific page
8443 of the file, so you can at least navigate
8444 \begin_inset Quotes eld
8448 \begin_inset Quotes erd
8452 This latter functionality is provided by an external call of synctex (see
8453 the predefined example configurations).
8457 \begin_layout Standard
8458 Forward search works both with DVI and PDF output.
8460 simply checks which preview format you have used before (i.
8461 \begin_inset space \thinspace{}
8464 e., which format is already there in the temporary directory) and chooses
8465 the appropriate configuration for the respective format.
8468 \begin_layout Chapter
8469 Special Document Classes
8472 \begin_layout Section
8476 \begin_layout Standard
8482 \begin_layout Subsection
8486 \begin_layout Standard
8487 This section describes how \SpecialChar LyX
8488 can be used to write articles for submission
8489 to the scientific journal
8491 Astronomy and Astrophysics
8494 \begin_inset Flex URL
8497 \begin_layout Plain Layout
8499 https://www.aanda.org/
8504 ) using Version 5.01 of the document class
8509 This package can be downloaded from the ftp site
8512 \begin_layout Standard
8513 \begin_inset VSpace medskip
8519 \begin_layout Standard
8521 \begin_inset Flex URL
8524 \begin_layout Plain Layout
8526 ftp://ftp.edpsciences.org/pub/aa/readme.html
8534 \begin_layout Standard
8535 \begin_inset VSpace medskip
8541 \begin_layout Standard
8542 A manual comes together with that package, and this text is not meant to
8543 replace the original manual but is merely a short guide in how to realize
8544 the correct form of your paper.
8548 \begin_layout Standard
8549 Please note that the publisher of the journal was changed from Springer
8550 to EDP Sciences starting January 1, 2001.
8551 That change involved also some slight changes to the style files, namely
8552 the removal of the thesaurus command.
8553 The \SpecialChar LyX
8554 class aa supports the newest version of these style files, V 5.01.
8555 If you have an older version installed, please upgrade.
8556 For compatibility, the old (version 4) layout has been kept as
8561 Please refer to the comments in
8564 Dir/layouts/aapaper.layout
8569 \begin_layout Subsection
8573 \begin_layout Standard
8574 It is recommended you start from the example template distributed with \SpecialChar LyX
8576 If you are not using a template, note the following settings:
8579 \begin_layout Itemize
8586 Document\SpecialChar menuseparator
8589 dialog (OK, that one was obvious).
8592 \begin_layout Itemize
8593 Don't change the option
8596 \begin_inset space ~
8606 The whole layout is done by the macros, you shouldn't change anything.
8609 \begin_layout Subsection
8613 \begin_layout Standard
8614 First thing to enter is the header information.
8615 It consists of seven entries, of which some are optional.
8619 \begin_layout Itemize
8627 \begin_layout Itemize
8635 \begin_layout Itemize
8643 \begin_layout Itemize
8651 \begin_layout Itemize
8656 : [optional] if more than one author: whom to contact for offprint requests.
8659 \begin_layout Itemize
8664 : [optional] mail address for contacts.
8667 \begin_layout Itemize
8675 Received: <date>; Accepted <date>
8678 \begin_layout Standard
8679 There is no need to issue the
8685 command, this is done automatically by \SpecialChar LyX
8686 when the header is finished.
8687 Although the order of the single header entries doesn't matter it is advised
8688 to keep the above sequence, just to get the best optics and meets the layout
8689 of the real document.
8692 \begin_layout Standard
8693 If you want to place footnotes in the header block, e.
8694 \begin_inset space \thinspace{}
8698 \begin_inset space \space{}
8701 to state your present address, just use the standard footnote via the menu
8704 Insert\SpecialChar menuseparator
8709 will automagically use the term
8718 \begin_layout Standard
8721 Edit\SpecialChar menuseparator
8724 , you'll find two insets which are relevant for the titling:
8727 \begin_layout Itemize
8734 to mark corresponding author\SpecialChar breakableslash
8736 The institutes are numbered sequentially as they appear in the
8740 field, so you have to put a marker to each author.
8743 \begin_layout Itemize
8748 to supply an email address for fast contact.
8751 \begin_layout Standard
8752 In addition to these topics, the macros use one additional \SpecialChar LaTeX
8754 has no counterpart in \SpecialChar LyX
8758 \begin_layout Itemize
8765 to separate different names for more than one author and institute, respectivel
8769 \begin_layout Standard
8770 The appropriate command has to be entered in \SpecialChar LyX
8771 and marked as \SpecialChar LaTeX
8777 \begin_layout Subsection
8781 \begin_layout Standard
8782 The abstract should immediately follow the header block.
8783 With version 5 the abstract environment was changed to a command, and there
8784 is now a restriction to only one paragraph.
8785 In addition, it should contain an entry with the keywords.
8786 This is done via the paragraph style
8791 Refer to the example paper.
8794 \begin_layout Subsection
8795 Supported environments
8798 \begin_layout Standard
8799 The A&A paper layout supports the following environments for structuring
8803 \begin_layout Itemize
8809 \begin_layout Itemize
8815 \begin_layout Itemize
8821 \begin_layout Itemize
8827 \begin_layout Itemize
8833 \begin_layout Itemize
8839 \begin_layout Itemize
8845 \begin_layout Itemize
8851 \begin_layout Itemize
8857 \begin_layout Itemize
8863 \begin_layout Itemize
8869 \begin_layout Itemize
8876 \begin_layout Subsection
8877 Commands not supported by \SpecialChar LyX
8881 \begin_layout Standard
8882 Some commands are not yet supported by the
8886 layout for \SpecialChar LyX
8888 Some have already been mentioned.
8889 For the sake of completeness, they are listed all together here:
8892 \begin_layout Itemize
8900 \begin_layout Itemize
8908 \begin_layout Itemize
8916 \begin_layout Itemize
8924 \begin_layout Standard
8925 If you want to use any of these commands, you have to enter them yourself.
8928 Do not forget to mark them as \SpecialChar LaTeX
8932 \begin_layout Subsection
8933 Figure and Table Floats
8936 \begin_layout Standard
8938 provides support for the necessary float environments
8940 figure, figure*, table
8946 , therefore we won't tell much about it here.
8950 \begin_inset space ~
8956 Just remember that tables should be left-aligned.
8957 For that, select the table and change the alignment in
8959 Edit\SpecialChar menuseparator
8961 \begin_inset space ~
8967 \begin_layout Standard
8968 There is only one special thing: the figures with caption besides the figure.
8969 To create such a figure, you have to do the following:
8972 \begin_layout Enumerate
8973 Create a wide figure float:
8975 Insert\SpecialChar menuseparator
8976 Float\SpecialChar menuseparator
8979 , then right click in the figure and select
8982 \begin_inset space ~
8990 \begin_layout Enumerate
8991 Enter your caption text.
8994 \begin_layout Enumerate
8999 to move the cursor above the caption.
9002 \begin_layout Enumerate
9006 \begin_layout Enumerate
9007 Position the cursor behind the figure and insert a horizontal fill:
9009 Insert\SpecialChar menuseparator
9011 \begin_inset space ~
9014 Character\SpecialChar menuseparator
9016 \begin_inset space ~
9024 \begin_layout Enumerate
9025 Switch to \SpecialChar LaTeX
9029 \begin_inset space ~
9037 \begin_layout Enumerate
9047 Do not close the brace!
9050 \begin_layout Enumerate
9051 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
9056 \begin_inset space ~
9068 \begin_layout Standard
9069 Also, refer to the figures in the example paper.
9072 \begin_layout Subsection
9076 \begin_layout Standard
9077 For submission, the paper has to be formated in a special double-spacing
9079 For this purpose, you have to give the option
9083 to the document class.
9084 This must be done using the custom class options field in the
9086 Document\SpecialChar menuseparator
9090 Just enter the string
9097 \begin_layout Subsection
9101 \begin_layout Standard
9106 directory contains an example paper written with \SpecialChar LyX
9108 It is the example paper from the original macro package, translated to
9111 Use it for inspiration, and compare the original \SpecialChar LaTeX
9112 code with \SpecialChar LyX
9116 \begin_layout Section
9121 \begin_layout Standard
9127 \begin_layout Subsection
9131 \begin_layout Standard
9133 is a set of macros produced by the American Astronomical Society to
9134 facilitate electronic manuscript submission to the three journals they
9135 publish: the Astrophysical Journal (including the Letters and Supplement),
9136 the Astronomical Journal, and the Publications of the Astronomical Society
9139 has proven to be an excellent tool for generating these documents, especially
9140 given its equation, citation, and figure handling capabilities.
9142 requires version 5.0 (or higher) of these macros; preferably 6.0, which
9143 is the version described here, or higher.
9144 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
9145 2.09 and are fundamentally
9146 incompatible with \SpecialChar LyX
9148 The AAS\SpecialChar TeX
9149 package may be downloaded from the AAS\SpecialChar TeX
9153 \begin_layout Standard
9154 \begin_inset VSpace medskip
9160 \begin_layout Standard
9162 \begin_inset Flex URL
9165 \begin_layout Plain Layout
9167 https://aas.org/aastex/aastex-downloads
9175 \begin_layout Standard
9176 \begin_inset VSpace medskip
9182 \begin_layout Standard
9183 A complete user guide is contained in that package and you should familiarize
9184 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
9187 will not reduce the need to figure out all the AAS\SpecialChar TeX
9188 commands, it will only
9189 reduce the drudgery of typing everything in.
9190 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
9192 completely to the requirements of the journal to which you are submitting
9196 \begin_layout Subsection
9197 Starting a New Paper
9200 \begin_layout Standard
9201 I strongly suggest that you start with the AAS\SpecialChar TeX
9205 File\SpecialChar menuseparator
9212 , enter the new file name, then choose the
9217 This will show the most common fields found in a manuscript.
9218 Simply overwrite the existing text (including the brackets,
9222 ) with the correct information.
9223 Many of the AAS\SpecialChar TeX
9224 commands and environments can be implemented directly in
9227 For commands such as these, the \SpecialChar LaTeX
9228 code must be entered directly and marked
9230 Such commands are referred to as \SpecialChar TeX
9231 code, or Evil Red Text.
9232 I tried to minimize the amount of \SpecialChar TeX
9233 code needed in an AAS\SpecialChar TeX
9237 \begin_layout Subsection
9238 Finishing Your Paper
9241 \begin_layout Standard
9242 When the paper is finished to your satisfaction and previews/prints correctly,
9244 \begin_inset Quotes eld
9248 \begin_inset Quotes erd
9251 actions which need to be done before you submit it to the journals.
9255 \begin_layout Enumerate
9256 Export your paper as a \SpecialChar LaTeX
9259 File\SpecialChar menuseparator
9260 Export\SpecialChar menuseparator
9268 \begin_layout Enumerate
9273 file with your favorite text editor
9277 \begin_layout Enumerate
9278 remove the comment lines before the
9287 \begin_layout Enumerate
9292 usepackage...{fontenc}
9294 line if it appears (usually just after
9309 \begin_layout Enumerate
9310 remove everything between (and including) the
9322 commands, except for any commands you specifically put into the \SpecialChar LaTeX
9324 (which should appear immediately after the
9325 \begin_inset Quotes eld
9328 User specified \SpecialChar LaTeX
9330 \begin_inset Quotes erd
9341 \begin_layout Enumerate
9342 Run the resulting file through \SpecialChar LaTeX
9343 to make sure it still processes correctly.
9346 \begin_layout Enumerate
9347 Reread the journal requirements to make sure your filenames and formats
9351 \begin_layout Enumerate
9355 \begin_layout Subsection
9356 Comments On Specific Commands
9359 \begin_layout Standard
9360 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9367 ) gives a good description of each.
9368 Thus it's probably easiest for me to go down the list as found in the guide
9369 and offer comments where necessary.
9370 So let's begin \SpecialChar ldots
9374 \begin_layout Subsubsection
9375 Things that work as expected
9378 \begin_layout Standard
9379 Because they work as you might expect, I simply list them and the section
9480 begin{thebibliography}
9488 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9489 graphicx figure commands (2.14.1),
9513 (2.15.4, amongst other places),
9540 \begin_layout Standard
9541 The following style options also work correctly:
9562 Simply put them in the
9568 Layout\SpecialChar menuseparator
9574 \begin_layout Subsubsection
9575 Things that work, but require more comment
9578 \begin_layout Standard
9579 The following items work, but require a little more discussion:
9582 \begin_layout Itemize
9583 These items are reserved for use by the journal editors, but you can put
9584 them into the \SpecialChar LaTeX
9585 preamble if you feel compelled to do so:
9618 \begin_layout Itemize
9619 These items may be placed in the \SpecialChar LaTeX
9620 preamble, and are included as blanks in
9642 \begin_layout Itemize
9649 (2.3) – can only be used
9650 \begin_inset Quotes eld
9654 \begin_inset Quotes erd
9657 , not in the middle of a paragraph.
9658 Use \SpecialChar TeX
9659 code if you need to embed it.
9662 \begin_layout Itemize
9669 (2.3) – will have extra {} after it.
9670 This should not cause an error.
9673 \begin_layout Itemize
9680 (2.6) – can only be used
9681 \begin_inset Quotes eld
9685 \begin_inset Quotes erd
9688 , not in the middle of a paragraph.
9689 Use \SpecialChar TeX
9690 code if you need to embed it.
9693 \begin_layout Itemize
9700 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9704 \begin_layout Itemize
9718 \begin_layout Itemize
9725 (2.9) – will have extra {} after it.
9726 This should not cause an error.
9729 \begin_layout Itemize
9736 (2.11) – will have extra {} after it.
9737 This should not cause an error.
9740 \begin_layout Itemize
9747 (2.14.2) – you can insert an optional filename argument by placing the cursor
9748 at the beginning of the text and selecting
9750 Insert\SpecialChar menuseparator
9755 \begin_inset Quotes eld
9759 \begin_inset Quotes erd
9762 inserts an optional argument of the type needed by
9769 Hopefully it will be renamed someday.
9772 \begin_layout Itemize
9785 for the catalog ID optional parameter
9788 \begin_layout Itemize
9801 for the catalog ID optional parameter
9804 \begin_layout Subsubsection
9805 Things not implemented, use \SpecialChar TeX
9809 \begin_layout Standard
9820 setcounter{equation}
9822 (2.12), Journal name abbreviations (2.13.4),
9858 (2.15.4, insert it as the first element in the lefthand cell after where
9860 Don't use any of \SpecialChar LyX
9861 's rules in the table),
9873 (2.15.5), much of Misc (2.17, except
9924 \begin_layout Subsubsection
9925 Things that cannot be implemented
9928 \begin_layout Standard
9930 at least in any meaningful sort of way, so I suggest ignoring them.
9931 They are the references environment (2.13.3), and the deluxetable environment
9933 If you really, really need to use deluxetable, I suggest editing it in
9934 a separate file with a text editor, then using
9936 Insert\SpecialChar menuseparator
9938 \begin_inset space ~
9943 to include it in your \SpecialChar LyX
9949 file to see an example of this.
9952 \begin_layout Subsection
9953 FAQs, Tips, Tricks, and Other Ruminations
9956 \begin_layout Subsubsection
9957 Getting \SpecialChar LyX
9958 and AAS\SpecialChar TeX
9962 \begin_layout Standard
9963 It can be a bit tricky to get \SpecialChar LyX
9964 to recognize a new layout and document class.
9965 When all else fails, do this:
9968 \begin_layout Enumerate
9969 Make certain that \SpecialChar LaTeX
9970 can find AAS\SpecialChar TeX
9972 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9974 directory completely unrelated to \SpecialChar LaTeX
9975 or AAS\SpecialChar TeX
9976 and run \SpecialChar LaTeX
9984 \begin_layout Enumerate
9989 appears in \SpecialChar LyX
9997 \begin_layout Enumerate
10000 Tools\SpecialChar menuseparator
10003 in \SpecialChar LyX
10004 , then restart \SpecialChar LyX
10008 \begin_layout Enumerate
10009 Open a regular new file, not from a template.
10010 Does AAS\SpecialChar TeX
10011 appear in the class list in
10013 Document\SpecialChar menuseparator
10019 \begin_layout Standard
10020 If you get a warning from an existing AAS\SpecialChar TeX
10021 document about not being able
10022 to find the AAS\SpecialChar TeX
10023 layout or a message about
10024 \begin_inset Quotes eld
10027 You should not mix title layouts with normal ones
10028 \begin_inset Quotes erd
10031 , things haven't been installed correctly.
10034 \begin_layout Subsubsection
10036 error processing a table
10039 \begin_layout Standard
10041 , by default, attempts to center the table caption/title.
10042 This seems to produce a bad interaction in AAS\SpecialChar TeX
10043 so you should click somewhere
10044 in the caption/title, then select
10046 Edit\SpecialChar menuseparator
10048 \begin_inset space ~
10062 This took care of it for me.
10065 \begin_layout Subsubsection
10069 \begin_layout Standard
10070 A couple of things: 1) I have noticed some funny spacing in the reference
10071 entries in the text.
10072 When you enter the bibliography item data, make sure their is
10076 space between the last author and the parenthesis setting off the year;
10080 \begin_inset space \thinspace{}
10084 \begin_inset space \space{}
10098 2) Entering the references at all is not obvious.
10099 The easiest thing is to start typing your first reference at the end of
10100 the document, then mark it as type
10105 That will put a small gray box in front of what you just typed.
10106 Click on the box to fill in the rest of the information.
10107 For new references, go to the end of an existing reference and press return.
10108 That will create a new line with its own box, etc.
10111 \begin_layout Subsubsection
10112 Including EPS files
10115 \begin_layout Standard
10116 Even though AAS\SpecialChar TeX
10117 provides its own figure commands (
10123 , for example), I much prefer \SpecialChar LaTeX
10124 's standard figure commands (with the default
10133 \begin_inset space ~
10136 commands as \SpecialChar TeX
10137 code into a Figure Float box if you desire, but I never have
10138 much luck getting the layout right.
10139 With the standard graphics, \SpecialChar LyX
10144 usepackage{graphicx}
10146 command into the \SpecialChar LaTeX
10147 preamble and handle the figures in the standard \SpecialChar LaTeX2e
10149 interspersing the figures in the text.
10150 I believe ApJ accepts figures exactly this way now; AJ might still use
10152 \begin_inset Quotes eld
10155 stack everything at the end
10156 \begin_inset Quotes erd
10162 \begin_layout Subsubsection
10163 Things I could have done, but didn't
10166 \begin_layout Standard
10168 \begin_inset Quotes eld
10172 \begin_inset Quotes erd
10175 things I could have implemented, but chose not to.
10176 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
10178 even though it is double-spaced in the paper manuscript.
10179 Also, I chose not to make separate layouts for the preprint and preprint2
10181 Since I assume you will spend most of your time in the plain manuscript
10182 mode anyway, I decided not to chew up more disk space with this.
10186 \begin_layout Subsection
10190 \begin_layout Standard
10191 Your mileage may vary.
10192 I've now had papers published by both ApJ and AJ that have had 98% of the
10193 effort done in \SpecialChar LyX
10194 ; the last 2% was the \SpecialChar LaTeX
10195 post-processing and a few cleanups.
10196 I have had no trouble with the submission process, and I'm sure the journals
10197 were never aware that there might be a difference.
10198 So, go forth and publish!
10201 \begin_layout Section
10202 AMS \SpecialChar LaTeX
10206 \begin_layout Standard
10213 Richard Kimberly Heck
10216 \begin_layout Standard
10217 \begin_inset VSpace bigskip
10223 \begin_layout Standard
10225 The AMS \SpecialChar LaTeX
10226 layouts are set up to conform to suggested styles for mathematical
10227 papers to be submitted to American Mathematical Society publications.
10228 The layouts are not tailored to a specific journal, but easily can be.
10229 You should refer to the AMS documentation for specific instructions for
10230 each journal (usually it will entail only changing a single line in the
10233 That documentation is available on the Web at
10234 \begin_inset Flex URL
10237 \begin_layout Plain Layout
10245 \begin_inset Flex URL
10248 \begin_layout Plain Layout
10250 ftp://ftp.ams.org/pub/tex/amslatex/
10256 These layouts are appropriate, and useful, for any mathematical writing.
10260 \begin_layout Standard
10261 There are two basic AMS \SpecialChar LaTeX
10265 \begin_layout Itemize
10266 amsart: The standard AMS article format.
10269 \begin_layout Itemize
10270 amsbook: the standard AMS book (really, monograph) format.
10274 \begin_layout Standard
10275 The layouts themselves contain only the minimum necessary to use the AMS
10277 They do not, in particular, contain any of the `theorem' environments used
10278 for setting theorems, lemmas, and the like.
10279 These are contained, instead, in the
10280 \begin_inset Flex Code
10283 \begin_layout Plain Layout
10289 module, which is loaded by default when you select one of the AMS classes.
10290 (It can also be used with other classes and can be removed, if you would
10291 rather use something else.) Less commonly used environments are in the
10292 \begin_inset Flex Code
10295 \begin_layout Plain Layout
10296 Theorems (AMS-Extended)
10301 module, which must be loaded manually.
10304 \begin_layout Standard
10305 By default, theorems and the like are numbered consecutively throughout
10306 the document, but this may be modified by loading the module
10307 \begin_inset Flex Code
10310 \begin_layout Plain Layout
10311 Theorems (Order by Section)
10316 or, if you are using
10317 \begin_inset Flex Code
10320 \begin_layout Plain Layout
10327 \begin_inset Flex Code
10330 \begin_layout Plain Layout
10331 Theorems (Order by Chapter)
10337 These will number the results as
10338 \begin_inset Formula $n.m$
10341 , where the first number refers to the section (or chapter) and the second
10342 refers to the total number of results so far in that section (or chapter).
10343 Many environments are also available unnumbered.
10344 These are indicated by an asterisk at the end.
10345 If you happen to want
10349 unnumbered results, the module
10350 \begin_inset Flex Code
10353 \begin_layout Plain Layout
10359 provides that option.
10362 \begin_layout Standard
10363 Note that these modules do not
10367 to be used with the AMS classes.
10368 It is perfectly possible to use the
10369 \begin_inset Flex Code
10372 \begin_layout Plain Layout
10378 module, and the others mentioned, with other classes, such as
10379 \begin_inset Flex Code
10382 \begin_layout Plain Layout
10389 \begin_inset Flex Code
10392 \begin_layout Plain Layout
10399 \begin_inset Flex Code
10402 \begin_layout Plain Layout
10411 \begin_layout Subsection
10412 What these layouts provide
10415 \begin_layout Standard
10416 There is a long list of included environments provided by these layouts.
10417 In AMS-\SpecialChar LaTeX
10418 , there is, in fact, an opportunity to define an unlimited variety
10419 of `theorem' environments.
10420 However, the AMS recommends the environments that are available in \SpecialChar LyX
10425 \begin_layout Standard
10426 The following environments—as well as the standard environments, such as
10428 \begin_inset Flex Noun
10431 \begin_layout Plain Layout
10438 \begin_inset Flex Noun
10441 \begin_layout Plain Layout
10448 \begin_inset Flex Noun
10451 \begin_layout Plain Layout
10458 \begin_inset Flex Noun
10461 \begin_layout Plain Layout
10468 \begin_inset Flex Noun
10471 \begin_layout Plain Layout
10478 \begin_inset Flex Code
10481 \begin_layout Plain Layout
10488 \begin_inset Flex Code
10491 \begin_layout Plain Layout
10500 \begin_layout Description
10501 Address This should be the author's permanent address.
10504 \begin_layout Description
10506 \begin_inset space ~
10509 Address This should be the author's temporary address at the time of submission,
10510 if different from the Address.
10513 \begin_layout Description
10514 Email Author's e-mail address
10517 \begin_layout Description
10518 URL Author's Web address, if desired.
10521 \begin_layout Description
10522 Keywords Key words or phrases used to identify specific topics discussed
10526 \begin_layout Description
10527 Subjectclass These refer to the AMS Subject Classifications, published and
10530 Mathematical Reviews
10533 These are also available online at the AMS cites listed above.
10536 \begin_layout Description
10540 \begin_layout Description
10544 \begin_layout Description
10548 \begin_layout Standard
10549 The following environments are provided by both the
10550 \begin_inset Flex Code
10553 \begin_layout Plain Layout
10560 \begin_inset Flex Code
10563 \begin_layout Plain Layout
10569 modules, in the latter case in both starred (unnumbered) and unstarred
10570 (numbered) versions.
10571 These same environments are provided only in the starred versions by the
10573 \begin_inset Flex Code
10576 \begin_layout Plain Layout
10585 \begin_layout Theorem
10586 This is typically used for the statements of major results.
10590 \begin_layout Corollary*
10591 This is used for statements which follow fairly directly from previous statement
10593 Again, these can be major results.
10597 \begin_layout Lemma
10598 These are smaller results needed to prove other statements.
10601 \begin_layout Proposition
10602 These are less major results which (hopefully) add to the general theory
10606 \begin_layout Conjecture
10607 These are statements provided without justification, which the author does
10608 not know how to prove, but which seem to be true (to the author, at least).
10611 \begin_layout Definition*
10612 Guess what this is for.
10613 The font is different for this environment than for the previous ones.
10617 \begin_layout Example*
10618 Used for examples illustrating proven results.
10621 \begin_layout Problem
10622 It's not really known what this is for.
10623 You should figure it out.
10626 \begin_layout Exercise*
10627 Write a description for this one.
10630 \begin_layout Remark
10631 This environment is also a type of theorem, usually a lesser sort of observation.
10634 \begin_layout Claim*
10635 Often used in the course of giving a proof of a larger result.
10639 Generally, these are used to break up long arguments, using specific instances
10645 The numbering scheme for cases is on its own, not together with other numbered
10650 \begin_layout Proof
10651 At the end of this environment, a QED symbol (usually a square, but it can
10652 vary with different styles) is placed.
10653 If you want to have other environments within this one—for example, Case
10654 environments—and have the QED symbol appear only after them, then the other
10655 environments need to be nested within the proof environment.
10658 Nesting Environments
10664 for information on nesting.
10667 \begin_layout Standard
10668 And these environments are provided by
10669 \begin_inset Flex Code
10672 \begin_layout Plain Layout
10673 Theorems (AMS-Extended)
10681 \begin_layout Criterion*
10682 A required condition.
10685 \begin_layout Algorithm*
10686 A general procedure to be used.
10689 \begin_layout Axiom*
10690 This is a property or statement taken as true within the system being discussed.
10693 \begin_layout Condition*
10694 Sometimes used to state a condition assumed within the present context of
10698 \begin_layout Note*
10699 Similar to a Remark.
10702 \begin_layout Notation*
10703 Used for the explanation of, yes, notation.
10706 \begin_layout Summary
10707 Do we really need to tell you?
10710 \begin_layout Acknowledgement*
10714 \begin_layout Conclusion*
10715 Sometimes used at the end of a long train of argument.
10719 Used in a way similar to Proposition, though perhaps lower on the scale.
10722 \begin_layout Standard
10723 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10726 They need to be available on your system in order to use these environments.
10729 \begin_layout Section
10733 \begin_layout Standard
10739 \begin_layout Subsection
10743 \begin_layout Standard
10744 Broadway is for writing plays.
10745 The format is more decorative than Hollywood, and much less standardized.
10746 This format should be suitable for workshops.
10749 \begin_layout Subsection
10753 \begin_layout Standard
10754 The same as in Hollywood.
10757 \begin_layout Subsection
10761 \begin_layout Standard
10766 names as labels then cross-reference the label to insert the name.
10767 The cross-reference dialog will show the current cast of characters.
10770 \begin_layout Subsection
10771 Paper size and Margins
10774 \begin_layout Standard
10775 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10778 \begin_layout Subsection
10782 \begin_layout Standard
10783 The following environments are available.
10784 You can use broadway.bind to get the bind keys shown at the right.
10787 \begin_layout Itemize
10791 \begin_inset Newline newline
10796 You should not have to use this, but it is here for anything that does not
10800 \begin_layout Itemize
10804 \begin_inset space \hfill{}
10808 \begin_inset Newline newline
10813 Used to describe stage setting and the action.
10814 First use of speaker names in all CAPs.
10817 \begin_layout Itemize
10821 \begin_inset space \hfill{}
10825 \begin_inset Newline newline
10830 Automatically numbered.
10831 On screen it will be arabic, but will print as Roman.
10834 \begin_layout Itemize
10838 \begin_inset space \hfill{}
10842 \begin_inset Newline newline
10852 It is just centered text.
10855 \begin_layout Itemize
10859 \begin_inset space \hfill{}
10863 \begin_inset Newline newline
10868 Not automatically numbered.
10869 You supply the number.
10870 This is because I couldn't figure out how.
10873 \begin_layout Itemize
10877 \begin_inset space \hfill{}
10881 \begin_inset Newline newline
10886 A special case of Narrative to describe the setting and action as the curtain
10890 \begin_layout Itemize
10894 \begin_inset space \hfill{}
10898 \begin_inset Newline newline
10903 The speaker's (actor's) title, centered in all CAPS.
10906 \begin_layout Itemize
10910 \begin_inset space \hfill{}
10914 \begin_inset Newline newline
10919 Instructions to the speaker.
10920 The parentheses are automatically inserted.
10921 The ( will appear on screen, but both will be in the printed play.
10922 This environment is only used within
10929 \begin_layout Itemize
10933 \begin_inset space \hfill{}
10937 \begin_inset Newline newline
10942 What the Speaker says.
10945 \begin_layout Itemize
10949 \begin_inset space \hfill{}
10953 \begin_inset Newline newline
10958 The curtain comes down.
10961 \begin_layout Itemize
10965 \begin_inset space \hfill{}
10971 \begin_layout Itemize
10975 \begin_inset space \hfill{}
10981 \begin_layout Itemize
10985 \begin_inset space \hfill{}
10991 \begin_layout Standard
10995 \begin_layout Section
10999 \begin_layout Standard
11004 can be used to type letters according to German conventions.
11005 A template file is included in
11007 .../lyx/share/templates
11009 for you to use as a starting point.
11012 \begin_layout Section
11016 \begin_layout Standard
11017 See the \SpecialChar LyX
11023 It contains all infos you need.
11026 \begin_layout Section
11029 Foil\SpecialChar TeX
11033 \begin_inset CommandInset label
11042 \begin_layout Standard
11048 \begin_layout Subsection
11052 \begin_layout Standard
11053 This section describes how to use \SpecialChar LyX
11054 to make slides for overhead projectors.
11055 There are two document classes that can do this: the default slides class
11058 Foil\SpecialChar TeX
11062 This section documents the latter.
11065 \begin_layout Standard
11066 I'm going to say this again, nice and clear, so that there's no misunderstanding
11070 \begin_layout Standard
11071 \begin_inset VSpace bigskip
11077 \begin_layout Standard
11081 This section documents the class
11082 \begin_inset Quotes eld
11090 \begin_inset Quotes erd
11098 \begin_layout Standard
11099 \begin_inset VSpace bigskip
11105 \begin_layout Standard
11106 If you're looking for the documentation for
11107 \begin_inset Quotes eld
11115 \begin_inset Quotes erd
11118 , check out section
11119 \begin_inset space ~
11123 \begin_inset CommandInset ref
11125 reference "sec:slitex"
11130 If your machine doesn't have the
11138 installed, you'll probably have to use the default
11142 class, which isn't quite as good as
11147 \begin_layout Standard
11152 class is designed for use with version
11153 \begin_inset space ~
11161 class file which is now an integral part of \SpecialChar LaTeX2e
11165 \begin_layout Subsection
11169 \begin_layout Standard
11170 Obviously, to use this document class, you need to select
11181 \begin_inset space ~
11187 There are some settings in the
11190 \begin_inset space ~
11195 dialog that you should know about that are specific to this class:
11198 \begin_layout Itemize
11199 Don't change the options
11210 \begin_inset space ~
11216 They're ignored by the
11223 \begin_layout Itemize
11224 The default font size is 20
11225 \begin_inset space \thinspace{}
11228 pt with the other options being 17
11229 \begin_inset space \thinspace{}
11233 \begin_inset space \thinspace{}
11237 \begin_inset space \thinspace{}
11243 \begin_layout Itemize
11244 The default font is
11252 but all math equations are still typeset in the usual roman font.
11255 \begin_layout Itemize
11258 Foil\SpecialChar TeX
11261 supports A4 and Letter paper sizes as well as a special size for working
11263 \begin_inset space \thinspace{}
11267 It doesn't support A5, B5, legal or executive paper sizes.
11270 \begin_layout Itemize
11271 Don't bother changing the
11275 settings because they are ignored anyway.
11276 All floats appear where they are defined in the text.
11279 \begin_layout Itemize
11284 setting behaves a bit differently for this class.
11287 Foil\SpecialChar TeX
11290 provides extensive footer and header capabilities including a user-defined
11293 \begin_inset space ~
11297 \begin_inset CommandInset ref
11299 reference "sec:foilfoot"
11304 The title page is treated differently to all other pages in the document
11313 has the logo centered at the bottom of the page (if one is defined).
11314 The possible page style choices and what they do are as follows:
11318 \begin_layout Labeling
11319 \labelwidthstring MMMMMMM
11326 The final output contains no page numbers, or other headers or footers
11327 (except footnotes of course).
11331 \begin_layout Labeling
11332 \labelwidthstring MMMMMMM
11339 The final output contains page numbers centered at the bottom of the page.
11340 No other headings or footers (other than footnotes).
11343 \begin_layout Labeling
11344 \labelwidthstring MMMMMMM
11349 Page numbers in lower right corner.
11350 Additional headers and footers are also shown.
11351 This is also the default.
11354 \begin_layout Labeling
11355 \labelwidthstring MMMMMMM
11360 Gives you access to the
11364 package although its use with
11366 Foil\SpecialChar TeX
11369 is discouraged by the writer of the
11371 Foil\SpecialChar TeX
11374 package because of some potential page layout clashes.
11378 \begin_layout Subsubsection
11382 \begin_layout Standard
11383 The following options may be used in the extra class options in the
11385 Document\SpecialChar menuseparator
11391 \begin_layout Labeling
11392 \labelwidthstring MMMMMMx
11397 This sets up the page layout for 7.33
11398 \begin_inset space \thinspace{}
11402 \begin_inset space \thinspace{}
11405 in paper, which is about the same aspect ratio as a 35
11406 \begin_inset space \thinspace{}
11409 mm slide, making it a bit easier to work with this medium.
11412 \begin_layout Labeling
11413 \labelwidthstring MMMMMMx
11418 Places a rule across the page below the header on every page except the
11422 \begin_layout Labeling
11423 \labelwidthstring MMMMMMx
11428 Places a rule across the page above the footer on every page except the
11432 \begin_layout Labeling
11433 \labelwidthstring MMMMMMx
11438 This is automatically set each time you create a new
11445 Foil\SpecialChar TeX
11448 to use the dvips driver to rotate those pages that are set as landscape
11452 \begin_layout Labeling
11453 \labelwidthstring MMMMMMx
11458 Simply changes the page dimensions to those of a landscape page but doesn't
11460 Thus if you use this option you need to use an external program to rotate
11461 each page or feed your paper through your printer as landscape.
11462 Note that this option effectively reverses the roles of the
11470 environments (don't worry these are described in the next section).
11473 \begin_layout Labeling
11474 \labelwidthstring MMMMMMx
11479 Equation numbers on the left.
11482 \begin_layout Labeling
11483 \labelwidthstring MMMMMMx
11488 Flush-left equations.
11491 \begin_layout Subsection
11492 Supported Environments
11495 \begin_layout Standard
11496 Most of the environments commonly supported in other classes are also supported
11502 There are several additional environments provided by
11504 Foil\SpecialChar TeX
11507 as well as a couple added by \SpecialChar LyX
11509 The following environments are shared with other classes:
11512 \begin_layout Standard
11513 \begin_inset Flex Multiple Columns
11516 \begin_layout Itemize
11522 \begin_layout Itemize
11528 \begin_layout Itemize
11534 \begin_layout Itemize
11540 \begin_layout Itemize
11546 \begin_layout Itemize
11553 \begin_layout Itemize
11559 \begin_layout Itemize
11565 \begin_layout Itemize
11571 \begin_layout Itemize
11577 \begin_layout Itemize
11583 \begin_layout Itemize
11589 \begin_layout Itemize
11595 \begin_layout Itemize
11601 \begin_layout Itemize
11612 \begin_layout Standard
11613 That is, all the major environments apart from the sectioning environments.
11614 Since foils are essentially self-contained sections, with a title and body,
11617 Foil\SpecialChar TeX
11620 provides specific commands for starting new foils and these are:
11623 \begin_layout Itemize
11629 \begin_layout Itemize
11635 \begin_layout Standard
11637 also provides slightly modified versions of these two environments called:
11640 \begin_layout Itemize
11646 \begin_layout Itemize
11649 ShortRotatefoilhead
11652 \begin_layout Standard
11653 and the differences will be explained in the next section.
11656 \begin_layout Standard
11657 Since foils are often used in presenting ideas or new theorems and such
11660 Foil\SpecialChar TeX
11663 also provides a comprehensive box of goodies for presenting them:
11666 \begin_layout Standard
11667 \begin_inset Flex Multiple Columns
11670 \begin_layout Itemize
11676 \begin_layout Itemize
11682 \begin_layout Itemize
11688 \begin_layout Itemize
11694 \begin_layout Itemize
11700 \begin_layout Itemize
11706 \begin_layout Itemize
11712 \begin_layout Itemize
11718 \begin_layout Itemize
11724 \begin_layout Itemize
11730 \begin_layout Itemize
11741 \begin_layout Standard
11742 The starred versions are unnumbered while the unstarred versions are numbered.
11743 There are also two list environments added by \SpecialChar LyX
11747 \begin_layout Itemize
11753 \begin_layout Itemize
11759 \begin_layout Standard
11762 Foil\SpecialChar TeX
11765 provides some powerful header and footer capabilities that are best set
11766 in the preamble although they may be set at any point in a document.
11767 If you want to change these settings in your document the best place to
11768 do so is at the very top of a foil, i.
11769 \begin_inset space \thinspace{}
11775 \begin_inset space \space{}
11780 straight after the foilhead.
11783 \begin_layout Standard
11784 For this purpose, the following command styles are provided [
11791 \begin_layout Standard
11792 \begin_inset Flex Multiple Columns
11795 \begin_layout Itemize
11799 \begin_inset space ~
11805 \begin_layout Itemize
11811 \begin_layout Itemize
11815 \begin_inset space ~
11821 \begin_layout Itemize
11825 \begin_inset space ~
11831 \begin_layout Itemize
11835 \begin_inset space ~
11842 \begin_layout Plain Layout
11843 \begin_inset space ~
11855 \begin_layout Standard
11856 There are also a few commands provided by
11858 Foil\SpecialChar TeX
11861 that aren't directly supported by \SpecialChar LyX
11862 but I'll tell you what they do and how
11863 to use them in section
11864 \begin_inset space ~
11868 \begin_inset CommandInset ref
11870 reference "sec:unsuppfoils"
11877 \begin_layout Subsection
11878 Building a Set of Foils
11881 \begin_layout Standard
11882 This section will give a simple introduction to using the different environments
11883 to build a set of foils.
11884 If you want to see an example set of foils, take a look at the
11888 file you find in \SpecialChar LyX
11896 \begin_layout Subsubsection
11897 Give It a Title Page
11900 \begin_layout Standard
11901 Unlike other classes that provide
11921 creates the title on a page of its own.
11922 If you leave out the
11926 environment \SpecialChar LaTeX
11927 will substitute the current date (every time you regenerate
11931 \begin_layout Subsubsection
11935 \begin_layout Standard
11936 As I mentioned earlier, there are four ways of starting a new foil.
11937 For portrait foils you should use
11946 The difference between these two environments is the amount of space between
11947 the title of the foil (the foilhead) and the body of the foil.
11950 \begin_layout Standard
11951 Landscape foils are generated using the
11957 ShortRotatefoilhead
11960 Again the only difference is the spacing between foilhead and body.
11961 Both of the short versions have 0.5
11962 \begin_inset space ~
11965 inches less separation between the foilhead and the body.
11969 \begin_layout Standard
11970 One problem with the support for landscape foils is the requirement that
11971 you have to use the
11975 driver to generate the PostScript output otherwise the foils won't be rotated.
11976 It is possible to get landscape foils even if you haven't got the
11980 driver provided you can feed your foils sideways through your printer ;-)
11983 \begin_layout Subsubsection
11984 Theorems, Lemmas, Proofs and more
11987 \begin_layout Standard
11988 You can't have two of the same type of these environments directly following
11990 If you use a normal paragraph break, , you will just be extending the previous
11991 environment as if you had merged the two environments together.
11992 Rather than that, you need to insert a so-called separator.
11993 Please refer to the section entitled
12004 \begin_layout Subsubsection
12008 \begin_layout Standard
12009 You get all the commonly supported list styles found in other classes as
12010 well as two new ones.
12011 I'll only describe the new ones here.
12012 If you want to find out more about the other list environments check out
12018 If you intend to use itemized lists you might also want to read about the
12022 \begin_inset space ~
12026 \begin_inset space ~
12031 dialog described above in section
12032 \begin_inset space ~
12036 \begin_inset CommandInset ref
12038 reference "sec:bullet"
12045 \begin_layout Standard
12046 The two new list styles,
12054 , are designed to make it easier for you to create lists of do's and don'ts
12055 or right and wrong by providing dedicated environments that use a tick
12056 or a cross as the label of the list.
12057 These lists are in fact dedicated variants of the
12062 They do however require that you have the
12066 packages installed.
12069 \begin_layout Subsubsection
12073 \begin_layout Standard
12076 Foil\SpecialChar TeX
12079 redefines the floating tables and figures so that they appear exactly where
12080 they are in the text rather than pushing them to the top of the page or
12081 to some user specified location.
12082 In fact if you change the float placement settings they are simply ignored.
12085 \begin_layout Subsubsection
12086 Page Headers and Footers
12087 \begin_inset CommandInset label
12089 name "sec:foilfoot"
12096 \begin_layout Standard
12100 \begin_inset space ~
12109 are two commands used to control the left-footer text string.
12110 The first is meant to allow you to include a graphic logo on your foils
12112 \begin_inset Quotes eld
12117 Foil\SpecialChar TeX
12121 \begin_inset Quotes erd
12125 While the second is meant to provide a classification for the audience,
12129 \begin_inset space \thinspace{}
12135 \begin_inset space \space{}
12139 It is empty by default.
12142 \begin_layout Standard
12143 The remaining page corners can be filled by
12146 \begin_inset space ~
12151 (which defaults to page numbers),
12154 \begin_inset space ~
12162 \begin_inset space ~
12170 \begin_layout Subsection
12173 Foil\SpecialChar TeX
12177 \begin_inset CommandInset label
12179 name "sec:unsuppfoils"
12186 \begin_layout Standard
12187 All the commands mentioned below need to be set in a
12197 within another environment.
12200 \begin_layout Subsubsection
12204 \begin_layout Standard
12205 All lengths are adjusted using the
12228 should be replaced by the name given to the length you want to change and
12233 is the length value.
12234 All lengths should be specified in units of length such as inches (
12246 ) or relative to some document or font-based length such as
12256 \begin_layout Standard
12257 It's possible to change the spacing between a foilhead and the body of the
12258 foil by adjusting the length specified by
12265 For example, to make
12270 \begin_inset space \space{}
12273 in closer to their bodies put the following in the preamble:
12279 foilheadskip}{-0.5in}
12282 \begin_layout Standard
12283 The spacings around floats can be adjusted by setting these lengths:
12286 \begin_layout Labeling
12287 \labelwidthstring MMMMMMMMMMM
12294 Separation between the text and the top of the float
12297 \begin_layout Labeling
12298 \labelwidthstring MMMMMMMMMMM
12305 Separation between the float and the caption
12308 \begin_layout Labeling
12309 \labelwidthstring MMMMMMMMMMM
12316 Separation between the caption and the following text
12319 \begin_layout Labeling
12320 \labelwidthstring MMMMMMMMMMM
12327 You can make the captions narrower than the surrounding text by adjusting
12329 Best done relative to
12338 \begin_layout Standard
12339 There are also several title page related lengths that you may find useful
12340 if you have a long title or several authors:
12343 \begin_layout Labeling
12344 \labelwidthstring MMMMMMMMMMM
12351 Separation from headers to
12356 \begin_layout Labeling
12357 \labelwidthstring MMMMMMMMMMM
12375 \begin_layout Labeling
12376 \labelwidthstring MMMMMMMMMMM
12390 \begin_layout Labeling
12391 \labelwidthstring MMMMMMMMMMM
12407 \begin_layout Labeling
12408 \labelwidthstring MMMMMMMMMMM
12424 \begin_layout Standard
12425 The last length related command affects all the list environments.
12436 a list environment then all the vertical spacing between the list items
12438 Note that this is a command not a length so it doesn't require
12444 like the stuff mentioned above.
12447 \begin_layout Subsubsection
12448 Headers and Footers
12451 \begin_layout Standard
12464 commands control whether the logo in the
12468 definition appear on a given page.
12475 in the preamble then none of the foils will have the logo on them.
12476 If you don't want the logo on a particular page place the
12482 directly after the foilhead of that page and the
12488 directly after the next foilhead.
12491 \begin_layout Standard
12492 If you decide to use the
12496 page style setting in the
12499 \begin_inset space ~
12504 dialog you should probably add
12514 to your preamble so headers and footers on landscape pages are correctly
12515 placed when rotated.
12516 This is due to some clashes between the page layouts provided by the
12527 \begin_layout Section
12528 Hollywood (Hollywood spec scripts)
12531 \begin_layout Standard
12537 \begin_layout Subsection
12541 \begin_layout Standard
12542 Getting the format of a Hollywood script right is a
12543 \begin_inset Quotes eld
12547 \begin_inset Quotes erd
12550 It is designed to make the readers focus on content and to be easy and
12551 familiar for the actors to read.
12552 Each page of a script should be one minute of film.
12553 Nothing goes in a script that you cannot see or hear on screen.
12554 The courier 12 pt font should be used throughout.
12558 \begin_layout Subsection
12562 \begin_layout Standard
12563 Speakers' lines should NEVER break in mid-sentence.
12564 If a speaker's lines continue over a page break, repeat the
12568 title followed by (Cont'd).
12571 \begin_layout Subsection
12575 \begin_layout Standard
12580 names as labels then cross-reference the label to insert the name.
12581 The cross-reference dialog will show the current cast of characters.
12582 You can use this to insert the speaker name in narratives also.
12585 \begin_layout Subsection
12586 Paper size and Margins
12589 \begin_layout Standard
12590 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12593 \begin_layout Subsection
12597 \begin_layout Standard
12598 The following environments are available.
12599 You can use hollywood.bind to get the bind keys shown at the right.
12602 \begin_layout Itemize
12606 \begin_inset Newline newline
12611 Used where nothing else works.
12615 \begin_layout Itemize
12621 \begin_inset space \hfill{}
12629 \begin_inset Newline newline
12632 Usually followed by something like
12633 \begin_inset Quotes eld
12636 on Sally waking up.
12637 \begin_inset Quotes erd
12643 \begin_layout Itemize
12647 \begin_inset space \hfill{}
12651 \begin_inset Newline newline
12656 Introduces a new INTERIOR camera set-up.
12657 Always followed by DAY or NIGHT, or something similar to define the lighting
12659 Everthing on this line in CAPS.
12662 \begin_layout Itemize
12666 \begin_inset space \hfill{}
12670 \begin_inset Newline newline
12675 Introduces a new EXTERIOR camera set-up.
12676 Everthing on this line in CAPS.
12679 \begin_layout Itemize
12683 \begin_inset space \hfill{}
12687 \begin_inset Newline newline
12692 The character speaking.
12695 \begin_layout Itemize
12699 \begin_inset space \hfill{}
12703 \begin_inset Newline newline
12708 Instructions to the speaker.
12709 The () are automatically inserted.
12712 \begin_layout Itemize
12716 \begin_inset space \hfill{}
12720 \begin_inset Newline newline
12732 \begin_layout Itemize
12736 \begin_inset space \hfill{}
12740 \begin_inset Newline newline
12745 Camera movement instruction.
12747 \begin_inset space \thinspace{}
12751 \begin_inset space \space{}
12757 \begin_layout Itemize
12761 \begin_inset space \hfill{}
12767 \begin_layout Itemize
12771 \begin_inset space \hfill{}
12777 \begin_layout Itemize
12781 \begin_inset space \hfill{}
12787 \begin_layout Itemize
12791 \begin_inset space \hfill{}
12797 \begin_layout Subsection
12801 \begin_layout Itemize
12805 \begin_layout Itemize
12809 \begin_layout Itemize
12811 \begin_inset space \thinspace{}
12818 \begin_layout Itemize
12823 \begin_layout Itemize
12824 PAN — camera movement
12827 \begin_layout Itemize
12828 INSERT — cut to close-up of
12831 \begin_layout Section
12835 \begin_layout Standard
12838 Panayotis Papasotiriou
12841 \begin_layout Subsection
12845 \begin_layout Standard
12846 The ijmpc package is a set of macros that facilitates electronic manuscript
12849 International Journal of Modern Physics C
12852 Similarly, the ijmpd package is for creating manuscripts to be submitted
12855 International Journal of Modern Physics D
12858 Both journals are published by World Scientific.
12859 The corresponding document classes are named
12868 These files, together with instructions for the authors, can be downloaded
12870 \begin_inset Flex URL
12873 \begin_layout Plain Layout
12875 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12881 \begin_inset Flex URL
12884 \begin_layout Plain Layout
12886 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12892 Both packages are modified versions of the standard
12893 \begin_inset Quotes eld
12897 \begin_inset Quotes erd
12900 package, and they are almost (but not exactly) identical.
12901 Most of their features are supported by \SpecialChar LyX
12903 I have used \SpecialChar LyX
12904 successfully to write articles submitted to both journals
12905 without any problem.
12908 \begin_layout Subsection
12912 \begin_layout Standard
12913 As usual, the easiest way to write a paper is to start with a template.
12916 File\SpecialChar menuseparator
12932 This will give an (almost) empty document that includes the most common
12933 fields found in a manuscript.
12934 Simply overwrite the existing text (including the brackets,
12939 You should keep in mind the following remarks.
12942 \begin_layout Enumerate
12944 won't let you change the font size and the page style of the document,
12945 because such modifications are not allowed by both packages.
12948 \begin_layout Enumerate
12949 The language of the document should not be changed.
12950 Before previewing your paper, be sure that the babel package is not used.
12951 To do this, click on
12954 arg "dialog-show document"
12959 \SpecialChar menuseparator
12963 \begin_inset Quotes eld
12967 \begin_inset Quotes erd
12977 \begin_layout Enumerate
12979 \begin_inset Quotes eld
12983 \begin_inset Quotes erd
12986 style must be used to define keywords.
12989 \begin_layout Enumerate
12990 The ijmpc package provides a style named
12991 \begin_inset Quotes eld
12994 Classification Codes
12995 \begin_inset Quotes erd
12998 , which can be used to define classification codes, such as PACS numbers.
12999 Note that this facility is not supported by the ijmpd package.
13002 \begin_layout Enumerate
13003 Several new environments are available:
13004 \begin_inset Quotes eld
13008 \begin_inset Quotes erd
13012 \begin_inset Quotes eld
13016 \begin_inset Quotes erd
13020 \begin_inset Quotes eld
13024 \begin_inset Quotes erd
13028 \begin_inset Quotes eld
13032 \begin_inset Quotes erd
13036 \begin_inset Quotes eld
13040 \begin_inset Quotes erd
13044 \begin_inset Quotes eld
13048 \begin_inset Quotes erd
13052 \begin_inset Quotes eld
13056 \begin_inset Quotes erd
13060 \begin_inset Quotes eld
13064 \begin_inset Quotes erd
13068 \begin_inset Quotes eld
13072 \begin_inset Quotes erd
13076 \begin_inset Quotes eld
13080 \begin_inset Quotes erd
13084 \begin_inset Quotes eld
13088 \begin_inset Quotes erd
13092 \begin_inset Quotes eld
13096 \begin_inset Quotes erd
13100 \begin_inset Quotes eld
13104 \begin_inset Quotes erd
13108 \begin_inset Quotes eld
13112 \begin_inset Quotes erd
13116 Their use is more or less obvious.
13118 supports all these environments; it will use the proper label, text style,
13119 and numbering scheme for each of them.
13122 \begin_layout Enumerate
13123 Both packages use basic citations; the natbib package should not be used.
13124 In \SpecialChar LyX
13125 , citation references are shown as usual; in the output, citations are
13126 shown as superscripts.
13127 If you want to use a citation as normal text, you should use the
13132 \begin_inset space \thinspace{}
13136 \begin_inset space \space{}
13140 \begin_inset Quotes eld
13144 \begin_inset space \space{}
13154 \begin_inset Quotes erd
13160 \begin_layout Enumerate
13162 \begin_inset Quotes eld
13166 \begin_inset Quotes erd
13169 section in both packages.
13170 To put acknowledgments, just use the
13171 \begin_inset Quotes eld
13175 \begin_inset Quotes erd
13181 \begin_layout Enumerate
13182 Appendices may be added to the paper,
13186 the Acknowledgments and
13192 provides a special environment, called
13193 \begin_inset Quotes eld
13197 \begin_inset Quotes erd
13200 which marks the beginning of the appendices.
13201 This environment should be left blank; it just sends a \SpecialChar LaTeX
13202 command, but nothing
13204 In \SpecialChar LyX
13206 \begin_inset Quotes eld
13210 \begin_inset Quotes erd
13213 is printed with blue letters, as a signal that all sections after that
13214 point are appendices.
13215 To write an appendix, use the
13216 \begin_inset Quotes eld
13220 \begin_inset Quotes erd
13225 will number each appendix with capital letters, as required by both journals.
13227 \begin_inset Quotes eld
13231 \begin_inset Quotes erd
13238 be present before the first appendix; if not, all appendices will be numbered
13239 as normal sections in the output.
13242 \begin_layout Enumerate
13243 The ijmpc and the ijmpd packages use the
13247 command to implement table captions.
13248 As a result, a table created by \SpecialChar LyX
13249 is printed correctly, but its caption
13251 However, you can use some \SpecialChar TeX
13252 code to overcome this problem, so that captions
13253 are printed as expected.
13254 To do so, create a float table as usual, remove the caption, and replace
13255 it with the \SpecialChar TeX
13266 (sic); you must also the \SpecialChar TeX
13271 immediately after the tabular material.
13272 Study the example table included in the template files to see how this
13273 trick is implemented.
13274 Alternatively, If you need table captions, you should implement the whole
13279 file, then include this file to the \SpecialChar LyX
13282 Insert\SpecialChar menuseparator
13283 File\SpecialChar menuseparator
13285 \begin_inset space ~
13291 Details on how to create a table float can be found in the files
13299 , included in the corresponding packages.
13302 \begin_layout Subsection
13303 Preparing a paper for submission
13306 \begin_layout Standard
13307 Before you submit your paper you must export the \SpecialChar LyX
13308 document as a \SpecialChar LaTeX
13311 File\SpecialChar menuseparator
13312 Export\SpecialChar menuseparator
13320 \begin_layout Plain Layout
13321 Actually you have the choice between \SpecialChar LaTeX
13322 (plain) and pdflatex.
13323 If you intend to use pdflatex to prepare the paper, you should use the
13324 pdflatex option so that included graphics are converted to PDF format,
13325 ready for use by pdflatex.
13330 , then make the following changes to the resulting
13337 \begin_layout Enumerate
13338 Remove the comment lines before the
13347 \begin_layout Enumerate
13348 Remove everything between (and including) the
13360 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13364 \begin_layout Standard
13369 file should be saved and processed through \SpecialChar LaTeX
13370 as many times as necessary.
13371 You may also want to check the resulting
13378 \begin_layout Section
13382 \begin_layout Standard
13388 \begin_layout Subsection
13392 \begin_layout Standard
13393 The iopart package provides a document class to create electronic manuscript
13394 submission to the journals published by the Institute of Physics.
13395 Instructions for the authors how to create a paper using the iopart class
13396 can be downloaded together with the iopart package from the site
13397 \begin_inset Flex URL
13400 \begin_layout Plain Layout
13402 ftp://ftp.iop.org/pub/journals/latex2e
13410 \begin_layout Subsection
13414 \begin_layout Standard
13415 The easiest way to write a paper is to start with the template
13419 that is available via
13421 File\SpecialChar menuseparator
13424 The template explains how to use the special text environments.
13425 Here are the most important advices:
13428 \begin_layout Itemize
13429 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13430 no AMS packages are loaded in
13432 Document\SpecialChar menuseparator
13433 Settings\SpecialChar menuseparator
13439 \begin_layout Itemize
13442 The title environment defines the kind of your paper.
13443 So use one of the following environments for the title:
13447 \begin_layout Itemize
13456 \begin_layout Itemize
13465 \begin_layout Itemize
13471 for a Topical review
13474 \begin_layout Itemize
13483 \begin_layout Itemize
13492 \begin_layout Itemize
13498 for a Paper (same as Title)
13501 \begin_layout Itemize
13507 for a Preliminary communication
13510 \begin_layout Itemize
13516 for a Rapid communication
13519 \begin_layout Itemize
13525 for a Letter to the editor
13529 \begin_layout Itemize
13532 All title environments except of
13536 can have an optional short title.
13539 \begin_layout Itemize
13540 There is a general title environment
13544 which is not directly supported by \SpecialChar LyX
13546 This can be used as \SpecialChar TeX
13547 code when your document doesn't fit into one of the
13551 \begin_layout Standard
13552 For more informations like hints for special table and formula formatting,
13553 look at the IOP author guidelines.
13556 \begin_layout Section
13560 \begin_layout Standard
13563 Panayotis Papasotiriou
13566 \begin_layout Subsection
13570 \begin_layout Standard
13571 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13572 that facilitates electronic manuscript submission to the journals they
13574 Most known of them (at least in my domain of interest) are
13576 Astrophysics and Space Science
13582 , but there are many others (see a complete list at
13583 \begin_inset Flex URL
13586 \begin_layout Plain Layout
13588 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13594 The Kluwer package may be downloaded from the site
13595 \begin_inset Flex URL
13598 \begin_layout Plain Layout
13600 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13606 A complete user guide is contained in that package (but it can also be
13607 downloaded separately).
13610 \begin_layout Standard
13612 supports many features of the package but not everything.
13613 However, the \SpecialChar TeX
13614 code needed is reduced to some
13615 \begin_inset Quotes eld
13619 \begin_inset Quotes erd
13622 commands of the package (see
13623 \begin_inset space ~
13627 \begin_inset CommandInset ref
13629 reference "subsec:kluwer_peculiarities"
13634 I have recently used \SpecialChar LyX
13635 to write an article submitted to the
13637 Astrophysics and Space Science
13639 without any problem.
13642 \begin_layout Subsection
13646 \begin_layout Standard
13647 The easiest way to write a paper is to start with the Kluwer template file.
13650 File\SpecialChar menuseparator
13662 This will give an (almost) empty document that includes the most common
13663 fields found in a manuscript and a short description of their use.
13664 As in most templates, simply overwrite the existing text (including the
13669 ) with the correct information.
13672 \begin_layout Subsection
13673 Preparing a paper for submission
13676 \begin_layout Standard
13677 As in the AAS\SpecialChar TeX
13678 package, before you submit your paper to a journal you must
13680 \begin_inset Quotes eld
13684 \begin_inset Quotes erd
13690 \begin_layout Enumerate
13691 Export your paper as a \SpecialChar LaTeX
13693 To do this, click on
13695 File\SpecialChar menuseparator
13696 Export\SpecialChar menuseparator
13704 \begin_layout Enumerate
13709 file with a text editor and make the following changes
13713 \begin_layout Enumerate
13714 remove the comment lines before the
13723 \begin_layout Enumerate
13724 remove everything between (and including) the
13736 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13740 \begin_layout Standard
13749 \begin_layout Enumerate
13754 file through \SpecialChar LaTeX
13755 as many times as necessary (usually up to three).
13758 \begin_layout Enumerate
13764 \begin_inset space \thinspace{}
13768 \begin_inset space \space{}
13775 , and check if everything is OK (it should, if you didn't make any mistake).
13778 \begin_layout Subsection
13779 \begin_inset Quotes eld
13783 \begin_inset Quotes erd
13786 of the Kluwer package
13787 \begin_inset CommandInset label
13789 name "subsec:kluwer_peculiarities"
13796 \begin_layout Standard
13797 The Kluwer package has the following
13798 \begin_inset Quotes eld
13802 \begin_inset Quotes erd
13808 \begin_layout Enumerate
13809 It is possible to write multiple articles in the same \SpecialChar LaTeX
13814 \begin_layout Plain Layout
13815 I can't imagine any good reason to do this.
13821 Each article must be included in the environment
13822 \begin_inset Quotes eld
13826 \begin_inset Quotes erd
13830 Unfortunately, this environment cannot be omitted, even if you write just
13832 Therefore, each article starts with the command
13838 and, obviously, ends with the command
13845 Although this can be implemented in \SpecialChar LyX
13846 , I didn't included it, since it looks
13847 ugly and can confuse the novice user.
13848 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13851 \begin_inset Quotes eld
13856 \begin_inset Quotes erd
13862 \begin_layout Enumerate
13863 Information given at the beginning of the article (i.
13864 \begin_inset space \thinspace{}
13868 \begin_inset space \space{}
13871 title, subtitle, author, institution, running title, running author, abstract
13872 and keywords) must be included in an environment called
13873 \begin_inset Quotes eld
13877 \begin_inset Quotes erd
13881 This is not implemented in \SpecialChar LyX
13882 , so you must enter title, subtitle etc.
13883 \begin_inset space ~
13886 between two \SpecialChar TeX
13902 \begin_layout Enumerate
13903 According to the user manual, the label of each bibliography item must be
13927 \begin_layout Standard
13932 template takes care of all these
13933 \begin_inset Quotes eld
13937 \begin_inset Quotes erd
13941 If you start a new paper using this template you don't need to do anything
13946 \begin_layout Enumerate
13947 don't delete the \SpecialChar TeX
13948 code included in the template, and
13951 \begin_layout Enumerate
13952 copy the example bibliography item included in the template and modify it
13953 as necessary to enter new bibliography items.
13956 \begin_layout Section
13960 \begin_layout Standard
13966 \begin_layout Subsection
13970 \begin_layout Standard
13971 The \SpecialChar LyX
13974 article (koma-script)
13978 report (koma-script)
13996 correspond to the \SpecialChar LaTeX
14014 \begin_inset space ~
14017 of the Koma-Script family.
14018 They are replacements for the standard document classes
14034 , resp., and fit better to European typography conventions in a number of
14038 \begin_layout Itemize
14039 Standard character size is 11pt in
14041 article (koma-script)
14045 report (koma-script)
14053 letter (koma-script)
14058 \begin_layout Itemize
14059 Headings, labels of the description environment, and a number of elements
14062 letter (koma-script)
14064 document class are set in a bold sans serif font.
14068 \begin_layout Plain Layout
14069 There is a big difference between the bold sans serif old cm fonts and new
14070 ec fonts, especially in the appearance of headings.
14071 In comparison, the ec bold sans serif fonts look a bit thin.
14072 Here the \SpecialChar LaTeX
14081 helps to produce the
14082 \begin_inset Quotes eld
14086 \begin_inset Quotes erd
14089 appearance when using the ec fonts.
14094 The numbering of chapter headings is made in the same way as the numbering
14095 of section headings, that is without the extra line
14096 \begin_inset Quotes eld
14099 Chapter\SpecialChar ldots
14101 \begin_inset Quotes erd
14105 In addition, the appearance of the headings can be modified by using a
14106 number of options (in \SpecialChar LyX
14107 to be entered in the field
14110 \begin_inset space ~
14117 Layout\SpecialChar menuseparator
14124 \begin_layout Itemize
14125 The main means in the Koma-Script document classes to design the type area
14134 (in \SpecialChar LyX
14135 to be entered in the extra class options field in the dialog
14137 Document\SpecialChar menuseparator
14141 They make a clearer modification of page margins possible as do the options
14144 Document\SpecialChar menuseparator
14151 \begin_layout Itemize
14152 The \SpecialChar LaTeX
14153 document classes of the Koma-Script family define a number of additional
14155 Those part of it which makes sense in \SpecialChar LyX
14156 is implemented in corresponding
14160 \begin_layout Standard
14161 Detailed descriptions of the \SpecialChar LaTeX
14162 document classes of the Koma-Script family
14163 can be found in the Koma-Script documentation
14174 \begin_layout Subsection
14175 article (koma-script), report (koma-script), and book (koma-script)
14178 \begin_layout Standard
14179 The document classes
14181 article (koma-script)
14185 report (koma-script)
14195 are implemented in the layout files
14208 They contain all the paragraph types of the corresponding standard document
14221 , resp., partly modified, with the exception of the \SpecialChar LyX
14226 -type, which is replaced by the new
14230 -type having the same functionality.
14235 -Type there is a number of new paragraph types added.
14242 letter (koma-script)
14247 \begin_layout Itemize
14256 : are equivalents to
14264 , resp., additionally inserting an entry in the table of contents.
14273 are not contained in
14275 article (koma-script)
14280 \begin_layout Itemize
14289 : behave exactly as
14297 , resp., additionally clearing running heads.
14302 is not contained in
14304 article (koma-script)
14310 \begin_layout Plain Layout
14323 report (koma-script)
14325 , but since this is identical to
14329 , is has not been implemented in \SpecialChar LyX
14338 \begin_layout Itemize
14343 : generates a heading directly above the following paragraph in the standard
14344 character size without affecting the structure of the document.
14347 \begin_layout Itemize
14356 are special captions which respect the different space settings needed
14357 for captions placed above or below an element (if you follow strict typographic
14358 rules, you might want to place table captions always above the table).
14359 You can also use the class option
14363 , which will switch
14376 You need at least Koma-Script version 2.8q to use this.
14379 \begin_layout Itemize
14384 : can be used to set a bonmot, e.
14385 \begin_inset space \thinspace{}
14389 \begin_inset space \space{}
14392 at the beginning of a chapter.
14393 If you use the optional argument (
14395 Insert\SpecialChar menuseparator
14397 \begin_inset space ~
14402 ), you can insert the dictum's author there.
14403 Dictum and author are separated by a line.
14404 You need at least Koma-Script version 2.8q to use this.
14409 is not contained in
14411 article (koma-script)
14416 \begin_layout Standard
14417 The following types, together with the standard types
14429 , form the title area of the document.
14430 They must be entered ahead of the first
14431 \begin_inset Quotes eld
14435 \begin_inset Quotes erd
14442 \begin_layout Plain Layout
14443 The corresponding \SpecialChar LaTeX
14444 commands must appear before the
14455 When such a type is used more than once, the latter usage overwrites the
14456 former one, that means, for every type only the latest usage is valid.
14457 The order of the different types however has, like
14469 , no effect on the appearance of the produced document.
14472 \begin_layout Itemize
14477 : produces a centered paragraph above the ordinary title (
14489 ) for the subject of the document.
14492 \begin_layout Itemize
14497 : produces a centered paragraph below the ordinary title (
14509 ) for the publishers' name.
14512 \begin_layout Itemize
14519 report (koma-script)
14525 produces a centered paragraph on its own page behind the title page, or
14528 article (koma-script)
14530 produces a centered paragraph below the ordinary title (
14546 ) for a dedication.
14549 \begin_layout Itemize
14554 : produces a left aligned paragraph above the ordinary title (
14570 ) for a document`s head.
14573 \begin_layout Itemize
14578 : produces in a double-sided print in
14580 report (koma-script)
14586 a left-aligned paragraph at the top of the title page`s back or has no
14587 effect in a single-sided print or in
14589 article (koma-script)
14594 \begin_layout Itemize
14599 : produces in a double-sided print in
14601 report (koma-script)
14607 a left-aligned paragraph at the bottom of the title page`s back or has
14608 no effect in a single-sided print or in
14610 article (koma-script)
14615 \begin_layout Itemize
14620 : produces a special
14621 \begin_inset Quotes eld
14625 \begin_inset Quotes erd
14628 page ahead of the actual document containing a paragraph without special
14632 \begin_layout Standard
14633 The layout files for the document classes
14635 article (koma-script)
14639 report (koma-script)
14645 do include the file
14650 This is thought of as a place to define your own types.
14655 in your personal layout directory and edit the file!
14658 \begin_layout Subsection
14659 letter (koma-script)
14662 \begin_layout Description
14663 Note: This section discusses the obsolete
14665 KOMA-Script-Letter (v.
14666 \begin_inset space ~
14671 , which is not even included anymore in recent KOMA releases.
14672 Please refer to the next section for the current KOMA-Script-Letter class
14674 \begin_inset space ~
14680 \begin_layout Standard
14684 letter (koma-script)
14686 is implemented in the layout file
14691 It contains all the paragraph types of the corresponding standard document
14696 , partly modified, with the exception of the \SpecialChar LyX
14710 type, which is replaced by the new
14715 In addition, it contains, in contrast to the standard document class, the
14734 Furthermore, there are a number of new letter specific types.
14737 \begin_layout Standard
14738 The appearance of the letter produced by this document class can be controlled
14739 by a number of \SpecialChar LaTeX
14740 commands, which you can put in the \SpecialChar LaTeX
14745 \begin_layout Plain Layout
14746 For example, the standard appearance of the letter`s heading, consisting
14747 of name and address, is quite self-willed.
14749 \begin_inset Quotes eld
14753 \begin_inset Quotes erd
14756 heading is produced by the following \SpecialChar LaTeX
14757 commands in the preamble:
14760 \begin_layout LyX-Code
14770 \begin_layout LyX-Code
14786 \begin_layout LyX-Code
14796 \begin_layout LyX-Code
14816 A detailed German description of such \SpecialChar LaTeX
14817 commands can be found in the Koma-Script
14823 With it, the letter's author can produce his personal letter layout.
14826 \begin_layout Standard
14835 define the beginning of the letter and must be used in every letter.
14836 To emphasize them in the \SpecialChar LyX
14837 document class, they are marked with the letter
14847 \begin_inset space ~
14850 in the left margin.
14851 It is possible to write any number of letters in one file.
14856 type produces a new letter using the same addressee and a
14860 type produces a new addressee.
14877 are ordinary paragraph types and can also be used several times in one
14878 and the same letter.
14881 \begin_layout Itemize
14886 : produces a paragraph for the addressee and implicitly defines the beginning
14890 \begin_layout Itemize
14895 : produces a paragraph for the form of address and implicitly produces a
14899 \begin_layout Itemize
14904 : produces a paragraph for a close.
14907 \begin_layout Itemize
14912 : produces a paragraph for a postscript.
14915 \begin_layout Itemize
14920 : produces a paragraph for a distribution list.
14923 \begin_layout Itemize
14928 : produces a paragraph for enclosures.
14931 \begin_layout Standard
14972 are input types provided with a label to enter information, which will
14973 be processed by the document class.
14977 \begin_layout Plain Layout
14978 It could be seen as a matter of inconsequence, that the types
14986 described above are not such input types as well.
14987 Because of the special meaning of those types, however, I have implemented
14988 them as ordinary paragraph types with a one letter mark in the left margin.
14989 Moreover, it would affect my feeling of symmetry, if the
14997 type had such a serious different appearance.
15002 The types must be used ahead of the corresponding
15009 \begin_layout Standard
15010 An implementation of these types in a WYSIWYG fashion does not seem to make
15011 sense, because the real appearance of the produced letter does not only
15012 depend on the usage of the particular type, but also on other factors.
15013 For example, a signature entered in the
15017 type will in the standard behavior appear in the produced letter only,
15018 when in the same letter also a
15023 The entered value of the
15027 type will in the standard behavior not appear in the produced letter at
15029 The possibility to design the letter`s heading freely is already indicated
15030 in a footnote above.
15033 \begin_layout Standard
15034 The input types can also be used as empty paragraphs.
15035 This makes sense e.
15036 \begin_inset space \thinspace{}
15040 \begin_inset space \space{}
15052 type is not used at all, in the standard behavior the value of the
15056 type is used as signature, whereas if an empty
15060 type is used, no signature value is defined.
15063 \begin_layout Standard
15064 By using the input types it is possible to write a letter template, containing
15065 filled input types with your personal dates (name, address, etc.) and empty
15066 input types for other dates you want to enter.
15069 \begin_layout Itemize
15074 : sender's name, in the standard behavior appears as a centered paragraph
15075 in small caps in the letter`s heading.
15078 \begin_layout Itemize
15083 : sender's signature, in the standard behavior appears below the
15092 type is used, the value of the
15096 type appears instead.
15099 \begin_layout Itemize
15104 : sender's address, in the standard behavior appears in a centered paragraph
15105 in the letter`s heading below the sender's name.
15108 \begin_layout Itemize
15113 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
15124 \begin_layout Itemize
15129 : place of the letter`s making.
15132 \begin_layout Itemize
15137 : date of the letter`s making.
15146 , in the standard behavior, produce the place and the date in a right-aligned
15147 line below the addressee's field.
15152 type is used, neither place nor date appear, independent of the value of
15162 type is used, the date of the letter `s production is used.
15165 \begin_layout Itemize
15170 : sender`s back address, in the standard behavior appears above the addressee's
15171 field in a small sans serif font.
15174 \begin_layout Itemize
15179 : special mail information, in the standard behavior appears underlined
15180 above the addressee's field below the back address.
15183 \begin_layout Itemize
15188 : additional information, in the standard behavior appears on right side
15189 below the addressee`s field.
15192 \begin_layout Itemize
15197 : the letter's title, in the standard behavior appears in a big, bold, sans
15198 serif font above the subject.
15201 \begin_layout Itemize
15206 : the letter's subject, in the standard behavior appears in a bold font
15214 \begin_layout Standard
15235 produce a business letter like line above the
15239 line containing the fields
15240 \begin_inset Quotes eld
15244 \begin_inset Quotes erd
15248 \begin_inset Quotes eld
15252 \begin_inset Quotes erd
15256 \begin_inset Quotes eld
15260 \begin_inset Quotes erd
15264 \begin_inset Quotes eld
15268 \begin_inset Quotes erd
15272 \begin_inset Quotes eld
15276 \begin_inset Quotes erd
15280 \begin_inset Quotes eld
15284 \begin_inset Quotes erd
15288 For the date field, the value of the
15294 \begin_inset Quotes eld
15297 business letter types
15298 \begin_inset Quotes erd
15301 is used, the value of the
15305 type however does not appear, but only the \SpecialChar LaTeX
15313 The ordinary output of place and date in a right-aligned line below the
15314 addressee`s field is suppressed.
15315 The types are implemented as input types provided with a label and must
15316 be used ahead of the corresponding
15323 \begin_layout Itemize
15331 \begin_layout Itemize
15339 \begin_layout Itemize
15347 \begin_layout Itemize
15355 \begin_layout Itemize
15363 \begin_layout Subsection
15364 The new letter class: letter (koma-script v.2)
15367 \begin_layout Standard
15373 \begin_layout Standard
15374 \begin_inset VSpace medskip
15380 \begin_layout Standard
15382 Koma-Script version 2.8 has introduced a new letter class
15386 which supersedes the now unsupported
15391 It has — on the \SpecialChar LaTeX
15392 side — a completely new interface and is not compatible
15393 with the old class.
15394 Therefore, \SpecialChar LyX
15395 supports both, though it is recommended you use the new class.
15398 \begin_layout Standard
15399 This class covers the same functionality as
15401 letter (koma-script),
15404 The basic items are
15408 (receiver's address, same as
15412 in the old layout),
15425 will start a new letter (i.
15426 \begin_inset space \thinspace{}
15430 \begin_inset space \space{}
15433 you can write several letters per document).
15434 New elements are sender's
15450 and the possibility to use a
15456 Insert\SpecialChar menuseparator
15462 \begin_layout Standard
15463 The biggest improvement is, though, that the letter's layout is configurable
15464 to meet almost any needs.
15465 This can be done via the preamble or with a special style file (Letter
15466 Class Option, extension
15470 ), that will be read in as a class option.
15474 \begin_layout Plain Layout
15475 The KOMA package comes with some default
15480 There is, for instance, a
15484 file that follows german typesetting rules, or a
15488 that provides the default layout of the old
15493 The latter can be loaded with the class option
15499 Layout\SpecialChar menuseparator
15500 Document\SpecialChar menuseparator
15512 template that is included in \SpecialChar LyX
15514 A detailed description is to be found in the Koma-Script documentation
15522 \begin_layout Subsection
15526 \begin_layout Standard
15527 Visualizing the Koma-Script document classes in \SpecialChar LyX
15528 , the \SpecialChar LyX
15529 internals cause some
15533 \begin_layout Itemize
15534 The chapter number of a
15538 type appears on a line of its own above the chapter heading instead of
15539 appearing in the same line ahead of it.
15540 The cause for that is the \SpecialChar LyX
15541 internal behavior for the labeltype
15545 in the layout file.
15548 \begin_layout Itemize
15549 The headings of the types
15557 are only put in the
15558 \begin_inset Quotes eld
15562 \begin_inset Quotes erd
15566 table of contents, but not in the \SpecialChar LyX
15567 table of contents (
15569 Document\SpecialChar menuseparator
15571 \begin_inset space ~
15575 \begin_inset space ~
15583 \begin_layout Itemize
15584 The paragraphs in a
15588 document class appear in a skip separation mode, not indented.
15589 This is the standard behavior, no special \SpecialChar LaTeX
15590 commands are needed for that.
15593 Document\SpecialChar menuseparator
15596 dialog the corresponding radio button indicates
15605 value always has the effect that extra \SpecialChar LaTeX
15606 commands are inserted in the document
15607 to produce the gap, which is not what is wanted in this case.
15610 \begin_layout Section
15614 \begin_layout Standard
15620 \begin_layout Subsection
15624 \begin_layout Standard
15625 Memoir is a very powerful and constantly evolving class.
15626 It has been designed with regard to fictional and non-fictional literature.
15627 Its aim is to let the user have maximum control over the typesetting of
15629 Memoir is based on the standard book class, but it can also emulate the
15630 article class (see below).
15633 \begin_layout Standard
15634 Peter Wilson, the developer of Memoir, is known as the author of lots of
15635 useful packages in the \SpecialChar LaTeX
15637 Most of them have been merged with Memoir.
15638 Therefore, it is much easier to layout the table of contents, appendices,
15639 chapter designs and such.
15641 , though, does not support all of these goodies natively.
15642 Some of them might be added to forthcoming releases
15646 \begin_layout Plain Layout
15647 You are invited to send suggestions to
15648 \begin_inset Flex URL
15651 \begin_layout Plain Layout
15653 lyx-devel@lists.lyx.org
15663 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15665 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15667 commands (\SpecialChar TeX
15672 \begin_layout Plain Layout
15677 \begin_layout Plain Layout
15687 \begin_inset space ~
15691 \begin_inset CommandInset ref
15693 reference "sec:Inserting-TeX-Code"
15703 In this section, we can only list those features that are natively supported
15704 by \SpecialChar LyX
15706 For detailed descriptions (and for the rest of features) we recommend you
15707 have a look at the detailed manual of the Memoir class
15711 \begin_layout Plain Layout
15716 \begin_layout Plain Layout
15726 \begin_inset Flex URL
15729 \begin_layout Plain Layout
15731 CTAN:/macros/latex/memoir/memman.pdf
15741 , which is not only a user guide for the class, but also both a comprehensive
15742 description on good typesetting and a superb example for good typesetting
15746 \begin_layout Subsection
15747 Basic features and restrictions
15750 \begin_layout Standard
15751 Memoir supports basically all features of the standard book classes.
15752 There are, however, some differences, as follows:
15755 \begin_layout Description
15757 \begin_inset space ~
15760 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15763 \begin_layout Description
15765 \begin_inset space ~
15768 style: The fancy page style is not supported, due to a command clash between
15769 Memoir and the fancyhdr package (they both define a command with the same
15770 name, which confuses \SpecialChar LaTeX
15772 Instead, Memoir comes with a number of its own page styles (see
15774 Document\SpecialChar menuseparator
15775 Settings\SpecialChar menuseparator
15777 \begin_inset space ~
15783 If you want to use these for the chapter pages, you have to use the command
15790 in the main text or in preamble (e.
15791 \begin_inset space \thinspace{}
15795 \begin_inset space \space{}
15802 chapterstyle{companion}
15807 \begin_layout Description
15808 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15809 optional argument in the standard classes.
15810 With this, you can specify an alternative version of the title for the
15811 table of contents and the headers (for instance, if the title is too long).
15812 In \SpecialChar LyX
15813 , you can do this via
15815 Insert\SpecialChar menuseparator
15817 \begin_inset space ~
15822 at the beginning of a chapter/section.
15823 Memoir features a second optional argument and thus separates the table
15824 of contents from the header.
15825 You can define three variants of a title with this: one for the main text,
15826 one for the table of contents, and one for the headers.
15828 makes these available in form of specific
15839 \begin_layout Description
15840 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15841 of contents, the list of figures and the list of table start a new page
15843 Memoir does not follow this route.
15844 You have to insert a page break yourself, if you want to have one.
15847 \begin_layout Description
15848 Titlepage: For some unknown reason, Memoir uses pagination on the title
15849 page (in the standard classes, title pages are
15850 \begin_inset Quotes eld
15854 \begin_inset Quotes erd
15858 If you want an empty title page, type
15862 aliaspagestyle{title}{empty}
15867 \begin_layout Description
15868 Article: With the class option
15874 Document\SpecialChar menuseparator
15875 Settings\SpecialChar menuseparator
15876 Class Settings\SpecialChar menuseparator
15878 \begin_inset space ~
15883 ), you can emulate article style.
15884 That is, counters (footnotes, figures, tables etc.) will not be reset on
15885 new chapters, chapters don't start a new page (but are—in contrary to
15886 \begin_inset Quotes eld
15890 \begin_inset Quotes erd
15893 article classes—still allowed), parts, though, use their own page, as in
15897 \begin_layout Description
15898 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15899 font commands, which have been used in the old \SpecialChar LaTeX
15901 \begin_inset space \thinspace{}
15905 \begin_inset space \space{}
15921 It produces an error and stops \SpecialChar LaTeX
15922 whenever such a command appears.
15927 reallows the commands and spits out warnings instead (which does at least
15928 not stop \SpecialChar LaTeX
15930 Since a lot of packages and particularly Bib\SpecialChar TeX
15931 style files are still using
15932 those commands, we have decided to use this option by default.
15935 \begin_layout Subsection
15939 \begin_layout Standard
15940 We will only describe the features supported by \SpecialChar LyX
15941 (which is not much currently).
15942 Please consult the Memoir manual
15946 \begin_layout Plain Layout
15951 \begin_layout Plain Layout
15961 \begin_inset Flex URL
15964 \begin_layout Plain Layout
15966 CTAN:/macros/latex/memoir/memman.pdf
15979 \begin_layout Description
15980 Abstract: You may wonder why an abstract is an extra feature.
15981 Well, it is in book class.
15982 Usually books don't have abstracts.
15983 Memoir, however, has.
15984 You can use it wherever and how often you like.
15987 \begin_layout Description
15988 Chapterprecis: You may know this older typesetting style: The contents of
15989 a chapter are summarized below the title and also in the table of contents
15991 \begin_inset space \thinspace{}
15995 \begin_inset space \space{}
16000 Our hero arrives in Troia; he loses some friends; he finds others
16003 Chapterprecis does exactly this.
16004 It is therefore only sensible below a chapter.
16007 \begin_layout Description
16008 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
16009 The epigraph environment provides an elegant way of typesetting such a
16011 The motto itself (text) and its (optional) author (source) are divided
16013 The author (source) can be inserted via
16015 Insert\SpecialChar menuseparator
16022 \begin_layout Description
16023 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
16024 complex figurative poems).
16026 can only support a few of them.
16027 One is poemtitle, which is a centered title for poems, which will also
16028 be added to the table of contents (verse is the standard environment for
16030 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
16032 because they have to be nested inside regular verse environments, which
16033 is not possible with \SpecialChar LyX
16037 \begin_layout Description
16038 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
16041 \begin_layout Section
16042 Article (mwart), book (mwbk) and report (mwrep)
16043 \begin_inset Argument status
16046 \begin_layout Plain Layout
16059 \begin_layout Standard
16065 \begin_layout Standard
16066 The \SpecialChar LyX
16083 correspond to the \SpecialChar LaTeX
16097 They are replacements for the standard document classes
16109 , resp., and fit better to Polish typography conventions in a number of points.
16113 \begin_layout Standard
16117 \begin_layout Itemize
16118 Unnumbered titles (with star, e.
16119 \begin_inset space \thinspace{}
16123 \begin_inset space \space{}
16130 ) are added into table of contents,
16133 \begin_layout Itemize
16134 Additional page styles:
16138 \begin_layout Description
16139 uheadings header with separated lines,
16142 \begin_layout Description
16143 myheadings custom header, contents headers via commands:
16158 \begin_layout Description
16159 myuheadings custom header with separated lines,
16162 \begin_layout Description
16163 outer page number is placed on outer side of page
16167 \begin_layout Itemize
16172 \begin_layout Description
16173 rmheadings serif titles — default,
16176 \begin_layout Description
16177 sfheadings sansserif titles,
16180 \begin_layout Description
16181 authortitle on title page first placed is author next title — default,
16184 \begin_layout Description
16185 titleauthor on title page first placed is title next author,
16188 \begin_layout Description
16189 withmarginpar reserve place on page for margins.
16193 \begin_layout Section
16197 \begin_layout Standard
16202 provides an alternative to the standard
16207 It provides similar functionality, but you might prefer this layout with
16208 sans serif sections, headings, and more.
16211 \begin_layout Section
16212 Rev\SpecialChar TeX
16216 \begin_layout Standard
16222 \begin_layout Standard
16223 \begin_inset VSpace bigskip
16229 \begin_layout Standard
16234 \begin_inset space ~
16239 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16241 \begin_inset Formula $\beta$
16244 release of May, 1999) class.
16247 \begin_layout Standard
16253 textclass, which works with Rev\SpecialChar TeX
16255 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16257 That means that it doesn't interact very well with \SpecialChar LyX
16258 , which requires \SpecialChar LaTeX2e
16260 it has been kludged to work.
16261 Since Rev\SpecialChar TeX
16262 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16267 Rev\SpecialChar TeX
16269 \begin_inset space ~
16274 textclass should also be pretty easy to use.
16277 \begin_layout Standard
16278 These documents are supposed to be used in
16282 to the Rev\SpecialChar TeX
16283 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16285 and assume you'll know what to put in the preamble if necessary.
16288 \begin_layout Subsection
16292 \begin_layout Standard
16293 All you need to do is install Rev\SpecialChar TeX
16294 4, as described in the package's README
16296 The package can be found at The Rev\SpecialChar TeX
16298 \begin_inset Flex URL
16301 \begin_layout Plain Layout
16303 http://publish.aps.org/revtex4/
16309 Install it somewhere that \SpecialChar LaTeX
16311 Test it by trying to \SpecialChar LaTeX
16312 a short Rev\SpecialChar TeX
16313 4 document in some random directory (i.
16314 \begin_inset space \thinspace{}
16318 \begin_inset space \space{}
16321 not the directory where you installed the class file.) Then, if you reconfigure
16323 , it will find the class file and let you use the Rev\SpecialChar TeX
16327 \begin_layout Standard
16328 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16337 \begin_inset space ~
16342 template, found in the templates directory.
16345 \begin_layout Subsection
16349 \begin_layout Standard
16350 Optional arguments to
16357 \begin_inset Quotes eld
16361 \begin_inset Quotes erd
16365 \begin_inset Quotes eld
16369 \begin_inset Quotes erd
16375 \begin_inset space ~
16383 \begin_inset space ~
16389 Remember that in Rev\SpecialChar TeX
16390 , at least one optional argument is required!
16393 \begin_layout Standard
16394 Other preamble matter, like
16401 \begin_inset space ~
16408 \begin_inset space ~
16413 dialog, also as usual.
16416 \begin_layout Subsection
16420 \begin_layout Standard
16421 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16423 For example, the Email layout corresponds to
16430 Note that (at least as of Rev\SpecialChar TeX
16439 layouts are exactly equivalent, so you shouldn't need to use both.
16443 \begin_layout Plain Layout
16444 In case you're curious, both were included so that
16448 would be able to translate both
16468 \begin_layout Subsection
16472 \begin_layout Standard
16473 There are a couple of important unique aspects of Rev\SpecialChar TeX
16474 4 which might cause
16475 bugs that will be even more confusing in \SpecialChar LyX
16479 \begin_layout Standard
16480 In Rev\SpecialChar TeX
16498 The \SpecialChar LyX
16499 equivalent is that there is a separate Thanks layout.
16504 write footnotes in the
16508 layout, or weird things may happen.
16509 See the Rev\SpecialChar TeX
16510 4 documentation for more details.
16513 \begin_layout Standard
16517 \begin_inset space ~
16525 \begin_inset space ~
16534 layouts must be placed
16542 layout and the corresponding
16559 , the \SpecialChar LaTeX
16563 \begin_layout Section
16564 Springer Journals (
16571 \begin_layout Standard
16577 \begin_layout Subsection
16581 \begin_layout Standard
16582 These are the layout files for some of the journal formats used by Springer
16583 Verlag and listed on
16584 \begin_inset Flex URL
16587 \begin_layout Plain Layout
16589 http://www.springer.de/author/tex/help-journals.html
16594 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16596 It is a modular system: the things common to all journals are implemented
16601 , which journal-specific layout files (such as, e.
16602 \begin_inset space \thinspace{}
16606 \begin_inset space \space{}
16613 for Journal of Geodesy) can include.
16616 \begin_layout Standard
16617 This means that implementing support for any other Springer journal on this
16618 list is as simple as writing your own
16626 file following the outline given in
16634 \begin_layout Standard
16635 It is reasonably well tested only for the Journal of Geodesy.
16644 come with the standard \SpecialChar LyX
16646 Install the relevant class file (downloaded from Springer) in a proper
16647 directory, reconfigure \SpecialChar LaTeX
16648 (in the te\SpecialChar TeX
16653 , as root if necessary — doesn't \SpecialChar LyX
16654 take care of this?), reconfigure \SpecialChar LyX
16659 \begin_layout Subsection
16663 \begin_layout Standard
16664 A large number of theorem-like styles —
16676 \begin_layout Standard
16679 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16680 _Title, Author_Running, Institute,
16681 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16684 See the Springer class file documentation for details.
16687 \begin_layout Subsection
16691 \begin_layout Itemize
16703 \begin_layout Itemize
16706 Probability Theory and Related Fields
16712 — Jean-Marc Lasgouttes
16715 \begin_layout Standard
16716 Add your own, it isn't so hard!
16719 \begin_layout Subsection
16723 \begin_layout Standard
16724 These files are partly based on the older
16728 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16730 file from Springer.
16735 layout, are now defunct.
16736 Jean-Marc Lasgouttes helped out big in making me find my way around the
16738 layout file mechanism.
16741 \begin_layout Subsection
16745 \begin_layout Standard
16747 But probably less than in the old hacked-\SpecialChar LaTeX
16755 \begin_layout Section
16758 Sli\SpecialChar TeX
16762 \begin_inset CommandInset label
16771 \begin_layout Standard
16779 \begin_layout Subsection
16783 \begin_layout Standard
16784 This section describes how to use \SpecialChar LyX
16785 to make slides for overhead projectors.
16786 There are two document classes that can do this: the default slides class
16789 Foil\SpecialChar TeX
16793 This section documents the former.
16796 \begin_layout Standard
16797 I'm going to say this again, nice and clear, so that there's no misunderstanding
16801 \begin_layout Standard
16802 \begin_inset VSpace bigskip
16808 \begin_layout Standard
16812 This section documents the class
16813 \begin_inset Quotes eld
16821 \begin_inset Quotes erd
16829 \begin_layout Standard
16830 \begin_inset VSpace bigskip
16836 \begin_layout Standard
16837 If you're looking for the documentation for
16838 \begin_inset Quotes eld
16843 slides (Foil\SpecialChar TeX
16847 \begin_inset Quotes erd
16850 , check out section
16851 \begin_inset space ~
16855 \begin_inset CommandInset ref
16857 reference "sec:foiltex"
16867 \begin_inset Quotes eld
16872 slides (Foil\SpecialChar TeX
16876 \begin_inset Quotes erd
16879 ] is actually somewhat better than the default
16887 \begin_layout Plain Layout
16889 or so I've been told repeatedly by its advocates.
16890 Having never used it, I have no idea if this claim is true or not.
16895 which this section documents.
16898 \begin_layout Standard
16899 This class is the \SpecialChar LaTeX2e
16900 improvement of the old
16902 Sli\SpecialChar TeX
16906 Every \SpecialChar LaTeX2e
16907 distribution includes this class [which I'll just refer to as
16908 \begin_inset Quotes eld
16916 \begin_inset Quotes erd
16919 from now on], so you're bound to have it.
16920 As I noted earlier, there are other classes, such as
16924 , which also produce slides for overhead projectors and do a better job
16926 However, there are some things which
16930 can do which the others can't, such as generate overlays.
16931 Read on to learn more!
16934 \begin_layout Subsection
16936 \begin_inset CommandInset label
16938 name "sec:slidesetup"
16945 \begin_layout Standard
16946 Obviously, to use this document class, you need to select
16947 \begin_inset Quotes eld
16955 \begin_inset Quotes erd
16958 from the class list in the
16960 Document\SpecialChar menuseparator
16964 There are some other special things you should know about this class:
16967 \begin_layout Itemize
16968 Don't bother changing the options
16973 They're not supported by the
16980 \begin_layout Itemize
16984 \begin_inset space ~
16989 behaves a bit differently for this class.
16990 The possible choices and what they do are as follows:
16994 \begin_layout Description
16999 The final output contains page numbers in the lower right corner.
17002 \begin_layout Description
17011 , but also prints out any time markers you've put in.
17012 This is the default.
17015 \begin_layout Description
17020 The final output contains no page numbers, time markers, or alignment markers.
17024 \begin_layout Itemize
17029 class has an extra option:
17035 \begin_inset Quotes eld
17043 \begin_inset Quotes erd
17046 in the extra class options.
17050 \begin_layout Standard
17051 Using this options allows you to add time markers to
17057 \begin_inset space ~
17061 \begin_inset CommandInset ref
17063 reference "sec:slideNote"
17071 \begin_layout Standard
17072 You can also use the template file
17073 \begin_inset Quotes eld
17081 \begin_inset Quotes erd
17084 to automatically set up a document to use the
17090 File\SpecialChar menuseparator
17092 \begin_inset space ~
17096 \begin_inset space ~
17101 to open your new document].
17102 The template file also contains some examples of the special paragraph
17103 environments used by this class.
17104 I'll describe those next.
17107 \begin_layout Subsection
17108 Paragraph Environments
17111 \begin_layout Subsubsection
17112 Supported Environments
17115 \begin_layout Standard
17116 The first thing you'll notice when you start up a new
17120 document is the font size and type: it's the equivalent of the size
17121 \begin_inset Quotes eld
17129 \begin_inset Quotes erd
17135 \begin_inset space ~
17141 This is also what's used in the output.
17143 \begin_inset Quotes eld
17147 \begin_inset Quotes erd
17150 to remind you that this is a slide.
17151 Your final slides will use a larger font; ergo, you'll have less space.
17152 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
17155 \begin_layout Standard
17156 The next thing that becomes obvious is the changes to the paragraph environment
17157 pull-down box [at the far-left end of the toolbar].
17158 Most of the paragraph environments you're used to seeing are missing.
17159 There are also five new ones.
17164 class itself only supports certain paragraph environments:
17167 \begin_layout Itemize
17173 \begin_layout Itemize
17179 \begin_layout Itemize
17185 \begin_layout Itemize
17191 \begin_layout Itemize
17197 \begin_layout Itemize
17203 \begin_layout Itemize
17209 \begin_layout Itemize
17215 \begin_layout Itemize
17221 \begin_layout Itemize
17228 \begin_layout Standard
17229 All of the other standard environments, including the section-heading environmen
17230 ts, aren't used in the
17237 \begin_layout Standard
17238 On the other hand, you'll notice the following new environments:
17241 \begin_layout Itemize
17247 \begin_layout Itemize
17253 \begin_layout Itemize
17259 \begin_layout Itemize
17265 \begin_layout Itemize
17271 \begin_layout Standard
17272 These five are kind of quirky, due to a
17273 \begin_inset Quotes eld
17277 \begin_inset Quotes erd
17280 in \SpecialChar LyX
17282 You see, \SpecialChar LyX
17283 doesn't permit you to nest any other paragraph environment into
17284 an empty environment.
17285 Now, that's fine and dandy, but it means that you wouldn't be able to start
17286 a slide with anything except plain text.
17287 To deal with this, I've performed a little
17288 \begin_inset Quotes eld
17293 \begin_inset Quotes erd
17299 \begin_layout Subsubsection
17300 Quirks of the New Environments
17301 \begin_inset CommandInset label
17303 name "sec:slideQuirk"
17310 \begin_layout Standard
17311 All five of the new paragraph environments are somewhat quirky due to inherent
17312 limitiations in the current version of \SpecialChar LyX
17314 As I just mentioned, \SpecialChar LyX
17315 forbids environments that begin with another environment.
17316 To get around this, the
17320 environment isn't a paragraph environment as described in the
17328 \begin_layout Standard
17329 You should consider
17342 \begin_inset Quotes eld
17345 pseudo-environments.
17346 \begin_inset Quotes erd
17349 They look like a section heading or a
17350 \begin_inset Quotes eld
17358 \begin_inset Quotes erd
17361 but really begin a [and, if necessary, end the previous] paragraph environment.
17371 \begin_inset Quotes eld
17375 \begin_inset Quotes erd
17378 These two perform some action.
17381 \begin_layout Standard
17382 A common feature of all five environments,
17402 , is a rather long-ish label.
17403 The text following this label — ordinarily the contents of the paragraph
17404 environment — is utterly irrelevant for
17426 completely ignores it.
17427 In fact, you can leave these five environments completely empty.
17431 \begin_layout Standard
17436 to put any text after the rather long-ish label, you might want to.
17437 This could be a short description of the contents of the
17442 In that case, enter your descriptive comment and hit
17446 as you normally would.
17449 \begin_layout Standard
17450 If, on the other hand, you don't want to enter any descriptive text, you'll
17451 hit another \SpecialChar LyX
17454 , like nature, abhors a vacuum, and will not let you start a new paragraph
17455 environment until you put something in the old one.
17459 \begin_layout Itemize
17460 Start entering the text that will
17488 \begin_layout Itemize
17489 Now move to the beginning of that paragraph.
17493 \begin_layout Itemize
17502 \begin_layout Itemize
17503 Finally, change this new, empty paragraph to a
17527 \begin_layout Standard
17528 Some future version of \SpecialChar LyX
17529 will, hopefully, resolve this quirkiness\SpecialChar ldots
17533 \begin_layout Subsection
17534 Making a Presentation with
17547 \begin_layout Subsubsection
17555 \begin_layout Standard
17556 If you're expecting this section to teach you how to actually make a presentatio
17557 n, you'll be sorely disappointed.
17558 Naturally, I'll describe all of the ways the
17562 class can assist you in preparing the materials for a presentation.
17563 Filling in the contents, however, is up to you.
17568 the \SpecialChar LyX
17572 \begin_layout Standard
17577 environment [in the manner described in section
17578 \begin_inset space ~
17582 \begin_inset CommandInset ref
17584 reference "sec:slideQuirk"
17588 ] tells \SpecialChar LyX
17589 to begin a new slide [duh].
17590 The label for this environment/
17591 \begin_inset Quotes erd
17595 \begin_inset Quotes erd
17599 \begin_inset Quotes eld
17603 \begin_inset Quotes erd
17606 in cool blue, followed by the label,
17607 \begin_inset Quotes eld
17611 \begin_inset Quotes erd
17615 Any text or paragraph environments that follow this one go on the new slide.
17619 \begin_layout Standard
17620 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17622 (this can be specified in the
17627 In fact, you'll want to, once you finish entering the contents of one slide.
17628 If you've entered more text than can physically fit on a slide, the extra
17629 overflows onto a new slide.
17630 I don't recommend doing this, however, since the overflow slide won't have
17631 any page number on it.
17632 Furthermore, it may interfere with any
17636 you've made to accompany the oversized
17643 \begin_layout Standard
17652 environments work the same way as the
17657 They both create an
17658 \begin_inset Quotes eld
17662 \begin_inset Quotes erd
17665 followed by a label [
17666 \begin_inset Quotes eld
17670 \begin_inset Quotes erd
17674 \begin_inset Quotes eld
17678 \begin_inset Quotes erd
17682 The color is a stunning magenta instead of blue, and the
17683 \begin_inset Quotes eld
17687 \begin_inset Quotes erd
17690 will look different, in style and in length.
17691 The label fonts of all three also differ from one another.
17694 \begin_layout Standard
17699 , if the contents of a
17707 exceed the physical size of a slide or sheet of paper, the extra will overflow
17709 Again, you should avoid this.
17710 It defeats the whole purpose of
17721 \begin_layout Subsubsection
17731 \begin_layout Standard
17736 is a slide that sits atop another slide.
17737 Perhaps you wish to discuss a figure on the main
17741 before displaying the text associated with it.
17742 One way to accomplish this is tape a flap of dark paper over the part of
17747 you want to display later.
17748 This method fails, however, if you wish to overlap one graph with another,
17750 You would then have to fumble while speaking to align the two separate,
17755 s to align the two graphs.
17760 environment in both cases makes life much easier.
17763 \begin_layout Standard
17768 receives the page number of its
17769 \begin_inset Quotes eld
17773 \begin_inset Quotes erd
17781 \begin_inset Quotes eld
17789 \begin_inset Quotes erd
17796 \begin_layout Plain Layout
17797 Presumably, mutliple
17802 \begin_inset Quotes eld
17810 \begin_inset Quotes erd
17814 \begin_inset Quotes eld
17822 \begin_inset Quotes erd
17826 \begin_inset Quotes eld
17834 \begin_inset Quotes erd
17838 \begin_inset space ~
17841 appended to the page number of the parent
17851 Clearly, you want the contents of both the
17859 to each fit on a single physical slide! You should probably consider an
17865 \begin_inset Quotes eld
17869 \begin_inset Quotes erd
17877 Indeed, the \SpecialChar LyX
17882 class provides a visual cue for this: the label at the start of an
17886 is shorter than that at the start of a
17891 Lastly, when you generate printable output, you'll find alignment markers
17892 in all four corners of both the
17896 page and its parent
17901 These will assist you in lining up the two physical slides.
17904 \begin_layout Standard
17905 The major problem in overlaying two slides is aligning the contents of the
17906 two transparencies.
17907 How much space should you leave for that graph on the second slide? Worse
17908 still, what if you want a graph and a sentence on second slide, but there
17909 is text on the main transparency that goes in between them? You could try
17910 and insert vertical space of the right size.
17911 The better way is to use
17922 \begin_layout Standard
17923 As their names imply,
17931 are two command-like paragraph environments that make all subsequent text
17932 invisible and visible, respectively.
17934 \begin_inset space ~
17938 \begin_inset CommandInset ref
17940 reference "sec:slideQuirk"
17944 that you don't place anything
17948 these two environments, however.
17953 , it inserts a centered, sky-blue label into the page reading
17954 \begin_inset Quotes eld
17957 <Invisible Text Follows>
17958 \begin_inset Quotes erd
17962 For paragraphs following this label, the parts of the
17970 ; it doesn't matter which] where they would be contain instead blank space.
17974 \begin_layout Standard
17979 , the corresponding centered label is
17980 \begin_inset Quotes eld
17983 <Visible Text Follows>
17984 \begin_inset Quotes erd
17988 Paragraphs following this label behave normally.
17989 Note that the beginning of a new
18001 automatically shuts off an
18006 It's therefore not necessary to use
18017 \begin_layout Standard
18018 By now, it should be obvious how to create overlay transparencies using
18019 the proper combination of
18038 \begin_layout Enumerate
18043 , including everything that will appear on it, whether on the main slide
18051 \begin_layout Enumerate
18052 Before each figure or paragraph that will appear only on the
18061 If necessary, insert a
18065 environment after the
18072 \begin_layout Enumerate
18077 immediately following the
18084 \begin_layout Enumerate
18085 Copy the contents of this
18096 \begin_layout Enumerate
18101 , change all of the
18112 \begin_layout Standard
18114 You've just made an
18121 \begin_layout Standard
18122 There's one problem with the way I've designed the \SpecialChar LyX
18127 class: you can't make text in the middle of a paragraph invisible, nor
18128 make text in the middle of an invisible paragraph visible again.
18129 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
18134 \begin_layout Plain Layout
18135 The commands of interest are:
18138 \begin_layout Itemize
18143 invisible \SpecialChar ldots
18147 \begin_layout Itemize
18152 visible \SpecialChar ldots
18156 \begin_layout Plain Layout
18158 and need to be marked as \SpecialChar TeX
18161 \begin_inset Quotes eld
18165 \begin_inset Quotes erd
18168 you wish to change goes in between the brackets [and after the
18181 If you don't know how to mark text as \SpecialChar TeX
18182 , see the appropriate section of
18195 \begin_layout Subsubsection
18205 \begin_inset CommandInset label
18207 name "sec:slideNote"
18214 \begin_layout Standard
18223 is associated with a
18224 \begin_inset Quotes eld
18228 \begin_inset Quotes erd
18236 Here, too, the \SpecialChar LyX
18241 class provides visual cues.
18246 is shorter than that of a
18250 [yet longer than that of an
18254 ] and, like the label of an
18258 is shockingly magenta.
18259 Additionally, the printed
18263 has the page number of its
18264 \begin_inset Quotes eld
18268 \begin_inset Quotes erd
18276 \begin_inset Quotes eld
18284 \begin_inset Quotes erd
18288 \begin_inset Quotes eld
18296 \begin_inset Quotes erd
18300 \begin_inset Quotes eld
18308 \begin_inset Quotes erd
18312 You can have multiple
18316 s associated with a single
18328 , you'll probably want to break up long
18332 s so that they fit on a single sheet of paper.
18335 \begin_layout Standard
18340 is obvious: it contains anything additional you might want to say about
18346 It could also be used as a sheet of reminders for a particular
18351 In the case of the latter, you might want to make use of time markers.
18352 Currently, the \SpecialChar LyX
18358 \begin_inset Quotes eld
18362 \begin_inset Quotes erd
18365 support for time markers, a
18367 Sli\SpecialChar TeX
18371 So, you'll have to resort to using the \SpecialChar LaTeX
18375 \begin_layout Standard
18376 To use time markers, you'll need to specify the extra class option
18377 \begin_inset Quotes eld
18385 \begin_inset Quotes erd
18389 \begin_inset space ~
18393 \begin_inset CommandInset ref
18395 reference "sec:slidesetup"
18400 This option turns on timing marks, which will appear in the lower-left-hand
18406 To set what appears in the time marker, you use the \SpecialChar LaTeX
18408 \begin_inset Quotes eld
18418 \begin_inset Quotes erd
18422 \begin_inset Quotes eld
18432 \begin_inset Quotes erd
18436 The arguments of both commands are time measured in seconds.
18438 \begin_inset Quotes eld
18448 \begin_inset Quotes erd
18451 sets the time marker to a given time.
18453 \begin_inset Quotes eld
18463 \begin_inset Quotes erd
18466 increments the time marker by the specified amount.
18467 Using time markers and
18471 s in this fashion, you can remind yourself how much time to spend on a particula
18479 \begin_layout Standard
18480 There's one last feature to describe.
18481 Clearly, you'd like to print out all of your
18489 s on transparencies while printing all of your
18506 with which it is associated.
18507 What's a person to do?
18510 \begin_layout Standard
18511 Luckily, there are two \SpecialChar LaTeX
18512 commands that allow you to select what to print
18514 Both must be placed into the preamble of your document.
18516 \begin_inset Quotes eld
18528 \begin_inset Quotes erd
18531 will cause the output to contain only the
18540 Correspondingly, the command
18541 \begin_inset Quotes eld
18553 \begin_inset Quotes erd
18556 prevents the output of anything but
18561 I'd advise placing both commands in the preamble and initially comment
18563 You can then preview your entire presentation as you write.
18564 When you're done writing, you can then uncomment one of the two to select
18565 what you want to print.
18566 I like to uncomment
18567 \begin_inset Quotes eld
18579 \begin_inset Quotes erd
18582 , print to a file with
18583 \begin_inset Quotes eld
18591 \begin_inset Quotes erd
18594 in its name, comment it back out, then uncomment
18595 \begin_inset Quotes eld
18607 \begin_inset Quotes erd
18611 \begin_inset Quotes eld
18619 \begin_inset Quotes erd
18623 I can then send either file to a printer, loading transparencies or plain
18624 paper as appropriate.
18627 \begin_layout Standard
18628 You can also provide other arguments to the
18629 \begin_inset Quotes eld
18639 \begin_inset Quotes erd
18643 \begin_inset Quotes eld
18653 \begin_inset Quotes erd
18657 See a good \SpecialChar LaTeX
18661 \begin_layout Subsection
18666 Class Template File
18669 \begin_layout Standard
18670 I have also provided a template file,
18671 \begin_inset Quotes eld
18679 \begin_inset Quotes erd
18687 To use it, begin your new presentation with
18689 File\SpecialChar menuseparator
18691 \begin_inset space ~
18695 \begin_inset space ~
18701 Your new \SpecialChar LyX
18702 presentation file will contain an example
18723 additionally contain an example of the use of
18732 Lastly, the preamble will contain:
18735 \begin_layout LyX-Code
18736 % Uncomment to print out only slides and overlays
18739 \begin_layout LyX-Code
18743 \begin_layout LyX-Code
18749 \begin_inset Newline newline
18755 \begin_layout LyX-Code
18756 % Uncomment to print out only notes
18759 \begin_layout LyX-Code
18763 \begin_layout LyX-Code
18771 \begin_layout Standard
18772 One final thing: I created this class to support the \SpecialChar LaTeX2e
18774 \begin_inset Quotes eld
18779 Sli\SpecialChar TeX
18783 \begin_inset Quotes erd
18786 class, one of the built-in \SpecialChar LaTeX2e
18788 Neither I nor the rest of the \SpecialChar LyX
18789 Team endorse or oppose the use of this built-in
18791 It's here if you want it or need it.
18792 There exist other \SpecialChar LaTeX2e
18793 classes for creating presentations, such as the
18798 \begin_inset space ~
18802 \begin_inset CommandInset ref
18804 reference "sec:foiltex"
18809 \begin_inset Quotes eld
18817 \begin_inset Quotes erd
18820 package [present on some \SpecialChar TeX
18822 The latter is not yet supported under \SpecialChar LyX
18827 \begin_layout Plain Layout
18828 Perhaps you can take on the task\SpecialChar ldots
18834 I know nothing about these other classes.
18835 Try them out to see what sort of alternative they provide.
18838 \begin_layout Chapter
18840 Features needing Extra Software
18843 \begin_layout Section
18844 Checking \SpecialChar TeX
18848 \begin_layout Standard
18854 \begin_layout Subsection
18858 \begin_layout Standard
18867 \begin_layout Plain Layout
18872 is not yet available when you are using the \SpecialChar LaTeX
18873 distribution MiK\SpecialChar TeX
18879 , you'll find in the
18886 \begin_inset space ~
18897 \begin_inset Newline newline
18901 \begin_inset CommandInset href
18903 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18911 \begin_layout Standard
18914 Chk\SpecialChar TeX
18917 package is a program that was written by
18918 \begin_inset Flex Noun
18921 \begin_layout Plain Layout
18923 \begin_inset space ~
18931 in frustration because some constructs in \SpecialChar LaTeX
18932 are sometimes non-intuitive,
18933 and easy to forget.
18934 The program runs over your \SpecialChar LaTeX
18935 file, checks the integrity of the file, and
18936 flags some common errors.
18937 In other technical words, it is
18941 for \SpecialChar LaTeX
18945 \begin_layout Standard
18946 Well, what is a syntax checker doing in \SpecialChar LyX
18947 which is supposed to produce correct
18949 anyways? The answer is simple: Just as
18953 not only checks the
18957 of C programs, but also does
18961 checks for type-errors,
18963 Chk\SpecialChar TeX
18966 catches some common
18970 errors, in addition to the syntactical ones.
18973 Chk\SpecialChar TeX
18976 is capable of detecting several common errors, such as
18979 \begin_layout Itemize
18980 Ellipsis detection:
18981 \begin_inset Newline newline
18984 Use \SpecialChar ldots
18988 \begin_layout Itemize
18989 No space in front of/after parenthesis:
18990 \begin_inset Newline newline
18996 \begin_layout Itemize
18997 Enforcement of normal space after common abbreviations:
18998 \begin_inset Newline newline
19002 \begin_inset space \thinspace{}
19006 \begin_inset space \space{}
19009 is too wide spacing.
19012 \begin_layout Itemize
19013 Enforcement of end-of-sentence space when the last sentence ends with a
19015 \begin_inset Newline newline
19019 And this is wrong spacing.
19022 \begin_layout Itemize
19023 Space in front of labels and similar commands:
19024 \begin_inset Newline newline
19027 The label should stick right up to the text to avoid falling to a wrong
19030 \begin_inset CommandInset label
19040 \begin_layout Plain Layout
19041 This footnote is in danger of falling off to a wrong page
19046 The label is separated too much.
19049 \begin_layout Itemize
19050 Space in front of references, instead of hard spaces:
19051 \begin_inset Newline newline
19054 If you have bad luck, the text will break right between the referenced text
19055 and reference number, and that's a pity.
19057 \begin_inset CommandInset ref
19059 reference "sec:chktex"
19066 \begin_layout Itemize
19068 \begin_inset Quotes eld
19072 \begin_inset Quotes erd
19076 \begin_inset Formula $\times$
19080 \begin_inset Newline newline
19083 2x2 looks cheap compared to
19084 \begin_inset Formula $2\times2$
19090 \begin_layout Standard
19091 and more \SpecialChar ldots
19092 It is an invaluable tool when you are
19093 \begin_inset Quotes eld
19097 \begin_inset Quotes erd
19100 your document before printing, and you should run it right after the obligatory
19101 spelling check, and before you go fine tuning the typesetting.
19104 \begin_layout Subsection
19108 \begin_layout Standard
19109 If you have the program installed, usage is as simple as choosing
19111 Tools\SpecialChar menuseparator
19113 \begin_inset space ~
19119 This will make \SpecialChar LyX
19120 generate a \SpecialChar LaTeX
19121 file of your document, start
19123 Chk\SpecialChar TeX
19126 to check it, and then make \SpecialChar LyX
19128 \begin_inset Quotes eld
19132 \begin_inset Quotes erd
19135 with the warnings from
19137 Chk\SpecialChar TeX
19140 , if there were any.
19141 The warnings will be placed close to the point of the mistake, and you
19142 can quickly find them by using the
19144 Navigate\SpecialChar menuseparator
19147 menu item, or the shortcut key
19156 Open the error boxes by clicking on them with the mouse, or use the shortcut
19165 bindings, or the corresponding
19174 Read the warning and correct the mistake, if it is a mistake.
19175 If you have trouble understanding what the warning is about, you can safely
19177 Remember that there is a hidden layer between the document on screen and
19178 the technical details in invoking
19180 Chk\SpecialChar TeX
19183 , and this gap can make some warnings seem arcane or just plain silly.
19186 \begin_layout Standard
19187 This document is an excellent testing bed for the feature, and it should
19188 provide quite a few warnings for you to fiddle with.
19189 Since computers are only so smart, expect most of the warnings to be false
19193 \begin_layout Subsection
19194 How to fine tune it
19197 \begin_layout Standard
19198 Sometimes, you'll find that
19200 Chk\SpecialChar TeX
19203 makes more noise than suits your mood.
19204 Then you can choose not to use it, wait until your mood changes, or try
19207 Chk\SpecialChar TeX
19210 to get better along with you.
19213 \begin_layout Standard
19216 Chk\SpecialChar TeX
19223 very configurable and extensible, you should not expect to solve all problems
19226 Chk\SpecialChar TeX
19229 in \SpecialChar LyX
19231 Since \SpecialChar LyX
19232 has to generate a somewhat special \SpecialChar LaTeX
19233 file to be able to match the
19234 line numbers from the
19236 Chk\SpecialChar TeX
19243 \begin_layout Plain Layout
19244 You can inspect the specific output from
19250 Document\SpecialChar menuseparator
19253 \begin_inset space ~
19267 to the internal document structure, some of the warnings will not appear
19269 There are two things you can do about this:
19272 \begin_layout Itemize
19275 Chk\SpecialChar TeX
19278 invocation command line in
19279 \begin_inset Flex Noun
19282 \begin_layout Plain Layout
19283 Tools\SpecialChar menuseparator
19284 Preferences\SpecialChar menuseparator
19285 Output\SpecialChar menuseparator
19286 LaTeX\SpecialChar menuseparator
19294 Chk\SpecialChar TeX
19297 installation configuration file (usually with the file
19302 See below to learn what warnings can be enabled and disabled on the command
19306 \begin_layout Itemize
19307 Export your document as a raw \SpecialChar LaTeX
19310 File\SpecialChar menuseparator
19311 Export\SpecialChar menuseparator
19320 Invoked in this way, it can be a hassle to find the corresponding place
19321 in the document inside \SpecialChar LyX
19322 , but with a little patience, you should be able
19326 \begin_layout Standard
19327 Here follows the warning messages that can be enabled and disabled in
19336 to disable a warning, and
19340 to enable a warning.
19341 The emphasized entries are disabled by default, because the default is
19344 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19349 \begin_layout Standard
19350 Notice that you should only use the options that enable and disable warnings,
19351 because \SpecialChar LyX
19352 relies on some of the other command line parameters to be set
19353 in a specific way to have a chance to communicate with
19360 \begin_layout Enumerate
19364 Command terminated with space.
19367 \begin_layout Enumerate
19370 Non-breaking space (
19371 \begin_inset Quotes eld
19379 \begin_inset Quotes erd
19382 ) should have been used.
19385 \begin_layout Enumerate
19389 You should enclose the previous parenthesis with
19390 \begin_inset Quotes eld
19398 \begin_inset Quotes erd
19404 \begin_layout Enumerate
19407 Italic correction (
19408 \begin_inset Quotes eld
19418 \begin_inset Quotes erd
19421 ) found in non-italic buffer.
19424 \begin_layout Enumerate
19427 Italic correction (
19428 \begin_inset Quotes eld
19438 \begin_inset Quotes erd
19441 ) found more than once.
19444 \begin_layout Enumerate
19448 No italic correction (
19449 \begin_inset Quotes eld
19459 \begin_inset Quotes erd
19465 \begin_layout Enumerate
19469 \begin_inset Quotes eld
19477 \begin_inset Quotes erd
19481 \begin_inset Quotes eld
19489 \begin_inset Quotes erd
19495 \begin_layout Enumerate
19498 Wrong length of dash may have been used.
19501 \begin_layout Enumerate
19505 \begin_inset Quotes eld
19513 \begin_inset Quotes erd
19517 \begin_inset Quotes eld
19525 \begin_inset Quotes erd
19531 \begin_layout Enumerate
19535 \begin_inset Quotes eld
19543 \begin_inset Quotes erd
19549 \begin_layout Enumerate
19553 \begin_inset Quotes eld
19561 \begin_inset Quotes erd
19564 to achieve an ellipsis.
19567 \begin_layout Enumerate
19570 Inter-word spacing (
19571 \begin_inset Quotes eld
19581 \begin_inset Quotes eld
19584 ) should perhaps be used.
19587 \begin_layout Enumerate
19590 Inter-sentence spacing (
19591 \begin_inset Quotes eld
19601 \begin_inset Quotes erd
19604 ) should perhaps be used.
19607 \begin_layout Enumerate
19610 Could not find argument for command.
19613 \begin_layout Enumerate
19617 \begin_inset Quotes eld
19625 \begin_inset Quotes erd
19631 \begin_layout Enumerate
19634 Math mode still on at end of \SpecialChar LaTeX
19638 \begin_layout Enumerate
19642 \begin_inset Quotes eld
19650 \begin_inset Quotes erd
19653 doesn't match the number of
19654 \begin_inset Quotes eld
19662 \begin_inset Quotes erd
19668 \begin_layout Enumerate
19671 You should use either
19674 \begin_inset Quotes eld
19682 \begin_inset Quotes erd
19687 as an alternative to
19688 \begin_inset Quotes eld
19696 \begin_inset Quotes erd
19702 \begin_layout Enumerate
19709 " (ASCII 39) instead of "
19716 \begin_layout Enumerate
19719 User-specified pattern found.
19722 \begin_layout Enumerate
19725 This command might not be intended.
19728 \begin_layout Enumerate
19735 \begin_layout Enumerate
19753 \begin_layout Enumerate
19756 Delete this space to maintain correct page references.
19759 \begin_layout Enumerate
19763 You might wish to put this between a pair of
19764 \begin_inset Quotes eld
19772 \begin_inset Quotes erd
19778 \begin_layout Enumerate
19781 You ought to remove spaces in front of punctuation.
19784 \begin_layout Enumerate
19787 Could not execute \SpecialChar LaTeX
19791 \begin_layout Enumerate
19800 in front of small punctuation.
19803 \begin_layout Enumerate
19811 may look prettier here.
19814 \begin_layout Enumerate
19818 Multiple spaces detected in output.
19821 \begin_layout Enumerate
19824 This text may be ignored.
19827 \begin_layout Enumerate
19833 \begin_inset Quotes eld
19838 to begin quotation, not
19845 \begin_layout Enumerate
19852 to end quotation, not
19855 \begin_inset Quotes eld
19863 \begin_layout Enumerate
19869 \begin_layout Enumerate
19872 You should perhaps use
19873 \begin_inset Quotes eld
19881 \begin_inset Quotes erd
19887 \begin_layout Enumerate
19890 You should put a space in front of/after parenthesis.
19893 \begin_layout Enumerate
19896 You should avoid spaces in front of/after parenthesis.
19899 \begin_layout Enumerate
19903 You should not use punctuation in front of/after quotes.
19906 \begin_layout Enumerate
19909 Double space found.
19912 \begin_layout Enumerate
19915 You should put punctuation outside inner/inside display math mode.
19918 \begin_layout Enumerate
19921 You ought to not use primitive \SpecialChar TeX
19922 in \SpecialChar LaTeX
19926 \begin_layout Enumerate
19929 You should remove spaces in front of
19930 \begin_inset Quotes eld
19938 \begin_inset Quotes erd
19944 \begin_layout Enumerate
19947 \begin_inset Quotes eld
19955 \begin_inset Quotes erd
19958 is normally not followed by
19959 \begin_inset Quotes eld
19967 \begin_inset Quotes erd
19973 \begin_layout Standard
19974 In later versions of \SpecialChar LyX
19975 , we hope to provide a more complete interface to this
19976 tool (and it's smaller cousin
19980 ) to exploit the full power of it.
19981 But it's not exactly useless as it is now: go try it on one of your existing
19982 documents of a certain length and be surprised.
19985 \begin_layout Section
19986 Version Control in \SpecialChar LyX
19990 \begin_layout Standard
19993 Lars Gullik Bjønnes
20000 \begin_layout Subsection
20004 \begin_layout Standard
20006 supports some of the most basic RCS/CVS/SVN/GIT commands.
20007 If you need something a bit more sophisticated you will have to do that
20008 manually in a terminal.
20011 \begin_layout Standard
20012 Also note that CVS support is not as good as subversion support, so we advise
20014 A good place to start learning Subversion is the SVN Book
20018 \begin_layout Plain Layout
20019 \begin_inset CommandInset href
20021 target "http://svnbook.red-bean.com/"
20032 In the case of RCS you should read
20033 \begin_inset Quotes eld
20037 \begin_inset Quotes erd
20040 (a man file, read it with
20045 This file describes all the basic features of RCS.
20046 You should especially notice the comment about a RCS directory, and the
20047 notion of a master RCS file (the file ending in
20054 \begin_layout Standard
20055 Before you begin to use the version control features in \SpecialChar LyX
20057 familiar with RCS/CVS/SVN/GIT usage.
20058 The implementation in \SpecialChar LyX
20059 assumes a recent version of the GNU RCS or CVS/SVN
20060 package — no guarantees are made for older versions.
20061 Most of the log messages are not currently displayed after operations —
20062 you can check them in the Messages pane if you are unsure.
20063 Regular users of version control will appreciate the VC toolbar, which
20066 View\SpecialChar menuseparator
20067 Toolbars\SpecialChar menuseparator
20069 \begin_inset space ~
20077 \begin_layout Standard
20078 For introducing your own external commands consult
20079 \begin_inset Flex Code
20082 \begin_layout Plain Layout
20096 \begin_layout Standard
20097 It is strongly recommended to store documents in uncompressed format if
20098 using version control (uncheck
20100 Document\SpecialChar menuseparator
20103 if it is checked): Uncompressed LyX documents are text files and therefore
20104 for merging two different versions by version control systems.
20105 Compressed LyX documents are binary files, which cannot be merged by version
20109 \begin_layout Subsection
20110 RCS commands in \SpecialChar LyX
20114 \begin_layout Standard
20115 The following sections describe the RCS commands supported by \SpecialChar LyX
20117 You can find them in the
20119 File\SpecialChar menuseparator
20121 \begin_inset space ~
20128 was tested against RCS 5.7/5.8.
20131 \begin_layout Subsubsection
20137 \begin_layout Standard
20138 If your document is not under revision control, this is the only item shown
20140 And if it is under revision control, the
20144 item is not visible.
20148 \begin_layout Standard
20149 This command registers your document with RCS (unless you are under the
20150 directory managed by CVS)\SpecialChar endofsentence
20151 You are asked interactively to supply an initial
20152 description of the document.
20153 The document is now set in Read-Only mode and you have to
20156 \begin_inset space ~
20160 \begin_inset space ~
20164 \begin_inset space ~
20169 , before making any changes to it.
20170 A document under revision control has a
20171 \begin_inset Quotes eld
20174 [RCS:<version> <locker>]
20175 \begin_inset Quotes erd
20178 item tagged to the filename in the minibuffer.
20181 \begin_layout Standard
20182 RCS command that is run:
20185 \begin_layout LyX-Code
20188 ci -q -u -i -t-"<initial description>" <file-name>
20191 \begin_layout Standard
20196 to understand the switches.
20200 \begin_layout Subsubsection
20206 \begin_layout Standard
20207 When you are finished editing a file, you check in your changes.
20208 When you do this, you are asked for a description of the changes.
20209 This is stored in the history log.
20210 The version number is bumped, your changes are applied to the master RCS
20211 file, the document is unlocked and set to Read-Only mode.
20214 \begin_layout Itemize
20217 ci -q -u -m"<description>" <file-name>
20220 \begin_layout Subsubsection
20226 \begin_layout Standard
20227 By doing this you lock the document so that only you can edit it.
20228 This will also make the document Read-Write only for you.
20229 You will usually continue editing for a while and when you are finished
20230 you check in your changes.
20231 The status line is changed to reflect that you have locked the file.
20234 \begin_layout Itemize
20237 co -q -l <file-name>
20240 \begin_layout Subsubsection
20243 Revert To Repository Version
20246 \begin_layout Standard
20247 This will discard all changes made to the document since the last check
20249 You get a warning before changes are discarded.
20252 \begin_layout Itemize
20255 co -f -u<version> <file-name>
20258 \begin_layout Subsubsection
20264 \begin_layout Standard
20265 This will create a copy of the current document.
20266 Since RCS does not support copy operations natively, the version history
20267 is not preserved, and the copy is added as a new file.
20268 It requires a clean document without any changes since the last checkin.
20269 You are asked for a file name and a description of the copy operation.
20270 After that the copy is created, both locally and in the repository.
20271 If the parent directories of the copied and original document differ, all
20272 relative paths of included files of the copy are adjusted (like in
20274 File\SpecialChar menuseparator
20279 Finally, the copy is loaded instead of the original document.
20282 \begin_layout Labeling
20283 \labelwidthstring 00.00.0000
20285 \begin_inset space ~
20289 \begin_inset space ~
20293 \begin_inset Newline newline
20297 \begin_inset Flex Code
20300 \begin_layout Plain Layout
20303 \begin_inset Quotes qld
20307 \begin_inset Quotes qld
20316 \begin_inset Flex Code
20319 \begin_layout Plain Layout
20322 \begin_inset Quotes qld
20326 \begin_inset Quotes qld
20335 \begin_inset Newline newline
20339 \begin_inset Flex Code
20342 \begin_layout Plain Layout
20346 \begin_inset Quotes qld
20350 \begin_inset Quotes qld
20361 \begin_layout Subsubsection
20367 \begin_layout Standard
20368 This makes as if the last check in never happened.
20369 No changes are made to the document loaded into \SpecialChar LyX
20370 , but the last version
20371 is removed from the master RCS file.
20374 \begin_layout Itemize
20377 rcs -o<version> <file-name>
20380 \begin_layout Subsubsection
20386 \begin_layout Standard
20387 This shows the complete history of the RCS document.
20392 is shown in a browser.
20400 \begin_layout Subsubsection
20404 \begin_layout Standard
20406 supports RCS version number, author name, date and time of last commit.
20407 All those are extracted from
20409 rlog -r <file-name>
20413 \begin_inset CommandInset ref
20415 reference "subsec:VCS-Revision-Information"
20422 \begin_layout Subsection
20423 CVS commands in \SpecialChar LyX
20427 \begin_layout Standard
20428 A subset of CVS operations is supported by \SpecialChar LyX
20430 You can find the commands in the
20432 File\SpecialChar menuseparator
20434 \begin_inset space ~
20440 The version control system SVN is more powerful, so please use it instead
20441 of CVS if possible.
20444 \begin_layout Subsubsection
20450 \begin_layout Standard
20451 If you start from scratch with CVS you have to create your repository and
20452 checkout the working copy with external tools.
20453 If you're using a client-server setup you may need to login before doing
20454 the first repository checkout.
20457 \begin_layout Standard
20458 If your documents are under revision control and others are using the same
20459 repository problems arise when different changes to the same document at
20460 the same location happen.
20461 Standard CVS repositories don't operate with a file locking mechanism.
20462 This may be surprising, but conflicts only occur if people disagree on
20463 the proper content of the same part of a document.
20464 So, if co-workers are used to communicate regularly, these conflicts occur
20466 If they don't communicate they have a fundamental problem anyway.
20467 Nevertheless some people like to work with so called
20468 \begin_inset Quotes eld
20472 \begin_inset Quotes erd
20476 If they do so the working copy of all files is readonly when checked out
20477 first and the user starts editing after using a special command to make
20478 the working copy writable.
20479 When the changes are checked in the working copy returns to readonly state.
20480 With \SpecialChar LyX
20481 one has to edit the
20482 \begin_inset Flex Code
20485 \begin_layout Plain Layout
20491 file and add the line
20492 \begin_inset Flex Code
20495 \begin_layout Plain Layout
20501 to work with reserved checkouts.
20502 The benefit is the possibility to see who is using a writable copy of some
20504 It's not guaranteed only one user makes a copy writable.
20507 \begin_layout Standard
20509 tries to guess if you're using reserved or non-reserved checkouts.
20510 If your working copy is readonly or it is writable and an additional copy
20511 of your document exists in the CVS/Base sub-directory a reserved otherwise
20512 a non-reserved checkout is assumed.
20513 When a reserved checkout is detected you have to use
20514 \begin_inset Flex Noun
20517 \begin_layout Plain Layout
20523 to make your working copy writable if it's readonly.
20525 \begin_inset Flex Noun
20528 \begin_layout Plain Layout
20534 operation is possible and that makes your working copy readonly again after
20535 transferring your changes to the repository.
20538 \begin_layout Standard
20539 More information about CVS can be found here
20540 \begin_inset Flex URL
20543 \begin_layout Plain Layout
20545 http://www.nongnu.org/cvs
20551 \begin_inset Flex URL
20554 \begin_layout Plain Layout
20556 http://ximbiot.com/cvs
20564 \begin_layout Standard
20569 to understand the sub-commands and the switches mentioned below.
20572 \begin_layout Subsubsection
20578 \begin_layout Standard
20579 If your document is not under revision control, this is the only item shown
20581 And if it is under revision control, the
20585 item is not visible.
20589 \begin_layout Standard
20590 This command registers in CVS your document
20591 \begin_inset Flex Strong
20594 \begin_layout Plain Layout
20602 in the case you have already the documents directory under CVS control
20608 This means you have to create or checkout the archive by yourself using
20610 (In case you forget that step \SpecialChar LyX
20611 registers the document with RCS.)
20614 \begin_layout Standard
20615 Then you are asked interactively to supply an initial description of the
20617 Don't forget that registered file is not yet checked in.
20620 \begin_layout Standard
20621 CVS command that is run:
20623 cvs -q add -m"<entered message>" "<file-name>"
20626 \begin_layout Standard
20631 above and for all other CVS commands is an abbreviation for
20632 \begin_inset Quotes eld
20635 change the current working directory to file location and use the file name
20636 without path component as argument
20637 \begin_inset Quotes erd
20643 \begin_layout Subsubsection
20649 \begin_layout Standard
20650 When you are finished editing a file, you commit your changes.
20651 When you do this and you had changed the document, you are asked for a
20652 description of the changes.
20653 After that changes are written to the repository.
20654 In case you didn't change the document and a reserved checkout is detected
20655 the reservation made on
20656 \begin_inset Flex Noun
20659 \begin_layout Plain Layout
20668 \begin_layout Labeling
20669 \labelwidthstring 00.00.0000
20671 \begin_inset space ~
20675 \begin_inset space ~
20679 \begin_inset Newline newline
20683 \begin_inset Flex Code
20686 \begin_layout Plain Layout
20689 -q commit -m"<description>" "<file-name>"
20695 \begin_inset Newline newline
20699 \begin_inset Flex Code
20702 \begin_layout Plain Layout
20713 \begin_layout Subsubsection
20719 \begin_layout Standard
20720 When you are sharing a repository with others, you may have to incorporate
20721 their changes into your working copy.
20724 \begin_layout Standard
20727 cvs -q update "<file-name>"
20730 \begin_layout Standard
20731 If a readonly checkout is detected the working copy is made writable and
20735 \begin_layout Standard
20738 cvs -q edit "<file-name>"
20741 \begin_layout Subsubsection
20744 Revert To Repository Version
20747 \begin_layout Standard
20748 This will discard all changes made to the document since the last check
20750 You get a warning before changes are discarded.
20751 Firstly the file is deleted, secondly CVS update command is run.
20754 \begin_layout Standard
20757 cvs -q update "<file-name>"
20760 \begin_layout Standard
20761 If a reserved checkout is detected and the working copy has no changes only
20762 the reservation is undone.
20765 \begin_layout Standard
20768 cvs -q unedit "<file-name>"
20771 \begin_layout Subsubsection
20777 \begin_layout Standard
20778 This will create a copy of the current document.
20779 Since CVS does not support copy operations natively, the version history
20780 is not preserved, and the copy is added as a new file.
20781 It requires a clean document without any changes since the last checkin.
20782 You are asked for a file name and a description of the copy operation.
20783 After that the copy is created, both locally and in the repository.
20784 If the parent directories of the copied and original document differ, all
20785 relative paths of included files of the copy are adjusted (like in
20787 File\SpecialChar menuseparator
20792 Finally, the copy is loaded instead of the original document.
20795 \begin_layout Labeling
20796 \labelwidthstring 00.00.0000
20798 \begin_inset space ~
20802 \begin_inset space ~
20806 \begin_inset Newline newline
20810 \begin_inset Flex Code
20813 \begin_layout Plain Layout
20820 \begin_inset Flex Code
20823 \begin_layout Plain Layout
20830 \begin_inset Newline newline
20834 \begin_inset Flex Code
20837 \begin_layout Plain Layout
20838 cvs -q add "<new-file-name>"
20846 \begin_layout Subsubsection
20852 \begin_layout Standard
20853 This will rename the current document.
20854 Since CVS does not support rename operations natively, the version history
20855 is not preserved, the renamed document is added as a new file, and the
20856 original document is deleted.
20857 It requires a clean document without any changes since the last checkin.
20858 You are asked for a file name and a description of the rename operation.
20859 After that the document is renamed, both locally and in the repository.
20860 If the parent directories of the new and old file names differ, all relative
20861 paths of included files are adjusted (like in
20863 File\SpecialChar menuseparator
20868 Finally, the document is reloaded using the new name.
20871 \begin_layout Labeling
20872 \labelwidthstring 00.00.0000
20874 \begin_inset space ~
20878 \begin_inset space ~
20882 \begin_inset Newline newline
20886 \begin_inset Flex Code
20889 \begin_layout Plain Layout
20896 \begin_inset Flex Code
20899 \begin_layout Plain Layout
20906 \begin_inset Newline newline
20910 \begin_inset Flex Code
20913 \begin_layout Plain Layout
20914 cvs -q add "<new-file-name>"
20920 \begin_inset Newline newline
20924 \begin_inset Flex Code
20927 \begin_layout Plain Layout
20928 cvs -q remove "<file-name>"
20936 \begin_layout Subsubsection
20937 Update of the local directory checkout from repository
20940 \begin_layout Standard
20941 Once your documents gets more complex, containing sub-documents and pictures,
20943 \begin_inset Flex Code
20946 \begin_layout Plain Layout
20952 files and so on using version control becomes more complicated.
20954 supports updating the whole tree in which resides the document.
20955 This become especially useful once you cooperate with people which neither
20956 have detailed knowledge about CVS usage nor they have ambition to commit
20957 additional material to the repository.
20958 You have to organize the files structure so that all external files are
20959 in the same directory or subdirectories of the document.
20960 It's good practice anyway to store multipart documents in an extra directory.
20963 \begin_layout Standard
20965 \begin_inset Flex Code
20968 \begin_layout Plain Layout
20969 Update local directory from repository
20974 command updates the whole directory.
20975 If local changes are detected user is warned before update starts.
20976 In case of merge conflicts both versions of the conflicting document parts
20977 are placed in the final document.
20978 You have to review and correct the result of the merge.
20979 You'll find the conflicts enclosed in pairs of
20980 \begin_inset Flex Code
20983 \begin_layout Plain Layout
20990 \begin_inset Flex Code
20993 \begin_layout Plain Layout
21000 \begin_inset Flex Code
21003 \begin_layout Plain Layout
21010 The first part is your version as before the update operation with the
21011 document name prepended.
21012 The second one is the repository version with the version number after
21014 \begin_inset Flex Code
21017 \begin_layout Plain Layout
21026 \begin_layout Labeling
21027 \labelwidthstring 00.00.0000
21029 \begin_inset space ~
21033 \begin_inset space ~
21037 \begin_inset Newline newline
21041 \begin_inset Flex Code
21044 \begin_layout Plain Layout
21052 (Ask if changes are detected.)
21053 \begin_inset Newline newline
21057 \begin_inset Flex Code
21060 \begin_layout Plain Layout
21061 cd $path; cvs -q update
21071 \begin_layout Standard
21073 \begin_inset Flex Code
21076 \begin_layout Plain Layout
21082 stands for the path to the document.
21085 \begin_layout Subsubsection
21091 \begin_layout Standard
21092 This shows the complete history of the CVS document.
21095 cvs log "<file-name>"
21097 is shown in a browser.
21100 \begin_layout Subsubsection
21104 \begin_layout Standard
21106 supports CVS version number, author name, date and time of last commit.
21107 All those are extracted from
21109 cvs log -r <file-name>
21113 \begin_inset CommandInset ref
21115 reference "subsec:VCS-Revision-Information"
21122 \begin_layout Subsection
21123 SVN commands in \SpecialChar LyX
21127 \begin_layout Standard
21128 SVN is now partially supported by \SpecialChar LyX
21130 You can find the commands in the
21132 File\SpecialChar menuseparator
21134 \begin_inset space ~
21140 Please note that if you use password protected access to repository via
21141 ssh, you will be asked in terminal window.
21143 was tested against SVN 1.5, 1.6, 1.7 and 1.8
21147 \begin_layout Plain Layout
21148 Most of the commands will work with 1.4 too, see
21149 \begin_inset CommandInset ref
21151 reference "subsec:SVN-Repo-Update"
21156 There seems to be currently unresolved permissions problem under SVN 1.8
21157 with reverting changes when file is locked.
21165 \begin_layout Subsubsection
21171 \begin_layout Standard
21172 If your document is not under revision control, this is the only item shown
21174 And if it is under revision control, the
21178 item is not visible.
21181 \begin_layout Standard
21182 This command registers in SVN your document ONLY in case you have already
21183 the documents directory under SVN control (in particular
21188 This means you have to checkout the archive by yourself.
21191 \begin_layout Standard
21192 Then you are asked interactively to supply an initial description of the
21194 Don't forget that registered file is not yet commited.
21197 \begin_layout Standard
21198 SVN command that is run:
21201 \begin_inset Quotes qld
21205 \begin_inset Quotes qld
21211 \begin_layout Standard
21216 to understand the switches.
21219 \begin_layout Subsubsection
21225 \begin_layout Standard
21226 When you are finished editing a file, you commit your changes.
21227 When you do this, you are asked for a description of the changes.
21228 After that changes are commited.
21231 \begin_layout Standard
21236 \begin_layout Plain Layout
21237 In case locking is not enabled.
21239 \begin_inset CommandInset ref
21241 reference "subsec:SVN-File-Locking"
21252 svn commit -q -m"<description>" <file-name>
21255 \begin_layout Subsubsection
21261 \begin_layout Standard
21262 Updates the changes of this file from the repository.
21263 Be sure you understand SVN merging and conflicts resolving before using
21264 this function, because all conflicts has to be resolved manually by you!
21267 \begin_layout Standard
21272 \begin_layout Plain Layout
21280 svn update --non-interactive
21281 \begin_inset Quotes qld
21285 \begin_inset Quotes qld
21291 \begin_layout Subsubsection
21294 Revert To Repository Version
21297 \begin_layout Standard
21298 This will discard all changes made to the document since the last check
21300 You get a warning before changes are discarded.
21303 \begin_layout Standard
21307 \begin_inset Quotes qld
21311 \begin_inset Quotes qld
21317 \begin_layout Subsubsection
21323 \begin_layout Standard
21324 This will create a copy of the current document including the version history.
21325 It requires a clean document without any changes since the last checkin.
21326 You are asked for a file name and a description of the copy operation.
21327 After that the copy is created, both locally and in the repository.
21328 If the parent directories of the copied and original document differ, all
21329 relative paths of included files of the copy are adjusted (like in
21331 File\SpecialChar menuseparator
21336 Finally, the copy is loaded instead of the original document.
21339 \begin_layout Labeling
21340 \labelwidthstring 00.00.0000
21342 \begin_inset space ~
21346 \begin_inset space ~
21350 \begin_inset Newline newline
21354 \begin_inset Flex Code
21357 \begin_layout Plain Layout
21361 \begin_inset Quotes qld
21365 \begin_inset Quotes qld
21369 \begin_inset Quotes qld
21373 \begin_inset Quotes qld
21382 \begin_inset Newline newline
21386 \begin_inset Flex Code
21389 \begin_layout Plain Layout
21398 \begin_layout Subsubsection
21404 \begin_layout Standard
21405 This will rename the current document including the version history.
21406 It requires a clean document without any changes since the last checkin.
21407 You are asked for a file name and a description of the rename operation.
21408 After that the document is renamed, both locally and in the repository.
21409 If the parent directories of the new and old file names differ, all relative
21410 paths of included files are adjusted (like in
21412 File\SpecialChar menuseparator
21417 Finally, the document is reloaded using the new name.
21420 \begin_layout Labeling
21421 \labelwidthstring 00.00.0000
21423 \begin_inset space ~
21427 \begin_inset space ~
21431 \begin_inset Newline newline
21435 \begin_inset Flex Code
21438 \begin_layout Plain Layout
21442 \begin_inset Quotes qld
21446 \begin_inset Quotes qld
21450 \begin_inset Quotes qld
21454 \begin_inset Quotes qld
21463 \begin_inset Newline newline
21467 \begin_inset Flex Code
21470 \begin_layout Plain Layout
21479 \begin_layout Subsubsection
21480 \begin_inset CommandInset label
21482 name "subsec:SVN-Repo-Update"
21486 Update of the local directory checkout from repository
21490 \begin_layout Plain Layout
21491 Note that this command will work only with subversion
21492 \begin_inset Formula $\geqq1.5$
21503 \begin_layout Standard
21504 All the commands above have one shortcoming – they deal with the current
21506 Once your document contains pictures, includes external
21507 \begin_inset Flex Code
21510 \begin_layout Plain Layout
21516 files and so on administration becomes more complicated.
21518 now supports updating the whole tree in which resides the document
21522 \begin_layout Plain Layout
21523 One need to organize the files structure so that all external files are
21524 in the same directory or subdirectories of the document.
21531 This become especially useful once you cooperate with people which neither
21532 know about subversion management nor they have ambition to commit additional
21533 material to the repository.
21537 \begin_layout Standard
21538 \begin_inset Flex Code
21541 \begin_layout Plain Layout
21542 Update local directory from repository
21547 command updates the whole directory and in case of merge conflicts local
21548 version of the files are left, so no unintended data loss occurs.
21549 If local changes are detected user is warned before update starts.
21552 \begin_layout Labeling
21553 \labelwidthstring 00.00.0000
21555 \begin_inset space ~
21559 \begin_inset space ~
21563 \begin_inset Newline newline
21567 \begin_inset Flex Code
21570 \begin_layout Plain Layout
21576 (Ask if changes are detected.)
21577 \begin_inset Newline newline
21581 \begin_inset Flex Code
21584 \begin_layout Plain Layout
21585 svn update --accept mine-full $path
21593 \begin_layout Standard
21595 \begin_inset Flex Code
21598 \begin_layout Plain Layout
21604 stands for the path to the document.
21607 \begin_layout Subsubsection
21613 \begin_layout Standard
21614 This shows the complete history of the SVN document.
21618 \begin_inset Quotes qld
21622 \begin_inset Quotes qld
21627 is shown in a browser.
21630 \begin_layout Subsubsection
21632 \begin_inset CommandInset label
21634 name "subsec:SVN-File-Locking"
21641 \begin_layout Standard
21642 The file exchange through various revision control systems brings the problem
21643 of merge conflicts in case two different users try to edit the same (parts
21645 When such a conflict happens it needs manual resolving and one reasonable
21646 alternative is to provide some kind of locking mechanism, which guarantees
21647 that only one user is allowed to edit file at the given time.
21650 \begin_layout Standard
21651 SVN has two such mechanisms to provide mutual exclusivity for file access
21652 – locks and automatic setting of write permissions (see sec.
21654 \begin_inset CommandInset ref
21656 reference "subsec:Automatical-Locking-Property"
21661 \begin_inset Flex Code
21664 \begin_layout Plain Layout
21674 \begin_layout Plain Layout
21675 \begin_inset Flex URL
21678 \begin_layout Plain Layout
21680 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21691 If this property is detected for a given document \SpecialChar LyX
21692 starts to use SVN locks
21693 for document editing automatically and the whole check-in/out mechanism
21694 switches to the same regimen as for RCS.
21695 This in particular means there are two different modes of file use in \SpecialChar LyX
21699 \begin_layout Itemize
21701 The loaded file is in the read-only mode.
21702 For editing on needs to check-out.
21707 consists of updating from the repository and gaining write lock.
21708 If the lock is not possible to obtain, we remain in unlocked state.
21711 \begin_layout Itemize
21713 The loaded file is in the
21714 \begin_inset Quotes els
21718 \begin_inset Quotes ers
21722 No other user is allowed to edit the file.
21727 consists of commiting changes and releasing write-lock.
21728 If no changes have been made to the document, no commit will be produced
21732 \begin_layout Plain Layout
21733 Don't be puzzled by the fact that you will be asked for commit message anyway.
21738 and only the write-lock will be released.
21741 \begin_layout Standard
21745 \begin_layout Labeling
21746 \labelwidthstring 00.00.0000
21749 svn commit -q -m"<description>" "<file-name>"
21750 \begin_inset Newline newline
21753 svn unlock "<file-name>"
21756 \begin_layout Labeling
21757 \labelwidthstring 00.00.0000
21760 svn update "<file-name>"
21761 \begin_inset Newline newline
21764 svn lock "<file-name>"
21767 \begin_layout Subsubsection
21770 \begin_inset CommandInset label
21772 name "subsec:Automatical-Locking-Property"
21778 Automatic Locking Property
21781 \begin_layout Standard
21782 The above mentioned automatic setting of write permissions of the .lyx file
21785 File\SpecialChar menuseparator
21787 \begin_inset space ~
21790 Control\SpecialChar menuseparator
21791 Use Locking Property
21794 This command is active only when the file is not locked on the svn server
21796 you need to check-out before proceeding).
21799 \begin_layout Labeling
21800 \labelwidthstring 00.00.0000
21802 \begin_inset space ~
21808 \begin_layout Labeling
21809 \labelwidthstring 00.00.0000
21812 svn propset svn:needs-lock ON "<file-name>"
21815 \begin_layout Labeling
21816 \labelwidthstring 00.00.0000
21819 svn propdel svn:needs-lock "<file-name>"
21822 \begin_layout Subsubsection
21823 \begin_inset CommandInset label
21825 name "subsec:VCS-Revision-Information"
21829 Revision Information in Documents
21832 \begin_layout Standard
21833 There are more possibilities how to activate revision information in our
21837 \begin_layout Itemize
21843 \begin_layout Itemize
21844 tree revision information (
21845 \begin_inset Flex Code
21848 \begin_layout Plain Layout
21855 The result is the output of the
21856 \begin_inset Flex Code
21859 \begin_layout Plain Layout
21865 command, the following table gives you an idea, how to read the results.
21868 \begin_layout Standard
21870 \begin_inset Tabular
21871 <lyxtabular version="3" rows="6" columns="2">
21872 <features tabularvalignment="middle">
21873 <column alignment="left" valignment="top">
21874 <column alignment="left" valignment="top">
21876 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21879 \begin_layout Plain Layout
21887 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21890 \begin_layout Plain Layout
21900 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21903 \begin_layout Plain Layout
21909 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21912 \begin_layout Plain Layout
21913 mixed revision working copy
21920 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21923 \begin_layout Plain Layout
21929 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21932 \begin_layout Plain Layout
21933 modified working copy
21940 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21943 \begin_layout Plain Layout
21949 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21952 \begin_layout Plain Layout
21953 switched working copy
21960 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21963 \begin_layout Plain Layout
21969 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21972 \begin_layout Plain Layout
21973 partial working copy, from a sparse checkout
21980 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21983 \begin_layout Plain Layout
21989 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21992 \begin_layout Plain Layout
21993 mixed revision, modified, switched working copy
22006 \begin_layout Itemize
22007 file revision information.
22008 The result comes from parsing the output of
22009 \begin_inset Flex Code
22012 \begin_layout Plain Layout
22014 \begin_inset space ~
22018 \begin_inset space ~
22022 \begin_inset space ~
22031 Supported flags are:
22035 \begin_layout Itemize
22036 version number of the last commit (
22037 \begin_inset Flex Code
22040 \begin_layout Plain Layout
22049 \begin_layout Itemize
22050 author of the last commit (
22051 \begin_inset Flex Code
22054 \begin_layout Plain Layout
22063 \begin_layout Itemize
22064 date of the last commit (
22065 \begin_inset Flex Code
22068 \begin_layout Plain Layout
22077 \begin_layout Itemize
22078 time of the last commit (
22079 \begin_inset Flex Code
22082 \begin_layout Plain Layout
22092 \begin_layout Standard
22093 You can obtain this info via InsetInfo (
22094 \change_inserted 5863208 1564400022
22097 Insert\SpecialChar menuseparator
22098 Field\SpecialChar menuseparator
22099 Version Control Revision
22100 \change_deleted 5863208 1564399852
22105 \begin_inset Flex Code
22108 \begin_layout Plain Layout
22109 info-insert buffer vcs-date
22117 The information will be available only when you have the file stored under
22118 svn managment (i.e.
22120 \begin_inset Flex Code
22123 \begin_layout Plain Layout
22129 directory is available with your document).
22133 \begin_layout Itemize
22134 Another—a hacking one—possibility is to use svn keywords
22138 \begin_layout Plain Layout
22139 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
22145 In short – you set file keywords property (e.g.
22148 svn propset svn:keywords 'Rev' file.lyx
22150 ) and then paste keyword \SpecialChar TeX
22155 \begin_layout Plain Layout
22156 This is an easy way how to ensure that \SpecialChar LyX
22157 won't break the line in the middle
22163 tag in your document (e.g.
22165 \begin_inset Flex Code
22168 \begin_layout Plain Layout
22175 This way svn client will automatically substitute revision number (e.g.
22177 \begin_inset Flex Code
22180 \begin_layout Plain Layout
22186 ) after each update and commit.
22187 There are more problems with this approach.
22188 Firstly, the '$' character is used in \SpecialChar TeX
22189 world for math equations, so any
22190 occurence of math formula
22191 \begin_inset Formula $Rev$
22195 \begin_inset Formula $Rev:59$
22198 in your \SpecialChar LyX
22200 Similarly for other keywords like Id, Date, Author, etc.
22201 Secondly svn output is dependent on your locales, so its very easy that
22202 svn would produce some problematic strings once Date is used.
22203 Thirdly you get the whole 'Rev: 59' string in your document instead of
22205 Until subversion implements user's custom keywords it will be hard to use
22206 this approach reliably or let \SpecialChar LyX
22207 to support it directly.
22210 \begin_layout Subsection
22211 SVN and Windows Environment
22214 \begin_layout Quote
22215 My inclination is to say that if the user cannot figure out the command
22216 line operations on their own fairly quickly, they would be well advised
22217 to use TortoiseSVN.
22223 \begin_layout Subsubsection
22227 \begin_layout Standard
22228 In addition to installing \SpecialChar LyX
22229 , and having access to a Subversion repository,
22230 the user will need to install the Subversion client program.
22231 A Windows installer for the client program is available from
22232 \begin_inset CommandInset href
22235 target "http://www.collab.net/nonav/downloads/subversion/"
22241 The user may also want to install
22242 \begin_inset CommandInset href
22245 target "http://tortoisesvn.tigris.org/"
22250 , which integrates Subversion operations into the context (rightclick) menu
22251 of Windows Explorer.
22252 Operations done outside \SpecialChar LyX
22253 will typically be more convenient using the Explorer
22255 Note that TortoiseSVN is not a replacement for the client program, which
22256 is what \SpecialChar LyX
22260 \begin_layout Subsubsection
22261 Bringing a document under Subversion control
22264 \begin_layout Standard
22265 Before a \SpecialChar LyX
22266 document can be brought under version control in Subversion, its
22267 parent directory needs to be under version control.
22268 If the document is being added to a project already in the repository,
22269 this is accomplished by checking the project out to the directory where
22270 the new document will be placed.
22271 If the project itself is not yet under version control (for instance, if
22272 this document starts a new project), the directory must be imported into
22274 This is done outside \SpecialChar LyX
22276 Both import and checkout are easily accomplished from the Explorer context
22277 menu using TortoiseSVN, or alternatively can be done using the command
22278 line client at a DOS prompt.
22279 The procedure for importing the project using TortoiseSVN is described
22280 below, assuming an existing repository and a new project being started
22288 For information on using the Subversion client program, run
22295 \begin_layout Enumerate
22302 in Windows Explorer, right click it, and select
22304 TortoiseSVN\SpecialChar menuseparator
22308 If necessary, adjust the URL for the repository, then click OK.
22311 \begin_layout Enumerate
22312 Right click the level of the repository under which you want to place the
22313 new project folder (typically the top level) and click
22317 Supply a name for the project folder and click OK.
22318 Add a message for the log file if desired, then click OK again.
22319 The new project folder should appear in the repository.
22320 Finally, click OK again to exit the repository browser.
22323 \begin_layout Enumerate
22324 Once again right click
22330 , this time selecting SVN Checkout\SpecialChar ldots
22331 Select the URL of the project folder
22332 you just created in the repository, and set the checkout directory to
22340 You will be warned about a non-empty folder; click OK to proceed.
22341 You should now have a
22352 \begin_layout Enumerate
22353 Create or open your document in \SpecialChar LyX
22356 File\SpecialChar menuseparator
22358 \begin_inset space ~
22361 Control\SpecialChar menuseparator
22365 Add a log message and click OK to commit the document to version control.
22368 \begin_layout Standard
22369 From this point onward, you should have full functionality in the
22371 File\SpecialChar menuseparator
22373 \begin_inset space ~
22379 You also have the option of checking the document in and out, viewing its
22381 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22382 client program from a command prompt.
22385 \begin_layout Subsubsection
22386 SSH tunnel used with SVN under Windows
22389 \begin_layout Standard
22390 Compared with Linux setting up an svn client to communicate over ssh under
22391 Windows is a rather troublesome task.
22392 We will at least offer some hints how to setup the client side but prior
22393 knowledge about ssh and the Windows command line is needed, also be prepared
22394 for a great deal of frustration\SpecialChar ldots
22398 \begin_layout Enumerate
22399 Get an svn client for windows, as described in the previous sections.
22400 When it is a fresh install run some svn command (e.g.
22402 \begin_inset Flex Code
22405 \begin_layout Plain Layout
22411 ) to create config files, which you will need to change later on.
22414 \begin_layout Enumerate
22415 Choose an ssh client for Windows.
22416 There are several possibilities, we will use the one from Putty tools
22420 \begin_layout Plain Layout
22421 \begin_inset Flex URL
22424 \begin_layout Plain Layout
22426 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22437 You will need to set the connection up so that the client doesn't ask for
22438 any password from you.
22439 To keep things easy we will use only keys without any additional password
22444 \begin_layout Enumerate
22446 \begin_inset Flex Code
22449 \begin_layout Plain Layout
22456 Save your private .ppk key file and put the public one on the server side.
22457 If the SVN server runs on Linux, note that the format of the public key
22458 is not compatible with Linux openssh and you will need to direcly copy-paste
22460 \begin_inset Quotes eld
22465 Public key for pasting into OpenSSH authorized_keys file
22468 \begin_inset Quotes erd
22471 edit field into the server's
22472 \begin_inset Flex Code
22475 \begin_layout Plain Layout
22476 ~/.ssh/authorized_keys
22482 \begin_inset Flex Code
22485 \begin_layout Plain Layout
22494 \begin_layout Enumerate
22496 \begin_inset Flex Code
22499 \begin_layout Plain Layout
22506 In the SVN config file
22510 \begin_layout Plain Layout
22511 Exact path depends on Windows version, usually somewhere around
22512 \begin_inset Flex Code
22515 \begin_layout Plain Layout
22518 Documents and Settings
22532 \begin_inset Flex Code
22535 \begin_layout Plain Layout
22550 , section [tunnels], setup ssh command, e.g.
22552 \begin_inset Flex Code
22555 \begin_layout Plain Layout
22556 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22565 \begin_layout Plain Layout
22566 It will usually take a lot of time to get exact command right and it depends
22568 For example do not have some remote server saved as a default session in
22570 If things fail, try to connect via plink without SVN first.
22579 \begin_layout Enumerate
22580 Checkout the SVN archive, e.
22581 \begin_inset space \thinspace{}
22585 \begin_inset Newline newline
22589 \begin_inset Flex Code
22592 \begin_layout Plain Layout
22593 svn co svn+ssh://user@server/repository_path
22601 \begin_layout Subsubsection
22602 End-of-Line Conversions
22605 \begin_layout Standard
22606 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22608 use different line endings inside the .lyx files.
22609 This is not a problem as far as \SpecialChar LyX
22610 functionality is concerned, but the commit
22611 diffs will be huge and merge-conflicts prone.
22612 Fortunately SVN itself knows
22616 \begin_layout Plain Layout
22617 \begin_inset Flex URL
22620 \begin_layout Plain Layout
22622 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22632 how to deal with CR/LF problems when switching .lyx files to the
22633 \begin_inset Flex Code
22636 \begin_layout Plain Layout
22646 \begin_layout Plain Layout
22648 \begin_inset Flex Code
22651 \begin_layout Plain Layout
22652 svn propset svn:eol-style native FILE_NAME
22665 \begin_layout Subsection
22666 GIT commands in \SpecialChar LyX
22670 \begin_layout Standard
22671 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22673 You can find the commands in the
22675 File\SpecialChar menuseparator
22677 \begin_inset space ~
22683 Please note that if you use password protected access to repository via
22684 ssh, you will be asked in terminal window.
22686 was tested against GIT 1.7.
22690 \begin_layout Plain Layout
22691 Windows users please note that you need to ensure that git is on the path.
22692 This can be set from within \SpecialChar LyX
22695 Tools\SpecialChar menuseparator
22696 Preferences\SpecialChar menuseparator
22697 Paths\SpecialChar menuseparator
22708 \begin_layout Standard
22709 One big difference of GIT and the other supported version control systems
22710 is the distributed nature of GIT: With traditional version control systems
22711 there is one central server which hosts the repository.
22712 Users commit their changes to the server, and get updates made by other
22714 With GIT, users commit to a local repository.
22715 The local repository can be synchronized with one or more remote repositories
22717 \begin_inset Flex Code
22720 \begin_layout Plain Layout
22727 \begin_inset Flex Code
22730 \begin_layout Plain Layout
22738 does not interact in any way with remote GIT repositories.
22739 It works exclusively with the local repository in a very similar way as
22740 with a central CVS or SVN repository.
22741 If you use remote GIT repositories you need to do the
22742 \begin_inset Flex Code
22745 \begin_layout Plain Layout
22752 \begin_inset Flex Code
22755 \begin_layout Plain Layout
22761 operations with your favourite GIT client.
22764 \begin_layout Subsubsection
22770 \begin_layout Standard
22771 If your document is not under revision control, this is the only item shown
22773 And if it is under revision control, the
22777 item is not visible.
22780 \begin_layout Standard
22781 This command registers in GIT your document ONLY in case you have already
22782 the documents directory under GIT control (in particular
22787 This means you have to checkout the archive by yourself.
22790 \begin_layout Standard
22791 Then you are asked interactively to supply an initial description of the
22793 Don't forget that registered file is not yet committed.
22796 \begin_layout Standard
22797 GIT command that is run:
22800 \begin_inset Quotes qld
22804 \begin_inset Quotes qld
22810 \begin_layout Standard
22815 to understand the switches.
22818 \begin_layout Subsubsection
22824 \begin_layout Standard
22825 When you are finished editing a file, you commit your changes.
22826 When you do this, you are asked for a description of the changes.
22827 After that changes are committed.
22830 \begin_layout Standard
22833 git commit -q -m"<description>" <file-name>
22836 \begin_layout Subsubsection
22839 Revert To Repository Version
22842 \begin_layout Standard
22843 This will discard all changes made to the document since the last check
22845 You get a warning before changes are discarded.
22848 \begin_layout Standard
22852 \begin_inset Quotes qld
22856 \begin_inset Quotes qld
22862 \begin_layout Subsubsection
22868 \begin_layout Standard
22869 This will rename the current document including the version history.
22870 It requires a clean document without any changes since the last checkin.
22871 You are asked for a file name and a description of the rename operation.
22872 After that the document is renamed, both locally and in the repository.
22873 If the parent directories of the new and old file names differ, all relative
22874 paths of included files are adjusted (like in
22876 File\SpecialChar menuseparator
22881 Finally, the document is reloaded using the new name.
22884 \begin_layout Labeling
22885 \labelwidthstring 00.00.0000
22887 \begin_inset space ~
22891 \begin_inset space ~
22895 \begin_inset Newline newline
22899 \begin_inset Flex Code
22902 \begin_layout Plain Layout
22906 \begin_inset Quotes qld
22910 \begin_inset Quotes qld
22914 \begin_inset Quotes qld
22918 \begin_inset Quotes qld
22927 \begin_inset Newline newline
22931 \begin_inset Flex Code
22934 \begin_layout Plain Layout
22943 \begin_layout Subsubsection
22949 \begin_layout Standard
22950 This shows the complete history of the GIT document.
22954 \begin_inset Quotes qld
22958 \begin_inset Quotes qld
22963 is shown in a browser.
22966 \begin_layout Subsubsection
22970 \begin_layout Standard
22972 supports GIT hash number of the last commit to the file,
22973 \change_inserted 1119979965 1564297456
22974 its abbreviated form,
22976 author name, date and time of last commit.
22977 All those are extracted from
22979 git log -n 1 --pretty=format:%H%n
22980 \change_inserted 1119979965 1564297427
22986 Tree version information is obtained via
22988 git describe --abbrev --dirty --long
22992 \begin_inset CommandInset ref
22994 reference "subsec:VCS-Revision-Information"
23001 \begin_layout Subsection
23005 \begin_layout Standard
23006 With the recent addition of the
23007 \begin_inset Flex Code
23010 \begin_layout Plain Layout
23016 function \SpecialChar LyX
23017 power users are allowed to create their own commands for revision
23021 \begin_layout Standard
23022 As an example you can see how two TortoiseSVN commands could be integrated
23026 \begin_layout Description
23028 \begin_inset Flex Code
23031 \begin_layout Plain Layout
23032 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
23040 \begin_layout Description
23042 \begin_inset Flex Code
23045 \begin_layout Plain Layout
23046 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
23054 \begin_layout Subsection
23055 Version control and Document comparison
23058 \begin_layout Standard
23059 One of the typical uses of version control is to inspect the changes between
23060 revisions, usually by creating
23061 \begin_inset Flex Code
23064 \begin_layout Plain Layout
23071 While this is useful for plain text files, it is much less useful in the
23072 case of \SpecialChar LyX
23073 files, which have more a complicated structure.
23074 Hence we provide binding to the Document comparison feature.
23075 There are two ways of calling this feature – either by direct call of
23076 \begin_inset Flex Code
23079 \begin_layout Plain Layout
23086 function (for details see \SpecialChar LyX
23087 functions manual) or by the toolbar icon
23100 One can either compare two chosen revisions of the document or he can simply
23101 compare the current version of edited text with older revisions (where
23103 \begin_inset Flex Noun
23106 \begin_layout Plain Layout
23112 ' revisions back means comparison of the edited file with last commited
23117 \begin_layout Standard
23118 This feature is supported for SVN and RCS though due to the more complicated
23119 versioning scheme of RCS there is a constraint – when addressing the revisions
23120 in dialog, numbers always point to the last number in RCS revision number,
23123 We don't currently support GIT addressing of revisions, one can just compare
23124 edited document with its revision X steps backs, where X is addressed as
23126 \begin_inset Flex Code
23129 \begin_layout Plain Layout
23138 \begin_layout Section
23139 Literate Programming
23142 \begin_layout Standard
23147 (kayvan@sylvan.com)
23151 original documentation written by
23153 Edmar Wienskoski Jr.
23156 (edmar-w-jr@technologist.com)
23159 \begin_layout Subsection
23163 \begin_layout Standard
23164 The main purpose of this documentation is to show you how to use \SpecialChar LyX
23166 programming, where it is assumed that you are familiar with this programming
23167 technique, and know what
23168 \begin_inset Quotes eld
23172 \begin_inset Quotes erd
23176 \begin_inset Quotes eld
23180 \begin_inset Quotes erd
23184 If that is not the case, please follow the web links provided in the following
23186 There is a lot of good documentation out there covering old development
23187 history to the latest tools tips.
23190 \begin_layout Standard
23191 It is also assumed that you are familiar with \SpecialChar LyX
23192 itself to a point that you
23193 are comfortable changing your \SpecialChar LyX
23194 preferences, and X resources file.
23195 If that is not the case please refer to other \SpecialChar LyX
23196 documentation to cover your
23200 \begin_layout Subsection
23201 Literate Programming
23204 \begin_layout Standard
23205 From the Literate Programming FAQ:
23208 \begin_layout Quotation
23209 Literate programming is the combination of documentation and source together
23210 in a fashion suited for reading by human beings.
23211 In fact, literate programs should be enjoyable reading, even inviting!
23212 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23213 and documentation in a single file.
23214 Literate programming tools then parse the file to produce either readable
23215 documentation or compilable source.
23216 The WEB style of literate programming was created by D.
23217 \begin_inset space \thinspace{}
23221 Knuth during the development of his \SpecialChar TeX
23222 typesetting software.
23226 \begin_layout Standard
23227 Another excerpt says:
23230 \begin_layout Quotation
23233 How is literate programming different from verbose commenting?
23236 \begin_layout Quotation
23237 There are three distinguishing characteristics.
23238 In order of importance, they are:
23242 \begin_layout Itemize
23243 flexible order of elaboration
23246 \begin_layout Itemize
23247 automatic support for browsing
23250 \begin_layout Itemize
23251 typeset documentation, especially diagrams and mathematics
23255 \begin_layout Standard
23256 Now that I sparked your curiosity, take a look in the references.
23259 \begin_layout Subsubsection
23263 \begin_layout Standard
23264 The complete Literate Programming FAQ can be found at:
23267 \begin_layout Quote
23268 Literate Programming FAQ
23269 \begin_inset Flex URL
23272 \begin_layout Plain Layout
23274 http://www.literateprogramming.com/lpfaq.pdf
23282 \begin_layout Standard
23283 The FAQ lists 23 (twenty three!) different literate programming tools.
23284 Where some are specialized or
23285 \begin_inset Quotes eld
23289 \begin_inset Quotes erd
23292 for particular programming languages, while other have general scope.
23297 for my own use for several reasons:
23300 \begin_layout Itemize
23301 It can generate the documentation either in \SpecialChar LaTeX
23305 \begin_layout Itemize
23306 It has a open architecture, i.
23307 \begin_inset space \thinspace{}
23311 \begin_inset space \space{}
23314 it is easy to plug in new filters
23318 \begin_layout Plain Layout
23323 are programs that read a given data stream and output a manipulated data
23325 That way, a WEB file (consisting of literate code) can be turned into a
23326 file consisting only of C program code or \SpecialChar LaTeX
23332 and to perform special processing that you may need.
23336 \begin_layout Itemize
23337 There is a good selection of filters available already (the HTML is one
23341 \begin_layout Itemize
23345 \begin_layout Standard
23346 The Noweb web page can be found at:
23349 \begin_layout Quote
23351 \begin_inset Flex URL
23354 \begin_layout Plain Layout
23356 https://www.cs.tufts.edu/~nr/noweb/
23364 \begin_layout Standard
23365 Starting from there you can reach many other interesting links and even
23366 some literate program examples.
23369 \begin_layout Subsection
23371 and Literate Programming with Noweb
23374 \begin_layout Standard
23375 The \SpecialChar LyX
23376 support for Literate Programming is provided by using the generic \SpecialChar LyX
23378 converters mechanism.
23379 This support is provided in a
23380 \begin_inset Quotes eld
23384 \begin_inset Quotes erd
23388 \begin_inset space \thinspace{}
23392 \begin_inset space \space{}
23395 you will be able to use this new \SpecialChar LyX
23396 feature with some other literate programming
23397 tool of your choice by just changing your \SpecialChar LyX
23401 \begin_layout Subsubsection
23402 Generating documents and code (weaving and tangling)
23405 \begin_layout Paragraph
23406 Using the noweb module
23409 \begin_layout Standard
23410 If you have installed Noweb and \SpecialChar LyX
23411 successfully, whenever you open a new document,
23412 after you have chosen its document class, use the
23414 Document\SpecialChar menuseparator
23418 \begin_inset Quotes eld
23422 \begin_inset Quotes erd
23426 If Noweb is correctly installed, when you click on the
23427 \begin_inset Quotes eld
23431 \begin_inset Quotes erd
23434 link, you will see the
23435 \begin_inset Quotes eld
23439 \begin_inset Quotes erd
23442 module in the available list and you can add it to your document.
23445 \begin_layout Paragraph
23449 \begin_layout Standard
23451 enables you to write code with a custom inset named
23452 \begin_inset Flex Noun
23455 \begin_layout Plain Layout
23462 Noweb delimits chunks like this:
23465 \begin_layout LyX-Code
23469 \begin_layout LyX-Code
23473 \begin_layout LyX-Code
23477 \begin_layout LyX-Code
23481 \begin_layout LyX-Code
23485 \begin_layout Standard
23486 The problem is that whatever is written in between the << and the
23490 must be taken literally, i.
23491 \begin_inset space \thinspace{}
23495 \begin_inset space \space{}
23499 should be prevented from making any special interpretation of what has
23501 This is also handled by
23502 \begin_inset Flex Noun
23505 \begin_layout Plain Layout
23511 , that works like a normal text inset but has a free spacing capability.
23514 \begin_layout Standard
23515 As a special note, you can also use the
23516 \begin_inset Quotes eld
23520 \begin_inset Quotes erd
23523 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23527 \begin_layout LyX-Code
23531 \begin_layout LyX-Code
23532 def some_function(args):
23535 \begin_layout LyX-Code
23536 "This is the doc string for this function."
23539 \begin_layout LyX-Code
23540 print "My args: ", args
23543 \begin_layout LyX-Code
23544 @ %def some_function
23547 \begin_layout Standard
23548 For an example of this usage and the resulting cross-reference output, look
23549 at the Literate python program in
23551 LIBDIR/examples/listerrors.lyx
23553 which should make this all clear.
23556 \begin_layout Paragraph
23557 Generating the documentation
23560 \begin_layout Standard
23561 At this point you already have a new document file with a proper document
23562 class, and with some code and text on it.
23563 How do I print it? The answer is simple, you select
23565 View\SpecialChar menuseparator
23569 Just like you would do for a plain document.
23570 No special procedure is required.
23573 \begin_layout Standard
23574 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23578 \begin_layout Enumerate
23581 Update\SpecialChar menuseparator
23584 menu option is chosen, a \SpecialChar LaTeX
23590 \begin_layout Standard
23591 If the document is of any literate class the generated file will be named
23592 with an extension name defined by the
23593 \begin_inset Quotes eld
23597 \begin_inset Quotes erd
23600 format (defined in the Preferences panel), otherwise the file will have
23609 \begin_layout Enumerate
23610 Note that the only difference so far is in the name of the file, no special
23611 processing is required by \SpecialChar LyX
23613 Given that you formatted the code using the
23614 \begin_inset Flex Noun
23617 \begin_layout Plain Layout
23623 inset that, by itself, takes care of the business.
23626 \begin_layout Enumerate
23627 If the document is of any literate class \SpecialChar LyX
23628 will then use the internal \SpecialChar LyX
23630 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23635 \begin_layout Plain Layout
23636 The converters are defined in the
23638 Tools\SpecialChar menuseparator
23642 \begin_inset Quotes eld
23646 \begin_inset Quotes erd
23658 manual for general information about converters.
23663 to generate the \SpecialChar LaTeX
23668 \begin_layout Standard
23669 Otherwise it will just skip this step.
23673 \begin_layout Enumerate
23674 Finally, \SpecialChar LaTeX
23675 is invoked and the regular post processing continues as in a plain
23679 \begin_layout Standard
23680 Independence from a particular
23681 \begin_inset Quotes eld
23685 \begin_inset Quotes erd
23688 is easily achieved by changing the commands that are run by the various
23692 \begin_layout Paragraph
23693 Generating the code
23696 \begin_layout Standard
23697 When the build menu option is chosen or the corresponding button in the
23698 toolbar is pressed, a \SpecialChar LaTeX
23699 file is generated just like step 1 above.
23700 Next, \SpecialChar LyX
23706 This converter needs to be defined by the user and is not installed by
23707 default, though the Program format is.
23708 This converter (like any other converter) will have two parts:
23711 \begin_layout Enumerate
23712 The converter program itself.
23713 This program performs the conversion from the one format to the other (in
23714 this case, from the Noweb format to the Program pseudo-format).
23717 \begin_layout Enumerate
23718 The error log parser.
23719 This is a program whose sole purpose is to rewrite error messages in a
23720 format that \SpecialChar LyX
23722 This makes it possible for \SpecialChar LyX
23723 to place error boxes in the right places in
23727 \begin_layout Standard
23728 The first part, the
23729 \begin_inset Quotes eld
23733 \begin_inset Quotes erd
23736 setting, should be set to
23739 \begin_layout LyX-Code
23747 \begin_layout Standard
23748 This basically means that \SpecialChar LyX
23750 \begin_inset Quotes eld
23754 \begin_inset Quotes erd
23757 (a program or script) with the name of the Noweb file (normally a file
23758 in the \SpecialChar LyX
23759 temp directory) and the directory path of the original \SpecialChar LyX
23764 \begin_layout Standard
23765 This is an implementation of
23766 \begin_inset Quotes eld
23770 \begin_inset Quotes erd
23773 that you can place in a directory on your path:
23776 \begin_layout LyX-Code
23782 \begin_layout LyX-Code
23788 \begin_layout LyX-Code
23791 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23794 \begin_layout Standard
23795 The next part of the converter setting is the
23796 \begin_inset Quotes eld
23800 \begin_inset Quotes erd
23803 which is to be set to
23806 \begin_layout LyX-Code
23809 parselog=$$s/scripts/listerrors
23812 \begin_layout Standard
23813 This will run any errors that are generated by the
23814 \begin_inset Quotes eld
23818 \begin_inset Quotes erd
23821 process through the
23822 \begin_inset Quotes eld
23826 \begin_inset Quotes erd
23832 \begin_layout Standard
23833 The build will normally take place in \SpecialChar LyX
23834 's temporary directory, so the files
23835 produced by the conversion will be in that directory.
23837 will copy out what it regards as the `main' file, but the
23841 conversion may produce several files, and so most of these would then be
23842 deleted when \SpecialChar LyX
23844 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23845 the build-script chunk can place the generated files in that location.
23848 \begin_layout Paragraph
23849 Build instructions in the document
23852 \begin_layout Standard
23853 The last piece of the integration between \SpecialChar LyX
23855 \begin_inset Quotes eld
23859 \begin_inset Quotes erd
23863 Generally, the instructions for building your program should be embedded
23864 in a chunk of its own.
23866 \begin_inset Quotes eld
23870 \begin_inset Quotes erd
23873 above uses the notangle command to look for this chunk (called
23874 \begin_inset Quotes eld
23878 \begin_inset Quotes erd
23881 ) and runs its contents through
23882 \begin_inset Quotes eld
23886 \begin_inset Quotes erd
23892 \begin_layout Standard
23893 Typically, such a chunk would look something like this:
23896 \begin_layout LyX-Code
23900 \begin_layout LyX-Code
23902 \begin_inset Newline newline
23905 if [ -z "${NOWEB_SOURCE}" ]
23906 \begin_inset Newline newline
23912 \begin_layout LyX-Code
23913 NOWEB_SOURCE=myfile.nw
23914 \begin_inset Newline newline
23918 \begin_inset Newline newline
23922 code to extract files ...
23923 use NOWEB_OUTPUT_DIR here ...]
23924 \begin_inset Newline newline
23928 code to compile files ...]
23929 \begin_inset Newline newline
23935 \begin_layout Standard
23938 LIBDIR/examples/listerrors.lyx
23942 LIBDIR/examples/Literate.lyx
23944 which implement two versions of the
23945 \begin_inset Quotes eld
23949 \begin_inset Quotes erd
23952 program for some illustrations of how all of these pieces go together or
23955 LIBDIR/examples/noweb2lyx.lyx.
23958 Interestingly, these three files show off the language-indepence of the
23960 literate programming support since they are written in Python, C and Perl
23964 \begin_layout Subsubsection
23965 Configuring \SpecialChar LyX
23969 \begin_layout Standard
23970 All the Literate Programming support is configured by the
23972 Tools\SpecialChar menuseparator
23976 \begin_inset Quotes eld
23980 \begin_inset Quotes erd
23984 The important parts are:
23987 \begin_layout Description
23989 \begin_inset space ~
23993 \begin_inset Quotes eld
23997 \begin_inset Quotes erd
24001 \begin_inset space ~
24004 format Set up via the File Formats tab, this is where the Noweb-specific
24014 , the file extension is set to
24019 This tells \SpecialChar LyX
24020 to create a file with a
24024 extension in the first step of the conversion process.
24027 \begin_layout Description
24029 \begin_inset space ~
24037 \begin_inset space ~
24040 format This is an empty format whose sole purpose is to be the endpoint
24041 of a conversion (which then allows us to set up a converter for it).
24044 \begin_layout Description
24054 This converter performs the
24055 \begin_inset Quotes eld
24059 \begin_inset Quotes erd
24062 of the literate document.
24063 For Noweb, it is set to
24064 \begin_inset Quotes eld
24069 noweave -delay -index $$i > $$o
24072 \begin_inset Quotes erd
24078 \begin_layout Description
24088 \begin_inset Quotes eld
24092 \begin_inset Quotes erd
24096 As stated above, the Converter is set to
24097 \begin_inset Quotes eld
24105 \begin_inset Quotes erd
24108 , with Flags set to
24109 \begin_inset Newline newline
24113 \begin_inset Quotes eld
24118 parselog=$$s/scripts/listerrors
24121 \begin_inset Quotes erd
24127 \begin_layout Subsubsection
24131 \begin_layout Standard
24132 There is also a new function implemented in the \SpecialChar LyX
24134 \begin_inset Quotes eld
24137 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
24141 \begin_layout Standard
24142 When debugging code with ddd/gdb, it is possible to invoke a text editor
24143 at the current execution position with a single key stroke.
24144 The default ddd configuration for that is shift-ctrl-V.
24145 It happens that you can define the editor command line invocation in ddd
24148 Edit\SpecialChar menuseparator
24149 Preferences\SpecialChar menuseparator
24152 dialog and changing the "Edit Sources" entry.
24155 \begin_layout Standard
24156 I take advantage of the newly created \SpecialChar LyX
24157 server function and this ddd feature,
24159 \begin_inset Quotes eld
24163 \begin_inset Quotes erd
24169 \begin_layout LyX-Code
24170 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
24173 \begin_layout Standard
24174 With this, whenever you are using ddd and find a point in the program that
24175 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24176 ddd will forward this information to \SpecialChar LyX
24177 through the \SpecialChar LyX
24178 server and then the
24180 window will show the same file with the cursor at the same position ddd
24182 No more guessing or long scrolling to locate a point in the program back
24186 \begin_layout Standard
24187 Note however that you must enable the \SpecialChar LyX
24188 server to get this feature working
24189 (it is disabled by default).
24191 \begin_inset space ~
24195 \begin_inset CommandInset ref
24197 reference "sec:Starting-the-Server"
24201 explains how to do that.
24204 \begin_layout Subsubsection
24208 \begin_layout Standard
24209 There are six new buttons that can be added to your \SpecialChar LyX
24211 Four of these buttons are short cuts to layout styles:
24229 , one for the custom inset
24234 The last one is a short cut to the
24235 \begin_inset Quotes eld
24239 \begin_inset Quotes erd
24246 \begin_layout Standard
24248 has a range of buttons that are available for tool bar customization.
24249 In my toolbar I like to combine the six short cuts above with two more:
24254 \SpecialChar menuseparator
24259 \SpecialChar menuseparator
24266 Document\SpecialChar menuseparator
24267 View\SpecialChar menuseparator
24271 Here is how it looks like:
24274 \begin_layout LyX-Code
24278 \begin_layout LyX-Code
24282 \begin_layout LyX-Code
24283 Icon "layout Standard"
24286 \begin_layout LyX-Code
24287 Icon "layout Section"
24290 \begin_layout LyX-Code
24291 Icon "layout \SpecialChar LaTeX
24295 \begin_layout LyX-Code
24296 Icon "layout \SpecialChar LyX
24300 \begin_layout LyX-Code
24301 Icon "flex.insert Chunk"
24304 \begin_layout LyX-Code
24308 \begin_layout LyX-Code
24312 \begin_layout LyX-Code
24313 Icon "buffer-typeset"
24316 \begin_layout LyX-Code
24317 Icon "build-program"
24320 \begin_layout LyX-Code
24324 \begin_layout LyX-Code
24328 \begin_layout LyX-Code
24332 \begin_layout LyX-Code
24336 \begin_layout LyX-Code
24340 \begin_layout Subsubsection
24341 Colors customization
24344 \begin_layout Standard
24345 There are a number of colors in \SpecialChar LyX
24346 that can be customized in
24351 One of the things that bothers people is the \SpecialChar LaTeX
24353 The default color is red, since the chunks uses \SpecialChar LaTeX
24354 font, and there is a lot
24355 of chunks in literate documents, you may get tired of seeing everything
24357 You can change it by going to the tabs
24366 \begin_layout Standard
24367 The next thing is the visible presence of the newline character in the screen.
24368 You can choose the color of this particular character and make it blend
24370 I recommend you choosing a color that is close to the background but not
24371 equal, that way you still can see it is there, but it is not bothering
24375 \begin_layout Subsection
24380 \begin_layout Standard
24389 is documented in the
24393 example file and in the Sweave manual (menu
24395 Help\SpecialChar menuseparator
24401 \begin_layout Chapter
24405 \begin_layout Standard
24406 You can do everything with \SpecialChar LyX
24407 that you can do with \SpecialChar LaTeX
24409 However, \SpecialChar LyX
24410 cannot support every \SpecialChar LaTeX
24412 But you can always use \SpecialChar TeX
24414 This chapter shows you some more special things you might want to use.
24415 For other special things you can do with figures, tables, floats, boxes
24416 and notes, have a look at the
24419 \begin_inset space ~
24427 \begin_layout Section
24428 Multiple Text Columns
24431 \begin_layout Standard
24432 This feature is independent of the option
24434 Two-column document
24436 in the document settings under
24441 If you want to have 2
24442 \begin_inset space ~
24445 columns for the whole document, it is recommended to use the
24447 Two-column document
24450 For all other cases use this feature.
24453 \begin_layout Standard
24454 To use multiple text columns in your document, you have to load the module
24461 Document\SpecialChar menuseparator
24462 Settings\SpecialChar menuseparator
24465 ) and must have the \SpecialChar LaTeX
24467 \begin_inset Flex Code
24470 \begin_layout Plain Layout
24479 \begin_layout Standard
24480 Footnotes within multiple columns will be placed at the bottom of the page
24481 and not under each column.
24482 Within the different columns you can use everything, with the limitation
24483 that for floats you need to use the float option
24490 \begin_layout Subsection
24494 \begin_layout Standard
24495 If you want to have 2
24496 \begin_inset space ~
24499 columns in your text, insert a multicolumn inset via the menu
24501 Insert\SpecialChar menuseparator
24503 \begin_inset space ~
24506 Insets\SpecialChar menuseparator
24508 \begin_inset space ~
24513 where the columns should start.
24514 Write all text that should be printed in 2
24515 \begin_inset space ~
24518 columns into this inset.
24521 \begin_layout Standard
24522 Here is an example:
24525 \begin_layout Standard
24527 \begin_inset Flex Multiple Columns
24530 \begin_layout Plain Layout
24535 The Adventure of the Empty House
24538 \begin_inset Newline newline
24541 by Sir Arthur Conan Doyle
24544 \begin_layout Plain Layout
24547 It was in the spring of the year 1894 that all London was interested, and
24548 the fashionable world dismayed, by the murder of the Honourable Ronald
24549 Adair under most unusual and inexplicable circumstances.
24550 The public has already learned those particulars of the crime which came
24551 out in the police investigation, but a good deal was suppressed upon that
24552 occasion, since the case for the prosecution was so overwhelmingly strong
24553 that it was not necessary to bring forward all the facts.
24554 Only now, at the end of nearly ten years, am I allowed to supply those
24555 missing links which make up the whole of that remarkable chain.
24556 The crime was of interest in itself, but that interest was as nothing to
24557 me compared to the inconceivable sequel, which afforded me the greatest
24558 shock and surprise of any event in my adventurous life.
24559 Even now, after this long interval, I find myself thrilling as I think
24560 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24561 ty which utterly submerged my mind.
24562 Let me say to that public, which has shown some interest in those glimpses
24563 which I have occasionally given them of the thoughts and actions of a very
24564 remarkable man, that they are not to blame me if I have not shared my knowledge
24565 with them, for I should have considered it my first duty to do so, had
24566 I not been barred by a positive prohibition from his own lips, which was
24567 only withdrawn upon the third of last month.
24575 \begin_layout Standard
24576 To get 3 or more columns, set the cursor into the multicolumn inset and
24579 Insert\SpecialChar menuseparator
24581 \begin_inset space ~
24585 \begin_inset space ~
24591 The number of the desired columns is written into that inset (for 3
24592 \begin_inset space ~
24596 \begin_inset Quotes eld
24600 \begin_inset Quotes erd
24604 \begin_inset Newline newline
24607 Here is an example with 3
24608 \begin_inset space ~
24614 \begin_layout Standard
24615 \begin_inset Flex Multiple Columns
24618 \begin_layout Plain Layout
24621 \begin_inset Argument 1
24624 \begin_layout Plain Layout
24631 It can be imagined that my close intimacy with Sherlock Holmes had interested
24632 me deeply in crime, and that after his disappearance I never failed to
24633 read with care the various problems which came before the public.
24634 And I even attempted, more than once, for my own private satisfaction,
24635 to employ his methods in their solution, though with indifferent success.
24636 There was none, however, which appealed to me like this tragedy of Ronald
24638 As I read the evidence at the inquest, which led up to a verdict of willful
24639 murder against some person or persons unknown, I realized more clearly
24640 than I had ever done the loss which the community had sustained by the
24641 death of Sherlock Holmes.
24642 There were points about this strange business which would, I was sure,
24643 have specially appealed to him, and the efforts of the police would have
24644 been supplemented, or more probably anticipated, by the trained observation
24645 and the alert mind of the first criminal agent in Europe.
24646 All day, as I drove upon my round, I turned over the case in my mind and
24647 found no explanation which appeared to me to be adequate.
24648 At the risk of telling a twice-told tale, I will recapitulate the facts
24649 as they were known to the public at the conclusion of the inquest.
24657 \begin_layout Standard
24658 You can have up to 10
24659 \begin_inset space ~
24662 columns if you want to, but that might not be very pleasant for the readers
24666 \begin_layout Standard
24667 \begin_inset Newpage newpage
24673 \begin_layout Subsection
24674 Columns inside Columns
24677 \begin_layout Standard
24678 You can also have columns inside columns:
24681 \begin_layout Standard
24682 \begin_inset Flex Multiple Columns
24685 \begin_layout Plain Layout
24688 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24689 at that time governor of one of the Australian colonies.
24690 Adair's mother had returned from Australia to undergo the operation for
24691 cataract, and she, her son Ronald, and her daughter Hilda were living together
24695 \begin_layout Plain Layout
24696 \begin_inset Flex Multiple Columns
24699 \begin_layout Plain Layout
24702 The youth moved in the best society
24703 \begin_inset space ~
24706 – had, so far as was known, no enemies and no particular vices.
24707 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24708 had been broken off by mutual consent some months before, and there was
24709 no sign that it had left any very profound feeling behind it.
24710 For the rest {sic} the man's life moved in a narrow and conventional circle,
24711 for his habits were quiet and his nature unemotional.
24712 Yet it was upon this easy-going young aristocrat that death came, in most
24713 strange and unexpected form, between the hours of ten and eleven-twenty
24714 on the night of March 30, 1894.
24722 \begin_layout Plain Layout
24725 Ronald Adair was fond of cards
24726 \begin_inset space ~
24729 – playing continually, but never for such stakes as would hurt him.
24730 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24731 It was shown that, after dinner on the day of his death, he had played
24732 a rubber of whist at the latter club.
24733 He had also played there in the afternoon.
24738 The evidence of those who had played with him
24739 \begin_inset space ~
24743 Murray, Sir John Hardy, and Colonel Moran
24744 \begin_inset space ~
24747 – showed that the game was whist, and that there was a fairly equal fall
24749 Adair might have lost five pounds, but not more.
24750 His fortune was a considerable one, and such a loss could not in any way
24752 He had played nearly every day at one club or other, but he was a cautious
24753 player, and usually rose a winner.
24754 It came out in evidence that, in partnership with Colonel Moran, he had
24755 actually won as much as four hundred and twenty pounds in a sitting, some
24756 weeks before, from Godfrey Milner and Lord Balmoral.
24757 So much for his recent history as it came out at the inquest.
24765 \begin_layout Subsection
24769 \begin_layout Standard
24770 The examples in this section show some more special features of multiple
24774 \begin_layout Standard
24775 For more features of multiple columns, have a look at the
24776 \begin_inset CommandInset href
24778 name "documentation"
24779 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
24784 of the \SpecialChar LaTeX
24786 \begin_inset Flex Code
24789 \begin_layout Plain Layout
24798 \begin_layout Subsubsection
24802 \begin_layout Standard
24803 To add a preface text for multiple columns, set the cursor into the multicolumn
24804 inset and use the menu
24806 Insert\SpecialChar menuseparator
24810 Write your preface text into that inset.
24811 \begin_inset Newline newline
24814 This is an example with some preface text:
24817 \begin_layout Standard
24818 \begin_inset VSpace bigskip
24824 \begin_layout Standard
24825 \begin_inset Flex Multiple Columns
24828 \begin_layout Plain Layout
24829 \begin_inset Argument 2
24832 \begin_layout Plain Layout
24833 And the story continues and continues and continues and continues\SpecialChar ldots
24841 On the evening of the crime, he returned from the club exactly at ten.
24842 His mother and sister were out spending the evening with a relation.
24843 The servant deposed that she heard him enter the front room on the second
24844 floor, generally used as his sitting-room.
24845 She had lit a fire there, and as it smoked she had opened the window.
24846 No sound was heard from the room until eleven-twenty, the hour of the return
24847 of Lady Maynooth and her daughter.
24848 Desiring to say good-night, she attempted to enter her son's room.
24849 The door was locked on the inside, and no answer could be got to their
24850 cries and knocking.
24851 Help was obtained, and the door forced.
24852 The unfortunate young man was found lying near the table.
24853 His head had been horribly mutilated by an expanding revolver bullet, but
24854 no weapon of any sort was to be found in the room.
24862 \begin_layout Standard
24863 You can also use a section heading as the preface if you use a section command
24864 as \SpecialChar TeX
24866 For example the command
24869 \begin_layout LyX-Code
24872 subsection{subsection title}
24875 \begin_layout Standard
24876 creates a subsection.
24877 In this example the preface is a subsubsection:
24880 \begin_layout Standard
24881 \begin_inset Flex Multiple Columns
24884 \begin_layout Plain Layout
24885 \begin_inset Argument 2
24888 \begin_layout Plain Layout
24892 \begin_layout Plain Layout
24901 This is a subsubsection heading as a preface
24905 \begin_layout Plain Layout
24919 A minute examination of the circumstances served only to make the case more
24921 In the first place, no reason could be given why the young man should have
24922 fastened the door upon the inside.
24923 There was the possibility that the murderer had done this, and had afterwards
24924 escaped by the window.
24925 The drop was at least twenty feet, however, and a bed of crocuses in full
24927 Neither the flowers nor the earth showed any sign of having been disturbed,
24928 nor were there any marks upon the narrow strip of grass which separated
24929 the house from the road.
24930 Apparently, therefore, it was the young man himself who had fastened the
24932 But how did he come by his death? No one could have climbed up to the window
24933 without leaving traces.
24934 Suppose a man had fired through the window, he would indeed be a remarkable
24935 shot who could with a revolver inflict so deadly a wound.
24936 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
24937 a hundred yards of the house.
24938 No one had heard a shot.
24946 \begin_layout Standard
24947 If there is less vertical space than 6
24948 \begin_inset space ~
24951 text lines is left on the page at the beginning of the multiple columns,
24952 a page break will be inserted before the multiple columns.
24953 Depending on the number of lines of the preface text, you might want to
24955 This is done by setting the cursor into the mulitcolumn inset behind the
24956 preface (if there is any) and using the menu
24958 Insert\SpecialChar menuseparator
24960 \begin_inset space ~
24964 \begin_inset space ~
24968 \begin_inset space ~
24974 Insert into that inset the amount of space like e.
24975 \begin_inset space \thinspace{}
24979 \begin_inset space \space{}
24983 \begin_inset Quotes eld
24987 \begin_inset Quotes erd
24991 \begin_inset Newline newline
24994 In this example the space is set to 7
24995 \begin_inset space ~
24998 text lines by using
24999 \begin_inset Flex Code
25002 \begin_layout Plain Layout
25011 \begin_inset Flex Code
25014 \begin_layout Plain Layout
25022 needs to be inserted as \SpecialChar TeX
25026 \begin_layout Standard
25027 \begin_inset Flex Multiple Columns
25030 \begin_layout Plain Layout
25031 \begin_inset Argument 3
25034 \begin_layout Plain Layout
25039 \begin_layout Plain Layout
25055 On the evening of the crime, he returned from the club exactly at ten.
25056 His mother and sister were out spending the evening with a relation.
25057 The servant deposed that she heard him enter the front room on the second
25058 floor, generally used as his sitting-room.
25059 She had lit a fire there, and as it smoked she had opened the window.
25060 No sound was heard from the room until eleven-twenty, the hour of the return
25061 of Lady Maynooth and her daughter.
25062 Desiring to say good-night, she attempted to enter her son's room.
25063 The door was locked on the inside, and no answer could be got to their
25064 cries and knocking.
25065 Help was obtained, and the door forced.
25066 The unfortunate young man was found lying near the table.
25067 His head had been horribly mutilated by an expanding revolver bullet, but
25068 no weapon of any sort was to be found in the room.
25076 \begin_layout Subsubsection
25080 \begin_layout Standard
25081 The amount of space before and after multiple columns can be changed by
25082 changing the length
25083 \begin_inset Flex Code
25086 \begin_layout Plain Layout
25095 For example the command
25098 \begin_layout LyX-Code
25106 \begin_layout Standard
25107 in \SpecialChar TeX
25108 Code changes its value to 3
25109 \begin_inset space \thinspace{}
25113 The change must be made before the multiple columns' start.
25114 The predefined value is 13
25115 \begin_inset space \thinspace{}
25121 \begin_layout Standard
25123 \begin_inset Flex Code
25126 \begin_layout Plain Layout
25135 \begin_inset space \thinspace{}
25141 \begin_layout Standard
25145 \begin_layout Plain Layout
25151 multicolsep}{2.5cm}
25159 \begin_layout Standard
25160 \begin_inset Flex Multiple Columns
25163 \begin_layout Plain Layout
25166 All day I turned these facts over in my mind, endeavouring to hit upon some
25167 theory which could reconcile them all, and to find that line of least resistanc
25168 e which my poor friend had declared to be the starting-point of every investigat
25170 I confess that I made little progress.
25171 In the evening I strolled across the Park, and found myself about six o'clock
25172 at the Oxford Street end of Park Lane.
25173 A group of loafers upon the pavements, all staring up at a particular window,
25174 directed me to the house which I had come to see.
25175 A tall, thin man with coloured glasses, whom I strongly suspected of being
25176 a plain-clothes detective, was pointing out some theory of his own, while
25177 the others crowded round to listen to what he said.
25178 I got as near him as I could, but his observations seemed to me to be absurd,
25179 so I withdrew again in some disgust.
25180 As I did so I struck against an elderly, deformed man, who had been behind
25181 me, and I knocked down several books which he was carrying.
25189 \begin_layout Standard
25190 \begin_inset Note Greyedout
25193 \begin_layout Plain Layout
25198 The values you set with
25199 \begin_inset Flex Code
25202 \begin_layout Plain Layout
25210 will be used for all following multiple columns until you change them again.
25218 \begin_layout Standard
25222 \begin_layout Plain Layout
25234 \begin_inset Note Note
25237 \begin_layout Plain Layout
25238 go back to the default
25246 \begin_layout Standard
25247 \begin_inset Newpage newpage
25253 \begin_layout Subsubsection
25257 \begin_layout Standard
25258 A column break can be forced by inserting the command
25259 \begin_inset Flex Code
25262 \begin_layout Plain Layout
25270 as \SpecialChar TeX
25271 Code to that position in the text where the column should be broken.
25272 Note that this leads in most cases to whitespace in the text.
25273 \begin_inset Newline newline
25276 Here is an example:
25279 \begin_layout Standard
25280 \begin_inset Flex Multiple Columns
25283 \begin_layout Plain Layout
25286 \begin_inset Quotes eld
25289 You're surprised to see me, sir,
25290 \begin_inset Quotes erd
25293 said he, in a strange, croaking voice.
25296 \begin_layout Plain Layout
25299 I acknowledged that I was.
25302 \begin_layout Plain Layout
25305 \begin_inset Quotes eld
25308 Well, I've a conscience, sir, and when I chanced to see you go into this
25309 house, as I came hobbling after you, I thought to myself, I'll just step
25310 in and see that kind gentleman, and tell him that if I was a bit gruff
25311 in my manner there was not any harm meant, and that I am much obliged to
25312 him for picking up my books.
25313 \begin_inset Quotes erd
25319 \begin_layout Plain Layout
25322 \begin_inset Quotes eld
25325 You make too much of a trifle,
25326 \begin_inset Quotes erd
25331 \begin_inset Quotes eld
25334 May I ask how you knew who I was?
25335 \begin_inset Quotes erd
25338 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25342 \begin_layout Plain Layout
25354 \begin_layout Plain Layout
25357 \begin_inset Quotes eld
25360 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25361 you'll find my little bookshop at the corner of Church Street, and very
25362 happy to see you, I am sure.
25363 Maybe you collect yourself, sir.
25367 \begin_inset space ~
25381 \begin_inset space ~
25384 – a bargain, every one of them.
25385 With five volumes you could just fill that gap on that second shelf.
25386 It looks untidy, does it not, sir?
25387 \begin_inset Quotes erd
25398 \begin_layout Subsubsection
25402 \begin_layout Standard
25403 The width of the columns is automatically calculated, but you can modify
25404 the space between the columns.
25405 This is done by changing the length
25406 \begin_inset Flex Code
25409 \begin_layout Plain Layout
25418 Its predefined value is 10
25419 \begin_inset space \thinspace{}
25423 Here is an example where
25424 \begin_inset Flex Code
25427 \begin_layout Plain Layout
25436 \begin_inset space \thinspace{}
25442 \begin_layout Standard
25446 \begin_layout Plain Layout
25460 \begin_layout Standard
25461 \begin_inset Flex Multiple Columns
25464 \begin_layout Plain Layout
25467 My observations of No.
25468 \begin_inset space \space{}
25471 427 Park Lane did little to clear up the problem in which I was interested.
25472 The house was separated from the street by a low wall and railing, the
25473 whole not more than five feet high.
25474 It was perfectly easy, therefore, for anyone to get into the garden, but
25475 the window was entirely inaccessible, since there was no water pipe or
25476 anything which could help the most active man to climb it.
25477 More puzzled than ever, I retraced my steps to Kensington.
25478 I had not been in my study five minutes when the maid entered to say that
25479 a person desired to see me.
25480 To my astonishment it was none other than my strange old book collector,
25481 his sharp, wizened face peering out from a frame of white hair, and his
25482 precious volumes, a dozen of them at least, wedged under his right arm.
25490 \begin_layout Standard
25494 \begin_layout Plain Layout
25506 \begin_inset Note Note
25509 \begin_layout Plain Layout
25510 go back to the default
25518 \begin_layout Subsubsection
25522 \begin_layout Standard
25523 Between the columns a rule with a width of the length
25524 \begin_inset Flex Code
25527 \begin_layout Plain Layout
25536 If this rule width is set to 0
25537 \begin_inset space \thinspace{}
25540 pt (this is the default), the rule is suppressed.
25541 In the following example the rule is 2
25542 \begin_inset space \thinspace{}
25548 \begin_layout Standard
25552 \begin_layout Plain Layout
25558 columnseprule}{2pt}
25566 \begin_layout Standard
25567 \begin_inset Flex Multiple Columns
25570 \begin_layout Plain Layout
25573 \begin_inset Quotes eld
25576 You're surprised to see me, sir,
25577 \begin_inset Quotes erd
25580 said he, in a strange, croaking voice.
25583 \begin_layout Plain Layout
25586 I acknowledged that I was.
25589 \begin_layout Plain Layout
25592 \begin_inset Quotes eld
25595 Well, I've a conscience, sir, and when I chanced to see you go into this
25596 house, as I came hobbling after you, I thought to myself, I'll just step
25597 in and see that kind gentleman, and tell him that if I was a bit gruff
25598 in my manner there was not any harm meant, and that I am much obliged to
25599 him for picking up my books.
25600 \begin_inset Quotes erd
25606 \begin_layout Plain Layout
25609 \begin_inset Quotes eld
25612 You make too much of a trifle,
25613 \begin_inset Quotes erd
25618 \begin_inset Quotes eld
25621 May I ask how you knew who I was?
25622 \begin_inset Quotes erd
25628 \begin_layout Plain Layout
25631 \begin_inset Quotes eld
25634 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25635 you'll find my little bookshop at the corner of Church Street, and very
25636 happy to see you, I am sure.
25637 Maybe you collect yourself, sir.
25641 \begin_inset space ~
25655 \begin_inset space ~
25658 – a bargain, every one of them.
25659 With five volumes you could just fill that gap on that second shelf.
25660 It looks untidy, does it not, sir?
25661 \begin_inset Quotes erd
25672 \begin_layout Standard
25673 \begin_inset VSpace defskip
25679 \begin_layout Standard
25680 The rule can be colored by redefining the command
25681 \begin_inset Flex Code
25684 \begin_layout Plain Layout
25693 This is done by inserting the command
25696 \begin_layout LyX-Code
25701 columnseprulecolor}{
25706 \begin_layout Standard
25707 as \SpecialChar TeX
25708 Code before the multicolumn inset.
25710 \begin_inset Flex Code
25713 \begin_layout Plain Layout
25719 in this command by a color of your choice.
25720 You can use all pre- and self-defined colors.
25728 \begin_inset space ~
25733 for more information about pre- and self-defined colors.
25734 To go back to the default color insert the command
25737 \begin_layout LyX-Code
25742 columnseprulecolor}{
25747 \begin_layout Standard
25748 Here is the example with a cyan rule and 1
25749 \begin_inset space \thinspace{}
25752 cm column separation:
25755 \begin_layout Standard
25759 \begin_layout Plain Layout
25768 \begin_layout Plain Layout
25774 columnseprulecolor}{
25784 \begin_layout Standard
25785 \begin_inset Flex Multiple Columns
25788 \begin_layout Plain Layout
25791 \begin_inset Quotes eld
25794 You're surprised to see me, sir,
25795 \begin_inset Quotes erd
25798 said he, in a strange, croaking voice.
25801 \begin_layout Plain Layout
25804 I acknowledged that I was.
25807 \begin_layout Plain Layout
25810 \begin_inset Quotes eld
25813 Well, I've a conscience, sir, and when I chanced to see you go into this
25814 house, as I came hobbling after you, I thought to myself, I'll just step
25815 in and see that kind gentleman, and tell him that if I was a bit gruff
25816 in my manner there was not any harm meant, and that I am much obliged to
25817 him for picking up my books.
25818 \begin_inset Quotes erd
25824 \begin_layout Plain Layout
25827 \begin_inset Quotes eld
25830 You make too much of a trifle,
25831 \begin_inset Quotes erd
25836 \begin_inset Quotes eld
25839 May I ask how you knew who I was?
25840 \begin_inset Quotes erd
25846 \begin_layout Plain Layout
25849 \begin_inset Quotes eld
25852 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25853 you'll find my little bookshop at the corner of Church Street, and very
25854 happy to see you, I am sure.
25855 Maybe you collect yourself, sir.
25859 \begin_inset space ~
25873 \begin_inset space ~
25876 – a bargain, every one of them.
25877 With five volumes you could just fill that gap on that second shelf.
25878 It looks untidy, does it not, sir?
25879 \begin_inset Quotes erd
25890 \begin_layout Standard
25894 \begin_layout Plain Layout
25900 columnseprule}{0pt}
25903 \begin_layout Plain Layout
25909 columnseprulecolor}{
25917 \begin_inset Note Note
25920 \begin_layout Plain Layout
25921 go back to the default
25929 \begin_layout Section
25930 Non-standard Paragraph Shapes
25933 \begin_layout Standard
25936 as well as any other text processor uses by default rectangular paragraphs.
25937 For special cases like for example posters, invitation cards or poems you
25938 can modify the paragraph shape to one of your choice.
25939 This can be done by using the \SpecialChar LaTeX
25941 \begin_inset Flex Code
25944 \begin_layout Plain Layout
25950 which is loaded by using in the document settings the module
25952 Custom paragraph shapes
25957 \begin_layout Subsection
25961 \begin_layout Standard
25966 provides the following shapes:
25969 \begin_layout Standard
25970 \begin_inset Tabular
25971 <lyxtabular version="3" rows="13" columns="3">
25972 <features booktabs="true" islongtable="true" longtabularalignment="center">
25973 <column alignment="left" valignment="middle" width="16col%">
25974 <column alignment="left" valignment="middle" width="40col%">
25975 <column alignment="left" valignment="middle" width="35col%">
25976 <row endhead="true">
25977 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25980 \begin_layout Plain Layout
25989 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25992 \begin_layout Plain Layout
26001 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26004 \begin_layout Plain Layout
26014 <row interlinespace="default">
26015 <cell alignment="left" valignment="top" usebox="none">
26018 \begin_layout Plain Layout
26026 <cell alignment="left" valignment="top" usebox="none">
26029 \begin_layout Plain Layout
26032 Circle with circular hole (in the size of a CD/DVD)
26037 <cell alignment="left" valignment="top" usebox="none">
26040 \begin_layout Plain Layout
26043 Cannot be scaled, take care there is not too much text
26049 <row interlinespace="default">
26050 <cell alignment="left" valignment="top" usebox="none">
26053 \begin_layout Plain Layout
26061 <cell alignment="left" valignment="top" usebox="none">
26064 \begin_layout Plain Layout
26072 <cell alignment="left" valignment="top" usebox="none">
26075 \begin_layout Plain Layout
26078 Fragile, calculation might fail
26084 <row interlinespace="default">
26085 <cell alignment="left" valignment="top" usebox="none">
26088 \begin_layout Plain Layout
26096 <cell alignment="left" valignment="top" usebox="none">
26099 \begin_layout Plain Layout
26102 Rhomboid (symbolizing a
26103 \begin_inset Quotes eld
26107 \begin_inset Quotes erd
26115 <cell alignment="left" valignment="top" usebox="none">
26118 \begin_layout Plain Layout
26127 <row interlinespace="default">
26128 <cell alignment="left" valignment="top" usebox="none">
26131 \begin_layout Plain Layout
26139 <cell alignment="left" valignment="top" usebox="none">
26142 \begin_layout Plain Layout
26150 <cell alignment="left" valignment="top" usebox="none">
26153 \begin_layout Plain Layout
26162 <row interlinespace="default">
26163 <cell alignment="left" valignment="top" usebox="none">
26166 \begin_layout Plain Layout
26174 <cell alignment="left" valignment="top" usebox="none">
26177 \begin_layout Plain Layout
26185 <cell alignment="left" valignment="top" usebox="none">
26188 \begin_layout Plain Layout
26197 <row interlinespace="default">
26198 <cell alignment="left" valignment="top" usebox="none">
26201 \begin_layout Plain Layout
26209 <cell alignment="left" valignment="top" usebox="none">
26212 \begin_layout Plain Layout
26215 Nut for bolt (hexagon with circular hole)
26220 <cell alignment="left" valignment="top" usebox="none">
26223 \begin_layout Plain Layout
26232 <row interlinespace="default">
26233 <cell alignment="left" valignment="top" usebox="none">
26236 \begin_layout Plain Layout
26244 <cell alignment="left" valignment="top" usebox="none">
26247 \begin_layout Plain Layout
26255 <cell alignment="left" valignment="top" usebox="none">
26258 \begin_layout Plain Layout
26267 <row interlinespace="default">
26268 <cell alignment="left" valignment="top" usebox="none">
26271 \begin_layout Plain Layout
26279 <cell alignment="left" valignment="top" usebox="none">
26282 \begin_layout Plain Layout
26290 <cell alignment="left" valignment="top" usebox="none">
26293 \begin_layout Plain Layout
26302 <row interlinespace="default">
26303 <cell alignment="left" valignment="top" usebox="none">
26306 \begin_layout Plain Layout
26314 <cell alignment="left" valignment="top" usebox="none">
26317 \begin_layout Plain Layout
26325 <cell alignment="left" valignment="top" usebox="none">
26328 \begin_layout Plain Layout
26337 <row interlinespace="default">
26338 <cell alignment="left" valignment="top" usebox="none">
26341 \begin_layout Plain Layout
26349 <cell alignment="left" valignment="top" usebox="none">
26352 \begin_layout Plain Layout
26355 Normal/reversed rain drop
26360 <cell alignment="left" valignment="top" usebox="none">
26363 \begin_layout Plain Layout
26366 Fragile, calculation might fail
26372 <row interlinespace="default">
26373 <cell alignment="left" valignment="top" usebox="none">
26376 \begin_layout Plain Layout
26385 <cell alignment="left" valignment="top" usebox="none">
26388 \begin_layout Plain Layout
26391 The \SpecialChar TeX
26397 <cell alignment="left" valignment="top" usebox="none">
26400 \begin_layout Plain Layout
26409 <row interlinespace="default">
26410 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26413 \begin_layout Plain Layout
26417 \begin_inset Newline newline
26425 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26428 \begin_layout Plain Layout
26431 Triangles in different orientations
26436 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26439 \begin_layout Plain Layout
26455 \begin_layout Standard
26456 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26458 for environments in the toolbar.
26461 \begin_layout Standard
26462 \begin_inset Newpage newpage
26468 \begin_layout Standard
26469 Here is an example paragraph in the shape of a nut:
26472 \begin_layout Standard
26473 \begin_inset VSpace bigskip
26482 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26483 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26485 At vero eos et accusam et justo duo dolores et ea rebum.
26486 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26488 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26489 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26493 \begin_layout Standard
26494 \begin_inset VSpace bigskip
26500 \begin_layout Standard
26501 \begin_inset Note Greyedout
26504 \begin_layout Plain Layout
26513 paragraphs cannot run over a page break.
26521 \begin_layout Standard
26522 \begin_inset VSpace bigskip
26528 \begin_layout Standard
26530 \begin_inset Flex Code
26533 \begin_layout Plain Layout
26539 takes care that the shape will always be preserved, no matter how much
26540 text is in the paragraph.
26541 Therefore the paragraph size changes with the amount of contained text.
26542 This can lead to paragraph sizes exceeding the page margins.
26543 To demonstrate the size scaling, here is the same example paragraph but
26544 with twice as much text:
26547 \begin_layout Standard
26548 \begin_inset Newpage newpage
26557 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26558 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26560 At vero eos et accusam et justo duo dolores et ea rebum.
26561 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26563 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26564 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26566 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26567 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26569 At vero eos et accusam et justo duo dolores et ea rebum.
26570 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26572 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26573 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26577 \begin_layout Standard
26578 \begin_inset VSpace bigskip
26584 \begin_layout Standard
26585 An exception is the shape
26590 It cannot be scaled because it must fit the size of a CD/DVD.
26591 Therefore the amount of text that fits into the shape is limited.
26592 \begin_inset Newline newline
26603 shape are fragile, meaning that the calculation of their size can fail,
26604 depending on the amount of text.
26605 You will then get the \SpecialChar LaTeX
26607 \begin_inset Quotes eld
26610 Arithmetic overflow
26611 \begin_inset Quotes erd
26615 In this case one can try to remove or add some text; if nothing works one
26616 has to use another shape.
26619 \begin_layout Standard
26620 \begin_inset VSpace bigskip
26626 \begin_layout Standard
26627 For shapes with tips you will maybe see that \SpecialChar LaTeX
26628 's hyphenation routine fails
26629 for text in the tips.
26630 Therefore it is often necessary to add hyphenation points
26635 arg "specialchar-insert hyphenation"
26640 ) to the corresponding text parts.
26643 \begin_layout Standard
26644 \begin_inset VSpace bigskip
26650 \begin_layout Standard
26651 Shapepar paragraphs are either always centered or placed on the page so
26652 that their left border touches the left page margin.
26653 You can therefore not use the paragraph dialog to align such paragraphs.
26654 A solution is to put the paragraph into a minipage or parbox and align
26656 The problem is hereby to find the right width for the box.
26657 Because if it is too wide and you center the box, the paragraph is not
26658 centered too because it sticks at the left side of the box.
26659 So you might have to play a bit with the width until it fits.
26660 Here are two heart-shaped paragraphs, the first one is not aligned, the
26661 second one is right-aligned:
26664 \begin_layout Standard
26665 \begin_inset Newpage newpage
26671 \begin_layout Heart
26675 Lo\SpecialChar softhyphen
26676 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26677 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26679 At vero eos et accusam et justo duo dolores et ea rebum.
26680 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26684 \begin_layout Standard
26685 \begin_inset VSpace bigskip
26691 \begin_layout Standard
26694 \begin_inset Box Frameless
26704 height_special "totalheight"
26709 backgroundcolor "none"
26712 \begin_layout Heart
26716 Lo\SpecialChar softhyphen
26717 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26718 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26720 At vero eos et accusam et justo duo dolores et ea rebum.
26721 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26730 \begin_layout Subsection
26734 \begin_layout Standard
26735 You can define any shape you want.
26736 Doing this manually is a lot of work because every coordinate must be specified.
26737 But there is a way to let the computer calculate the coordinates:
26740 \begin_layout Enumerate
26741 Install the program
26742 \begin_inset CommandInset href
26745 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
26753 \begin_layout Enumerate
26760 TeX/LaTeX\SpecialChar menuseparator
26761 Settings\SpecialChar menuseparator
26764 and select the font size you are using in your document.
26765 For example this document uses the size 12
26766 \begin_inset space \thinspace{}
26772 \begin_layout Enumerate
26776 \begin_layout Enumerate
26779 TeX/LaTeX\SpecialChar menuseparator
26782 to export the shape to coordinates.
26783 In the appearing dialog use either the outline of your shape for the coordinate
26784 s or the path itself.
26788 \begin_layout Plain Layout
26789 For more information see
26790 \begin_inset CommandInset href
26792 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26805 \begin_layout Standard
26806 The coordinates are written into a \SpecialChar TeX
26808 To use it for your \SpecialChar LyX
26812 \begin_layout Enumerate
26813 Place the cursor before the first character of your paragraph (or into a
26817 \begin_layout Enumerate
26818 Open in \SpecialChar LyX
26821 Insert\SpecialChar menuseparator
26822 File\SpecialChar menuseparator
26824 \begin_inset space ~
26829 , select the file and use
26838 \begin_layout Standard
26839 \begin_inset VSpace defskip
26845 \begin_layout Standard
26846 \begin_inset Note Greyedout
26849 \begin_layout Plain Layout
26854 : The changed shape only applies to the current paragraph; everything is
26855 reset to normal for the next paragraph.
26856 Therefore the shape definition file must be input into every paragraph
26857 with the desired shape.
26865 \begin_layout Standard
26866 \begin_inset VSpace bigskip
26872 \begin_layout Standard
26873 Here is an example:
26876 \begin_layout Standard
26877 \begin_inset VSpace bigskip
26883 \begin_layout Standard
26884 \begin_inset CommandInset include
26886 filename "SpecialParagraphShape.tex"
26893 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26894 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26896 At vero eos et accusam et justo duo dolores et ea rebum.
26897 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26899 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26900 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26904 \begin_layout Standard
26905 \begin_inset VSpace bigskip
26911 \begin_layout Standard
26916 to draw complexer shapes in
26920 you can draw the shape in a program of your choice and import the resulting
26926 Then you only need to draw a line or spline along the outline of the image.
26929 \begin_layout Standard
26930 \begin_inset VSpace bigskip
26936 \begin_layout Standard
26939 Custom paragraph shapes
26941 also provides the two commands
26949 which can be used to define custom shapes coordinate by coordinate.
26953 \begin_layout Plain Layout
26954 These commands are internally used for all shapes described here.
26959 For information how these styles are used and about further customization
26960 possibilities, have a look at the
26961 \begin_inset CommandInset href
26963 name "documentation"
26964 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
26970 \begin_inset Flex Code
26973 \begin_layout Plain Layout