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
44 \maintain_unincluded_children no
46 \language_package default
49 \font_roman "lmodern" "default"
50 \font_sans "lmss" "default"
51 \font_typewriter "lmtt" "default"
52 \font_math "auto" "auto"
53 \font_default_family default
54 \use_non_tex_fonts false
58 \font_typewriter_osf false
59 \font_sf_scale 100 100
60 \font_tt_scale 100 100
62 \use_dash_ligatures true
64 \default_output_format pdf2
66 \bibtex_command default
67 \index_command default
68 \float_placement class
69 \float_alignment class
73 \pdf_title "LyX's Additional Features manual"
74 \pdf_author "LyX Team"
75 \pdf_subject "LyX's additional features documentation"
76 \pdf_keywords "LyX, Documentation, Additional"
78 \pdf_bookmarksnumbered true
79 \pdf_bookmarksopen false
80 \pdf_bookmarksopenlevel 1
85 \pdf_pdfusetitle false
86 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
89 \use_package amsmath 1
90 \use_package amssymb 1
93 \use_package mathdots 1
94 \use_package mathtools 1
96 \use_package stackrel 1
97 \use_package stmaryrd 1
98 \use_package undertilde 1
100 \cite_engine_type default
104 \paperorientation portrait
111 \notefontcolor #0000ff
118 \paragraph_separation indent
119 \paragraph_indentation default
121 \math_indentation default
122 \math_numbering_side default
123 \quotes_style english
127 \paperpagestyle headings
129 \tracking_changes false
130 \output_changes false
132 \postpone_fragile_content false
136 \docbook_table_output 0
137 \docbook_mathml_prefix 1
143 Additional \SpecialChar LyX
147 \begin_layout Subtitle
152 by the \SpecialChar LyX
157 \begin_layout Plain Layout
159 Principal maintainer of this file is
161 Richard Kimberly Heck
164 If you have comments or error corrections,
165 please send them to the \SpecialChar LyX
166 Documentation mailing list,
168 \begin_inset Flex Code
171 \begin_layout Plain Layout
172 <lyx-docs@lists.lyx.org>
185 \begin_layout Standard
186 \begin_inset CommandInset toc
187 LatexCommand tableofcontents
194 \begin_layout Chapter
198 \begin_layout Standard
199 This manual is essentially Part II of the
201 User's Guide\SpecialChar endofsentence
204 The reason for separating the two documents is simple:
209 is already quite lengthy,
210 and it contains information on all of the basic features one needs to know in order to prepare most documents.
213 Team has worked to make \SpecialChar LyX
214 extensible through various configuration files and external packages.
215 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
217 you can create a layout file (or module) for it without having to alter \SpecialChar LyX
219 We've already had contributions of several new features this way,
220 and some of them are documented here.
221 There are also some more `advanced' features,
222 such as how to control the presentation of bibliographies and how to work with multi-part documents,
223 that are not covered in the
227 and are discussed here.
230 \begin_layout Standard
231 This manual also documents some special features,
232 like fax support and version control,
233 which require additional software to work properly.
234 There is also a chapter on \SpecialChar LyX
237 there's a chapter of \SpecialChar LaTeX
239 things you can use to spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
247 only WYSIWYM and will only ever interface to some,
253 \begin_layout Standard
254 If you haven't read the
259 you are definitely in the wrong manual.
264 is the first place to go,
265 since it describes the notation and format of all of the manuals.
266 You should also be thoroughly familiar with the
270 and all of the basic features of \SpecialChar LyX
271 before attempting to read this one.
274 \begin_layout Standard
275 Since many of the topics in this manual depend heavily on \SpecialChar LyX
276 's interaction with \SpecialChar LaTeX
278 this first chapter covers the inner workings of \SpecialChar LyX
279 and how to direct \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
303 we'll explain how \SpecialChar LyX
304 and \SpecialChar LaTeX
305 work together to produce printable output.
306 This is the only place in any of the manuals where we assume you know something about \SpecialChar LaTeX
310 \begin_layout Standard
314 \begin_inset Quotes eld
317 WYSIWYM frontend to \SpecialChar LaTeX
319 \begin_inset Quotes erd
322 but that's no longer true.
323 There are frontends to \SpecialChar LaTeX
328 \begin_layout Plain Layout
329 Some familar ones are \SpecialChar TeX
335 There are also the \SpecialChar LaTeX
336 modes for vi and emacs,
342 These are basically text editors with the ability to run \SpecialChar LaTeX
343 and mark any errors in the file you're editing.
344 Although \SpecialChar LyX
354 run \SpecialChar LaTeX
356 and it also indicates errors in the file,
360 you don't need to know \SpecialChar LaTeX
361 to use \SpecialChar LyX
364 has added its own extensions to \SpecialChar LaTeX
366 Try the following sometime:
369 Export\SpecialChar menuseparator
378 View\SpecialChar menuseparator
386 then look at the preamble of the resulting
387 \begin_inset Flex Code
390 \begin_layout Plain Layout
397 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
399 These macros are defined automatically,
400 according to the features you use in the document.
403 \begin_layout Standard
404 There are several commands that automatically invoke \SpecialChar LaTeX
409 \begin_layout Itemize
412 Document\SpecialChar menuseparator
416 \begin_layout Itemize
419 Document\SpecialChar menuseparator
423 \begin_layout Standard
424 They will only invoke \SpecialChar LaTeX
425 if the file has changed since the last time \SpecialChar LaTeX
430 \begin_layout Standard
431 When \SpecialChar LyX
432 runs \SpecialChar LaTeX
433 on the file you're editing,
434 it performs these steps:
437 \begin_layout Enumerate
438 Convert the document to \SpecialChar LaTeX
439 and save to a file with the extension
440 \begin_inset Flex Code
443 \begin_layout Plain Layout
450 \begin_inset Flex Code
453 \begin_layout Plain Layout
462 \begin_layout Enumerate
463 Run \SpecialChar LaTeX
465 \begin_inset Flex Code
468 \begin_layout Plain Layout
474 file (maybe several times),
475 and run any other commands (such as
476 \begin_inset Flex Code
479 \begin_layout Plain Layout
486 \begin_inset Flex Code
489 \begin_layout Plain Layout
495 ) needed to compile the \SpecialChar LaTeX
499 \begin_layout Enumerate
500 If there are any errors,
504 \begin_layout Standard
505 If you have run \SpecialChar LaTeX
508 View\SpecialChar menuseparator
513 then runs a DVI viewer to display the DVI-file.
516 View\SpecialChar menuseparator
521 performs further steps:
524 \begin_layout Enumerate
526 \begin_inset Flex Code
529 \begin_layout Plain Layout
535 to convert the DVI file to PostScript.
538 \begin_layout Enumerate
539 Run a PostScript viewer,
541 \begin_inset Flex Code
544 \begin_layout Plain Layout
551 to display the PostScript file.
554 \begin_layout Standard
556 does similar things when viewing,
561 \begin_layout Section
562 Translating \SpecialChar LaTeX
563 files into \SpecialChar LyX
567 \begin_layout Standard
568 You can import a \SpecialChar LaTeX
569 file into \SpecialChar LyX
572 File\SpecialChar menuseparator
573 Import\SpecialChar menuseparator
576 command in \SpecialChar LyX
578 This will call a program named
579 \begin_inset Flex Code
582 \begin_layout Plain Layout
588 which will create a file
589 \begin_inset Flex Code
592 \begin_layout Plain Layout
599 \begin_inset Flex Code
602 \begin_layout Plain Layout
610 will then open that file.
614 \begin_layout Plain Layout
615 \begin_inset Flex Code
618 \begin_layout Plain Layout
624 can also be run from the command line,
633 \begin_layout Standard
634 \begin_inset Flex Code
637 \begin_layout Plain Layout
643 will translate most legal \SpecialChar LaTeX
646 It will put things it doesn't understand into \SpecialChar TeX
648 so after translating a file with
649 \begin_inset Flex Code
652 \begin_layout Plain Layout
659 you can look for \SpecialChar TeX
660 code and hand-edit it until it looks right.
663 \begin_layout Standard
664 If you don't know what \SpecialChar TeX
666 read the next section.
669 \begin_layout Section
670 \begin_inset CommandInset label
672 name "sec:Inserting-TeX-Code"
676 Inserting \SpecialChar TeX
677 Code into \SpecialChar LyX
681 \begin_layout Standard
682 Anything you can do in \SpecialChar LaTeX
683 you can do in \SpecialChar LyX
685 for a very simple reason:
686 You can always insert \SpecialChar TeX
687 code into any \SpecialChar LyX
691 and will never be able to,
692 display every possible \SpecialChar LaTeX
694 If ever you need to insert \SpecialChar LaTeX
695 commands into your \SpecialChar LyX
698 \begin_inset Flex Code
701 \begin_layout Plain Layout
709 which you can insert into your document with
711 Insert\SpecialChar menuseparator
714 or the keyboard shortcut
723 \begin_layout Standard
724 Here's an example of inserting \SpecialChar LaTeX
725 commands in a \SpecialChar LyX
727 The code looks like this:
730 \begin_layout LyX-Code
734 \begin_inset Newline newline
740 \begin_inset Newline newline
743 This is an example of a minipage environment.
745 \begin_inset Newline newline
748 can put nearly everything in it,
750 \begin_inset Newline newline
755 \begin_inset Newline newline
761 \begin_inset Newline newline
765 \begin_inset Newline newline
771 \begin_inset Newline newline
777 \begin_inset Newline newline
783 \begin_inset Newline newline
788 \begin_inset Newline newline
794 \begin_inset Newline newline
800 \begin_inset Newline newline
806 \begin_inset Newline newline
814 \begin_layout LyX-Code
818 \begin_layout Standard
820 \begin_inset Flex Code
823 \begin_layout Plain Layout
830 box containing this text is directly after this paragraph.
831 Those of you reading the manual in \SpecialChar LyX
832 will only see the \SpecialChar TeX
834 Those reading a printed version of the manuals will see the actual results:
835 \begin_inset VSpace bigskip
841 \begin_layout Standard
845 \begin_layout Plain Layout
852 \begin_layout Plain Layout
859 \begin_layout Plain Layout
861 This is an example of a minipage environment.
862 You can put nearly everything in it,
863 even (non-floating) figures and tables.
867 \begin_layout Plain Layout
874 \begin_layout Plain Layout
879 \begin_layout Plain Layout
886 \begin_layout Plain Layout
893 \begin_layout Plain Layout
900 \begin_layout Plain Layout
906 \begin_layout Plain Layout
913 \begin_layout Plain Layout
920 \begin_layout Plain Layout
927 \begin_layout Plain Layout
937 \begin_inset VSpace bigskip
943 \begin_layout Standard
944 In addition to using \SpecialChar TeX
946 you can also create a separate file containing some complex \SpecialChar LaTeX
947 structure and then use
949 Insert\SpecialChar menuseparator
956 to include your file (you should select the type
957 \begin_inset Flex Code
960 \begin_layout Plain Layout
967 We recommend that you only do this if you have a
968 \begin_inset Flex Code
971 \begin_layout Plain Layout
983 you'll have a big job tracking down \SpecialChar LaTeX
987 \begin_layout Standard
988 There are a few last points to emphasize:
991 \begin_layout Itemize
997 check if your \SpecialChar LaTeX
1001 \begin_layout Itemize
1002 Beware of reinventing the wheel.
1005 \begin_layout Standard
1008 does have quite a few features tucked into it,
1009 and more are coming.
1010 Be sure to check the manuals to make sure that \SpecialChar LyX
1011 doesn't have such-and-such feature before you decide you have to do it by hand.
1013 there are numerous \SpecialChar LaTeX
1014 packages out there to do all sorts of things,
1015 from labels to envelopes to fancy multipage tables.
1017 \begin_inset CommandInset href
1020 target "https://www.ctan.org/"
1028 \begin_layout Standard
1029 If you do need to do some wild and fancy things within your document,
1030 be sure to check out a good \SpecialChar LaTeX
1031 book for assistance.
1032 There are a number of them listed in the bibliography of the
1039 \begin_layout Section
1041 and the \SpecialChar LaTeX
1045 \begin_layout Subsection
1046 About the \SpecialChar LaTeX
1050 \begin_layout Standard
1051 If you already know \SpecialChar LaTeX
1053 there is no need to explain here what the preamble is good for.
1055 the following will give you some ideas—
1056 we recommend again that you consult a \SpecialChar LaTeX
1057 book for further information.
1059 you should read the points below,
1060 because they explain what you can do and what you don't need to do in the \SpecialChar LaTeX
1061 preamble of a \SpecialChar LyX
1065 \begin_layout Standard
1066 The \SpecialChar LaTeX
1067 preamble comes at the very beginning of a document,
1076 \begin_layout Itemize
1077 Declare the document class.
1079 \begin_inset Newline newline
1083 already does this for you.
1084 If you're a seasoned \SpecialChar LaTeX
1086 and you have a custom document class you want to use,
1089 Customization Manual
1091 for information on how to make \SpecialChar LyX
1095 \begin_layout Itemize
1096 Declare the usage of packages.
1098 \begin_inset Newline newline
1102 packages provide special commands,
1103 which are only available within a document when the package has been declared in the preamble.
1104 In addition to providing special commands,
1105 the inclusion of a package can change the document.
1108 \begin_inset Flex Code
1111 \begin_layout Plain Layout
1117 forces all paragraphs to be indented.
1118 There are other packages for labels,
1125 \begin_layout Itemize
1130 \begin_inset Newline newline
1133 There are several \SpecialChar LaTeX
1134 counters and variables that
1138 be set globally from within the preamble in order to have the desired effect.
1139 (There are variables that you can set and reset inside the document,
1140 too.) Margins are a good example of something that must be set in the preamble.
1141 Another example is the label format for lists.
1142 You can actually set these just about anywhere,
1143 but it's best to do it just once,
1144 inside the preamble.
1147 \begin_layout Itemize
1148 Declare user defined commands (with
1149 \begin_inset Flex Code
1152 \begin_layout Plain Layout
1161 \begin_inset Flex Code
1164 \begin_layout Plain Layout
1173 \begin_inset Newline newline
1176 These are abbreviations for \SpecialChar LaTeX
1177 commands which appear very often inside a document.
1178 Although the preamble is a good place to declare such commands,
1183 be declared anywhere (before they are used for the first time,
1185 This can be useful if there is a lot of raw \SpecialChar LaTeX
1186 code in your document,
1187 which normally should not be the case.
1190 \begin_layout Standard
1192 adds its own set of definitions to the preamble of the
1193 \begin_inset Flex Code
1196 \begin_layout Plain Layout
1203 This makes \SpecialChar LaTeX
1204 files generated by \SpecialChar LyX
1208 \begin_layout Subsection
1209 Changing the Preamble
1212 \begin_layout Standard
1213 The commands which \SpecialChar LyX
1214 adds to the preamble of a \SpecialChar LaTeX
1216 you can't change them without patching \SpecialChar LyX
1220 add your own stuff to the preamble by selecting
1221 \begin_inset Flex Noun
1224 \begin_layout Plain Layout
1227 \begin_inset space ~
1237 Document\SpecialChar menuseparator
1242 adds anything in the
1243 \begin_inset Flex Noun
1246 \begin_layout Plain Layout
1252 dialog to its own built-in preamble.
1253 Before adding your own declarations in the preamble,
1254 you should make sure that \SpecialChar LyX
1255 doesn't already support what you want to do.
1256 (Remember what we said about reinventing the wheel?) Also,
1259 make sure your preamble code is correct
1263 doesn't check it for you.
1264 If there is an error,
1265 you're likely to get an error like
1266 \begin_inset Quotes eld
1270 \begin_inset Flex Code
1273 \begin_layout Plain Layout
1282 \begin_inset Quotes erd
1286 If you see this error,
1287 check your preamble.
1290 \begin_layout Subsection
1294 \begin_layout Standard
1295 Here are some examples of what you can add to a preamble,
1299 \begin_layout Subsubsection
1304 \begin_layout Standard
1305 There are two variables under \SpecialChar LaTeX
1306 that control page position:
1308 \begin_inset Flex Code
1311 \begin_layout Plain Layout
1320 \begin_inset Flex Code
1323 \begin_layout Plain Layout
1332 Their names should be self-explanatory.
1333 These variables are useful if you think for a moment about computer labels.
1335 the size of a print medium and the area of the medium that you can actually print on aren't the same.
1337 \begin_inset Flex Code
1340 \begin_layout Plain Layout
1349 \begin_inset Flex Code
1352 \begin_layout Plain Layout
1363 \begin_layout Standard
1364 The default values for
1365 \begin_inset Flex Code
1368 \begin_layout Plain Layout
1377 \begin_inset Flex Code
1380 \begin_layout Plain Layout
1389 \begin_inset space \thinspace{}
1394 \begin_inset space \thinspace{}
1398 \begin_inset space \space{}
1401 the page isn't shifted.
1403 some DVI drivers always seem to shift the page.
1404 We have no idea why,
1405 or why the sysadmin hasn't fixed such behavior.
1406 If you're using \SpecialChar LyX
1407 on a system that you don't personally maintain,
1408 and your sysadmin is a doofus,
1410 \begin_inset Flex Code
1413 \begin_layout Plain Layout
1422 \begin_inset Flex Code
1425 \begin_layout Plain Layout
1434 Suppose your left and top margins are always 0.5
1435 \begin_inset space \thinspace{}
1439 You can add this to the preamble:
1442 \begin_layout LyX-Code
1450 \begin_layout LyX-Code
1458 \begin_layout Standard
1459 and your margins should now be correct.
1462 \begin_layout Subsubsection
1467 \begin_layout Standard
1469 suppose you wanted to print out a bunch of address labels.
1470 There's a rather nice package,
1471 available at your nearest CTAN archive,
1472 for printing sheets of labels:
1474 \begin_inset Flex Code
1477 \begin_layout Plain Layout
1485 your system may not have this package installed by default.
1486 We leave that up to you to check.
1487 You'll also want to read the documentation for it;
1488 we're not going to do that for you.
1489 Since this is an example,
1491 we'll give you an example of how you use this package.
1494 \begin_layout Standard
1496 make sure you're using the
1497 \begin_inset Flex Code
1500 \begin_layout Plain Layout
1508 you need to put the following in your preamble:
1511 \begin_layout LyX-Code
1517 \begin_layout LyX-Code
1523 \begin_layout LyX-Code
1529 \begin_layout LyX-Code
1535 \begin_layout LyX-Code
1541 \begin_layout LyX-Code
1547 \begin_layout LyX-Code
1553 \begin_layout Standard
1554 This sets things up for Avery label sheets,
1556 You're now ready to print labels,
1557 but you'll need to insert \SpecialChar LaTeX
1559 placing the commands
1560 \begin_inset Flex Code
1563 \begin_layout Plain Layout
1572 \begin_inset Flex Code
1575 \begin_layout Plain Layout
1583 around each label text.
1584 This and other special features of
1585 \begin_inset Flex Code
1588 \begin_layout Plain Layout
1594 are explained in its documentation.
1597 \begin_layout Standard
1599 someone may write a \SpecialChar LyX
1600 layout file to support this package directly.
1601 Maybe that someone is you.
1604 \begin_layout Subsubsection
1606 Paragraph Indentation
1609 \begin_layout Standard
1610 Americans are trained to indent the first line of
1615 As with all of their other weird quirks,
1616 most Americans will whine and moan until they can have their way and indent the first line of all paragraphs.
1627 \begin_layout Standard
1629 this behavior isn't standard typography.
1631 you typically only indent the first line of a paragraph
1635 it follows another one.
1636 The idea behind indenting the first line of a paragraph is to distinguish neighboring paragraphs from one another.
1637 If there is no previous paragraph—
1639 if it follows a figure or is the first paragraph in a section—
1640 then there is no need for indentation.
1644 \begin_layout Standard
1645 If you're a typical American (we're still joking!),
1647 you don't care about such esoteric things;
1648 you want your indentation!
1649 Add this to the preamble:
1652 \begin_layout LyX-Code
1655 usepackage{indentfirst}
1658 \begin_layout Standard
1659 If your \SpecialChar TeX
1660 distribution isn't braindead,
1661 you'll have this package,
1662 and all of your paragraphs will get the indentation the Founding Fathers intended they should have.
1665 \begin_layout Subsubsection
1670 \begin_layout Standard
1671 You can also check out the preamble of this document to get an idea of some of the advanced things you can do.
1674 \begin_layout Section
1676 and \SpecialChar LaTeX
1680 \begin_layout Standard
1681 When \SpecialChar LyX
1682 calls \SpecialChar LaTeX
1684 it tells \SpecialChar LaTeX
1685 to blithely ignore any errors and keep going.
1686 It then uses the logfile from the \SpecialChar LaTeX
1687 run to do a post-mortem.
1688 After analyzing the logfile,
1690 displays a dialog listing the errors.
1691 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1692 file where the error occurred.
1696 \begin_layout Plain Layout
1699 Analyzing the logfile is a tough job,
1700 and \SpecialChar LyX
1701 doesn't always go to the right line.
1702 There are also cases where \SpecialChar LaTeX
1703 reports the error on one line,
1704 but the actual error is earlier.
1705 This is not unlike forgetting a closing brace in a program:
1706 You'll get an error,
1715 \begin_layout Standard
1716 Some folks also like to look at the log file directly:
1717 It is available from
1719 Document\SpecialChar menuseparator
1721 \begin_inset space ~
1727 There are some fairly common error messages and warnings.
1728 We'll cover those here.
1729 You should look at a good \SpecialChar LaTeX
1730 book for a complete listing.
1733 \begin_layout Itemize
1734 \begin_inset Flex Code
1737 \begin_layout Plain Layout
1744 \begin_inset Newline newline
1747 Anything beginning with these words is a warning message for the purpose of
1748 \begin_inset Quotes eld
1752 \begin_inset Quotes erd
1755 the \SpecialChar LaTeX
1757 You'll get messages like this if you added or changed cross-references or bibliography entries,
1760 is trying to tell you that you need to make another run.
1761 You can by-and-large ignore these.
1764 \begin_layout Itemize
1765 \begin_inset Flex Code
1768 \begin_layout Plain Layout
1775 \begin_inset Newline newline
1778 Another warning message,
1779 this time about fonts which \SpecialChar LaTeX
1781 The rest of the message will often say something about a replacement font that \SpecialChar LaTeX
1783 You can safely ignore these,
1787 \begin_layout Itemize
1788 \begin_inset Flex Code
1791 \begin_layout Plain Layout
1800 \begin_inset Newline newline
1809 It seems to generate at least one of these messages for just about any document you write.
1810 They are warnings about lines that were too long and run past the right margin.
1811 This happens if \SpecialChar LaTeX
1812 does not find a reasonable way to break the lines (notoriously often with typewriter font,
1813 since this does not allow for automatic break points).
1815 this is unnoticeable in the final output.
1816 (It can be just a point or two.) Sometimes,
1818 the lines run rather visibly into the margin;
1819 something you will not want to have in your final print.
1821 \begin_inset Newline newline
1824 There are several global ways to try to minimize the overfull lines.
1827 Enable micro-typographic extensions
1831 Document\SpecialChar menuseparator
1832 Settings\SpecialChar menuseparator
1835 might already improve things a lot.
1838 code such as the following in
1840 Document\SpecialChar menuseparator
1841 Settings\SpecialChar menuseparator
1844 usually reduces the overfull lines drastically (we use this in the preamble of this document):
1848 \begin_layout LyX-Code
1852 \begin_inset Newline newline
1858 \begin_inset Newline newline
1863 emergencystretch 1.5em
1864 \begin_inset Newline newline
1872 \begin_layout Standard
1875 you eventually have to rewrite the text to get the line breaking right.
1879 \begin_layout Plain Layout
1880 For more information,
1882 \begin_inset Flex URL
1885 \begin_layout Plain Layout
1887 http://www.tex.ac.uk/FAQ-overfull.html
1900 \begin_layout Standard
1902 you should check the respective lines,
1903 at least for the final version of your document.
1904 Your eyes will tell you if there's a problem with something that's too wide.
1908 \begin_layout Plain Layout
1909 You can also enable the `draft' option in
1911 Document\SpecialChar menuseparator
1915 and then \SpecialChar LaTeX
1916 will draw a black box in the margin of lines that are overfull.
1925 \begin_layout Itemize
1926 \begin_inset Flex Code
1929 \begin_layout Plain Layout
1938 \begin_inset Newline newline
1941 Not quite as common as its cousin.
1942 This happens again if \SpecialChar LaTeX
1943 does not find a reasonable break point and consequently generates too loose lines.
1944 As with the overfull lines,
1945 you should check if this is a visible problem.
1948 \begin_layout Itemize
1949 \begin_inset Flex Code
1952 \begin_layout Plain Layout
1961 \begin_inset Flex Code
1964 \begin_layout Plain Layout
1973 \begin_inset Newline newline
1976 Warnings about troubles breaking the page.
1978 just look at the output.
1979 Your eyes will tell you where something has gone wrong.
1982 \begin_layout Itemize
1983 \begin_inset Flex Code
1986 \begin_layout Plain Layout
1989 \begin_inset Quotes els
1993 \begin_inset Quotes ers
2002 \begin_inset Newline newline
2006 \begin_inset Quotes eld
2010 \begin_inset Quotes erd
2013 isn't installed on this system.
2014 This usually appears because some package your document needs isn't installed.
2015 If you didn't touch the preamble or didn't use the
2016 \begin_inset Flex Code
2019 \begin_layout Plain Layout
2028 then one of the packages \SpecialChar LyX
2029 tried to load is missing.
2032 Help\SpecialChar menuseparator
2035 to get a list of packages that \SpecialChar LyX
2037 This file is updated whenever you reconfigure \SpecialChar LyX
2040 Tools\SpecialChar menuseparator
2043 ) and tells you which packages have been detected and what they do.
2044 \begin_inset Newline newline
2048 \begin_inset Flex Code
2051 \begin_layout Plain Layout
2059 command and the package in question isn't installed,
2060 then you'll need to install it yourself.
2063 \begin_layout Itemize
2064 \begin_inset Flex Code
2067 \begin_layout Plain Layout
2075 \begin_inset Newline newline
2078 Error messages beginning with this are trying to tell you that you specified a bad or undefined option to a package.
2079 Check the package's documentation.
2082 \begin_layout Itemize
2083 \begin_inset Flex Code
2086 \begin_layout Plain Layout
2087 Undefined control sequence
2093 \begin_inset Newline newline
2096 If you've inserted \SpecialChar LaTeX
2097 code into your document,
2099 you'll get one of these.
2100 You may have forgotten to load a package.
2102 this error message usually means that you used an undefined command.
2106 \begin_layout Standard
2107 There are other error and warning messages.
2108 Some are self-explanatory.
2109 These are usually \SpecialChar LaTeX
2111 Others are downright cryptic.
2112 These are usually \SpecialChar TeX
2118 what they mean or how to decipher them.
2122 \begin_layout Standard
2123 There's a general sequence you should follow if you get error messages:
2126 \begin_layout Enumerate
2127 Look at the \SpecialChar LaTeX
2128 code you inserted for typos.
2131 \begin_layout Enumerate
2132 If there are no typos,
2133 check that you used the command(s) correctly.
2136 \begin_layout Enumerate
2137 If you get a bunch of error boxes piled up at the very top of the document—
2138 and especially if you see a
2139 \begin_inset Quotes eld
2143 \begin_inset Flex Code
2146 \begin_layout Plain Layout
2155 \begin_inset Quotes erd
2159 it means that there are errors in the preamble.
2160 Start debugging your preamble.
2163 \begin_layout Enumerate
2164 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2165 code to the document,
2166 the first suspect is your \SpecialChar LaTeX
2167 distribution itself.
2168 Check for missing packages and install them.
2171 \begin_layout Enumerate
2173 so there are no missing packages.
2174 Did you use any of the fine-tuning options in \SpecialChar LyX
2182 like trying to manually insert lots of
2183 \begin_inset Flex Code
2186 \begin_layout Plain Layout
2188 \begin_inset space ~
2198 \begin_inset Flex Code
2201 \begin_layout Plain Layout
2209 \begin_inset Flex Code
2212 \begin_layout Plain Layout
2219 Did you try to kludge something together with these instead of using the appropriate paragraph environment?
2222 \begin_layout Enumerate
2224 you didn't use any of the fine-tuning options,
2225 you played by the rules.
2226 Did you try to pull a fancy maneuver?
2227 Did you do something funky inside a table or an equation,
2228 like inserting a graphic into a table cell?
2231 \begin_layout Enumerate
2232 Do you have long sections of text where \SpecialChar LaTeX
2233 cannot find a place to break a line?
2236 is rather strict about how much extra inter-word spacing it will add in order to break a line.
2238 you should rework the paragraph to avoid the problem.
2241 \begin_layout Enumerate
2242 Did you go overboard with the nesting?
2244 (currently) doesn't check to make sure you're in the limits for nesting environments.
2245 If you nested a bunch of environments to the
2246 \begin_inset Formula $17^{\mathrm{th}}$
2251 (The limit in \SpecialChar LaTeX
2255 \begin_layout Enumerate
2257 you didn't get any error messages,
2258 but your output looks awful.
2259 If you have a table or figure that's too wide or long for the page,
2264 \begin_layout Enumerate
2265 rescale the figure so it fits.
2268 \begin_layout Enumerate
2269 trim down the table so it fits.
2273 \begin_layout Enumerate
2274 If something else is wrong with the output,
2275 and you didn't try to pull anything fancy or kludge the fine-tuning options,
2276 we're not sure what's wrong.
2279 \begin_layout Standard
2280 If all this doesn't help—
2286 you might have found a bug in \SpecialChar LyX
2291 \begin_layout Chapter
2295 \begin_layout Standard
2302 originally offered four standard document classes,
2306 but individuals and organizations,
2307 most notably the American Mathematical Society in the early days,
2308 have made many contributions to extending the range of document classes.
2309 In this chapter we summarize the main externally maintained classes,
2310 some of which are marked “Unavailable:” in the pull-down
2313 \begin_inset space ~
2327 ocument\SpecialChar menuseparator
2332 ettings\SpecialChar menuseparator
2334 \begin_inset space ~
2339 dialog and which you will need to install as described in the
2341 Installing New Document Classes
2347 manual if you want to use them.
2350 \begin_layout Section
2351 \begin_inset CommandInset label
2353 name "sec:Collections"
2360 \begin_layout Subsection
2361 \begin_inset CommandInset label
2363 name "subsec:AMS-LaTeX-(American-Mathematical"
2367 AMS-\SpecialChar LaTeX
2368 (American Mathematical Society)
2371 \begin_layout Standard
2372 The \SpecialChar LyX
2373 supported document classes
2375 American Mathematical Society (AMS)
2383 American Mathematical Society (AMS)
2389 are maintained by the Society;
2390 use of their features is described in the Math manual and on their website
2391 \begin_inset Flex URL
2394 \begin_layout Plain Layout
2396 http://www.ams.org/publications/authors/tex/amslatex
2402 The following summary was originally provided by
2408 Richard Kimberly Heck
2410 and the \SpecialChar LyX
2416 \begin_layout Standard
2417 \begin_inset VSpace bigskip
2423 \begin_layout Standard
2425 The AMS \SpecialChar LaTeX
2426 layouts are set up to conform to suggested styles for mathematical papers to be submitted to American Mathematical Society publications.
2427 The layouts are not tailored to a specific journal,
2429 You should refer to the AMS documentation for specific instructions for each journal (usually it will entail only changing a single line in the \SpecialChar TeX
2431 That documentation is available on the Web at
2432 \begin_inset Flex URL
2435 \begin_layout Plain Layout
2443 \begin_inset Flex URL
2446 \begin_layout Plain Layout
2448 ftp://ftp.ams.org/pub/tex/amslatex/
2454 These layouts are appropriate,
2456 for any mathematical writing.
2460 \begin_layout Standard
2461 There are three basic AMS \SpecialChar LaTeX
2466 \begin_layout Itemize
2468 The standard AMS article format;
2471 File\SpecialChar menuseparator
2472 Open Example\SpecialChar menuseparator
2473 Articles\SpecialChar menuseparator
2474 American Mathematical Society (AMS)
2479 \begin_layout Itemize
2481 the standard AMS book (really,
2485 File\SpecialChar menuseparator
2486 Open Example\SpecialChar menuseparator
2487 Books\SpecialChar menuseparator
2488 American Mathematical Society (AMS)
2493 \begin_layout Itemize
2495 the standard AMS proceedings format.
2498 \begin_layout Standard
2500 only supports the first two natively;
2503 Installing New Document Classes
2509 manual if you want to use
2516 \begin_layout Standard
2517 The layouts themselves contain only the minimum necessary to use the AMS classes.
2520 contain any of the `theorem' environments used for setting theorems,
2523 These are contained,
2530 which is loaded by default when you select one of the AMS classes.
2531 (It can also be used with other classes and can be removed,
2532 if you would rather use something else.) Less commonly used environments are in the
2534 AMS Theorems (Extended)
2537 which must be loaded manually.
2540 \begin_layout Standard
2542 theorems and the like are numbered consecutively throughout the document,
2543 but this may be modified by loading the module
2545 Standard Theorems (Numbered by Section)
2549 \begin_inset Flex Code
2552 \begin_layout Plain Layout
2561 Standard Theorems (Numbered by Chapter)
2564 These will number the results as
2565 \begin_inset Formula $n.m$
2569 where the first number refers to the section (or chapter) and the second refers to the total number of results so far in that section (or chapter).
2570 Many environments are also available unnumbered.
2571 These are indicated by an asterisk at the end.
2572 If you happen to want
2579 Standard Theorems (Unnumbered)
2581 provides that option.
2584 \begin_layout Standard
2585 Note that these modules do not
2589 to be used with the AMS classes.
2590 It is perfectly possible to use the
2595 and the others mentioned,
2598 \begin_inset Flex Code
2601 \begin_layout Plain Layout
2602 Article (Standard Class)
2609 \begin_inset Flex Code
2612 \begin_layout Plain Layout
2613 Report (Standard Class)
2620 \begin_inset Flex Code
2623 \begin_layout Plain Layout
2633 \begin_layout Subsubsection
2634 What these layouts provide
2637 \begin_layout Standard
2638 There is a long list of included environments provided by these layouts.
2639 In AMS-\SpecialChar LaTeX
2643 an opportunity to define an unlimited variety of `theorem' environments.
2645 the AMS recommends the environments that are available in \SpecialChar LyX
2650 \begin_layout Standard
2651 The following environments—
2652 as well as the standard environments,
2654 \begin_inset Flex Noun
2657 \begin_layout Plain Layout
2665 \begin_inset Flex Noun
2668 \begin_layout Plain Layout
2676 \begin_inset Flex Noun
2679 \begin_layout Plain Layout
2687 \begin_inset Flex Noun
2690 \begin_layout Plain Layout
2698 \begin_inset Flex Noun
2701 \begin_layout Plain Layout
2709 \begin_inset Flex Code
2712 \begin_layout Plain Layout
2719 \begin_inset Flex Code
2722 \begin_layout Plain Layout
2731 \begin_layout Description
2732 Address This should be the author's permanent address.
2735 \begin_layout Description
2737 \begin_inset space ~
2740 Address This should be the author's temporary address at the time of submission,
2741 if different from the Address.
2744 \begin_layout Description
2745 Email Author's e-mail address
2748 \begin_layout Description
2749 URL Author's Web address,
2753 \begin_layout Description
2754 Keywords Key words or phrases used to identify specific topics discussed in the paper.
2757 \begin_layout Description
2758 Subjectclass These refer to the AMS Subject Classifications,
2759 published and described in
2761 Mathematical Reviews
2764 These are also available online at the AMS cites listed above.
2767 \begin_layout Description
2771 \begin_layout Description
2775 \begin_layout Description
2779 \begin_layout Standard
2780 The following environments are provided by both the
2789 in the latter case in both unnumbered and numbered versions.
2790 These same environments are provided only in the starred versions by the
2792 Standard Theorems (Unnumbered)
2797 \begin_layout Theorem
2798 This is typically used for the statements of major results.
2802 \begin_layout Corollary*
2803 This is used for statements which follow fairly directly from previous statements.
2805 these can be major results.
2810 These are smaller results needed to prove other statements.
2813 \begin_layout Proposition
2814 These are less major results which (hopefully) add to the general theory being discussed.
2817 \begin_layout Conjecture
2818 These are statements provided without justification,
2819 which the author does not know how to prove,
2820 but which seem to be true (to the author,
2824 \begin_layout Definition*
2825 Guess what this is for.
2826 The font is different for this environment than for the previous ones.
2830 \begin_layout Example*
2831 Used for examples illustrating proven results.
2834 \begin_layout Problem
2835 It's not really known what this is for.
2836 You should figure it out.
2839 \begin_layout Exercise*
2840 Write a description for this one.
2843 \begin_layout Remark
2844 This environment is also a type of theorem,
2845 usually a lesser sort of observation.
2848 \begin_layout Claim*
2849 Often used in the course of giving a proof of a larger result.
2854 these are used to break up long arguments,
2855 using specific instances of some condition.
2860 The numbering scheme for cases is on its own,
2861 not together with other numbered statements.
2866 At the end of this environment,
2867 a QED symbol (usually a square,
2868 but it can vary with different styles) is placed.
2869 If you want to have other environments within this one—
2872 and have the QED symbol appear only after them,
2873 then the other environments need to be nested within the proof environment.
2876 Nesting Environments
2882 for information on nesting.
2886 Used in a way similar to Proposition,
2887 though perhaps lower on the scale.
2890 \begin_layout Standard
2891 And these environments are provided by
2893 AMS Theorems (Extended
2898 \begin_layout Criterion*
2899 A required condition.
2902 \begin_layout Algorithm*
2903 A general procedure to be used.
2906 \begin_layout Axiom*
2907 This is a property or statement taken as true within the system being discussed.
2910 \begin_layout Condition*
2911 Sometimes used to state a condition assumed within the present context of discussion.
2915 Similar to a Remark.
2918 \begin_layout Notation*
2919 Used for the explanation of,
2924 \begin_layout Summary
2925 Do we really need to tell you?
2929 \begin_layout Conclusion*
2930 Sometimes used at the end of a long train of argument.
2933 \begin_layout Assumption*
2937 \begin_layout Question*
2941 \begin_layout Standard
2942 There are ten more Maths modules available including several offering options ordered on
2944 (Numbered by Type \SpecialChar ldots
2950 \begin_layout Standard
2952 the AMS classes automatically provide the AMS \SpecialChar LaTeX
2953 and AMS fonts packages.
2954 They need to be available on your system in order to use these environments.
2957 \begin_layout Subsection
2958 \begin_inset CommandInset label
2960 name "subsec:Extra-font-sizes"
2967 \begin_layout Standard
2968 The “Extra font sizes” collection provides the document classes
2971 \begin_inset space \thinspace{}
2974 (with extra font sizes)
2980 \begin_inset space \thinspace{}
2983 (with extra font sizes)
2989 \begin_inset space \thinspace{}
2992 (with extra font sizes)
2997 \begin_inset space \thinspace{}
3000 (with extra font sizes)
3020 document classes respectively but offer the additional
3026 \begin_inset space ~
3039 ocument\SpecialChar menuseparator
3044 ettings\SpecialChar menuseparator
3050 \begin_layout Subsection
3054 \begin_layout Standard
3055 The document classes
3073 document classes to facilitate the use of Hebrew in \SpecialChar LyX
3077 \begin_layout Subsection
3078 \begin_inset CommandInset label
3080 name "subsec:Japanese"
3084 Japanese (Standard Classes)
3087 \begin_layout Standard
3089 included a collection of several bundles that aim to facilitate typesetting Japanese documents.
3090 The bundles have been developed at different times,
3091 they thus support different typesetting engines and features.
3092 This collection is the oldest one.
3093 It adjusts the \SpecialChar LaTeX
3094 standard classes to requirements of Japanese typesetting,
3095 for horizontal and vertical writing.
3096 The collection includes
3099 \begin_inset space \thinspace{}
3108 \begin_inset space \thinspace{}
3118 \begin_inset space \thinspace{}
3127 \begin_inset space \thinspace{}
3137 \begin_inset space \thinspace{}
3140 (Japanese Standard Class)
3146 \begin_inset space \thinspace{}
3154 \begin_inset Quotes eld
3158 \begin_inset Quotes erd
3161 engines tailored for Japanese,
3163 and up\SpecialChar LaTeX
3167 \begin_layout Standard
3168 For the use with the more modern Lua\SpecialChar LaTeX
3170 the collection also includes dedicated classes
3173 \begin_inset space \thinspace{}
3176 (Standard Class for LuaTeX),
3178 \begin_inset space \thinspace{}
3181 (Standard Class for LuaTeX,
3184 \begin_inset space \thinspace{}
3187 (Standard Class for LuaTeX)
3193 \begin_inset space \thinspace{}
3196 (Standard Class for LuaTeX,
3203 \begin_inset space \thinspace{}
3206 (Japanese Standard Class for LuaTeX)
3212 \begin_inset space \thinspace{}
3215 (Japanese Standard Class for LuaTeX,
3227 \begin_layout Standard
3228 Templates for the Lua\SpecialChar LaTeX
3229 classes can be found in
3231 File\SpecialChar menuseparator
3234 in the respective category (
3251 \begin_layout Subsection
3252 \begin_inset CommandInset label
3254 name "subsec:Japanese-JS"
3258 Japanese (JS Bundle)
3261 \begin_layout Standard
3262 This collection includes improved versions of the classes included in
3264 Japanese (Standard Classes)
3267 \begin_inset space ~
3271 \begin_inset CommandInset ref
3273 reference "subsec:Japanese"
3281 \begin_inset space \thinspace{}
3289 \begin_inset space \thinspace{}
3295 A report class can be obtained by using
3298 \begin_inset space \thinspace{}
3309 Document\SpecialChar menuseparator
3310 Settings\SpecialChar menuseparator
3311 Document Class\SpecialChar menuseparator
3312 Class Options\SpecialChar menuseparator
3316 All these classes work with
3317 \begin_inset Quotes eld
3321 \begin_inset Quotes erd
3324 engines tailored for Japanese,
3326 and up\SpecialChar LaTeX
3330 \begin_layout Standard
3331 For the use with the more modern Lua\SpecialChar LaTeX
3333 the collection also includes dedicated classes
3335 Japanese Article (JS Bundle for LuaTeX),
3337 \begin_inset space \thinspace{}
3340 (JS Bundle for LuaTeX)
3346 \begin_inset space \thinspace{}
3360 \begin_layout Standard
3361 Templates for the Lua\SpecialChar LaTeX
3362 classes can be found in
3364 File\SpecialChar menuseparator
3367 in the respective category (
3384 \begin_layout Subsection
3385 \begin_inset CommandInset label
3387 name "subsec:Japanese-BX"
3391 Japanese (BX Bundle)
3394 \begin_layout Standard
3395 This bundle contains the document classes
3398 \begin_inset space \thinspace{}
3407 \begin_inset space \thinspace{}
3416 \begin_inset space \thinspace{}
3421 which provide alternative document classes for Japanese documents.
3425 Japanese Slides (BX Bundle)
3427 for presentation slides,
3429 As opposed to the classes of the
3439 \begin_inset CommandInset ref
3441 reference "subsec:Japanese"
3446 \begin_inset CommandInset ref
3448 reference "subsec:Japanese-JS"
3453 which support only p\SpecialChar LaTeX
3454 and up\SpecialChar LaTeX
3455 out of the box (and Lua\SpecialChar LaTeX
3456 only through the extra classes added by the
3462 the classes of this bundle also support pdf\SpecialChar LaTeX
3464 Xe\SpecialChar LaTeX
3465 and Lua\SpecialChar LaTeX
3467 with the aid of suitable packages that provide capability of Japanese typesetting.
3470 \begin_layout Subsection
3471 \begin_inset CommandInset label
3473 name "subsec:Japanese-JLReq"
3477 Japanese (JLReq Class)
3480 \begin_layout Standard
3481 This bundle draws on the
3485 class which faithfully traces the standard of
3487 Requirements for Japanese Text Layout
3489 set by the World Wide Web Consortium (W3C,
3491 \begin_inset Flex URL
3494 \begin_layout Plain Layout
3496 https://www.w3.org/TR/jlreq/?lang=en
3502 It can be used with Lua\SpecialChar LaTeX
3503 as well as p\SpecialChar LaTeX
3504 and up\SpecialChar LaTeX
3508 \begin_layout Standard
3509 LyX provides layouts for
3512 \begin_inset space \thinspace{}
3521 \begin_inset space \thinspace{}
3530 \begin_inset space \thinspace{}
3535 which are all derived from the
3540 class via specific class options.
3543 \begin_layout Standard
3544 An example article document is available at
3546 File\SpecialChar menuseparator
3547 Open Example\SpecialChar menuseparator
3548 Articles\SpecialChar menuseparator
3549 Japanese Article (JLReq Class)
3552 English documentation is available at
3553 \begin_inset Flex URL
3556 \begin_layout Plain Layout
3558 http://mirrors.ctan.org/macros/jptex/latex/jlreq/jlreq.pdf
3566 \begin_layout Subsection
3567 \begin_inset CommandInset label
3569 name "subsec:KOMA-Script"
3576 \begin_layout Standard
3586 and the \SpecialChar LyX
3590 \begin_layout Subsubsection
3594 \begin_layout Standard
3595 The KOMA-Script collection of document classes is a development of the Script classes created by Frank Neukam in the early 1990s;
3596 it was formally launched with the addition of a letter class in 1994.
3598 a second letter class has been added.
3599 Frank Neukam's classes were inspired by the principles of typography and this has been fully integrated into the design of the KOMA-Script classes.
3602 \begin_layout Standard
3603 The \SpecialChar LyX
3623 correspond to the \SpecialChar LaTeX
3645 \begin_inset space ~
3648 of the Koma-Script family.
3649 They are replacements for the standard document classes
3669 and fit better to European typography conventions in a number of points.
3672 \begin_layout Itemize
3673 The base character sizes when you select a KOMA-Script class are 11pt in
3694 \begin_layout Itemize
3696 labels of the description environment,
3697 and a number of elements of the
3701 document class are set in a bold sans serif font.
3705 \begin_layout Plain Layout
3706 There is a big difference between the bold sans serif old cm fonts and new ec fonts,
3707 especially in the appearance of headings.
3709 the ec bold sans serif fonts look a bit thin.
3710 Here the \SpecialChar LaTeX
3719 helps to produce the
3720 \begin_inset Quotes eld
3724 \begin_inset Quotes erd
3727 appearance when using the ec fonts.
3732 The numbering of chapter headings is made in the same way as the numbering of section headings,
3733 that is without the extra line
3734 \begin_inset Quotes eld
3737 Chapter\SpecialChar ldots
3739 \begin_inset Quotes erd
3744 the appearance of the headings can be modified by using a number of options (in \SpecialChar LyX
3745 to be entered in the field
3748 \begin_inset space ~
3755 Layout\SpecialChar menuseparator
3762 \begin_layout Itemize
3763 The layout of a KOMA-Script page follows one of two traditional typesetting conventions based on dividing the page into strips or drawing a circle.
3764 The default is to imagine that a page is divided horizontally and vertically into strips and allocate strips to the margins leaving the unused strips for the text area.
3765 You can change the sizes of the margins by changing the factor by which the page is divided into strips;
3766 the default for an A4 page is 9 and increasing this factor will produce increasingly narrower strips and therefore narrower margins.
3770 \begin_layout Standard
3771 Whatever the factor,
3772 two strips are allocated to the outer and bottom margins of a two-sided document and one strip to the inner and top margins,
3773 leaving a text area occupying around half the page.
3774 Since most two-sided documents have a binding,
3775 this can make the inner margins appear too narrow;
3776 so you can apply a binding correction to the page which is deducted before the size of the strips is calculated.
3779 \begin_layout Standard
3780 The main means in the Koma-Script document classes to design the type area are the options
3790 Document\SpecialChar menuseparator
3791 Settings\SpecialChar menuseparator
3792 Document Class\SpecialChar menuseparator
3793 Class Options\SpecialChar menuseparator
3799 \begin_layout Standard
3801 the binding correction is 7.5mm which is added in the form
3808 \begin_inset space ~
3811 options\SpecialChar menuseparator
3819 To change the factor to 11,
3825 to the comma separated list of entries in the
3836 \begin_inset space ~
3842 If you want the default value of this factor for a page size other than A4,
3850 \begin_layout Standard
3851 To use the circle method of calculating the page layout,
3860 \begin_layout Itemize
3861 The \SpecialChar LaTeX
3862 document classes of the Koma-Script family define a number of additional commands.
3863 Those part of it which makes sense in \SpecialChar LyX
3864 is implemented in corresponding paragraph types.
3867 \begin_layout Standard
3868 Detailed descriptions of the \SpecialChar LaTeX
3869 document classes of the Koma-Script family can be found in the Koma-Script documentation
3880 \begin_layout Subsubsection
3883 \begin_inset CommandInset label
3885 name "subsec:article-(KOMA-Script),-report"
3905 \begin_layout Standard
3906 The document classes
3920 are implemented in the layout files
3936 They contain all the paragraph types of the corresponding standard document classes
3953 with the exception of the \SpecialChar LyX
3959 which is replaced by the new
3963 -type having the same functionality.
3968 -Type there is a number of new paragraph types added.
3975 letter (koma-script)
3980 \begin_layout Itemize
4003 additionally inserting an entry in the table of contents.
4012 are not contained in
4014 article (koma-script)
4019 \begin_layout Itemize
4040 additionally clearing running heads.
4047 article (koma-script)
4053 \begin_layout Plain Layout
4066 report (koma-script)
4069 but since this is identical to
4074 is has not been implemented in \SpecialChar LyX
4083 \begin_layout Itemize
4089 generates a heading directly above the following paragraph in the standard character size without affecting the structure of the document.
4092 \begin_layout Itemize
4101 are special captions which respect the different space settings needed for captions placed above or below an element (if you follow strict typographic rules,
4102 you might want to place table captions always above the table).
4103 You can also use the class option
4121 You need at least Koma-Script version 2.8q to use this.
4124 \begin_layout Itemize
4130 can be used to set a bonmot,
4132 \begin_inset space \thinspace{}
4136 \begin_inset space \space{}
4139 at the beginning of a chapter.
4140 If you use the optional argument (
4142 Insert\SpecialChar menuseparator
4144 \begin_inset space ~
4150 you can insert the dictum's author there.
4151 Dictum and author are separated by a line.
4152 You need at least Koma-Script version 2.8q to use this.
4159 article (koma-script)
4164 \begin_layout Standard
4165 The following types,
4166 together with the standard types
4181 form the title area of the document.
4182 They must be entered ahead of the first
4183 \begin_inset Quotes eld
4187 \begin_inset Quotes erd
4194 \begin_layout Plain Layout
4195 The corresponding \SpecialChar LaTeX
4196 commands must appear before the
4207 When such a type is used more than once,
4208 the latter usage overwrites the former one,
4210 for every type only the latest usage is valid.
4211 The order of the different types however has,
4227 no effect on the appearance of the produced document.
4230 \begin_layout Itemize
4236 produces a centered paragraph above the ordinary title (
4250 ) for the subject of the document.
4253 \begin_layout Itemize
4259 produces a centered paragraph below the ordinary title (
4273 ) for the publishers' name.
4276 \begin_layout Itemize
4284 report (koma-script)
4290 produces a centered paragraph on its own page behind the title page,
4293 article (koma-script)
4295 produces a centered paragraph below the ordinary title (
4317 \begin_layout Itemize
4323 produces a left aligned paragraph above the ordinary title (
4342 ) for a document`s head.
4345 \begin_layout Itemize
4351 produces in a double-sided print in
4353 report (koma-script)
4359 a left-aligned paragraph at the top of the title page`s back or has no effect in a single-sided print or in
4361 article (koma-script)
4366 \begin_layout Itemize
4372 produces in a double-sided print in
4374 report (koma-script)
4380 a left-aligned paragraph at the bottom of the title page`s back or has no effect in a single-sided print or in
4382 article (koma-script)
4387 \begin_layout Itemize
4394 \begin_inset Quotes eld
4398 \begin_inset Quotes erd
4401 page ahead of the actual document containing a paragraph without special formatting.
4404 \begin_layout Standard
4405 KOMA-Script offers a wide range of
4412 \begin_inset space ~
4422 ocument\SpecialChar menuseparator
4427 ettings\SpecialChar menuseparator
4429 \begin_inset space ~
4434 dialog which you can apply to the whole document,
4438 \begin_layout Description
4445 which produces a PDF with a small black box at the end any line in which a formatting error occurs;
4446 the default setting is
4451 \begin_layout Description
4458 which may take the values
4472 the first and last adjust the sizes of the headings to take account of page sizes where the default values may not be suitable
4475 \begin_layout Description
4482 which may take the values
4496 the first leaves it up to KOMA-Script to add periods after chapter,
4499 the second forces the addition of periods and third suppresses them
4502 \begin_layout Standard
4503 and the math options:
4506 \begin_layout Description
4513 which causes equations to be numbered on the left rather than on the right,
4517 \begin_layout Description
4524 which causes equations to be left justified rather than centered.
4527 \begin_layout Standard
4528 It also provides commands to affect the output of the document independently of the standard \SpecialChar LaTeX
4529 commands and packages;
4531 if you want your captions in bold add
4534 \begin_layout Standard
4539 setkomafont{captionlabel}{
4544 \begin_layout Standard
4550 ocument\SpecialChar menuseparator
4557 \SpecialChar menuseparator
4562 \begin_inset space ~
4567 ) and the problem is solved.
4570 \begin_layout Standard
4571 If you are writing a book,
4572 it is normal to have the preliminary pages numbered in Roman numerals and the Chapters in this part unnumbered.
4573 If you use the Chapter* environment,
4574 your Foreword and Preface will not appear in the Table of Contents;
4575 to make them to appear in the Table of contents,
4576 you need to use Chapter environments and add the \SpecialChar TeX
4580 \begin_layout Standard
4588 \begin_layout Standard
4589 at the very start of the book (not in the \SpecialChar LaTeX
4593 \begin_layout Standard
4601 \begin_layout Standard
4602 before the first chapter of the body of the text.
4611 \begin_layout Standard
4612 You may also want to have some unnumbered Chapter environments at the end of the book after the Appendices,
4617 \begin_layout Plain Layout
4618 Appendices are normally “numbered” with letters.
4623 If you use the Chapter* environment,
4624 they will not appear in the Table of Contents;
4625 so add the \SpecialChar TeX
4629 \begin_layout Standard
4637 \begin_layout Standard
4638 before the first of these headings and use the Chapter environment.
4639 These commands will have no effect on the numbering in \SpecialChar LyX
4641 only on the PDF output where the headings will be unnumbered and appear in the Table of Contents.
4644 \begin_layout Standard
4645 The layout files for the document classes
4647 article (koma-script)
4652 report (koma-script)
4664 This is thought of as a place to define your own types.
4669 in your personal layout directory and edit the file!
4672 \begin_layout Subsubsection
4673 \begin_inset CommandInset label
4675 name "subsec:The-new-letter"
4679 The new letter class:
4680 KOMA-Script Letter (V.
4684 \begin_layout Standard
4690 \begin_layout Standard
4691 \begin_inset VSpace medskip
4697 \begin_layout Standard
4699 Koma-Script version 2.8 has introduced a new letter class
4703 which supersedes the now unsupported
4709 on the \SpecialChar LaTeX
4711 a completely new interface and is not compatible with the old class.
4715 though it is recommended you use the new class.
4718 \begin_layout Standard
4719 This class covers the same functionality as
4721 letter (koma-script),
4729 (receiver's address,
4749 will start a new letter (i.
4750 \begin_inset space \thinspace{}
4754 \begin_inset space \space{}
4757 you can write several letters per document).
4758 New elements are sender's
4777 and the possibility to use a
4783 Insert\SpecialChar menuseparator
4789 \begin_layout Standard
4790 The biggest improvement is,
4792 that the letter's layout is configurable to meet almost any needs.
4793 This can be done via the preamble or with a special style file (Letter Class Option,
4799 that will be read in as a class option.
4803 \begin_layout Plain Layout
4804 The KOMA package comes with some default
4815 file that follows german typesetting rules,
4820 that provides the default layout of the old
4825 The latter can be loaded with the class option
4832 Layout\SpecialChar menuseparator
4833 Document\SpecialChar menuseparator
4841 Have a look at the template in
4846 ile\SpecialChar menuseparator
4848 \begin_inset space ~
4856 \begin_inset space ~
4859 Template\SpecialChar menuseparator
4860 Letters\SpecialChar menuseparator
4861 KOMA-Script Letter (V.2)
4864 A detailed description is to be found in the Koma-Script documentation (
4871 \begin_layout Subsubsection
4875 \begin_layout Standard
4876 Visualizing the Koma-Script document classes in \SpecialChar LyX
4878 the \SpecialChar LyX
4879 internals cause some problems.
4882 \begin_layout Itemize
4883 The chapter number of a
4887 type appears on a line of its own above the chapter heading instead of appearing in the same line ahead of it.
4888 The cause for that is the \SpecialChar LyX
4889 internal behavior for the labeltype
4896 \begin_layout Itemize
4897 The headings of the types
4906 \begin_inset Quotes eld
4910 \begin_inset Quotes erd
4915 but not in the \SpecialChar LyX
4918 Document\SpecialChar menuseparator
4920 \begin_inset space ~
4924 \begin_inset space ~
4932 \begin_layout Itemize
4937 document class appear in a skip separation mode,
4939 This is the standard behavior,
4940 no special \SpecialChar LaTeX
4941 commands are needed for that.
4944 Document\SpecialChar menuseparator
4947 dialog the corresponding radio button indicates
4956 value always has the effect that extra \SpecialChar LaTeX
4957 commands are inserted in the document to produce the gap,
4958 which is not what is wanted in this case.
4961 \begin_layout Subsection
4962 \begin_inset CommandInset label
4964 name "subsec:Polish-M.W.collection"
4969 \begin_inset space \thinspace{}
4973 \begin_inset space \space{}
4979 \begin_layout Standard
4985 \begin_layout Standard
4986 The \SpecialChar LyX
4989 Polish Article (MW Bundle)
4994 Polish Report (MW Bundle)
4998 Polish Book (MW Bundle)
5000 correspond to the \SpecialChar LaTeX
5016 They are replacements for the standard document classes
5031 and fit better to Polish typography conventions in a number of points.
5035 \begin_layout Standard
5039 \begin_layout Itemize
5040 Unnumbered titles (with star,
5042 \begin_inset space \thinspace{}
5046 \begin_inset space \space{}
5053 ) are added into table of contents,
5056 \begin_layout Itemize
5057 Additional page styles:
5061 \begin_layout Description
5062 uheadings header with separated lines,
5065 \begin_layout Description
5066 myheadings custom header,
5067 contents headers via commands:
5083 \begin_layout Description
5084 myuheadings custom header with separated lines,
5087 \begin_layout Description
5088 outer page number is placed on outer side of page
5092 \begin_layout Itemize
5097 \begin_layout Description
5098 rmheadings serif titles —
5102 \begin_layout Description
5103 sfheadings sansserif titles,
5106 \begin_layout Description
5107 authortitle on title page first placed is author next title —
5111 \begin_layout Description
5112 titleauthor on title page first placed is title next author,
5115 \begin_layout Description
5116 withmarginpar reserve place on page for margins.
5120 \begin_layout Subsection
5124 \begin_layout Standard
5125 The document classes
5142 Detailed information about these document classes can be found in
5144 File\SpecialChar menuseparator
5145 Open Example\SpecialChar menuseparator
5146 Books\SpecialChar menuseparator
5151 File\SpecialChar menuseparator
5152 Open Example\SpecialChar menuseparator
5153 Handouts\SpecialChar menuseparator
5159 \begin_layout Section
5163 \begin_layout Standard
5164 See also the document classes in the Collections (section
5165 \begin_inset space ~
5169 \begin_inset CommandInset ref
5171 reference "sec:Collections"
5179 \begin_layout Subsection
5180 Astronomy & Astrophysics
5183 \begin_layout Standard
5189 updated by the \SpecialChar LyX
5193 \begin_layout Subsubsection
5197 \begin_layout Standard
5198 This section describes how \SpecialChar LyX
5199 can be used to write articles for submission to the scientific journal
5201 Astronomy & Astrophysics
5204 \begin_inset CommandInset href
5207 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
5212 ) using Version 9.1 of the document class
5217 information about it is available at
5218 \begin_inset Flex URL
5221 \begin_layout Plain Layout
5223 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
5231 \begin_layout Standard
5232 A manual comes together with the package and should be consulted before installing this document class as described in the
5234 Installing New Document Classe
5243 \begin_layout Standard
5244 \begin_inset Note Greyedout
5247 \begin_layout Plain Layout
5248 Please note that the publisher of the journal was changed from Springer to EDP Sciences starting January 1,
5250 That change also involved some slight changes to the style files,
5251 namely the removal of the thesaurus command.
5252 If you have an older version installed,
5254 For information about compatibility with the old (version 4) layout,
5255 please refer to the comments in
5258 Dir/layouts/aapaper.layout
5268 \begin_layout Subsubsection
5272 \begin_layout Standard
5273 It is recommended you start from the template in the menu
5278 ile\SpecialChar menuseparator
5280 \begin_inset space ~
5288 \begin_inset space ~
5291 Template\SpecialChar menuseparator
5292 Articles\SpecialChar menuseparator
5293 Astronomy & Astrophysics
5296 If you are not using the template,
5297 note the following settings:
5300 \begin_layout Itemize
5303 Astronomy & Astrophysics
5310 ocument\SpecialChar menuseparator
5315 ettings\SpecialChar menuseparator
5317 \begin_inset space ~
5323 that one was obvious).
5326 \begin_layout Itemize
5330 \begin_inset space ~
5342 \begin_inset space ~
5353 The whole layout is done by the macros,
5354 you shouldn't change anything.
5357 \begin_layout Subsubsection
5361 \begin_layout Standard
5362 First thing to enter is the header information.
5363 It consists of seven entries,
5364 of which one is optional.
5368 \begin_layout Itemize
5377 \begin_layout Itemize
5386 \begin_layout Itemize
5395 \begin_layout Itemize
5404 \begin_layout Itemize
5410 Determines to whom correspondence and reprints are to be sent.
5413 \begin_layout Itemize
5418 [optional] Snail mail address for contacts.
5421 \begin_layout Itemize
5435 \begin_layout Standard
5436 There is no need to issue the
5443 this is done automatically by \SpecialChar LyX
5444 when the header is finished.
5445 Although the order of the single header entries doesn't matter it is advised to keep the above sequence,
5446 just to get the best optics and meets the layout of the real document.
5449 \begin_layout Standard
5450 If you want to place footnotes in the header block,
5452 \begin_inset space \thinspace{}
5456 \begin_inset space \space{}
5459 to state your present address,
5460 just use the standard footnote via the menu
5465 nsert\SpecialChar menuseparator
5474 will automagically use the term
5483 \begin_layout Standard
5486 Edit\SpecialChar menuseparator
5490 you'll find two insets which are relevant for the titling:
5493 \begin_layout Itemize
5500 to mark corresponding author\SpecialChar breakableslash
5502 The institutes are numbered sequentially as they appear in the
5507 so you have to put a marker to each author.
5510 \begin_layout Itemize
5515 to supply an email address for fast contact.
5518 \begin_layout Standard
5519 In addition to these topics,
5520 the macros use one additional \SpecialChar LaTeX
5521 commands that has no counterpart in \SpecialChar LyX
5525 \begin_layout Itemize
5532 to separate different names for more than one author and institute,
5536 \begin_layout Standard
5537 The appropriate command has to be entered as \SpecialChar TeX
5538 code in \SpecialChar LyX
5540 See the examples in the template and in
5542 File\SpecialChar menuseparator
5543 Open Example\SpecialChar menuseparator
5544 Articles\SpecialChar menuseparator
5545 Astronomy & Astrophysics
5550 \begin_layout Subsubsection
5554 \begin_layout Standard
5555 The abstract should immediately follow the header block.
5556 With version 5 the abstract environment was changed to a command,
5557 and there is now a restriction to only one paragraph.
5559 it should contain an entry with the keywords.
5560 This is done via the paragraph style
5565 Refer to the example paper.
5568 \begin_layout Subsubsection
5569 Supported environments
5572 \begin_layout Standard
5573 The A&A paper layout supports the following environments for structuring your text:
5576 \begin_layout Standard
5579 \begin_inset Flex Multiple Columns
5582 \begin_layout Itemize
5588 \begin_layout Itemize
5594 \begin_layout Itemize
5600 \begin_layout Itemize
5606 \begin_layout Itemize
5612 \begin_layout Itemize
5618 \begin_layout Itemize
5624 \begin_layout Itemize
5630 \begin_layout Itemize
5636 \begin_layout Itemize
5642 \begin_layout Itemize
5648 \begin_layout Itemize
5657 \begin_layout Subsubsection
5658 Commands not supported by \SpecialChar LyX
5662 \begin_layout Standard
5663 Some commands are not yet supported by the
5665 Astronomy & Astrophysics
5667 layout for \SpecialChar LyX
5669 Some have already been mentioned.
5670 For the sake of completeness,
5671 they are listed all together here:
5674 \begin_layout Itemize
5682 \begin_layout Itemize
5690 \begin_layout Itemize
5698 \begin_layout Itemize
5706 \begin_layout Standard
5707 If you want to use any of these commands,
5708 you have to enter them yourself.
5709 Do not forget to use
5715 nsert\SpecialChar menuseparator
5718 \begin_inset space ~
5726 \begin_layout Subsubsection
5727 Figure and Table Floats
5730 \begin_layout Standard
5732 provides support for the necessary float environments
5743 therefore we won't tell much about it here.
5747 \begin_inset space ~
5753 Just remember that tables should be left-aligned.
5755 select the table and change the alignment in
5760 dit\SpecialChar menuseparator
5766 \begin_inset space ~
5774 arg "layout-paragraph"
5782 \begin_layout Standard
5783 There is only one special thing:
5784 the figures with a caption beside the figure.
5785 To create such a figure,
5786 you have to do the following:
5789 \begin_layout Enumerate
5790 Create a wide figure float:
5796 nsert\SpecialChar menuseparator
5801 t\SpecialChar menuseparator
5806 from within the float,
5812 dit\SpecialChar menuseparator
5818 \begin_inset space ~
5829 \begin_inset space ~
5841 \begin_layout Enumerate
5842 Enter your caption text.
5845 \begin_layout Enumerate
5850 to move the cursor above the caption.
5853 \begin_layout Enumerate
5857 \begin_layout Enumerate
5858 Position the cursor after the figure and insert a horizontal fill by using the menu:
5864 nsert\SpecialChar menuseparator
5869 rmatting\SpecialChar menuseparator
5875 \begin_inset space ~
5884 dialog and select the
5898 \begin_layout Enumerate
5899 Switch to \SpecialChar LaTeX
5904 \begin_inset space ~
5912 \begin_layout Enumerate
5921 Do not close the brace!
5924 \begin_layout Enumerate
5925 Position the cursor behind the caption text,
5926 switch to \SpecialChar LaTeX
5927 mode and insert the closing brace:
5931 \begin_inset space ~
5943 \begin_layout Standard
5945 refer to the figures in the file in
5947 File\SpecialChar menuseparator
5948 Open Example\SpecialChar menuseparator
5949 Articles\SpecialChar menuseparator
5950 Astronomy & Astrophysics
5955 \begin_layout Subsubsection
5959 \begin_layout Standard
5961 the paper has to be formatted in a special double-spacing layout.
5963 you have to add the option
5974 \begin_inset space ~
5984 ocument\SpecialChar menuseparator
5989 ettings\SpecialChar menuseparator
5991 \begin_inset space ~
5999 \begin_layout Subsubsection
6003 \begin_layout Standard
6006 File\SpecialChar menuseparator
6007 Open Example\SpecialChar menuseparator
6008 Articles\SpecialChar menuseparator
6009 Astronomy & Astrophysics
6011 was written with \SpecialChar LyX
6013 It is the example paper from the original macro package,
6019 \begin_inset CommandInset href
6022 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
6028 but translated to \SpecialChar LyX
6029 using the older unstructured abstract type.
6030 Use it for inspiration,
6031 and compare the \SpecialChar LaTeX
6036 with the \SpecialChar LyX
6040 \begin_layout Subsection
6045 \begin_layout Standard
6051 \begin_layout Subsubsection
6055 \begin_layout Standard
6057 is a set of macros produced by the American Astronomical Society to facilitate electronic manuscript submission to the three journals they publish:
6058 the Astrophysical Journal (including the Letters and Supplement),
6059 the Astronomical Journal,
6060 and the Publications of the Astronomical Society of the Pacific.
6062 has proven to be an excellent tool for generating these documents,
6063 especially given its equation,
6065 and figure handling capabilities.
6067 requires version 5.0 (or higher) of these macros;
6069 which is the version described here,
6071 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
6072 2.09 and are fundamentally incompatible with \SpecialChar LyX
6074 The AAS\SpecialChar TeX
6075 package may be downloaded from the AAS\SpecialChar TeX
6079 \begin_layout Standard
6080 \begin_inset VSpace medskip
6086 \begin_layout Standard
6088 \begin_inset Flex URL
6091 \begin_layout Plain Layout
6093 https://aas.org/aastex/aastex-downloads
6101 \begin_layout Standard
6102 \begin_inset VSpace medskip
6108 \begin_layout Standard
6109 A complete user guide is contained in that package and you should familiarize yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
6112 will not reduce the need to figure out all the AAS\SpecialChar TeX
6114 it will only reduce the drudgery of typing everything in.
6115 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
6116 document conforms completely to the requirements of the journal to which you are submitting your paper.
6119 \begin_layout Subsubsection
6120 Starting a New Paper
6123 \begin_layout Standard
6124 I strongly suggest that you start with the AAS\SpecialChar TeX
6128 File\SpecialChar menuseparator
6133 Template\SpecialChar menuseparator
6134 Articles\SpecialChar menuseparator
6135 American Astronomical Society
6138 This will show the most common fields found in a manuscript.
6139 Simply overwrite the existing text (including the brackets,
6144 ) with the correct information.
6145 Many of the AAS\SpecialChar TeX
6146 commands and environments can be implemented directly in \SpecialChar LyX
6149 For commands such as these,
6150 the \SpecialChar LaTeX
6151 code must be entered directly and marked as such.
6152 Such commands are referred to as \SpecialChar TeX
6155 I tried to minimize the amount of \SpecialChar TeX
6156 code needed in an AAS\SpecialChar TeX
6160 \begin_layout Subsubsection
6161 Finishing Your Paper
6164 \begin_layout Standard
6165 When the paper is finished to your satisfaction and previews/prints correctly,
6167 \begin_inset Quotes eld
6171 \begin_inset Quotes erd
6174 actions which need to be done before you submit it to the journals.
6178 \begin_layout Enumerate
6179 Export your paper as a \SpecialChar LaTeX
6182 File\SpecialChar menuseparator
6183 Export\SpecialChar menuseparator
6191 \begin_layout Enumerate
6196 file with your favorite text editor
6200 \begin_layout Enumerate
6201 remove the comment lines before the
6210 \begin_layout Enumerate
6215 usepackage...{fontenc}
6217 line if it appears (usually just after
6233 \begin_layout Enumerate
6234 remove everything between (and including) the
6247 except for any commands you specifically put into the \SpecialChar LaTeX
6248 preamble (which should appear immediately after the
6249 \begin_inset Quotes eld
6252 User specified \SpecialChar LaTeX
6254 \begin_inset Quotes erd
6265 \begin_layout Enumerate
6266 Run the resulting file through \SpecialChar LaTeX
6267 to make sure it still processes correctly.
6270 \begin_layout Enumerate
6271 Reread the journal requirements to make sure your filenames and formats are correct.
6274 \begin_layout Enumerate
6278 \begin_layout Subsubsection
6279 Comments On Specific Commands
6282 \begin_layout Standard
6283 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
6285 the AAS\SpecialChar TeX
6290 ) gives a good description of each.
6291 Thus it's probably easiest for me to go down the list as found in the guide and offer comments where necessary.
6292 So let's begin \SpecialChar ldots
6296 \begin_layout Paragraph
6297 Things that work as expected
6300 \begin_layout Standard
6301 Because they work as you might expect,
6302 I simply list them and the section they are found in:
6419 begin{thebibliography}
6429 all the cite commands and their variations (2.13.2),
6430 the generic graphicx figure commands (2.14.1),
6459 amongst other places),
6490 \begin_layout Standard
6491 The following style options also work correctly:
6517 Simply put them in the
6523 Layout\SpecialChar menuseparator
6529 \begin_layout Paragraph
6531 but require more comment
6534 \begin_layout Standard
6535 The following items work,
6536 but require a little more discussion:
6539 \begin_layout Itemize
6540 These items are reserved for use by the journal editors,
6541 but you can put them into the \SpecialChar LaTeX
6542 preamble if you feel compelled to do so:
6580 \begin_layout Itemize
6581 These items may be placed in the \SpecialChar LaTeX
6583 and are included as blanks in the template file:
6607 \begin_layout Itemize
6614 (2.3) – can only be used
6615 \begin_inset Quotes eld
6619 \begin_inset Quotes erd
6623 not in the middle of a paragraph.
6624 Use \SpecialChar TeX
6625 code if you need to embed it.
6628 \begin_layout Itemize
6635 (2.3) – will have extra {} after it.
6636 This should not cause an error.
6639 \begin_layout Itemize
6646 (2.6) – can only be used
6647 \begin_inset Quotes eld
6651 \begin_inset Quotes erd
6655 not in the middle of a paragraph.
6656 Use \SpecialChar TeX
6657 code if you need to embed it.
6660 \begin_layout Itemize
6667 (2.8) – can't insert a cross-reference tag,
6668 you must type the tag name by hand
6671 \begin_layout Itemize
6685 \begin_layout Itemize
6692 (2.9) – will have extra {} after it.
6693 This should not cause an error.
6696 \begin_layout Itemize
6703 (2.11) – will have extra {} after it.
6704 This should not cause an error.
6707 \begin_layout Itemize
6714 (2.14.2) – you can insert an optional filename argument by placing the cursor at the beginning of the text and selecting
6716 Insert\SpecialChar menuseparator
6721 \begin_inset Quotes eld
6725 \begin_inset Quotes erd
6728 inserts an optional argument of the type needed by
6735 Hopefully it will be renamed someday.
6738 \begin_layout Itemize
6751 for the catalog ID optional parameter
6754 \begin_layout Itemize
6767 for the catalog ID optional parameter
6770 \begin_layout Paragraph
6771 Things not implemented,
6772 use \SpecialChar TeX
6776 \begin_layout Standard
6788 setcounter{equation}
6791 Journal name abbreviations (2.13.4),
6834 insert it as the first element in the lefthand cell after where you want it.
6835 Don't use any of \SpecialChar LyX
6836 's rules in the table),
6911 \begin_layout Paragraph
6912 Things that cannot be implemented
6915 \begin_layout Standard
6917 at least in any meaningful sort of way,
6918 so I suggest ignoring them.
6919 They are the references environment (2.13.3),
6920 and the deluxetable environment (2.15).
6922 really need to use deluxetable,
6923 I suggest editing it in a separate file with a text editor,
6926 Insert\SpecialChar menuseparator
6928 \begin_inset space ~
6933 to include it in your \SpecialChar LyX
6937 File\SpecialChar menuseparator
6938 Open Example\SpecialChar menuseparator
6939 Articles\SpecialChar menuseparator
6940 American Astronomical Society
6942 for an example of this.
6945 \begin_layout Subsubsection
6949 and Other Ruminations
6952 \begin_layout Paragraph
6953 Getting \SpecialChar LyX
6954 and AAS\SpecialChar TeX
6958 \begin_layout Standard
6959 It can be a bit tricky to get \SpecialChar LyX
6960 to recognize a new layout and document class.
6961 When all else fails,
6965 \begin_layout Enumerate
6966 Make certain that \SpecialChar LaTeX
6967 can find AAS\SpecialChar TeX
6969 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
6970 distribution into a directory completely unrelated to \SpecialChar LaTeX
6971 or AAS\SpecialChar TeX
6972 and run \SpecialChar LaTeX
6980 \begin_layout Enumerate
6985 appears in \SpecialChar LyX
6993 \begin_layout Enumerate
6996 Tools\SpecialChar menuseparator
7001 then restart \SpecialChar LyX
7005 \begin_layout Enumerate
7006 Open a regular new file,
7007 not from a template.
7010 American Astronomical Society (AASTeX V.
7011 \begin_inset space \thinspace{}
7016 appear in the class list in
7018 Document\SpecialChar menuseparator
7024 \begin_layout Standard
7025 If you get a warning from an existing AAS\SpecialChar TeX
7026 document about not being able to find the AAS\SpecialChar TeX
7027 layout or a message about
7028 \begin_inset Quotes eld
7031 You should not mix title layouts with normal ones
7032 \begin_inset Quotes erd
7036 things haven't been installed correctly.
7039 \begin_layout Paragraph
7041 error processing a table
7044 \begin_layout Standard
7048 attempts to center the table caption/title.
7049 This seems to produce a bad interaction in AAS\SpecialChar TeX
7050 so you should click somewhere in the caption/title,
7053 Edit\SpecialChar menuseparator
7055 \begin_inset space ~
7070 This took care of it for me.
7073 \begin_layout Paragraph
7077 \begin_layout Standard
7082 \begin_layout Enumerate
7083 I have noticed some funny spacing in the reference entries in the text.
7084 When you enter the bibliography item data,
7089 space between the last author and the parenthesis setting off the year;
7093 \begin_inset space \thinspace{}
7097 \begin_inset space \space{}
7115 \begin_layout Enumerate
7116 Entering the references at all is not obvious.
7117 The easiest thing is to start typing your first reference at the end of the document,
7118 then mark it as type
7123 That will put a small gray box in front of what you just typed.
7124 Click on the box to fill in the rest of the information.
7126 go to the end of an existing reference and press return.
7127 That will create a new line with its own box,
7131 \begin_layout Paragraph
7135 \begin_layout Standard
7136 Even though AAS\SpecialChar TeX
7137 provides its own figure commands (
7145 I much prefer \SpecialChar LaTeX
7146 's standard figure commands (with the default graphicx).
7155 \begin_inset space ~
7158 commands as \SpecialChar TeX
7159 code into a Figure Float box if you desire,
7160 but I never have much luck getting the layout right.
7161 With the standard graphics,
7167 usepackage{graphicx}
7169 command into the \SpecialChar LaTeX
7170 preamble and handle the figures in the standard \SpecialChar LaTeX2e
7172 interspersing the figures in the text.
7173 I believe ApJ accepts figures exactly this way now;
7174 AJ might still use the
7175 \begin_inset Quotes eld
7178 stack everything at the end
7179 \begin_inset Quotes erd
7185 \begin_layout Paragraph
7186 Things I could have done,
7190 \begin_layout Standard
7192 \begin_inset Quotes eld
7196 \begin_inset Quotes erd
7199 things I could have implemented,
7202 I saw no point in double-spacing the text in the \SpecialChar LyX
7204 even though it is double-spaced in the paper manuscript.
7206 I chose not to make separate layouts for the preprint and preprint2 styles.
7207 Since I assume you will spend most of your time in the plain manuscript mode anyway,
7208 I decided not to chew up more disk space with this.
7212 \begin_layout Subsubsection
7216 \begin_layout Standard
7217 Your mileage may vary.
7218 I've now had papers published by both ApJ and AJ that have had 98% of the effort done in \SpecialChar LyX
7220 the last 2% was the \SpecialChar LaTeX
7221 post-processing and a few cleanups.
7222 I have had no trouble with the submission process,
7223 and I'm sure the journals were never aware that there might be a difference.
7225 go forth and publish!
7228 \begin_layout Subsection
7232 \begin_layout Standard
7237 uses the standard article document class together with the package
7241 to facilitate the description of chess games.
7244 File\SpecialChar menuseparator
7245 Open Example\SpecialChar menuseparator
7246 Articles\SpecialChar menuseparator
7260 \begin_layout Subsection
7264 \begin_layout Standard
7269 provides support for the
7274 class for journals in the Elsevier publishing house.
7275 This provides the following additional environments:
7279 \begin_inset space ~
7288 \begin_inset space ~
7297 \begin_inset space ~
7319 \begin_layout Standard
7320 A template is available in the menu
7325 ile\SpecialChar menuseparator
7327 \begin_inset space ~
7335 \begin_inset space ~
7338 Template\SpecialChar menuseparator
7339 Articles\SpecialChar menuseparator
7343 It has been customized with further environments and contains all the information you may need.
7345 the documentation is also available from
7346 \begin_inset CommandInset href
7349 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
7357 \begin_layout Subsection
7361 \begin_layout Standard
7364 Paper (Standard Class)
7366 provides an alternative to the
7368 Article (Standard Class)
7371 It provides similar functionality,
7372 but you might prefer this layout with sans serif sections,
7377 \begin_layout Subsection
7382 \begin_layout Standard
7388 \begin_layout Standard
7389 \begin_inset VSpace bigskip
7395 \begin_layout Standard
7400 \begin_inset space \thinspace{}
7405 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
7407 \begin_inset Formula $\beta$
7414 \begin_layout Standard
7421 which works with Rev\SpecialChar TeX
7424 v3.1 is basically obsolete,
7425 as it works with \SpecialChar LaTeX
7427 That means that it doesn't interact very well with \SpecialChar LyX
7429 which requires \SpecialChar LaTeX2e
7431 although it has been kludged to work.
7432 Since Rev\SpecialChar TeX
7433 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
7439 \begin_inset space ~
7443 \begin_inset space \thinspace{}
7448 textclass should also be pretty easy to use.
7451 \begin_layout Standard
7452 These documents are supposed to be used in
7456 to the Rev\SpecialChar TeX
7458 so we don't describe any of the special Rev\SpecialChar TeX
7460 and assume you'll know what to put in the preamble if necessary.
7463 \begin_layout Subsubsection
7467 \begin_layout Standard
7468 All you need to do is install Rev\SpecialChar TeX
7470 as described in the package's README file.
7471 The package can be found at The Rev\SpecialChar TeX
7473 \begin_inset Flex URL
7476 \begin_layout Plain Layout
7478 http://publish.aps.org/revtex4/
7484 Install it somewhere that \SpecialChar LaTeX
7486 Test it by trying to \SpecialChar LaTeX
7487 a short Rev\SpecialChar TeX
7488 4 document in some random directory (i.
7489 \begin_inset space \thinspace{}
7493 \begin_inset space \space{}
7496 not the directory where you installed the class file.) Then,
7497 if you reconfigure \SpecialChar LyX
7499 it will find the class file and let you use the Rev\SpecialChar TeX
7503 \begin_layout Standard
7504 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
7513 \begin_inset space ~
7521 File\SpecialChar menuseparator
7522 New From Templates\SpecialChar menuseparator
7528 \begin_layout Subsubsection
7532 \begin_layout Standard
7533 Optional arguments to
7541 \begin_inset Quotes eld
7545 \begin_inset Quotes erd
7549 \begin_inset Quotes eld
7553 \begin_inset Quotes erd
7560 \begin_inset space ~
7568 \begin_inset space ~
7575 Remember that in Rev\SpecialChar TeX
7577 at least one optional argument is required!
7581 \begin_layout Standard
7582 Other preamble matter,
7590 \begin_inset space ~
7597 \begin_inset space ~
7606 \begin_layout Subsubsection
7610 \begin_layout Standard
7611 The layouts basically correspond to the commands in Rev\SpecialChar TeX
7614 the Email layout corresponds to
7621 Note that (at least as of Rev\SpecialChar TeX
7631 layouts are exactly equivalent,
7632 so you shouldn't need to use both.
7636 \begin_layout Plain Layout
7637 In case you're curious,
7638 both were included so that
7642 would be able to translate both
7662 \begin_layout Subsubsection
7666 \begin_layout Standard
7667 There are a couple of important unique aspects of Rev\SpecialChar TeX
7668 4 which might cause bugs that will be even more confusing in \SpecialChar LyX
7672 \begin_layout Standard
7673 In Rev\SpecialChar TeX
7692 The \SpecialChar LyX
7693 equivalent is that there is a separate Thanks layout.
7698 write footnotes in the
7703 or weird things may happen.
7704 See the Rev\SpecialChar TeX
7705 4 documentation for more details.
7708 \begin_layout Standard
7713 \begin_inset space ~
7722 \begin_inset space ~
7732 layouts must be placed
7740 layout and the corresponding
7758 the \SpecialChar LaTeX
7762 \begin_layout Subsection
7766 \begin_layout Standard
7771 classes were replaced with a completely new class,
7777 Please find information at
7778 \begin_inset Flex URL
7781 \begin_layout Plain Layout
7783 https://www.springernature.com/gp/authors/campaigns/latex-author-support
7789 Native \SpecialChar LyX
7790 support is not available yet.
7793 \begin_layout Section
7797 \begin_layout Standard
7798 See also the document classes in the Collections (section
7799 \begin_inset space ~
7803 \begin_inset CommandInset ref
7805 reference "sec:Collections"
7813 \begin_layout Subsection
7817 \begin_layout Standard
7823 \begin_layout Subsubsection
7827 \begin_layout Standard
7828 Memoir is a very powerful and constantly evolving class.
7829 It has been designed with regard to fictional and non-fictional literature.
7830 Its aim is to let the user have maximum control over the typesetting of his document.
7831 Memoir is based on the standard book class,
7832 but it can also emulate the article class (see below).
7835 \begin_layout Standard
7837 the developer of Memoir,
7838 is known as the author of lots of useful packages in the \SpecialChar LaTeX
7840 Most of them have been merged with Memoir.
7842 it is much easier to layout the table of contents,
7844 chapter designs and such.
7848 does not support all of these goodies natively.
7849 Some of them might be added to forthcoming releases
7853 \begin_layout Plain Layout
7854 You are invited to send suggestions to
7855 \begin_inset Flex URL
7858 \begin_layout Plain Layout
7860 lyx-devel@lists.lyx.org
7871 lots will probably never be supported,
7872 due to the limitations of \SpecialChar LyX
7874 Of course you can still use all features with the help of some native \SpecialChar LaTeX
7875 commands (\SpecialChar TeX
7880 \begin_layout Plain Layout
7885 \begin_layout Plain Layout
7895 \begin_inset space ~
7899 \begin_inset CommandInset ref
7901 reference "sec:Inserting-TeX-Code"
7913 we can only list those features that are natively supported by \SpecialChar LyX
7915 For detailed descriptions (and for the rest of features) we recommend you have a look at the detailed manual of the Memoir class
7919 \begin_layout Plain Layout
7924 \begin_layout Plain Layout
7934 \begin_inset Flex URL
7937 \begin_layout Plain Layout
7939 CTAN:/macros/latex/memoir/memman.pdf
7950 which is not only a user guide for the class,
7951 but also both a comprehensive description on good typesetting and a superb example for good typesetting itself.
7954 \begin_layout Subsubsection
7955 Basic features and restrictions
7958 \begin_layout Standard
7959 Memoir supports basically all features of the standard book classes.
7966 \begin_layout Description
7968 \begin_inset space ~
7972 Memoir has a broader range of font sizes:
7981 \begin_layout Description
7983 \begin_inset space ~
7987 The fancy page style is not supported,
7988 due to a command clash between Memoir and the fancyhdr package (they both define a command with the same name,
7989 which confuses \SpecialChar LaTeX
7992 Memoir comes with a number of its own page styles (see
7994 Document\SpecialChar menuseparator
7995 Settings\SpecialChar menuseparator
7997 \begin_inset space ~
8003 If you want to use these for the chapter pages,
8004 you have to use the command
8010 in the main text or in preamble (e.
8011 \begin_inset space \thinspace{}
8015 \begin_inset space \space{}
8022 chapterstyle{companion}
8027 \begin_layout Description
8029 Sectionings (chapter,
8031 subsection etc.) come with an optional argument in the standard classes.
8033 you can specify an alternative version of the title for the table of contents and the headers (for instance,
8034 if the title is too long).
8039 Insert\SpecialChar menuseparator
8041 \begin_inset space ~
8046 at the beginning of a chapter/section.
8047 Memoir features a second optional argument and thus separates the table of contents from the header.
8048 You can define three variants of a title with this:
8049 one for the main text,
8050 one for the table of contents,
8051 and one for the headers.
8053 makes these available in form of specific
8064 \begin_layout Description
8066 In the standard classes (and in many other classes),
8067 the table of contents,
8068 the list of figures and the list of table start a new page automatically.
8069 Memoir does not follow this route.
8070 You have to insert a page break yourself,
8071 if you want to have one.
8074 \begin_layout Description
8076 For some unknown reason,
8077 Memoir uses pagination on the title page (in the standard classes,
8079 \begin_inset Quotes eld
8083 \begin_inset Quotes erd
8087 If you want an empty title page,
8092 aliaspagestyle{title}{empty}
8097 \begin_layout Description
8099 With the class option
8105 Document\SpecialChar menuseparator
8106 Settings\SpecialChar menuseparator
8107 Class Settings\SpecialChar menuseparator
8109 \begin_inset space ~
8115 you can emulate article style.
8117 counters (footnotes,
8119 tables etc.) will not be reset on new chapters,
8120 chapters don't start a new page (but are—
8122 \begin_inset Quotes eld
8126 \begin_inset Quotes erd
8137 \begin_layout Description
8140 Memoir does not allow the use of the deprecated font commands,
8141 which have been used in the old \SpecialChar LaTeX
8143 \begin_inset space \thinspace{}
8147 \begin_inset space \space{}
8164 It produces an error and stops \SpecialChar LaTeX
8165 whenever such a command appears.
8170 reallows the commands and spits out warnings instead (which does at least not stop \SpecialChar LaTeX
8172 Since a lot of packages and particularly Bib\SpecialChar TeX
8173 style files are still using those commands,
8174 we have decided to use this option by default.
8177 \begin_layout Subsubsection
8181 \begin_layout Standard
8182 We will only describe the features supported by \SpecialChar LyX
8183 (which is not much currently).
8184 Please consult the Memoir manual
8188 \begin_layout Plain Layout
8193 \begin_layout Plain Layout
8203 \begin_inset Flex URL
8206 \begin_layout Plain Layout
8208 CTAN:/macros/latex/memoir/memman.pdf
8221 \begin_layout Description
8223 You may wonder why an abstract is an extra feature.
8225 it is in book class.
8226 Usually books don't have abstracts.
8230 You can use it wherever and how often you like.
8233 \begin_layout Description
8235 You may know this older typesetting style:
8236 The contents of a chapter are summarized below the title and also in the table of contents (e.
8237 \begin_inset space \thinspace{}
8241 \begin_inset space \space{}
8246 Our hero arrives in Troia;
8247 he loses some friends;
8251 Chapterprecis does exactly this.
8252 It is therefore only sensible below a chapter.
8255 \begin_layout Description
8257 An epigraph is a smart slogan or motto at the beginning of a chapter.
8258 The epigraph environment provides an elegant way of typesetting such a motto.
8259 The motto itself (text) and its (optional) author (source) are divided by a short line.
8260 The author (source) can be inserted via
8262 Insert\SpecialChar menuseparator
8269 \begin_layout Description
8271 Memoir has lots of possibilities to typeset poetry (up to very complex figurative poems).
8273 can only support a few of them.
8275 which is a centered title for poems,
8276 which will also be added to the table of contents (verse is the standard environment for poems.
8277 Memoir has some enhanced versions of verse,
8278 but you need to use \SpecialChar TeX
8280 because they have to be nested inside regular verse environments,
8281 which is not possible with \SpecialChar LyX
8285 \begin_layout Description
8288 but it adds no entry to the table of contents.
8291 \begin_layout Subsection
8295 \begin_layout Standard
8304 document class but adds two environments:
8307 \begin_layout Description
8308 Recipe a numbered section environment at the
8312 level which generates a bold centered heading above a double horizontal rule
8315 \begin_layout Description
8326 are what are being described and the environment ends with a horizontal rule.
8329 \begin_layout Standard
8332 File\SpecialChar menuseparator
8333 Open Example\SpecialChar menuseparator
8334 Books\SpecialChar menuseparator
8337 illustrates its use.
8340 \begin_layout Standard
8341 The class is designed for typesetting one or two recipes per page.
8342 The hyperlinked table of contents (ToC) and page numbers make browsing recipes convenient.
8346 \begin_layout Section
8350 \begin_layout Subsection
8354 \begin_layout Standard
8364 an unofficial implementation of the ‘Europass CV’ recommended by the European Commission in 2013.
8367 File\SpecialChar menuseparator
8368 Open Example\SpecialChar menuseparator
8369 Curricula Vitae\SpecialChar menuseparator
8372 offers guidance on its use.
8373 Its documentation is available from
8374 \begin_inset CommandInset href
8377 target "http://mirrors.ctan.org/macros/latex/contrib/europasscv/europasscv.pdf"
8385 \begin_layout Subsection
8389 \begin_layout Standard
8399 an unofficial implementation of the “Europass CV” recommended by the European Commission in 2002.
8402 File\SpecialChar menuseparator
8403 Open Example\SpecialChar menuseparator
8404 Curricula Vitae\SpecialChar menuseparator
8407 offers guidance on its use.
8408 Its documentation is available from
8409 \begin_inset CommandInset href
8412 target "http://mirrors.ctan.org/macros/latex/contrib/europecv/europecv.pdf"
8420 \begin_layout Subsection
8424 \begin_layout Standard
8434 This allows the creation of customizable CVs.
8437 File\SpecialChar menuseparator
8438 Open Example\SpecialChar menuseparator
8439 Curricula Vitae\SpecialChar menuseparator
8442 offers guidance on its use.
8443 Its documentation is available from
8444 \begin_inset CommandInset href
8447 target "http://mirrors.ctan.org/macros/latex/contrib/moderncv/manual/moderncv_userguide.pdf"
8455 \begin_layout Subsection
8459 \begin_layout Standard
8469 originally developed for use with \SpecialChar LyX
8473 File\SpecialChar menuseparator
8474 Open Example\SpecialChar menuseparator
8475 Curricula Vitae\SpecialChar menuseparator
8478 offers guidance on its use.
8479 Its documentation is available from
8480 \begin_inset CommandInset href
8483 target "http://mirrors.ctan.org/macros/latex/contrib/simplecv/simplecv.pdf"
8491 \begin_layout Section
8495 \begin_layout Standard
8498 KOMA-Script Letter (V.
8502 \begin_inset space ~
8506 \begin_inset CommandInset ref
8508 reference "subsec:The-new-letter"
8515 Letter (Standard Class with Extra Font Sizes)
8518 \begin_inset space ~
8522 \begin_inset CommandInset ref
8524 reference "subsec:Extra-font-sizes"
8529 ) document classes .
8532 \begin_layout Subsection
8536 \begin_layout Standard
8541 provides support for the
8546 class for writing letters according to the standards of the German Standards Institute (
8548 Deutsches Institut für Normung,
8552 The file in the menu
8557 ile\SpecialChar menuseparator
8559 \begin_inset space ~
8567 \begin_inset space ~
8570 Template\SpecialChar menuseparator
8571 Letters\SpecialChar menuseparator
8574 offers guidance on its use.
8575 The documentation is available from
8576 \begin_inset CommandInset href
8579 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
8587 \begin_layout Subsection
8589 \begin_inset space \space{}
8595 \begin_layout Standard
8599 \begin_inset space \space{}
8604 provides support for the
8609 class for writing letters according to French conventions.
8610 The file in the menu
8615 ile\SpecialChar menuseparator
8617 \begin_inset space ~
8625 \begin_inset space ~
8628 Template\SpecialChar menuseparator
8629 Letters\SpecialChar menuseparator
8631 \begin_inset space \space{}
8636 offers guidance on its use.
8639 \begin_layout Subsection
8641 \begin_inset space \space{}
8647 \begin_layout Standard
8651 \begin_inset space \space{}
8656 provides support for
8661 another \SpecialChar LaTeX
8662 class for writing letters,
8663 but also faxes and envelopes,
8665 The file in the menu
8670 ile\SpecialChar menuseparator
8672 \begin_inset space ~
8680 \begin_inset space ~
8683 Template\SpecialChar menuseparator
8684 Letters\SpecialChar menuseparator
8686 \begin_inset space \space{}
8691 offers guidance on its use.
8692 The documentation is available from
8693 \begin_inset CommandInset href
8696 target "http://mirrors.ctan.org/macros/latex/contrib/lettre/lettre.pdf"
8704 \begin_layout Subsection
8706 \begin_inset space \thinspace{}
8712 \begin_layout Standard
8716 \begin_inset space \thinspace{}
8721 provides support for the
8726 class for writing letters in German.
8727 The file in the menu
8732 ile\SpecialChar menuseparator
8734 \begin_inset space ~
8742 \begin_inset space ~
8745 Template\SpecialChar menuseparator
8746 Letters\SpecialChar menuseparator
8748 \begin_inset space \thinspace{}
8753 offers guidance on its use.
8754 The documentation is available from
8755 \begin_inset CommandInset href
8758 target "http://mirrors.ctan.org/macros/latex/contrib/g-brief/g-brief.pdf"
8766 \begin_layout Section
8770 \begin_layout Subsection
8774 \begin_layout Standard
8784 class for creating presentations.
8785 The file in the menu
8790 ile\SpecialChar menuseparator
8792 \begin_inset space ~
8800 \begin_inset space ~
8803 Template\SpecialChar menuseparator
8804 Presentations\SpecialChar menuseparator
8809 Help\SpecialChar menuseparator
8810 Specific Manuals\SpecialChar menuseparator
8811 Beamer Presentations
8813 offers guidance on its use.
8814 The documentation is available from
8815 \begin_inset CommandInset href
8818 target "http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf"
8826 \begin_layout Subsection
8829 Foil\SpecialChar TeX
8833 \begin_inset CommandInset label
8842 \begin_layout Standard
8848 updated by the \SpecialChar LyX
8852 \begin_layout Subsubsection
8856 \begin_layout Standard
8859 Foil\SpecialChar TeX
8866 document class to make slides for overhead projectors.
8867 There are two document classes that can do this:
8872 document class (section
8873 \begin_inset space ~
8877 \begin_inset CommandInset ref
8879 reference "sec:slitex"
8889 Foil\SpecialChar TeX
8893 As of 2023 the former has continued to be maintained whereas
8895 Foil\SpecialChar TeX
8898 has not been maintained since 2008.
8899 This section documents the latter.
8900 If your machine doesn’t have the
8902 Foil\SpecialChar TeX
8905 document class installed,
8906 you’ll probably have to use the
8911 If you want to install the
8916 it is available from
8917 \begin_inset CommandInset href
8920 target "https://www.ctan.org/pkg/foiltex"
8926 You should also read the
8928 Installing New Document Classes
8937 \begin_layout Subsubsection
8941 \begin_layout Standard
8943 to use this document class,
8955 \begin_inset space ~
8961 There are some settings in the
8964 \begin_inset space ~
8969 dialog that you should know about that are specific to this class:
8972 \begin_layout Itemize
8973 Don't change the options
8984 \begin_inset space ~
8990 They're ignored by the
8997 \begin_layout Itemize
8998 The default font size is 20
8999 \begin_inset space \thinspace{}
9002 pt with the other options being 17
9003 \begin_inset space \thinspace{}
9008 \begin_inset space \thinspace{}
9012 \begin_inset space \thinspace{}
9018 \begin_layout Itemize
9027 but all math equations are still typeset in the usual roman font.
9030 \begin_layout Itemize
9033 Foil\SpecialChar TeX
9036 supports A4 and Letter paper sizes as well as a special size for working with 35
9037 \begin_inset space \thinspace{}
9041 It doesn't support A5,
9043 legal or executive paper sizes.
9046 \begin_layout Itemize
9047 Don't bother changing the
9051 settings because they are ignored anyway.
9052 All floats appear where they are defined in the text.
9055 \begin_layout Itemize
9060 setting behaves a bit differently for this class.
9063 Foil\SpecialChar TeX
9066 provides extensive footer and header capabilities including a user-defined logo.
9068 \begin_inset space ~
9072 \begin_inset CommandInset ref
9074 reference "sec:foilfoot"
9080 The title page is treated differently to all other pages in the document and is
9088 has the logo centered at the bottom of the page (if one is defined).
9089 The possible page style choices and what they do are as follows:
9093 \begin_layout Labeling
9094 \labelwidthstring MMMMMMM
9101 The final output contains no page numbers,
9102 or other headers or footers (except footnotes of course).
9106 \begin_layout Labeling
9107 \labelwidthstring MMMMMMM
9114 The final output contains page numbers centered at the bottom of the page.
9115 No other headings or footers (other than footnotes).
9118 \begin_layout Labeling
9119 \labelwidthstring MMMMMMM
9124 Page numbers in lower right corner.
9125 Additional headers and footers are also shown.
9126 This is also the default.
9129 \begin_layout Labeling
9130 \labelwidthstring MMMMMMM
9135 Gives you access to the
9139 package although its use with
9141 Foil\SpecialChar TeX
9144 is discouraged by the writer of the
9146 Foil\SpecialChar TeX
9149 package because of some potential page layout clashes.
9153 \begin_layout Paragraph
9157 \begin_layout Standard
9158 The following options may be used in the extra class options in the
9160 Document\SpecialChar menuseparator
9166 \begin_layout Labeling
9167 \labelwidthstring MMMMMMx
9172 This sets up the page layout for 7.33
9173 \begin_inset space \thinspace{}
9177 \begin_inset space \thinspace{}
9181 which is about the same aspect ratio as a 35
9182 \begin_inset space \thinspace{}
9186 making it a bit easier to work with this medium.
9189 \begin_layout Labeling
9190 \labelwidthstring MMMMMMx
9195 Places a rule across the page below the header on every page except the title page.
9198 \begin_layout Labeling
9199 \labelwidthstring MMMMMMx
9204 Places a rule across the page above the footer on every page except the title page.
9207 \begin_layout Labeling
9208 \labelwidthstring MMMMMMx
9213 This is automatically set each time you create a new
9220 Foil\SpecialChar TeX
9223 to use the dvips driver to rotate those pages that are set as landscape foils.
9226 \begin_layout Labeling
9227 \labelwidthstring MMMMMMx
9232 Simply changes the page dimensions to those of a landscape page but doesn't do any rotation.
9233 Thus if you use this option you need to use an external program to rotate each page or feed your paper through your printer as landscape.
9234 Note that this option effectively reverses the roles of the
9242 environments (don't worry these are described in the next section).
9245 \begin_layout Labeling
9246 \labelwidthstring MMMMMMx
9251 Equation numbers on the left.
9254 \begin_layout Labeling
9255 \labelwidthstring MMMMMMx
9260 Flush-left equations.
9263 \begin_layout Subsubsection
9264 Supported Environments
9267 \begin_layout Standard
9268 Most of the environments commonly supported in other classes are also supported by the
9270 Foil\SpecialChar TeX
9274 There are several additional environments provided by
9276 Foil\SpecialChar TeX
9279 as well as a couple added by \SpecialChar LyX
9281 The following environments are shared with other classes:
9284 \begin_layout Standard
9285 \begin_inset Flex Multiple Columns
9288 \begin_layout Itemize
9294 \begin_layout Itemize
9300 \begin_layout Itemize
9306 \begin_layout Itemize
9312 \begin_layout Itemize
9318 \begin_layout Itemize
9325 \begin_layout Itemize
9331 \begin_layout Itemize
9337 \begin_layout Itemize
9343 \begin_layout Itemize
9349 \begin_layout Itemize
9355 \begin_layout Itemize
9361 \begin_layout Itemize
9367 \begin_layout Itemize
9373 \begin_layout Itemize
9379 \begin_layout Itemize
9390 \begin_layout Standard
9392 all the major environments apart from the sectioning environments.
9393 Since foils are essentially self-contained sections,
9394 with a title and body,
9397 Foil\SpecialChar TeX
9400 provides specific commands for starting new foils and these are:
9403 \begin_layout Itemize
9409 \begin_layout Itemize
9415 \begin_layout Standard
9417 also provides slightly modified versions of these two environments called:
9420 \begin_layout Itemize
9426 \begin_layout Itemize
9432 \begin_layout Standard
9433 and the differences will be explained in the next section.
9436 \begin_layout Standard
9437 Since foils are often used in presenting ideas or new theorems and such
9439 Foil\SpecialChar TeX
9442 also provides a comprehensive box of goodies for presenting them:
9445 \begin_layout Standard
9446 \begin_inset Flex Multiple Columns
9449 \begin_layout Itemize
9455 \begin_layout Itemize
9461 \begin_layout Itemize
9467 \begin_layout Itemize
9473 \begin_layout Itemize
9479 \begin_layout Itemize
9485 \begin_layout Itemize
9491 \begin_layout Itemize
9497 \begin_layout Itemize
9503 \begin_layout Itemize
9509 \begin_layout Itemize
9520 \begin_layout Standard
9521 The starred versions are unnumbered while the unstarred versions are numbered.
9522 There are also two list environments added by \SpecialChar LyX
9526 \begin_layout Itemize
9532 \begin_layout Itemize
9538 \begin_layout Standard
9541 Foil\SpecialChar TeX
9544 provides some powerful header and footer capabilities that are best set in the preamble although they may be set at any point in a document.
9545 If you want to change these settings in your document the best place to do so is at the very top of a foil,
9547 \begin_inset space \thinspace{}
9553 \begin_inset space \space{}
9558 straight after the foilhead.
9561 \begin_layout Standard
9563 the following command styles are provided [
9570 \begin_layout Standard
9571 \begin_inset Flex Multiple Columns
9574 \begin_layout Itemize
9578 \begin_inset space ~
9584 \begin_layout Itemize
9590 \begin_layout Itemize
9594 \begin_inset space ~
9600 \begin_layout Itemize
9604 \begin_inset space ~
9610 \begin_layout Itemize
9614 \begin_inset space ~
9621 \begin_layout Plain Layout
9622 \begin_inset space ~
9634 \begin_layout Standard
9635 There are also a few commands provided by
9637 Foil\SpecialChar TeX
9640 that aren't directly supported by \SpecialChar LyX
9641 but I'll tell you what they do and how to use them in section
9642 \begin_inset space ~
9646 \begin_inset CommandInset ref
9648 reference "sec:unsuppfoils"
9656 \begin_layout Subsubsection
9657 Building a Set of Foils
9660 \begin_layout Standard
9661 This section will give a simple introduction to using the different environments to build a set of foils.
9662 If you want to see an example set of foils,
9665 File\SpecialChar menuseparator
9666 Open Example\SpecialChar menuseparator
9667 Presentations\SpecialChar menuseparator
9673 \begin_layout Paragraph
9674 Give It a Title Page
9677 \begin_layout Standard
9678 Unlike other classes that provide
9703 creates the title on a page of its own.
9704 If you leave out the
9708 environment \SpecialChar LaTeX
9709 will substitute the current date (every time you regenerate the output).
9712 \begin_layout Paragraph
9716 \begin_layout Standard
9717 As I mentioned earlier,
9718 there are four ways of starting a new foil.
9719 For portrait foils you should use
9728 The difference between these two environments is the amount of space between the title of the foil (the foilhead) and the body of the foil.
9731 \begin_layout Standard
9732 Landscape foils are generated using the
9741 Again the only difference is the spacing between foilhead and body.
9742 Both of the short versions have 0.5
9743 \begin_inset space ~
9746 inches less separation between the foilhead and the body.
9750 \begin_layout Standard
9751 One problem with the support for landscape foils is the requirement that you have to use the
9755 driver to generate the PostScript output otherwise the foils won't be rotated.
9756 It is possible to get landscape foils even if you haven't got the
9760 driver provided you can feed your foils sideways through your printer ;-)
9763 \begin_layout Paragraph
9769 \begin_layout Standard
9770 You can't have two of the same type of these environments directly following each other.
9771 If you use a normal paragraph break,
9773 you will just be extending the previous environment as if you had merged the two environments together.
9775 you need to insert a so-called separator.
9776 Please refer to the section entitled
9787 \begin_layout Paragraph
9791 \begin_layout Standard
9792 You get all the commonly supported list styles found in other classes as well as two new ones.
9793 I'll only describe the new ones here.
9794 If you want to find out more about the other list environments check out the
9799 If you intend to use itemized lists you might also want to read about the
9802 \begin_inset space ~
9806 \begin_inset space ~
9811 dialog described above in section
9812 \begin_inset space ~
9816 \begin_inset CommandInset ref
9818 reference "chap:bullets"
9826 \begin_layout Standard
9827 The two new list styles,
9837 are designed to make it easier for you to create lists of do's and don'ts or right and wrong by providing dedicated environments that use a tick or a cross as the label of the list.
9838 These lists are in fact dedicated variants of the
9843 They do however require that you have the
9850 \begin_layout Paragraph
9854 \begin_layout Standard
9857 Foil\SpecialChar TeX
9860 redefines the floating tables and figures so that they appear exactly where they are in the text rather than pushing them to the top of the page or to some user specified location.
9861 In fact if you change the float placement settings they are simply ignored.
9864 \begin_layout Paragraph
9865 Page Headers and Footers
9866 \begin_inset CommandInset label
9875 \begin_layout Standard
9879 \begin_inset space ~
9888 are two commands used to control the left-footer text string.
9889 The first is meant to allow you to include a graphic logo on your foils and defaults to
9890 \begin_inset Quotes eld
9895 Foil\SpecialChar TeX
9899 \begin_inset Quotes erd
9903 While the second is meant to provide a classification for the audience,
9907 \begin_inset space \thinspace{}
9913 \begin_inset space \space{}
9917 It is empty by default.
9920 \begin_layout Standard
9921 The remaining page corners can be filled by
9924 \begin_inset space ~
9929 (which defaults to page numbers),
9933 \begin_inset space ~
9941 \begin_inset space ~
9949 \begin_layout Subsubsection
9952 Foil\SpecialChar TeX
9956 \begin_inset CommandInset label
9958 name "sec:unsuppfoils"
9965 \begin_layout Standard
9966 All the commands mentioned below need to be set in a
9976 within another environment.
9979 \begin_layout Paragraph
9983 \begin_layout Standard
9984 All lengths are adjusted using the
10007 should be replaced by the name given to the length you want to change and
10011 is the length value.
10012 All lengths should be specified in units of length such as inches (
10025 ) or relative to some document or font-based length such as
10035 \begin_layout Standard
10036 It's possible to change the spacing between a foilhead and the body of the foil by adjusting the length specified by
10049 \begin_inset space \space{}
10052 in closer to their bodies put the following in the preamble:
10059 foilheadskip}{-0.5in}
10062 \begin_layout Standard
10063 The spacings around floats can be adjusted by setting these lengths:
10066 \begin_layout Labeling
10067 \labelwidthstring MMMMMMMMMMM
10074 Separation between the text and the top of the float
10077 \begin_layout Labeling
10078 \labelwidthstring MMMMMMMMMMM
10085 Separation between the float and the caption
10088 \begin_layout Labeling
10089 \labelwidthstring MMMMMMMMMMM
10096 Separation between the caption and the following text
10099 \begin_layout Labeling
10100 \labelwidthstring MMMMMMMMMMM
10107 You can make the captions narrower than the surrounding text by adjusting this length.
10108 Best done relative to
10117 \begin_layout Standard
10118 There are also several title page related lengths that you may find useful if you have a long title or several authors:
10121 \begin_layout Labeling
10122 \labelwidthstring MMMMMMMMMMM
10129 Separation from headers to
10134 \begin_layout Labeling
10135 \labelwidthstring MMMMMMMMMMM
10153 \begin_layout Labeling
10154 \labelwidthstring MMMMMMMMMMM
10168 \begin_layout Labeling
10169 \labelwidthstring MMMMMMMMMMM
10185 \begin_layout Labeling
10186 \labelwidthstring MMMMMMMMMMM
10202 \begin_layout Standard
10203 The last length related command affects all the list environments.
10214 a list environment then all the vertical spacing between the list items is removed.
10215 Note that this is a command not a length so it doesn't require
10221 like the stuff mentioned above.
10224 \begin_layout Paragraph
10225 Headers and Footers
10228 \begin_layout Standard
10241 commands control whether the logo in the
10245 definition appear on a given page.
10252 in the preamble then none of the foils will have the logo on them.
10253 If you don't want the logo on a particular page place the
10259 directly after the foilhead of that page and the
10265 directly after the next foilhead.
10268 \begin_layout Standard
10269 If you decide to use the
10273 page style setting in the
10276 \begin_inset space ~
10281 dialog you should probably add
10291 to your preamble so headers and footers on landscape pages are correctly placed when rotated.
10292 This is due to some clashes between the page layouts provided by the
10305 \begin_layout Subsection
10309 \begin_layout Standard
10319 class for creating presentations.
10322 File\SpecialChar menuseparator
10323 Open Example\SpecialChar menuseparator
10324 Presentations\SpecialChar menuseparator
10327 offers guidance on its use.
10328 The documentation is available from
10329 \begin_inset CommandInset href
10332 target "http://mirrors.ctan.org/macros/latex/contrib/powerdot/doc/powerdot.pdf"
10340 \begin_layout Subsection
10341 \begin_inset CommandInset label
10343 name "subsec:Seminar"
10352 \begin_layout Standard
10361 document class for creating presentations.
10364 File\SpecialChar menuseparator
10365 Open Example\SpecialChar menuseparator
10366 Presentations\SpecialChar menuseparator
10369 offers guidance on its use.
10370 The documentation is available from
10371 \begin_inset CommandInset href
10374 target "http://mirrors.ctan.org/macros/latex/contrib/seminar/doc/seminar-doc.pdf"
10382 \begin_layout Subsection
10385 Sli\SpecialChar TeX
10389 \begin_inset CommandInset label
10398 \begin_layout Standard
10404 updated by the \SpecialChar LyX
10408 \begin_layout Subsubsection
10412 \begin_layout Standard
10413 This section describes how to use \SpecialChar LyX
10414 to make slides for overhead projectors.
10415 There are two document classes that can do this:
10420 document class and the
10422 Foil\SpecialChar TeX
10426 This section documents the former.
10427 If you’re looking for the documentation for
10429 Foil\SpecialChar TeX
10434 \begin_inset space ~
10438 \begin_inset CommandInset ref
10440 reference "sec:foiltex"
10453 has continued to be maintained whereas
10455 Foil\SpecialChar TeX
10458 has not been maintained since 2008.
10462 \begin_layout Subsubsection
10464 \begin_inset CommandInset label
10466 name "sec:slidesetup"
10473 \begin_layout Standard
10475 to use this document class,
10477 \begin_inset Quotes eld
10485 \begin_inset Quotes erd
10488 from the class list in the
10490 Document\SpecialChar menuseparator
10494 There are some other special things you should know about this class:
10497 \begin_layout Itemize
10498 Don't bother changing the options
10503 They're not supported by the
10511 \begin_layout Itemize
10515 \begin_inset space ~
10520 behaves a bit differently for this class.
10521 The possible choices and what they do are as follows:
10525 \begin_layout Description
10530 The final output contains page numbers in the lower right corner.
10533 \begin_layout Description
10543 but also prints out any time markers you've put in.
10544 This is the default.
10547 \begin_layout Description
10552 The final output contains no page numbers,
10554 or alignment markers.
10558 \begin_layout Itemize
10563 class has an extra option:
10571 \begin_inset Quotes eld
10579 \begin_inset Quotes erd
10582 in the extra class options.
10586 \begin_layout Standard
10587 Using this options allows you to add time markers to
10593 \begin_inset space ~
10597 \begin_inset CommandInset ref
10599 reference "sec:slideNote"
10608 \begin_layout Standard
10609 You can also use the template file to automatically set up a document to use the
10615 File\SpecialChar menuseparator
10617 \begin_inset space ~
10621 \begin_inset space ~
10624 Template\SpecialChar menuseparator
10625 Presentations\SpecialChar menuseparator
10628 to open your new document.
10629 The template file also contains some examples of the special paragraph environments used by this class.
10630 I'll describe those next.
10633 \begin_layout Subsubsection
10634 Paragraph Environments
10637 \begin_layout Paragraph
10638 Supported Environments
10641 \begin_layout Standard
10642 The first thing you'll notice when you start up a new
10646 document is the font size and type:
10647 it's the equivalent of the size
10648 \begin_inset Quotes eld
10656 \begin_inset Quotes erd
10662 \begin_inset space ~
10668 This is also what's used in the output.
10670 \begin_inset Quotes eld
10674 \begin_inset Quotes erd
10677 to remind you that this is a slide.
10678 Your final slides will use a larger font;
10680 you'll have less space.
10682 the larger default screen font isn't WYSIWYG,
10686 \begin_layout Standard
10687 The next thing that becomes obvious is the changes to the paragraph environment pull-down box [at the far-left end of the toolbar].
10688 Most of the paragraph environments you're used to seeing are missing.
10689 There are also five new ones.
10694 class itself only supports certain paragraph environments:
10697 \begin_layout Standard
10700 \begin_inset Flex Multiple Columns
10703 \begin_layout Itemize
10709 \begin_layout Itemize
10715 \begin_layout Itemize
10721 \begin_layout Itemize
10727 \begin_layout Itemize
10733 \begin_layout Itemize
10739 \begin_layout Itemize
10745 \begin_layout Itemize
10751 \begin_layout Itemize
10757 \begin_layout Itemize
10769 \begin_layout Standard
10770 All of the other standard environments,
10771 including the section-heading environments,
10779 \begin_layout Standard
10781 you'll notice the following new environments:
10784 \begin_layout Standard
10787 \begin_inset Flex Multiple Columns
10790 \begin_layout Itemize
10796 \begin_layout Itemize
10802 \begin_layout Itemize
10808 \begin_layout Itemize
10814 \begin_layout Itemize
10821 \begin_layout Plain Layout
10822 \begin_inset space ~
10834 \begin_layout Standard
10835 These five are kind of quirky,
10837 \begin_inset Quotes eld
10841 \begin_inset Quotes erd
10844 in \SpecialChar LyX
10848 doesn't permit you to nest any other paragraph environment into an empty environment.
10850 that's fine and dandy,
10851 but it means that you wouldn't be able to start a slide with anything except plain text.
10853 I've performed a little
10854 \begin_inset Quotes eld
10859 \begin_inset Quotes erd
10865 \begin_layout Paragraph
10866 Quirks of the New Environments
10867 \begin_inset CommandInset label
10869 name "sec:slideQuirk"
10876 \begin_layout Standard
10877 All five of the new paragraph environments are somewhat quirky due to inherent limitiations in the current version of \SpecialChar LyX
10879 As I just mentioned,
10881 forbids environments that begin with another environment.
10882 To get around this,
10887 environment isn't a paragraph environment as described in the
10895 \begin_layout Standard
10896 You should consider
10911 \begin_inset Quotes eld
10914 pseudo-environments.
10915 \begin_inset Quotes erd
10918 They look like a section heading or a
10919 \begin_inset Quotes eld
10927 \begin_inset Quotes erd
10930 but really begin a [and,
10932 end the previous] paragraph environment.
10943 \begin_inset Quotes eld
10947 \begin_inset Quotes erd
10950 These two perform some action.
10953 \begin_layout Standard
10954 A common feature of all five environments,
10979 is a rather long-ish label.
10980 The text following this label —
10981 ordinarily the contents of the paragraph environment —
10982 is utterly irrelevant for
11007 completely ignores it.
11009 you can leave these five environments completely empty.
11013 \begin_layout Standard
11018 to put any text after the rather long-ish label,
11020 This could be a short description of the contents of the
11027 enter your descriptive comment and hit
11031 as you normally would.
11034 \begin_layout Subsubsection
11035 Making a Presentation with
11049 \begin_layout Paragraph
11057 \begin_layout Standard
11058 If you're expecting this section to teach you how to actually make a presentation,
11059 you'll be sorely disappointed.
11061 I'll describe all of the ways the
11065 class can assist you in preparing the materials for a presentation.
11066 Filling in the contents,
11074 the \SpecialChar LyX
11078 \begin_layout Standard
11083 environment [in the manner described in section
11084 \begin_inset space ~
11088 \begin_inset CommandInset ref
11090 reference "sec:slideQuirk"
11095 ] tells \SpecialChar LyX
11096 to begin a new slide [duh].
11097 The label for this environment/
11098 \begin_inset Quotes eld
11102 \begin_inset Quotes erd
11106 \begin_inset Quotes eld
11110 \begin_inset Quotes erd
11114 followed by the label,
11116 \begin_inset Quotes eld
11120 \begin_inset Quotes erd
11124 Any text or paragraph environments that follow this one go on the new slide.
11128 \begin_layout Standard
11129 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
11130 (this can be specified in the
11137 once you finish entering the contents of one slide.
11138 If you've entered more text than can physically fit on a slide,
11139 the extra overflows onto a new slide.
11140 I don't recommend doing this,
11142 since the overflow slide won't have any page number on it.
11144 it may interfere with any
11148 you've made to accompany the oversized
11155 \begin_layout Standard
11164 environments work the same way as the
11169 They both create an
11170 \begin_inset Quotes eld
11174 \begin_inset Quotes erd
11177 followed by a label [
11178 \begin_inset Quotes eld
11182 \begin_inset Quotes erd
11186 \begin_inset Quotes eld
11190 \begin_inset Quotes erd
11195 The color is a stunning magenta instead of blue,
11197 \begin_inset Quotes eld
11201 \begin_inset Quotes erd
11204 will look different,
11205 in style and in length.
11206 The label fonts of all three also differ from one another.
11209 \begin_layout Standard
11215 if the contents of a
11223 exceed the physical size of a slide or sheet of paper,
11224 the extra will overflow onto a new sheet.
11226 you should avoid this.
11227 It defeats the whole purpose of
11238 \begin_layout Paragraph
11248 \begin_layout Standard
11253 is a slide that sits atop another slide.
11254 Perhaps you wish to discuss a figure on the main
11258 before displaying the text associated with it.
11259 One way to accomplish this is tape a flap of dark paper over the part of the
11263 you want to display later.
11266 if you wish to overlap one graph with another,
11268 You would then have to fumble while speaking to align the two separate,
11273 s to align the two graphs.
11278 environment in both cases makes life much easier.
11281 \begin_layout Standard
11286 receives the page number of its
11287 \begin_inset Quotes eld
11291 \begin_inset Quotes erd
11300 \begin_inset Quotes eld
11308 \begin_inset Quotes erd
11315 \begin_layout Plain Layout
11322 \begin_inset Quotes eld
11330 \begin_inset Quotes erd
11335 \begin_inset Quotes eld
11343 \begin_inset Quotes erd
11348 \begin_inset Quotes eld
11356 \begin_inset Quotes erd
11361 \begin_inset space ~
11364 appended to the page number of the parent
11375 you want the contents of both the
11383 to each fit on a single physical slide!
11384 You should probably consider an
11389 \begin_inset Quotes eld
11393 \begin_inset Quotes erd
11402 the \SpecialChar LyX
11407 class provides a visual cue for this:
11408 the label at the start of an
11412 is shorter than that at the start of a
11418 when you generate printable output,
11419 you'll find alignment markers in all four corners of both the
11423 page and its parent
11428 These will assist you in lining up the two physical slides.
11431 \begin_layout Standard
11432 The major problem in overlaying two slides is aligning the contents of the two transparencies.
11433 How much space should you leave for that graph on the second slide?
11435 what if you want a graph and a sentence on second slide,
11436 but there is text on the main transparency that goes in between them?
11437 You could try and insert vertical space of the right size.
11438 The better way is to use
11449 \begin_layout Standard
11450 As their names imply,
11459 are two command-like paragraph environments that make all subsequent text invisible and visible,
11462 \begin_inset space ~
11466 \begin_inset CommandInset ref
11468 reference "sec:slideQuirk"
11473 that you don't place anything
11477 these two environments,
11484 it inserts a centered,
11485 sky-blue label into the page reading
11486 \begin_inset Quotes eld
11489 <Invisible Text Follows>
11490 \begin_inset Quotes erd
11494 For paragraphs following this label,
11504 it doesn't matter which] where they would be contain instead blank space.
11508 \begin_layout Standard
11514 the corresponding centered label is
11515 \begin_inset Quotes eld
11518 <Visible Text Follows>
11519 \begin_inset Quotes erd
11523 Paragraphs following this label behave normally.
11524 Note that the beginning of a new
11538 automatically shuts off an
11543 It's therefore not necessary to use
11554 \begin_layout Standard
11556 it should be obvious how to create overlay transparencies using the proper combination of
11575 \begin_layout Enumerate
11581 including everything that will appear on it,
11582 whether on the main slide or on the
11589 \begin_layout Enumerate
11590 Before each figure or paragraph that will appear only on the
11605 environment after the
11612 \begin_layout Enumerate
11617 immediately following the
11624 \begin_layout Enumerate
11625 Copy the contents of this
11636 \begin_layout Enumerate
11653 \begin_layout Standard
11655 You've just made an
11662 \begin_layout Standard
11663 There's one problem with the way I've designed the \SpecialChar LyX
11669 you can't make text in the middle of a paragraph invisible,
11670 nor make text in the middle of an invisible paragraph visible again.
11671 To accomplish this feat,
11672 you'll need to use some inlined \SpecialChar LaTeX
11677 \begin_layout Plain Layout
11678 The commands of interest are:
11682 \begin_layout Itemize
11687 invisible \SpecialChar ldots
11691 \begin_layout Itemize
11696 visible \SpecialChar ldots
11700 \begin_layout Plain Layout
11702 and need to be marked as \SpecialChar TeX
11705 \begin_inset Quotes eld
11709 \begin_inset Quotes erd
11712 you wish to change goes in between the brackets [and after the
11725 If you don't know how to mark text as \SpecialChar TeX
11727 see the appropriate section of the
11739 \begin_layout Paragraph
11749 \begin_inset CommandInset label
11751 name "sec:slideNote"
11758 \begin_layout Standard
11768 is associated with a
11769 \begin_inset Quotes eld
11773 \begin_inset Quotes erd
11783 the \SpecialChar LyX
11788 class provides visual cues.
11793 is shorter than that of a
11797 [yet longer than that of an
11802 like the label of an
11806 is shockingly magenta.
11812 has the page number of its
11813 \begin_inset Quotes eld
11817 \begin_inset Quotes erd
11826 \begin_inset Quotes eld
11834 \begin_inset Quotes erd
11839 \begin_inset Quotes eld
11847 \begin_inset Quotes erd
11852 \begin_inset Quotes eld
11860 \begin_inset Quotes erd
11865 You can have multiple
11869 s associated with a single
11884 you'll probably want to break up long
11888 s so that they fit on a single sheet of paper.
11891 \begin_layout Standard
11897 it contains anything additional you might want to say about a
11902 It could also be used as a sheet of reminders for a particular
11907 In the case of the latter,
11908 you might want to make use of time markers.
11910 the \SpecialChar LyX
11916 \begin_inset Quotes eld
11920 \begin_inset Quotes erd
11923 support for time markers,
11926 Sli\SpecialChar TeX
11931 you'll have to resort to using the \SpecialChar LaTeX
11935 \begin_layout Standard
11936 To use time markers,
11937 you'll need to specify the extra class option
11938 \begin_inset Quotes eld
11946 \begin_inset Quotes erd
11950 \begin_inset space ~
11954 \begin_inset CommandInset ref
11956 reference "sec:slidesetup"
11962 This option turns on timing marks,
11963 which will appear in the lower-left-hand corner of every
11968 To set what appears in the time marker,
11969 you use the \SpecialChar LaTeX
11971 \begin_inset Quotes eld
11981 \begin_inset Quotes erd
11985 \begin_inset Quotes eld
11995 \begin_inset Quotes erd
11999 The arguments of both commands are time measured in seconds.
12001 \begin_inset Quotes eld
12011 \begin_inset Quotes erd
12014 sets the time marker to a given time.
12016 \begin_inset Quotes eld
12026 \begin_inset Quotes erd
12029 increments the time marker by the specified amount.
12030 Using time markers and
12035 you can remind yourself how much time to spend on a particular
12042 \begin_layout Standard
12043 There's one last feature to describe.
12045 you'd like to print out all of your
12053 s on transparencies while printing all of your
12071 with which it is associated.
12072 What's a person to do?
12075 \begin_layout Standard
12077 there are two \SpecialChar LaTeX
12078 commands that allow you to select what to print out.
12079 Both must be placed into the preamble of your document.
12081 \begin_inset Quotes eld
12093 \begin_inset Quotes erd
12096 will cause the output to contain only the
12107 \begin_inset Quotes eld
12119 \begin_inset Quotes erd
12122 prevents the output of anything but
12127 I'd advise placing both commands in the preamble and initially comment both out.
12128 You can then preview your entire presentation as you write.
12129 When you're done writing,
12130 you can then uncomment one of the two to select what you want to print.
12131 I like to uncomment
12132 \begin_inset Quotes eld
12144 \begin_inset Quotes erd
12148 print to a file with
12149 \begin_inset Quotes eld
12157 \begin_inset Quotes erd
12161 comment it back out,
12163 \begin_inset Quotes eld
12175 \begin_inset Quotes erd
12179 \begin_inset Quotes eld
12187 \begin_inset Quotes erd
12191 I can then send either file to a printer,
12192 loading transparencies or plain paper as appropriate.
12195 \begin_layout Standard
12196 You can also provide other arguments to the
12197 \begin_inset Quotes eld
12207 \begin_inset Quotes erd
12211 \begin_inset Quotes eld
12221 \begin_inset Quotes erd
12225 See a good \SpecialChar LaTeX
12229 \begin_layout Subsubsection
12234 Class Template File
12237 \begin_layout Standard
12238 I have also provided a template file with the
12244 begin your new presentation with
12246 File\SpecialChar menuseparator
12248 \begin_inset space ~
12252 \begin_inset space ~
12255 Template\SpecialChar menuseparator
12256 Presentations\SpecialChar menuseparator
12260 Your new \SpecialChar LyX
12261 presentation file will contain an example
12282 additionally contain an example of the use of
12292 the preamble will contain:
12295 \begin_layout LyX-Code
12296 % Uncomment to print out only slides and overlays
12299 \begin_layout LyX-Code
12303 \begin_layout LyX-Code
12309 \begin_inset Newline newline
12315 \begin_layout LyX-Code
12316 % Uncomment to print out only notes
12319 \begin_layout LyX-Code
12323 \begin_layout LyX-Code
12331 \begin_layout Standard
12333 I created this class to support the \SpecialChar LaTeX2e
12335 \begin_inset Quotes eld
12340 Sli\SpecialChar TeX
12344 \begin_inset Quotes erd
12348 one of the built-in \SpecialChar LaTeX2e
12350 Neither I nor the rest of the \SpecialChar LyX
12351 Team endorse or oppose the use of this built-in slide class.
12352 It's here if you want it or need it.
12353 There exist other \SpecialChar LaTeX2e
12354 classes for creating presentations,
12360 \begin_inset space ~
12364 \begin_inset CommandInset ref
12366 reference "sec:foiltex"
12376 \begin_inset space ~
12380 \begin_inset CommandInset ref
12382 reference "subsec:Seminar"
12391 Try them out to see what sort of alternative they provide.
12394 \begin_layout Section
12398 \begin_layout Subsection
12402 \begin_layout Standard
12403 Report classes are sort of a hybrid between book and article classes:
12405 they provide parts,
12406 chapters and sections but does not provide frontmatter,
12409 like article classes,
12410 they provide abstract paragraph styles and are one-sided by default.
12412 they do not start a new chapter on the right hand page (even in two-side mode).
12415 \begin_layout Standard
12416 All externally maintained
12420 document classes that are officially supported by \SpecialChar LyX
12421 are described in the Collections (section
12422 \begin_inset space ~
12426 \begin_inset CommandInset ref
12428 reference "sec:Collections"
12436 \begin_layout Itemize
12439 Japanese Report (Standard Class,
12444 Japanese Report (Standard Class)
12448 \begin_inset space ~
12452 \begin_inset CommandInset ref
12454 reference "subsec:Japanese"
12462 \begin_layout Itemize
12469 \begin_inset space ~
12473 \begin_inset CommandInset ref
12475 reference "subsec:KOMA-Script"
12483 \begin_layout Itemize
12486 Report (Standard Class with Extra Font Sizes)
12490 \begin_inset space ~
12494 \begin_inset CommandInset ref
12496 reference "subsec:Extra-font-sizes"
12504 \begin_layout Itemize
12507 Polish Report (MW Bundle)
12511 \begin_inset space ~
12515 \begin_inset CommandInset ref
12517 reference "subsec:Polish-M.W.collection"
12528 \begin_layout Section
12532 \begin_layout Standard
12538 we assemble document classes that help to write drama or movie scripts.
12539 The category is also open for other scripts,
12540 such as lecture scripts,
12541 for which no classes are officially supported yet by \SpecialChar LyX
12545 \begin_layout Subsection
12549 \begin_layout Standard
12555 \begin_layout Subsubsection
12559 \begin_layout Standard
12564 is for writing plays.
12565 The format is more decorative than
12570 \begin_inset space ~
12574 \begin_inset CommandInset ref
12576 reference "subsec:Hollywood"
12581 and much less standardized.
12582 This format should be suitable for workshops.
12585 \begin_layout Subsubsection
12589 \begin_layout Standard
12595 \begin_inset space ~
12599 \begin_inset CommandInset ref
12601 reference "subsec:Special-problems-Hollywood"
12608 \begin_layout Subsubsection
12612 \begin_layout Standard
12617 names as labels then cross-reference the label to insert the name.
12618 The cross-reference dialog will show the current cast of characters.
12621 \begin_layout Subsubsection
12622 Paper size and Margins
12625 \begin_layout Standard
12633 \begin_layout Subsubsection
12637 \begin_layout Standard
12638 The following environments are available.
12643 to get the bind keys shown at the right.
12646 \begin_layout Itemize
12650 \begin_inset Newline newline
12655 You should not have to use this,
12656 but it is here for anything that does not fit otherwise.
12659 \begin_layout Itemize
12663 \begin_inset space \hfill{}
12667 \begin_inset Newline newline
12672 Used to describe stage setting and the action.
12673 First use of speaker names in all CAPs.
12676 \begin_layout Itemize
12680 \begin_inset space \hfill{}
12684 \begin_inset Newline newline
12689 Automatically numbered.
12690 On screen it will be arabic,
12691 but will print as Roman.
12694 \begin_layout Itemize
12698 \begin_inset space \hfill{}
12702 \begin_inset Newline newline
12712 It is just centered text.
12715 \begin_layout Itemize
12719 \begin_inset space \hfill{}
12723 \begin_inset Newline newline
12728 Not automatically numbered.
12729 You supply the number.
12730 This is because I couldn't figure out how.
12733 \begin_layout Itemize
12737 \begin_inset space \hfill{}
12741 \begin_inset Newline newline
12746 A special case of Narrative to describe the setting and action as the curtain rises.
12749 \begin_layout Itemize
12753 \begin_inset space \hfill{}
12757 \begin_inset Newline newline
12762 The speaker's (actor's) title,
12763 centered in all CAPS.
12766 \begin_layout Itemize
12770 \begin_inset space \hfill{}
12774 \begin_inset Newline newline
12779 Instructions to the speaker.
12780 The parentheses are automatically inserted.
12781 The ( will appear on screen,
12782 but both will be in the printed play.
12783 This environment is only used within
12790 \begin_layout Itemize
12794 \begin_inset space \hfill{}
12798 \begin_inset Newline newline
12803 What the Speaker says.
12806 \begin_layout Itemize
12810 \begin_inset space \hfill{}
12814 \begin_inset Newline newline
12819 The curtain comes down.
12822 \begin_layout Itemize
12826 \begin_inset space \hfill{}
12832 \begin_layout Itemize
12836 \begin_inset space \hfill{}
12842 \begin_layout Itemize
12846 \begin_inset space \hfill{}
12852 \begin_layout Standard
12856 \begin_layout Subsection
12857 \begin_inset CommandInset label
12859 name "subsec:Hollywood"
12863 Hollywood (Hollywood spec scripts)
12866 \begin_layout Standard
12872 \begin_layout Subsubsection
12876 \begin_layout Standard
12877 Getting the format of a Hollywood script right is a
12878 \begin_inset Quotes eld
12882 \begin_inset Quotes erd
12885 It is designed to make the readers focus on content and to be easy and familiar for the actors to read.
12886 Each page of a script should be one minute of film.
12887 Nothing goes in a script that you cannot see or hear on screen.
12888 The courier 12 pt font should be used throughout.
12892 \begin_layout Subsubsection
12893 \begin_inset CommandInset label
12895 name "subsec:Special-problems-Hollywood"
12902 \begin_layout Standard
12903 Speakers' lines should
12907 break in mid-sentence.
12908 If a speaker's lines continue over a page break,
12913 title followed by (Cont'd).
12916 \begin_layout Subsubsection
12920 \begin_layout Standard
12925 names as labels then cross-reference the label to insert the name.
12926 The cross-reference dialog will show the current cast of characters.
12927 You can use this to insert the speaker name in narratives also.
12930 \begin_layout Subsubsection
12931 Paper size and Margins
12934 \begin_layout Standard
12942 \begin_layout Subsubsection
12946 \begin_layout Standard
12947 The following environments are available.
12952 to get the bind keys shown at the right.
12955 \begin_layout Itemize
12959 \begin_inset Newline newline
12964 Used where nothing else works.
12968 \begin_layout Itemize
12974 \begin_inset space \hfill{}
12982 \begin_inset Newline newline
12985 Usually followed by something like
12986 \begin_inset Quotes eld
12989 on Sally waking up.
12990 \begin_inset Quotes erd
12996 \begin_layout Itemize
13000 \begin_inset space \hfill{}
13004 \begin_inset Newline newline
13009 Introduces a new INTERIOR camera set-up.
13010 Always followed by DAY or NIGHT,
13011 or something similar to define the lighting required.
13012 Everthing on this line in CAPS.
13015 \begin_layout Itemize
13019 \begin_inset space \hfill{}
13023 \begin_inset Newline newline
13028 Introduces a new EXTERIOR camera set-up.
13029 Everthing on this line in CAPS.
13032 \begin_layout Itemize
13036 \begin_inset space \hfill{}
13040 \begin_inset Newline newline
13045 The character speaking.
13048 \begin_layout Itemize
13052 \begin_inset space \hfill{}
13056 \begin_inset Newline newline
13061 Instructions to the speaker.
13062 The () are automatically inserted.
13065 \begin_layout Itemize
13069 \begin_inset space \hfill{}
13073 \begin_inset Newline newline
13085 \begin_layout Itemize
13089 \begin_inset space \hfill{}
13093 \begin_inset Newline newline
13098 Camera movement instruction.
13100 \begin_inset space \thinspace{}
13104 \begin_inset space \space{}
13110 \begin_layout Itemize
13114 \begin_inset space \hfill{}
13120 \begin_layout Itemize
13124 \begin_inset space \hfill{}
13130 \begin_layout Itemize
13134 \begin_inset space \hfill{}
13140 \begin_layout Itemize
13144 \begin_inset space \hfill{}
13150 \begin_layout Subsubsection
13154 \begin_layout Itemize
13159 \begin_layout Itemize
13164 \begin_layout Itemize
13166 \begin_inset space \thinspace{}
13174 \begin_layout Itemize
13180 \begin_layout Itemize
13185 \begin_layout Itemize
13190 \begin_layout Chapter
13194 \begin_layout Section
13195 Academic Field Specifics
13198 \begin_layout Subsection
13200 Hazard and Precautionary Statements
13203 \begin_layout Standard
13204 This module provides two insets and a paragraph style to typeset numbers and phrases of chemical hazard and precautionary statements.
13205 For a description see
13207 File\SpecialChar menuseparator
13208 Open Example\SpecialChar menuseparator
13209 Modules\SpecialChar menuseparator
13210 Hazard and Precautionary Statements
13214 Help\SpecialChar menuseparator
13215 Specific Manuals\SpecialChar menuseparator
13216 Hazard and Precautionary Statements
13221 \begin_layout Subsection
13225 Risk and Safety Statements
13228 \begin_layout Standard
13229 This module provides two insets,
13239 accessible via the menu
13244 nsert\SpecialChar menuseparator
13246 \begin_inset space ~
13251 and an environment to typeset numbers and phrases of chemical risk and safety statements.
13254 \begin_layout Subsection
13258 \begin_layout Standard
13259 This module provides specific environments useful for linguistics (numbered examples,
13262 OT tableau floats).
13263 You can obtain information about this module in
13268 elp\SpecialChar menuseparator
13274 \begin_inset space ~
13277 Manuals\SpecialChar menuseparator
13286 File\SpecialChar menuseparator
13287 Open Example\SpecialChar menuseparator
13288 Modules\SpecialChar menuseparator
13294 \begin_layout Section
13298 \begin_layout Subsection
13302 \begin_layout Standard
13303 This module supports the Braille script.
13304 It requires the \SpecialChar LaTeX
13310 This and its documentation can be obtained from
13311 \begin_inset CommandInset href
13314 target "https://www.ctan.org/pkg/braille"
13325 elp\SpecialChar menuseparator
13331 \begin_inset space ~
13334 Manuals\SpecialChar menuseparator
13343 File\SpecialChar menuseparator
13344 Open Example\SpecialChar menuseparator
13345 Modules\SpecialChar menuseparator
13351 \begin_layout Section
13352 Annotation & Revision
13355 \begin_layout Subsection
13359 \begin_layout Standard
13360 This module provides “FiXme” (marginal) annotations for document revision purposes.
13361 A list of annotations can be produced by using the “List of FIXMEs” paragraph style.
13362 The annotations are customizable via the LaTeX preamble.
13367 documentation which can be obtained from
13368 \begin_inset CommandInset href
13371 target "http://mirrors.ctan.org/macros/latex/contrib/fixme/fixme.pdf"
13379 \begin_layout Paragraph
13383 \begin_layout Standard
13385 the notes are only displayed in “draft” mode (if the option “draft” has been inserted in
13387 Document\SpecialChar menuseparator
13388 Settings\SpecialChar menuseparator
13389 Document Class\SpecialChar menuseparator
13390 Class Options\SpecialChar menuseparator
13394 To display them always,
13403 Document\SpecialChar menuseparator
13404 Settings\SpecialChar menuseparator
13411 \begin_layout Subsection
13415 \begin_layout Standard
13416 This module provides various kinds of annotations for PDF output.
13419 Help\SpecialChar menuseparator
13420 Specific Manuals\SpecialChar menuseparator
13425 File\SpecialChar menuseparator
13426 Open Example\SpecialChar menuseparator
13427 Modules\SpecialChar menuseparator
13433 \begin_layout Subsection
13439 \begin_layout Standard
13440 This module provides fields and buttons for PDF forms.
13442 \begin_inset CommandInset href
13444 name "hyperref documentation"
13445 target "http://mirrors.ctan.org/macros/latex/contrib/hyperref/doc/hyperref-doc.pdf"
13453 Help\SpecialChar menuseparator
13454 Specific Manuals\SpecialChar menuseparator
13459 File\SpecialChar menuseparator
13460 Open Example\SpecialChar menuseparator
13461 Modules\SpecialChar menuseparator
13467 \begin_layout Subsection
13473 \begin_layout Standard
13474 This module defines an inset to typeset reading aids (ruby,
13475 furigana) to Chinese characters.
13489 package (depending on the TeX engine) or a fallback definition.
13492 \begin_layout Subsection
13498 \begin_layout Standard
13499 This module provides custom insets to insert TODO items in your document.
13500 In order to generate a “List of TODOs,” the module provides a paragraph style.
13507 Document\SpecialChar menuseparator
13508 Settings\SpecialChar menuseparator
13509 Document Class\SpecialChar menuseparator
13510 Class Options\SpecialChar menuseparator
13513 ) suppresses the output of TODO notes.
13515 \begin_inset CommandInset href
13517 name "todonotes documentation"
13518 target "http://mirrors.ctan.org/macros/latex/contrib/todonotes/todonotes.pdf"
13526 \begin_layout Section
13530 \begin_layout Subsection
13531 APA Style with Natbib
13534 \begin_layout Standard
13535 This module adds support for using natbib together with apacite (the bibliography style need not be
13550 or any bibliography that works with both the natbib and apacite packages.)
13553 \begin_layout Section
13557 \begin_layout Subsection
13558 Fancy Colored Boxes
13561 \begin_layout Standard
13562 This module adds ten custom insets that support colored boxes via the
13569 Help\SpecialChar menuseparator
13570 Specific Manuals\SpecialChar menuseparator
13576 File\SpecialChar menuseparator
13577 Open Example\SpecialChar menuseparator
13578 Modules\SpecialChar menuseparator
13582 \begin_inset CommandInset href
13584 name "tcolorbox documentation"
13585 target "http://mirrors.ctan.org/macros/latex/contrib/tcolorbox/tcolorbox.pdf"
13593 \begin_layout Subsection
13597 \begin_layout Standard
13598 This provides the custom insets
13616 to scale and rotate its content.
13619 \begin_layout Standard
13624 is a simple way of reversing text without any other enhancement:
13627 \begin_layout Standard
13628 \begin_inset Flex Reflectbox
13631 \begin_layout Plain Layout
13632 Great Western Railway
13640 \begin_layout Standard
13641 (You will need to use Ctrl-R to see any of these examples.)
13644 \begin_layout Standard
13649 allows you to specify the dimensions of the text or image;
13650 permissible units are em,
13672 it scales by the width factor:
13675 \begin_layout Standard
13676 \begin_inset Flex Resizebox
13679 \begin_layout Plain Layout
13680 \begin_inset Argument 1
13683 \begin_layout Plain Layout
13690 \begin_inset Argument 2
13693 \begin_layout Plain Layout
13699 Great Western Railway
13707 \begin_layout Standard
13712 allows you to rotate its contents around the reference point of the box.
13713 If you wish to rotate the box around a different origin,
13714 place the cursor inside the box and select Insert\SpecialChar menuseparator
13744 or meaningful combinations of these and the counterclockwise rotation angle is expressed in degrees.
13748 \begin_layout Standard
13749 \begin_inset Flex Rotatebox
13752 \begin_layout Plain Layout
13753 \begin_inset Argument 1
13756 \begin_layout Plain Layout
13763 \begin_inset Argument 2
13766 \begin_layout Plain Layout
13772 Great Western Railway
13780 \begin_layout Standard
13781 You can combine boxes as in:
13784 \begin_layout Standard
13785 \begin_inset Flex Rotatebox
13788 \begin_layout Plain Layout
13789 \begin_inset Argument 1
13792 \begin_layout Plain Layout
13799 \begin_inset Argument 2
13802 \begin_layout Plain Layout
13809 \begin_inset Flex Resizebox
13812 \begin_layout Plain Layout
13813 \begin_inset Argument 1
13816 \begin_layout Plain Layout
13823 \begin_inset Argument 2
13826 \begin_layout Plain Layout
13833 \begin_inset Flex Reflectbox
13836 \begin_layout Plain Layout
13837 Great Western Railway
13855 \begin_layout Standard
13860 scales its contents;
13861 select Insert\SpecialChar menuseparator
13862 V-Factor to add a vertical factor.
13863 If the vertical factor is omitted,
13864 the horizontal is used.
13865 Adding different horizontal and vertical values creates distortion as in
13868 \begin_layout Standard
13871 \begin_inset Flex Scalebox
13874 \begin_layout Plain Layout
13875 \begin_inset Argument 1
13878 \begin_layout Plain Layout
13885 \begin_inset Argument 2
13888 \begin_layout Plain Layout
13896 Great Western Railway
13904 \begin_layout Standard
13905 A negative horizontal value reverses the text on the horizontal axis,
13906 a negative vertical value on the vertical axis,
13910 \begin_layout Standard
13911 \begin_inset Flex Scalebox
13914 \begin_layout Plain Layout
13915 \begin_inset Argument 1
13918 \begin_layout Plain Layout
13925 \begin_inset Argument 2
13928 \begin_layout Plain Layout
13934 Great Western Railway
13940 \begin_inset Flex Scalebox
13943 \begin_layout Plain Layout
13944 \begin_inset Argument 1
13947 \begin_layout Plain Layout
13954 \begin_inset Argument 2
13957 \begin_layout Plain Layout
13963 Great Western Railway
13971 \begin_layout Subsection
13975 \begin_layout Standard
13976 This module defines Boxes with section header.
13977 It is mainly intended for the SciPoster Document class.
13980 \begin_layout Subsection
13981 Variable-width Minipages
13984 \begin_layout Standard
13988 \begin_inset space \thinspace{}
13995 Insert\SpecialChar menuseparator
14007 package provides a variable-width minipage,
14008 whose resulting width is the width of its contents (if this does not exceed the specified maximum width).
14009 The inset has two optional arguments which can be added by placing the cursor inside the minipage and entering
14011 Insert\SpecialChar menuseparator
14013 \begin_inset space \thinspace{}
14024 Insert\SpecialChar menuseparator
14026 \begin_inset space \thinspace{}
14040 File\SpecialChar menuseparator
14041 Open Example\SpecialChar menuseparator
14042 Variable-width Minipages
14047 \begin_layout Section
14051 \begin_layout Subsection
14052 Fix Computer Modern Fonts
14055 \begin_layout Standard
14056 This module uses the
14060 package to improve the appearance of Computer Modern fonts and make them available with arbitrary sizes.
14062 \begin_inset CommandInset href
14064 name "fix-cm documentation"
14065 target "http://mirrors.ctan.org/macros/latex/base/fix-cm.pdf"
14073 \begin_layout Subsection
14075 Kernel Fixes (Obsolete)
14078 \begin_layout Standard
14079 This module loads the \SpecialChar LaTeX
14084 which contains some bug fixes for \SpecialChar LaTeX
14086 If you use this module your typeset document may look different when you process it,
14087 depending on the respective version of
14094 \begin_layout Paragraph
14098 \begin_layout Standard
14099 recent \SpecialChar LaTeX
14100 kernels (as of 2015/01/01) include the functionality of
14109 module is obsolete with newer \SpecialChar LaTeX
14113 \begin_layout Subsection
14114 Minimalistic Insets
14117 \begin_layout Standard
14118 This module redefines several insets (Index,
14120 URL) as being Minimalistic.
14123 \begin_layout Subsection
14124 Title and Preamble Hacks
14127 \begin_layout Standard
14128 This module provides two new paragraph styles:
14131 \begin_layout Enumerate
14136 which puts whatever is entered into it into the preamble.
14139 to include preamble code in the body of a LyX document.
14142 \begin_layout Enumerate
14147 which that will put its contents into the body of the LaTeX document,
14155 This is useful for making branches and notes in title-related material.
14157 if you put these in a
14162 this signals to LyX to output
14169 which may then come too early.)
14172 \begin_layout Section
14176 \begin_layout Subsection
14180 \begin_layout Standard
14181 This module uses the
14185 package for algorithm floats rather than LyX’s home-brewed algorithm floats.
14186 Use the Algorithm paragraph style to enter and indent the algorithm.
14188 \begin_inset CommandInset href
14190 name "algorithm2e documentation"
14191 target "http://mirrors.ctan.org/macros/latex/contrib/algorithm2e/doc/algorithm2e.pdf"
14199 \begin_layout Subsection
14200 Bilingual Captions AKA Multilingual Captions
14203 \begin_layout Standard
14204 This module provides the paragraph style
14207 \begin_inset space ~
14212 with which to typeset bilingual captions.
14213 Within this paragraph style
14215 Insert\SpecialChar menuseparator
14218 allows you to enter the desired second language using one of the babel names.
14221 File\SpecialChar menuseparator
14222 Open Example\SpecialChar menuseparator
14223 Modules\SpecialChar menuseparator
14224 Multilingual Captions
14228 Help\SpecialChar menuseparator
14229 Specific Manuals\SpecialChar menuseparator
14230 Multilingual Captions
14232 further information on its use.
14235 \begin_layout Subsection
14236 Number Figures by Section
14239 \begin_layout Standard
14240 This module resets the figure number at section start and prepends the section number to the figure number,
14241 as in “Figure 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
14244 \begin_layout Subsection
14245 Number Tables by Section
14248 \begin_layout Standard
14249 This module resets the table number at section start and prepends the section number to the table number,
14250 as in “Table 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
14253 \begin_layout Section
14257 \begin_layout Subsection
14261 \begin_layout Standard
14262 This module adds an endnote inset,
14263 in addition to footnotes.
14269 which has some limitations but works with older \SpecialChar LaTeX
14270 distributions as well.
14273 Insert\SpecialChar menuseparator
14274 Custom Inset\SpecialChar menuseparator
14277 to insert an endnote and
14279 Insert\SpecialChar menuseparator
14280 List/Contents/References\SpecialChar menuseparator
14283 to insert the endnotes list where you want the endnotes to appear.
14286 Help\SpecialChar menuseparator
14297 \begin_layout Subsection
14298 Endnotes (Extended)
14301 \begin_layout Standard
14302 This module adds an endnote inset,
14303 in addition to footnotes.
14308 package which is more powerful and customizable than the
14313 but requires a fairly modern \SpecialChar LaTeX
14314 distribution (with \SpecialChar LaTeX
14318 Insert\SpecialChar menuseparator
14319 Custom Inset\SpecialChar menuseparator
14322 to insert an endnote and
14324 Insert\SpecialChar menuseparator
14325 List/Contents/References\SpecialChar menuseparator
14328 to insert the endnotes list where you want the endnotes to appear.
14331 Help\SpecialChar menuseparator
14342 \begin_layout Subsection
14343 Footnotes as Endnotes (Basic)
14346 \begin_layout Standard
14347 This module sets all footnotes as endnotes.
14353 which has some limitations but works with older \SpecialChar LaTeX
14354 distributions as well.
14357 Insert\SpecialChar menuseparator
14358 List/Contents/References\SpecialChar menuseparator
14361 to insert the endnotes list where you want the endnotes to appear.
14364 Help\SpecialChar menuseparator
14375 \begin_layout Subsection
14376 Footnotes as Endnotes (Extended)
14379 \begin_layout Standard
14380 This module sets all footnotes as endnotes.
14385 package which is more powerful and customizable than then
14390 but requires a fairly modern \SpecialChar LaTeX
14391 distribution (with \SpecialChar LaTeX
14395 Insert\SpecialChar menuseparator
14396 List/Contents/References\SpecialChar menuseparator
14399 to insert the endnotes list where you want the endnotes to appear.
14402 Help\SpecialChar menuseparator
14413 \begin_layout Section
14418 \begin_layout Subsection
14422 \begin_layout Standard
14423 This module provides support for the
14427 package to print chess games.
14430 File\SpecialChar menuseparator
14431 Open Example\SpecialChar menuseparator
14432 Articles\SpecialChar menuseparator
14435 where you will find
14444 \begin_inset CommandInset href
14446 name "chessboard documentation"
14447 target "http://mirrors.ctan.org/macros/latex/contrib/chessboard/chessboard.pdf"
14455 \begin_layout Subsection
14456 Lilypond Music Notation
14459 \begin_layout Standard
14460 This module provides an inset via
14465 nsert\SpecialChar menuseparator
14466 Custom Inset\SpecialChar menuseparator
14469 in which to enter code for the LilyPond music editor.
14470 It will then be processed in the output.
14473 Help\SpecialChar menuseparator
14474 Specific Manuals\SpecialChar menuseparator
14479 File\SpecialChar menuseparator
14480 Open Example\SpecialChar menuseparator
14481 Modules\SpecialChar menuseparator
14485 It cannot be used if the modules
14488 \begin_inset space \thinspace{}
14500 \begin_layout Section
14504 \begin_layout Subsection
14506 \begin_inset CommandInset label
14508 name "subsec:Customizable-Lists"
14515 \begin_layout Standard
14516 This module uses the
14520 package to enable the customization of various list environments.
14523 \begin_layout Subsubsection
14524 Custom Enumerate Lists
14527 \begin_layout Standard
14529 The default numbering of numbered lists can be changed by adding an optional argument (menu
14534 nsert\SpecialChar menuseparator
14541 ) to the first item of each level in the list.
14542 There you add the command
14545 \begin_layout Standard
14553 \begin_layout Standard
14554 in \SpecialChar TeX
14564 \begin_layout Standard
14569 is the first level counter of the enumeration.
14570 To change the numbering for the list sublevels,
14575 ” in the command by the small Roman numeral of the level (
14597 \begin_layout Standard
14604 outputs the counter as a small Roman numeral.
14605 For capital Roman numerals replace
14617 in the command above.
14618 For Arabic numerals use
14626 \begin_inset Quotes eld
14630 \begin_inset Quotes erd
14633 items with capital or small Latin letters use
14649 \begin_layout Standard
14651 \begin_inset Note Greyedout
14654 \begin_layout Plain Layout
14660 You can only number 26
14661 \begin_inset space ~
14664 items with Latin letters,
14665 because this numbering is limited to single letters.
14673 \begin_layout Standard
14674 Here is a list with custom numbering:
14677 \begin_layout Enumerate
14678 \begin_inset Argument 1
14681 \begin_layout Plain Layout
14685 \begin_layout Plain Layout
14704 \begin_inset Separator latexpar
14711 \begin_layout Enumerate
14712 \begin_inset Argument 1
14715 \begin_layout Plain Layout
14719 \begin_layout Plain Layout
14738 \begin_layout Enumerate
14740 \begin_inset Separator latexpar
14747 \begin_layout Enumerate
14748 \begin_inset Argument 1
14751 \begin_layout Plain Layout
14755 \begin_layout Plain Layout
14772 \begin_inset Separator latexpar
14779 \begin_layout Enumerate
14780 \begin_inset Argument 1
14783 \begin_layout Plain Layout
14787 \begin_layout Plain Layout
14809 \begin_layout Standard
14810 For this list these commands were used:
14813 \begin_layout Standard
14824 \begin_inset Newline newline
14832 \begin_inset Newline newline
14840 \begin_inset Newline newline
14850 \begin_layout Standard
14857 makes the label emphasized and
14866 \begin_layout Standard
14867 \begin_inset Note Greyedout
14870 \begin_layout Plain Layout
14876 When you change the label of a list level,
14877 it will be used for all following lists until you change the definition.
14885 \begin_layout Standard
14889 \begin_layout Plain Layout
14907 \begin_layout Subsubsection
14908 Numbered Paragraphs in Reports
14911 \begin_layout Enumerate
14912 Official reports often include numbered paragraphs;
14913 you can achieve this with a variation on the approach outlined in section
14914 \begin_inset space ~
14918 \begin_inset CommandInset ref
14920 reference "sec:How-to-use"
14929 in each command with
14936 \begin_layout Enumerate
14937 These numbered paragraphs were generated by inserting the \SpecialChar TeX
14939 \begin_inset Separator latexpar
14946 \begin_layout Standard
14960 \begin_layout Standard
14961 before the start of the section;
14968 uses the \SpecialChar LaTeX
14969 section counter to generate the first part of the number.
14973 \begin_layout Enumerate
14974 I have ignored the subsection heading in this example because,
14975 with paragraphs numbered in this way,
14976 subsections are less likely to be used.
14979 \begin_layout Subsubsection
14980 Resumed Enumeration
14983 \begin_layout Standard
14987 \begin_layout Plain Layout
15003 \begin_layout Standard
15004 Enumerations can be resumed after intermediate paragraphs:
15007 \begin_layout Enumerate
15008 \begin_inset Argument 1
15011 \begin_layout Plain Layout
15015 \begin_layout Plain Layout
15030 \begin_inset Note Note
15033 \begin_layout Plain Layout
15034 goes back to default numbering
15042 \begin_layout Enumerate
15046 \begin_layout Standard
15050 \begin_layout Enumerate-Resume
15054 \begin_layout Standard
15055 To resume an enumeration,
15063 \begin_layout Standard
15064 \begin_inset Note Greyedout
15067 \begin_layout Plain Layout
15073 If there is no previous enumeration to resume,
15074 you will get a \SpecialChar LaTeX
15083 \begin_layout Standard
15084 Perhaps you might want to resume the list with a different number from the next one.
15085 Or you want to start a new enumeration with a defined number.
15086 This is possible by adding an optional argument to the first list item of a normal enumeration.
15091 \begin_layout Standard
15097 \begin_layout Standard
15102 is the number with which you want to resume the list.
15106 \begin_layout Enumerate
15110 \begin_layout Enumerate
15114 \begin_layout Standard
15115 Enumeration starting at a given value:
15118 \begin_layout Enumerate
15119 \begin_inset Argument 1
15122 \begin_layout Plain Layout
15126 \begin_layout Plain Layout
15138 This enumeration starts at 4
15141 \begin_layout Subsubsection
15143 \begin_inset Index idx
15148 \begin_layout Plain Layout
15158 \begin_layout Standard
15159 In some cases you might want less or more vertical space between the items of a list.
15160 For example if the default space is too much in your opinion in this case:
15163 \begin_layout Itemize
15167 \begin_layout Itemize
15168 with standard spacing
15171 \begin_layout Standard
15172 You can decrease the space by adding an optional argument to the first item of the list.
15173 Add there the command
15177 to get no additional list space like in this example:
15180 \begin_layout Itemize
15181 \begin_inset Argument 1
15184 \begin_layout Plain Layout
15188 \begin_layout Plain Layout
15203 \begin_layout Itemize
15207 \begin_layout Itemize
15211 \begin_layout Standard
15212 To add space you can use several other commands provided by the
15217 \begin_inset Index idx
15222 \begin_layout Plain Layout
15231 For more information see the
15232 \begin_inset CommandInset href
15234 name "enumitem documentation"
15235 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
15243 \begin_layout Standard
15244 There are also many commands available to change the horizontal spacing and indentation.
15245 Here is an example where the indentation was changed to that of the paragraphs in the document and the label separation was set to 2
15246 \begin_inset space \thinspace{}
15249 cm so that the number is in the page margin:
15252 \begin_layout Enumerate
15253 \begin_inset Argument 1
15256 \begin_layout Plain Layout
15260 \begin_layout Plain Layout
15278 \begin_layout Enumerate
15279 with negative indentation
15282 \begin_layout Subsubsection
15283 Further Customization
15284 \begin_inset Index idx
15289 \begin_layout Plain Layout
15299 \begin_layout Standard
15300 You can also change the style of description lists.
15304 \begin_layout Standard
15310 \begin_layout Standard
15311 changes the description label font,
15315 \begin_layout Standard
15324 \begin_layout Standard
15325 sets the list style.
15328 \begin_layout Standard
15329 An example where the command
15332 \begin_layout Standard
15341 \begin_layout Standard
15345 \begin_layout Description
15347 \begin_inset space ~
15352 \begin_inset Argument 1
15355 \begin_layout Plain Layout
15359 \begin_layout Plain Layout
15376 Ionizing radiation consists of particles or electromagnetic waves that are energetic enough to detach electrons from atoms or molecules,
15377 therefore ionizing them.
15380 \begin_layout Description
15382 \begin_inset space ~
15386 In computer science,
15387 reference counting is a technique of storing the number of references,
15389 or handles to a resource such as an object,
15391 disk space or other resource.
15394 \begin_layout Standard
15395 There are many more commands and features provided by the
15400 \begin_inset Index idx
15405 \begin_layout Plain Layout
15414 For more information see the
15415 \begin_inset CommandInset href
15417 name "enumitem documentation"
15418 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
15426 \begin_layout Subsection
15432 \begin_layout Standard
15433 This module uses the package
15437 to provide nine new list environments.
15438 Itemized and enumerated lists can be typeset within paragraphs,
15439 as paragraphs and in a compact version.
15440 Most environments have optional arguments to format the labels.
15442 the \SpecialChar LaTeX
15443 list environments itemize and enumerate are extended to use a similar optional argument.
15444 For further details see
15446 File\SpecialChar menuseparator
15447 Open Example\SpecialChar menuseparator
15448 Modules\SpecialChar menuseparator
15449 Paragraph Lists (paralist)
15454 Help\SpecialChar menuseparator
15455 Specific Manuals\SpecialChar menuseparator
15459 \begin_inset CommandInset href
15461 name "paralist documentation"
15462 target "http://mirrors.ctan.org/macros/latex/contrib/paralist/paralist.pdf"
15470 \begin_layout Section
15471 Literate Programming
15474 \begin_layout Subsection
15478 \begin_layout Standard
15479 This module allows the use of Noweb as a literate programming tool.
15480 The files and the documentation for Noweb can be obtained from
15481 \begin_inset CommandInset href
15484 target "https://www.ctan.org/pkg/noweb"
15490 Literate programming is described in section
15491 \begin_inset space ~
15495 \begin_inset CommandInset ref
15497 reference "sec:Literate-Programming"
15502 and there are three example files:
15505 File\SpecialChar menuseparator
15506 Open Example\SpecialChar menuseparator
15507 Modules\SpecialChar menuseparator
15513 File\SpecialChar menuseparator
15514 Open Example\SpecialChar menuseparator
15515 Modules\SpecialChar menuseparator
15520 File\SpecialChar menuseparator
15521 Open Example\SpecialChar menuseparator
15522 Modules\SpecialChar menuseparator
15523 Noweb2\SpecialChar LyX
15529 \begin_layout Subsection
15533 \begin_layout Standard
15534 This module uses the
15544 \begin_inset Flex Code
15547 \begin_layout Plain Layout
15553 package in R for dynamic report generation has to be installed for this module to work:
15555 \begin_inset Flex Code
15558 \begin_layout Plain Layout
15559 install.packages(“knitr”)
15567 \begin_layout Paragraph
15571 \begin_layout Itemize
15572 it depends on R >= 2.14.1.
15574 \begin_inset Flex URL
15577 \begin_layout Plain Layout
15579 http://yihui.name/knitr
15587 \begin_layout Itemize
15592 also has to be installed.
15595 \begin_layout Itemize
15596 It cannot be used if the modules
15599 \begin_inset space ~
15611 \begin_layout Standard
15614 Help\SpecialChar menuseparator
15615 Specific Manuals\SpecialChar menuseparator
15621 File\SpecialChar menuseparator
15622 Open Example\SpecialChar menuseparator
15623 Modules\SpecialChar menuseparator
15627 \begin_inset space ~
15631 \begin_inset CommandInset ref
15633 reference "sec:Literate-Programming"
15638 for information about literate programming.
15641 \begin_layout Subsection
15645 \begin_layout Standard
15646 This module allows the use of the statistical language S/R as a literate programming tool.
15657 \begin_inset CommandInset href
15660 target "https://www.ctan.org/pkg/includernw"
15666 \begin_inset CommandInset href
15669 target "https://www.ctan.org/pkg/fancyvrb"
15674 are available from CTAN.
15675 It cannot be used if the module
15678 \begin_inset space ~
15686 Help\SpecialChar menuseparator
15687 Specific Manuals\SpecialChar menuseparator
15693 File\SpecialChar menuseparator
15694 Open Example\SpecialChar menuseparator
15695 Modules\SpecialChar menuseparator
15699 \begin_inset space ~
15703 \begin_inset CommandInset ref
15705 reference "sec:Literate-Programming"
15710 for information about literate programming.
15713 \begin_layout Section
15717 \begin_layout Subsection
15721 \begin_layout Standard
15722 This modules defines theorem environments and the proof environment using the extended AMS machinery.
15723 Both numbered and unnumbered types are provided.
15725 the theorems are numbered consecutively throughout the document.
15726 This can be changed by loading one of the
15728 AMS Theorems (Numbered by \SpecialChar ldots
15732 It cannot be used if the modules
15738 Standard Theorems (Unnumbered)
15743 \begin_layout Subsection
15744 AMS Theorems (Extended)
15747 \begin_layout Standard
15748 This module defines some additional theorem environments for use with the
15752 package (which must be loaded).
15811 in both numbered and unnumbered forms.
15814 \begin_layout Subsection
15815 AMS Theorems (Extended,
15816 Numbered by Type within Chapters)
15819 \begin_layout Standard
15820 This module defines some additional theorem environments for use with the
15822 AMS Theorems (Numbered by Type within Chapters)
15824 module (which must be loaded).
15873 in both numbered and unnumbered forms.
15876 \begin_layout Standard
15879 AMS Theorems (Extended)
15882 the different theorem types provided here each have a separate counter,
15883 restarted with each new chapter (e.g.,
15945 \begin_layout Subsection
15946 AMS Theorems (Extended,
15950 \begin_layout Standard
15951 This module defines some additional theorem environments for use with the
15953 AMS Theorems (Numbered by Type)
15955 package (which must be loaded).
16004 in both numbered and unnumbered forms.
16007 \begin_layout Standard
16010 AMS Theorems (Extended)
16013 the different theorem types provided here each have a separate counter (e.g.,
16065 \begin_layout Subsection
16066 AMS Theorems (Numbered by Type within Chapters)
16069 \begin_layout Standard
16070 This module defines theorem environments and the proof environment using the extended AMS machinery.
16071 Both numbered and unnumbered types are provided.
16074 \begin_layout Standard
16080 the different theorem types provided here each have a separate counter (e.g.,
16135 The numbering restarts for each chapter:
16150 \begin_layout Standard
16151 It cannot be used if the modules
16163 Standard Theorems (Numbered by Type)
16167 Standard Theorems (Unnumbered)
16172 \begin_layout Subsection
16173 AMS Theorems (Numbered by Type)
16176 \begin_layout Standard
16177 This module defines theorem environments and the proof environment using the extended AMS machinery.
16178 Both numbered and unnumbered types are provided.
16184 the different theorem types provided here each have a separate counter (e.g.,
16239 The numbering’s scope is the whole document.
16240 For chapter- and section-wide numbering,
16241 use one of the ‘within Sections’/‘within Chapters’ modules,
16245 \begin_layout Standard
16246 It cannot be used if the modules
16258 Standard Theorems (Numbered by Type)
16262 Standard Theorems (Unnumbered)
16267 \begin_layout Subsection
16268 Number Equations by Section
16271 \begin_layout Standard
16272 This module resets the equation number at section start and prepends the section number to the equation number,
16280 \begin_layout Subsection
16284 \begin_layout Standard
16285 This module defines some theorem environments for use with non-AMS classes.
16287 the theorems are numbered consecutively throughout the document.
16288 This can be changed by loading one of the
16290 Standard Theorems (Numbered by \SpecialChar ldots
16296 \begin_layout Standard
16297 It cannot be used if the modules
16303 Standard Theorems (Unnumbered)
16308 \begin_layout Subsection
16309 Standard Theorems (Nameable)
16312 \begin_layout Standard
16313 This module facilitates the use of named theorems.
16314 The name of the theorem can be inserted via
16316 Insert\SpecialChar menuseparator
16317 Additional Theorem Text
16322 \begin_layout Subsection
16323 Standard Theorems (Numbered by Chapter)
16326 \begin_layout Standard
16327 This module numbers theorems and the like by chapter (i.e.,
16328 the counter is reset at each chapter start).
16329 Use this module only with document classes that provide a chapter environment.
16332 \begin_layout Standard
16344 \begin_layout Standard
16345 It cannot be used if the module
16347 Standard Theorems (Numbered by Section)
16352 \begin_layout Subsection
16353 Standard Theorems (Numbered by Section)
16356 \begin_layout Standard
16357 This module numbers theorems and the like by section (i.e.,
16358 the counter is reset at each section start).
16368 It cannot be used if the module
16370 Standard Theorems (Numbered by Chapter)
16375 \begin_layout Subsection
16376 Standard Theorems (Numbered by Type within Chapters)
16379 \begin_layout Standard
16380 This module defines some theorem environments for use with non-AMS classes.
16390 the different theorem types provided here each have a separate counter (e.g.,
16445 The numbering is reset at each chapter start.
16448 \begin_layout Standard
16451 AMS Theorems (Numbered by Type)
16455 Standard Theorems (Numbered by Type)
16460 \begin_layout Standard
16461 It cannot be used if any of the modules
16473 Standard Theorems (Unnumbered)
16478 Standard Theorems (Numbered by Sections)
16482 Standard Theorems (Numbered by Type within Sections)
16487 \begin_layout Subsection
16488 Standard Theorems (Numbered by Type within Sections)
16491 \begin_layout Standard
16492 This module defines some theorem environments for use with non-AMS classes.
16502 the different theorem types provided here each have a separate counter (e.g.,
16557 The numbering is reset at each section start.
16560 \begin_layout Standard
16563 AMS Theorems (Numbered by Type)
16567 Standard Theorems (Numbered by Type)
16572 \begin_layout Standard
16573 It cannot be used if any of the modules
16585 Standard Theorems (Unnumbered)
16590 Standard Theorems (Numbered by Chapters)
16594 Standard Theorems (Numbered by Type within Chapters)
16599 \begin_layout Subsection
16600 Standard Theorems (Numbered by Type)
16603 \begin_layout Standard
16604 This module defines some theorem environments for use with non-AMS classes.
16614 the different theorem types provided here each have a separate counter (e.g.,
16669 The numbering’s scope is the whole document.
16670 For chapter- and section-wide numbering,
16671 use one of the “within Chapters”/“within Sections” modules,
16675 \begin_layout Standard
16676 It cannot be used if any of the modules
16688 Standard Theorems (Unnumbered)
16692 AMS Theorems (Numbered by Type)
16697 \begin_layout Subsection
16698 Standard Theorems (Unnumbered)
16701 \begin_layout Standard
16702 This module defines only unnumbered theorem environments and the proof environment,
16703 using the extended AMS machinery.
16704 It cannot be used if either of the modules
16715 \begin_layout Subsection
16719 \begin_layout Standard
16720 This module provides a straightforward way to segregate subequations in LyX.
16723 Help\SpecialChar menuseparator
16724 Math\SpecialChar menuseparator
16730 \begin_layout Section
16734 \begin_layout Subsection
16735 Custom Header/Footer Text
16738 \begin_layout Standard
16739 This module requires the
16742 \begin_inset space ~
16756 ocument\SpecialChar menuseparator
16761 ettings\SpecialChar menuseparator
16763 \begin_inset space ~
16768 dialog to be set to
16773 It adds six environments to document classes which support the
16780 \begin_layout Itemize
16786 \begin_layout Itemize
16792 \begin_layout Itemize
16798 \begin_layout Itemize
16804 \begin_layout Itemize
16810 \begin_layout Itemize
16816 \begin_layout Subsubsection
16817 Fancy Headers and Footers
16820 \begin_layout Standard
16821 The default page layout is rather plain;
16824 Article (Standard Class)
16827 all you get is a centered page number at the bottom of the page.
16828 This document uses the
16833 so it appears to be a bit fancier.
16836 \begin_layout Standard
16840 \begin_inset space ~
16854 ocument\SpecialChar menuseparator
16859 ettings\SpecialChar menuseparator
16863 \begin_inset Quotes eld
16867 \begin_inset Quotes erd
16871 you will find that the page header is divided into three fields,
16872 not surprisingly labeled
16873 \begin_inset Quotes eld
16877 \begin_inset Quotes erd
16882 \begin_inset Quotes eld
16886 \begin_inset Quotes erd
16891 \begin_inset Quotes eld
16895 \begin_inset Quotes erd
16899 The footer is also divided into these three fields.
16900 The \SpecialChar LaTeX
16901 commands to set these fields in the simplest manner are
16930 Suppose you wish to put your name in the upper left hand corner of each page.
16931 Simply insert the following command in the preamble:
16934 \begin_layout LyX-Code
16941 \begin_layout Standard
16942 You will now see your name in the upper left.
16943 If a field has a default entry that you would like to get rid of (often the page number appears in the central footer) simply include a command with a blank argument,
16945 \begin_inset space \thinspace{}
16951 \begin_layout LyX-Code
16957 \begin_layout Standard
16960 an easier way to make simple changes.
16966 ocument\SpecialChar menuseparator
16971 ettings\SpecialChar menuseparator
16972 Modules\SpecialChar menuseparator
16973 Page Layout\SpecialChar menuseparator
16974 Custom Header/Footer Text
16977 you will find you have six new environments corresponding to the six fields described above.
16980 \begin_layout Standard
16981 Let's get really fancy:
16982 lets put the section number with the word
16983 \begin_inset Quotes eld
16987 \begin_inset Quotes erd
16991 \begin_inset space \thinspace{}
16995 \begin_inset space \space{}
16998 Section 3) in the upper left,
16999 the page number (e.
17000 \begin_inset space \thinspace{}
17004 \begin_inset space \space{}
17007 Page 4) in the upper right,
17008 your name in the lower left,
17009 and the date in the lower right.
17010 Use your newly enabled environments to add these entries:
17013 \begin_layout LyX-Code
17017 \begin_inset space ~
17036 \begin_layout LyX-Code
17042 \begin_layout LyX-Code
17059 \begin_layout LyX-Code
17071 \begin_layout LyX-Code
17077 \begin_layout LyX-Code
17091 \begin_layout Standard
17092 Make sure you enter the commands
17111 as \SpecialChar TeX
17129 access \SpecialChar LaTeX
17130 ’s section and page counters,
17131 and so print out the current section and page numbers.
17138 simply prints out today’s date.
17141 \begin_layout Standard
17142 The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
17143 If you don't want one of the rules,
17144 set its thickness to 0.
17145 The header rule has a default thickness of 0.4pt,
17146 the footer rule is 0pt.
17147 For this you will need to use \SpecialChar TeX
17151 \begin_layout Standard
17158 headrulewidth}{0.4pt}
17163 \begin_layout Standard
17170 footrulewidth}{0.4pt}
17172 to set the thicknesses.
17175 \begin_layout Standard
17176 You can switch the header/footer settings on and off for individual pages using \SpecialChar TeX
17181 thispagestyle{empty}
17188 thispagestyle{plain}
17195 thispagestyle{fancy}
17198 Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
17201 title pages are marked as plain by default,
17202 while following pages are marked fancy when using the global fancy setting.
17205 \begin_layout Standard
17206 If you want a header or footer to be on the outer side of a two sided document,
17207 you need to use something like:
17210 \begin_layout LyX-Code
17216 \begin_layout LyX-Code
17224 \begin_layout Standard
17225 The first command clears all existing footers avoiding any conflicts with your new command.
17228 \begin_layout Standard
17229 You can enter any of these commands,
17230 the simpler ones in any of your new environments,
17231 the more complex ones as \SpecialChar TeX
17233 at any point in your document and they will take effect on the next page.
17236 \begin_layout Standard
17237 As a final example,
17238 it is possible to include an image in the header or footer.
17239 Suppose you want to put a company logo in the upper left hand corner.
17240 You might try something like this in
17242 Document\SpecialChar menuseparator
17243 Settings\SpecialChar menuseparator
17249 \begin_layout LyX-Code
17256 includegraphics{logo.png}}}
17259 \begin_layout Standard
17261 You may need to preface this with
17265 usepackage{graphics}
17267 if you don't include graphics elsewhere in your document.
17270 \begin_layout Standard
17271 For more information on fancy headers,
17273 \begin_inset Flex Code
17276 \begin_layout Plain Layout
17283 \begin_inset CommandInset href
17286 target "http://www.ctan.org/pkg/fancyhdr"
17294 \begin_layout Subsection
17295 Landscape Document Parts
17298 \begin_layout Standard
17299 This module outputs parts of the document in landscape mode using
17301 Insert\SpecialChar menuseparator
17302 Custom Insets\SpecialChar menuseparator
17307 Insert\SpecialChar menuseparator
17308 Custom Insets\SpecialChar menuseparator
17309 Landscape (Floating)
17314 \begin_layout Subsection
17315 \begin_inset CommandInset label
17317 name "sec:Multiple-Columns"
17324 \begin_layout Standard
17325 This module uses the
17330 \begin_inset Index idx
17335 \begin_layout Plain Layout
17343 package and is independent of the option
17356 ocument\SpecialChar menuseparator
17361 ettings\SpecialChar menuseparator
17363 \begin_inset space ~
17369 If you want to have two columns for the whole document,
17370 you are recommended to use the
17379 For all other cases use this module.
17382 \begin_layout Standard
17383 Footnotes within multiple columns will be placed at the bottom of the page and not under each column.
17384 Within the different columns you can use everything,
17385 with the limitation that for floats you need to check the option
17391 \begin_inset space ~
17401 dit\SpecialChar menuseparator
17407 \begin_inset space ~
17415 \begin_layout Subsubsection
17419 \begin_layout Standard
17420 If you want to have two columns in your text,
17421 insert a multicolumn inset via the menu
17423 Insert\SpecialChar menuseparator
17425 \begin_inset space ~
17428 Insets\SpecialChar menuseparator
17430 \begin_inset space ~
17435 where the columns should start.
17436 Write all text that should be printed in 2
17437 \begin_inset space ~
17440 columns into this inset.
17443 \begin_layout Standard
17444 Here is an example:
17447 \begin_layout Standard
17449 \begin_inset Flex Multiple Columns
17452 \begin_layout Plain Layout
17457 The Adventure of the Empty House
17460 \begin_inset Newline newline
17465 Sir Arthur Conan Doyle
17468 \begin_layout Plain Layout
17471 It was in the spring of the year 1894 that all London was interested,
17472 and the fashionable world dismayed,
17473 by the murder of the Honourable Ronald Adair under most unusual and inexplicable circumstances.
17474 The public has already learned those particulars of the crime which came out in the police investigation,
17475 but a good deal was suppressed upon that occasion,
17476 since the case for the prosecution was so overwhelmingly strong that it was not necessary to bring forward all the facts.
17478 at the end of nearly ten years,
17479 am I allowed to supply those missing links which make up the whole of that remarkable chain.
17480 The crime was of interest in itself,
17481 but that interest was as nothing to me compared to the inconceivable sequel,
17482 which afforded me the greatest shock and surprise of any event in my adventurous life.
17484 after this long interval,
17485 I find myself thrilling as I think of it,
17486 and feeling once more that sudden flood of joy,
17488 and incredulity which utterly submerged my mind.
17489 Let me say to that public,
17490 which has shown some interest in those glimpses which I have occasionally given them of the thoughts and actions of a very remarkable man,
17491 that they are not to blame me if I have not shared my knowledge with them,
17492 for I should have considered it my first duty to do so,
17493 had I not been barred by a positive prohibition from his own lips,
17494 which was only withdrawn upon the third of last month.
17502 \begin_layout Standard
17503 To get 3 or more columns,
17504 set the cursor into the multicolumn inset and use the menu
17506 Insert\SpecialChar menuseparator
17508 \begin_inset space ~
17512 \begin_inset space ~
17518 The number of the desired columns is written into that inset (for 3
17519 \begin_inset space ~
17523 \begin_inset Quotes eld
17527 \begin_inset Quotes erd
17531 \begin_inset Newline newline
17534 Here is an example with 3
17535 \begin_inset space ~
17541 \begin_layout Standard
17542 \begin_inset Flex Multiple Columns
17545 \begin_layout Plain Layout
17548 \begin_inset Argument 1
17551 \begin_layout Plain Layout
17558 It can be imagined that my close intimacy with Sherlock Holmes had interested me deeply in crime,
17559 and that after his disappearance I never failed to read with care the various problems which came before the public.
17560 And I even attempted,
17562 for my own private satisfaction,
17563 to employ his methods in their solution,
17564 though with indifferent success.
17567 which appealed to me like this tragedy of Ronald Adair.
17568 As I read the evidence at the inquest,
17569 which led up to a verdict of willful murder against some person or persons unknown,
17570 I realized more clearly than I had ever done the loss which the community had sustained by the death of Sherlock Holmes.
17571 There were points about this strange business which would,
17573 have specially appealed to him,
17574 and the efforts of the police would have been supplemented,
17575 or more probably anticipated,
17576 by the trained observation and the alert mind of the first criminal agent in Europe.
17578 as I drove upon my round,
17579 I turned over the case in my mind and found no explanation which appeared to me to be adequate.
17580 At the risk of telling a twice-told tale,
17581 I will recapitulate the facts as they were known to the public at the conclusion of the inquest.
17589 \begin_layout Standard
17590 You can have up to 10
17591 \begin_inset space ~
17594 columns if you want to,
17595 but that might not be very pleasant for the readers of your document.
17598 \begin_layout Subsubsection
17599 Columns inside Columns
17602 \begin_layout Standard
17603 You can also have columns inside columns:
17606 \begin_layout Standard
17607 \begin_inset Flex Multiple Columns
17610 \begin_layout Plain Layout
17613 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
17614 at that time governor of one of the Australian colonies.
17615 Adair's mother had returned from Australia to undergo the operation for cataract,
17618 and her daughter Hilda were living together at 427 Park Lane.
17621 \begin_layout Plain Layout
17622 \begin_inset Flex Multiple Columns
17625 \begin_layout Plain Layout
17628 The youth moved in the best society
17629 \begin_inset space ~
17633 so far as was known,
17634 no enemies and no particular vices.
17635 He had been engaged to Miss Edith Woodley,
17637 but the engagement had been broken off by mutual consent some months before,
17638 and there was no sign that it had left any very profound feeling behind it.
17639 For the rest {sic} the man's life moved in a narrow and conventional circle,
17640 for his habits were quiet and his nature unemotional.
17641 Yet it was upon this easy-going young aristocrat that death came,
17642 in most strange and unexpected form,
17643 between the hours of ten and eleven-twenty on the night of March 30,
17652 \begin_layout Plain Layout
17655 Ronald Adair was fond of cards
17656 \begin_inset space ~
17659 – playing continually,
17660 but never for such stakes as would hurt him.
17661 He was a member of the Baldwin,
17663 and the Bagatelle card clubs.
17665 after dinner on the day of his death,
17666 he had played a rubber of whist at the latter club.
17667 He had also played there in the afternoon.
17672 The evidence of those who had played with him
17673 \begin_inset space ~
17680 \begin_inset space ~
17683 – showed that the game was whist,
17684 and that there was a fairly equal fall of the cards.
17685 Adair might have lost five pounds,
17687 His fortune was a considerable one,
17688 and such a loss could not in any way affect him.
17689 He had played nearly every day at one club or other,
17690 but he was a cautious player,
17691 and usually rose a winner.
17692 It came out in evidence that,
17693 in partnership with Colonel Moran,
17694 he had actually won as much as four hundred and twenty pounds in a sitting,
17696 from Godfrey Milner and Lord Balmoral.
17697 So much for his recent history as it came out at the inquest.
17705 \begin_layout Subsubsection
17709 \begin_layout Standard
17710 The examples in this section show some more special features of multiple columns.
17713 \begin_layout Standard
17714 For more features of multiple columns,
17716 \begin_inset CommandInset href
17718 name "documentation"
17719 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
17724 of the \SpecialChar LaTeX
17726 \begin_inset Flex Code
17729 \begin_layout Plain Layout
17738 \begin_layout Paragraph
17742 \begin_layout Standard
17743 To add a preface text for multiple columns,
17744 set the cursor into the multicolumn inset and use the menu
17746 Insert\SpecialChar menuseparator
17750 Write your preface text into that inset.
17751 \begin_inset Newline newline
17754 This is an example with some preface text:
17757 \begin_layout Standard
17758 \begin_inset VSpace bigskip
17764 \begin_layout Standard
17765 \begin_inset Flex Multiple Columns
17768 \begin_layout Plain Layout
17769 \begin_inset Argument 2
17772 \begin_layout Plain Layout
17773 And the story continues and continues and continues and continues\SpecialChar ldots
17781 On the evening of the crime,
17782 he returned from the club exactly at ten.
17783 His mother and sister were out spending the evening with a relation.
17784 The servant deposed that she heard him enter the front room on the second floor,
17785 generally used as his sitting-room.
17786 She had lit a fire there,
17787 and as it smoked she had opened the window.
17788 No sound was heard from the room until eleven-twenty,
17789 the hour of the return of Lady Maynooth and her daughter.
17790 Desiring to say good-night,
17791 she attempted to enter her son's room.
17792 The door was locked on the inside,
17793 and no answer could be got to their cries and knocking.
17795 and the door forced.
17796 The unfortunate young man was found lying near the table.
17797 His head had been horribly mutilated by an expanding revolver bullet,
17798 but no weapon of any sort was to be found in the room.
17806 \begin_layout Standard
17807 You can also use a section heading as the preface if you use a section command as \SpecialChar TeX
17809 For example the command
17812 \begin_layout LyX-Code
17815 subsection{subsection title}
17818 \begin_layout Standard
17819 creates a subsection.
17820 In this example the preface is a subsubsection:
17823 \begin_layout Standard
17824 \begin_inset Flex Multiple Columns
17827 \begin_layout Plain Layout
17828 \begin_inset Argument 2
17831 \begin_layout Plain Layout
17835 \begin_layout Plain Layout
17844 This is a subsubsection heading as a preface
17848 \begin_layout Plain Layout
17862 A minute examination of the circumstances served only to make the case more complex.
17863 In the first place,
17864 no reason could be given why the young man should have fastened the door upon the inside.
17865 There was the possibility that the murderer had done this,
17866 and had afterwards escaped by the window.
17867 The drop was at least twenty feet,
17869 and a bed of crocuses in full bloom lay beneath.
17870 Neither the flowers nor the earth showed any sign of having been disturbed,
17871 nor were there any marks upon the narrow strip of grass which separated the house from the road.
17874 it was the young man himself who had fastened the door.
17875 But how did he come by his death?
17876 No one could have climbed up to the window without leaving traces.
17877 Suppose a man had fired through the window,
17878 he would indeed be a remarkable shot who could with a revolver inflict so deadly a wound.
17880 Park Lane is a frequented thoroughfare;
17881 there is a cab stand within a hundred yards of the house.
17882 No one had heard a shot.
17890 \begin_layout Standard
17891 If there is less vertical space than six text lines is left on the page at the beginning of the multiple columns,
17892 a page break will be inserted before the multiple columns.
17893 Depending on the number of lines of the preface text,
17894 you might want to change this space.
17895 This is done by setting the cursor into the mulitcolumn inset behind the preface (if there is any) and using the menu
17897 Insert\SpecialChar menuseparator
17899 \begin_inset space ~
17903 \begin_inset space ~
17907 \begin_inset space ~
17913 Insert into that inset the amount of space like e.
17914 \begin_inset space \thinspace{}
17918 \begin_inset space \space{}
17922 \begin_inset Quotes eld
17926 \begin_inset Quotes erd
17930 \begin_inset Newline newline
17933 In this example the space is set to 7
17934 \begin_inset space ~
17937 text lines by using
17938 \begin_inset Flex Code
17941 \begin_layout Plain Layout
17950 \begin_inset Flex Code
17953 \begin_layout Plain Layout
17961 needs to be inserted as \SpecialChar TeX
17965 \begin_layout Standard
17966 \begin_inset Flex Multiple Columns
17969 \begin_layout Plain Layout
17970 \begin_inset Argument 3
17973 \begin_layout Plain Layout
17978 \begin_layout Plain Layout
17994 On the evening of the crime,
17995 he returned from the club exactly at ten.
17996 His mother and sister were out spending the evening with a relation.
17997 The servant deposed that she heard him enter the front room on the second floor,
17998 generally used as his sitting-room.
17999 She had lit a fire there,
18000 and as it smoked she had opened the window.
18001 No sound was heard from the room until eleven-twenty,
18002 the hour of the return of Lady Maynooth and her daughter.
18003 Desiring to say good-night,
18004 she attempted to enter her son's room.
18005 The door was locked on the inside,
18006 and no answer could be got to their cries and knocking.
18008 and the door forced.
18009 The unfortunate young man was found lying near the table.
18010 His head had been horribly mutilated by an expanding revolver bullet,
18011 but no weapon of any sort was to be found in the room.
18019 \begin_layout Paragraph
18023 \begin_layout Standard
18024 The amount of space before and after multiple columns can be changed by changing the length
18025 \begin_inset Flex Code
18028 \begin_layout Plain Layout
18037 For example the command
18040 \begin_layout LyX-Code
18048 \begin_layout Standard
18049 in \SpecialChar TeX
18050 Code changes its value to 3
18051 \begin_inset space \thinspace{}
18055 The change must be made before the multiple columns' start.
18056 The predefined value is 13
18057 \begin_inset space \thinspace{}
18063 \begin_layout Standard
18065 \begin_inset Flex Code
18068 \begin_layout Plain Layout
18077 \begin_inset space \thinspace{}
18083 \begin_layout Standard
18087 \begin_layout Plain Layout
18093 multicolsep}{2.5cm}
18101 \begin_layout Standard
18102 \begin_inset Flex Multiple Columns
18105 \begin_layout Plain Layout
18108 All day I turned these facts over in my mind,
18109 endeavouring to hit upon some theory which could reconcile them all,
18110 and to find that line of least resistance which my poor friend had declared to be the starting-point of every investigation.
18111 I confess that I made little progress.
18112 In the evening I strolled across the Park,
18113 and found myself about six o'clock at the Oxford Street end of Park Lane.
18114 A group of loafers upon the pavements,
18115 all staring up at a particular window,
18116 directed me to the house which I had come to see.
18118 thin man with coloured glasses,
18119 whom I strongly suspected of being a plain-clothes detective,
18120 was pointing out some theory of his own,
18121 while the others crowded round to listen to what he said.
18122 I got as near him as I could,
18123 but his observations seemed to me to be absurd,
18124 so I withdrew again in some disgust.
18125 As I did so I struck against an elderly,
18127 who had been behind me,
18128 and I knocked down several books which he was carrying.
18136 \begin_layout Standard
18137 \begin_inset Note Greyedout
18140 \begin_layout Plain Layout
18146 The values you set with
18147 \begin_inset Flex Code
18150 \begin_layout Plain Layout
18158 will be used for all following multiple columns until you change them again.
18166 \begin_layout Standard
18170 \begin_layout Plain Layout
18182 \begin_inset Note Note
18185 \begin_layout Plain Layout
18186 go back to the default
18194 \begin_layout Paragraph
18198 \begin_layout Standard
18199 A column break can be forced by inserting the command
18200 \begin_inset Flex Code
18203 \begin_layout Plain Layout
18211 as \SpecialChar TeX
18212 Code to that position in the text where the column should be broken.
18213 Note that this leads in most cases to whitespace in the text.
18214 \begin_inset Newline newline
18217 Here is an example:
18220 \begin_layout Standard
18221 \begin_inset Flex Multiple Columns
18224 \begin_layout Plain Layout
18227 \begin_inset Quotes eld
18230 You're surprised to see me,
18232 \begin_inset Quotes erd
18240 \begin_layout Plain Layout
18243 I acknowledged that I was.
18246 \begin_layout Plain Layout
18249 \begin_inset Quotes eld
18255 and when I chanced to see you go into this house,
18256 as I came hobbling after you,
18257 I thought to myself,
18258 I'll just step in and see that kind gentleman,
18259 and tell him that if I was a bit gruff in my manner there was not any harm meant,
18260 and that I am much obliged to him for picking up my books.
18261 \begin_inset Quotes erd
18267 \begin_layout Plain Layout
18270 \begin_inset Quotes eld
18273 You make too much of a trifle,
18274 \begin_inset Quotes erd
18279 \begin_inset Quotes eld
18282 May I ask how you knew who I was?
18283 \begin_inset Quotes erd
18286 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
18290 \begin_layout Plain Layout
18302 \begin_layout Plain Layout
18305 \begin_inset Quotes eld
18310 if it isn't too great a liberty,
18311 I am a neighbour of yours,
18312 for you'll find my little bookshop at the corner of Church Street,
18313 and very happy to see you,
18315 Maybe you collect yourself,
18320 \begin_inset space ~
18336 \begin_inset space ~
18341 With five volumes you could just fill that gap on that second shelf.
18345 \begin_inset Quotes erd
18356 \begin_layout Paragraph
18360 \begin_layout Standard
18361 The width of the columns is automatically calculated,
18362 but you can modify the space between the columns.
18363 This is done by changing the length
18364 \begin_inset Flex Code
18367 \begin_layout Plain Layout
18376 Its predefined value is 10
18377 \begin_inset space \thinspace{}
18381 Here is an example where
18382 \begin_inset Flex Code
18385 \begin_layout Plain Layout
18394 \begin_inset space \thinspace{}
18400 \begin_layout Standard
18404 \begin_layout Plain Layout
18418 \begin_layout Standard
18419 \begin_inset Flex Multiple Columns
18422 \begin_layout Plain Layout
18425 My observations of No.
18426 \begin_inset space \space{}
18429 427 Park Lane did little to clear up the problem in which I was interested.
18430 The house was separated from the street by a low wall and railing,
18431 the whole not more than five feet high.
18432 It was perfectly easy,
18434 for anyone to get into the garden,
18435 but the window was entirely inaccessible,
18436 since there was no water pipe or anything which could help the most active man to climb it.
18437 More puzzled than ever,
18438 I retraced my steps to Kensington.
18439 I had not been in my study five minutes when the maid entered to say that a person desired to see me.
18440 To my astonishment it was none other than my strange old book collector,
18442 wizened face peering out from a frame of white hair,
18443 and his precious volumes,
18444 a dozen of them at least,
18445 wedged under his right arm.
18453 \begin_layout Standard
18457 \begin_layout Plain Layout
18469 \begin_inset Note Note
18472 \begin_layout Plain Layout
18473 go back to the default
18481 \begin_layout Paragraph
18485 \begin_layout Standard
18486 Between the columns a rule with a width of the length
18487 \begin_inset Flex Code
18490 \begin_layout Plain Layout
18499 If this rule width is set to 0
18500 \begin_inset space \thinspace{}
18503 pt (this is the default),
18504 the rule is suppressed.
18505 In the following example the rule is 2
18506 \begin_inset space \thinspace{}
18512 \begin_layout Standard
18516 \begin_layout Plain Layout
18522 columnseprule}{2pt}
18530 \begin_layout Standard
18531 \begin_inset Flex Multiple Columns
18534 \begin_layout Plain Layout
18537 \begin_inset Quotes eld
18540 You're surprised to see me,
18542 \begin_inset Quotes erd
18550 \begin_layout Plain Layout
18553 I acknowledged that I was.
18556 \begin_layout Plain Layout
18559 \begin_inset Quotes eld
18565 and when I chanced to see you go into this house,
18566 as I came hobbling after you,
18567 I thought to myself,
18568 I'll just step in and see that kind gentleman,
18569 and tell him that if I was a bit gruff in my manner there was not any harm meant,
18570 and that I am much obliged to him for picking up my books.
18571 \begin_inset Quotes erd
18577 \begin_layout Plain Layout
18580 \begin_inset Quotes eld
18583 You make too much of a trifle,
18584 \begin_inset Quotes erd
18589 \begin_inset Quotes eld
18592 May I ask how you knew who I was?
18593 \begin_inset Quotes erd
18599 \begin_layout Plain Layout
18602 \begin_inset Quotes eld
18607 if it isn't too great a liberty,
18608 I am a neighbour of yours,
18609 for you'll find my little bookshop at the corner of Church Street,
18610 and very happy to see you,
18612 Maybe you collect yourself,
18617 \begin_inset space ~
18633 \begin_inset space ~
18638 With five volumes you could just fill that gap on that second shelf.
18642 \begin_inset Quotes erd
18653 \begin_layout Standard
18654 \begin_inset VSpace defskip
18660 \begin_layout Standard
18661 The rule can be colored by redefining the command
18662 \begin_inset Flex Code
18665 \begin_layout Plain Layout
18674 This is done by inserting the command
18677 \begin_layout LyX-Code
18682 columnseprulecolor}{
18687 \begin_layout Standard
18688 as \SpecialChar TeX
18689 Code before the multicolumn inset.
18691 \begin_inset Flex Code
18694 \begin_layout Plain Layout
18700 in this command by a color of your choice.
18701 You can use all pre- and self-defined colors.
18710 \begin_inset space ~
18715 for more information about pre- and self-defined colors.
18716 To go back to the default color insert the command
18719 \begin_layout LyX-Code
18724 columnseprulecolor}{
18729 \begin_layout Standard
18730 Here is the example with a cyan rule and 1
18731 \begin_inset space \thinspace{}
18734 cm column separation:
18737 \begin_layout Standard
18741 \begin_layout Plain Layout
18750 \begin_layout Plain Layout
18756 columnseprulecolor}{
18766 \begin_layout Standard
18767 \begin_inset Flex Multiple Columns
18770 \begin_layout Plain Layout
18773 \begin_inset Quotes eld
18776 You're surprised to see me,
18778 \begin_inset Quotes erd
18786 \begin_layout Plain Layout
18789 I acknowledged that I was.
18792 \begin_layout Plain Layout
18795 \begin_inset Quotes eld
18801 and when I chanced to see you go into this house,
18802 as I came hobbling after you,
18803 I thought to myself,
18804 I'll just step in and see that kind gentleman,
18805 and tell him that if I was a bit gruff in my manner there was not any harm meant,
18806 and that I am much obliged to him for picking up my books.
18807 \begin_inset Quotes erd
18813 \begin_layout Plain Layout
18816 \begin_inset Quotes eld
18819 You make too much of a trifle,
18820 \begin_inset Quotes erd
18825 \begin_inset Quotes eld
18828 May I ask how you knew who I was?
18829 \begin_inset Quotes erd
18835 \begin_layout Plain Layout
18838 \begin_inset Quotes eld
18843 if it isn't too great a liberty,
18844 I am a neighbour of yours,
18845 for you'll find my little bookshop at the corner of Church Street,
18846 and very happy to see you,
18848 Maybe you collect yourself,
18853 \begin_inset space ~
18869 \begin_inset space ~
18874 With five volumes you could just fill that gap on that second shelf.
18878 \begin_inset Quotes erd
18889 \begin_layout Standard
18893 \begin_layout Plain Layout
18899 columnseprule}{0pt}
18902 \begin_layout Plain Layout
18908 columnseprulecolor}{
18916 \begin_inset Note Note
18919 \begin_layout Plain Layout
18920 go back to the default
18928 \begin_layout Section
18932 \begin_layout Subsection
18933 Custom Paragraph Shapes
18936 \begin_layout Standard
18939 as well as any other text processor uses by default rectangular paragraphs.
18940 For special cases like for example posters,
18941 invitation cards or poems you can modify the paragraph shape to one of your choice.
18942 This module uses the
18946 package to provide over a dozen paragraph shapes as well as commands to define custom shapes.
18949 \begin_layout Subsubsection
18953 \begin_layout Standard
18958 package provides the following shapes:
18961 \begin_layout Standard
18962 \begin_inset Tabular
18963 <lyxtabular version="3" rows="13" columns="3">
18964 <features booktabs="true" islongtable="true" longtabularalignment="center">
18965 <column alignment="left" valignment="middle" width="16col%">
18966 <column alignment="left" valignment="middle" width="40col%">
18967 <column alignment="left" valignment="middle" width="35col%">
18968 <row endhead="true">
18969 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
18972 \begin_layout Plain Layout
18981 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
18984 \begin_layout Plain Layout
18993 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
18996 \begin_layout Plain Layout
19006 <row interlinespace="default">
19007 <cell alignment="left" valignment="top" usebox="none">
19010 \begin_layout Plain Layout
19018 <cell alignment="left" valignment="top" usebox="none">
19021 \begin_layout Plain Layout
19024 Circle with circular hole (in the size of a CD/DVD)
19029 <cell alignment="left" valignment="top" usebox="none">
19032 \begin_layout Plain Layout
19036 take care there is not too much text
19042 <row interlinespace="default">
19043 <cell alignment="left" valignment="top" usebox="none">
19046 \begin_layout Plain Layout
19054 <cell alignment="left" valignment="top" usebox="none">
19057 \begin_layout Plain Layout
19065 <cell alignment="left" valignment="top" usebox="none">
19068 \begin_layout Plain Layout
19072 calculation might fail
19078 <row interlinespace="default">
19079 <cell alignment="left" valignment="top" usebox="none">
19082 \begin_layout Plain Layout
19090 <cell alignment="left" valignment="top" usebox="none">
19093 \begin_layout Plain Layout
19096 Rhomboid (symbolizing a
19097 \begin_inset Quotes eld
19101 \begin_inset Quotes erd
19109 <cell alignment="left" valignment="top" usebox="none">
19112 \begin_layout Plain Layout
19121 <row interlinespace="default">
19122 <cell alignment="left" valignment="top" usebox="none">
19125 \begin_layout Plain Layout
19133 <cell alignment="left" valignment="top" usebox="none">
19136 \begin_layout Plain Layout
19144 <cell alignment="left" valignment="top" usebox="none">
19147 \begin_layout Plain Layout
19156 <row interlinespace="default">
19157 <cell alignment="left" valignment="top" usebox="none">
19160 \begin_layout Plain Layout
19168 <cell alignment="left" valignment="top" usebox="none">
19171 \begin_layout Plain Layout
19179 <cell alignment="left" valignment="top" usebox="none">
19182 \begin_layout Plain Layout
19191 <row interlinespace="default">
19192 <cell alignment="left" valignment="top" usebox="none">
19195 \begin_layout Plain Layout
19203 <cell alignment="left" valignment="top" usebox="none">
19206 \begin_layout Plain Layout
19209 Nut for bolt (hexagon with circular hole)
19214 <cell alignment="left" valignment="top" usebox="none">
19217 \begin_layout Plain Layout
19226 <row interlinespace="default">
19227 <cell alignment="left" valignment="top" usebox="none">
19230 \begin_layout Plain Layout
19238 <cell alignment="left" valignment="top" usebox="none">
19241 \begin_layout Plain Layout
19249 <cell alignment="left" valignment="top" usebox="none">
19252 \begin_layout Plain Layout
19261 <row interlinespace="default">
19262 <cell alignment="left" valignment="top" usebox="none">
19265 \begin_layout Plain Layout
19273 <cell alignment="left" valignment="top" usebox="none">
19276 \begin_layout Plain Layout
19284 <cell alignment="left" valignment="top" usebox="none">
19287 \begin_layout Plain Layout
19296 <row interlinespace="default">
19297 <cell alignment="left" valignment="top" usebox="none">
19300 \begin_layout Plain Layout
19308 <cell alignment="left" valignment="top" usebox="none">
19311 \begin_layout Plain Layout
19319 <cell alignment="left" valignment="top" usebox="none">
19322 \begin_layout Plain Layout
19331 <row interlinespace="default">
19332 <cell alignment="left" valignment="top" usebox="none">
19335 \begin_layout Plain Layout
19343 <cell alignment="left" valignment="top" usebox="none">
19346 \begin_layout Plain Layout
19349 Normal/reversed rain drop
19354 <cell alignment="left" valignment="top" usebox="none">
19357 \begin_layout Plain Layout
19361 calculation might fail
19367 <row interlinespace="default">
19368 <cell alignment="left" valignment="top" usebox="none">
19371 \begin_layout Plain Layout
19380 <cell alignment="left" valignment="top" usebox="none">
19383 \begin_layout Plain Layout
19386 The \SpecialChar TeX
19392 <cell alignment="left" valignment="top" usebox="none">
19395 \begin_layout Plain Layout
19404 <row interlinespace="default">
19405 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
19408 \begin_layout Plain Layout
19412 \begin_inset Newline newline
19420 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
19423 \begin_layout Plain Layout
19426 Triangles in different orientations
19431 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
19434 \begin_layout Plain Layout
19450 \begin_layout Standard
19451 To use a shape for your paragraph,
19452 simply select it in \SpecialChar LyX
19453 's pull-down box for environments in the toolbar.
19456 \begin_layout Standard
19457 \begin_inset Newpage newpage
19463 \begin_layout Standard
19464 Here is an example paragraph in the shape of a nut:
19467 \begin_layout Standard
19468 \begin_inset VSpace bigskip
19477 Lorem ipsum dolor sit amet,
19478 consetetur sadipscing elitr,
19479 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19481 At vero eos et accusam et justo duo dolores et ea rebum.
19482 Stet clita kasd gubergren,
19483 no sea takimata sanctus est Lorem ipsum dolor sit amet.
19484 Lorem ipsum dolor sit amet,
19485 consetetur sadipscing elitr,
19486 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19490 \begin_layout Standard
19491 \begin_inset VSpace bigskip
19497 \begin_layout Standard
19498 \begin_inset Note Greyedout
19501 \begin_layout Plain Layout
19511 paragraphs cannot run over a page break.
19519 \begin_layout Standard
19520 \begin_inset VSpace bigskip
19526 \begin_layout Standard
19528 \begin_inset Flex Code
19531 \begin_layout Plain Layout
19537 takes care that the shape will always be preserved,
19538 no matter how much text is in the paragraph.
19539 Therefore the paragraph size changes with the amount of contained text.
19540 This can lead to paragraph sizes exceeding the page margins.
19541 To demonstrate the size scaling,
19542 here is the same example paragraph but with twice as much text:
19545 \begin_layout Standard
19546 \begin_inset Newpage newpage
19555 Lorem ipsum dolor sit amet,
19556 consetetur sadipscing elitr,
19557 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19559 At vero eos et accusam et justo duo dolores et ea rebum.
19560 Stet clita kasd gubergren,
19561 no sea takimata sanctus est Lorem ipsum dolor sit amet.
19562 Lorem ipsum dolor sit amet,
19563 consetetur sadipscing elitr,
19564 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19566 Lorem ipsum dolor sit amet,
19567 consetetur sadipscing elitr,
19568 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19570 At vero eos et accusam et justo duo dolores et ea rebum.
19571 Stet clita kasd gubergren,
19572 no sea takimata sanctus est Lorem ipsum dolor sit amet.
19573 Lorem ipsum dolor sit amet,
19574 consetetur sadipscing elitr,
19575 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19579 \begin_layout Standard
19580 \begin_inset VSpace bigskip
19586 \begin_layout Standard
19587 An exception is the shape
19592 It cannot be scaled because it must fit the size of a CD/DVD.
19593 Therefore the amount of text that fits into the shape is limited.
19596 \begin_layout Standard
19606 meaning that the calculation of their size can fail,
19607 depending on the amount of text.
19608 You will then get the \SpecialChar LaTeX
19610 \begin_inset Quotes eld
19613 Arithmetic overflow
19614 \begin_inset Quotes erd
19618 In this case one can try to remove or add some text;
19619 if nothing works one has to use another shape.
19622 \begin_layout Standard
19623 For shapes with tips you will maybe see that \SpecialChar LaTeX
19624 's hyphenation routine fails for text in the tips.
19625 Therefore it is often necessary to add hyphenation points
19630 arg "specialchar-insert hyphenation"
19635 ) to the corresponding text parts.
19638 \begin_layout Standard
19639 Shapepar paragraphs are either always centered or placed on the page so that their left border touches the left page margin.
19640 You can therefore not use the paragraph dialog to align such paragraphs.
19641 A solution is to put the paragraph into a minipage or parbox and align the box.
19642 The problem is hereby to find the right width for the box.
19643 Because if it is too wide and you center the box,
19644 the paragraph is not centered too because it sticks at the left side of the box.
19645 So you might have to play a bit with the width until it fits.
19646 Here are two heart-shaped paragraphs,
19647 the first one is not aligned,
19648 the second one is right-aligned:
19651 \begin_layout Standard
19652 \begin_inset Newpage newpage
19658 \begin_layout Heart
19662 Lo\SpecialChar softhyphen
19663 rem ipsum dolor sit amet,
19664 consetetur sadipscing elitr,
19665 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19667 At vero eos et accusam et justo duo dolores et ea rebum.
19668 Stet clita kasd gubergren,
19669 no sea takimata sanctus est Lorem ipsum dolor sit amet.
19672 \begin_layout Standard
19673 \begin_inset VSpace bigskip
19679 \begin_layout Standard
19682 \begin_inset Box Frameless
19692 height_special "totalheight"
19697 backgroundcolor "none"
19700 \begin_layout Heart
19704 Lo\SpecialChar softhyphen
19705 rem ipsum dolor sit amet,
19706 consetetur sadipscing elitr,
19707 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19709 At vero eos et accusam et justo duo dolores et ea rebum.
19710 Stet clita kasd gubergren,
19711 no sea takimata sanctus est Lorem ipsum dolor sit amet.
19719 \begin_layout Subsubsection
19723 \begin_layout Standard
19724 You can define any shape you want.
19725 Doing this manually is a lot of work because every coordinate must be specified.
19726 But there is a way to let the computer calculate the coordinates:
19729 \begin_layout Enumerate
19730 Install the program
19731 \begin_inset CommandInset href
19734 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
19742 \begin_layout Enumerate
19749 TeX/LaTeX\SpecialChar menuseparator
19750 Settings\SpecialChar menuseparator
19753 and select the font size you are using in your document.
19754 For example this document uses the size 12
19755 \begin_inset space \thinspace{}
19761 \begin_layout Enumerate
19765 \begin_layout Enumerate
19768 TeX/LaTeX\SpecialChar menuseparator
19771 to export the shape to coordinates.
19772 In the appearing dialog use either the outline of your shape for the coordinates or the path itself.
19776 \begin_layout Plain Layout
19777 For more information see
19778 \begin_inset CommandInset href
19780 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
19793 \begin_layout Standard
19794 The coordinates are written into a \SpecialChar TeX
19796 To use it for your \SpecialChar LyX
19800 \begin_layout Enumerate
19801 Place the cursor before the first character of your paragraph (or into a new empty one).
19804 \begin_layout Enumerate
19805 Open in \SpecialChar LyX
19808 Insert\SpecialChar menuseparator
19809 File\SpecialChar menuseparator
19811 \begin_inset space ~
19817 select the file and use
19826 \begin_layout Standard
19827 \begin_inset VSpace defskip
19833 \begin_layout Standard
19834 \begin_inset Note Greyedout
19837 \begin_layout Plain Layout
19843 The changed shape only applies to the current paragraph;
19844 everything is reset to normal for the next paragraph.
19845 Therefore the shape definition file must be input into every paragraph with the desired shape.
19853 \begin_layout Standard
19854 \begin_inset VSpace bigskip
19860 \begin_layout Standard
19861 Here is an example:
19864 \begin_layout Standard
19865 \begin_inset VSpace bigskip
19871 \begin_layout Standard
19872 \begin_inset CommandInset include
19874 filename "SpecialParagraphShape.tex"
19881 Lorem ipsum dolor sit amet,
19882 consetetur sadipscing elitr,
19883 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19885 At vero eos et accusam et justo duo dolores et ea rebum.
19886 Stet clita kasd gubergren,
19887 no sea takimata sanctus est Lorem ipsum dolor sit amet.
19888 Lorem ipsum dolor sit amet,
19889 consetetur sadipscing elitr,
19890 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19894 \begin_layout Standard
19895 \begin_inset VSpace bigskip
19901 \begin_layout Standard
19907 to draw complexer shapes in
19911 you can draw the shape in a program of your choice and import the resulting image to
19916 Then you only need to draw a line or spline along the outline of the image.
19919 \begin_layout Standard
19922 Custom paragraph shapes
19924 also provides the two commands
19932 which can be used to define custom shapes coordinate by coordinate.
19936 \begin_layout Plain Layout
19937 These commands are internally used for all shapes described here.
19942 For information how these styles are used and about further customization possibilities,
19944 \begin_inset CommandInset href
19946 name "documentation"
19947 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
19953 \begin_inset Flex Code
19956 \begin_layout Plain Layout
19965 \begin_layout Subsection
19969 \begin_layout Hanging
19970 This module adds the
19976 one where all but the first line of the paragraph is indented.
19977 This may not appear in your \SpecialChar LyX
19978 document but will appear in the final output.
19981 \begin_layout Subsection
19982 \begin_inset CommandInset label
19984 name "subsec:Initials"
19988 Initials (Drop Caps)
19991 \begin_layout Initial
19992 \begin_inset Argument 2
19995 \begin_layout Plain Layout
20002 \begin_inset Argument 3
20005 \begin_layout Plain Layout
20011 module adds a drop capitals paragraph style
20015 for paragraph environments which you can use wherever you want to have drop capitals.
20016 You then have three more items in the
20023 \begin_layout Itemize
20028 which creates an inset for the drop capital
20031 \begin_layout Itemize
20036 which creates an inset for the rest of the word
20039 \begin_layout Itemize
20044 which allow you configure the formatting of the drop capital.
20047 \begin_layout Standard
20048 To customize the appearance of the style,
20051 Help\SpecialChar menuseparator
20052 Embedded Objects\SpecialChar menuseparator
20053 Objects Surrounded by Text\SpecialChar menuseparator
20059 \begin_layout Section
20063 \begin_layout Subsection
20064 Hyphenatable Text Markup (Soul)
20067 \begin_layout Standard
20068 This modul defines text styles to highlight,
20071 underline and capitalize/small-cap text by means of the
20078 \begin_layout Standard
20079 As opposed to the markup provided by the Text Properties dialog,
20080 words marked-up with
20086 \begin_inset CommandInset href
20088 name "soul documentation"
20089 target "http://mirrors.ctan.org/macros/generic/soul/soul.pdf"
20097 \begin_layout Subsection
20101 \begin_layout Standard
20102 This module defines some character styles for logical markup:
20106 \begin_inset Flex Noun
20109 \begin_layout Plain Layout
20123 \begin_inset Flex Emph
20126 \begin_layout Plain Layout
20138 \begin_inset Flex Strong
20141 \begin_layout Plain Layout
20149 \begin_inset Flex Code
20152 \begin_layout Plain Layout
20158 which are accessed via the
20163 dit\SpecialChar menuseparator
20165 \begin_inset space ~
20169 \begin_inset space ~
20181 \begin_layout Chapter
20185 \begin_layout Standard
20186 The most basic information about how to use Bib\SpecialChar TeX
20191 with \SpecialChar LyX
20192 is contained in the section
20194 Bibliography databases
20201 The following subsections explain special bibliography features supported by \SpecialChar LyX
20205 \begin_layout Section
20206 Alternative Citation Styles
20209 \begin_layout Standard
20210 Standard Bib\SpecialChar TeX
20212 \begin_inset space \thinspace{}
20216 \begin_inset space \space{}
20220 \begin_inset Quotes eld
20224 \begin_inset Quotes erd
20227 ) to refer to a cited work.
20229 in many scientific disciplines,
20230 other citation styles are in use.
20231 The most common one is the author-year style (e.
20232 \begin_inset space \thinspace{}
20236 \begin_inset space \space{}
20240 \begin_inset Quotes eld
20244 \begin_inset Quotes erd
20249 supports three packages that provide this style,
20251 \begin_inset Flex Code
20254 \begin_layout Plain Layout
20262 \begin_inset Flex Code
20265 \begin_layout Plain Layout
20273 \begin_inset Flex Code
20276 \begin_layout Plain Layout
20283 Each of these packages has their pros and cons,
20284 which cannot be listed in detail.
20285 If you only want to have simple author-year (or author-numerical) style,
20286 or if you want to use one of the countless style files for
20287 \begin_inset Flex Code
20290 \begin_layout Plain Layout
20297 then the established
20298 \begin_inset Flex Code
20301 \begin_layout Plain Layout
20307 package is probably your choice.
20308 If you look for specific citation styles common in law studies,
20309 you might consider the
20310 \begin_inset Flex Code
20313 \begin_layout Plain Layout
20320 If you want to have full control over the formatting or look for advanced features such as ibidem,
20321 footnote citations,
20322 full title citations,
20323 advanced date formats (such as 400 BC) or full localization to other languages than English,
20324 you should definitely consider
20325 \begin_inset Flex Code
20328 \begin_layout Plain Layout
20335 which exceeds all other packages in terms of features,
20336 but is also quite heavy and more resource-hungry.
20339 \begin_layout Standard
20340 The handling of these packages in \SpecialChar LyX
20341 is basically the same.
20344 Document\SpecialChar menuseparator
20367 Biblatex (Natbib mode)
20379 \begin_inset space ~
20382 6.5.3 in the User's Guide for more information on these choices).
20383 With all these packages,
20384 you will get some extra features in the citation dialog and you can select the style of the reference (
20385 \begin_inset Quotes eld
20389 \begin_inset Quotes erd
20394 \begin_inset Quotes eld
20398 \begin_inset Quotes erd
20403 \begin_inset Quotes eld
20408 \begin_inset Quotes erd
20413 \begin_inset Quotes eld
20417 \begin_inset Quotes erd
20421 Note that either package needs specifically designed style files.
20422 They all ship their own,
20423 but there are lots of additional style files,
20424 and there is even an interactive style file builder
20428 \begin_layout Plain Layout
20430 \begin_inset Flex URL
20433 \begin_layout Plain Layout
20435 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
20446 \begin_inset Flex Code
20449 \begin_layout Plain Layout
20458 \begin_layout Section
20459 Subdivided Bibliographies
20462 \begin_layout Standard
20463 Sometimes you might need to divide your bibliography into several sections.
20464 If you are for instance a historian,
20465 the possibility to separate sources and scientific works is most likely a
20466 \begin_inset Quotes eld
20470 \begin_inset Quotes erd
20475 Bib\SpecialChar TeX
20476 itself does not allow you to do this.
20477 But with the help of some \SpecialChar LaTeX
20479 Bib\SpecialChar TeX
20480 can be extended to fit your needs.
20483 \begin_layout Standard
20485 provides native support for one of these packages,
20494 \begin_layout Plain Layout
20496 \begin_inset Flex URL
20499 \begin_layout Plain Layout
20501 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
20511 The advantage of this package (compared to other packages such as
20515 ) is that you don't need to define new citation commands.
20517 you need to prepare different bibliographic databases which include the entries for the different sections of the bibliography.
20519 If you want to divide your bibliography into the sections
20520 \begin_inset Quotes eld
20524 \begin_inset Quotes erd
20528 \begin_inset Quotes eld
20532 \begin_inset Quotes erd
20536 you first need to create two bibliographic databases,
20538 \begin_inset space \thinspace{}
20542 \begin_inset space \space{}
20546 \begin_inset Flex Code
20549 \begin_layout Plain Layout
20556 \begin_inset Flex Code
20559 \begin_layout Plain Layout
20569 \begin_layout Standard
20572 Document\SpecialChar menuseparator
20581 Subdivided bibliography
20584 Now you can insert multiple Bib\SpecialChar TeX
20586 one for each section of your bibliography.
20587 Returning to our example:
20588 Insert the Bib\SpecialChar TeX
20590 \begin_inset Flex Code
20593 \begin_layout Plain Layout
20599 and a second one for the database
20600 \begin_inset Flex Code
20603 \begin_layout Plain Layout
20610 You are free to use the same or different styles for each section.
20612 you can choose if the bibliography section should contain
20613 \begin_inset Quotes eld
20616 all cited references
20617 \begin_inset Quotes erd
20620 of the specified database(s) (which is the default),
20622 \begin_inset Quotes eld
20625 all uncited references
20626 \begin_inset Quotes erd
20630 \begin_inset Quotes eld
20634 \begin_inset Quotes erd
20638 This might be useful if you would like to separate your bibliography into three sections:
20640 \begin_inset Quotes eld
20644 \begin_inset Quotes erd
20649 \begin_inset Quotes eld
20653 \begin_inset Quotes erd
20658 \begin_inset Quotes eld
20662 \begin_inset Quotes erd
20666 The titles for the sections can be added as ordinary sections or subsections.
20668 \begin_inset Flex Code
20671 \begin_layout Plain Layout
20677 removes the bibliography title,
20678 you have to manually re-add that,
20679 too (as a chapter* or section*,
20683 \begin_layout Standard
20689 the procedure is a bit different.
20700 \begin_inset Flex Noun
20703 \begin_layout Plain Layout
20704 Subdivided bibliography
20709 option is disabled if you use
20719 provides its own means to generate subdivided bibliographies.
20720 You can either add keywords to bibliography entries via the
20721 \begin_inset Flex Code
20724 \begin_layout Plain Layout
20730 entry option and then filter bibliography sections by keyword (by adding
20731 \begin_inset Flex Code
20734 \begin_layout Plain Layout
20741 \begin_inset Flex Noun
20744 \begin_layout Plain Layout
20750 field of the dialog that opens if you left-click on the
20751 \begin_inset Flex Noun
20754 \begin_layout Plain Layout
20755 Biblatex Generated Bibliography
20761 or you can filter by entry types (such as
20770 \begin_inset space \thinspace{}
20775 \begin_inset Flex Code
20778 \begin_layout Plain Layout
20785 \begin_inset Flex Code
20788 \begin_layout Plain Layout
20795 \begin_inset Flex Noun
20798 \begin_layout Plain Layout
20805 or you can create so-called
20806 \begin_inset Quotes eld
20809 Bibliography Categories
20810 \begin_inset Quotes erd
20813 to which you can assign individual entries.
20814 Please refer to the Biblatex manual,
20817 Subdivided Bibliographies
20823 \begin_layout Section
20824 Multiple Bibliographies
20825 \begin_inset CommandInset label
20827 name "subsec:Multiple-Bibliographies"
20834 \begin_layout Standard
20835 Multiple bibliographies,
20837 \begin_inset space \thinspace{}
20841 \begin_inset space \space{}
20844 a bibliography for each part,
20847 subsection or child (sub-document) of the document,
20848 are also supported by \SpecialChar LyX
20850 In order to enable it,
20853 Document\SpecialChar menuseparator
20854 Settings\SpecialChar menuseparator
20857 and select the relevant unit (e.
20858 \begin_inset space \thinspace{}
20863 \begin_inset Quotes eld
20867 \begin_inset Quotes erd
20871 \begin_inset Flex Noun
20874 \begin_layout Plain Layout
20875 Multiple Bibliographies
20881 Then add a Bib(la)\SpecialChar TeX
20882 bibliography to each unit (e.
20883 \begin_inset space \thinspace{}
20887 section) of your document.
20889 a separate bibliography,
20890 containing only the references done in the current unit is generated.
20893 \begin_layout Standard
20894 If you use Bib\SpecialChar TeX
20897 \begin_inset Flex Code
20900 \begin_layout Plain Layout
20907 \begin_inset Flex Code
20910 \begin_layout Plain Layout
20916 package is used to create multiple bibliographies.
20917 The former package is used if you select
20918 \begin_inset Quotes eld
20922 \begin_inset Quotes erd
20930 \begin_inset Flex Noun
20933 \begin_layout Plain Layout
20934 Sectioned Bibliography
20940 In all other cases,
20942 \begin_inset Flex Code
20945 \begin_layout Plain Layout
20955 \begin_layout Plain Layout
20956 An alternative approach,
20957 if you are willing to use some
20958 \begin_inset Flex Noun
20961 \begin_layout Plain Layout
20969 \begin_inset space ~
20973 \begin_inset CommandInset ref
20975 reference "sec:Inserting-TeX-Code"
20982 \begin_inset Flex Code
20985 \begin_layout Plain Layout
20997 \begin_inset Flex Code
21000 \begin_layout Plain Layout
21008 encloses the specified units in
21009 \begin_inset Flex Code
21012 \begin_layout Plain Layout
21019 \begin_inset Flex Code
21022 \begin_layout Plain Layout
21031 \begin_inset Flex Code
21034 \begin_layout Plain Layout
21042 in order to create the units.
21043 Note that this approach has some limitations.
21045 every citation reference has to be inside some
21046 \begin_inset Flex Code
21049 \begin_layout Plain Layout
21056 So citations outside a defined unit (e.
21057 \begin_inset space \thinspace{}
21061 before the first section if you use
21062 \begin_inset Quotes eld
21066 \begin_inset Quotes erd
21070 \begin_inset Quotes eld
21074 \begin_inset Quotes erd
21078 You can also create your own units by entering
21079 \begin_inset Flex Code
21082 \begin_layout Plain Layout
21091 \begin_inset Flex Code
21094 \begin_layout Plain Layout
21102 as \SpecialChar TeX
21103 code (for instance to work around the mentioned limitation).
21107 \begin_inset Flex Code
21110 \begin_layout Plain Layout
21116 s cannot be nested.
21117 A second limitation is that
21118 \begin_inset Flex Code
21121 \begin_layout Plain Layout
21127 always processes all references of a bibliography database,
21128 even if they are not cited.
21129 This can result in odd labels (e.
21130 \begin_inset space \thinspace{}
21135 \begin_inset Quotes eld
21139 \begin_inset Quotes erd
21142 if two works of this author from 2014 are in the database,
21143 even if only one is cited).
21146 \begin_layout Standard
21153 \begin_inset Flex Code
21156 \begin_layout Plain Layout
21162 option is used instead.
21163 If you need specific units,
21164 you can start them with the \SpecialChar TeX
21166 \begin_inset Flex Code
21169 \begin_layout Plain Layout
21178 \begin_inset Flex Code
21181 \begin_layout Plain Layout
21191 If you also want to control the end of the unit,
21192 use the environment
21193 \begin_inset Flex Code
21196 \begin_layout Plain Layout
21206 \begin_inset Flex Code
21209 \begin_layout Plain Layout
21221 \begin_inset Flex Code
21224 \begin_layout Plain Layout
21230 s cannot be nested.
21231 In addition to the individual bibliography of the current unit,
21236 also provides an easy way to output all bibliographies,
21239 \begin_inset space \thinspace{}
21243 at the end of the document).
21245 \begin_inset Quotes eld
21248 all reference units
21249 \begin_inset Quotes erd
21252 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve this.
21253 Please refer to the
21257 manual for more information on this topic.
21260 \begin_layout Chapter
21262 \begin_inset CommandInset label
21264 name "chap:bullets"
21271 \begin_layout Standard
21277 \begin_layout Section
21281 \begin_layout Standard
21283 provides 216 bullet shapes that can be accessed from a simple dialog.
21284 Using this dialog you can easily specify what bullet shape to use at each level of an itemized list.
21285 These settings are document-wide so you won't be able to specify different sets of bullets for different paragraphs.
21289 \begin_layout Plain Layout
21291 actually you can but you'll have to do it by hand.
21299 \begin_layout Section
21303 \begin_layout Standard
21304 Open the dialog by selecting the
21306 Document\SpecialChar menuseparator
21309 menu item and then select the
21310 \begin_inset Flex Noun
21313 \begin_layout Plain Layout
21322 \begin_layout Standard
21323 The dialog provides you with a table of bullet shapes.
21324 A column of buttons on the left of the table provides access to the six different panels of bullet shapes.
21325 The row of buttons across the top is used to select which bullet depth you are changing.
21328 \begin_layout Standard
21334 a text entry under the table will be activated in which you can enter a bullet shape's \SpecialChar LaTeX
21336 If you do modify the text you will also need to specify any needed packages in the \SpecialChar LaTeX
21340 \begin_layout Standard
21341 The six panels are divided up by the packages they require.
21342 The following table shows the mappings from button name to \SpecialChar LaTeX
21346 \begin_layout Standard
21348 \begin_inset Tabular
21349 <lyxtabular version="3" rows="7" columns="2">
21350 <features tabularvalignment="middle">
21351 <column alignment="center" valignment="top" width="0pt">
21352 <column alignment="center" valignment="top" width="0pt">
21354 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21357 \begin_layout Plain Layout
21372 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21375 \begin_layout Plain Layout
21392 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21395 \begin_layout Plain Layout
21410 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21413 \begin_layout Plain Layout
21422 base \SpecialChar LaTeX
21430 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21433 \begin_layout Plain Layout
21448 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21451 \begin_layout Plain Layout
21468 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21471 \begin_layout Plain Layout
21486 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21489 \begin_layout Plain Layout
21506 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21509 \begin_layout Plain Layout
21524 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21527 \begin_layout Plain Layout
21544 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21547 \begin_layout Plain Layout
21562 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21565 \begin_layout Plain Layout
21582 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21585 \begin_layout Plain Layout
21600 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21603 \begin_layout Plain Layout
21626 \begin_layout Standard
21628 doesn't stop you using bullets from packages you don't have.
21629 If you get errors from \SpecialChar LaTeX
21630 when you try to view or print the file,
21631 then it is likely you are missing a package.
21635 \begin_layout Plain Layout
21637 doesn't restrict your use since you may be editing locally and exporting elsewhere.
21645 \begin_layout Section
21646 \begin_inset CommandInset label
21648 name "sec:How-to-use"
21655 \begin_layout Standard
21656 Select which bullet depth you want to change then select the bullet shape and size.
21657 Any changes will not be visible in \SpecialChar LyX
21659 but are visible when viewing the document.
21662 \begin_layout Standard
21663 You can reset a bullet shape to the default simply by clicking your right mouse button on the appropriate bullet depth button.
21664 \begin_inset CommandInset label
21666 name "fn:If-you-really"
21673 \begin_layout Standard
21678 want to have multiple sets of paragraphs with different sets of bullets in each,
21679 then you're going to have to get your hands dirty with \SpecialChar TeX
21681 The bullet selection dialog can help though because it provides you with the \SpecialChar LaTeX
21682 code for a wide range of bullet shapes.
21683 To make your own custom paragraphs you have the following options:
21686 \begin_layout Standard
21690 \begin_layout Plain Layout
21706 \begin_layout Standard
21710 \begin_layout Plain Layout
21732 \begin_layout Itemize
21733 Use the \SpecialChar LaTeX
21735 \begin_inset Flex Code
21738 \begin_layout Plain Layout
21746 to specify a new bullet shape for a given depth.
21747 You'll also need to save the current bullet shape so you can restore it again afterwards.
21748 In this itemized list the following \SpecialChar LaTeX
21749 code was used to change the bullet used for the first depth.
21753 \begin_layout LyX-Code
21763 \begin_layout LyX-Code
21780 \begin_layout Itemize
21781 Note that the itemize depth is specified in Roman numerals as part of the
21790 \begin_layout Itemize
21791 \begin_inset Argument item:1
21794 \begin_layout Plain Layout
21798 \begin_layout Plain Layout
21816 Specify each individual entry by starting each item with the bullet shape enclosed in a
21817 \begin_inset Quotes eld
21821 \begin_inset Quotes erd
21824 inset (available at
21826 Insert\SpecialChar menuseparator
21830 \begin_inset Flex Noun
21833 \begin_layout Plain Layout
21842 this item was started with
21843 \begin_inset Flex Code
21846 \begin_layout Plain Layout
21861 \begin_layout Standard
21865 \begin_layout Plain Layout
21881 \begin_layout Standard
21882 You'll also need to revert the labelitem back to its previous setting for the global bullet shape settings to remain in effect.
21883 The way used here was:
21886 \begin_layout LyX-Code
21896 \begin_layout Chapter
21900 \begin_layout Section
21901 Multipart Documents
21904 \begin_layout Subsection
21908 \begin_layout Standard
21909 When you are working on a large file with many sections,
21910 it is often convenient to break up the document into several files,
21911 or perhaps you have something where a table may change from time to time,
21912 but the preceding text does not.
21914 you should seriously consider using multipart documents.
21916 scientific papers often have five major sections:
21922 Each of these could be its own separate \SpecialChar LyX
21925 \begin_inset Quotes eld
21929 \begin_inset Quotes erd
21932 file which contains the title,
21937 plus the five included files.
21938 It is important to note that each of these files is a full \SpecialChar LyX
21939 file which can be formatted and printed on its own,
21940 as well as included in a master file.
21941 Each of these files must have the same document class,
21943 don't attempt to mix book classes with article classes.
21944 You may also include \SpecialChar LaTeX
21947 these files must not have their own preamble (i.
21948 \begin_inset space \thinspace{}
21952 \begin_inset space \space{}
21955 everything up to and including the
21956 \begin_inset Flex Code
21959 \begin_layout Plain Layout
21967 line as well as the
21968 \begin_inset Flex Code
21971 \begin_layout Plain Layout
21979 line must be deleted) or else errors will be generated when you try to make a DVI file.
21982 \begin_layout Standard
21984 allows you to include files quite easily with
21986 Insert\SpecialChar menuseparator
21988 \begin_inset space ~
21994 When you click on this selection a small box is inserted into the file at the current cursor location.
21995 Clicking on the box raises a dialog which allows you to select the file to be included,
21996 and the method of its inclusion.
22000 \begin_layout Standard
22001 The file selection box should by now be obvious.
22002 The three inclusion methods are
22003 \begin_inset Quotes eld
22007 \begin_inset Quotes erd
22012 \begin_inset Quotes eld
22016 \begin_inset Quotes erd
22021 \begin_inset Quotes eld
22025 \begin_inset Quotes erd
22030 \begin_inset Quotes eld
22034 \begin_inset Quotes erd
22038 \begin_inset Quotes eld
22042 \begin_inset Quotes erd
22045 are similar in many ways,
22046 but there are also some notable differences:
22049 \begin_layout Enumerate
22051 \begin_inset Quotes eld
22055 \begin_inset Quotes erd
22058 are typeset beginning on a new page,
22059 while files that are
22060 \begin_inset Quotes eld
22064 \begin_inset Quotes erd
22067 are typeset starting on the current page.
22070 \begin_layout Enumerate
22071 \begin_inset Quotes eld
22075 \begin_inset Quotes erd
22078 files cannot themselves
22079 \begin_inset Quotes eld
22083 \begin_inset Quotes erd
22087 \begin_inset Quotes eld
22091 \begin_inset Quotes erd
22096 \begin_inset Quotes eld
22100 \begin_inset Quotes erd
22105 infinite sub-inputting is possible.
22108 \begin_layout Enumerate
22109 \begin_inset Quotes eld
22113 \begin_inset Quotes erd
22116 allow for the output of only selected
22117 \begin_inset Quotes eld
22121 \begin_inset Quotes erd
22125 while maintaining the actual counters (pagination etc.) and references (please refer to the section
22128 \begin_inset space ~
22136 \begin_inset space ~
22141 manual for details).
22144 \begin_layout Standard
22147 \begin_inset Quotes eld
22151 \begin_inset Quotes erd
22154 is the preferred method for chapters that are outsourced to child documents,
22156 \begin_inset Quotes eld
22160 \begin_inset Quotes erd
22163 is more suitable for arbitrary file inheritance.
22166 \begin_layout Standard
22168 \begin_inset Quotes eld
22172 \begin_inset Quotes erd
22175 included file allows you to include a file typeset exactly as it appears in the file,
22177 \begin_inset space \thinspace{}
22181 \begin_inset space \space{}
22185 \begin_inset Flex Code
22188 \begin_layout Plain Layout
22195 with the characters set in a fixed-width typewriter font.
22197 spaces in this file are invisible,
22198 though two consecutive spaces are conserved,
22199 unlike \SpecialChar LyX
22200 's normal treatment of spaces.
22203 \begin_inset Flex Noun
22206 \begin_layout Plain Layout
22208 \begin_inset space ~
22212 \begin_inset space ~
22216 \begin_inset space ~
22224 checkbox typesets a mark to unambiguously define the presence of a space.
22228 \begin_layout Standard
22230 the master file is converted into a full \SpecialChar LaTeX
22231 file before typesetting,
22232 while the included files are converted to \SpecialChar LaTeX
22233 files that do not have all the preamble information.
22236 \begin_layout Subsection
22237 Cross-References Between Files
22240 \begin_layout Standard
22241 \begin_inset Box Shadowbox
22251 height_special "totalheight"
22256 backgroundcolor "none"
22259 \begin_layout Plain Layout
22260 This section is somewhat out of date.
22261 Need to describe default master documents and how children are opened when the master is.
22270 \begin_layout Standard
22271 It is possible to set up cross-references between the different files.
22273 open all the files in question:
22274 let's call them A and B in a two file example,
22275 where B is included in A.
22276 Let's say you insert a label in A,
22277 then want to reference it in B.
22278 Open the cross-reference dialog whilst in document B,
22279 and you can select the
22280 \begin_inset Quotes eld
22284 \begin_inset Quotes erd
22290 \begin_layout Subsection
22291 Bibliography Lists in all Subdocuments
22294 \begin_layout Standard
22295 If you work with child documents,
22296 you might want to have only one main bibliography at the end,
22297 but still be able to have a selected bibliography for the child if you output it on its own.
22298 Here is how to achieve this.
22301 \begin_layout Standard
22302 For the main document,
22303 you just insert a bibliography inset at the place where the main bibliography has to appear (within the master file or within a child).
22304 If the bibliography inset is in the master file,
22305 the references will be inherited by all children,
22306 so they are available in the citation dialog within each child.
22309 \begin_layout Standard
22310 For child-specific bibliographies,
22311 insert bibliography insets within the child documents,
22312 at the place where the bibliography should appear when the child is compiled separately.
22314 the trick is to insert them into a branch (
22316 Insert\SpecialChar menuseparator
22317 Branch\SpecialChar menuseparator
22318 Insert New Branch...
22322 \begin_inset space \thinspace{}
22327 \begin_inset Quotes eld
22331 \begin_inset Quotes erd
22335 Within the children,
22336 activate the branch (
22338 Document\SpecialChar menuseparator
22339 Settings...\SpecialChar menuseparator
22344 deactivate the branch (
22346 Document\SpecialChar menuseparator
22347 Settings...\SpecialChar menuseparator
22351 Now the child's bibliography will be ignored by the master,
22352 but considered by the child.
22355 \begin_layout Standard
22356 If you need multiple bibliographies (e.
22357 \begin_inset space \thinspace{}
22361 one per child in the
22366 please refer to sec.
22367 \begin_inset space ~
22371 \begin_inset CommandInset ref
22373 reference "subsec:Multiple-Bibliographies"
22381 \begin_layout Section
22386 \begin_layout Standard
22387 Users sometimes need to be able to
22388 \begin_inset Quotes eld
22392 \begin_inset Quotes erd
22396 file together with all the images (and other files) on which it depends,
22397 either for sending to a publisher or for sharing with a co-author.
22399 includes a Python script (
22400 \begin_inset Flex Code
22403 \begin_layout Plain Layout
22409 ) that automates this process.
22411 you must have either the
22412 \begin_inset Flex Code
22415 \begin_layout Plain Layout
22422 \begin_inset Flex Code
22425 \begin_layout Plain Layout
22431 python modules installed on your system.
22433 the script prefers the
22434 \begin_inset Flex Code
22437 \begin_layout Plain Layout
22444 \begin_inset Flex Code
22447 \begin_layout Plain Layout
22453 format on Unix-like systems and the
22454 \begin_inset Flex Code
22457 \begin_layout Plain Layout
22466 \begin_layout Standard
22468 's configuration process will set the script up to export a `\SpecialChar LyX
22470 and this format will then be available under
22472 File\SpecialChar menuseparator
22478 \begin_layout Standard
22479 Independently of the platform,
22480 the generation of a particular archive format can be forced by adding either the
22481 \begin_inset Flex Code
22484 \begin_layout Plain Layout
22491 \begin_inset Flex Code
22494 \begin_layout Plain Layout
22501 \begin_inset Flex Code
22504 \begin_layout Plain Layout
22511 \begin_inset Flex Code
22514 \begin_layout Plain Layout
22520 format) switch to the
22521 \begin_inset Flex Code
22524 \begin_layout Plain Layout
22534 Tools\SpecialChar menuseparator
22535 Preferences\SpecialChar menuseparator
22536 File Handling\SpecialChar menuseparator
22540 (Make sure you add the switch after the script name,
22544 \begin_layout Chapter
22546 and the World Wide Web
22549 \begin_layout Standard
22551 has long supported the export of documents to various web-friendly formats,
22553 Before version 2.0,
22555 HTML export was always accomplished by the use of external converters.
22559 \begin_layout Plain Layout
22560 For details on the use of external converters with \SpecialChar LyX
22566 section of the Customization manual.
22571 These fall into two large groups:
22572 there are converters that use \SpecialChar LaTeX
22573 as an intermediate format,
22575 \begin_inset Flex Code
22578 \begin_layout Plain Layout
22586 \begin_inset Flex Code
22589 \begin_layout Plain Layout
22597 \begin_inset Flex Code
22600 \begin_layout Plain Layout
22607 relying upon \SpecialChar LyX
22608 to produce the \SpecialChar LaTeX
22610 and there is a converter that works directly on \SpecialChar LyX
22613 \begin_inset Flex Code
22616 \begin_layout Plain Layout
22624 All of these have different advantages and disadvantages.
22628 \begin_layout Standard
22629 The \SpecialChar LaTeX
22630 -based converters have the advantage that,
22632 they know everything about the exported document that \SpecialChar LaTeX
22634 Such converters do not care,
22636 if a certain block of code was produced by \SpecialChar LyX
22637 or was Evil Red Text.
22638 These converters know about
22639 \begin_inset Flex Code
22642 \begin_layout Plain Layout
22651 and can often make use of the
22652 \begin_inset Flex Code
22655 \begin_layout Plain Layout
22661 files generated by Bib\SpecialChar TeX
22665 is a very hard language to parse—
22666 it is sometimes said that only \SpecialChar TeX
22667 itself understands \SpecialChar TeX
22669 and \SpecialChar LaTeX
22670 -based converters will often choke on what seem to be quite simple constructs;
22671 complex ones can throw them completely,
22672 and as of this writing,
22678 manual will not export with
22679 \begin_inset Flex Code
22682 \begin_layout Plain Layout
22689 though the others will.
22690 The other issue concerns how math is handled.
22691 These converters typically convert the formulae into little pictures that are then linked from the HTML document.
22692 Since these are actually generated by \SpecialChar LaTeX
22695 But they do not scale well,
22696 and just getting them to look as if they are actually meant to be in your document—
22697 so that the font sizes seem to be roughly the same—
22698 can be a challenge.
22701 \begin_layout Standard
22703 \begin_inset Flex Code
22706 \begin_layout Plain Layout
22714 \begin_inset CommandInset href
22716 name "http://pinchito.es/elyxer/"
22717 target "http://pinchito.es/elyxer/"
22722 ) solves some of these problems.
22724 the formulae it produces scale perfectly,
22725 since it renders math using a combination of HTML and CSS rather than converting the formulae to images.
22726 But even moderately complex formula are rendered less well than with
22727 \begin_inset Flex Code
22730 \begin_layout Plain Layout
22737 this reflects the limitations of HTML.
22741 \begin_layout Plain Layout
22744 \begin_inset Flex Code
22747 \begin_layout Plain Layout
22754 can also use jsMath and MathJax for equations,
22755 but this setting is only available globally and requires one to have access to a server that runs the backend.
22760 More importantly (as of version 1.1.1,
22763 \begin_inset Flex Code
22766 \begin_layout Plain Layout
22773 has limited support for math macros and no support for user-defined paragraph or character styles.
22774 These limitations make
22775 \begin_inset Flex Code
22778 \begin_layout Plain Layout
22785 unsuitable for many of the documents \SpecialChar LyX
22789 these problems could be solved,
22790 but the \SpecialChar LyX
22791 developers have decided to follow a different path and have made \SpecialChar LyX
22792 itself capable of writing XHTML,
22793 just as it is capable of writing \SpecialChar LaTeX
22799 \begin_layout Standard
22800 As of this writing,
22801 XHTML output remains under development and should probably be regarded as
22802 \begin_inset Quotes eld
22806 \begin_inset Quotes erd
22813 \begin_layout Plain Layout
22815 \begin_inset Flex Code
22818 \begin_layout Plain Layout
22819 development/HTML/HTML.notes
22825 which can be found in the \SpecialChar LyX
22827 \begin_inset CommandInset href
22829 name "accessed online"
22830 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
22836 usually contains up-to-date information about the state of XHTML output.
22837 See also the list of XHTML bugs on
22838 \begin_inset CommandInset href
22840 name "the bug tracker"
22841 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"
22852 the developers have chosen this approach because it has several potential advantages over the other two.
22855 \begin_layout Standard
22856 These advantages are primarily due to the fact that the XHTML output routines,
22857 since they are part of \SpecialChar LyX
22859 know everything \SpecialChar LyX
22860 knows about the document being exported.
22864 \begin_layout Plain Layout
22865 Another advantage is that,
22866 since these routines are internal to \SpecialChar LyX
22868 they are immune to changes in \SpecialChar LyX
22870 or to changes in the semantics of existing insets.
22875 So they know about the table of contents (as displayed in the outline),
22876 about the counters associated with different paragraph styles,
22877 and about user-defined styles.
22878 The XHTML output routines know what \SpecialChar LyX
22879 knows about internationalization,
22881 so they will output
22882 \begin_inset Quotes eld
22886 \begin_inset Quotes erd
22890 \begin_inset Quotes eld
22898 \begin_inset Quotes erd
22902 depending upon the language in effect at the time.
22906 \begin_layout Standard
22908 the output routines know what \SpecialChar LyX
22909 knows about document layout,
22911 about how the document is to be rendered on screen.
22912 We use this information when we output the document as XHTML.
22919 generates CSS style information corresponding to the layout information it uses to render the document on screen:
22920 if section headings are supposed to be sans-serif and bold as seen in \SpecialChar LyX
22922 then (by default) they will be sans-serif and bold when viewed in a web browser,
22924 And this is true not just for pre-defined styles,
22927 including user-defined styles.
22929 the XHTML output routines make no distinction between user-defined paragraph and text styles and \SpecialChar LyX
22930 's own pre-defined styles:
22932 everything \SpecialChar LyX
22933 knows about the styles is contained in the layout files.
22934 And much the same is true as regards pre-defined textual insets,
22936 and various custom insets.
22939 \begin_layout Standard
22940 The result is that XHTML output can be customized and extended in exactly the same way \SpecialChar LaTeX
22941 output can be customized and extended:
22942 through layout files and modules.
22943 See chapter five of the
22947 manual for the details.
22950 \begin_layout Standard
22951 The remainder of this chapter contains more detailed information on XHTML output,
22953 and ways to work around those limitations.
22956 \begin_layout Section
22957 Math Output in XHTML
22960 \begin_layout Standard
22962 offers four choices for how math is rendered.
22963 These have various advantages and disadvantages:
22966 \begin_layout Itemize
22968 \begin_inset Newline newline
22971 MathML is a dialect of XML designed specifically for mathematics on the web,
22972 and it typically renders very well in browsers that support it.
22973 The disadvantage is that not all browsers support MathML,
22974 and support is not complete even in the Gecko-based browsers,
22976 \begin_inset Newline newline
22979 If \SpecialChar LyX
22980 is unable to render a formula as MathML—
22982 if the formula uses the
22983 \begin_inset Flex Code
22986 \begin_layout Plain Layout
22993 then it will instead output the formula as an image.
22997 \begin_layout Itemize
22999 \begin_inset Newline newline
23002 As mentioned above,
23004 \begin_inset Flex Code
23007 \begin_layout Plain Layout
23013 outputs math as HTML,
23018 \begin_layout Plain Layout
23020 has borrowed some of the CSS for its HTML output from
23021 \begin_inset Flex Code
23024 \begin_layout Plain Layout
23035 For simple formulae,
23036 this can work quite well,
23037 though with more complicated formulae it tends to break down.
23039 this method has the advantage that it is very widely supported and so it may be appropriate for documents that contain only a little,
23040 fairly simple math.
23041 \begin_inset Newline newline
23044 If Lyx is unable to render a formula as HTML—
23046 if the formula uses the
23047 \begin_inset Flex Code
23050 \begin_layout Plain Layout
23057 then it will instead output the formula as an image.
23061 \begin_layout Itemize
23063 \begin_inset Newline newline
23067 \begin_inset Flex Code
23070 \begin_layout Plain Layout
23078 will output formulae as images,
23079 the very same images,
23081 that are used for instant preview.
23085 \begin_layout Plain Layout
23086 Instant preview does
23090 have to be on for images to be output,
23096 The advantage to this method is that the images are simply generated by \SpecialChar LaTeX
23098 so they are very accurate.
23100 as mentioned earlier,
23101 is that these are bitmapped images,
23102 so they do not scale terribly well,
23103 and one cannot copy them,
23105 \begin_inset Newline newline
23108 The size of the images can be controlled by setting the
23109 \begin_inset Quotes eld
23112 Math Images Scaling
23113 \begin_inset Quotes erd
23118 Document\SpecialChar menuseparator
23119 Settings\SpecialChar menuseparator
23124 \SpecialChar menuseparator
23131 \begin_layout Plain Layout
23132 For those who want to know,
23133 this controls the resolution of the image in dots per inch and is based upon a default of 75 dpi.
23139 \begin_inset Newline newline
23142 If \SpecialChar LyX
23143 for some reason fails to create an image for a formula (e.g.,
23144 if a required \SpecialChar LaTeX
23145 package is not installed),
23146 then it will fall back to outputing the raw \SpecialChar LaTeX
23150 \begin_layout Itemize
23153 \begin_inset Newline newline
23158 will happily output math as \SpecialChar LaTeX
23160 As well as being the output of last resort,
23161 this method can be used with such tools as
23162 \begin_inset CommandInset href
23165 target "http://www.math.union.edu/~dpvc/jsMath/"
23171 which uses JavaScript to render \SpecialChar LaTeX
23172 embedded in HTML documents.
23174 wraps the \SpecialChar LaTeX
23176 \begin_inset Flex Code
23179 \begin_layout Plain Layout
23185 (for inline formulas) or
23186 \begin_inset Flex Code
23189 \begin_layout Plain Layout
23195 (for displayed formulas) with
23196 \begin_inset Flex Code
23199 \begin_layout Plain Layout
23206 as is required for jsMath.
23209 \begin_layout Standard
23210 One of these output methods must be selected under
23212 Document\SpecialChar menuseparator
23213 Settings\SpecialChar menuseparator
23220 This is a document-wide setting,
23224 \begin_layout Standard
23227 will offer the user the option to select an alternate output method for a particular inset,
23229 one that isn't being rendered very well by MathML.
23233 \begin_layout Plain Layout
23235 since \SpecialChar LyX
23236 falls back to images if the inset contains ERT,
23237 then one can force output as an image by putting some harmless ERT into the math,
23240 \begin_inset Formula $a=b\relax$
23251 \begin_layout Section
23252 Bibliography and Citations
23255 \begin_layout Standard
23256 XHTML output fully supports bibliographies and citations.
23260 \begin_layout Standard
23261 Citation labels are generated by the same machinery that generates \SpecialChar LyX
23262 's on-screen labels,
23263 so the labels will look in the output much as they do in \SpecialChar LyX
23266 If you are using numerical citations,
23267 then \SpecialChar LyX
23268 will output numerical labels,
23269 such as [1] or [17],
23270 rather than simply showing the citation key in square brackets,
23271 as it does on-screen.
23272 If you are using author-year citations,
23273 then \SpecialChar LyX
23274 will add lowercase letters to the years,
23275 just as Bib\SpecialChar TeX
23277 if it finds more than one citation for a given author-year combination.
23278 The labels will be printed with the bibliography entries.
23279 Note that there is,
23281 no way to customize the appearance of the labels,
23283 to choose between square brackets and parentheses.
23286 \begin_layout Standard
23287 Bibliography output is handled by the same machinery that handles the presentation of reference information in the citation dialog,
23288 so you will see in the XHTML output pretty much what you would see if you were to look at a given entry in the citation dialog.
23289 The formatting can be customized in your layout file or,
23296 manual for the details.
23299 \begin_layout Standard
23300 The main defect at present is that cross-referenced information is printed with every entry with which it is associated.
23301 So you can see things like this:
23304 \begin_layout Quote
23307 \begin_inset Quotes eld
23310 Context and Logical Form
23311 \begin_inset Quotes erd
23317 Language in Context:
23321 Oxford University Press,
23327 \begin_layout Quote
23330 \begin_inset Quotes eld
23333 Semantics in Context
23334 \begin_inset Quotes erd
23340 Language in Context:
23344 Oxford University Press,
23350 \begin_layout Standard
23351 This should be fixed before long.
23354 \begin_layout Standard
23355 There is no support at present for sectioned bibliographies.
23356 If you have multiple bibliographies,
23357 then \SpecialChar LyX
23358 will print the same bibliography over and over.
23361 \begin_layout Section
23365 \begin_layout Standard
23367 will happily export indexes as XHTML,
23368 but with certain limitations at the moment.
23371 \begin_layout Standard
23372 Index export will be most reliable when you do not attempt to use the fancy constructs that are described in the section on indexes in the
23380 \begin_layout Plain Layout
23381 The main issue here is that \SpecialChar LyX
23382 itself does not really handle these.
23383 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
23389 We'll describe how they are handled using the subsection headings from that section.
23392 \begin_layout Itemize
23393 Grouping Index Entries (aka,
23396 makes an effort to support these,
23397 but the entries must be separated by
23398 \begin_inset Quotes eld
23403 \begin_inset Quotes erd
23408 there must be spaces around the exclamation point.
23409 This is because it is otherwise too difficult to check for escaped exclamation points,
23414 \begin_layout Itemize
23416 There is no support at all for page ranges,
23417 since these make no sense with XHMTL.
23419 you will just get two index entries,
23423 \begin_layout Itemize
23425 There is no support for cross-referencing.
23426 If \SpecialChar LyX
23427 finds an entry containing the
23428 \begin_inset Quotes eld
23431 |see\SpecialChar ldots
23433 \begin_inset Quotes erd
23437 it is just dropped,
23438 and the rest is treated as an ordinary index entry.
23441 \begin_layout Itemize
23444 does support attempts to fix the sorting order.
23445 It will take what is before the first `@' it finds and use that for sorting,
23446 taking what follows the first `@' to be the actual entry.
23449 does not check for escaped `@',
23450 so do not try to index email addresses.
23453 \begin_layout Itemize
23454 Index Entry Layout:
23455 You can format entries by using the text style dialog,
23456 or by using any other method available within \SpecialChar LyX
23458 There is no support for constructs like:
23460 \begin_inset Quotes eld
23464 \begin_inset Quotes erd
23469 if \SpecialChar LyX
23470 finds a pipe symbol,
23473 it will delete it and everything that follows it.
23476 \begin_layout Itemize
23478 There is no support for multiple indexes.
23480 all index entries will be printed as one large index.
23481 To avoid our printing several versions of the index,
23482 we print only the main index,
23483 so make sure you have one.
23486 \begin_layout Section
23487 Nomenclature and Glossary
23490 \begin_layout Standard
23491 There is at present no support for glossaries.
23492 Adding it would be fairly trivial,
23496 \begin_layout Chapter
23500 \begin_layout Standard
23503 can generate documents in the DocBook XML vocabulary.
23504 With versions 2.3 and before,
23505 only select templates could be used to generate DocBook documents (only version 4).
23506 Starting with \SpecialChar LyX
23508 most \SpecialChar LyX
23509 layouts can generate valid DocBook documents (only version 5).
23510 This feature is built into \SpecialChar LyX
23511 and does not require the use of external tools.
23514 \begin_layout Standard
23515 The result is that the DocBook output can be customized and extended in exactly the same way \SpecialChar LaTeX
23516 output can be customized and extended:
23517 through layout files and modules.
23518 See chapter five of the
23522 manual for the details.
23525 \begin_layout Standard
23526 Most \SpecialChar LyX
23527 features are supported with DocBook,
23531 \begin_layout Itemize
23532 Math output is performed mostly in MathML (the major exception being constructions not supported by \SpecialChar LyX
23536 All formulae are also available in raw \SpecialChar TeX
23537 in the DocBook output for further processing.
23540 \begin_layout Itemize
23541 Bibliographies and citations are implemented,
23542 including with an external BibTeX file.
23543 Bibliography entries are not prerendered when the detailed information are available,
23544 but rather output with the standard DocBook constructs.
23545 The external DocBook processor is expected to handle the rendering of entries.
23548 \begin_layout Itemize
23549 Indexes are supported,
23550 including multiple indices.
23557 and cross-references (
23562 with the exception of the same symbols escaped.
23571 ) are not supported.
23572 There is no support for escaping of index entries.
23575 \begin_layout Itemize
23576 Glossaries are implemented.
23579 \begin_layout Standard
23580 Two major parameters can be set at the document level.
23583 \begin_layout Itemize
23586 can generate tables either as HTML (default value) or CALS,
23587 depending on the user's requirements.
23588 Most DocBook processors accept both formats.
23591 \begin_layout Itemize
23594 MathML is included within its own name space,
23596 The implication is that there must be an indication of the tags belonging to the MathML standard.
23597 Three choices are offered:
23601 \begin_layout Itemize
23603 the MathML name space is defined for each formula (using the
23607 attribute on each formula)
23610 \begin_layout Itemize
23616 the MathML name space is defined at the document level (using the
23620 attribute on the root element).
23621 Each MathML is prefixed with
23632 \begin_layout Itemize
23648 \begin_layout Standard
23649 This option is especially useful if you want \SpecialChar LyX
23650 to match your personal style or to work with buggy software that only accepts one prefix for MathML.
23654 \begin_layout Chapter
23655 The \SpecialChar LyX
23659 \begin_layout Section
23663 \begin_layout Standard
23664 The `\SpecialChar LyX
23665 server' allows other programs to talk to \SpecialChar LyX
23667 invoke \SpecialChar LyX
23669 and retrieve information about the \SpecialChar LyX
23671 This is only intended for advanced users,
23672 but they should find it useful.
23673 It is by writing to the \SpecialChar LyX
23676 that bibliography managers,
23679 \begin_inset Quotes eld
23683 \begin_inset Quotes erd
23686 citations to \SpecialChar LyX
23690 \begin_layout Section
23691 Starting the \SpecialChar LyX
23693 \begin_inset CommandInset label
23695 name "sec:Starting-the-Server"
23702 \begin_layout Standard
23703 The \SpecialChar LyX
23704 server works through the use of a pair of named pipes.
23705 These are usually located in
23706 \begin_inset Flex Code
23709 \begin_layout Plain Layout
23716 (except on Windows,
23721 named pipes are special objects located in
23722 \begin_inset Flex Code
23725 \begin_layout Plain Layout
23737 ) and have the names
23738 \begin_inset Quotes eld
23742 \begin_inset Flex Code
23745 \begin_layout Plain Layout
23752 \begin_inset Quotes erd
23756 \begin_inset Quotes eld
23760 \begin_inset Flex Code
23763 \begin_layout Plain Layout
23770 \begin_inset Quotes erd
23774 External programs write into
23775 \begin_inset Flex Code
23778 \begin_layout Plain Layout
23784 and read back data from
23785 \begin_inset Flex Code
23788 \begin_layout Plain Layout
23795 The stem of the pipe names can be defined in the
23797 Tools\SpecialChar menuseparator
23798 Preferences\SpecialChar menuseparator
23803 \begin_inset Flex Code
23806 \begin_layout Plain Layout
23807 "/home/myhome/lyxpipe"
23814 \begin_inset Flex Code
23817 \begin_layout Plain Layout
23831 on Windows (where any working path instead of lyxpipe can be used,
23833 \begin_inset Flex Code
23836 \begin_layout Plain Layout
23859 configure this manually in order for the server to start.
23862 \begin_layout Standard
23865 \begin_inset Flex Code
23868 \begin_layout Plain Layout
23875 \begin_inset Flex Code
23878 \begin_layout Plain Layout
23884 ' to create the pipes.
23885 If one of the pipes already exists,
23887 will assume that another \SpecialChar LyX
23888 process is already running and will not start the server.
23889 On POSIX (Unix like) systems,
23890 if for some other reason,
23892 \begin_inset Quotes eld
23896 \begin_inset Quotes erd
23899 pipe is left in existence when \SpecialChar LyX
23901 then \SpecialChar LyX
23902 will try to delete it.
23903 If this fails for some reason,
23904 you will need to delete the pipes manually and then restart \SpecialChar LyX
23907 pipes are deleted by the OS on program termination or crash,
23909 \begin_inset Quotes eld
23913 \begin_inset Quotes erd
23916 pipes should not be possible.
23919 \begin_layout Standard
23920 To have several \SpecialChar LyX
23921 processes with servers at the same time,
23922 you have to use different configurations,
23923 perhaps by using separate user directories,
23925 \begin_inset Flex Code
23928 \begin_layout Plain Layout
23938 \begin_layout Standard
23939 If you are developing a client program,
23940 you might find it useful to enable debugging information from the \SpecialChar LyX
23942 Do this by starting \SpecialChar LyX
23944 \begin_inset Flex Code
23947 \begin_layout Plain Layout
23956 \begin_layout Standard
23957 You can find a complete example client written in C++ in the source distribution as
23958 \begin_inset Flex Code
23961 \begin_layout Plain Layout
23962 development/lyxserver/server_monitor.cpp
23970 \begin_layout Standard
23971 Another useful tool is the command-line based client found in
23972 \begin_inset Flex Code
23975 \begin_layout Plain Layout
23976 src/client/lyxclient
23984 \begin_layout Section
23985 Normal communication
23988 \begin_layout Standard
23989 To issue a \SpecialChar LyX
23991 the client writes a line of ASCII text into the input pipe.
23992 This line has the following format:
23995 \begin_layout Quote
24009 \begin_layout Description
24010 clientname is a name that the client can choose arbitrarily.
24011 Its only use is that \SpecialChar LyX
24012 will echo it if it sends an answer—
24013 so a client can dispatch results from different requesters.
24016 \begin_layout Description
24017 function is the function you want \SpecialChar LyX
24019 It is the same as the commands you'd use in the minibuffer.
24022 \begin_layout Description
24023 argument is an optional argument which is meaningful only to some functions (for instance,
24025 \begin_inset Quotes eld
24029 \begin_inset Quotes erd
24032 LFUN will insert the argument as text at the cursor position).
24035 \begin_layout Standard
24036 The answer from \SpecialChar LyX
24037 will arrive in the output pipe and be of the form
24040 \begin_layout Quote
24054 \begin_layout Standard
24063 are just echoed from the command request,
24068 is more or less useful information filled according to how the command execution worked out.
24071 \begin_inset Quotes eld
24075 \begin_inset Quotes erd
24079 will return information about the internal state of \SpecialChar LyX
24081 while other will return an empty data-response.
24082 This means that the command execution went fine.
24085 \begin_layout Standard
24087 the response from \SpecialChar LyX
24088 will have this form
24091 \begin_layout Quote
24105 \begin_layout Standard
24110 should contain an explanation of why the command failed.
24113 \begin_layout Standard
24117 \begin_layout LyX-Code
24118 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
24119 \begin_inset Newline newline
24122 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
24123 \begin_inset Newline newline
24126 read a <~/.lyxpipe.out
24127 \begin_inset Newline newline
24133 \begin_layout Subsection
24134 AppleScript (Mac OS X)
24137 \begin_layout Standard
24138 Since \SpecialChar LyX
24141 supports basic interactions with AppleScript for normal communication through the command run.
24142 This command takes a direct argument (the
24146 to perform) and an optional argument.
24147 It either returns the output of the function or triggers an error with the error message and code.
24150 \begin_layout Standard
24154 \begin_layout LyX-Code
24155 tell application "\SpecialChar LyX
24159 \begin_layout LyX-Code
24163 \begin_layout LyX-Code
24164 -- Stores the current file name into f
24167 \begin_layout LyX-Code
24168 set f to (run "server-get-filename" with argument "")
24171 \begin_layout LyX-Code
24172 on error the error_message number the error_number
24175 \begin_layout LyX-Code
24176 display dialog "Error:
24177 " & the error_number & ".
24181 \begin_layout LyX-Code
24182 & the error_message buttons {"OK"} default button 1
24185 \begin_layout LyX-Code
24189 \begin_layout LyX-Code
24193 \begin_layout Section
24197 \begin_layout Standard
24199 can notify clients of events going on asynchronously.
24200 Currently it will only do this if the user binds a key sequence with the function
24201 \begin_inset Quotes eld
24205 \begin_inset Quotes erd
24209 The format of the string \SpecialChar LyX
24210 sends is as follows:
24213 \begin_layout Quote
24214 \begin_inset Flex Code
24217 \begin_layout Plain Layout
24228 \begin_layout Standard
24233 is the printed representation of the key sequence that was actually typed by the user.
24236 \begin_layout Standard
24237 This mechanism can be used to extend \SpecialChar LyX
24238 's command set and implement macros.
24239 Bind some key sequence to
24240 \begin_inset Quotes eld
24244 \begin_inset Quotes erd
24248 Then start a client that listens on the output pipe,
24249 dispatches the command according to the sequence,
24250 and starts a function that may use \SpecialChar LyX
24251 calls and \SpecialChar LyX
24252 requests to issue a command or a series of commands to \SpecialChar LyX
24256 \begin_layout Section
24257 The simple \SpecialChar LyX
24261 \begin_layout Standard
24263 implements a simple protocol that can be used for session management.
24264 All messages are of the form
24267 \begin_layout Quote
24277 \begin_layout Standard
24283 \begin_inset Quotes eld
24287 \begin_inset Quotes erd
24291 \begin_inset Quotes eld
24295 \begin_inset Quotes erd
24300 \begin_inset Quotes eld
24304 \begin_inset Quotes erd
24307 is received from a client,
24309 will report back to inform the client that it's listening to it's messages,
24311 \begin_inset Quotes eld
24315 \begin_inset Quotes erd
24318 sent from \SpecialChar LyX
24319 will inform clients that \SpecialChar LyX
24323 \begin_layout Section
24324 Reverse DVI/PDF search
24327 \begin_layout Standard
24328 Some DVI/PDF viewers
24332 \begin_layout Plain Layout
24333 The following viewers offer the reverse PDF search feature:
24334 Okular on KDE/Linux,
24336 Skim on Mac OSX and SumatraPDF on Windows.
24345 facility (also called
24350 This means that you can tell \SpecialChar LyX
24351 to put the cursor to a specific line in the document by clicking at the respective position in the DVI/PDF output.
24353 the viewer must be able to communicate with \SpecialChar LyX
24355 This is done via the \SpecialChar LyX
24356 server either by using the named pipe (
24361 or the UNIX domain socket (
24365 ) that \SpecialChar LyX
24366 creates in its temporary directory (this is the way the
24367 \begin_inset Flex Code
24370 \begin_layout Plain Layout
24376 program communicates with \SpecialChar LyX
24379 you need a helper script that mediates between the viewer and \SpecialChar LyX
24382 the viewer can communicate with \SpecialChar LyX
24384 This depends on the selected viewer and on your operating system.
24385 The same applies to the way viewers need to be configured and the way the reverse search is actually performed.
24387 we will thus describe how to setup reverse search for specific viewers.
24388 Before we turn to this,
24390 we will explain what needs to be done generally to enable reverse search in the DVI/PDF output.
24393 \begin_layout Subsection
24395 \begin_inset CommandInset label
24397 name "subsec:rev-search"
24404 \begin_layout Standard
24405 In most cases \SpecialChar LyX
24406 will do the work for you by pressing the following button in the toolbar:
24410 arg "buffer-toggle-output-sync"
24415 you can also enable the feature by checking
24417 Synchronize with Output
24421 Document\SpecialChar menuseparator
24422 Settings\SpecialChar menuseparator
24423 Output\SpecialChar menuseparator
24427 In such a case \SpecialChar LyX
24428 will automatically insert the necessary Sync\SpecialChar TeX
24429 macro (for PDF) or load the srcltx package (for DVI) respectively.
24430 This option can be easily reached also on
24431 \begin_inset Flex Code
24434 \begin_layout Plain Layout
24443 \begin_layout Standard
24444 If you need a different setting,
24445 you can select or input a custom macro from the drop down box just below
24447 Document\SpecialChar menuseparator
24448 Settings\SpecialChar menuseparator
24449 Output\SpecialChar menuseparator
24450 Synchronize with Output
24455 \begin_layout Standard
24456 Note that the method
24457 \begin_inset Flex Code
24460 \begin_layout Plain Layout
24468 enables gzip compression.
24469 If your viewer does not support it,
24470 you should instead use
24471 \begin_inset Flex Code
24474 \begin_layout Plain Layout
24485 \begin_layout Standard
24486 Please also note that including the
24487 \begin_inset Flex Code
24490 \begin_layout Plain Layout
24497 \begin_inset Flex Code
24500 \begin_layout Plain Layout
24506 sometimes has an undesired impact on the typesetting.
24508 you should switch output synchronization off for the final typesetting if you use the
24509 \begin_inset Flex Code
24512 \begin_layout Plain Layout
24519 \begin_inset Flex Code
24522 \begin_layout Plain Layout
24532 \begin_layout Standard
24533 In case you need some more special settings that are not covered by the automatic settings,
24534 read the next section about how to set up output synchronization manually.
24535 If the automatic setup suits your needs,
24536 you can readily jump to section
24537 \begin_inset space ~
24541 \begin_inset CommandInset ref
24543 reference "subsec:configuring-viewers"
24549 where the necessary configuration steps in your viewer – needed both with the automatic and the manual setup – are described.
24552 \begin_layout Subsection
24556 \begin_layout Standard
24558 provides several different methods for reverse search.
24559 Some are built-in in the
24560 \begin_inset Flex Code
24563 \begin_layout Plain Layout
24570 some are provided by external packages.
24571 Your choice depends on whether your \SpecialChar LaTeX
24572 distribution already provides a given method (the built-in methods are rather new) and whether your viewer can cope with it.
24573 The available methods are described in the following.
24576 \begin_layout Subsubsection*
24577 Built-in DVI-search via src-specials (DVI only)
24580 \begin_layout Standard
24581 This method provides the DVI file with the necessary information for reverse search.
24582 It is available in \SpecialChar LaTeX
24583 since quite some time (any somewhat recent \SpecialChar LaTeX
24584 distribution should include it),
24585 and it works reliably.
24588 \begin_inset Flex Noun
24591 \begin_layout Plain Layout
24602 \begin_inset Flex Noun
24605 \begin_layout Plain Layout
24617 Preferences\SpecialChar menuseparator
24618 File Handling\SpecialChar menuseparator
24622 \begin_inset Flex Code
24625 \begin_layout Plain Layout
24626 latex -src-specials $$i
24632 If this doesn't work,
24633 check if your \SpecialChar TeX
24634 engine needs different options (the syntax might differ in some distributions).
24637 \begin_layout Subsubsection*
24638 External Packages (PDFSync and scrltx)
24641 \begin_layout Standard
24650 provide reverse search facility for PDF output (via pdflatex) and DVI output,
24652 In order to enable it,
24653 load the packages in the \SpecialChar LyX
24658 \begin_layout Itemize
24659 \begin_inset Flex Code
24662 \begin_layout Plain Layout
24665 usepackage{pdfsync}
24670 for reverse PDF search,
24673 \begin_layout Itemize
24674 \begin_inset Flex Code
24677 \begin_layout Plain Layout
24680 usepackage[active]{srcltx}
24685 for reverse DVI search.
24688 \begin_layout Standard
24689 If you want to be able to perform both DVI and PDF reverse searches,
24690 you can also insert in the preamble the following lines
24693 \begin_layout LyX-Code
24697 \begin_inset Newline newline
24703 \begin_inset Newline newline
24708 usepackage{pdfsync}
24709 \begin_inset Newline newline
24715 \begin_inset Newline newline
24720 usepackage[active]{srcltx}
24721 \begin_inset Newline newline
24729 \begin_layout Standard
24731 you can preview the file as either DVI or PDF (pdflatex) and the right package will be used.
24734 \begin_layout Standard
24735 Note that PDFSync might affect the output layout of your document.
24736 It is therefore advised to disable PDFsync for final documents.
24739 \begin_layout Subsubsection*
24740 Built-in reverse search via Sync\SpecialChar TeX
24744 \begin_layout Standard
24746 \begin_inset Flex Code
24749 \begin_layout Plain Layout
24755 have built-in support for both PDF and DVI reverse search.
24758 Sync\SpecialChar TeX
24761 facility is basically the result of the integration of the PDFSync package to the pdftex program and its merge with the
24766 You need at least \SpecialChar TeX
24767 Live 2008 or a recent Mik\SpecialChar TeX
24768 distribution in order to use it.
24772 \begin_layout Plain Layout
24774 Mik\SpecialChar TeX
24775 does not understand/obey the command \SpecialChar LyX
24776 inserts into the preamble when you check the "Enable Forward/Reverse Search" button in the toolbar and does not generate the necessary info.
24779 \begin_layout Plain Layout
24780 The generation of the required info can be forced by changing the converter "\SpecialChar LaTeX
24781 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e.,
24782 by adding the -synctex=1 switch).
24787 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
24789 SumatraPDF on Windows;
24790 see the next section for details) already provide Sync\SpecialChar TeX
24794 \begin_layout Standard
24795 To enable Sync\SpecialChar TeX
24798 \begin_inset Flex Noun
24801 \begin_layout Plain Layout
24812 \begin_inset Flex Noun
24815 \begin_layout Plain Layout
24820 (plain) -> DraftDVI
24827 Preferences\SpecialChar menuseparator
24828 File Handling\SpecialChar menuseparator
24832 \begin_inset Flex Code
24835 \begin_layout Plain Layout
24836 latex -synctex=1 $$i
24842 and for PDF output,
24844 \begin_inset Flex Noun
24847 \begin_layout Plain Layout
24852 (pdflatex) -> PDF (pdflatex)
24858 \begin_inset Flex Code
24861 \begin_layout Plain Layout
24862 pdflatex -synctex=1 $$i
24868 Should your viewer not be considered in the following description,
24869 or in case of missing success,
24870 please check the documentation of your viewer whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
24875 \begin_layout Plain Layout
24876 Note that the option
24877 \begin_inset Flex Code
24880 \begin_layout Plain Layout
24886 option enables gzip compression.
24887 If your viewer does not support it,
24888 you should instead use
24889 \begin_inset Flex Code
24892 \begin_layout Plain Layout
24906 \begin_layout Subsection
24907 Configuring and using specific viewers
24908 \begin_inset CommandInset label
24910 name "subsec:configuring-viewers"
24917 \begin_layout Subsubsection*
24918 Xdvi (all platforms)
24921 \begin_layout Standard
24923 \begin_inset Flex Code
24926 \begin_layout Plain Layout
24933 you don't need to do anything else for performing a reverse DVI search,
24934 as \SpecialChar LyX
24935 already provides the necessary hooks for automatically using the
24936 \begin_inset Flex Code
24939 \begin_layout Plain Layout
24946 Just setup your document as described above (reverse search is triggered by Ctrl-click or Alt-click on Mac OSX,
24950 \begin_layout Standard
24952 if for whatever reason you want to use the named pipe instead of the socket for communicating with \SpecialChar LyX
24954 simply change the DVI viewer in
24956 Preferences\SpecialChar menuseparator
24957 File Handling\SpecialChar menuseparator
24964 \begin_layout Plain Layout
24965 On Mac OSX you have to use
24966 \begin_inset Flex Code
24969 \begin_layout Plain Layout
24970 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
24981 \begin_inset Flex Code
24984 \begin_layout Plain Layout
24985 xdvi -editor "lyxeditor.sh %f %l"
24992 \begin_inset Flex Code
24995 \begin_layout Plain Layout
25001 is a suitable script.
25003 a minimal shell script is the following one:
25006 \begin_layout LyX-Code
25008 \begin_inset Newline newline
25011 LYXPIPE="/path/to/lyxpipe"
25012 \begin_inset Newline newline
25015 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
25016 \begin_inset Newline newline
25019 echo "$COMMAND" > "${LYXPIPE}".in || exit
25020 \begin_inset Newline newline
25023 read TMP < "${LYXPIPE}".out || exit
25026 \begin_layout Standard
25028 \begin_inset Flex Code
25031 \begin_layout Plain Layout
25037 is the LyXServer pipe path specified in
25039 Preferences\SpecialChar menuseparator
25046 \begin_layout Plain Layout
25048 \begin_inset Flex Code
25051 \begin_layout Plain Layout
25057 folder of a source distribution you can find a
25058 \begin_inset Flex Code
25061 \begin_layout Plain Layout
25067 script which is able to locate the
25071 based on your preferences.
25079 \begin_layout Subsubsection*
25083 \begin_layout Standard
25085 \begin_inset Flex Code
25088 \begin_layout Plain Layout
25089 /Applications/MacDviX_Folder/calleditor.script
25095 add the following lines:
25098 \begin_layout LyX-Code
25099 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
25100 \begin_inset Newline newline
25106 \begin_layout Standard
25107 Modify the lines accordingly if you install \SpecialChar LyX
25108 somewhere else than in the Applications folder.
25111 \begin_layout Standard
25112 Reverse search is triggered by Alt-click (OPTION-click).
25115 \begin_layout Subsubsection*
25119 \begin_layout Standard
25121 \begin_inset Flex Code
25124 \begin_layout Plain Layout
25125 open -a Skim.app $$i
25130 to the viewer setting in
25132 Preferences\SpecialChar menuseparator
25133 File Handling\SpecialChar menuseparator
25134 File formats\SpecialChar menuseparator
25140 Skim\SpecialChar menuseparator
25141 Preferences\SpecialChar menuseparator
25148 preset and enter command
25149 \begin_inset Flex Noun
25152 \begin_layout Plain Layout
25153 /Applications/\SpecialChar LyX
25154 .app/Contents/MacOS/lyxeditor
25162 \begin_layout Standard
25163 Reverse search is triggered by COMMAND-SHIFT-click
25166 \begin_layout Subsubsection*
25170 \begin_layout Standard
25171 Reverse search with evince does not work out of the box,
25172 but it can be achieved by means of some third party helper scripts.
25174 \begin_inset CommandInset href
25176 target "https://wiki.lyx.org/LyX/SyncTeX"
25184 \begin_layout Subsubsection*
25188 \begin_layout Standard
25191 Settings\SpecialChar menuseparator
25192 Configure Okular\SpecialChar menuseparator
25196 \begin_inset Quotes erd
25200 This inserts the appropriate command (
25201 \begin_inset Flex Code
25204 \begin_layout Plain Layout
25213 \begin_layout Standard
25214 Reverse search is triggered by SHIFT-click.
25215 Note that this only works if Okular is in
25216 \begin_inset Quotes eld
25220 \begin_inset Quotes erd
25224 \begin_inset space \thinspace{}
25228 the hand symbol is clicked).
25231 \begin_layout Subsubsection*
25235 \begin_layout Standard
25236 Qpdfview supports Sync\SpecialChar TeX
25237 since version 0.3.5.
25240 Edit\SpecialChar menuseparator
25241 Settings\SpecialChar menuseparator
25245 click on the input field of the
25246 \begin_inset Quotes eld
25250 \begin_inset Quotes erd
25253 item and add the command
25254 \begin_inset Flex Code
25257 \begin_layout Plain Layout
25266 \begin_layout Standard
25267 Reverse search is triggered by double-click or,
25268 in more recent versions,
25272 \begin_layout Subsubsection*
25276 \begin_layout Standard
25280 View\SpecialChar menuseparator
25283 menu and select the
25284 \begin_inset Quotes eld
25288 \begin_inset Quotes erd
25293 \begin_inset Quotes eld
25296 New\SpecialChar ldots
25298 \begin_inset Quotes erd
25302 in the window that opens,
25304 \begin_inset Quotes eld
25309 \begin_inset Quotes erd
25312 (or any other name you like) in the
25313 \begin_inset Quotes eld
25317 \begin_inset Quotes erd
25321 Now click on the button labeled
25322 \begin_inset Quotes eld
25327 \begin_inset Quotes erd
25330 to open a file dialog and navigate to the directory containing the batch file
25331 \begin_inset Flex Code
25334 \begin_layout Plain Layout
25342 \begin_inset Flex Code
25345 \begin_layout Plain Layout
25351 and then specify the program arguments as
25352 \begin_inset Flex Code
25355 \begin_layout Plain Layout
25363 \begin_inset Flex Code
25366 \begin_layout Plain Layout
25372 wrapper is used for communicating with \SpecialChar LyX
25380 \begin_layout LyX-Code
25382 \begin_inset Newline newline
25385 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
25394 \begin_inset Newline newline
25408 \begin_layout Standard
25409 Make sure that the \SpecialChar LyX
25410 Server pipe path you specified in \SpecialChar LyX
25412 \begin_inset Flex Code
25415 \begin_layout Plain Layout
25430 otherwise change the
25431 \begin_inset Flex Code
25434 \begin_layout Plain Layout
25440 wrapper accordingly.
25443 \begin_layout Standard
25445 reverse search is triggered by double-click.
25448 \begin_layout Subsubsection*
25449 SumatraPDF (Windows)
25452 \begin_layout Standard
25453 In order to use SumatraPDF for inverse search,
25455 \begin_inset Flex Code
25458 \begin_layout Plain Layout
25459 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
25464 in the viewer setting in
25466 Preferences\SpecialChar menuseparator
25467 File Handling\SpecialChar menuseparator
25468 File formats\SpecialChar menuseparator
25473 \begin_inset Flex Code
25476 \begin_layout Plain Layout
25482 is the previous wrapper.
25483 If SumatraPDF.exe is not in your command PATH,
25484 use its full file name.
25487 \begin_layout Standard
25488 Reverse search is triggered by double-click.
25491 \begin_layout Subsubsection*
25495 \begin_layout Standard
25497 make sure that yap is your default DVI viewer in the Windows environment,
25501 View\SpecialChar menuseparator
25504 menu and select the
25505 \begin_inset Quotes eld
25509 \begin_inset Quotes erd
25514 \begin_inset Quotes eld
25517 New\SpecialChar ldots
25519 \begin_inset Quotes erd
25523 in the window that opens,
25525 \begin_inset Quotes eld
25530 \begin_inset Quotes erd
25533 (or any other name you like) in the
25534 \begin_inset Quotes eld
25538 \begin_inset Quotes erd
25542 Now click on the button labeled
25543 \begin_inset Quotes eld
25548 \begin_inset Quotes erd
25551 to open a file dialog and navigate to the directory containing the
25552 \begin_inset Flex Code
25555 \begin_layout Plain Layout
25561 program (which is installed by default on Cygwin along with the \SpecialChar LyX
25564 \begin_inset Flex Code
25567 \begin_layout Plain Layout
25573 and then specify the program arguments as
25574 \begin_inset Flex Code
25577 \begin_layout Plain Layout
25585 you will be using the
25589 for communicating with \SpecialChar LyX
25592 for whatever reason,
25593 you want to use the
25599 \begin_inset Flex Code
25602 \begin_layout Plain Layout
25608 option and be sure to specify the \SpecialChar LyX
25609 Server pipe path in the \SpecialChar LyX
25613 \begin_layout Standard
25615 reverse search is triggered by double-click.
25618 \begin_layout Subsubsection*
25619 SumatraPDF (Cygwin)
25622 \begin_layout Standard
25623 In order to use SumatraPDF for inverse search,
25625 \begin_inset Flex Code
25628 \begin_layout Plain Layout
25629 SumatraPDF -inverse-search "lyxeditor -g %f %l"
25634 in the viewer setting in
25636 Preferences\SpecialChar menuseparator
25637 File Handling\SpecialChar menuseparator
25638 File formats\SpecialChar menuseparator
25642 If SumatraPDF.exe is not in your command PATH,
25643 use its full posix path.
25645 \begin_inset Flex Code
25648 \begin_layout Plain Layout
25654 enables communication via the
25661 \begin_inset Flex Code
25664 \begin_layout Plain Layout
25670 option if you want to use the
25675 and be sure to specify the \SpecialChar LyX
25676 Server pipe path in the \SpecialChar LyX
25680 \begin_layout Standard
25681 Reverse search is triggered by double-click.
25684 \begin_layout Section
25688 \begin_layout Standard
25690 as the name implies,
25692 \begin_inset Quotes eld
25696 \begin_inset Quotes erd
25700 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
25702 If forward search is set up (as described in what follows),
25703 you can put the cursor anywhere in your \SpecialChar LyX
25707 Navigate\SpecialChar menuseparator
25714 in the context menu via right mouse click),
25715 and then the viewer will jump to that position as well.
25718 that your viewer supports this function.
25721 \begin_layout Standard
25722 To make forward search possible,
25723 you first need to provide the generated output PDF/DVI file with additional information about the \SpecialChar TeX
25725 This can be done via the methods described in the section
25726 \begin_inset CommandInset ref
25728 reference "subsec:rev-search"
25736 \begin_layout Standard
25738 you need to configure \SpecialChar LyX
25739 for using your viewers in
25741 Tools\SpecialChar menuseparator
25742 Preferences\SpecialChar menuseparator
25743 Output\SpecialChar menuseparator
25747 We provide a range of tested configurations for some viewers,
25748 which you can select from the drop down list.
25749 If none of these configurations suits you,
25750 you have to find out and enter a suitable configuration yourself.
25751 The definition syntax uses the following placeholders:
25754 \begin_layout Itemize
25756 \begin_inset Flex Code
25759 \begin_layout Plain Layout
25769 \begin_layout Itemize
25771 \begin_inset Flex Code
25774 \begin_layout Plain Layout
25781 name of the (temporary) exported .tex file (without path)
25784 \begin_layout Itemize
25786 \begin_inset Flex Code
25789 \begin_layout Plain Layout
25796 name of the (temporary) exported .tex file (including path)
25799 \begin_layout Itemize
25801 \begin_inset Flex Code
25804 \begin_layout Plain Layout
25811 name of the exported output file (either dvi or pdf,
25812 depending on which one exists in the temporary directory)
25815 \begin_layout Standard
25816 Note that only some of the viewers provide full and usable forward search functionality out of the box,
25823 \begin_layout Plain Layout
25824 You might want to set
25825 \begin_inset Flex Code
25828 \begin_layout Plain Layout
25836 Tools\SpecialChar menuseparator
25837 Preferences\SpecialChar menuseparator
25838 File Handling\SpecialChar menuseparator
25840 \begin_inset space ~
25854 \begin_layout Plain Layout
25855 SumatraPDF can also use DDE commands through the external program CMCDDE —
25857 \begin_inset CommandInset href
25859 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
25875 \begin_layout Plain Layout
25876 Forward search with evince can be achieved by means of third party helper scripts.
25878 \begin_inset CommandInset href
25880 target "https://wiki.lyx.org/LyX/SyncTeX"
25891 require some extra tools in order to use forward search.
25892 While many of the widespread PDF viewers (most notably Adobe Reader) do not support forward search at all,
25893 some other viewers – e.
25894 \begin_inset space \thinspace{}
25898 xpdf – allow at least to reload the document and jump to a specific page of the file,
25899 so you can at least navigate
25900 \begin_inset Quotes eld
25904 \begin_inset Quotes erd
25908 This latter functionality is provided by an external call of synctex (see the predefined example configurations).
25912 \begin_layout Standard
25913 Forward search works both with DVI and PDF output.
25915 simply checks which preview format you have used before (i.
25916 \begin_inset space \thinspace{}
25920 which format is already there in the temporary directory) and chooses the appropriate configuration for the respective format.\SpecialChar LyX
25921 Features needing Extra Software
25924 \begin_layout Section
25925 Checking \SpecialChar TeX
25929 \begin_layout Standard
25935 \begin_layout Subsection
25939 \begin_layout Standard
25948 \begin_layout Plain Layout
25953 is not yet available when you are using the \SpecialChar LaTeX
25954 distribution MiK\SpecialChar TeX
25969 \begin_inset space ~
25980 \begin_inset Newline newline
25984 \begin_inset CommandInset href
25986 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
25994 \begin_layout Standard
25997 Chk\SpecialChar TeX
26000 package is a program that was written by
26001 \begin_inset Flex Noun
26004 \begin_layout Plain Layout
26006 \begin_inset space ~
26014 in frustration because some constructs in \SpecialChar LaTeX
26015 are sometimes non-intuitive,
26016 and easy to forget.
26017 The program runs over your \SpecialChar LaTeX
26019 checks the integrity of the file,
26020 and flags some common errors.
26021 In other technical words,
26026 for \SpecialChar LaTeX
26030 \begin_layout Standard
26032 what is a syntax checker doing in \SpecialChar LyX
26033 which is supposed to produce correct \SpecialChar LaTeX
26035 The answer is simple:
26040 not only checks the
26049 checks for type-errors,
26052 Chk\SpecialChar TeX
26055 catches some common
26060 in addition to the syntactical ones.
26064 Chk\SpecialChar TeX
26067 is capable of detecting several common errors,
26071 \begin_layout Itemize
26072 Ellipsis detection:
26073 \begin_inset Newline newline
26076 Use \SpecialChar ldots
26080 \begin_layout Itemize
26081 No space in front of/after parenthesis:
26082 \begin_inset Newline newline
26088 \begin_layout Itemize
26089 Enforcement of normal space after common abbreviations:
26090 \begin_inset Newline newline
26094 \begin_inset space \thinspace{}
26098 \begin_inset space \space{}
26101 is too wide spacing.
26104 \begin_layout Itemize
26105 Enforcement of end-of-sentence space when the last sentence ends with a capital letter:
26106 \begin_inset Newline newline
26110 And this is wrong spacing.
26113 \begin_layout Itemize
26114 Space in front of labels and similar commands:
26115 \begin_inset Newline newline
26118 The label should stick right up to the text to avoid falling to a wrong page.
26120 \begin_inset CommandInset label
26130 \begin_layout Plain Layout
26131 This footnote is in danger of falling off to a wrong page
26136 The label is separated too much.
26139 \begin_layout Itemize
26140 Space in front of references,
26141 instead of hard spaces:
26142 \begin_inset Newline newline
26145 If you have bad luck,
26146 the text will break right between the referenced text and reference number,
26149 \begin_inset CommandInset ref
26151 reference "sec:chktex"
26159 \begin_layout Itemize
26161 \begin_inset Quotes eld
26165 \begin_inset Quotes erd
26169 \begin_inset Formula $\times$
26173 \begin_inset Newline newline
26176 2x2 looks cheap compared to
26177 \begin_inset Formula $2\times2$
26183 \begin_layout Standard
26184 and more \SpecialChar ldots
26185 It is an invaluable tool when you are
26186 \begin_inset Quotes eld
26190 \begin_inset Quotes erd
26193 your document before printing,
26194 and you should run it right after the obligatory spelling check,
26195 and before you go fine tuning the typesetting.
26198 \begin_layout Subsection
26202 \begin_layout Standard
26203 If you have the program installed,
26204 usage is as simple as choosing
26206 Tools\SpecialChar menuseparator
26208 \begin_inset space ~
26214 This will make \SpecialChar LyX
26215 generate a \SpecialChar LaTeX
26216 file of your document,
26219 Chk\SpecialChar TeX
26223 and then make \SpecialChar LyX
26225 \begin_inset Quotes eld
26229 \begin_inset Quotes erd
26232 with the warnings from
26234 Chk\SpecialChar TeX
26239 The warnings will be placed close to the point of the mistake,
26240 and you can quickly find them by using the
26242 Navigate\SpecialChar menuseparator
26246 or the shortcut key
26255 Open the error boxes by clicking on them with the mouse,
26256 or use the shortcut key
26265 or the corresponding
26274 Read the warning and correct the mistake,
26275 if it is a mistake.
26276 If you have trouble understanding what the warning is about,
26277 you can safely ignore it.
26278 Remember that there is a hidden layer between the document on screen and the technical details in invoking
26280 Chk\SpecialChar TeX
26284 and this gap can make some warnings seem arcane or just plain silly.
26287 \begin_layout Standard
26288 This document is an excellent testing bed for the feature,
26289 and it should provide quite a few warnings for you to fiddle with.
26290 Since computers are only so smart,
26291 expect most of the warnings to be false alarms,
26295 \begin_layout Subsection
26296 How to fine tune it
26299 \begin_layout Standard
26303 Chk\SpecialChar TeX
26306 makes more noise than suits your mood.
26307 Then you can choose not to use it,
26308 wait until your mood changes,
26309 or try to customize
26311 Chk\SpecialChar TeX
26314 to get better along with you.
26317 \begin_layout Standard
26320 Chk\SpecialChar TeX
26327 very configurable and extensible,
26328 you should not expect to solve all problems with
26330 Chk\SpecialChar TeX
26333 in \SpecialChar LyX
26335 Since \SpecialChar LyX
26336 has to generate a somewhat special \SpecialChar LaTeX
26337 file to be able to match the line numbers from the
26339 Chk\SpecialChar TeX
26346 \begin_layout Plain Layout
26347 You can inspect the specific output from
26353 Document\SpecialChar menuseparator
26356 \begin_inset space ~
26370 to the internal document structure,
26371 some of the warnings will not appear correctly.
26372 There are two things you can do about this:
26375 \begin_layout Itemize
26378 Chk\SpecialChar TeX
26381 invocation command line in
26383 Tools\SpecialChar menuseparator
26384 Preferences\SpecialChar menuseparator
26385 Output\SpecialChar menuseparator
26386 LaTeX\SpecialChar menuseparator
26392 Chk\SpecialChar TeX
26395 installation configuration file (usually with the file
26400 See below to learn what warnings can be enabled and disabled on the command line.
26403 \begin_layout Itemize
26404 Export your document as a raw \SpecialChar LaTeX
26407 File\SpecialChar menuseparator
26408 Export\SpecialChar menuseparator
26417 Invoked in this way,
26418 it can be a hassle to find the corresponding place in the document inside \SpecialChar LyX
26420 but with a little patience,
26421 you should be able to do it.
26424 \begin_layout Standard
26425 Here follows the warning messages that can be enabled and disabled in
26434 to disable a warning,
26439 to enable a warning.
26440 The emphasized entries are disabled by default,
26441 because the default is "
26443 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
26448 \begin_layout Standard
26449 Notice that you should only use the options that enable and disable warnings,
26450 because \SpecialChar LyX
26451 relies on some of the other command line parameters to be set in a specific way to have a chance to communicate with
26458 \begin_layout Enumerate
26462 Command terminated with space.
26465 \begin_layout Enumerate
26468 Non-breaking space (
26469 \begin_inset Quotes eld
26477 \begin_inset Quotes erd
26480 ) should have been used.
26483 \begin_layout Enumerate
26487 You should enclose the previous parenthesis with
26488 \begin_inset Quotes eld
26496 \begin_inset Quotes erd
26502 \begin_layout Enumerate
26505 Italic correction (
26506 \begin_inset Quotes eld
26516 \begin_inset Quotes erd
26519 ) found in non-italic buffer.
26522 \begin_layout Enumerate
26525 Italic correction (
26526 \begin_inset Quotes eld
26536 \begin_inset Quotes erd
26539 ) found more than once.
26542 \begin_layout Enumerate
26546 No italic correction (
26547 \begin_inset Quotes eld
26557 \begin_inset Quotes erd
26563 \begin_layout Enumerate
26567 \begin_inset Quotes eld
26575 \begin_inset Quotes erd
26579 \begin_inset Quotes eld
26587 \begin_inset Quotes erd
26593 \begin_layout Enumerate
26596 Wrong length of dash may have been used.
26599 \begin_layout Enumerate
26603 \begin_inset Quotes eld
26611 \begin_inset Quotes erd
26616 \begin_inset Quotes eld
26624 \begin_inset Quotes erd
26630 \begin_layout Enumerate
26634 \begin_inset Quotes eld
26642 \begin_inset Quotes erd
26648 \begin_layout Enumerate
26652 \begin_inset Quotes eld
26660 \begin_inset Quotes erd
26663 to achieve an ellipsis.
26666 \begin_layout Enumerate
26669 Inter-word spacing (
26670 \begin_inset Quotes eld
26680 \begin_inset Quotes eld
26683 ) should perhaps be used.
26686 \begin_layout Enumerate
26689 Inter-sentence spacing (
26690 \begin_inset Quotes eld
26700 \begin_inset Quotes erd
26703 ) should perhaps be used.
26706 \begin_layout Enumerate
26709 Could not find argument for command.
26712 \begin_layout Enumerate
26716 \begin_inset Quotes eld
26724 \begin_inset Quotes erd
26730 \begin_layout Enumerate
26733 Math mode still on at end of \SpecialChar LaTeX
26737 \begin_layout Enumerate
26741 \begin_inset Quotes eld
26749 \begin_inset Quotes erd
26752 doesn't match the number of
26753 \begin_inset Quotes eld
26761 \begin_inset Quotes erd
26767 \begin_layout Enumerate
26770 You should use either
26773 \begin_inset Quotes eld
26781 \begin_inset Quotes erd
26786 as an alternative to
26787 \begin_inset Quotes eld
26795 \begin_inset Quotes erd
26801 \begin_layout Enumerate
26808 " (ASCII 39) instead of "
26815 \begin_layout Enumerate
26818 User-specified pattern found.
26821 \begin_layout Enumerate
26824 This command might not be intended.
26827 \begin_layout Enumerate
26834 \begin_layout Enumerate
26852 \begin_layout Enumerate
26855 Delete this space to maintain correct page references.
26858 \begin_layout Enumerate
26862 You might wish to put this between a pair of
26863 \begin_inset Quotes eld
26871 \begin_inset Quotes erd
26877 \begin_layout Enumerate
26880 You ought to remove spaces in front of punctuation.
26883 \begin_layout Enumerate
26886 Could not execute \SpecialChar LaTeX
26890 \begin_layout Enumerate
26899 in front of small punctuation.
26902 \begin_layout Enumerate
26910 may look prettier here.
26913 \begin_layout Enumerate
26917 Multiple spaces detected in output.
26920 \begin_layout Enumerate
26923 This text may be ignored.
26926 \begin_layout Enumerate
26932 \begin_inset Quotes eld
26937 to begin quotation,
26945 \begin_layout Enumerate
26956 \begin_inset Quotes eld
26964 \begin_layout Enumerate
26970 \begin_layout Enumerate
26973 You should perhaps use
26974 \begin_inset Quotes eld
26982 \begin_inset Quotes erd
26988 \begin_layout Enumerate
26991 You should put a space in front of/after parenthesis.
26994 \begin_layout Enumerate
26997 You should avoid spaces in front of/after parenthesis.
27000 \begin_layout Enumerate
27004 You should not use punctuation in front of/after quotes.
27007 \begin_layout Enumerate
27010 Double space found.
27013 \begin_layout Enumerate
27016 You should put punctuation outside inner/inside display math mode.
27019 \begin_layout Enumerate
27022 You ought to not use primitive \SpecialChar TeX
27023 in \SpecialChar LaTeX
27027 \begin_layout Enumerate
27030 You should remove spaces in front of
27031 \begin_inset Quotes eld
27039 \begin_inset Quotes erd
27045 \begin_layout Enumerate
27048 \begin_inset Quotes eld
27056 \begin_inset Quotes erd
27059 is normally not followed by
27060 \begin_inset Quotes eld
27068 \begin_inset Quotes erd
27074 \begin_layout Standard
27075 In later versions of \SpecialChar LyX
27077 we hope to provide a more complete interface to this tool (and it's smaller cousin
27081 ) to exploit the full power of it.
27082 But it's not exactly useless as it is now:
27083 go try it on one of your existing documents of a certain length and be surprised.
27086 \begin_layout Section
27087 Version Control in \SpecialChar LyX
27091 \begin_layout Standard
27094 Lars Gullik Bjønnes
27101 \begin_layout Subsection
27105 \begin_layout Standard
27107 supports some of the most basic RCS/CVS/SVN/GIT commands.
27108 If you need something a bit more sophisticated you will have to do that manually in a terminal or your favourite client.
27111 \begin_layout Standard
27112 Also note that CVS support is not as good as subversion support,
27113 so we advise using SVN instead.
27114 A good place to start learning Subversion is the SVN Book
27118 \begin_layout Plain Layout
27119 \begin_inset CommandInset href
27121 target "http://svnbook.red-bean.com/"
27132 In the case of RCS you should read
27133 \begin_inset Quotes eld
27137 \begin_inset Quotes erd
27146 This file describes all the basic features of RCS.
27147 You should especially notice the comment about a RCS directory,
27148 and the notion of a master RCS file (the file ending in
27155 \begin_layout Standard
27156 Before you begin to use the version control features in \SpecialChar LyX
27158 you should be familiar with RCS/CVS/SVN/GIT usage.
27159 The implementation in \SpecialChar LyX
27160 assumes a recent version of the GNU RCS or CVS/SVN package —
27161 no guarantees are made for older versions.
27162 Most of the log messages are not currently displayed after operations —
27163 you can check them in the Messages pane if you are unsure.
27164 Regular users of version control will appreciate the VC toolbar,
27165 which can be enabled via
27167 View\SpecialChar menuseparator
27168 Toolbars\SpecialChar menuseparator
27170 \begin_inset space ~
27178 \begin_layout Standard
27179 For introducing your own external commands consult
27180 \begin_inset Flex Code
27183 \begin_layout Plain Layout
27197 \begin_layout Standard
27198 It is strongly recommended to store documents in uncompressed format if using version control (uncheck
27200 Document\SpecialChar menuseparator
27204 Uncompressed LyX documents are text files and therefore for merging two different versions by version control systems.
27205 Compressed LyX documents are binary files,
27206 which cannot be merged by version control systems.
27207 Also to avoid unnecessary merge conflicts we advise to disable
27209 Document\SpecialChar menuseparator
27210 Settings\SpecialChar menuseparator
27211 Output\SpecialChar menuseparator
27212 Save transient properties
27214 when more users work on the same document.
27217 \begin_layout Subsection
27218 RCS commands in \SpecialChar LyX
27222 \begin_layout Standard
27223 The following sections describe the RCS commands supported by \SpecialChar LyX
27225 You can find them in the
27227 File\SpecialChar menuseparator
27229 \begin_inset space ~
27236 was tested against RCS 5.7/5.8/5.10.
27239 \begin_layout Subsubsection
27245 \begin_layout Standard
27246 If your document is not under revision control,
27247 this is the only item shown in the menu.
27248 And if it is under revision control,
27253 item is not visible.
27257 \begin_layout Standard
27258 This command registers your document with RCS (unless you are under the directory managed by CVS)\SpecialChar endofsentence
27259 You are asked interactively to supply an initial description of the document.
27260 The document is now set in Read-Only mode and you have to
27263 \begin_inset space ~
27267 \begin_inset space ~
27271 \begin_inset space ~
27277 before making any changes to it.
27278 A document under revision control has a
27279 \begin_inset Quotes eld
27282 [RCS:<version> <locker>]
27283 \begin_inset Quotes erd
27286 item tagged to the filename in the minibuffer.
27289 \begin_layout Standard
27290 RCS command that is run:
27293 \begin_layout LyX-Code
27296 ci -q -u -i -t-"<initial description>" <file-name>
27299 \begin_layout Standard
27304 to understand the switches.
27308 \begin_layout Subsubsection
27314 \begin_layout Standard
27315 When you are finished editing a file,
27316 you check in your changes.
27318 you are asked for a description of the changes.
27319 This is stored in the history log.
27320 The version number is bumped,
27321 your changes are applied to the master RCS file,
27322 the document is unlocked and set to Read-Only mode.
27325 \begin_layout Itemize
27329 ci -q -u -m"<description>" <file-name>
27332 \begin_layout Subsubsection
27338 \begin_layout Standard
27339 By doing this you lock the document so that only you can edit it.
27340 This will also make the document Read-Write only for you.
27341 You will usually continue editing for a while and when you are finished you check in your changes.
27342 The status line is changed to reflect that you have locked the file.
27345 \begin_layout Itemize
27349 co -q -l <file-name>
27352 \begin_layout Subsubsection
27355 Revert To Repository Version
27358 \begin_layout Standard
27359 This will discard all changes made to the document since the last check in.
27360 You get a warning before changes are discarded.
27363 \begin_layout Itemize
27367 co -f -u<version> <file-name>
27370 \begin_layout Subsubsection
27376 \begin_layout Standard
27377 This will create a copy of the current document.
27378 Since RCS does not support copy operations natively,
27379 the version history is not preserved,
27380 and the copy is added as a new file.
27381 It requires a clean document without any changes since the last checkin.
27382 You are asked for a file name and a description of the copy operation.
27383 After that the copy is created,
27384 both locally and in the repository.
27385 If the parent directories of the copied and original document differ,
27386 all relative paths of included files of the copy are adjusted (like in
27388 File\SpecialChar menuseparator
27394 the copy is loaded instead of the original document.
27397 \begin_layout Labeling
27398 \labelwidthstring 00.00.0000
27400 \begin_inset space ~
27405 \begin_inset space ~
27409 \begin_inset Newline newline
27413 \begin_inset Flex Code
27416 \begin_layout Plain Layout
27419 \begin_inset Quotes qld
27423 \begin_inset Quotes qld
27432 \begin_inset Flex Code
27435 \begin_layout Plain Layout
27438 \begin_inset Quotes qld
27442 \begin_inset Quotes qld
27451 \begin_inset Newline newline
27455 \begin_inset Flex Code
27458 \begin_layout Plain Layout
27462 \begin_inset Quotes qld
27466 \begin_inset Quotes qld
27477 \begin_layout Subsubsection
27483 \begin_layout Standard
27484 This makes as if the last check in never happened.
27485 No changes are made to the document loaded into \SpecialChar LyX
27487 but the last version is removed from the master RCS file.
27490 \begin_layout Itemize
27494 rcs -o<version> <file-name>
27497 \begin_layout Subsubsection
27503 \begin_layout Standard
27504 This shows the complete history of the RCS document.
27509 is shown in a browser.
27517 \begin_layout Subsubsection
27521 \begin_layout Standard
27523 supports RCS version number,
27525 date and time of last commit.
27526 All those are extracted from
27528 rlog -r <file-name>
27532 \begin_inset CommandInset ref
27534 reference "subsec:VCS-Revision-Information"
27542 \begin_layout Subsection
27543 CVS commands in \SpecialChar LyX
27547 \begin_layout Standard
27548 A subset of CVS operations is supported by \SpecialChar LyX
27550 You can find the commands in the
27552 File\SpecialChar menuseparator
27554 \begin_inset space ~
27560 The version control system SVN is more powerful,
27561 so please use it instead of CVS if possible.
27564 \begin_layout Subsubsection
27570 \begin_layout Standard
27571 If you start from scratch with CVS you have to create your repository and checkout the working copy with external tools.
27572 If you're using a client-server setup you may need to login before doing the first repository checkout.
27575 \begin_layout Standard
27576 If your documents are under revision control and others are using the same repository problems arise when different changes to the same document at the same location happen.
27577 Standard CVS repositories don't operate with a file locking mechanism.
27578 This may be surprising,
27579 but conflicts only occur if people disagree on the proper content of the same part of a document.
27581 if co-workers are used to communicate regularly,
27582 these conflicts occur rarely.
27583 If they don't communicate they have a fundamental problem anyway.
27584 Nevertheless some people like to work with so called
27585 \begin_inset Quotes eld
27589 \begin_inset Quotes erd
27593 If they do so the working copy of all files is readonly when checked out first and the user starts editing after using a special command to make the working copy writable.
27594 When the changes are checked in the working copy returns to readonly state.
27595 With \SpecialChar LyX
27596 one has to edit the
27597 \begin_inset Flex Code
27600 \begin_layout Plain Layout
27606 file and add the line
27607 \begin_inset Flex Code
27610 \begin_layout Plain Layout
27616 to work with reserved checkouts.
27617 The benefit is the possibility to see who is using a writable copy of some document.
27618 It's not guaranteed only one user makes a copy writable.
27621 \begin_layout Standard
27623 tries to guess if you're using reserved or non-reserved checkouts.
27624 If your working copy is readonly or it is writable and an additional copy of your document exists in the CVS/Base sub-directory a reserved otherwise a non-reserved checkout is assumed.
27625 When a reserved checkout is detected you have to use
27626 \begin_inset Flex Noun
27629 \begin_layout Plain Layout
27635 to make your working copy writable if it's readonly.
27637 \begin_inset Flex Noun
27640 \begin_layout Plain Layout
27646 operation is possible and that makes your working copy readonly again after transferring your changes to the repository.
27649 \begin_layout Standard
27650 More information about CVS can be found here
27651 \begin_inset Flex URL
27654 \begin_layout Plain Layout
27656 http://www.nongnu.org/cvs
27662 \begin_inset Flex URL
27665 \begin_layout Plain Layout
27667 http://ximbiot.com/cvs
27675 \begin_layout Standard
27680 to understand the sub-commands and the switches mentioned below.
27683 \begin_layout Subsubsection
27689 \begin_layout Standard
27690 If your document is not under revision control,
27691 this is the only item shown in the menu.
27692 And if it is under revision control,
27697 item is not visible.
27701 \begin_layout Standard
27702 This command registers in CVS your document
27703 \begin_inset Flex Strong
27706 \begin_layout Plain Layout
27714 in the case you have already the documents directory under CVS control (in particular
27719 This means you have to create or checkout the archive by yourself using external tools.
27720 (In case you forget that step \SpecialChar LyX
27721 registers the document with RCS.)
27724 \begin_layout Standard
27725 Then you are asked interactively to supply an initial description of the document.
27726 Don't forget that registered file is not yet checked in.
27729 \begin_layout Standard
27730 CVS command that is run:
27733 cvs -q add -m"<entered message>" "<file-name>"
27736 \begin_layout Standard
27741 above and for all other CVS commands is an abbreviation for
27742 \begin_inset Quotes eld
27745 change the current working directory to file location and use the file name without path component as argument
27746 \begin_inset Quotes erd
27752 \begin_layout Subsubsection
27758 \begin_layout Standard
27759 When you are finished editing a file,
27760 you commit your changes.
27761 When you do this and you had changed the document,
27762 you are asked for a description of the changes.
27763 After that changes are written to the repository.
27764 In case you didn't change the document and a reserved checkout is detected the reservation made on
27765 \begin_inset Flex Noun
27768 \begin_layout Plain Layout
27777 \begin_layout Labeling
27778 \labelwidthstring 00.00.0000
27780 \begin_inset space ~
27785 \begin_inset space ~
27789 \begin_inset Newline newline
27793 \begin_inset Flex Code
27796 \begin_layout Plain Layout
27799 -q commit -m"<description>" "<file-name>"
27805 \begin_inset Newline newline
27809 \begin_inset Flex Code
27812 \begin_layout Plain Layout
27823 \begin_layout Subsubsection
27829 \begin_layout Standard
27830 When you are sharing a repository with others,
27831 you may have to incorporate their changes into your working copy.
27834 \begin_layout Standard
27838 cvs -q update "<file-name>"
27841 \begin_layout Standard
27842 If a readonly checkout is detected the working copy is made writable and reserved.
27845 \begin_layout Standard
27849 cvs -q edit "<file-name>"
27852 \begin_layout Subsubsection
27855 Revert To Repository Version
27858 \begin_layout Standard
27859 This will discard all changes made to the document since the last check in.
27860 You get a warning before changes are discarded.
27861 Firstly the file is deleted,
27862 secondly CVS update command is run.
27865 \begin_layout Standard
27869 cvs -q update "<file-name>"
27872 \begin_layout Standard
27873 If a reserved checkout is detected and the working copy has no changes only the reservation is undone.
27876 \begin_layout Standard
27880 cvs -q unedit "<file-name>"
27883 \begin_layout Subsubsection
27889 \begin_layout Standard
27890 This will create a copy of the current document.
27891 Since CVS does not support copy operations natively,
27892 the version history is not preserved,
27893 and the copy is added as a new file.
27894 It requires a clean document without any changes since the last checkin.
27895 You are asked for a file name and a description of the copy operation.
27896 After that the copy is created,
27897 both locally and in the repository.
27898 If the parent directories of the copied and original document differ,
27899 all relative paths of included files of the copy are adjusted (like in
27901 File\SpecialChar menuseparator
27907 the copy is loaded instead of the original document.
27910 \begin_layout Labeling
27911 \labelwidthstring 00.00.0000
27913 \begin_inset space ~
27918 \begin_inset space ~
27922 \begin_inset Newline newline
27926 \begin_inset Flex Code
27929 \begin_layout Plain Layout
27936 \begin_inset Flex Code
27939 \begin_layout Plain Layout
27946 \begin_inset Newline newline
27950 \begin_inset Flex Code
27953 \begin_layout Plain Layout
27954 cvs -q add "<new-file-name>"
27962 \begin_layout Subsubsection
27968 \begin_layout Standard
27969 This will rename the current document.
27970 Since CVS does not support rename operations natively,
27971 the version history is not preserved,
27972 the renamed document is added as a new file,
27973 and the original document is deleted.
27974 It requires a clean document without any changes since the last checkin.
27975 You are asked for a file name and a description of the rename operation.
27976 After that the document is renamed,
27977 both locally and in the repository.
27978 If the parent directories of the new and old file names differ,
27979 all relative paths of included files are adjusted (like in
27981 File\SpecialChar menuseparator
27987 the document is reloaded using the new name.
27990 \begin_layout Labeling
27991 \labelwidthstring 00.00.0000
27993 \begin_inset space ~
27998 \begin_inset space ~
28002 \begin_inset Newline newline
28006 \begin_inset Flex Code
28009 \begin_layout Plain Layout
28016 \begin_inset Flex Code
28019 \begin_layout Plain Layout
28026 \begin_inset Newline newline
28030 \begin_inset Flex Code
28033 \begin_layout Plain Layout
28034 cvs -q add "<new-file-name>"
28040 \begin_inset Newline newline
28044 \begin_inset Flex Code
28047 \begin_layout Plain Layout
28048 cvs -q remove "<file-name>"
28056 \begin_layout Subsubsection
28057 Update of the local directory checkout from repository
28060 \begin_layout Standard
28061 Once your documents gets more complex,
28062 containing sub-documents and pictures,
28064 \begin_inset Flex Code
28067 \begin_layout Plain Layout
28073 files and so on using version control becomes more complicated.
28075 supports updating the whole tree in which resides the document.
28076 This become especially useful once you cooperate with people which neither have detailed knowledge about CVS usage nor they have ambition to commit additional material to the repository.
28077 You have to organize the files structure so that all external files are in the same directory or subdirectories of the document.
28078 It's good practice anyway to store multipart documents in an extra directory.
28081 \begin_layout Standard
28083 \begin_inset Flex Code
28086 \begin_layout Plain Layout
28087 Update local directory from repository
28092 command updates the whole directory.
28093 If local changes are detected user is warned before update starts.
28094 In case of merge conflicts both versions of the conflicting document parts are placed in the final document.
28095 You have to review and correct the result of the merge.
28096 You'll find the conflicts enclosed in pairs of
28097 \begin_inset Flex Code
28100 \begin_layout Plain Layout
28107 \begin_inset Flex Code
28110 \begin_layout Plain Layout
28117 \begin_inset Flex Code
28120 \begin_layout Plain Layout
28127 The first part is your version as before the update operation with the document name prepended.
28128 The second one is the repository version with the version number after the sequence of
28129 \begin_inset Flex Code
28132 \begin_layout Plain Layout
28141 \begin_layout Labeling
28142 \labelwidthstring 00.00.0000
28144 \begin_inset space ~
28149 \begin_inset space ~
28153 \begin_inset Newline newline
28157 \begin_inset Flex Code
28160 \begin_layout Plain Layout
28169 (Ask if changes are detected.)
28170 \begin_inset Newline newline
28174 \begin_inset Flex Code
28177 \begin_layout Plain Layout
28189 \begin_layout Standard
28191 \begin_inset Flex Code
28194 \begin_layout Plain Layout
28200 stands for the path to the document.
28203 \begin_layout Subsubsection
28209 \begin_layout Standard
28210 This shows the complete history of the CVS document.
28213 cvs log "<file-name>"
28215 is shown in a browser.
28218 \begin_layout Subsubsection
28222 \begin_layout Standard
28224 supports CVS version number,
28226 date and time of last commit.
28227 All those are extracted from
28229 cvs log -r <file-name>
28233 \begin_inset CommandInset ref
28235 reference "subsec:VCS-Revision-Information"
28243 \begin_layout Subsection
28244 SVN commands in \SpecialChar LyX
28248 \begin_layout Standard
28249 SVN is now partially supported by \SpecialChar LyX
28251 You can find the commands in the
28253 File\SpecialChar menuseparator
28255 \begin_inset space ~
28261 Please note that if you use password protected access to repository via ssh,
28262 you will be asked in terminal window.
28264 was tested against SVN 1.5,
28270 \begin_layout Plain Layout
28271 Most of the commands will work with 1.4 too,
28273 \begin_inset CommandInset ref
28275 reference "subsec:SVN-Repo-Update"
28281 There seems to be currently unresolved permissions problem under SVN 1.8 with reverting changes when file is locked.
28289 \begin_layout Subsubsection
28295 \begin_layout Standard
28296 If your document is not under revision control,
28297 this is the only item shown in the menu.
28298 And if it is under revision control,
28303 item is not visible.
28306 \begin_layout Standard
28307 This command registers in SVN your document ONLY in case you have already the documents directory under SVN control (in particular
28312 This means you have to checkout the archive by yourself.
28315 \begin_layout Standard
28316 Then you are asked interactively to supply an initial description of the document.
28317 Don't forget that registered file is not yet commited.
28320 \begin_layout Standard
28321 SVN command that is run:
28325 \begin_inset Quotes qld
28329 \begin_inset Quotes qld
28335 \begin_layout Standard
28340 to understand the switches.
28343 \begin_layout Subsubsection
28349 \begin_layout Standard
28350 When you are finished editing a file,
28351 you commit your changes.
28353 you are asked for a description of the changes.
28354 After that changes are commited.
28357 \begin_layout Standard
28362 \begin_layout Plain Layout
28363 In case locking is not enabled.
28365 \begin_inset CommandInset ref
28367 reference "subsec:SVN-File-Locking"
28379 svn commit -q -m"<description>" <file-name>
28382 \begin_layout Subsubsection
28388 \begin_layout Standard
28389 Updates the changes of this file from the repository.
28390 Be sure you understand SVN merging and conflicts resolving before using this function,
28391 because all conflicts has to be resolved manually by you!
28394 \begin_layout Standard
28399 \begin_layout Plain Layout
28407 svn update --non-interactive
28408 \begin_inset Quotes qld
28412 \begin_inset Quotes qld
28418 \begin_layout Subsubsection
28421 Revert To Repository Version
28424 \begin_layout Standard
28425 This will discard all changes made to the document since the last check in.
28426 You get a warning before changes are discarded.
28429 \begin_layout Standard
28434 \begin_inset Quotes qld
28438 \begin_inset Quotes qld
28444 \begin_layout Subsubsection
28450 \begin_layout Standard
28451 This will create a copy of the current document including the version history.
28452 It requires a clean document without any changes since the last checkin.
28453 You are asked for a file name and a description of the copy operation.
28454 After that the copy is created,
28455 both locally and in the repository.
28456 If the parent directories of the copied and original document differ,
28457 all relative paths of included files of the copy are adjusted (like in
28459 File\SpecialChar menuseparator
28465 the copy is loaded instead of the original document.
28468 \begin_layout Labeling
28469 \labelwidthstring 00.00.0000
28471 \begin_inset space ~
28476 \begin_inset space ~
28480 \begin_inset Newline newline
28484 \begin_inset Flex Code
28487 \begin_layout Plain Layout
28491 \begin_inset Quotes qld
28495 \begin_inset Quotes qld
28499 \begin_inset Quotes qld
28503 \begin_inset Quotes qld
28512 \begin_inset Newline newline
28516 \begin_inset Flex Code
28519 \begin_layout Plain Layout
28528 \begin_layout Subsubsection
28534 \begin_layout Standard
28535 This will rename the current document including the version history.
28536 It requires a clean document without any changes since the last checkin.
28537 You are asked for a file name and a description of the rename operation.
28538 After that the document is renamed,
28539 both locally and in the repository.
28540 If the parent directories of the new and old file names differ,
28541 all relative paths of included files are adjusted (like in
28543 File\SpecialChar menuseparator
28549 the document is reloaded using the new name.
28552 \begin_layout Labeling
28553 \labelwidthstring 00.00.0000
28555 \begin_inset space ~
28560 \begin_inset space ~
28564 \begin_inset Newline newline
28568 \begin_inset Flex Code
28571 \begin_layout Plain Layout
28575 \begin_inset Quotes qld
28579 \begin_inset Quotes qld
28583 \begin_inset Quotes qld
28587 \begin_inset Quotes qld
28596 \begin_inset Newline newline
28600 \begin_inset Flex Code
28603 \begin_layout Plain Layout
28612 \begin_layout Subsubsection
28613 \begin_inset CommandInset label
28615 name "subsec:SVN-Repo-Update"
28619 Update of the local directory checkout from repository
28623 \begin_layout Plain Layout
28624 Note that this command will work only with subversion
28625 \begin_inset Formula $\geqq1.5$
28636 \begin_layout Standard
28637 All the commands above have one shortcoming – they deal with the current document only.
28638 Once your document contains pictures,
28640 \begin_inset Flex Code
28643 \begin_layout Plain Layout
28649 files and so on administration becomes more complicated.
28651 now supports updating the whole tree in which resides the document
28655 \begin_layout Plain Layout
28656 One need to organize the files structure so that all external files are in the same directory or subdirectories of the document.
28663 This become especially useful once you cooperate with people which neither know about subversion management nor they have ambition to commit additional material to the repository.
28667 \begin_layout Standard
28668 \begin_inset Flex Code
28671 \begin_layout Plain Layout
28672 Update local directory from repository
28677 command updates the whole directory and in case of merge conflicts local version of the files are left,
28678 so no unintended data loss occurs.
28679 If local changes are detected user is warned before update starts.
28682 \begin_layout Labeling
28683 \labelwidthstring 00.00.0000
28685 \begin_inset space ~
28690 \begin_inset space ~
28694 \begin_inset Newline newline
28698 \begin_inset Flex Code
28701 \begin_layout Plain Layout
28707 (Ask if changes are detected.)
28708 \begin_inset Newline newline
28712 \begin_inset Flex Code
28715 \begin_layout Plain Layout
28716 svn update --accept mine-full $path
28724 \begin_layout Standard
28726 \begin_inset Flex Code
28729 \begin_layout Plain Layout
28735 stands for the path to the document.
28738 \begin_layout Subsubsection
28744 \begin_layout Standard
28745 This shows the complete history of the SVN document.
28749 \begin_inset Quotes qld
28753 \begin_inset Quotes qld
28758 is shown in a browser.
28761 \begin_layout Subsubsection
28763 \begin_inset CommandInset label
28765 name "subsec:SVN-File-Locking"
28772 \begin_layout Standard
28773 The file exchange through various revision control systems brings the problem of merge conflicts in case two different users try to edit the same (parts of) document.
28774 When such a conflict happens it needs manual resolving and one reasonable alternative is to provide some kind of locking mechanism,
28775 which guarantees that only one user is allowed to edit file at the given time.
28778 \begin_layout Standard
28779 SVN has two such mechanisms to provide mutual exclusivity for file access – locks and automatic setting of write permissions (see sec.
28781 \begin_inset CommandInset ref
28783 reference "subsec:Automatical-Locking-Property"
28789 \begin_inset Flex Code
28792 \begin_layout Plain Layout
28802 \begin_layout Plain Layout
28803 \begin_inset Flex URL
28806 \begin_layout Plain Layout
28808 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
28819 If this property is detected for a given document \SpecialChar LyX
28820 starts to use SVN locks for document editing automatically and the whole check-in/out mechanism switches to the same regimen as for RCS.
28821 This in particular means there are two different modes of file use in \SpecialChar LyX
28825 \begin_layout Itemize
28827 The loaded file is in the read-only mode.
28828 For editing on needs to check-out.
28833 consists of updating from the repository and gaining write lock.
28834 If the lock is not possible to obtain,
28835 we remain in unlocked state.
28838 \begin_layout Itemize
28840 The loaded file is in the
28841 \begin_inset Quotes els
28845 \begin_inset Quotes ers
28849 No other user is allowed to edit the file.
28854 consists of commiting changes and releasing write-lock.
28855 If no changes have been made to the document,
28856 no commit will be produced
28860 \begin_layout Plain Layout
28861 Don't be puzzled by the fact that you will be asked for commit message anyway.
28866 and only the write-lock will be released.
28869 \begin_layout Standard
28873 \begin_layout Labeling
28874 \labelwidthstring 00.00.0000
28878 svn commit -q -m"<description>" "<file-name>"
28879 \begin_inset Newline newline
28882 svn unlock "<file-name>"
28885 \begin_layout Labeling
28886 \labelwidthstring 00.00.0000
28890 svn update "<file-name>"
28891 \begin_inset Newline newline
28894 svn lock "<file-name>"
28897 \begin_layout Subsubsection
28900 \begin_inset CommandInset label
28902 name "subsec:Automatical-Locking-Property"
28908 Automatic Locking Property
28911 \begin_layout Standard
28912 The above mentioned automatic setting of write permissions of the .lyx file can be set through
28914 File\SpecialChar menuseparator
28916 \begin_inset space ~
28919 Control\SpecialChar menuseparator
28920 Use Locking Property
28923 This command is active only when the file is not locked on the svn server (i.e.
28924 you need to check-out before proceeding).
28927 \begin_layout Labeling
28928 \labelwidthstring 00.00.0000
28930 \begin_inset space ~
28936 \begin_layout Labeling
28937 \labelwidthstring 00.00.0000
28941 svn propset svn:needs-lock ON "<file-name>"
28944 \begin_layout Labeling
28945 \labelwidthstring 00.00.0000
28949 svn propdel svn:needs-lock "<file-name>"
28952 \begin_layout Subsubsection
28953 \begin_inset CommandInset label
28955 name "subsec:VCS-Revision-Information"
28959 Revision Information in Documents
28962 \begin_layout Standard
28963 There are more possibilities how to activate revision information in our document.
28966 \begin_layout Itemize
28972 \begin_layout Itemize
28973 tree revision information (
28974 \begin_inset Flex Code
28977 \begin_layout Plain Layout
28984 The result is the output of the
28985 \begin_inset Flex Code
28988 \begin_layout Plain Layout
28995 the following table gives you an idea,
28996 how to read the results.
28999 \begin_layout Standard
29001 \begin_inset Tabular
29002 <lyxtabular version="3" rows="6" columns="2">
29003 <features tabularvalignment="middle">
29004 <column alignment="left" valignment="top">
29005 <column alignment="left" valignment="top">
29007 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
29010 \begin_layout Plain Layout
29018 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
29021 \begin_layout Plain Layout
29031 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
29034 \begin_layout Plain Layout
29040 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
29043 \begin_layout Plain Layout
29044 mixed revision working copy
29051 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
29054 \begin_layout Plain Layout
29060 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
29063 \begin_layout Plain Layout
29064 modified working copy
29071 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
29074 \begin_layout Plain Layout
29080 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
29083 \begin_layout Plain Layout
29084 switched working copy
29091 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
29094 \begin_layout Plain Layout
29100 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
29103 \begin_layout Plain Layout
29104 partial working copy,
29105 from a sparse checkout
29112 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
29115 \begin_layout Plain Layout
29121 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
29124 \begin_layout Plain Layout
29127 switched working copy
29140 \begin_layout Itemize
29141 file revision information.
29142 The result comes from parsing the output of
29143 \begin_inset Flex Code
29146 \begin_layout Plain Layout
29148 \begin_inset space ~
29152 \begin_inset space ~
29156 \begin_inset space ~
29165 Supported flags are:
29169 \begin_layout Itemize
29170 version number of the last commit (
29171 \begin_inset Flex Code
29174 \begin_layout Plain Layout
29183 \begin_layout Itemize
29184 author of the last commit (
29185 \begin_inset Flex Code
29188 \begin_layout Plain Layout
29197 \begin_layout Itemize
29198 date of the last commit (
29199 \begin_inset Flex Code
29202 \begin_layout Plain Layout
29211 \begin_layout Itemize
29212 time of the last commit (
29213 \begin_inset Flex Code
29216 \begin_layout Plain Layout
29226 \begin_layout Standard
29227 You can obtain this info via InsetInfo (
29229 Insert\SpecialChar menuseparator
29230 Field\SpecialChar menuseparator
29231 Version Control Revision
29234 The information will be available only when you have the file stored under svn managment (i.e.
29236 \begin_inset Flex Code
29239 \begin_layout Plain Layout
29245 directory is available with your document).
29249 \begin_layout Itemize
29252 possibility is to use svn keywords
29256 \begin_layout Plain Layout
29257 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
29263 In short – you set file keywords property (e.g.
29266 svn propset svn:keywords 'Rev' file.lyx
29268 ) and then paste keyword \SpecialChar TeX
29273 \begin_layout Plain Layout
29274 This is an easy way how to ensure that \SpecialChar LyX
29275 won't break the line in the middle of keyword tag.
29280 tag in your document (e.g.
29282 \begin_inset Flex Code
29285 \begin_layout Plain Layout
29292 This way svn client will automatically substitute revision number (e.g.
29294 \begin_inset Flex Code
29297 \begin_layout Plain Layout
29304 ) after each update and commit.
29305 There are more problems with this approach.
29307 the '$' character is used in \SpecialChar TeX
29308 world for math equations,
29309 so any occurence of math formula
29310 \begin_inset Formula $Rev$
29314 \begin_inset Formula $Rev:59$
29317 in your \SpecialChar LyX
29319 Similarly for other keywords like Id,
29323 Secondly svn output is dependent on your locales,
29324 so its very easy that svn would produce some problematic strings once Date is used.
29325 Thirdly you get the whole 'Rev:
29326 59' string in your document instead of the plain number.
29327 Until subversion implements user's custom keywords it will be hard to use this approach reliably or let \SpecialChar LyX
29328 to support it directly.
29331 \begin_layout Subsection
29332 SVN and Windows Environment
29335 \begin_layout Quote
29336 My inclination is to say that if the user cannot figure out the command line operations on their own fairly quickly,
29337 they would be well advised to use TortoiseSVN.
29344 \begin_layout Subsubsection
29348 \begin_layout Standard
29349 In addition to installing \SpecialChar LyX
29351 and having access to a Subversion repository,
29352 the user will need to install the Subversion client program.
29353 A Windows installer for the client program is available from
29354 \begin_inset CommandInset href
29357 target "http://www.collab.net/nonav/downloads/subversion/"
29363 The user may also want to install
29364 \begin_inset CommandInset href
29367 target "http://tortoisesvn.tigris.org/"
29373 which integrates Subversion operations into the context (rightclick) menu of Windows Explorer.
29374 Operations done outside \SpecialChar LyX
29375 will typically be more convenient using the Explorer context menu.
29376 Note that TortoiseSVN is not a replacement for the client program,
29377 which is what \SpecialChar LyX
29381 \begin_layout Subsubsection
29382 Bringing a document under Subversion control
29385 \begin_layout Standard
29386 Before a \SpecialChar LyX
29387 document can be brought under version control in Subversion,
29388 its parent directory needs to be under version control.
29389 If the document is being added to a project already in the repository,
29390 this is accomplished by checking the project out to the directory where the new document will be placed.
29391 If the project itself is not yet under version control (for instance,
29392 if this document starts a new project),
29393 the directory must be imported into the repository.
29394 This is done outside \SpecialChar LyX
29396 Both import and checkout are easily accomplished from the Explorer context menu using TortoiseSVN,
29397 or alternatively can be done using the command line client at a DOS prompt.
29398 The procedure for importing the project using TortoiseSVN is described below,
29399 assuming an existing repository and a new project being started in
29406 For information on using the Subversion client program,
29414 \begin_layout Enumerate
29421 in Windows Explorer,
29425 TortoiseSVN\SpecialChar menuseparator
29430 adjust the URL for the repository,
29434 \begin_layout Enumerate
29435 Right click the level of the repository under which you want to place the new project folder (typically the top level) and click
29439 Supply a name for the project folder and click OK.
29440 Add a message for the log file if desired,
29441 then click OK again.
29442 The new project folder should appear in the repository.
29444 click OK again to exit the repository browser.
29447 \begin_layout Enumerate
29448 Once again right click
29455 this time selecting SVN Checkout\SpecialChar ldots
29456 Select the URL of the project folder you just created in the repository,
29457 and set the checkout directory to
29465 You will be warned about a non-empty folder;
29466 click OK to proceed.
29467 You should now have a
29478 \begin_layout Enumerate
29479 Create or open your document in \SpecialChar LyX
29482 File\SpecialChar menuseparator
29484 \begin_inset space ~
29487 Control\SpecialChar menuseparator
29491 Add a log message and click OK to commit the document to version control.
29494 \begin_layout Standard
29495 From this point onward,
29496 you should have full functionality in the
29498 File\SpecialChar menuseparator
29500 \begin_inset space ~
29506 You also have the option of checking the document in and out,
29507 viewing its history,
29509 using the TortoiseSVN context menu in Windows Explorer or the Subversion client program from a command prompt.
29512 \begin_layout Subsubsection
29513 SSH tunnel used with SVN under Windows
29516 \begin_layout Standard
29517 Compared with Linux setting up an svn client to communicate over ssh under Windows is a rather troublesome task.
29518 We will at least offer some hints how to setup the client side but prior knowledge about ssh and the Windows command line is needed,
29519 also be prepared for a great deal of frustration\SpecialChar ldots
29523 \begin_layout Enumerate
29524 Get an svn client for windows,
29525 as described in the previous sections.
29526 When it is a fresh install run some svn command (e.g.
29528 \begin_inset Flex Code
29531 \begin_layout Plain Layout
29537 ) to create config files,
29538 which you will need to change later on.
29541 \begin_layout Enumerate
29542 Choose an ssh client for Windows.
29543 There are several possibilities,
29544 we will use the one from Putty tools
29548 \begin_layout Plain Layout
29549 \begin_inset Flex URL
29552 \begin_layout Plain Layout
29554 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
29565 You will need to set the connection up so that the client doesn't ask for any password from you.
29566 To keep things easy we will use only keys without any additional password protection etc.
29570 \begin_layout Enumerate
29572 \begin_inset Flex Code
29575 \begin_layout Plain Layout
29582 Save your private .ppk key file and put the public one on the server side.
29583 If the SVN server runs on Linux,
29584 note that the format of the public key is not compatible with Linux openssh and you will need to direcly copy-paste the key from the
29585 \begin_inset Quotes eld
29590 Public key for pasting into OpenSSH authorized_keys file
29593 \begin_inset Quotes erd
29596 edit field into the server's
29597 \begin_inset Flex Code
29600 \begin_layout Plain Layout
29601 ~/.ssh/authorized_keys
29607 \begin_inset Flex Code
29610 \begin_layout Plain Layout
29619 \begin_layout Enumerate
29621 \begin_inset Flex Code
29624 \begin_layout Plain Layout
29631 In the SVN config file
29635 \begin_layout Plain Layout
29636 Exact path depends on Windows version,
29637 usually somewhere around
29638 \begin_inset Flex Code
29641 \begin_layout Plain Layout
29644 Documents and Settings
29658 \begin_inset Flex Code
29661 \begin_layout Plain Layout
29681 \begin_inset Flex Code
29684 \begin_layout Plain Layout
29685 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
29694 \begin_layout Plain Layout
29695 It will usually take a lot of time to get exact command right and it depends on many things.
29696 For example do not have some remote server saved as a default session in Putty etc.
29698 try to connect via plink without SVN first.
29707 \begin_layout Enumerate
29708 Checkout the SVN archive,
29710 \begin_inset space \thinspace{}
29714 \begin_inset Newline newline
29718 \begin_inset Flex Code
29721 \begin_layout Plain Layout
29722 svn co svn+ssh://user@server/repository_path
29730 \begin_layout Subsubsection
29731 End-of-Line Conversions
29734 \begin_layout Standard
29735 When the collaborators are mixing Linux and Windows environments,
29737 will use different line endings inside the .lyx files.
29738 This is not a problem as far as \SpecialChar LyX
29739 functionality is concerned,
29740 but the commit diffs will be huge and merge-conflicts prone.
29741 Fortunately SVN itself knows
29745 \begin_layout Plain Layout
29746 \begin_inset Flex URL
29749 \begin_layout Plain Layout
29751 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
29761 how to deal with CR/LF problems when switching .lyx files to the
29762 \begin_inset Flex Code
29765 \begin_layout Plain Layout
29775 \begin_layout Plain Layout
29778 \begin_inset Flex Code
29781 \begin_layout Plain Layout
29782 svn propset svn:eol-style native FILE_NAME
29795 \begin_layout Subsection
29796 GIT commands in \SpecialChar LyX
29800 \begin_layout Standard
29801 A minimal subset of GIT commands is now supported by \SpecialChar LyX
29803 You can find the commands in the
29805 File\SpecialChar menuseparator
29807 \begin_inset space ~
29813 Please note that if you use password protected access to repository via ssh,
29814 you will be asked in terminal window.
29816 was tested against GIT 1.7/2.30.
29820 \begin_layout Plain Layout
29821 Windows users please note that you need to ensure that git is on the path.
29822 This can be set from within \SpecialChar LyX
29825 Tools\SpecialChar menuseparator
29826 Preferences\SpecialChar menuseparator
29827 Paths\SpecialChar menuseparator
29838 \begin_layout Standard
29839 One big difference of GIT and the other supported version control systems is the distributed nature of GIT:
29840 With traditional version control systems there is one central server which hosts the repository.
29841 Users commit their changes to the server,
29842 and get updates made by other users from it.
29844 users commit to a local repository.
29845 The local repository can be synchronized with one or more remote repositories using the
29846 \begin_inset Flex Code
29849 \begin_layout Plain Layout
29856 \begin_inset Flex Code
29859 \begin_layout Plain Layout
29867 does not interact in any way with remote GIT repositories.
29868 It works exclusively with the local repository in a very similar way as with a central CVS or SVN repository.
29869 If you use remote GIT repositories you need to do the
29870 \begin_inset Flex Code
29873 \begin_layout Plain Layout
29880 \begin_inset Flex Code
29883 \begin_layout Plain Layout
29889 operations with your favourite GIT client.
29892 \begin_layout Subsubsection
29898 \begin_layout Standard
29899 If your document is not under revision control,
29900 this is the only item shown in the menu.
29901 And if it is under revision control,
29906 item is not visible.
29909 \begin_layout Standard
29910 This command registers in GIT your document ONLY in case you have already the documents directory under GIT control (in particular
29918 \begin_layout Plain Layout
29923 *and* initial repository commit (or at least
29927 ) needs to be manually done.
29933 This means you have to checkout the archive by yourself.
29936 \begin_layout Standard
29937 Then you are asked interactively to supply an initial description of the document.
29938 Don't forget that registered file is not yet committed.
29941 \begin_layout Standard
29942 GIT command that is run:
29946 \begin_inset Quotes qld
29950 \begin_inset Quotes qld
29956 \begin_layout Standard
29961 to understand the switches.
29964 \begin_layout Subsubsection
29970 \begin_layout Standard
29971 When you are finished editing a file,
29972 you commit your changes.
29974 you are asked for a description of the changes.
29975 After that changes are committed.
29978 \begin_layout Standard
29982 git commit -q -m"<description>" <file-name>
29985 \begin_layout Subsubsection
29988 Revert To Repository Version
29991 \begin_layout Standard
29992 This will discard all changes made to the document since the last check in.
29993 You get a warning before changes are discarded.
29996 \begin_layout Standard
30001 \begin_inset Quotes qld
30005 \begin_inset Quotes qld
30011 \begin_layout Subsubsection
30017 \begin_layout Standard
30018 This will rename the current document including the version history.
30019 It requires a clean document without any changes since the last checkin.
30020 You are asked for a file name and a description of the rename operation.
30021 After that the document is renamed,
30022 both locally and in the repository.
30023 If the parent directories of the new and old file names differ,
30024 all relative paths of included files are adjusted (like in
30026 File\SpecialChar menuseparator
30032 the document is reloaded using the new name.
30035 \begin_layout Labeling
30036 \labelwidthstring 00.00.0000
30038 \begin_inset space ~
30043 \begin_inset space ~
30047 \begin_inset Newline newline
30051 \begin_inset Flex Code
30054 \begin_layout Plain Layout
30058 \begin_inset Quotes qld
30062 \begin_inset Quotes qld
30066 \begin_inset Quotes qld
30070 \begin_inset Quotes qld
30079 \begin_inset Newline newline
30083 \begin_inset Flex Code
30086 \begin_layout Plain Layout
30095 \begin_layout Subsubsection
30101 \begin_layout Standard
30102 This shows the complete history of the GIT document.
30106 \begin_inset Quotes qld
30110 \begin_inset Quotes qld
30115 is shown in a browser.
30118 \begin_layout Subsubsection
30122 \begin_layout Standard
30124 supports GIT hash number of the last commit to the file,
30125 its abbreviated form,
30127 date and time of last commit.
30128 All those are extracted from
30130 git log -n 1 --pretty=format:%H%n%h%n%an%n%ai
30133 Tree version information is obtained via
30135 git describe --abbrev --dirty --long
30139 \begin_inset CommandInset ref
30141 reference "subsec:VCS-Revision-Information"
30149 \begin_layout Subsection
30153 \begin_layout Standard
30154 With the recent addition of the
30155 \begin_inset Flex Code
30158 \begin_layout Plain Layout
30164 function \SpecialChar LyX
30165 power users are allowed to create their own commands for revision control.
30168 \begin_layout Standard
30169 As an example you can see how two TortoiseSVN commands could be integrated directly:
30172 \begin_layout Description
30175 \begin_inset Flex Code
30178 \begin_layout Plain Layout
30179 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
30187 \begin_layout Description
30190 \begin_inset Flex Code
30193 \begin_layout Plain Layout
30194 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
30202 \begin_layout Subsection
30203 Version control and Document comparison
30206 \begin_layout Standard
30207 One of the typical uses of version control is to inspect the changes between revisions,
30208 usually by creating
30209 \begin_inset Flex Code
30212 \begin_layout Plain Layout
30219 While this is useful for plain text files,
30220 it is much less useful in the case of \SpecialChar LyX
30222 which have more a complicated structure.
30223 Hence we provide binding to the Document comparison feature.
30224 There are two ways of calling this feature – either by direct call of
30225 \begin_inset Flex Code
30228 \begin_layout Plain Layout
30235 function (for details see \SpecialChar LyX
30236 functions manual) or by the toolbar icon
30250 One can either compare two chosen revisions of the document or he can simply compare the current version of edited text with older revisions (where '
30251 \begin_inset Flex Noun
30254 \begin_layout Plain Layout
30260 ' revisions back means comparison of the edited file with last commited revision).
30264 \begin_layout Standard
30265 This feature is supported for SVN and RCS though due to the more complicated versioning scheme of RCS there is a constraint – when addressing the revisions in dialog,
30266 numbers always point to the last number in RCS revision number,
30269 We don't currently support GIT addressing of revisions,
30270 one can just compare edited document with its revision X steps backs,
30271 where X is addressed as
30272 \begin_inset Flex Code
30275 \begin_layout Plain Layout
30284 \begin_layout Section
30285 \begin_inset CommandInset label
30287 name "sec:Literate-Programming"
30291 Literate Programming
30294 \begin_layout Standard
30299 (kayvan@sylvan.com)
30304 original documentation written by
30306 Edmar Wienskoski Jr.
30309 (edmar-w-jr@technologist.com)
30312 \begin_layout Subsection
30316 \begin_layout Standard
30317 The main purpose of this documentation is to show you how to use \SpecialChar LyX
30318 for literate programming,
30319 where it is assumed that you are familiar with this programming technique,
30321 \begin_inset Quotes eld
30325 \begin_inset Quotes erd
30329 \begin_inset Quotes eld
30333 \begin_inset Quotes erd
30337 If that is not the case,
30338 please follow the web links provided in the following sections.
30339 There is a lot of good documentation out there covering old development history to the latest tools tips.
30342 \begin_layout Standard
30343 It is also assumed that you are familiar with \SpecialChar LyX
30344 itself to a point that you are comfortable changing your \SpecialChar LyX
30346 and X resources file.
30347 If that is not the case please refer to other \SpecialChar LyX
30348 documentation to cover your specific needs.
30351 \begin_layout Subsection
30352 Literate Programming
30355 \begin_layout Standard
30356 From the Literate Programming FAQ:
30360 \begin_layout Quotation
30361 Literate programming is the combination of documentation and source together in a fashion suited for reading by human beings.
30363 literate programs should be enjoyable reading,
30366 I couldn't resist!) In general,
30367 literate programs combine source and documentation in a single file.
30368 Literate programming tools then parse the file to produce either readable documentation or compilable source.
30369 The WEB style of literate programming was created by D.
30370 \begin_inset space \thinspace{}
30374 Knuth during the development of his \SpecialChar TeX
30375 typesetting software.
30379 \begin_layout Standard
30380 Another excerpt says:
30383 \begin_layout Quotation
30386 How is literate programming different from verbose commenting?
30389 \begin_layout Quotation
30390 There are three distinguishing characteristics.
30391 In order of importance,
30397 \begin_layout Itemize
30398 flexible order of elaboration
30401 \begin_layout Itemize
30402 automatic support for browsing
30405 \begin_layout Itemize
30406 typeset documentation,
30407 especially diagrams and mathematics
30411 \begin_layout Standard
30412 Now that I sparked your curiosity,
30413 take a look in the references.
30416 \begin_layout Subsubsection
30420 \begin_layout Standard
30421 The complete Literate Programming FAQ can be found at:
30424 \begin_layout Quote
30425 Literate Programming FAQ
30426 \begin_inset Flex URL
30429 \begin_layout Plain Layout
30431 http://www.literateprogramming.com/lpfaq.pdf
30439 \begin_layout Standard
30440 The FAQ lists 23 (twenty three!) different literate programming tools.
30441 Where some are specialized or
30442 \begin_inset Quotes eld
30446 \begin_inset Quotes erd
30449 for particular programming languages,
30450 while other have general scope.
30455 for my own use for several reasons:
30458 \begin_layout Itemize
30459 It can generate the documentation either in \SpecialChar LaTeX
30463 \begin_layout Itemize
30464 It has a open architecture,
30466 \begin_inset space \thinspace{}
30470 \begin_inset space \space{}
30473 it is easy to plug in new filters
30477 \begin_layout Plain Layout
30482 are programs that read a given data stream and output a manipulated data stream.
30484 a WEB file (consisting of literate code) can be turned into a file consisting only of C program code or \SpecialChar LaTeX
30490 and to perform special processing that you may need.
30494 \begin_layout Itemize
30495 There is a good selection of filters available already (the HTML is one of them).
30498 \begin_layout Itemize
30502 \begin_layout Standard
30503 The Noweb web page can be found at:
30507 \begin_layout Quote
30509 \begin_inset Flex URL
30512 \begin_layout Plain Layout
30514 https://www.cs.tufts.edu/~nr/noweb/
30522 \begin_layout Standard
30523 Starting from there you can reach many other interesting links and even some literate program examples.
30526 \begin_layout Subsection
30528 and Literate Programming with Noweb
30531 \begin_layout Standard
30532 The \SpecialChar LyX
30533 support for Literate Programming is provided by using the generic \SpecialChar LyX
30534 converters mechanism.
30535 This support is provided in a
30536 \begin_inset Quotes eld
30540 \begin_inset Quotes erd
30545 \begin_inset space \thinspace{}
30549 \begin_inset space \space{}
30552 you will be able to use this new \SpecialChar LyX
30553 feature with some other literate programming tool of your choice by just changing your \SpecialChar LyX
30557 \begin_layout Subsubsection
30558 Generating documents and code (weaving and tangling)
30561 \begin_layout Paragraph
30562 Using the noweb module
30565 \begin_layout Standard
30566 If you have installed Noweb and \SpecialChar LyX
30568 whenever you open a new document,
30569 after you have chosen its document class,
30572 Document\SpecialChar menuseparator
30576 \begin_inset Quotes eld
30580 \begin_inset Quotes erd
30584 If Noweb is correctly installed,
30585 when you click on the
30586 \begin_inset Quotes eld
30590 \begin_inset Quotes erd
30595 \begin_inset Quotes eld
30599 \begin_inset Quotes erd
30602 module in the available list and you can add it to your document.
30605 \begin_layout Paragraph
30609 \begin_layout Standard
30611 enables you to write code with a custom inset named
30612 \begin_inset Flex Noun
30615 \begin_layout Plain Layout
30622 Noweb delimits chunks like this:
30625 \begin_layout LyX-Code
30629 \begin_layout LyX-Code
30633 \begin_layout LyX-Code
30637 \begin_layout LyX-Code
30641 \begin_layout LyX-Code
30645 \begin_layout Standard
30646 The problem is that whatever is written in between the << and the
30650 must be taken literally,
30652 \begin_inset space \thinspace{}
30656 \begin_inset space \space{}
30660 should be prevented from making any special interpretation of what has been written.
30661 This is also handled by
30662 \begin_inset Flex Noun
30665 \begin_layout Plain Layout
30672 that works like a normal text inset but has a free spacing capability.
30675 \begin_layout Standard
30677 you can also use the
30678 \begin_inset Quotes eld
30682 \begin_inset Quotes erd
30685 construct of Noweb in your chunks to add items to Noweb's identifier cross-reference:
30688 \begin_layout LyX-Code
30692 \begin_layout LyX-Code
30693 def some_function(args):
30696 \begin_layout LyX-Code
30697 "This is the doc string for this function."
30700 \begin_layout LyX-Code
30706 \begin_layout LyX-Code
30707 @ %def some_function
30710 \begin_layout Standard
30711 For an example of this usage and the resulting cross-reference output,
30712 look at the Literate python program in
30714 LIBDIR/examples/listerrors.lyx
30716 which should make this all clear.
30719 \begin_layout Paragraph
30720 Generating the documentation
30723 \begin_layout Standard
30724 At this point you already have a new document file with a proper document class,
30725 and with some code and text on it.
30727 The answer is simple,
30730 View\SpecialChar menuseparator
30735 Just like you would do for a plain document.
30736 No special procedure is required.
30739 \begin_layout Standard
30740 To help orientate you,
30741 I will now explain what happens inside \SpecialChar LyX
30745 \begin_layout Enumerate
30748 Update\SpecialChar menuseparator
30751 menu option is chosen,
30752 a \SpecialChar LaTeX
30758 \begin_layout Standard
30759 If the document is of any literate class the generated file will be named with an extension name defined by the
30760 \begin_inset Quotes eld
30764 \begin_inset Quotes erd
30767 format (defined in the Preferences panel),
30768 otherwise the file will have the usual
30776 \begin_layout Enumerate
30777 Note that the only difference so far is in the name of the file,
30778 no special processing is required by \SpecialChar LyX
30780 Given that you formatted the code using the
30781 \begin_inset Flex Noun
30784 \begin_layout Plain Layout
30792 takes care of the business.
30795 \begin_layout Enumerate
30796 If the document is of any literate class \SpecialChar LyX
30797 will then use the internal \SpecialChar LyX
30798 to Noweb converter,
30799 followed by the Noweb to \SpecialChar LaTeX
30804 \begin_layout Plain Layout
30805 The converters are defined in the
30807 Tools\SpecialChar menuseparator
30812 \begin_inset Quotes eld
30816 \begin_inset Quotes erd
30828 manual for general information about converters.
30833 to generate the \SpecialChar LaTeX
30838 \begin_layout Standard
30839 Otherwise it will just skip this step.
30843 \begin_layout Enumerate
30846 is invoked and the regular post processing continues as in a plain document.
30849 \begin_layout Standard
30850 Independence from a particular
30851 \begin_inset Quotes eld
30855 \begin_inset Quotes erd
30858 is easily achieved by changing the commands that are run by the various converters.
30861 \begin_layout Paragraph
30862 Generating the code
30865 \begin_layout Standard
30866 When the build menu option is chosen or the corresponding button in the toolbar is pressed,
30867 a \SpecialChar LaTeX
30868 file is generated just like step 1 above.
30876 This converter needs to be defined by the user and is not installed by default,
30877 though the Program format is.
30878 This converter (like any other converter) will have two parts:
30881 \begin_layout Enumerate
30882 The converter program itself.
30883 This program performs the conversion from the one format to the other (in this case,
30884 from the Noweb format to the Program pseudo-format).
30887 \begin_layout Enumerate
30888 The error log parser.
30889 This is a program whose sole purpose is to rewrite error messages in a format that \SpecialChar LyX
30891 This makes it possible for \SpecialChar LyX
30892 to place error boxes in the right places in the file buffer.
30895 \begin_layout Standard
30898 \begin_inset Quotes eld
30902 \begin_inset Quotes erd
30909 \begin_layout LyX-Code
30917 \begin_layout Standard
30918 This basically means that \SpecialChar LyX
30920 \begin_inset Quotes eld
30924 \begin_inset Quotes erd
30927 (a program or script) with the name of the Noweb file (normally a file in the \SpecialChar LyX
30928 temp directory) and the directory path of the original \SpecialChar LyX
30933 \begin_layout Standard
30934 This is an implementation of
30935 \begin_inset Quotes eld
30939 \begin_inset Quotes erd
30942 that you can place in a directory on your path:
30945 \begin_layout LyX-Code
30951 \begin_layout LyX-Code
30957 \begin_layout LyX-Code
30960 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
30963 \begin_layout Standard
30964 The next part of the converter setting is the
30965 \begin_inset Quotes eld
30969 \begin_inset Quotes erd
30972 which is to be set to
30975 \begin_layout LyX-Code
30978 parselog=$$s/scripts/listerrors
30981 \begin_layout Standard
30982 This will run any errors that are generated by the
30983 \begin_inset Quotes eld
30987 \begin_inset Quotes erd
30990 process through the
30991 \begin_inset Quotes eld
30995 \begin_inset Quotes erd
31001 \begin_layout Standard
31002 The build will normally take place in \SpecialChar LyX
31003 's temporary directory,
31004 so the files produced by the conversion will be in that directory.
31006 will copy out what it regards as the `main' file,
31011 conversion may produce several files,
31012 and so most of these would then be deleted when \SpecialChar LyX
31014 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that the build-script chunk can place the generated files in that location.
31017 \begin_layout Paragraph
31018 Build instructions in the document
31021 \begin_layout Standard
31022 The last piece of the integration between \SpecialChar LyX
31024 \begin_inset Quotes eld
31028 \begin_inset Quotes erd
31033 the instructions for building your program should be embedded in a chunk of its own.
31035 \begin_inset Quotes eld
31039 \begin_inset Quotes erd
31042 above uses the notangle command to look for this chunk (called
31043 \begin_inset Quotes eld
31047 \begin_inset Quotes erd
31050 ) and runs its contents through
31051 \begin_inset Quotes eld
31055 \begin_inset Quotes erd
31061 \begin_layout Standard
31063 such a chunk would look something like this:
31066 \begin_layout LyX-Code
31070 \begin_layout LyX-Code
31072 \begin_inset Newline newline
31075 if [ -z "${NOWEB_SOURCE}" ]
31076 \begin_inset Newline newline
31082 \begin_layout LyX-Code
31083 NOWEB_SOURCE=myfile.nw
31084 \begin_inset Newline newline
31088 \begin_inset Newline newline
31092 code to extract files ...
31093 use NOWEB_OUTPUT_DIR here ...]
31094 \begin_inset Newline newline
31098 code to compile files ...]
31099 \begin_inset Newline newline
31105 \begin_layout Standard
31108 File\SpecialChar menuseparator
31109 Open Example\SpecialChar menuseparator
31110 Modules\SpecialChar menuseparator
31115 File\SpecialChar menuseparator
31116 Open Example\SpecialChar menuseparator
31117 Modules\SpecialChar menuseparator
31120 which implement versions of the
31121 \begin_inset Quotes eld
31125 \begin_inset Quotes erd
31128 program for some illustrations of how all of these pieces go together
31134 these files show off the language independency of the \SpecialChar LyX
31135 literate programming support since they are written in Python and Perl respectively.
31138 \begin_layout Subsubsection
31139 Configuring \SpecialChar LyX
31143 \begin_layout Standard
31144 All the Literate Programming support is configured by the
31146 Tools\SpecialChar menuseparator
31150 \begin_inset Quotes eld
31154 \begin_inset Quotes erd
31158 The important parts are:
31161 \begin_layout Description
31163 \begin_inset space ~
31167 \begin_inset Quotes eld
31171 \begin_inset Quotes erd
31175 \begin_inset space ~
31178 format Set up via the File Formats tab,
31179 this is where the Noweb-specific pieces are set up.
31189 the file extension is set to
31194 This tells \SpecialChar LyX
31195 to create a file with a
31199 extension in the first step of the conversion process.
31202 \begin_layout Description
31204 \begin_inset space ~
31212 \begin_inset space ~
31215 format This is an empty format whose sole purpose is to be the endpoint of a conversion (which then allows us to set up a converter for it).
31218 \begin_layout Description
31228 This converter performs the
31229 \begin_inset Quotes eld
31233 \begin_inset Quotes erd
31236 of the literate document.
31239 \begin_inset Quotes eld
31244 noweave -delay -index $$i > $$o
31247 \begin_inset Quotes erd
31253 \begin_layout Description
31263 \begin_inset Quotes eld
31267 \begin_inset Quotes erd
31272 the Converter is set to
31273 \begin_inset Quotes eld
31281 \begin_inset Quotes erd
31286 \begin_inset Newline newline
31290 \begin_inset Quotes eld
31295 parselog=$$s/scripts/listerrors
31298 \begin_inset Quotes erd
31304 \begin_layout Subsubsection
31308 \begin_layout Standard
31309 There is also a new function implemented in the \SpecialChar LyX
31312 \begin_inset Quotes eld
31315 server-goto-file-row" function,
31316 to be used with ddd/gdb or other debugger.
31320 \begin_layout Standard
31321 When debugging code with ddd/gdb,
31322 it is possible to invoke a text editor at the current execution position with a single key stroke.
31323 The default ddd configuration for that is shift-ctrl-V.
31324 It happens that you can define the editor command line invocation in ddd by accessing the
31326 Edit\SpecialChar menuseparator
31327 Preferences\SpecialChar menuseparator
31330 dialog and changing the "Edit Sources" entry.
31333 \begin_layout Standard
31334 I take advantage of the newly created \SpecialChar LyX
31335 server function and this ddd feature,
31337 \begin_inset Quotes eld
31341 \begin_inset Quotes erd
31347 \begin_layout LyX-Code
31348 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
31351 \begin_layout Standard
31353 whenever you are using ddd and find a point in the program that you want to edit,
31354 you just press shift-ctrl-V (in the ddd window),
31355 and ddd will forward this information to \SpecialChar LyX
31356 through the \SpecialChar LyX
31357 server and then the \SpecialChar LyX
31358 window will show the same file with the cursor at the same position ddd was pointing to.
31359 No more guessing or long scrolling to locate a point in the program back from debugging !
31362 \begin_layout Standard
31363 Note however that you must enable the \SpecialChar LyX
31364 server to get this feature working (it is disabled by default).
31366 \begin_inset space ~
31370 \begin_inset CommandInset ref
31372 reference "sec:Starting-the-Server"
31377 explains how to do that.
31380 \begin_layout Subsubsection
31384 \begin_layout Standard
31385 There are six new buttons that can be added to your \SpecialChar LyX
31387 Four of these buttons are short cuts to layout styles:
31410 one for the custom inset
31415 The last one is a short cut to the
31416 \begin_inset Quotes eld
31420 \begin_inset Quotes erd
31427 \begin_layout Standard
31429 has a range of buttons that are available for tool bar customization.
31430 In my toolbar I like to combine the six short cuts above with two more:
31435 \SpecialChar menuseparator
31440 \SpecialChar menuseparator
31447 Document\SpecialChar menuseparator
31448 View\SpecialChar menuseparator
31452 Here is how it looks like:
31455 \begin_layout LyX-Code
31459 \begin_layout LyX-Code
31463 \begin_layout LyX-Code
31464 Icon "layout Standard"
31467 \begin_layout LyX-Code
31468 Icon "layout Section"
31471 \begin_layout LyX-Code
31472 Icon "layout \SpecialChar LaTeX
31476 \begin_layout LyX-Code
31477 Icon "layout \SpecialChar LyX
31481 \begin_layout LyX-Code
31482 Icon "flex.insert Chunk"
31485 \begin_layout LyX-Code
31489 \begin_layout LyX-Code
31493 \begin_layout LyX-Code
31494 Icon "buffer-typeset"
31497 \begin_layout LyX-Code
31498 Icon "build-program"
31501 \begin_layout LyX-Code
31505 \begin_layout LyX-Code
31509 \begin_layout LyX-Code
31513 \begin_layout LyX-Code
31517 \begin_layout LyX-Code
31521 \begin_layout Subsubsection
31522 Colors customization
31525 \begin_layout Standard
31526 There are a number of colors in \SpecialChar LyX
31527 that can be customized in
31532 One of the things that bothers people is the \SpecialChar LaTeX
31534 The default color is red,
31535 since the chunks uses \SpecialChar LaTeX
31537 and there is a lot of chunks in literate documents,
31538 you may get tired of seeing everything in red.
31539 You can change it by going to the tabs
31549 \begin_layout Standard
31550 The next thing is the visible presence of the newline character in the screen.
31551 You can choose the color of this particular character and make it blend in the background.
31552 I recommend you choosing a color that is close to the background but not equal,
31553 that way you still can see it is there,
31554 but it is not bothering you anymore.
31557 \begin_layout Subsection
31562 \begin_layout Standard
31573 Help\SpecialChar menuseparator
31574 Specific Manuals\SpecialChar menuseparator
31579 File\SpecialChar menuseparator
31580 Open Example\SpecialChar menuseparator
31581 Modules\SpecialChar menuseparator
31586 Help\SpecialChar menuseparator
31587 Specific Manuals\SpecialChar menuseparator
31592 File\SpecialChar menuseparator
31593 Open Example\SpecialChar menuseparator
31594 Modules\SpecialChar menuseparator
31600 \begin_layout Standard
31601 \begin_inset CommandInset index_print
31602 LatexCommand printindex