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
3058 \begin_inset space \thinspace{}
3066 \begin_inset space \thinspace{}
3081 document classes to facilitate the use of Hebrew in \SpecialChar LyX
3085 \begin_layout Subsection
3086 \begin_inset CommandInset label
3088 name "subsec:Japanese"
3092 Japanese (Standard Classes)
3095 \begin_layout Standard
3097 included a collection of several bundles that aim to facilitate typesetting Japanese documents.
3098 The bundles have been developed at different times,
3099 they thus support different typesetting engines and features.
3100 This collection is the oldest one.
3101 It adjusts the \SpecialChar LaTeX
3102 standard classes to requirements of Japanese typesetting,
3103 for horizontal and vertical writing.
3104 The collection includes
3107 \begin_inset space \thinspace{}
3116 \begin_inset space \thinspace{}
3126 \begin_inset space \thinspace{}
3135 \begin_inset space \thinspace{}
3145 \begin_inset space \thinspace{}
3148 (Japanese Standard Class)
3154 \begin_inset space \thinspace{}
3162 \begin_inset Quotes eld
3166 \begin_inset Quotes erd
3169 engines tailored for Japanese,
3171 and up\SpecialChar LaTeX
3175 \begin_layout Standard
3176 For the use with the more modern Lua\SpecialChar LaTeX
3178 the collection also includes dedicated classes
3181 \begin_inset space \thinspace{}
3184 (Standard Class for LuaTeX),
3186 \begin_inset space \thinspace{}
3189 (Standard Class for LuaTeX,
3192 \begin_inset space \thinspace{}
3195 (Standard Class for LuaTeX)
3201 \begin_inset space \thinspace{}
3204 (Standard Class for LuaTeX,
3211 \begin_inset space \thinspace{}
3214 (Japanese Standard Class for LuaTeX)
3220 \begin_inset space \thinspace{}
3223 (Japanese Standard Class for LuaTeX,
3235 \begin_layout Standard
3236 Templates for the Lua\SpecialChar LaTeX
3237 classes can be found in
3239 File\SpecialChar menuseparator
3242 in the respective category (
3259 \begin_layout Subsection
3260 \begin_inset CommandInset label
3262 name "subsec:Japanese-JS"
3266 Japanese (JS Bundle)
3269 \begin_layout Standard
3270 This collection includes improved versions of the classes included in
3272 Japanese (Standard Classes)
3275 \begin_inset space ~
3279 \begin_inset CommandInset ref
3281 reference "subsec:Japanese"
3289 \begin_inset space \thinspace{}
3297 \begin_inset space \thinspace{}
3303 A report class can be obtained by using
3306 \begin_inset space \thinspace{}
3317 Document\SpecialChar menuseparator
3318 Settings\SpecialChar menuseparator
3319 Document Class\SpecialChar menuseparator
3320 Class Options\SpecialChar menuseparator
3324 All these classes work with
3325 \begin_inset Quotes eld
3329 \begin_inset Quotes erd
3332 engines tailored for Japanese,
3334 and up\SpecialChar LaTeX
3338 \begin_layout Standard
3339 For the use with the more modern Lua\SpecialChar LaTeX
3341 the collection also includes dedicated classes
3343 Japanese Article (JS Bundle for LuaTeX),
3345 \begin_inset space \thinspace{}
3348 (JS Bundle for LuaTeX)
3354 \begin_inset space \thinspace{}
3368 \begin_layout Standard
3369 Templates for the Lua\SpecialChar LaTeX
3370 classes can be found in
3372 File\SpecialChar menuseparator
3375 in the respective category (
3392 \begin_layout Subsection
3393 \begin_inset CommandInset label
3395 name "subsec:Japanese-BX"
3399 Japanese (BX Bundle)
3402 \begin_layout Standard
3403 This bundle contains the document classes
3406 \begin_inset space \thinspace{}
3415 \begin_inset space \thinspace{}
3424 \begin_inset space \thinspace{}
3429 which provide alternative document classes for Japanese documents.
3433 Japanese Slides (BX Bundle)
3435 for presentation slides,
3437 As opposed to the classes of the
3447 \begin_inset CommandInset ref
3449 reference "subsec:Japanese"
3454 \begin_inset CommandInset ref
3456 reference "subsec:Japanese-JS"
3461 which support only p\SpecialChar LaTeX
3462 and up\SpecialChar LaTeX
3463 out of the box (and Lua\SpecialChar LaTeX
3464 only through the extra classes added by the
3470 the classes of this bundle also support pdf\SpecialChar LaTeX
3472 Xe\SpecialChar LaTeX
3473 and Lua\SpecialChar LaTeX
3475 with the aid of suitable packages that provide capability of Japanese typesetting.
3478 \begin_layout Subsection
3479 \begin_inset CommandInset label
3481 name "subsec:Japanese-JLReq"
3485 Japanese (JLReq Class)
3488 \begin_layout Standard
3489 This bundle draws on the
3493 class which faithfully traces the standard of
3495 Requirements for Japanese Text Layout
3497 set by the World Wide Web Consortium (W3C,
3499 \begin_inset Flex URL
3502 \begin_layout Plain Layout
3504 https://www.w3.org/TR/jlreq/?lang=en
3510 It can be used with Lua\SpecialChar LaTeX
3511 as well as p\SpecialChar LaTeX
3512 and up\SpecialChar LaTeX
3516 \begin_layout Standard
3517 LyX provides layouts for
3520 \begin_inset space \thinspace{}
3529 \begin_inset space \thinspace{}
3538 \begin_inset space \thinspace{}
3543 which are all derived from the
3548 class via specific class options.
3551 \begin_layout Standard
3552 An example article document is available at
3554 File\SpecialChar menuseparator
3555 Open Example\SpecialChar menuseparator
3556 Articles\SpecialChar menuseparator
3557 Japanese Article (JLReq Class)
3560 English documentation is available at
3561 \begin_inset Flex URL
3564 \begin_layout Plain Layout
3566 http://mirrors.ctan.org/macros/jptex/latex/jlreq/jlreq.pdf
3574 \begin_layout Subsection
3575 \begin_inset CommandInset label
3577 name "subsec:KOMA-Script"
3584 \begin_layout Standard
3594 and the \SpecialChar LyX
3598 \begin_layout Subsubsection
3602 \begin_layout Standard
3603 The KOMA-Script collection of document classes is a development of the Script classes created by Frank Neukam in the early 1990s;
3604 it was formally launched with the addition of a letter class in 1994.
3606 a second letter class has been added.
3607 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.
3610 \begin_layout Standard
3611 The \SpecialChar LyX
3631 correspond to the \SpecialChar LaTeX
3653 \begin_inset space ~
3656 of the Koma-Script family.
3657 They are replacements for the standard document classes
3677 and fit better to European typography conventions in a number of points.
3680 \begin_layout Itemize
3681 The base character sizes when you select a KOMA-Script class are 11pt in
3702 \begin_layout Itemize
3704 labels of the description environment,
3705 and a number of elements of the
3709 document class are set in a bold sans serif font.
3713 \begin_layout Plain Layout
3714 There is a big difference between the bold sans serif old cm fonts and new ec fonts,
3715 especially in the appearance of headings.
3717 the ec bold sans serif fonts look a bit thin.
3718 Here the \SpecialChar LaTeX
3727 helps to produce the
3728 \begin_inset Quotes eld
3732 \begin_inset Quotes erd
3735 appearance when using the ec fonts.
3740 The numbering of chapter headings is made in the same way as the numbering of section headings,
3741 that is without the extra line
3742 \begin_inset Quotes eld
3745 Chapter\SpecialChar ldots
3747 \begin_inset Quotes erd
3752 the appearance of the headings can be modified by using a number of options (in \SpecialChar LyX
3753 to be entered in the field
3756 \begin_inset space ~
3763 Layout\SpecialChar menuseparator
3770 \begin_layout Itemize
3771 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.
3772 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.
3773 You can change the sizes of the margins by changing the factor by which the page is divided into strips;
3774 the default for an A4 page is 9 and increasing this factor will produce increasingly narrower strips and therefore narrower margins.
3778 \begin_layout Standard
3779 Whatever the factor,
3780 two strips are allocated to the outer and bottom margins of a two-sided document and one strip to the inner and top margins,
3781 leaving a text area occupying around half the page.
3782 Since most two-sided documents have a binding,
3783 this can make the inner margins appear too narrow;
3784 so you can apply a binding correction to the page which is deducted before the size of the strips is calculated.
3787 \begin_layout Standard
3788 The main means in the Koma-Script document classes to design the type area are the options
3798 Document\SpecialChar menuseparator
3799 Settings\SpecialChar menuseparator
3800 Document Class\SpecialChar menuseparator
3801 Class Options\SpecialChar menuseparator
3807 \begin_layout Standard
3809 the binding correction is 7.5mm which is added in the form
3816 \begin_inset space ~
3819 options\SpecialChar menuseparator
3827 To change the factor to 11,
3833 to the comma separated list of entries in the
3844 \begin_inset space ~
3850 If you want the default value of this factor for a page size other than A4,
3858 \begin_layout Standard
3859 To use the circle method of calculating the page layout,
3868 \begin_layout Itemize
3869 The \SpecialChar LaTeX
3870 document classes of the Koma-Script family define a number of additional commands.
3871 Those part of it which makes sense in \SpecialChar LyX
3872 is implemented in corresponding paragraph types.
3875 \begin_layout Standard
3876 Detailed descriptions of the \SpecialChar LaTeX
3877 document classes of the Koma-Script family can be found in the Koma-Script documentation
3888 \begin_layout Subsubsection
3891 \begin_inset CommandInset label
3893 name "subsec:article-(KOMA-Script),-report"
3913 \begin_layout Standard
3914 The document classes
3928 are implemented in the layout files
3944 They contain all the paragraph types of the corresponding standard document classes
3961 with the exception of the \SpecialChar LyX
3967 which is replaced by the new
3971 -type having the same functionality.
3976 -Type there is a number of new paragraph types added.
3983 letter (koma-script)
3988 \begin_layout Itemize
4011 additionally inserting an entry in the table of contents.
4020 are not contained in
4022 article (koma-script)
4027 \begin_layout Itemize
4048 additionally clearing running heads.
4055 article (koma-script)
4061 \begin_layout Plain Layout
4074 report (koma-script)
4077 but since this is identical to
4082 is has not been implemented in \SpecialChar LyX
4091 \begin_layout Itemize
4097 generates a heading directly above the following paragraph in the standard character size without affecting the structure of the document.
4100 \begin_layout Itemize
4109 are special captions which respect the different space settings needed for captions placed above or below an element (if you follow strict typographic rules,
4110 you might want to place table captions always above the table).
4111 You can also use the class option
4129 You need at least Koma-Script version 2.8q to use this.
4132 \begin_layout Itemize
4138 can be used to set a bonmot,
4140 \begin_inset space \thinspace{}
4144 \begin_inset space \space{}
4147 at the beginning of a chapter.
4148 If you use the optional argument (
4150 Insert\SpecialChar menuseparator
4152 \begin_inset space ~
4158 you can insert the dictum's author there.
4159 Dictum and author are separated by a line.
4160 You need at least Koma-Script version 2.8q to use this.
4167 article (koma-script)
4172 \begin_layout Standard
4173 The following types,
4174 together with the standard types
4189 form the title area of the document.
4190 They must be entered ahead of the first
4191 \begin_inset Quotes eld
4195 \begin_inset Quotes erd
4202 \begin_layout Plain Layout
4203 The corresponding \SpecialChar LaTeX
4204 commands must appear before the
4215 When such a type is used more than once,
4216 the latter usage overwrites the former one,
4218 for every type only the latest usage is valid.
4219 The order of the different types however has,
4235 no effect on the appearance of the produced document.
4238 \begin_layout Itemize
4244 produces a centered paragraph above the ordinary title (
4258 ) for the subject of the document.
4261 \begin_layout Itemize
4267 produces a centered paragraph below the ordinary title (
4281 ) for the publishers' name.
4284 \begin_layout Itemize
4292 report (koma-script)
4298 produces a centered paragraph on its own page behind the title page,
4301 article (koma-script)
4303 produces a centered paragraph below the ordinary title (
4325 \begin_layout Itemize
4331 produces a left aligned paragraph above the ordinary title (
4350 ) for a document`s head.
4353 \begin_layout Itemize
4359 produces in a double-sided print in
4361 report (koma-script)
4367 a left-aligned paragraph at the top of the title page`s back or has no effect in a single-sided print or in
4369 article (koma-script)
4374 \begin_layout Itemize
4380 produces in a double-sided print in
4382 report (koma-script)
4388 a left-aligned paragraph at the bottom of the title page`s back or has no effect in a single-sided print or in
4390 article (koma-script)
4395 \begin_layout Itemize
4402 \begin_inset Quotes eld
4406 \begin_inset Quotes erd
4409 page ahead of the actual document containing a paragraph without special formatting.
4412 \begin_layout Standard
4413 KOMA-Script offers a wide range of
4420 \begin_inset space ~
4430 ocument\SpecialChar menuseparator
4435 ettings\SpecialChar menuseparator
4437 \begin_inset space ~
4442 dialog which you can apply to the whole document,
4446 \begin_layout Description
4453 which produces a PDF with a small black box at the end any line in which a formatting error occurs;
4454 the default setting is
4459 \begin_layout Description
4466 which may take the values
4480 the first and last adjust the sizes of the headings to take account of page sizes where the default values may not be suitable
4483 \begin_layout Description
4490 which may take the values
4504 the first leaves it up to KOMA-Script to add periods after chapter,
4507 the second forces the addition of periods and third suppresses them
4510 \begin_layout Standard
4511 and the math options:
4514 \begin_layout Description
4521 which causes equations to be numbered on the left rather than on the right,
4525 \begin_layout Description
4532 which causes equations to be left justified rather than centered.
4535 \begin_layout Standard
4536 It also provides commands to affect the output of the document independently of the standard \SpecialChar LaTeX
4537 commands and packages;
4539 if you want your captions in bold add
4542 \begin_layout Standard
4547 setkomafont{captionlabel}{
4552 \begin_layout Standard
4558 ocument\SpecialChar menuseparator
4565 \SpecialChar menuseparator
4570 \begin_inset space ~
4575 ) and the problem is solved.
4578 \begin_layout Standard
4579 If you are writing a book,
4580 it is normal to have the preliminary pages numbered in Roman numerals and the Chapters in this part unnumbered.
4581 If you use the Chapter* environment,
4582 your Foreword and Preface will not appear in the Table of Contents;
4583 to make them to appear in the Table of contents,
4584 you need to use Chapter environments and add the \SpecialChar TeX
4588 \begin_layout Standard
4596 \begin_layout Standard
4597 at the very start of the book (not in the \SpecialChar LaTeX
4601 \begin_layout Standard
4609 \begin_layout Standard
4610 before the first chapter of the body of the text.
4619 \begin_layout Standard
4620 You may also want to have some unnumbered Chapter environments at the end of the book after the Appendices,
4625 \begin_layout Plain Layout
4626 Appendices are normally “numbered” with letters.
4631 If you use the Chapter* environment,
4632 they will not appear in the Table of Contents;
4633 so add the \SpecialChar TeX
4637 \begin_layout Standard
4645 \begin_layout Standard
4646 before the first of these headings and use the Chapter environment.
4647 These commands will have no effect on the numbering in \SpecialChar LyX
4649 only on the PDF output where the headings will be unnumbered and appear in the Table of Contents.
4652 \begin_layout Standard
4653 The layout files for the document classes
4655 article (koma-script)
4660 report (koma-script)
4672 This is thought of as a place to define your own types.
4677 in your personal layout directory and edit the file!
4680 \begin_layout Subsubsection
4681 \begin_inset CommandInset label
4683 name "subsec:The-new-letter"
4687 The new letter class:
4688 KOMA-Script Letter (V.
4692 \begin_layout Standard
4698 \begin_layout Standard
4699 \begin_inset VSpace medskip
4705 \begin_layout Standard
4707 Koma-Script version 2.8 has introduced a new letter class
4711 which supersedes the now unsupported
4717 on the \SpecialChar LaTeX
4719 a completely new interface and is not compatible with the old class.
4723 though it is recommended you use the new class.
4726 \begin_layout Standard
4727 This class covers the same functionality as
4729 letter (koma-script),
4737 (receiver's address,
4757 will start a new letter (i.
4758 \begin_inset space \thinspace{}
4762 \begin_inset space \space{}
4765 you can write several letters per document).
4766 New elements are sender's
4785 and the possibility to use a
4791 Insert\SpecialChar menuseparator
4797 \begin_layout Standard
4798 The biggest improvement is,
4800 that the letter's layout is configurable to meet almost any needs.
4801 This can be done via the preamble or with a special style file (Letter Class Option,
4807 that will be read in as a class option.
4811 \begin_layout Plain Layout
4812 The KOMA package comes with some default
4823 file that follows german typesetting rules,
4828 that provides the default layout of the old
4833 The latter can be loaded with the class option
4840 Layout\SpecialChar menuseparator
4841 Document\SpecialChar menuseparator
4849 Have a look at the template in
4854 ile\SpecialChar menuseparator
4856 \begin_inset space ~
4864 \begin_inset space ~
4867 Template\SpecialChar menuseparator
4868 Letters\SpecialChar menuseparator
4869 KOMA-Script Letter (V.2)
4872 A detailed description is to be found in the Koma-Script documentation (
4879 \begin_layout Subsubsection
4883 \begin_layout Standard
4884 Visualizing the Koma-Script document classes in \SpecialChar LyX
4886 the \SpecialChar LyX
4887 internals cause some problems.
4890 \begin_layout Itemize
4891 The chapter number of a
4895 type appears on a line of its own above the chapter heading instead of appearing in the same line ahead of it.
4896 The cause for that is the \SpecialChar LyX
4897 internal behavior for the labeltype
4904 \begin_layout Itemize
4905 The headings of the types
4914 \begin_inset Quotes eld
4918 \begin_inset Quotes erd
4923 but not in the \SpecialChar LyX
4926 Document\SpecialChar menuseparator
4928 \begin_inset space ~
4932 \begin_inset space ~
4940 \begin_layout Itemize
4945 document class appear in a skip separation mode,
4947 This is the standard behavior,
4948 no special \SpecialChar LaTeX
4949 commands are needed for that.
4952 Document\SpecialChar menuseparator
4955 dialog the corresponding radio button indicates
4964 value always has the effect that extra \SpecialChar LaTeX
4965 commands are inserted in the document to produce the gap,
4966 which is not what is wanted in this case.
4969 \begin_layout Subsection
4970 \begin_inset CommandInset label
4972 name "subsec:Polish-M.W.collection"
4977 \begin_inset space \thinspace{}
4981 \begin_inset space \space{}
4987 \begin_layout Standard
4993 \begin_layout Standard
4994 The \SpecialChar LyX
4997 Polish Article (MW Bundle)
5002 Polish Report (MW Bundle)
5006 Polish Book (MW Bundle)
5008 correspond to the \SpecialChar LaTeX
5024 They are replacements for the standard document classes
5039 and fit better to Polish typography conventions in a number of points.
5043 \begin_layout Standard
5047 \begin_layout Itemize
5048 Unnumbered titles (with star,
5050 \begin_inset space \thinspace{}
5054 \begin_inset space \space{}
5061 ) are added into table of contents,
5064 \begin_layout Itemize
5065 Additional page styles:
5069 \begin_layout Description
5070 uheadings header with separated lines,
5073 \begin_layout Description
5074 myheadings custom header,
5075 contents headers via commands:
5091 \begin_layout Description
5092 myuheadings custom header with separated lines,
5095 \begin_layout Description
5096 outer page number is placed on outer side of page
5100 \begin_layout Itemize
5105 \begin_layout Description
5106 rmheadings serif titles —
5110 \begin_layout Description
5111 sfheadings sansserif titles,
5114 \begin_layout Description
5115 authortitle on title page first placed is author next title —
5119 \begin_layout Description
5120 titleauthor on title page first placed is title next author,
5123 \begin_layout Description
5124 withmarginpar reserve place on page for margins.
5128 \begin_layout Subsection
5132 \begin_layout Standard
5133 The document classes
5150 Detailed information about these document classes can be found in
5152 File\SpecialChar menuseparator
5153 Open Example\SpecialChar menuseparator
5154 Books\SpecialChar menuseparator
5159 File\SpecialChar menuseparator
5160 Open Example\SpecialChar menuseparator
5161 Handouts\SpecialChar menuseparator
5167 \begin_layout Section
5171 \begin_layout Standard
5172 See also the document classes in the Collections (section
5173 \begin_inset space ~
5177 \begin_inset CommandInset ref
5179 reference "sec:Collections"
5187 \begin_layout Subsection
5188 Astronomy & Astrophysics
5191 \begin_layout Standard
5197 updated by the \SpecialChar LyX
5201 \begin_layout Subsubsection
5205 \begin_layout Standard
5206 This section describes how \SpecialChar LyX
5207 can be used to write articles for submission to the scientific journal
5209 Astronomy & Astrophysics
5212 \begin_inset CommandInset href
5215 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
5220 ) using Version 9.1 of the document class
5225 information about it is available at
5226 \begin_inset Flex URL
5229 \begin_layout Plain Layout
5231 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
5239 \begin_layout Standard
5240 A manual comes together with the package and should be consulted before installing this document class as described in the
5242 Installing New Document Classe
5251 \begin_layout Standard
5252 \begin_inset Note Greyedout
5255 \begin_layout Plain Layout
5256 Please note that the publisher of the journal was changed from Springer to EDP Sciences starting January 1,
5258 That change also involved some slight changes to the style files,
5259 namely the removal of the thesaurus command.
5260 If you have an older version installed,
5262 For information about compatibility with the old (version 4) layout,
5263 please refer to the comments in
5266 Dir/layouts/aapaper.layout
5276 \begin_layout Subsubsection
5280 \begin_layout Standard
5281 It is recommended you start from the template in the menu
5286 ile\SpecialChar menuseparator
5288 \begin_inset space ~
5296 \begin_inset space ~
5299 Template\SpecialChar menuseparator
5300 Articles\SpecialChar menuseparator
5301 Astronomy & Astrophysics
5304 If you are not using the template,
5305 note the following settings:
5308 \begin_layout Itemize
5311 Astronomy & Astrophysics
5318 ocument\SpecialChar menuseparator
5323 ettings\SpecialChar menuseparator
5325 \begin_inset space ~
5331 that one was obvious).
5334 \begin_layout Itemize
5338 \begin_inset space ~
5350 \begin_inset space ~
5361 The whole layout is done by the macros,
5362 you shouldn't change anything.
5365 \begin_layout Subsubsection
5369 \begin_layout Standard
5370 First thing to enter is the header information.
5371 It consists of seven entries,
5372 of which one is optional.
5376 \begin_layout Itemize
5385 \begin_layout Itemize
5394 \begin_layout Itemize
5403 \begin_layout Itemize
5412 \begin_layout Itemize
5418 Determines to whom correspondence and reprints are to be sent.
5421 \begin_layout Itemize
5426 [optional] Snail mail address for contacts.
5429 \begin_layout Itemize
5443 \begin_layout Standard
5444 There is no need to issue the
5451 this is done automatically by \SpecialChar LyX
5452 when the header is finished.
5453 Although the order of the single header entries doesn't matter it is advised to keep the above sequence,
5454 just to get the best optics and meets the layout of the real document.
5457 \begin_layout Standard
5458 If you want to place footnotes in the header block,
5460 \begin_inset space \thinspace{}
5464 \begin_inset space \space{}
5467 to state your present address,
5468 just use the standard footnote via the menu
5473 nsert\SpecialChar menuseparator
5482 will automagically use the term
5491 \begin_layout Standard
5494 Edit\SpecialChar menuseparator
5498 you'll find two insets which are relevant for the titling:
5501 \begin_layout Itemize
5508 to mark corresponding author\SpecialChar breakableslash
5510 The institutes are numbered sequentially as they appear in the
5515 so you have to put a marker to each author.
5518 \begin_layout Itemize
5523 to supply an email address for fast contact.
5526 \begin_layout Standard
5527 In addition to these topics,
5528 the macros use one additional \SpecialChar LaTeX
5529 commands that has no counterpart in \SpecialChar LyX
5533 \begin_layout Itemize
5540 to separate different names for more than one author and institute,
5544 \begin_layout Standard
5545 The appropriate command has to be entered as \SpecialChar TeX
5546 code in \SpecialChar LyX
5548 See the examples in the template and in
5550 File\SpecialChar menuseparator
5551 Open Example\SpecialChar menuseparator
5552 Articles\SpecialChar menuseparator
5553 Astronomy & Astrophysics
5558 \begin_layout Subsubsection
5562 \begin_layout Standard
5563 The abstract should immediately follow the header block.
5564 With version 5 the abstract environment was changed to a command,
5565 and there is now a restriction to only one paragraph.
5567 it should contain an entry with the keywords.
5568 This is done via the paragraph style
5573 Refer to the example paper.
5576 \begin_layout Subsubsection
5577 Supported environments
5580 \begin_layout Standard
5581 The A&A paper layout supports the following environments for structuring your text:
5584 \begin_layout Standard
5587 \begin_inset Flex Multiple Columns
5590 \begin_layout Itemize
5596 \begin_layout Itemize
5602 \begin_layout Itemize
5608 \begin_layout Itemize
5614 \begin_layout Itemize
5620 \begin_layout Itemize
5626 \begin_layout Itemize
5632 \begin_layout Itemize
5638 \begin_layout Itemize
5644 \begin_layout Itemize
5650 \begin_layout Itemize
5656 \begin_layout Itemize
5665 \begin_layout Subsubsection
5666 Commands not supported by \SpecialChar LyX
5670 \begin_layout Standard
5671 Some commands are not yet supported by the
5673 Astronomy & Astrophysics
5675 layout for \SpecialChar LyX
5677 Some have already been mentioned.
5678 For the sake of completeness,
5679 they are listed all together here:
5682 \begin_layout Itemize
5690 \begin_layout Itemize
5698 \begin_layout Itemize
5706 \begin_layout Itemize
5714 \begin_layout Standard
5715 If you want to use any of these commands,
5716 you have to enter them yourself.
5717 Do not forget to use
5723 nsert\SpecialChar menuseparator
5726 \begin_inset space ~
5734 \begin_layout Subsubsection
5735 Figure and Table Floats
5738 \begin_layout Standard
5740 provides support for the necessary float environments
5751 therefore we won't tell much about it here.
5755 \begin_inset space ~
5761 Just remember that tables should be left-aligned.
5763 select the table and change the alignment in
5768 dit\SpecialChar menuseparator
5774 \begin_inset space ~
5782 arg "layout-paragraph"
5790 \begin_layout Standard
5791 There is only one special thing:
5792 the figures with a caption beside the figure.
5793 To create such a figure,
5794 you have to do the following:
5797 \begin_layout Enumerate
5798 Create a wide figure float:
5804 nsert\SpecialChar menuseparator
5809 t\SpecialChar menuseparator
5814 from within the float,
5820 dit\SpecialChar menuseparator
5826 \begin_inset space ~
5837 \begin_inset space ~
5849 \begin_layout Enumerate
5850 Enter your caption text.
5853 \begin_layout Enumerate
5858 to move the cursor above the caption.
5861 \begin_layout Enumerate
5865 \begin_layout Enumerate
5866 Position the cursor after the figure and insert a horizontal fill by using the menu:
5872 nsert\SpecialChar menuseparator
5877 rmatting\SpecialChar menuseparator
5883 \begin_inset space ~
5892 dialog and select the
5906 \begin_layout Enumerate
5907 Switch to \SpecialChar LaTeX
5912 \begin_inset space ~
5920 \begin_layout Enumerate
5929 Do not close the brace!
5932 \begin_layout Enumerate
5933 Position the cursor behind the caption text,
5934 switch to \SpecialChar LaTeX
5935 mode and insert the closing brace:
5939 \begin_inset space ~
5951 \begin_layout Standard
5953 refer to the figures in the file in
5955 File\SpecialChar menuseparator
5956 Open Example\SpecialChar menuseparator
5957 Articles\SpecialChar menuseparator
5958 Astronomy & Astrophysics
5963 \begin_layout Subsubsection
5967 \begin_layout Standard
5969 the paper has to be formatted in a special double-spacing layout.
5971 you have to add the option
5982 \begin_inset space ~
5992 ocument\SpecialChar menuseparator
5997 ettings\SpecialChar menuseparator
5999 \begin_inset space ~
6007 \begin_layout Subsubsection
6011 \begin_layout Standard
6014 File\SpecialChar menuseparator
6015 Open Example\SpecialChar menuseparator
6016 Articles\SpecialChar menuseparator
6017 Astronomy & Astrophysics
6019 was written with \SpecialChar LyX
6021 It is the example paper from the original macro package,
6027 \begin_inset CommandInset href
6030 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
6036 but translated to \SpecialChar LyX
6037 using the older unstructured abstract type.
6038 Use it for inspiration,
6039 and compare the \SpecialChar LaTeX
6044 with the \SpecialChar LyX
6048 \begin_layout Subsection
6053 \begin_layout Standard
6059 \begin_layout Subsubsection
6063 \begin_layout Standard
6065 is a set of macros produced by the American Astronomical Society to facilitate electronic manuscript submission to the three journals they publish:
6066 the Astrophysical Journal (including the Letters and Supplement),
6067 the Astronomical Journal,
6068 and the Publications of the Astronomical Society of the Pacific.
6070 has proven to be an excellent tool for generating these documents,
6071 especially given its equation,
6073 and figure handling capabilities.
6075 requires version 5.0 (or higher) of these macros;
6077 which is the version described here,
6079 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
6080 2.09 and are fundamentally incompatible with \SpecialChar LyX
6082 The AAS\SpecialChar TeX
6083 package may be downloaded from the AAS\SpecialChar TeX
6087 \begin_layout Standard
6088 \begin_inset VSpace medskip
6094 \begin_layout Standard
6096 \begin_inset Flex URL
6099 \begin_layout Plain Layout
6101 https://aas.org/aastex/aastex-downloads
6109 \begin_layout Standard
6110 \begin_inset VSpace medskip
6116 \begin_layout Standard
6117 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
6120 will not reduce the need to figure out all the AAS\SpecialChar TeX
6122 it will only reduce the drudgery of typing everything in.
6123 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
6124 document conforms completely to the requirements of the journal to which you are submitting your paper.
6127 \begin_layout Subsubsection
6128 Starting a New Paper
6131 \begin_layout Standard
6132 I strongly suggest that you start with the AAS\SpecialChar TeX
6136 File\SpecialChar menuseparator
6141 Template\SpecialChar menuseparator
6142 Articles\SpecialChar menuseparator
6143 American Astronomical Society
6146 This will show the most common fields found in a manuscript.
6147 Simply overwrite the existing text (including the brackets,
6152 ) with the correct information.
6153 Many of the AAS\SpecialChar TeX
6154 commands and environments can be implemented directly in \SpecialChar LyX
6157 For commands such as these,
6158 the \SpecialChar LaTeX
6159 code must be entered directly and marked as such.
6160 Such commands are referred to as \SpecialChar TeX
6163 I tried to minimize the amount of \SpecialChar TeX
6164 code needed in an AAS\SpecialChar TeX
6168 \begin_layout Subsubsection
6169 Finishing Your Paper
6172 \begin_layout Standard
6173 When the paper is finished to your satisfaction and previews/prints correctly,
6175 \begin_inset Quotes eld
6179 \begin_inset Quotes erd
6182 actions which need to be done before you submit it to the journals.
6186 \begin_layout Enumerate
6187 Export your paper as a \SpecialChar LaTeX
6190 File\SpecialChar menuseparator
6191 Export\SpecialChar menuseparator
6199 \begin_layout Enumerate
6204 file with your favorite text editor
6208 \begin_layout Enumerate
6209 remove the comment lines before the
6218 \begin_layout Enumerate
6223 usepackage...{fontenc}
6225 line if it appears (usually just after
6241 \begin_layout Enumerate
6242 remove everything between (and including) the
6255 except for any commands you specifically put into the \SpecialChar LaTeX
6256 preamble (which should appear immediately after the
6257 \begin_inset Quotes eld
6260 User specified \SpecialChar LaTeX
6262 \begin_inset Quotes erd
6273 \begin_layout Enumerate
6274 Run the resulting file through \SpecialChar LaTeX
6275 to make sure it still processes correctly.
6278 \begin_layout Enumerate
6279 Reread the journal requirements to make sure your filenames and formats are correct.
6282 \begin_layout Enumerate
6286 \begin_layout Subsubsection
6287 Comments On Specific Commands
6290 \begin_layout Standard
6291 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
6293 the AAS\SpecialChar TeX
6298 ) gives a good description of each.
6299 Thus it's probably easiest for me to go down the list as found in the guide and offer comments where necessary.
6300 So let's begin \SpecialChar ldots
6304 \begin_layout Paragraph
6305 Things that work as expected
6308 \begin_layout Standard
6309 Because they work as you might expect,
6310 I simply list them and the section they are found in:
6427 begin{thebibliography}
6437 all the cite commands and their variations (2.13.2),
6438 the generic graphicx figure commands (2.14.1),
6467 amongst other places),
6498 \begin_layout Standard
6499 The following style options also work correctly:
6525 Simply put them in the
6531 Layout\SpecialChar menuseparator
6537 \begin_layout Paragraph
6539 but require more comment
6542 \begin_layout Standard
6543 The following items work,
6544 but require a little more discussion:
6547 \begin_layout Itemize
6548 These items are reserved for use by the journal editors,
6549 but you can put them into the \SpecialChar LaTeX
6550 preamble if you feel compelled to do so:
6588 \begin_layout Itemize
6589 These items may be placed in the \SpecialChar LaTeX
6591 and are included as blanks in the template file:
6615 \begin_layout Itemize
6622 (2.3) – can only be used
6623 \begin_inset Quotes eld
6627 \begin_inset Quotes erd
6631 not in the middle of a paragraph.
6632 Use \SpecialChar TeX
6633 code if you need to embed it.
6636 \begin_layout Itemize
6643 (2.3) – will have extra {} after it.
6644 This should not cause an error.
6647 \begin_layout Itemize
6654 (2.6) – can only be used
6655 \begin_inset Quotes eld
6659 \begin_inset Quotes erd
6663 not in the middle of a paragraph.
6664 Use \SpecialChar TeX
6665 code if you need to embed it.
6668 \begin_layout Itemize
6675 (2.8) – can't insert a cross-reference tag,
6676 you must type the tag name by hand
6679 \begin_layout Itemize
6693 \begin_layout Itemize
6700 (2.9) – will have extra {} after it.
6701 This should not cause an error.
6704 \begin_layout Itemize
6711 (2.11) – will have extra {} after it.
6712 This should not cause an error.
6715 \begin_layout Itemize
6722 (2.14.2) – you can insert an optional filename argument by placing the cursor at the beginning of the text and selecting
6724 Insert\SpecialChar menuseparator
6729 \begin_inset Quotes eld
6733 \begin_inset Quotes erd
6736 inserts an optional argument of the type needed by
6743 Hopefully it will be renamed someday.
6746 \begin_layout Itemize
6759 for the catalog ID optional parameter
6762 \begin_layout Itemize
6775 for the catalog ID optional parameter
6778 \begin_layout Paragraph
6779 Things not implemented,
6780 use \SpecialChar TeX
6784 \begin_layout Standard
6796 setcounter{equation}
6799 Journal name abbreviations (2.13.4),
6842 insert it as the first element in the lefthand cell after where you want it.
6843 Don't use any of \SpecialChar LyX
6844 's rules in the table),
6919 \begin_layout Paragraph
6920 Things that cannot be implemented
6923 \begin_layout Standard
6925 at least in any meaningful sort of way,
6926 so I suggest ignoring them.
6927 They are the references environment (2.13.3),
6928 and the deluxetable environment (2.15).
6930 really need to use deluxetable,
6931 I suggest editing it in a separate file with a text editor,
6934 Insert\SpecialChar menuseparator
6936 \begin_inset space ~
6941 to include it in your \SpecialChar LyX
6945 File\SpecialChar menuseparator
6946 Open Example\SpecialChar menuseparator
6947 Articles\SpecialChar menuseparator
6948 American Astronomical Society
6950 for an example of this.
6953 \begin_layout Subsubsection
6957 and Other Ruminations
6960 \begin_layout Paragraph
6961 Getting \SpecialChar LyX
6962 and AAS\SpecialChar TeX
6966 \begin_layout Standard
6967 It can be a bit tricky to get \SpecialChar LyX
6968 to recognize a new layout and document class.
6969 When all else fails,
6973 \begin_layout Enumerate
6974 Make certain that \SpecialChar LaTeX
6975 can find AAS\SpecialChar TeX
6977 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
6978 distribution into a directory completely unrelated to \SpecialChar LaTeX
6979 or AAS\SpecialChar TeX
6980 and run \SpecialChar LaTeX
6988 \begin_layout Enumerate
6993 appears in \SpecialChar LyX
7001 \begin_layout Enumerate
7004 Tools\SpecialChar menuseparator
7009 then restart \SpecialChar LyX
7013 \begin_layout Enumerate
7014 Open a regular new file,
7015 not from a template.
7018 American Astronomical Society (AASTeX V.
7019 \begin_inset space \thinspace{}
7024 appear in the class list in
7026 Document\SpecialChar menuseparator
7032 \begin_layout Standard
7033 If you get a warning from an existing AAS\SpecialChar TeX
7034 document about not being able to find the AAS\SpecialChar TeX
7035 layout or a message about
7036 \begin_inset Quotes eld
7039 You should not mix title layouts with normal ones
7040 \begin_inset Quotes erd
7044 things haven't been installed correctly.
7047 \begin_layout Paragraph
7049 error processing a table
7052 \begin_layout Standard
7056 attempts to center the table caption/title.
7057 This seems to produce a bad interaction in AAS\SpecialChar TeX
7058 so you should click somewhere in the caption/title,
7061 Edit\SpecialChar menuseparator
7063 \begin_inset space ~
7078 This took care of it for me.
7081 \begin_layout Paragraph
7085 \begin_layout Standard
7090 \begin_layout Enumerate
7091 I have noticed some funny spacing in the reference entries in the text.
7092 When you enter the bibliography item data,
7097 space between the last author and the parenthesis setting off the year;
7101 \begin_inset space \thinspace{}
7105 \begin_inset space \space{}
7123 \begin_layout Enumerate
7124 Entering the references at all is not obvious.
7125 The easiest thing is to start typing your first reference at the end of the document,
7126 then mark it as type
7131 That will put a small gray box in front of what you just typed.
7132 Click on the box to fill in the rest of the information.
7134 go to the end of an existing reference and press return.
7135 That will create a new line with its own box,
7139 \begin_layout Paragraph
7143 \begin_layout Standard
7144 Even though AAS\SpecialChar TeX
7145 provides its own figure commands (
7153 I much prefer \SpecialChar LaTeX
7154 's standard figure commands (with the default graphicx).
7163 \begin_inset space ~
7166 commands as \SpecialChar TeX
7167 code into a Figure Float box if you desire,
7168 but I never have much luck getting the layout right.
7169 With the standard graphics,
7175 usepackage{graphicx}
7177 command into the \SpecialChar LaTeX
7178 preamble and handle the figures in the standard \SpecialChar LaTeX2e
7180 interspersing the figures in the text.
7181 I believe ApJ accepts figures exactly this way now;
7182 AJ might still use the
7183 \begin_inset Quotes eld
7186 stack everything at the end
7187 \begin_inset Quotes erd
7193 \begin_layout Paragraph
7194 Things I could have done,
7198 \begin_layout Standard
7200 \begin_inset Quotes eld
7204 \begin_inset Quotes erd
7207 things I could have implemented,
7210 I saw no point in double-spacing the text in the \SpecialChar LyX
7212 even though it is double-spaced in the paper manuscript.
7214 I chose not to make separate layouts for the preprint and preprint2 styles.
7215 Since I assume you will spend most of your time in the plain manuscript mode anyway,
7216 I decided not to chew up more disk space with this.
7220 \begin_layout Subsubsection
7224 \begin_layout Standard
7225 Your mileage may vary.
7226 I've now had papers published by both ApJ and AJ that have had 98% of the effort done in \SpecialChar LyX
7228 the last 2% was the \SpecialChar LaTeX
7229 post-processing and a few cleanups.
7230 I have had no trouble with the submission process,
7231 and I'm sure the journals were never aware that there might be a difference.
7233 go forth and publish!
7236 \begin_layout Subsection
7240 \begin_layout Standard
7245 uses the standard article document class together with the package
7249 to facilitate the description of chess games.
7252 File\SpecialChar menuseparator
7253 Open Example\SpecialChar menuseparator
7254 Articles\SpecialChar menuseparator
7268 \begin_layout Subsection
7272 \begin_layout Standard
7277 provides support for the
7282 class for journals in the Elsevier publishing house.
7283 This provides the following additional environments:
7287 \begin_inset space ~
7296 \begin_inset space ~
7305 \begin_inset space ~
7327 \begin_layout Standard
7328 A template is available in the menu
7333 ile\SpecialChar menuseparator
7335 \begin_inset space ~
7343 \begin_inset space ~
7346 Template\SpecialChar menuseparator
7347 Articles\SpecialChar menuseparator
7351 It has been customized with further environments and contains all the information you may need.
7353 the documentation is also available from
7354 \begin_inset CommandInset href
7357 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
7365 \begin_layout Subsection
7369 \begin_layout Standard
7372 Paper (Standard Class)
7374 provides an alternative to the
7376 Article (Standard Class)
7379 It provides similar functionality,
7380 but you might prefer this layout with sans serif sections,
7385 \begin_layout Subsection
7390 \begin_layout Standard
7396 \begin_layout Standard
7397 \begin_inset VSpace bigskip
7403 \begin_layout Standard
7408 \begin_inset space \thinspace{}
7413 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
7415 \begin_inset Formula $\beta$
7422 \begin_layout Standard
7429 which works with Rev\SpecialChar TeX
7432 v3.1 is basically obsolete,
7433 as it works with \SpecialChar LaTeX
7435 That means that it doesn't interact very well with \SpecialChar LyX
7437 which requires \SpecialChar LaTeX2e
7439 although it has been kludged to work.
7440 Since Rev\SpecialChar TeX
7441 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
7447 \begin_inset space ~
7451 \begin_inset space \thinspace{}
7456 textclass should also be pretty easy to use.
7459 \begin_layout Standard
7460 These documents are supposed to be used in
7464 to the Rev\SpecialChar TeX
7466 so we don't describe any of the special Rev\SpecialChar TeX
7468 and assume you'll know what to put in the preamble if necessary.
7471 \begin_layout Subsubsection
7475 \begin_layout Standard
7476 All you need to do is install Rev\SpecialChar TeX
7478 as described in the package's README file.
7479 The package can be found at The Rev\SpecialChar TeX
7481 \begin_inset Flex URL
7484 \begin_layout Plain Layout
7486 http://publish.aps.org/revtex4/
7492 Install it somewhere that \SpecialChar LaTeX
7494 Test it by trying to \SpecialChar LaTeX
7495 a short Rev\SpecialChar TeX
7496 4 document in some random directory (i.
7497 \begin_inset space \thinspace{}
7501 \begin_inset space \space{}
7504 not the directory where you installed the class file.) Then,
7505 if you reconfigure \SpecialChar LyX
7507 it will find the class file and let you use the Rev\SpecialChar TeX
7511 \begin_layout Standard
7512 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
7521 \begin_inset space ~
7529 File\SpecialChar menuseparator
7530 New From Templates\SpecialChar menuseparator
7536 \begin_layout Subsubsection
7540 \begin_layout Standard
7541 Optional arguments to
7549 \begin_inset Quotes eld
7553 \begin_inset Quotes erd
7557 \begin_inset Quotes eld
7561 \begin_inset Quotes erd
7568 \begin_inset space ~
7576 \begin_inset space ~
7583 Remember that in Rev\SpecialChar TeX
7585 at least one optional argument is required!
7589 \begin_layout Standard
7590 Other preamble matter,
7598 \begin_inset space ~
7605 \begin_inset space ~
7614 \begin_layout Subsubsection
7618 \begin_layout Standard
7619 The layouts basically correspond to the commands in Rev\SpecialChar TeX
7622 the Email layout corresponds to
7629 Note that (at least as of Rev\SpecialChar TeX
7639 layouts are exactly equivalent,
7640 so you shouldn't need to use both.
7644 \begin_layout Plain Layout
7645 In case you're curious,
7646 both were included so that
7650 would be able to translate both
7670 \begin_layout Subsubsection
7674 \begin_layout Standard
7675 There are a couple of important unique aspects of Rev\SpecialChar TeX
7676 4 which might cause bugs that will be even more confusing in \SpecialChar LyX
7680 \begin_layout Standard
7681 In Rev\SpecialChar TeX
7700 The \SpecialChar LyX
7701 equivalent is that there is a separate Thanks layout.
7706 write footnotes in the
7711 or weird things may happen.
7712 See the Rev\SpecialChar TeX
7713 4 documentation for more details.
7716 \begin_layout Standard
7721 \begin_inset space ~
7730 \begin_inset space ~
7740 layouts must be placed
7748 layout and the corresponding
7766 the \SpecialChar LaTeX
7770 \begin_layout Subsection
7774 \begin_layout Standard
7779 classes were replaced with a completely new class,
7785 Please find information at
7786 \begin_inset Flex URL
7789 \begin_layout Plain Layout
7791 https://www.springernature.com/gp/authors/campaigns/latex-author-support
7797 Native \SpecialChar LyX
7798 support is not available yet.
7801 \begin_layout Section
7805 \begin_layout Standard
7806 See also the document classes in the Collections (section
7807 \begin_inset space ~
7811 \begin_inset CommandInset ref
7813 reference "sec:Collections"
7821 \begin_layout Subsection
7825 \begin_layout Standard
7831 \begin_layout Subsubsection
7835 \begin_layout Standard
7836 Memoir is a very powerful and constantly evolving class.
7837 It has been designed with regard to fictional and non-fictional literature.
7838 Its aim is to let the user have maximum control over the typesetting of his document.
7839 Memoir is based on the standard book class,
7840 but it can also emulate the article class (see below).
7843 \begin_layout Standard
7845 the developer of Memoir,
7846 is known as the author of lots of useful packages in the \SpecialChar LaTeX
7848 Most of them have been merged with Memoir.
7850 it is much easier to layout the table of contents,
7852 chapter designs and such.
7856 does not support all of these goodies natively.
7857 Some of them might be added to forthcoming releases
7861 \begin_layout Plain Layout
7862 You are invited to send suggestions to
7863 \begin_inset Flex URL
7866 \begin_layout Plain Layout
7868 lyx-devel@lists.lyx.org
7879 lots will probably never be supported,
7880 due to the limitations of \SpecialChar LyX
7882 Of course you can still use all features with the help of some native \SpecialChar LaTeX
7883 commands (\SpecialChar TeX
7888 \begin_layout Plain Layout
7893 \begin_layout Plain Layout
7903 \begin_inset space ~
7907 \begin_inset CommandInset ref
7909 reference "sec:Inserting-TeX-Code"
7921 we can only list those features that are natively supported by \SpecialChar LyX
7923 For detailed descriptions (and for the rest of features) we recommend you have a look at the detailed manual of the Memoir class
7927 \begin_layout Plain Layout
7932 \begin_layout Plain Layout
7942 \begin_inset Flex URL
7945 \begin_layout Plain Layout
7947 CTAN:/macros/latex/memoir/memman.pdf
7958 which is not only a user guide for the class,
7959 but also both a comprehensive description on good typesetting and a superb example for good typesetting itself.
7962 \begin_layout Subsubsection
7963 Basic features and restrictions
7966 \begin_layout Standard
7967 Memoir supports basically all features of the standard book classes.
7974 \begin_layout Description
7976 \begin_inset space ~
7980 Memoir has a broader range of font sizes:
7989 \begin_layout Description
7991 \begin_inset space ~
7995 The fancy page style is not supported,
7996 due to a command clash between Memoir and the fancyhdr package (they both define a command with the same name,
7997 which confuses \SpecialChar LaTeX
8000 Memoir comes with a number of its own page styles (see
8002 Document\SpecialChar menuseparator
8003 Settings\SpecialChar menuseparator
8005 \begin_inset space ~
8011 If you want to use these for the chapter pages,
8012 you have to use the command
8018 in the main text or in preamble (e.
8019 \begin_inset space \thinspace{}
8023 \begin_inset space \space{}
8030 chapterstyle{companion}
8035 \begin_layout Description
8037 Sectionings (chapter,
8039 subsection etc.) come with an optional argument in the standard classes.
8041 you can specify an alternative version of the title for the table of contents and the headers (for instance,
8042 if the title is too long).
8047 Insert\SpecialChar menuseparator
8049 \begin_inset space ~
8054 at the beginning of a chapter/section.
8055 Memoir features a second optional argument and thus separates the table of contents from the header.
8056 You can define three variants of a title with this:
8057 one for the main text,
8058 one for the table of contents,
8059 and one for the headers.
8061 makes these available in form of specific
8072 \begin_layout Description
8074 In the standard classes (and in many other classes),
8075 the table of contents,
8076 the list of figures and the list of table start a new page automatically.
8077 Memoir does not follow this route.
8078 You have to insert a page break yourself,
8079 if you want to have one.
8082 \begin_layout Description
8084 For some unknown reason,
8085 Memoir uses pagination on the title page (in the standard classes,
8087 \begin_inset Quotes eld
8091 \begin_inset Quotes erd
8095 If you want an empty title page,
8100 aliaspagestyle{title}{empty}
8105 \begin_layout Description
8107 With the class option
8113 Document\SpecialChar menuseparator
8114 Settings\SpecialChar menuseparator
8115 Class Settings\SpecialChar menuseparator
8117 \begin_inset space ~
8123 you can emulate article style.
8125 counters (footnotes,
8127 tables etc.) will not be reset on new chapters,
8128 chapters don't start a new page (but are—
8130 \begin_inset Quotes eld
8134 \begin_inset Quotes erd
8145 \begin_layout Description
8148 Memoir does not allow the use of the deprecated font commands,
8149 which have been used in the old \SpecialChar LaTeX
8151 \begin_inset space \thinspace{}
8155 \begin_inset space \space{}
8172 It produces an error and stops \SpecialChar LaTeX
8173 whenever such a command appears.
8178 reallows the commands and spits out warnings instead (which does at least not stop \SpecialChar LaTeX
8180 Since a lot of packages and particularly Bib\SpecialChar TeX
8181 style files are still using those commands,
8182 we have decided to use this option by default.
8185 \begin_layout Subsubsection
8189 \begin_layout Standard
8190 We will only describe the features supported by \SpecialChar LyX
8191 (which is not much currently).
8192 Please consult the Memoir manual
8196 \begin_layout Plain Layout
8201 \begin_layout Plain Layout
8211 \begin_inset Flex URL
8214 \begin_layout Plain Layout
8216 CTAN:/macros/latex/memoir/memman.pdf
8229 \begin_layout Description
8231 You may wonder why an abstract is an extra feature.
8233 it is in book class.
8234 Usually books don't have abstracts.
8238 You can use it wherever and how often you like.
8241 \begin_layout Description
8243 You may know this older typesetting style:
8244 The contents of a chapter are summarized below the title and also in the table of contents (e.
8245 \begin_inset space \thinspace{}
8249 \begin_inset space \space{}
8254 Our hero arrives in Troia;
8255 he loses some friends;
8259 Chapterprecis does exactly this.
8260 It is therefore only sensible below a chapter.
8263 \begin_layout Description
8265 An epigraph is a smart slogan or motto at the beginning of a chapter.
8266 The epigraph environment provides an elegant way of typesetting such a motto.
8267 The motto itself (text) and its (optional) author (source) are divided by a short line.
8268 The author (source) can be inserted via
8270 Insert\SpecialChar menuseparator
8277 \begin_layout Description
8279 Memoir has lots of possibilities to typeset poetry (up to very complex figurative poems).
8281 can only support a few of them.
8283 which is a centered title for poems,
8284 which will also be added to the table of contents (verse is the standard environment for poems.
8285 Memoir has some enhanced versions of verse,
8286 but you need to use \SpecialChar TeX
8288 because they have to be nested inside regular verse environments,
8289 which is not possible with \SpecialChar LyX
8293 \begin_layout Description
8296 but it adds no entry to the table of contents.
8299 \begin_layout Subsection
8303 \begin_layout Standard
8312 document class but adds two environments:
8315 \begin_layout Description
8316 Recipe a numbered section environment at the
8320 level which generates a bold centered heading above a double horizontal rule
8323 \begin_layout Description
8334 are what are being described and the environment ends with a horizontal rule.
8337 \begin_layout Standard
8340 File\SpecialChar menuseparator
8341 Open Example\SpecialChar menuseparator
8342 Books\SpecialChar menuseparator
8345 illustrates its use.
8348 \begin_layout Standard
8349 The class is designed for typesetting one or two recipes per page.
8350 The hyperlinked table of contents (ToC) and page numbers make browsing recipes convenient.
8354 \begin_layout Section
8358 \begin_layout Subsection
8362 \begin_layout Standard
8372 an unofficial implementation of the ‘Europass CV’ recommended by the European Commission in 2013.
8375 File\SpecialChar menuseparator
8376 Open Example\SpecialChar menuseparator
8377 Curricula Vitae\SpecialChar menuseparator
8380 offers guidance on its use.
8381 Its documentation is available from
8382 \begin_inset CommandInset href
8385 target "http://mirrors.ctan.org/macros/latex/contrib/europasscv/europasscv.pdf"
8393 \begin_layout Subsection
8397 \begin_layout Standard
8407 an unofficial implementation of the “Europass CV” recommended by the European Commission in 2002.
8410 File\SpecialChar menuseparator
8411 Open Example\SpecialChar menuseparator
8412 Curricula Vitae\SpecialChar menuseparator
8415 offers guidance on its use.
8416 Its documentation is available from
8417 \begin_inset CommandInset href
8420 target "http://mirrors.ctan.org/macros/latex/contrib/europecv/europecv.pdf"
8428 \begin_layout Subsection
8432 \begin_layout Standard
8442 This allows the creation of customizable CVs.
8445 File\SpecialChar menuseparator
8446 Open Example\SpecialChar menuseparator
8447 Curricula Vitae\SpecialChar menuseparator
8450 offers guidance on its use.
8451 Its documentation is available from
8452 \begin_inset CommandInset href
8455 target "http://mirrors.ctan.org/macros/latex/contrib/moderncv/manual/moderncv_userguide.pdf"
8463 \begin_layout Subsection
8467 \begin_layout Standard
8477 originally developed for use with \SpecialChar LyX
8481 File\SpecialChar menuseparator
8482 Open Example\SpecialChar menuseparator
8483 Curricula Vitae\SpecialChar menuseparator
8486 offers guidance on its use.
8487 Its documentation is available from
8488 \begin_inset CommandInset href
8491 target "http://mirrors.ctan.org/macros/latex/contrib/simplecv/simplecv.pdf"
8499 \begin_layout Section
8503 \begin_layout Standard
8506 KOMA-Script Letter (V.
8510 \begin_inset space ~
8514 \begin_inset CommandInset ref
8516 reference "subsec:The-new-letter"
8523 Letter (Standard Class with Extra Font Sizes)
8526 \begin_inset space ~
8530 \begin_inset CommandInset ref
8532 reference "subsec:Extra-font-sizes"
8537 ) document classes .
8540 \begin_layout Subsection
8544 \begin_layout Standard
8549 provides support for the
8554 class for writing letters according to the standards of the German Standards Institute (
8556 Deutsches Institut für Normung,
8560 The file in the menu
8565 ile\SpecialChar menuseparator
8567 \begin_inset space ~
8575 \begin_inset space ~
8578 Template\SpecialChar menuseparator
8579 Letters\SpecialChar menuseparator
8582 offers guidance on its use.
8583 The documentation is available from
8584 \begin_inset CommandInset href
8587 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
8595 \begin_layout Subsection
8597 \begin_inset space \space{}
8603 \begin_layout Standard
8607 \begin_inset space \space{}
8612 provides support for the
8617 class for writing letters according to French conventions.
8618 The file in the menu
8623 ile\SpecialChar menuseparator
8625 \begin_inset space ~
8633 \begin_inset space ~
8636 Template\SpecialChar menuseparator
8637 Letters\SpecialChar menuseparator
8639 \begin_inset space \space{}
8644 offers guidance on its use.
8647 \begin_layout Subsection
8649 \begin_inset space \space{}
8655 \begin_layout Standard
8659 \begin_inset space \space{}
8664 provides support for
8669 another \SpecialChar LaTeX
8670 class for writing letters,
8671 but also faxes and envelopes,
8673 The file in the menu
8678 ile\SpecialChar menuseparator
8680 \begin_inset space ~
8688 \begin_inset space ~
8691 Template\SpecialChar menuseparator
8692 Letters\SpecialChar menuseparator
8694 \begin_inset space \space{}
8699 offers guidance on its use.
8700 The documentation is available from
8701 \begin_inset CommandInset href
8704 target "http://mirrors.ctan.org/macros/latex/contrib/lettre/lettre.pdf"
8712 \begin_layout Subsection
8714 \begin_inset space \thinspace{}
8720 \begin_layout Standard
8724 \begin_inset space \thinspace{}
8729 provides support for the
8734 class for writing letters in German.
8735 The file in the menu
8740 ile\SpecialChar menuseparator
8742 \begin_inset space ~
8750 \begin_inset space ~
8753 Template\SpecialChar menuseparator
8754 Letters\SpecialChar menuseparator
8756 \begin_inset space \thinspace{}
8761 offers guidance on its use.
8762 The documentation is available from
8763 \begin_inset CommandInset href
8766 target "http://mirrors.ctan.org/macros/latex/contrib/g-brief/g-brief.pdf"
8774 \begin_layout Section
8778 \begin_layout Subsection
8782 \begin_layout Standard
8792 class for creating presentations.
8793 The file in the menu
8798 ile\SpecialChar menuseparator
8800 \begin_inset space ~
8808 \begin_inset space ~
8811 Template\SpecialChar menuseparator
8812 Presentations\SpecialChar menuseparator
8817 Help\SpecialChar menuseparator
8818 Specific Manuals\SpecialChar menuseparator
8819 Beamer Presentations
8821 offers guidance on its use.
8822 The documentation is available from
8823 \begin_inset CommandInset href
8826 target "http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf"
8834 \begin_layout Subsection
8837 Foil\SpecialChar TeX
8841 \begin_inset CommandInset label
8850 \begin_layout Standard
8856 updated by the \SpecialChar LyX
8860 \begin_layout Subsubsection
8864 \begin_layout Standard
8867 Foil\SpecialChar TeX
8874 document class to make slides for overhead projectors.
8875 There are two document classes that can do this:
8880 document class (section
8881 \begin_inset space ~
8885 \begin_inset CommandInset ref
8887 reference "sec:slitex"
8897 Foil\SpecialChar TeX
8901 As of 2023 the former has continued to be maintained whereas
8903 Foil\SpecialChar TeX
8906 has not been maintained since 2008.
8907 This section documents the latter.
8908 If your machine doesn’t have the
8910 Foil\SpecialChar TeX
8913 document class installed,
8914 you’ll probably have to use the
8919 If you want to install the
8924 it is available from
8925 \begin_inset CommandInset href
8928 target "https://www.ctan.org/pkg/foiltex"
8934 You should also read the
8936 Installing New Document Classes
8945 \begin_layout Subsubsection
8949 \begin_layout Standard
8951 to use this document class,
8963 \begin_inset space ~
8969 There are some settings in the
8972 \begin_inset space ~
8977 dialog that you should know about that are specific to this class:
8980 \begin_layout Itemize
8981 Don't change the options
8992 \begin_inset space ~
8998 They're ignored by the
9005 \begin_layout Itemize
9006 The default font size is 20
9007 \begin_inset space \thinspace{}
9010 pt with the other options being 17
9011 \begin_inset space \thinspace{}
9016 \begin_inset space \thinspace{}
9020 \begin_inset space \thinspace{}
9026 \begin_layout Itemize
9035 but all math equations are still typeset in the usual roman font.
9038 \begin_layout Itemize
9041 Foil\SpecialChar TeX
9044 supports A4 and Letter paper sizes as well as a special size for working with 35
9045 \begin_inset space \thinspace{}
9049 It doesn't support A5,
9051 legal or executive paper sizes.
9054 \begin_layout Itemize
9055 Don't bother changing the
9059 settings because they are ignored anyway.
9060 All floats appear where they are defined in the text.
9063 \begin_layout Itemize
9068 setting behaves a bit differently for this class.
9071 Foil\SpecialChar TeX
9074 provides extensive footer and header capabilities including a user-defined logo.
9076 \begin_inset space ~
9080 \begin_inset CommandInset ref
9082 reference "sec:foilfoot"
9088 The title page is treated differently to all other pages in the document and is
9096 has the logo centered at the bottom of the page (if one is defined).
9097 The possible page style choices and what they do are as follows:
9101 \begin_layout Labeling
9102 \labelwidthstring MMMMMMM
9109 The final output contains no page numbers,
9110 or other headers or footers (except footnotes of course).
9114 \begin_layout Labeling
9115 \labelwidthstring MMMMMMM
9122 The final output contains page numbers centered at the bottom of the page.
9123 No other headings or footers (other than footnotes).
9126 \begin_layout Labeling
9127 \labelwidthstring MMMMMMM
9132 Page numbers in lower right corner.
9133 Additional headers and footers are also shown.
9134 This is also the default.
9137 \begin_layout Labeling
9138 \labelwidthstring MMMMMMM
9143 Gives you access to the
9147 package although its use with
9149 Foil\SpecialChar TeX
9152 is discouraged by the writer of the
9154 Foil\SpecialChar TeX
9157 package because of some potential page layout clashes.
9161 \begin_layout Paragraph
9165 \begin_layout Standard
9166 The following options may be used in the extra class options in the
9168 Document\SpecialChar menuseparator
9174 \begin_layout Labeling
9175 \labelwidthstring MMMMMMx
9180 This sets up the page layout for 7.33
9181 \begin_inset space \thinspace{}
9185 \begin_inset space \thinspace{}
9189 which is about the same aspect ratio as a 35
9190 \begin_inset space \thinspace{}
9194 making it a bit easier to work with this medium.
9197 \begin_layout Labeling
9198 \labelwidthstring MMMMMMx
9203 Places a rule across the page below the header on every page except the title page.
9206 \begin_layout Labeling
9207 \labelwidthstring MMMMMMx
9212 Places a rule across the page above the footer on every page except the title page.
9215 \begin_layout Labeling
9216 \labelwidthstring MMMMMMx
9221 This is automatically set each time you create a new
9228 Foil\SpecialChar TeX
9231 to use the dvips driver to rotate those pages that are set as landscape foils.
9234 \begin_layout Labeling
9235 \labelwidthstring MMMMMMx
9240 Simply changes the page dimensions to those of a landscape page but doesn't do any rotation.
9241 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.
9242 Note that this option effectively reverses the roles of the
9250 environments (don't worry these are described in the next section).
9253 \begin_layout Labeling
9254 \labelwidthstring MMMMMMx
9259 Equation numbers on the left.
9262 \begin_layout Labeling
9263 \labelwidthstring MMMMMMx
9268 Flush-left equations.
9271 \begin_layout Subsubsection
9272 Supported Environments
9275 \begin_layout Standard
9276 Most of the environments commonly supported in other classes are also supported by the
9278 Foil\SpecialChar TeX
9282 There are several additional environments provided by
9284 Foil\SpecialChar TeX
9287 as well as a couple added by \SpecialChar LyX
9289 The following environments are shared with other classes:
9292 \begin_layout Standard
9293 \begin_inset Flex Multiple Columns
9296 \begin_layout Itemize
9302 \begin_layout Itemize
9308 \begin_layout Itemize
9314 \begin_layout Itemize
9320 \begin_layout Itemize
9326 \begin_layout Itemize
9333 \begin_layout Itemize
9339 \begin_layout Itemize
9345 \begin_layout Itemize
9351 \begin_layout Itemize
9357 \begin_layout Itemize
9363 \begin_layout Itemize
9369 \begin_layout Itemize
9375 \begin_layout Itemize
9381 \begin_layout Itemize
9387 \begin_layout Itemize
9398 \begin_layout Standard
9400 all the major environments apart from the sectioning environments.
9401 Since foils are essentially self-contained sections,
9402 with a title and body,
9405 Foil\SpecialChar TeX
9408 provides specific commands for starting new foils and these are:
9411 \begin_layout Itemize
9417 \begin_layout Itemize
9423 \begin_layout Standard
9425 also provides slightly modified versions of these two environments called:
9428 \begin_layout Itemize
9434 \begin_layout Itemize
9440 \begin_layout Standard
9441 and the differences will be explained in the next section.
9444 \begin_layout Standard
9445 Since foils are often used in presenting ideas or new theorems and such
9447 Foil\SpecialChar TeX
9450 also provides a comprehensive box of goodies for presenting them:
9453 \begin_layout Standard
9454 \begin_inset Flex Multiple Columns
9457 \begin_layout Itemize
9463 \begin_layout Itemize
9469 \begin_layout Itemize
9475 \begin_layout Itemize
9481 \begin_layout Itemize
9487 \begin_layout Itemize
9493 \begin_layout Itemize
9499 \begin_layout Itemize
9505 \begin_layout Itemize
9511 \begin_layout Itemize
9517 \begin_layout Itemize
9528 \begin_layout Standard
9529 The starred versions are unnumbered while the unstarred versions are numbered.
9530 There are also two list environments added by \SpecialChar LyX
9534 \begin_layout Itemize
9540 \begin_layout Itemize
9546 \begin_layout Standard
9549 Foil\SpecialChar TeX
9552 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.
9553 If you want to change these settings in your document the best place to do so is at the very top of a foil,
9555 \begin_inset space \thinspace{}
9561 \begin_inset space \space{}
9566 straight after the foilhead.
9569 \begin_layout Standard
9571 the following command styles are provided [
9578 \begin_layout Standard
9579 \begin_inset Flex Multiple Columns
9582 \begin_layout Itemize
9586 \begin_inset space ~
9592 \begin_layout Itemize
9598 \begin_layout Itemize
9602 \begin_inset space ~
9608 \begin_layout Itemize
9612 \begin_inset space ~
9618 \begin_layout Itemize
9622 \begin_inset space ~
9629 \begin_layout Plain Layout
9630 \begin_inset space ~
9642 \begin_layout Standard
9643 There are also a few commands provided by
9645 Foil\SpecialChar TeX
9648 that aren't directly supported by \SpecialChar LyX
9649 but I'll tell you what they do and how to use them in section
9650 \begin_inset space ~
9654 \begin_inset CommandInset ref
9656 reference "sec:unsuppfoils"
9664 \begin_layout Subsubsection
9665 Building a Set of Foils
9668 \begin_layout Standard
9669 This section will give a simple introduction to using the different environments to build a set of foils.
9670 If you want to see an example set of foils,
9673 File\SpecialChar menuseparator
9674 Open Example\SpecialChar menuseparator
9675 Presentations\SpecialChar menuseparator
9681 \begin_layout Paragraph
9682 Give It a Title Page
9685 \begin_layout Standard
9686 Unlike other classes that provide
9711 creates the title on a page of its own.
9712 If you leave out the
9716 environment \SpecialChar LaTeX
9717 will substitute the current date (every time you regenerate the output).
9720 \begin_layout Paragraph
9724 \begin_layout Standard
9725 As I mentioned earlier,
9726 there are four ways of starting a new foil.
9727 For portrait foils you should use
9736 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.
9739 \begin_layout Standard
9740 Landscape foils are generated using the
9749 Again the only difference is the spacing between foilhead and body.
9750 Both of the short versions have 0.5
9751 \begin_inset space ~
9754 inches less separation between the foilhead and the body.
9758 \begin_layout Standard
9759 One problem with the support for landscape foils is the requirement that you have to use the
9763 driver to generate the PostScript output otherwise the foils won't be rotated.
9764 It is possible to get landscape foils even if you haven't got the
9768 driver provided you can feed your foils sideways through your printer ;-)
9771 \begin_layout Paragraph
9777 \begin_layout Standard
9778 You can't have two of the same type of these environments directly following each other.
9779 If you use a normal paragraph break,
9781 you will just be extending the previous environment as if you had merged the two environments together.
9783 you need to insert a so-called separator.
9784 Please refer to the section entitled
9795 \begin_layout Paragraph
9799 \begin_layout Standard
9800 You get all the commonly supported list styles found in other classes as well as two new ones.
9801 I'll only describe the new ones here.
9802 If you want to find out more about the other list environments check out the
9807 If you intend to use itemized lists you might also want to read about the
9810 \begin_inset space ~
9814 \begin_inset space ~
9819 dialog described above in section
9820 \begin_inset space ~
9824 \begin_inset CommandInset ref
9826 reference "chap:bullets"
9834 \begin_layout Standard
9835 The two new list styles,
9845 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.
9846 These lists are in fact dedicated variants of the
9851 They do however require that you have the
9858 \begin_layout Paragraph
9862 \begin_layout Standard
9865 Foil\SpecialChar TeX
9868 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.
9869 In fact if you change the float placement settings they are simply ignored.
9872 \begin_layout Paragraph
9873 Page Headers and Footers
9874 \begin_inset CommandInset label
9883 \begin_layout Standard
9887 \begin_inset space ~
9896 are two commands used to control the left-footer text string.
9897 The first is meant to allow you to include a graphic logo on your foils and defaults to
9898 \begin_inset Quotes eld
9903 Foil\SpecialChar TeX
9907 \begin_inset Quotes erd
9911 While the second is meant to provide a classification for the audience,
9915 \begin_inset space \thinspace{}
9921 \begin_inset space \space{}
9925 It is empty by default.
9928 \begin_layout Standard
9929 The remaining page corners can be filled by
9932 \begin_inset space ~
9937 (which defaults to page numbers),
9941 \begin_inset space ~
9949 \begin_inset space ~
9957 \begin_layout Subsubsection
9960 Foil\SpecialChar TeX
9964 \begin_inset CommandInset label
9966 name "sec:unsuppfoils"
9973 \begin_layout Standard
9974 All the commands mentioned below need to be set in a
9984 within another environment.
9987 \begin_layout Paragraph
9991 \begin_layout Standard
9992 All lengths are adjusted using the
10015 should be replaced by the name given to the length you want to change and
10019 is the length value.
10020 All lengths should be specified in units of length such as inches (
10033 ) or relative to some document or font-based length such as
10043 \begin_layout Standard
10044 It's possible to change the spacing between a foilhead and the body of the foil by adjusting the length specified by
10057 \begin_inset space \space{}
10060 in closer to their bodies put the following in the preamble:
10067 foilheadskip}{-0.5in}
10070 \begin_layout Standard
10071 The spacings around floats can be adjusted by setting these lengths:
10074 \begin_layout Labeling
10075 \labelwidthstring MMMMMMMMMMM
10082 Separation between the text and the top of the float
10085 \begin_layout Labeling
10086 \labelwidthstring MMMMMMMMMMM
10093 Separation between the float and the caption
10096 \begin_layout Labeling
10097 \labelwidthstring MMMMMMMMMMM
10104 Separation between the caption and the following text
10107 \begin_layout Labeling
10108 \labelwidthstring MMMMMMMMMMM
10115 You can make the captions narrower than the surrounding text by adjusting this length.
10116 Best done relative to
10125 \begin_layout Standard
10126 There are also several title page related lengths that you may find useful if you have a long title or several authors:
10129 \begin_layout Labeling
10130 \labelwidthstring MMMMMMMMMMM
10137 Separation from headers to
10142 \begin_layout Labeling
10143 \labelwidthstring MMMMMMMMMMM
10161 \begin_layout Labeling
10162 \labelwidthstring MMMMMMMMMMM
10176 \begin_layout Labeling
10177 \labelwidthstring MMMMMMMMMMM
10193 \begin_layout Labeling
10194 \labelwidthstring MMMMMMMMMMM
10210 \begin_layout Standard
10211 The last length related command affects all the list environments.
10222 a list environment then all the vertical spacing between the list items is removed.
10223 Note that this is a command not a length so it doesn't require
10229 like the stuff mentioned above.
10232 \begin_layout Paragraph
10233 Headers and Footers
10236 \begin_layout Standard
10249 commands control whether the logo in the
10253 definition appear on a given page.
10260 in the preamble then none of the foils will have the logo on them.
10261 If you don't want the logo on a particular page place the
10267 directly after the foilhead of that page and the
10273 directly after the next foilhead.
10276 \begin_layout Standard
10277 If you decide to use the
10281 page style setting in the
10284 \begin_inset space ~
10289 dialog you should probably add
10299 to your preamble so headers and footers on landscape pages are correctly placed when rotated.
10300 This is due to some clashes between the page layouts provided by the
10313 \begin_layout Subsection
10317 \begin_layout Standard
10327 class for creating presentations.
10330 File\SpecialChar menuseparator
10331 Open Example\SpecialChar menuseparator
10332 Presentations\SpecialChar menuseparator
10335 offers guidance on its use.
10336 The documentation is available from
10337 \begin_inset CommandInset href
10340 target "http://mirrors.ctan.org/macros/latex/contrib/powerdot/doc/powerdot.pdf"
10348 \begin_layout Subsection
10349 \begin_inset CommandInset label
10351 name "subsec:Seminar"
10360 \begin_layout Standard
10369 document class for creating presentations.
10372 File\SpecialChar menuseparator
10373 Open Example\SpecialChar menuseparator
10374 Presentations\SpecialChar menuseparator
10377 offers guidance on its use.
10378 The documentation is available from
10379 \begin_inset CommandInset href
10382 target "http://mirrors.ctan.org/macros/latex/contrib/seminar/doc/seminar-doc.pdf"
10390 \begin_layout Subsection
10393 Sli\SpecialChar TeX
10397 \begin_inset CommandInset label
10406 \begin_layout Standard
10412 updated by the \SpecialChar LyX
10416 \begin_layout Subsubsection
10420 \begin_layout Standard
10421 This section describes how to use \SpecialChar LyX
10422 to make slides for overhead projectors.
10423 There are two document classes that can do this:
10428 document class and the
10430 Foil\SpecialChar TeX
10434 This section documents the former.
10435 If you’re looking for the documentation for
10437 Foil\SpecialChar TeX
10442 \begin_inset space ~
10446 \begin_inset CommandInset ref
10448 reference "sec:foiltex"
10461 has continued to be maintained whereas
10463 Foil\SpecialChar TeX
10466 has not been maintained since 2008.
10470 \begin_layout Subsubsection
10472 \begin_inset CommandInset label
10474 name "sec:slidesetup"
10481 \begin_layout Standard
10483 to use this document class,
10485 \begin_inset Quotes eld
10493 \begin_inset Quotes erd
10496 from the class list in the
10498 Document\SpecialChar menuseparator
10502 There are some other special things you should know about this class:
10505 \begin_layout Itemize
10506 Don't bother changing the options
10511 They're not supported by the
10519 \begin_layout Itemize
10523 \begin_inset space ~
10528 behaves a bit differently for this class.
10529 The possible choices and what they do are as follows:
10533 \begin_layout Description
10538 The final output contains page numbers in the lower right corner.
10541 \begin_layout Description
10551 but also prints out any time markers you've put in.
10552 This is the default.
10555 \begin_layout Description
10560 The final output contains no page numbers,
10562 or alignment markers.
10566 \begin_layout Itemize
10571 class has an extra option:
10579 \begin_inset Quotes eld
10587 \begin_inset Quotes erd
10590 in the extra class options.
10594 \begin_layout Standard
10595 Using this options allows you to add time markers to
10601 \begin_inset space ~
10605 \begin_inset CommandInset ref
10607 reference "sec:slideNote"
10616 \begin_layout Standard
10617 You can also use the template file to automatically set up a document to use the
10623 File\SpecialChar menuseparator
10625 \begin_inset space ~
10629 \begin_inset space ~
10632 Template\SpecialChar menuseparator
10633 Presentations\SpecialChar menuseparator
10636 to open your new document.
10637 The template file also contains some examples of the special paragraph environments used by this class.
10638 I'll describe those next.
10641 \begin_layout Subsubsection
10642 Paragraph Environments
10645 \begin_layout Paragraph
10646 Supported Environments
10649 \begin_layout Standard
10650 The first thing you'll notice when you start up a new
10654 document is the font size and type:
10655 it's the equivalent of the size
10656 \begin_inset Quotes eld
10664 \begin_inset Quotes erd
10670 \begin_inset space ~
10676 This is also what's used in the output.
10678 \begin_inset Quotes eld
10682 \begin_inset Quotes erd
10685 to remind you that this is a slide.
10686 Your final slides will use a larger font;
10688 you'll have less space.
10690 the larger default screen font isn't WYSIWYG,
10694 \begin_layout Standard
10695 The next thing that becomes obvious is the changes to the paragraph environment pull-down box [at the far-left end of the toolbar].
10696 Most of the paragraph environments you're used to seeing are missing.
10697 There are also five new ones.
10702 class itself only supports certain paragraph environments:
10705 \begin_layout Standard
10708 \begin_inset Flex Multiple Columns
10711 \begin_layout Itemize
10717 \begin_layout Itemize
10723 \begin_layout Itemize
10729 \begin_layout Itemize
10735 \begin_layout Itemize
10741 \begin_layout Itemize
10747 \begin_layout Itemize
10753 \begin_layout Itemize
10759 \begin_layout Itemize
10765 \begin_layout Itemize
10777 \begin_layout Standard
10778 All of the other standard environments,
10779 including the section-heading environments,
10787 \begin_layout Standard
10789 you'll notice the following new environments:
10792 \begin_layout Standard
10795 \begin_inset Flex Multiple Columns
10798 \begin_layout Itemize
10804 \begin_layout Itemize
10810 \begin_layout Itemize
10816 \begin_layout Itemize
10822 \begin_layout Itemize
10829 \begin_layout Plain Layout
10830 \begin_inset space ~
10842 \begin_layout Standard
10843 These five are kind of quirky,
10845 \begin_inset Quotes eld
10849 \begin_inset Quotes erd
10852 in \SpecialChar LyX
10856 doesn't permit you to nest any other paragraph environment into an empty environment.
10858 that's fine and dandy,
10859 but it means that you wouldn't be able to start a slide with anything except plain text.
10861 I've performed a little
10862 \begin_inset Quotes eld
10867 \begin_inset Quotes erd
10873 \begin_layout Paragraph
10874 Quirks of the New Environments
10875 \begin_inset CommandInset label
10877 name "sec:slideQuirk"
10884 \begin_layout Standard
10885 All five of the new paragraph environments are somewhat quirky due to inherent limitiations in the current version of \SpecialChar LyX
10887 As I just mentioned,
10889 forbids environments that begin with another environment.
10890 To get around this,
10895 environment isn't a paragraph environment as described in the
10903 \begin_layout Standard
10904 You should consider
10919 \begin_inset Quotes eld
10922 pseudo-environments.
10923 \begin_inset Quotes erd
10926 They look like a section heading or a
10927 \begin_inset Quotes eld
10935 \begin_inset Quotes erd
10938 but really begin a [and,
10940 end the previous] paragraph environment.
10951 \begin_inset Quotes eld
10955 \begin_inset Quotes erd
10958 These two perform some action.
10961 \begin_layout Standard
10962 A common feature of all five environments,
10987 is a rather long-ish label.
10988 The text following this label —
10989 ordinarily the contents of the paragraph environment —
10990 is utterly irrelevant for
11015 completely ignores it.
11017 you can leave these five environments completely empty.
11021 \begin_layout Standard
11026 to put any text after the rather long-ish label,
11028 This could be a short description of the contents of the
11035 enter your descriptive comment and hit
11039 as you normally would.
11042 \begin_layout Subsubsection
11043 Making a Presentation with
11057 \begin_layout Paragraph
11065 \begin_layout Standard
11066 If you're expecting this section to teach you how to actually make a presentation,
11067 you'll be sorely disappointed.
11069 I'll describe all of the ways the
11073 class can assist you in preparing the materials for a presentation.
11074 Filling in the contents,
11082 the \SpecialChar LyX
11086 \begin_layout Standard
11091 environment [in the manner described in section
11092 \begin_inset space ~
11096 \begin_inset CommandInset ref
11098 reference "sec:slideQuirk"
11103 ] tells \SpecialChar LyX
11104 to begin a new slide [duh].
11105 The label for this environment/
11106 \begin_inset Quotes eld
11110 \begin_inset Quotes erd
11114 \begin_inset Quotes eld
11118 \begin_inset Quotes erd
11122 followed by the label,
11124 \begin_inset Quotes eld
11128 \begin_inset Quotes erd
11132 Any text or paragraph environments that follow this one go on the new slide.
11136 \begin_layout Standard
11137 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
11138 (this can be specified in the
11145 once you finish entering the contents of one slide.
11146 If you've entered more text than can physically fit on a slide,
11147 the extra overflows onto a new slide.
11148 I don't recommend doing this,
11150 since the overflow slide won't have any page number on it.
11152 it may interfere with any
11156 you've made to accompany the oversized
11163 \begin_layout Standard
11172 environments work the same way as the
11177 They both create an
11178 \begin_inset Quotes eld
11182 \begin_inset Quotes erd
11185 followed by a label [
11186 \begin_inset Quotes eld
11190 \begin_inset Quotes erd
11194 \begin_inset Quotes eld
11198 \begin_inset Quotes erd
11203 The color is a stunning magenta instead of blue,
11205 \begin_inset Quotes eld
11209 \begin_inset Quotes erd
11212 will look different,
11213 in style and in length.
11214 The label fonts of all three also differ from one another.
11217 \begin_layout Standard
11223 if the contents of a
11231 exceed the physical size of a slide or sheet of paper,
11232 the extra will overflow onto a new sheet.
11234 you should avoid this.
11235 It defeats the whole purpose of
11246 \begin_layout Paragraph
11256 \begin_layout Standard
11261 is a slide that sits atop another slide.
11262 Perhaps you wish to discuss a figure on the main
11266 before displaying the text associated with it.
11267 One way to accomplish this is tape a flap of dark paper over the part of the
11271 you want to display later.
11274 if you wish to overlap one graph with another,
11276 You would then have to fumble while speaking to align the two separate,
11281 s to align the two graphs.
11286 environment in both cases makes life much easier.
11289 \begin_layout Standard
11294 receives the page number of its
11295 \begin_inset Quotes eld
11299 \begin_inset Quotes erd
11308 \begin_inset Quotes eld
11316 \begin_inset Quotes erd
11323 \begin_layout Plain Layout
11330 \begin_inset Quotes eld
11338 \begin_inset Quotes erd
11343 \begin_inset Quotes eld
11351 \begin_inset Quotes erd
11356 \begin_inset Quotes eld
11364 \begin_inset Quotes erd
11369 \begin_inset space ~
11372 appended to the page number of the parent
11383 you want the contents of both the
11391 to each fit on a single physical slide!
11392 You should probably consider an
11397 \begin_inset Quotes eld
11401 \begin_inset Quotes erd
11410 the \SpecialChar LyX
11415 class provides a visual cue for this:
11416 the label at the start of an
11420 is shorter than that at the start of a
11426 when you generate printable output,
11427 you'll find alignment markers in all four corners of both the
11431 page and its parent
11436 These will assist you in lining up the two physical slides.
11439 \begin_layout Standard
11440 The major problem in overlaying two slides is aligning the contents of the two transparencies.
11441 How much space should you leave for that graph on the second slide?
11443 what if you want a graph and a sentence on second slide,
11444 but there is text on the main transparency that goes in between them?
11445 You could try and insert vertical space of the right size.
11446 The better way is to use
11457 \begin_layout Standard
11458 As their names imply,
11467 are two command-like paragraph environments that make all subsequent text invisible and visible,
11470 \begin_inset space ~
11474 \begin_inset CommandInset ref
11476 reference "sec:slideQuirk"
11481 that you don't place anything
11485 these two environments,
11492 it inserts a centered,
11493 sky-blue label into the page reading
11494 \begin_inset Quotes eld
11497 <Invisible Text Follows>
11498 \begin_inset Quotes erd
11502 For paragraphs following this label,
11512 it doesn't matter which] where they would be contain instead blank space.
11516 \begin_layout Standard
11522 the corresponding centered label is
11523 \begin_inset Quotes eld
11526 <Visible Text Follows>
11527 \begin_inset Quotes erd
11531 Paragraphs following this label behave normally.
11532 Note that the beginning of a new
11546 automatically shuts off an
11551 It's therefore not necessary to use
11562 \begin_layout Standard
11564 it should be obvious how to create overlay transparencies using the proper combination of
11583 \begin_layout Enumerate
11589 including everything that will appear on it,
11590 whether on the main slide or on the
11597 \begin_layout Enumerate
11598 Before each figure or paragraph that will appear only on the
11613 environment after the
11620 \begin_layout Enumerate
11625 immediately following the
11632 \begin_layout Enumerate
11633 Copy the contents of this
11644 \begin_layout Enumerate
11661 \begin_layout Standard
11663 You've just made an
11670 \begin_layout Standard
11671 There's one problem with the way I've designed the \SpecialChar LyX
11677 you can't make text in the middle of a paragraph invisible,
11678 nor make text in the middle of an invisible paragraph visible again.
11679 To accomplish this feat,
11680 you'll need to use some inlined \SpecialChar LaTeX
11685 \begin_layout Plain Layout
11686 The commands of interest are:
11690 \begin_layout Itemize
11695 invisible \SpecialChar ldots
11699 \begin_layout Itemize
11704 visible \SpecialChar ldots
11708 \begin_layout Plain Layout
11710 and need to be marked as \SpecialChar TeX
11713 \begin_inset Quotes eld
11717 \begin_inset Quotes erd
11720 you wish to change goes in between the brackets [and after the
11733 If you don't know how to mark text as \SpecialChar TeX
11735 see the appropriate section of the
11747 \begin_layout Paragraph
11757 \begin_inset CommandInset label
11759 name "sec:slideNote"
11766 \begin_layout Standard
11776 is associated with a
11777 \begin_inset Quotes eld
11781 \begin_inset Quotes erd
11791 the \SpecialChar LyX
11796 class provides visual cues.
11801 is shorter than that of a
11805 [yet longer than that of an
11810 like the label of an
11814 is shockingly magenta.
11820 has the page number of its
11821 \begin_inset Quotes eld
11825 \begin_inset Quotes erd
11834 \begin_inset Quotes eld
11842 \begin_inset Quotes erd
11847 \begin_inset Quotes eld
11855 \begin_inset Quotes erd
11860 \begin_inset Quotes eld
11868 \begin_inset Quotes erd
11873 You can have multiple
11877 s associated with a single
11892 you'll probably want to break up long
11896 s so that they fit on a single sheet of paper.
11899 \begin_layout Standard
11905 it contains anything additional you might want to say about a
11910 It could also be used as a sheet of reminders for a particular
11915 In the case of the latter,
11916 you might want to make use of time markers.
11918 the \SpecialChar LyX
11924 \begin_inset Quotes eld
11928 \begin_inset Quotes erd
11931 support for time markers,
11934 Sli\SpecialChar TeX
11939 you'll have to resort to using the \SpecialChar LaTeX
11943 \begin_layout Standard
11944 To use time markers,
11945 you'll need to specify the extra class option
11946 \begin_inset Quotes eld
11954 \begin_inset Quotes erd
11958 \begin_inset space ~
11962 \begin_inset CommandInset ref
11964 reference "sec:slidesetup"
11970 This option turns on timing marks,
11971 which will appear in the lower-left-hand corner of every
11976 To set what appears in the time marker,
11977 you use the \SpecialChar LaTeX
11979 \begin_inset Quotes eld
11989 \begin_inset Quotes erd
11993 \begin_inset Quotes eld
12003 \begin_inset Quotes erd
12007 The arguments of both commands are time measured in seconds.
12009 \begin_inset Quotes eld
12019 \begin_inset Quotes erd
12022 sets the time marker to a given time.
12024 \begin_inset Quotes eld
12034 \begin_inset Quotes erd
12037 increments the time marker by the specified amount.
12038 Using time markers and
12043 you can remind yourself how much time to spend on a particular
12050 \begin_layout Standard
12051 There's one last feature to describe.
12053 you'd like to print out all of your
12061 s on transparencies while printing all of your
12079 with which it is associated.
12080 What's a person to do?
12083 \begin_layout Standard
12085 there are two \SpecialChar LaTeX
12086 commands that allow you to select what to print out.
12087 Both must be placed into the preamble of your document.
12089 \begin_inset Quotes eld
12101 \begin_inset Quotes erd
12104 will cause the output to contain only the
12115 \begin_inset Quotes eld
12127 \begin_inset Quotes erd
12130 prevents the output of anything but
12135 I'd advise placing both commands in the preamble and initially comment both out.
12136 You can then preview your entire presentation as you write.
12137 When you're done writing,
12138 you can then uncomment one of the two to select what you want to print.
12139 I like to uncomment
12140 \begin_inset Quotes eld
12152 \begin_inset Quotes erd
12156 print to a file with
12157 \begin_inset Quotes eld
12165 \begin_inset Quotes erd
12169 comment it back out,
12171 \begin_inset Quotes eld
12183 \begin_inset Quotes erd
12187 \begin_inset Quotes eld
12195 \begin_inset Quotes erd
12199 I can then send either file to a printer,
12200 loading transparencies or plain paper as appropriate.
12203 \begin_layout Standard
12204 You can also provide other arguments to the
12205 \begin_inset Quotes eld
12215 \begin_inset Quotes erd
12219 \begin_inset Quotes eld
12229 \begin_inset Quotes erd
12233 See a good \SpecialChar LaTeX
12237 \begin_layout Subsubsection
12242 Class Template File
12245 \begin_layout Standard
12246 I have also provided a template file with the
12252 begin your new presentation with
12254 File\SpecialChar menuseparator
12256 \begin_inset space ~
12260 \begin_inset space ~
12263 Template\SpecialChar menuseparator
12264 Presentations\SpecialChar menuseparator
12268 Your new \SpecialChar LyX
12269 presentation file will contain an example
12290 additionally contain an example of the use of
12300 the preamble will contain:
12303 \begin_layout LyX-Code
12304 % Uncomment to print out only slides and overlays
12307 \begin_layout LyX-Code
12311 \begin_layout LyX-Code
12317 \begin_inset Newline newline
12323 \begin_layout LyX-Code
12324 % Uncomment to print out only notes
12327 \begin_layout LyX-Code
12331 \begin_layout LyX-Code
12339 \begin_layout Standard
12341 I created this class to support the \SpecialChar LaTeX2e
12343 \begin_inset Quotes eld
12348 Sli\SpecialChar TeX
12352 \begin_inset Quotes erd
12356 one of the built-in \SpecialChar LaTeX2e
12358 Neither I nor the rest of the \SpecialChar LyX
12359 Team endorse or oppose the use of this built-in slide class.
12360 It's here if you want it or need it.
12361 There exist other \SpecialChar LaTeX2e
12362 classes for creating presentations,
12368 \begin_inset space ~
12372 \begin_inset CommandInset ref
12374 reference "sec:foiltex"
12384 \begin_inset space ~
12388 \begin_inset CommandInset ref
12390 reference "subsec:Seminar"
12399 Try them out to see what sort of alternative they provide.
12402 \begin_layout Section
12406 \begin_layout Subsection
12410 \begin_layout Standard
12411 Report classes are sort of a hybrid between book and article classes:
12413 they provide parts,
12414 chapters and sections but does not provide frontmatter,
12417 like article classes,
12418 they provide abstract paragraph styles and are one-sided by default.
12420 they do not start a new chapter on the right hand page (even in two-side mode).
12423 \begin_layout Standard
12424 All externally maintained
12428 document classes that are officially supported by \SpecialChar LyX
12429 are described in the Collections (section
12430 \begin_inset space ~
12434 \begin_inset CommandInset ref
12436 reference "sec:Collections"
12444 \begin_layout Itemize
12447 Japanese Report (Standard Class,
12452 Japanese Report (Standard Class)
12456 \begin_inset space ~
12460 \begin_inset CommandInset ref
12462 reference "subsec:Japanese"
12470 \begin_layout Itemize
12477 \begin_inset space ~
12481 \begin_inset CommandInset ref
12483 reference "subsec:KOMA-Script"
12491 \begin_layout Itemize
12494 Report (Standard Class with Extra Font Sizes)
12498 \begin_inset space ~
12502 \begin_inset CommandInset ref
12504 reference "subsec:Extra-font-sizes"
12512 \begin_layout Itemize
12515 Polish Report (MW Bundle)
12519 \begin_inset space ~
12523 \begin_inset CommandInset ref
12525 reference "subsec:Polish-M.W.collection"
12536 \begin_layout Section
12540 \begin_layout Standard
12546 we assemble document classes that help to write drama or movie scripts.
12547 The category is also open for other scripts,
12548 such as lecture scripts,
12549 for which no classes are officially supported yet by \SpecialChar LyX
12553 \begin_layout Subsection
12557 \begin_layout Standard
12563 \begin_layout Subsubsection
12567 \begin_layout Standard
12572 is for writing plays.
12573 The format is more decorative than
12578 \begin_inset space ~
12582 \begin_inset CommandInset ref
12584 reference "subsec:Hollywood"
12589 and much less standardized.
12590 This format should be suitable for workshops.
12593 \begin_layout Subsubsection
12597 \begin_layout Standard
12603 \begin_inset space ~
12607 \begin_inset CommandInset ref
12609 reference "subsec:Special-problems-Hollywood"
12616 \begin_layout Subsubsection
12620 \begin_layout Standard
12625 names as labels then cross-reference the label to insert the name.
12626 The cross-reference dialog will show the current cast of characters.
12629 \begin_layout Subsubsection
12630 Paper size and Margins
12633 \begin_layout Standard
12641 \begin_layout Subsubsection
12645 \begin_layout Standard
12646 The following environments are available.
12651 to get the bind keys shown at the right.
12654 \begin_layout Itemize
12658 \begin_inset Newline newline
12663 You should not have to use this,
12664 but it is here for anything that does not fit otherwise.
12667 \begin_layout Itemize
12671 \begin_inset space \hfill{}
12675 \begin_inset Newline newline
12680 Used to describe stage setting and the action.
12681 First use of speaker names in all CAPs.
12684 \begin_layout Itemize
12688 \begin_inset space \hfill{}
12692 \begin_inset Newline newline
12697 Automatically numbered.
12698 On screen it will be arabic,
12699 but will print as Roman.
12702 \begin_layout Itemize
12706 \begin_inset space \hfill{}
12710 \begin_inset Newline newline
12720 It is just centered text.
12723 \begin_layout Itemize
12727 \begin_inset space \hfill{}
12731 \begin_inset Newline newline
12736 Not automatically numbered.
12737 You supply the number.
12738 This is because I couldn't figure out how.
12741 \begin_layout Itemize
12745 \begin_inset space \hfill{}
12749 \begin_inset Newline newline
12754 A special case of Narrative to describe the setting and action as the curtain rises.
12757 \begin_layout Itemize
12761 \begin_inset space \hfill{}
12765 \begin_inset Newline newline
12770 The speaker's (actor's) title,
12771 centered in all CAPS.
12774 \begin_layout Itemize
12778 \begin_inset space \hfill{}
12782 \begin_inset Newline newline
12787 Instructions to the speaker.
12788 The parentheses are automatically inserted.
12789 The ( will appear on screen,
12790 but both will be in the printed play.
12791 This environment is only used within
12798 \begin_layout Itemize
12802 \begin_inset space \hfill{}
12806 \begin_inset Newline newline
12811 What the Speaker says.
12814 \begin_layout Itemize
12818 \begin_inset space \hfill{}
12822 \begin_inset Newline newline
12827 The curtain comes down.
12830 \begin_layout Itemize
12834 \begin_inset space \hfill{}
12840 \begin_layout Itemize
12844 \begin_inset space \hfill{}
12850 \begin_layout Itemize
12854 \begin_inset space \hfill{}
12860 \begin_layout Standard
12864 \begin_layout Subsection
12865 \begin_inset CommandInset label
12867 name "subsec:Hollywood"
12871 Hollywood (Hollywood spec scripts)
12874 \begin_layout Standard
12880 \begin_layout Subsubsection
12884 \begin_layout Standard
12885 Getting the format of a Hollywood script right is a
12886 \begin_inset Quotes eld
12890 \begin_inset Quotes erd
12893 It is designed to make the readers focus on content and to be easy and familiar for the actors to read.
12894 Each page of a script should be one minute of film.
12895 Nothing goes in a script that you cannot see or hear on screen.
12896 The courier 12 pt font should be used throughout.
12900 \begin_layout Subsubsection
12901 \begin_inset CommandInset label
12903 name "subsec:Special-problems-Hollywood"
12910 \begin_layout Standard
12911 Speakers' lines should
12915 break in mid-sentence.
12916 If a speaker's lines continue over a page break,
12921 title followed by (Cont'd).
12924 \begin_layout Subsubsection
12928 \begin_layout Standard
12933 names as labels then cross-reference the label to insert the name.
12934 The cross-reference dialog will show the current cast of characters.
12935 You can use this to insert the speaker name in narratives also.
12938 \begin_layout Subsubsection
12939 Paper size and Margins
12942 \begin_layout Standard
12950 \begin_layout Subsubsection
12954 \begin_layout Standard
12955 The following environments are available.
12960 to get the bind keys shown at the right.
12963 \begin_layout Itemize
12967 \begin_inset Newline newline
12972 Used where nothing else works.
12976 \begin_layout Itemize
12982 \begin_inset space \hfill{}
12990 \begin_inset Newline newline
12993 Usually followed by something like
12994 \begin_inset Quotes eld
12997 on Sally waking up.
12998 \begin_inset Quotes erd
13004 \begin_layout Itemize
13008 \begin_inset space \hfill{}
13012 \begin_inset Newline newline
13017 Introduces a new INTERIOR camera set-up.
13018 Always followed by DAY or NIGHT,
13019 or something similar to define the lighting required.
13020 Everthing on this line in CAPS.
13023 \begin_layout Itemize
13027 \begin_inset space \hfill{}
13031 \begin_inset Newline newline
13036 Introduces a new EXTERIOR camera set-up.
13037 Everthing on this line in CAPS.
13040 \begin_layout Itemize
13044 \begin_inset space \hfill{}
13048 \begin_inset Newline newline
13053 The character speaking.
13056 \begin_layout Itemize
13060 \begin_inset space \hfill{}
13064 \begin_inset Newline newline
13069 Instructions to the speaker.
13070 The () are automatically inserted.
13073 \begin_layout Itemize
13077 \begin_inset space \hfill{}
13081 \begin_inset Newline newline
13093 \begin_layout Itemize
13097 \begin_inset space \hfill{}
13101 \begin_inset Newline newline
13106 Camera movement instruction.
13108 \begin_inset space \thinspace{}
13112 \begin_inset space \space{}
13118 \begin_layout Itemize
13122 \begin_inset space \hfill{}
13128 \begin_layout Itemize
13132 \begin_inset space \hfill{}
13138 \begin_layout Itemize
13142 \begin_inset space \hfill{}
13148 \begin_layout Itemize
13152 \begin_inset space \hfill{}
13158 \begin_layout Subsubsection
13162 \begin_layout Itemize
13167 \begin_layout Itemize
13172 \begin_layout Itemize
13174 \begin_inset space \thinspace{}
13182 \begin_layout Itemize
13188 \begin_layout Itemize
13193 \begin_layout Itemize
13198 \begin_layout Chapter
13202 \begin_layout Section
13203 Academic Field Specifics
13206 \begin_layout Subsection
13208 Hazard and Precautionary Statements
13211 \begin_layout Standard
13212 This module provides two insets and a paragraph style to typeset numbers and phrases of chemical hazard and precautionary statements.
13213 For a description see
13215 File\SpecialChar menuseparator
13216 Open Example\SpecialChar menuseparator
13217 Modules\SpecialChar menuseparator
13218 Hazard and Precautionary Statements
13222 Help\SpecialChar menuseparator
13223 Specific Manuals\SpecialChar menuseparator
13224 Hazard and Precautionary Statements
13229 \begin_layout Subsection
13233 Risk and Safety Statements
13236 \begin_layout Standard
13237 This module provides two insets,
13247 accessible via the menu
13252 nsert\SpecialChar menuseparator
13254 \begin_inset space ~
13259 and an environment to typeset numbers and phrases of chemical risk and safety statements.
13262 \begin_layout Subsection
13266 \begin_layout Standard
13267 This module provides specific environments useful for linguistics (numbered examples,
13270 OT tableau floats).
13271 You can obtain information about this module in
13276 elp\SpecialChar menuseparator
13282 \begin_inset space ~
13285 Manuals\SpecialChar menuseparator
13294 File\SpecialChar menuseparator
13295 Open Example\SpecialChar menuseparator
13296 Modules\SpecialChar menuseparator
13302 \begin_layout Section
13306 \begin_layout Subsection
13310 \begin_layout Standard
13311 This module supports the Braille script.
13312 It requires the \SpecialChar LaTeX
13318 This and its documentation can be obtained from
13319 \begin_inset CommandInset href
13322 target "https://www.ctan.org/pkg/braille"
13333 elp\SpecialChar menuseparator
13339 \begin_inset space ~
13342 Manuals\SpecialChar menuseparator
13351 File\SpecialChar menuseparator
13352 Open Example\SpecialChar menuseparator
13353 Modules\SpecialChar menuseparator
13359 \begin_layout Section
13360 Annotation & Revision
13363 \begin_layout Subsection
13367 \begin_layout Standard
13368 This module provides “FiXme” (marginal) annotations for document revision purposes.
13369 A list of annotations can be produced by using the “List of FIXMEs” paragraph style.
13370 The annotations are customizable via the LaTeX preamble.
13375 documentation which can be obtained from
13376 \begin_inset CommandInset href
13379 target "http://mirrors.ctan.org/macros/latex/contrib/fixme/fixme.pdf"
13387 \begin_layout Paragraph
13391 \begin_layout Standard
13393 the notes are only displayed in “draft” mode (if the option “draft” has been inserted in
13395 Document\SpecialChar menuseparator
13396 Settings\SpecialChar menuseparator
13397 Document Class\SpecialChar menuseparator
13398 Class Options\SpecialChar menuseparator
13402 To display them always,
13411 Document\SpecialChar menuseparator
13412 Settings\SpecialChar menuseparator
13419 \begin_layout Subsection
13423 \begin_layout Standard
13424 This module provides various kinds of annotations for PDF output.
13427 Help\SpecialChar menuseparator
13428 Specific Manuals\SpecialChar menuseparator
13433 File\SpecialChar menuseparator
13434 Open Example\SpecialChar menuseparator
13435 Modules\SpecialChar menuseparator
13441 \begin_layout Subsection
13447 \begin_layout Standard
13448 This module provides fields and buttons for PDF forms.
13450 \begin_inset CommandInset href
13452 name "hyperref documentation"
13453 target "http://mirrors.ctan.org/macros/latex/contrib/hyperref/doc/hyperref-doc.pdf"
13461 Help\SpecialChar menuseparator
13462 Specific Manuals\SpecialChar menuseparator
13467 File\SpecialChar menuseparator
13468 Open Example\SpecialChar menuseparator
13469 Modules\SpecialChar menuseparator
13475 \begin_layout Subsection
13481 \begin_layout Standard
13482 This module defines an inset to typeset reading aids (ruby,
13483 furigana) to Chinese characters.
13497 package (depending on the TeX engine) or a fallback definition.
13500 \begin_layout Subsection
13506 \begin_layout Standard
13507 This module provides custom insets to insert TODO items in your document.
13508 In order to generate a “List of TODOs,” the module provides a paragraph style.
13515 Document\SpecialChar menuseparator
13516 Settings\SpecialChar menuseparator
13517 Document Class\SpecialChar menuseparator
13518 Class Options\SpecialChar menuseparator
13521 ) suppresses the output of TODO notes.
13523 \begin_inset CommandInset href
13525 name "todonotes documentation"
13526 target "http://mirrors.ctan.org/macros/latex/contrib/todonotes/todonotes.pdf"
13534 \begin_layout Section
13538 \begin_layout Subsection
13539 APA Style with Natbib
13542 \begin_layout Standard
13543 This module adds support for using natbib together with apacite (the bibliography style need not be
13558 or any bibliography that works with both the natbib and apacite packages.)
13561 \begin_layout Section
13565 \begin_layout Subsection
13566 Fancy Colored Boxes
13569 \begin_layout Standard
13570 This module adds ten custom insets that support colored boxes via the
13577 Help\SpecialChar menuseparator
13578 Specific Manuals\SpecialChar menuseparator
13584 File\SpecialChar menuseparator
13585 Open Example\SpecialChar menuseparator
13586 Modules\SpecialChar menuseparator
13590 \begin_inset CommandInset href
13592 name "tcolorbox documentation"
13593 target "http://mirrors.ctan.org/macros/latex/contrib/tcolorbox/tcolorbox.pdf"
13601 \begin_layout Subsection
13605 \begin_layout Standard
13606 This provides the custom insets
13624 to scale and rotate its content.
13627 \begin_layout Standard
13632 is a simple way of reversing text without any other enhancement:
13635 \begin_layout Standard
13636 \begin_inset Flex Reflectbox
13639 \begin_layout Plain Layout
13640 Great Western Railway
13648 \begin_layout Standard
13649 (You will need to use Ctrl-R to see any of these examples.)
13652 \begin_layout Standard
13657 allows you to specify the dimensions of the text or image;
13658 permissible units are em,
13680 it scales by the width factor:
13683 \begin_layout Standard
13684 \begin_inset Flex Resizebox
13687 \begin_layout Plain Layout
13688 \begin_inset Argument 1
13691 \begin_layout Plain Layout
13698 \begin_inset Argument 2
13701 \begin_layout Plain Layout
13707 Great Western Railway
13715 \begin_layout Standard
13720 allows you to rotate its contents around the reference point of the box.
13721 If you wish to rotate the box around a different origin,
13722 place the cursor inside the box and select Insert\SpecialChar menuseparator
13752 or meaningful combinations of these and the counterclockwise rotation angle is expressed in degrees.
13756 \begin_layout Standard
13757 \begin_inset Flex Rotatebox
13760 \begin_layout Plain Layout
13761 \begin_inset Argument 1
13764 \begin_layout Plain Layout
13771 \begin_inset Argument 2
13774 \begin_layout Plain Layout
13780 Great Western Railway
13788 \begin_layout Standard
13789 You can combine boxes as in:
13792 \begin_layout Standard
13793 \begin_inset Flex Rotatebox
13796 \begin_layout Plain Layout
13797 \begin_inset Argument 1
13800 \begin_layout Plain Layout
13807 \begin_inset Argument 2
13810 \begin_layout Plain Layout
13817 \begin_inset Flex Resizebox
13820 \begin_layout Plain Layout
13821 \begin_inset Argument 1
13824 \begin_layout Plain Layout
13831 \begin_inset Argument 2
13834 \begin_layout Plain Layout
13841 \begin_inset Flex Reflectbox
13844 \begin_layout Plain Layout
13845 Great Western Railway
13863 \begin_layout Standard
13868 scales its contents;
13869 select Insert\SpecialChar menuseparator
13870 V-Factor to add a vertical factor.
13871 If the vertical factor is omitted,
13872 the horizontal is used.
13873 Adding different horizontal and vertical values creates distortion as in
13876 \begin_layout Standard
13879 \begin_inset Flex Scalebox
13882 \begin_layout Plain Layout
13883 \begin_inset Argument 1
13886 \begin_layout Plain Layout
13893 \begin_inset Argument 2
13896 \begin_layout Plain Layout
13904 Great Western Railway
13912 \begin_layout Standard
13913 A negative horizontal value reverses the text on the horizontal axis,
13914 a negative vertical value on the vertical axis,
13918 \begin_layout Standard
13919 \begin_inset Flex Scalebox
13922 \begin_layout Plain Layout
13923 \begin_inset Argument 1
13926 \begin_layout Plain Layout
13933 \begin_inset Argument 2
13936 \begin_layout Plain Layout
13942 Great Western Railway
13948 \begin_inset Flex Scalebox
13951 \begin_layout Plain Layout
13952 \begin_inset Argument 1
13955 \begin_layout Plain Layout
13962 \begin_inset Argument 2
13965 \begin_layout Plain Layout
13971 Great Western Railway
13979 \begin_layout Subsection
13983 \begin_layout Standard
13984 This module defines Boxes with section header.
13985 It is mainly intended for the SciPoster Document class.
13988 \begin_layout Subsection
13989 Variable-width Minipages
13992 \begin_layout Standard
13996 \begin_inset space \thinspace{}
14003 Insert\SpecialChar menuseparator
14015 package provides a variable-width minipage,
14016 whose resulting width is the width of its contents (if this does not exceed the specified maximum width).
14017 The inset has two optional arguments which can be added by placing the cursor inside the minipage and entering
14019 Insert\SpecialChar menuseparator
14021 \begin_inset space \thinspace{}
14032 Insert\SpecialChar menuseparator
14034 \begin_inset space \thinspace{}
14048 File\SpecialChar menuseparator
14049 Open Example\SpecialChar menuseparator
14050 Variable-width Minipages
14055 \begin_layout Section
14059 \begin_layout Subsection
14060 Fix Computer Modern Fonts
14063 \begin_layout Standard
14064 This module uses the
14068 package to improve the appearance of Computer Modern fonts and make them available with arbitrary sizes.
14070 \begin_inset CommandInset href
14072 name "fix-cm documentation"
14073 target "http://mirrors.ctan.org/macros/latex/base/fix-cm.pdf"
14081 \begin_layout Subsection
14083 Kernel Fixes (Obsolete)
14086 \begin_layout Standard
14087 This module loads the \SpecialChar LaTeX
14092 which contains some bug fixes for \SpecialChar LaTeX
14094 If you use this module your typeset document may look different when you process it,
14095 depending on the respective version of
14102 \begin_layout Paragraph
14106 \begin_layout Standard
14107 recent \SpecialChar LaTeX
14108 kernels (as of 2015/01/01) include the functionality of
14117 module is obsolete with newer \SpecialChar LaTeX
14121 \begin_layout Subsection
14122 Minimalistic Insets
14125 \begin_layout Standard
14126 This module redefines several insets (Index,
14128 URL) as being Minimalistic.
14131 \begin_layout Subsection
14132 Title and Preamble Hacks
14135 \begin_layout Standard
14136 This module provides two new paragraph styles:
14139 \begin_layout Enumerate
14144 which puts whatever is entered into it into the preamble.
14147 to include preamble code in the body of a LyX document.
14150 \begin_layout Enumerate
14155 which that will put its contents into the body of the LaTeX document,
14163 This is useful for making branches and notes in title-related material.
14165 if you put these in a
14170 this signals to LyX to output
14177 which may then come too early.)
14180 \begin_layout Section
14184 \begin_layout Subsection
14188 \begin_layout Standard
14189 This module uses the
14193 package for algorithm floats rather than LyX’s home-brewed algorithm floats.
14194 Use the Algorithm paragraph style to enter and indent the algorithm.
14196 \begin_inset CommandInset href
14198 name "algorithm2e documentation"
14199 target "http://mirrors.ctan.org/macros/latex/contrib/algorithm2e/doc/algorithm2e.pdf"
14207 \begin_layout Subsection
14208 Bilingual Captions AKA Multilingual Captions
14211 \begin_layout Standard
14212 This module provides the paragraph style
14215 \begin_inset space ~
14220 with which to typeset bilingual captions.
14221 Within this paragraph style
14223 Insert\SpecialChar menuseparator
14226 allows you to enter the desired second language using one of the babel names.
14229 File\SpecialChar menuseparator
14230 Open Example\SpecialChar menuseparator
14231 Modules\SpecialChar menuseparator
14232 Multilingual Captions
14236 Help\SpecialChar menuseparator
14237 Specific Manuals\SpecialChar menuseparator
14238 Multilingual Captions
14240 further information on its use.
14243 \begin_layout Subsection
14244 Number Figures by Section
14247 \begin_layout Standard
14248 This module resets the figure number at section start and prepends the section number to the figure number,
14249 as in “Figure 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
14252 \begin_layout Subsection
14253 Number Tables by Section
14256 \begin_layout Standard
14257 This module resets the table number at section start and prepends the section number to the table number,
14258 as in “Table 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
14261 \begin_layout Section
14265 \begin_layout Subsection
14269 \begin_layout Standard
14270 This module adds an endnote inset,
14271 in addition to footnotes.
14277 which has some limitations but works with older \SpecialChar LaTeX
14278 distributions as well.
14281 Insert\SpecialChar menuseparator
14282 Custom Inset\SpecialChar menuseparator
14285 to insert an endnote and
14287 Insert\SpecialChar menuseparator
14288 List/Contents/References\SpecialChar menuseparator
14291 to insert the endnotes list where you want the endnotes to appear.
14294 Help\SpecialChar menuseparator
14305 \begin_layout Subsection
14306 Endnotes (Extended)
14309 \begin_layout Standard
14310 This module adds an endnote inset,
14311 in addition to footnotes.
14316 package which is more powerful and customizable than the
14321 but requires a fairly modern \SpecialChar LaTeX
14322 distribution (with \SpecialChar LaTeX
14326 Insert\SpecialChar menuseparator
14327 Custom Inset\SpecialChar menuseparator
14330 to insert an endnote and
14332 Insert\SpecialChar menuseparator
14333 List/Contents/References\SpecialChar menuseparator
14336 to insert the endnotes list where you want the endnotes to appear.
14339 Help\SpecialChar menuseparator
14350 \begin_layout Subsection
14351 Footnotes as Endnotes (Basic)
14354 \begin_layout Standard
14355 This module sets all footnotes as endnotes.
14361 which has some limitations but works with older \SpecialChar LaTeX
14362 distributions as well.
14365 Insert\SpecialChar menuseparator
14366 List/Contents/References\SpecialChar menuseparator
14369 to insert the endnotes list where you want the endnotes to appear.
14372 Help\SpecialChar menuseparator
14383 \begin_layout Subsection
14384 Footnotes as Endnotes (Extended)
14387 \begin_layout Standard
14388 This module sets all footnotes as endnotes.
14393 package which is more powerful and customizable than then
14398 but requires a fairly modern \SpecialChar LaTeX
14399 distribution (with \SpecialChar LaTeX
14403 Insert\SpecialChar menuseparator
14404 List/Contents/References\SpecialChar menuseparator
14407 to insert the endnotes list where you want the endnotes to appear.
14410 Help\SpecialChar menuseparator
14421 \begin_layout Section
14426 \begin_layout Subsection
14430 \begin_layout Standard
14431 This module provides support for the
14435 package to print chess games.
14438 File\SpecialChar menuseparator
14439 Open Example\SpecialChar menuseparator
14440 Articles\SpecialChar menuseparator
14443 where you will find
14452 \begin_inset CommandInset href
14454 name "chessboard documentation"
14455 target "http://mirrors.ctan.org/macros/latex/contrib/chessboard/chessboard.pdf"
14463 \begin_layout Subsection
14464 Lilypond Music Notation
14467 \begin_layout Standard
14468 This module provides an inset via
14473 nsert\SpecialChar menuseparator
14474 Custom Inset\SpecialChar menuseparator
14477 in which to enter code for the LilyPond music editor.
14478 It will then be processed in the output.
14481 Help\SpecialChar menuseparator
14482 Specific Manuals\SpecialChar menuseparator
14487 File\SpecialChar menuseparator
14488 Open Example\SpecialChar menuseparator
14489 Modules\SpecialChar menuseparator
14493 It cannot be used if the modules
14496 \begin_inset space \thinspace{}
14508 \begin_layout Section
14512 \begin_layout Subsection
14514 \begin_inset CommandInset label
14516 name "subsec:Customizable-Lists"
14523 \begin_layout Standard
14524 This module uses the
14528 package to enable the customization of various list environments.
14531 \begin_layout Subsubsection
14532 Custom Enumerate Lists
14535 \begin_layout Standard
14537 The default numbering of numbered lists can be changed by adding an optional argument (menu
14542 nsert\SpecialChar menuseparator
14549 ) to the first item of each level in the list.
14550 There you add the command
14553 \begin_layout Standard
14561 \begin_layout Standard
14562 in \SpecialChar TeX
14572 \begin_layout Standard
14577 is the first level counter of the enumeration.
14578 To change the numbering for the list sublevels,
14583 ” in the command by the small Roman numeral of the level (
14605 \begin_layout Standard
14612 outputs the counter as a small Roman numeral.
14613 For capital Roman numerals replace
14625 in the command above.
14626 For Arabic numerals use
14634 \begin_inset Quotes eld
14638 \begin_inset Quotes erd
14641 items with capital or small Latin letters use
14657 \begin_layout Standard
14659 \begin_inset Note Greyedout
14662 \begin_layout Plain Layout
14668 You can only number 26
14669 \begin_inset space ~
14672 items with Latin letters,
14673 because this numbering is limited to single letters.
14681 \begin_layout Standard
14682 Here is a list with custom numbering:
14685 \begin_layout Enumerate
14686 \begin_inset Argument 1
14689 \begin_layout Plain Layout
14693 \begin_layout Plain Layout
14712 \begin_inset Separator latexpar
14719 \begin_layout Enumerate
14720 \begin_inset Argument 1
14723 \begin_layout Plain Layout
14727 \begin_layout Plain Layout
14746 \begin_layout Enumerate
14748 \begin_inset Separator latexpar
14755 \begin_layout Enumerate
14756 \begin_inset Argument 1
14759 \begin_layout Plain Layout
14763 \begin_layout Plain Layout
14780 \begin_inset Separator latexpar
14787 \begin_layout Enumerate
14788 \begin_inset Argument 1
14791 \begin_layout Plain Layout
14795 \begin_layout Plain Layout
14817 \begin_layout Standard
14818 For this list these commands were used:
14821 \begin_layout Standard
14832 \begin_inset Newline newline
14840 \begin_inset Newline newline
14848 \begin_inset Newline newline
14858 \begin_layout Standard
14865 makes the label emphasized and
14874 \begin_layout Standard
14875 \begin_inset Note Greyedout
14878 \begin_layout Plain Layout
14884 When you change the label of a list level,
14885 it will be used for all following lists until you change the definition.
14893 \begin_layout Standard
14897 \begin_layout Plain Layout
14915 \begin_layout Subsubsection
14916 Numbered Paragraphs in Reports
14919 \begin_layout Enumerate
14920 Official reports often include numbered paragraphs;
14921 you can achieve this with a variation on the approach outlined in section
14922 \begin_inset space ~
14926 \begin_inset CommandInset ref
14928 reference "sec:How-to-use"
14937 in each command with
14944 \begin_layout Enumerate
14945 These numbered paragraphs were generated by inserting the \SpecialChar TeX
14947 \begin_inset Separator latexpar
14954 \begin_layout Standard
14968 \begin_layout Standard
14969 before the start of the section;
14976 uses the \SpecialChar LaTeX
14977 section counter to generate the first part of the number.
14981 \begin_layout Enumerate
14982 I have ignored the subsection heading in this example because,
14983 with paragraphs numbered in this way,
14984 subsections are less likely to be used.
14987 \begin_layout Subsubsection
14988 Resumed Enumeration
14991 \begin_layout Standard
14995 \begin_layout Plain Layout
15011 \begin_layout Standard
15012 Enumerations can be resumed after intermediate paragraphs:
15015 \begin_layout Enumerate
15016 \begin_inset Argument 1
15019 \begin_layout Plain Layout
15023 \begin_layout Plain Layout
15038 \begin_inset Note Note
15041 \begin_layout Plain Layout
15042 goes back to default numbering
15050 \begin_layout Enumerate
15054 \begin_layout Standard
15058 \begin_layout Enumerate-Resume
15062 \begin_layout Standard
15063 To resume an enumeration,
15071 \begin_layout Standard
15072 \begin_inset Note Greyedout
15075 \begin_layout Plain Layout
15081 If there is no previous enumeration to resume,
15082 you will get a \SpecialChar LaTeX
15091 \begin_layout Standard
15092 Perhaps you might want to resume the list with a different number from the next one.
15093 Or you want to start a new enumeration with a defined number.
15094 This is possible by adding an optional argument to the first list item of a normal enumeration.
15099 \begin_layout Standard
15105 \begin_layout Standard
15110 is the number with which you want to resume the list.
15114 \begin_layout Enumerate
15118 \begin_layout Enumerate
15122 \begin_layout Standard
15123 Enumeration starting at a given value:
15126 \begin_layout Enumerate
15127 \begin_inset Argument 1
15130 \begin_layout Plain Layout
15134 \begin_layout Plain Layout
15146 This enumeration starts at 4
15149 \begin_layout Subsubsection
15151 \begin_inset Index idx
15156 \begin_layout Plain Layout
15166 \begin_layout Standard
15167 In some cases you might want less or more vertical space between the items of a list.
15168 For example if the default space is too much in your opinion in this case:
15171 \begin_layout Itemize
15175 \begin_layout Itemize
15176 with standard spacing
15179 \begin_layout Standard
15180 You can decrease the space by adding an optional argument to the first item of the list.
15181 Add there the command
15185 to get no additional list space like in this example:
15188 \begin_layout Itemize
15189 \begin_inset Argument 1
15192 \begin_layout Plain Layout
15196 \begin_layout Plain Layout
15211 \begin_layout Itemize
15215 \begin_layout Itemize
15219 \begin_layout Standard
15220 To add space you can use several other commands provided by the
15225 \begin_inset Index idx
15230 \begin_layout Plain Layout
15239 For more information see the
15240 \begin_inset CommandInset href
15242 name "enumitem documentation"
15243 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
15251 \begin_layout Standard
15252 There are also many commands available to change the horizontal spacing and indentation.
15253 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
15254 \begin_inset space \thinspace{}
15257 cm so that the number is in the page margin:
15260 \begin_layout Enumerate
15261 \begin_inset Argument 1
15264 \begin_layout Plain Layout
15268 \begin_layout Plain Layout
15286 \begin_layout Enumerate
15287 with negative indentation
15290 \begin_layout Subsubsection
15291 Further Customization
15292 \begin_inset Index idx
15297 \begin_layout Plain Layout
15307 \begin_layout Standard
15308 You can also change the style of description lists.
15312 \begin_layout Standard
15318 \begin_layout Standard
15319 changes the description label font,
15323 \begin_layout Standard
15332 \begin_layout Standard
15333 sets the list style.
15336 \begin_layout Standard
15337 An example where the command
15340 \begin_layout Standard
15349 \begin_layout Standard
15353 \begin_layout Description
15355 \begin_inset space ~
15360 \begin_inset Argument 1
15363 \begin_layout Plain Layout
15367 \begin_layout Plain Layout
15384 Ionizing radiation consists of particles or electromagnetic waves that are energetic enough to detach electrons from atoms or molecules,
15385 therefore ionizing them.
15388 \begin_layout Description
15390 \begin_inset space ~
15394 In computer science,
15395 reference counting is a technique of storing the number of references,
15397 or handles to a resource such as an object,
15399 disk space or other resource.
15402 \begin_layout Standard
15403 There are many more commands and features provided by the
15408 \begin_inset Index idx
15413 \begin_layout Plain Layout
15422 For more information see the
15423 \begin_inset CommandInset href
15425 name "enumitem documentation"
15426 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
15434 \begin_layout Subsection
15440 \begin_layout Standard
15441 This module uses the package
15445 to provide nine new list environments.
15446 Itemized and enumerated lists can be typeset within paragraphs,
15447 as paragraphs and in a compact version.
15448 Most environments have optional arguments to format the labels.
15450 the \SpecialChar LaTeX
15451 list environments itemize and enumerate are extended to use a similar optional argument.
15452 For further details see
15454 File\SpecialChar menuseparator
15455 Open Example\SpecialChar menuseparator
15456 Modules\SpecialChar menuseparator
15457 Paragraph Lists (paralist)
15462 Help\SpecialChar menuseparator
15463 Specific Manuals\SpecialChar menuseparator
15467 \begin_inset CommandInset href
15469 name "paralist documentation"
15470 target "http://mirrors.ctan.org/macros/latex/contrib/paralist/paralist.pdf"
15478 \begin_layout Section
15479 Literate Programming
15482 \begin_layout Subsection
15486 \begin_layout Standard
15487 This module allows the use of Noweb as a literate programming tool.
15488 The files and the documentation for Noweb can be obtained from
15489 \begin_inset CommandInset href
15492 target "https://www.ctan.org/pkg/noweb"
15498 Literate programming is described in section
15499 \begin_inset space ~
15503 \begin_inset CommandInset ref
15505 reference "sec:Literate-Programming"
15510 and there are three example files:
15513 File\SpecialChar menuseparator
15514 Open Example\SpecialChar menuseparator
15515 Modules\SpecialChar menuseparator
15521 File\SpecialChar menuseparator
15522 Open Example\SpecialChar menuseparator
15523 Modules\SpecialChar menuseparator
15528 File\SpecialChar menuseparator
15529 Open Example\SpecialChar menuseparator
15530 Modules\SpecialChar menuseparator
15531 Noweb2\SpecialChar LyX
15537 \begin_layout Subsection
15541 \begin_layout Standard
15542 This module uses the
15552 \begin_inset Flex Code
15555 \begin_layout Plain Layout
15561 package in R for dynamic report generation has to be installed for this module to work:
15563 \begin_inset Flex Code
15566 \begin_layout Plain Layout
15567 install.packages(“knitr”)
15575 \begin_layout Paragraph
15579 \begin_layout Itemize
15580 it depends on R >= 2.14.1.
15582 \begin_inset Flex URL
15585 \begin_layout Plain Layout
15587 http://yihui.name/knitr
15595 \begin_layout Itemize
15600 also has to be installed.
15603 \begin_layout Itemize
15604 It cannot be used if the modules
15607 \begin_inset space ~
15619 \begin_layout Standard
15622 Help\SpecialChar menuseparator
15623 Specific Manuals\SpecialChar menuseparator
15629 File\SpecialChar menuseparator
15630 Open Example\SpecialChar menuseparator
15631 Modules\SpecialChar menuseparator
15635 \begin_inset space ~
15639 \begin_inset CommandInset ref
15641 reference "sec:Literate-Programming"
15646 for information about literate programming.
15649 \begin_layout Subsection
15653 \begin_layout Standard
15654 This module allows the use of the statistical language S/R as a literate programming tool.
15665 \begin_inset CommandInset href
15668 target "https://www.ctan.org/pkg/includernw"
15674 \begin_inset CommandInset href
15677 target "https://www.ctan.org/pkg/fancyvrb"
15682 are available from CTAN.
15683 It cannot be used if the module
15686 \begin_inset space ~
15694 Help\SpecialChar menuseparator
15695 Specific Manuals\SpecialChar menuseparator
15701 File\SpecialChar menuseparator
15702 Open Example\SpecialChar menuseparator
15703 Modules\SpecialChar menuseparator
15707 \begin_inset space ~
15711 \begin_inset CommandInset ref
15713 reference "sec:Literate-Programming"
15718 for information about literate programming.
15721 \begin_layout Section
15725 \begin_layout Subsection
15729 \begin_layout Standard
15730 This modules defines theorem environments and the proof environment using the extended AMS machinery.
15731 Both numbered and unnumbered types are provided.
15733 the theorems are numbered consecutively throughout the document.
15734 This can be changed by loading one of the
15736 AMS Theorems (Numbered by \SpecialChar ldots
15740 It cannot be used if the modules
15746 Standard Theorems (Unnumbered)
15751 \begin_layout Subsection
15752 AMS Theorems (Extended)
15755 \begin_layout Standard
15756 This module defines some additional theorem environments for use with the
15760 package (which must be loaded).
15819 in both numbered and unnumbered forms.
15822 \begin_layout Subsection
15823 AMS Theorems (Extended,
15824 Numbered by Type within Chapters)
15827 \begin_layout Standard
15828 This module defines some additional theorem environments for use with the
15830 AMS Theorems (Numbered by Type within Chapters)
15832 module (which must be loaded).
15881 in both numbered and unnumbered forms.
15884 \begin_layout Standard
15887 AMS Theorems (Extended)
15890 the different theorem types provided here each have a separate counter,
15891 restarted with each new chapter (e.g.,
15953 \begin_layout Subsection
15954 AMS Theorems (Extended,
15958 \begin_layout Standard
15959 This module defines some additional theorem environments for use with the
15961 AMS Theorems (Numbered by Type)
15963 package (which must be loaded).
16012 in both numbered and unnumbered forms.
16015 \begin_layout Standard
16018 AMS Theorems (Extended)
16021 the different theorem types provided here each have a separate counter (e.g.,
16073 \begin_layout Subsection
16074 AMS Theorems (Numbered by Type within Chapters)
16077 \begin_layout Standard
16078 This module defines theorem environments and the proof environment using the extended AMS machinery.
16079 Both numbered and unnumbered types are provided.
16082 \begin_layout Standard
16088 the different theorem types provided here each have a separate counter (e.g.,
16143 The numbering restarts for each chapter:
16158 \begin_layout Standard
16159 It cannot be used if the modules
16171 Standard Theorems (Numbered by Type)
16175 Standard Theorems (Unnumbered)
16180 \begin_layout Subsection
16181 AMS Theorems (Numbered by Type)
16184 \begin_layout Standard
16185 This module defines theorem environments and the proof environment using the extended AMS machinery.
16186 Both numbered and unnumbered types are provided.
16192 the different theorem types provided here each have a separate counter (e.g.,
16247 The numbering’s scope is the whole document.
16248 For chapter- and section-wide numbering,
16249 use one of the ‘within Sections’/‘within Chapters’ modules,
16253 \begin_layout Standard
16254 It cannot be used if the modules
16266 Standard Theorems (Numbered by Type)
16270 Standard Theorems (Unnumbered)
16275 \begin_layout Subsection
16276 Number Equations by Section
16279 \begin_layout Standard
16280 This module resets the equation number at section start and prepends the section number to the equation number,
16288 \begin_layout Subsection
16292 \begin_layout Standard
16293 This module defines some theorem environments for use with non-AMS classes.
16295 the theorems are numbered consecutively throughout the document.
16296 This can be changed by loading one of the
16298 Standard Theorems (Numbered by \SpecialChar ldots
16304 \begin_layout Standard
16305 It cannot be used if the modules
16311 Standard Theorems (Unnumbered)
16316 \begin_layout Subsection
16317 Standard Theorems (Nameable)
16320 \begin_layout Standard
16321 This module facilitates the use of named theorems.
16322 The name of the theorem can be inserted via
16324 Insert\SpecialChar menuseparator
16325 Additional Theorem Text
16330 \begin_layout Subsection
16331 Standard Theorems (Numbered by Chapter)
16334 \begin_layout Standard
16335 This module numbers theorems and the like by chapter (i.e.,
16336 the counter is reset at each chapter start).
16337 Use this module only with document classes that provide a chapter environment.
16340 \begin_layout Standard
16352 \begin_layout Standard
16353 It cannot be used if the module
16355 Standard Theorems (Numbered by Section)
16360 \begin_layout Subsection
16361 Standard Theorems (Numbered by Section)
16364 \begin_layout Standard
16365 This module numbers theorems and the like by section (i.e.,
16366 the counter is reset at each section start).
16376 It cannot be used if the module
16378 Standard Theorems (Numbered by Chapter)
16383 \begin_layout Subsection
16384 Standard Theorems (Numbered by Type within Chapters)
16387 \begin_layout Standard
16388 This module defines some theorem environments for use with non-AMS classes.
16398 the different theorem types provided here each have a separate counter (e.g.,
16453 The numbering is reset at each chapter start.
16456 \begin_layout Standard
16459 AMS Theorems (Numbered by Type)
16463 Standard Theorems (Numbered by Type)
16468 \begin_layout Standard
16469 It cannot be used if any of the modules
16481 Standard Theorems (Unnumbered)
16486 Standard Theorems (Numbered by Sections)
16490 Standard Theorems (Numbered by Type within Sections)
16495 \begin_layout Subsection
16496 Standard Theorems (Numbered by Type within Sections)
16499 \begin_layout Standard
16500 This module defines some theorem environments for use with non-AMS classes.
16510 the different theorem types provided here each have a separate counter (e.g.,
16565 The numbering is reset at each section start.
16568 \begin_layout Standard
16571 AMS Theorems (Numbered by Type)
16575 Standard Theorems (Numbered by Type)
16580 \begin_layout Standard
16581 It cannot be used if any of the modules
16593 Standard Theorems (Unnumbered)
16598 Standard Theorems (Numbered by Chapters)
16602 Standard Theorems (Numbered by Type within Chapters)
16607 \begin_layout Subsection
16608 Standard Theorems (Numbered by Type)
16611 \begin_layout Standard
16612 This module defines some theorem environments for use with non-AMS classes.
16622 the different theorem types provided here each have a separate counter (e.g.,
16677 The numbering’s scope is the whole document.
16678 For chapter- and section-wide numbering,
16679 use one of the “within Chapters”/“within Sections” modules,
16683 \begin_layout Standard
16684 It cannot be used if any of the modules
16696 Standard Theorems (Unnumbered)
16700 AMS Theorems (Numbered by Type)
16705 \begin_layout Subsection
16706 Standard Theorems (Unnumbered)
16709 \begin_layout Standard
16710 This module defines only unnumbered theorem environments and the proof environment,
16711 using the extended AMS machinery.
16712 It cannot be used if either of the modules
16723 \begin_layout Subsection
16727 \begin_layout Standard
16728 This module provides a straightforward way to segregate subequations in LyX.
16731 Help\SpecialChar menuseparator
16732 Math\SpecialChar menuseparator
16738 \begin_layout Section
16742 \begin_layout Subsection
16743 Custom Header/Footer Text
16746 \begin_layout Standard
16747 This module requires the
16750 \begin_inset space ~
16764 ocument\SpecialChar menuseparator
16769 ettings\SpecialChar menuseparator
16771 \begin_inset space ~
16776 dialog to be set to
16781 It adds six environments to document classes which support the
16788 \begin_layout Itemize
16794 \begin_layout Itemize
16800 \begin_layout Itemize
16806 \begin_layout Itemize
16812 \begin_layout Itemize
16818 \begin_layout Itemize
16824 \begin_layout Subsubsection
16825 Fancy Headers and Footers
16828 \begin_layout Standard
16829 The default page layout is rather plain;
16832 Article (Standard Class)
16835 all you get is a centered page number at the bottom of the page.
16836 This document uses the
16841 so it appears to be a bit fancier.
16844 \begin_layout Standard
16848 \begin_inset space ~
16862 ocument\SpecialChar menuseparator
16867 ettings\SpecialChar menuseparator
16871 \begin_inset Quotes eld
16875 \begin_inset Quotes erd
16879 you will find that the page header is divided into three fields,
16880 not surprisingly labeled
16881 \begin_inset Quotes eld
16885 \begin_inset Quotes erd
16890 \begin_inset Quotes eld
16894 \begin_inset Quotes erd
16899 \begin_inset Quotes eld
16903 \begin_inset Quotes erd
16907 The footer is also divided into these three fields.
16908 The \SpecialChar LaTeX
16909 commands to set these fields in the simplest manner are
16938 Suppose you wish to put your name in the upper left hand corner of each page.
16939 Simply insert the following command in the preamble:
16942 \begin_layout LyX-Code
16949 \begin_layout Standard
16950 You will now see your name in the upper left.
16951 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,
16953 \begin_inset space \thinspace{}
16959 \begin_layout LyX-Code
16965 \begin_layout Standard
16968 an easier way to make simple changes.
16974 ocument\SpecialChar menuseparator
16979 ettings\SpecialChar menuseparator
16980 Modules\SpecialChar menuseparator
16981 Page Layout\SpecialChar menuseparator
16982 Custom Header/Footer Text
16985 you will find you have six new environments corresponding to the six fields described above.
16988 \begin_layout Standard
16989 Let's get really fancy:
16990 lets put the section number with the word
16991 \begin_inset Quotes eld
16995 \begin_inset Quotes erd
16999 \begin_inset space \thinspace{}
17003 \begin_inset space \space{}
17006 Section 3) in the upper left,
17007 the page number (e.
17008 \begin_inset space \thinspace{}
17012 \begin_inset space \space{}
17015 Page 4) in the upper right,
17016 your name in the lower left,
17017 and the date in the lower right.
17018 Use your newly enabled environments to add these entries:
17021 \begin_layout LyX-Code
17025 \begin_inset space ~
17044 \begin_layout LyX-Code
17050 \begin_layout LyX-Code
17067 \begin_layout LyX-Code
17079 \begin_layout LyX-Code
17085 \begin_layout LyX-Code
17099 \begin_layout Standard
17100 Make sure you enter the commands
17119 as \SpecialChar TeX
17137 access \SpecialChar LaTeX
17138 ’s section and page counters,
17139 and so print out the current section and page numbers.
17146 simply prints out today’s date.
17149 \begin_layout Standard
17150 The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
17151 If you don't want one of the rules,
17152 set its thickness to 0.
17153 The header rule has a default thickness of 0.4pt,
17154 the footer rule is 0pt.
17155 For this you will need to use \SpecialChar TeX
17159 \begin_layout Standard
17166 headrulewidth}{0.4pt}
17171 \begin_layout Standard
17178 footrulewidth}{0.4pt}
17180 to set the thicknesses.
17183 \begin_layout Standard
17184 You can switch the header/footer settings on and off for individual pages using \SpecialChar TeX
17189 thispagestyle{empty}
17196 thispagestyle{plain}
17203 thispagestyle{fancy}
17206 Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
17209 title pages are marked as plain by default,
17210 while following pages are marked fancy when using the global fancy setting.
17213 \begin_layout Standard
17214 If you want a header or footer to be on the outer side of a two sided document,
17215 you need to use something like:
17218 \begin_layout LyX-Code
17224 \begin_layout LyX-Code
17232 \begin_layout Standard
17233 The first command clears all existing footers avoiding any conflicts with your new command.
17236 \begin_layout Standard
17237 You can enter any of these commands,
17238 the simpler ones in any of your new environments,
17239 the more complex ones as \SpecialChar TeX
17241 at any point in your document and they will take effect on the next page.
17244 \begin_layout Standard
17245 As a final example,
17246 it is possible to include an image in the header or footer.
17247 Suppose you want to put a company logo in the upper left hand corner.
17248 You might try something like this in
17250 Document\SpecialChar menuseparator
17251 Settings\SpecialChar menuseparator
17257 \begin_layout LyX-Code
17264 includegraphics{logo.png}}}
17267 \begin_layout Standard
17269 You may need to preface this with
17273 usepackage{graphics}
17275 if you don't include graphics elsewhere in your document.
17278 \begin_layout Standard
17279 For more information on fancy headers,
17281 \begin_inset Flex Code
17284 \begin_layout Plain Layout
17291 \begin_inset CommandInset href
17294 target "http://www.ctan.org/pkg/fancyhdr"
17302 \begin_layout Subsection
17303 Landscape Document Parts
17306 \begin_layout Standard
17307 This module outputs parts of the document in landscape mode using
17309 Insert\SpecialChar menuseparator
17310 Custom Insets\SpecialChar menuseparator
17315 Insert\SpecialChar menuseparator
17316 Custom Insets\SpecialChar menuseparator
17317 Landscape (Floating)
17322 \begin_layout Subsection
17323 \begin_inset CommandInset label
17325 name "sec:Multiple-Columns"
17332 \begin_layout Standard
17333 This module uses the
17338 \begin_inset Index idx
17343 \begin_layout Plain Layout
17351 package and is independent of the option
17364 ocument\SpecialChar menuseparator
17369 ettings\SpecialChar menuseparator
17371 \begin_inset space ~
17377 If you want to have two columns for the whole document,
17378 you are recommended to use the
17387 For all other cases use this module.
17390 \begin_layout Standard
17391 Footnotes within multiple columns will be placed at the bottom of the page and not under each column.
17392 Within the different columns you can use everything,
17393 with the limitation that for floats you need to check the option
17399 \begin_inset space ~
17409 dit\SpecialChar menuseparator
17415 \begin_inset space ~
17423 \begin_layout Subsubsection
17427 \begin_layout Standard
17428 If you want to have two columns in your text,
17429 insert a multicolumn inset via the menu
17431 Insert\SpecialChar menuseparator
17433 \begin_inset space ~
17436 Insets\SpecialChar menuseparator
17438 \begin_inset space ~
17443 where the columns should start.
17444 Write all text that should be printed in 2
17445 \begin_inset space ~
17448 columns into this inset.
17451 \begin_layout Standard
17452 Here is an example:
17455 \begin_layout Standard
17457 \begin_inset Flex Multiple Columns
17460 \begin_layout Plain Layout
17465 The Adventure of the Empty House
17468 \begin_inset Newline newline
17473 Sir Arthur Conan Doyle
17476 \begin_layout Plain Layout
17479 It was in the spring of the year 1894 that all London was interested,
17480 and the fashionable world dismayed,
17481 by the murder of the Honourable Ronald Adair under most unusual and inexplicable circumstances.
17482 The public has already learned those particulars of the crime which came out in the police investigation,
17483 but a good deal was suppressed upon that occasion,
17484 since the case for the prosecution was so overwhelmingly strong that it was not necessary to bring forward all the facts.
17486 at the end of nearly ten years,
17487 am I allowed to supply those missing links which make up the whole of that remarkable chain.
17488 The crime was of interest in itself,
17489 but that interest was as nothing to me compared to the inconceivable sequel,
17490 which afforded me the greatest shock and surprise of any event in my adventurous life.
17492 after this long interval,
17493 I find myself thrilling as I think of it,
17494 and feeling once more that sudden flood of joy,
17496 and incredulity which utterly submerged my mind.
17497 Let me say to that public,
17498 which has shown some interest in those glimpses which I have occasionally given them of the thoughts and actions of a very remarkable man,
17499 that they are not to blame me if I have not shared my knowledge with them,
17500 for I should have considered it my first duty to do so,
17501 had I not been barred by a positive prohibition from his own lips,
17502 which was only withdrawn upon the third of last month.
17510 \begin_layout Standard
17511 To get 3 or more columns,
17512 set the cursor into the multicolumn inset and use the menu
17514 Insert\SpecialChar menuseparator
17516 \begin_inset space ~
17520 \begin_inset space ~
17526 The number of the desired columns is written into that inset (for 3
17527 \begin_inset space ~
17531 \begin_inset Quotes eld
17535 \begin_inset Quotes erd
17539 \begin_inset Newline newline
17542 Here is an example with 3
17543 \begin_inset space ~
17549 \begin_layout Standard
17550 \begin_inset Flex Multiple Columns
17553 \begin_layout Plain Layout
17556 \begin_inset Argument 1
17559 \begin_layout Plain Layout
17566 It can be imagined that my close intimacy with Sherlock Holmes had interested me deeply in crime,
17567 and that after his disappearance I never failed to read with care the various problems which came before the public.
17568 And I even attempted,
17570 for my own private satisfaction,
17571 to employ his methods in their solution,
17572 though with indifferent success.
17575 which appealed to me like this tragedy of Ronald Adair.
17576 As I read the evidence at the inquest,
17577 which led up to a verdict of willful murder against some person or persons unknown,
17578 I realized more clearly than I had ever done the loss which the community had sustained by the death of Sherlock Holmes.
17579 There were points about this strange business which would,
17581 have specially appealed to him,
17582 and the efforts of the police would have been supplemented,
17583 or more probably anticipated,
17584 by the trained observation and the alert mind of the first criminal agent in Europe.
17586 as I drove upon my round,
17587 I turned over the case in my mind and found no explanation which appeared to me to be adequate.
17588 At the risk of telling a twice-told tale,
17589 I will recapitulate the facts as they were known to the public at the conclusion of the inquest.
17597 \begin_layout Standard
17598 You can have up to 10
17599 \begin_inset space ~
17602 columns if you want to,
17603 but that might not be very pleasant for the readers of your document.
17606 \begin_layout Subsubsection
17607 Columns inside Columns
17610 \begin_layout Standard
17611 You can also have columns inside columns:
17614 \begin_layout Standard
17615 \begin_inset Flex Multiple Columns
17618 \begin_layout Plain Layout
17621 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
17622 at that time governor of one of the Australian colonies.
17623 Adair's mother had returned from Australia to undergo the operation for cataract,
17626 and her daughter Hilda were living together at 427 Park Lane.
17629 \begin_layout Plain Layout
17630 \begin_inset Flex Multiple Columns
17633 \begin_layout Plain Layout
17636 The youth moved in the best society
17637 \begin_inset space ~
17641 so far as was known,
17642 no enemies and no particular vices.
17643 He had been engaged to Miss Edith Woodley,
17645 but the engagement had been broken off by mutual consent some months before,
17646 and there was no sign that it had left any very profound feeling behind it.
17647 For the rest {sic} the man's life moved in a narrow and conventional circle,
17648 for his habits were quiet and his nature unemotional.
17649 Yet it was upon this easy-going young aristocrat that death came,
17650 in most strange and unexpected form,
17651 between the hours of ten and eleven-twenty on the night of March 30,
17660 \begin_layout Plain Layout
17663 Ronald Adair was fond of cards
17664 \begin_inset space ~
17667 – playing continually,
17668 but never for such stakes as would hurt him.
17669 He was a member of the Baldwin,
17671 and the Bagatelle card clubs.
17673 after dinner on the day of his death,
17674 he had played a rubber of whist at the latter club.
17675 He had also played there in the afternoon.
17680 The evidence of those who had played with him
17681 \begin_inset space ~
17688 \begin_inset space ~
17691 – showed that the game was whist,
17692 and that there was a fairly equal fall of the cards.
17693 Adair might have lost five pounds,
17695 His fortune was a considerable one,
17696 and such a loss could not in any way affect him.
17697 He had played nearly every day at one club or other,
17698 but he was a cautious player,
17699 and usually rose a winner.
17700 It came out in evidence that,
17701 in partnership with Colonel Moran,
17702 he had actually won as much as four hundred and twenty pounds in a sitting,
17704 from Godfrey Milner and Lord Balmoral.
17705 So much for his recent history as it came out at the inquest.
17713 \begin_layout Subsubsection
17717 \begin_layout Standard
17718 The examples in this section show some more special features of multiple columns.
17721 \begin_layout Standard
17722 For more features of multiple columns,
17724 \begin_inset CommandInset href
17726 name "documentation"
17727 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
17732 of the \SpecialChar LaTeX
17734 \begin_inset Flex Code
17737 \begin_layout Plain Layout
17746 \begin_layout Paragraph
17750 \begin_layout Standard
17751 To add a preface text for multiple columns,
17752 set the cursor into the multicolumn inset and use the menu
17754 Insert\SpecialChar menuseparator
17758 Write your preface text into that inset.
17759 \begin_inset Newline newline
17762 This is an example with some preface text:
17765 \begin_layout Standard
17766 \begin_inset VSpace bigskip
17772 \begin_layout Standard
17773 \begin_inset Flex Multiple Columns
17776 \begin_layout Plain Layout
17777 \begin_inset Argument 2
17780 \begin_layout Plain Layout
17781 And the story continues and continues and continues and continues\SpecialChar ldots
17789 On the evening of the crime,
17790 he returned from the club exactly at ten.
17791 His mother and sister were out spending the evening with a relation.
17792 The servant deposed that she heard him enter the front room on the second floor,
17793 generally used as his sitting-room.
17794 She had lit a fire there,
17795 and as it smoked she had opened the window.
17796 No sound was heard from the room until eleven-twenty,
17797 the hour of the return of Lady Maynooth and her daughter.
17798 Desiring to say good-night,
17799 she attempted to enter her son's room.
17800 The door was locked on the inside,
17801 and no answer could be got to their cries and knocking.
17803 and the door forced.
17804 The unfortunate young man was found lying near the table.
17805 His head had been horribly mutilated by an expanding revolver bullet,
17806 but no weapon of any sort was to be found in the room.
17814 \begin_layout Standard
17815 You can also use a section heading as the preface if you use a section command as \SpecialChar TeX
17817 For example the command
17820 \begin_layout LyX-Code
17823 subsection{subsection title}
17826 \begin_layout Standard
17827 creates a subsection.
17828 In this example the preface is a subsubsection:
17831 \begin_layout Standard
17832 \begin_inset Flex Multiple Columns
17835 \begin_layout Plain Layout
17836 \begin_inset Argument 2
17839 \begin_layout Plain Layout
17843 \begin_layout Plain Layout
17852 This is a subsubsection heading as a preface
17856 \begin_layout Plain Layout
17870 A minute examination of the circumstances served only to make the case more complex.
17871 In the first place,
17872 no reason could be given why the young man should have fastened the door upon the inside.
17873 There was the possibility that the murderer had done this,
17874 and had afterwards escaped by the window.
17875 The drop was at least twenty feet,
17877 and a bed of crocuses in full bloom lay beneath.
17878 Neither the flowers nor the earth showed any sign of having been disturbed,
17879 nor were there any marks upon the narrow strip of grass which separated the house from the road.
17882 it was the young man himself who had fastened the door.
17883 But how did he come by his death?
17884 No one could have climbed up to the window without leaving traces.
17885 Suppose a man had fired through the window,
17886 he would indeed be a remarkable shot who could with a revolver inflict so deadly a wound.
17888 Park Lane is a frequented thoroughfare;
17889 there is a cab stand within a hundred yards of the house.
17890 No one had heard a shot.
17898 \begin_layout Standard
17899 If there is less vertical space than six text lines is left on the page at the beginning of the multiple columns,
17900 a page break will be inserted before the multiple columns.
17901 Depending on the number of lines of the preface text,
17902 you might want to change this space.
17903 This is done by setting the cursor into the mulitcolumn inset behind the preface (if there is any) and using the menu
17905 Insert\SpecialChar menuseparator
17907 \begin_inset space ~
17911 \begin_inset space ~
17915 \begin_inset space ~
17921 Insert into that inset the amount of space like e.
17922 \begin_inset space \thinspace{}
17926 \begin_inset space \space{}
17930 \begin_inset Quotes eld
17934 \begin_inset Quotes erd
17938 \begin_inset Newline newline
17941 In this example the space is set to 7
17942 \begin_inset space ~
17945 text lines by using
17946 \begin_inset Flex Code
17949 \begin_layout Plain Layout
17958 \begin_inset Flex Code
17961 \begin_layout Plain Layout
17969 needs to be inserted as \SpecialChar TeX
17973 \begin_layout Standard
17974 \begin_inset Flex Multiple Columns
17977 \begin_layout Plain Layout
17978 \begin_inset Argument 3
17981 \begin_layout Plain Layout
17986 \begin_layout Plain Layout
18002 On the evening of the crime,
18003 he returned from the club exactly at ten.
18004 His mother and sister were out spending the evening with a relation.
18005 The servant deposed that she heard him enter the front room on the second floor,
18006 generally used as his sitting-room.
18007 She had lit a fire there,
18008 and as it smoked she had opened the window.
18009 No sound was heard from the room until eleven-twenty,
18010 the hour of the return of Lady Maynooth and her daughter.
18011 Desiring to say good-night,
18012 she attempted to enter her son's room.
18013 The door was locked on the inside,
18014 and no answer could be got to their cries and knocking.
18016 and the door forced.
18017 The unfortunate young man was found lying near the table.
18018 His head had been horribly mutilated by an expanding revolver bullet,
18019 but no weapon of any sort was to be found in the room.
18027 \begin_layout Paragraph
18031 \begin_layout Standard
18032 The amount of space before and after multiple columns can be changed by changing the length
18033 \begin_inset Flex Code
18036 \begin_layout Plain Layout
18045 For example the command
18048 \begin_layout LyX-Code
18056 \begin_layout Standard
18057 in \SpecialChar TeX
18058 Code changes its value to 3
18059 \begin_inset space \thinspace{}
18063 The change must be made before the multiple columns' start.
18064 The predefined value is 13
18065 \begin_inset space \thinspace{}
18071 \begin_layout Standard
18073 \begin_inset Flex Code
18076 \begin_layout Plain Layout
18085 \begin_inset space \thinspace{}
18091 \begin_layout Standard
18095 \begin_layout Plain Layout
18101 multicolsep}{2.5cm}
18109 \begin_layout Standard
18110 \begin_inset Flex Multiple Columns
18113 \begin_layout Plain Layout
18116 All day I turned these facts over in my mind,
18117 endeavouring to hit upon some theory which could reconcile them all,
18118 and to find that line of least resistance which my poor friend had declared to be the starting-point of every investigation.
18119 I confess that I made little progress.
18120 In the evening I strolled across the Park,
18121 and found myself about six o'clock at the Oxford Street end of Park Lane.
18122 A group of loafers upon the pavements,
18123 all staring up at a particular window,
18124 directed me to the house which I had come to see.
18126 thin man with coloured glasses,
18127 whom I strongly suspected of being a plain-clothes detective,
18128 was pointing out some theory of his own,
18129 while the others crowded round to listen to what he said.
18130 I got as near him as I could,
18131 but his observations seemed to me to be absurd,
18132 so I withdrew again in some disgust.
18133 As I did so I struck against an elderly,
18135 who had been behind me,
18136 and I knocked down several books which he was carrying.
18144 \begin_layout Standard
18145 \begin_inset Note Greyedout
18148 \begin_layout Plain Layout
18154 The values you set with
18155 \begin_inset Flex Code
18158 \begin_layout Plain Layout
18166 will be used for all following multiple columns until you change them again.
18174 \begin_layout Standard
18178 \begin_layout Plain Layout
18190 \begin_inset Note Note
18193 \begin_layout Plain Layout
18194 go back to the default
18202 \begin_layout Paragraph
18206 \begin_layout Standard
18207 A column break can be forced by inserting the command
18208 \begin_inset Flex Code
18211 \begin_layout Plain Layout
18219 as \SpecialChar TeX
18220 Code to that position in the text where the column should be broken.
18221 Note that this leads in most cases to whitespace in the text.
18222 \begin_inset Newline newline
18225 Here is an example:
18228 \begin_layout Standard
18229 \begin_inset Flex Multiple Columns
18232 \begin_layout Plain Layout
18235 \begin_inset Quotes eld
18238 You're surprised to see me,
18240 \begin_inset Quotes erd
18248 \begin_layout Plain Layout
18251 I acknowledged that I was.
18254 \begin_layout Plain Layout
18257 \begin_inset Quotes eld
18263 and when I chanced to see you go into this house,
18264 as I came hobbling after you,
18265 I thought to myself,
18266 I'll just step in and see that kind gentleman,
18267 and tell him that if I was a bit gruff in my manner there was not any harm meant,
18268 and that I am much obliged to him for picking up my books.
18269 \begin_inset Quotes erd
18275 \begin_layout Plain Layout
18278 \begin_inset Quotes eld
18281 You make too much of a trifle,
18282 \begin_inset Quotes erd
18287 \begin_inset Quotes eld
18290 May I ask how you knew who I was?
18291 \begin_inset Quotes erd
18294 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
18298 \begin_layout Plain Layout
18310 \begin_layout Plain Layout
18313 \begin_inset Quotes eld
18318 if it isn't too great a liberty,
18319 I am a neighbour of yours,
18320 for you'll find my little bookshop at the corner of Church Street,
18321 and very happy to see you,
18323 Maybe you collect yourself,
18328 \begin_inset space ~
18344 \begin_inset space ~
18349 With five volumes you could just fill that gap on that second shelf.
18353 \begin_inset Quotes erd
18364 \begin_layout Paragraph
18368 \begin_layout Standard
18369 The width of the columns is automatically calculated,
18370 but you can modify the space between the columns.
18371 This is done by changing the length
18372 \begin_inset Flex Code
18375 \begin_layout Plain Layout
18384 Its predefined value is 10
18385 \begin_inset space \thinspace{}
18389 Here is an example where
18390 \begin_inset Flex Code
18393 \begin_layout Plain Layout
18402 \begin_inset space \thinspace{}
18408 \begin_layout Standard
18412 \begin_layout Plain Layout
18426 \begin_layout Standard
18427 \begin_inset Flex Multiple Columns
18430 \begin_layout Plain Layout
18433 My observations of No.
18434 \begin_inset space \space{}
18437 427 Park Lane did little to clear up the problem in which I was interested.
18438 The house was separated from the street by a low wall and railing,
18439 the whole not more than five feet high.
18440 It was perfectly easy,
18442 for anyone to get into the garden,
18443 but the window was entirely inaccessible,
18444 since there was no water pipe or anything which could help the most active man to climb it.
18445 More puzzled than ever,
18446 I retraced my steps to Kensington.
18447 I had not been in my study five minutes when the maid entered to say that a person desired to see me.
18448 To my astonishment it was none other than my strange old book collector,
18450 wizened face peering out from a frame of white hair,
18451 and his precious volumes,
18452 a dozen of them at least,
18453 wedged under his right arm.
18461 \begin_layout Standard
18465 \begin_layout Plain Layout
18477 \begin_inset Note Note
18480 \begin_layout Plain Layout
18481 go back to the default
18489 \begin_layout Paragraph
18493 \begin_layout Standard
18494 Between the columns a rule with a width of the length
18495 \begin_inset Flex Code
18498 \begin_layout Plain Layout
18507 If this rule width is set to 0
18508 \begin_inset space \thinspace{}
18511 pt (this is the default),
18512 the rule is suppressed.
18513 In the following example the rule is 2
18514 \begin_inset space \thinspace{}
18520 \begin_layout Standard
18524 \begin_layout Plain Layout
18530 columnseprule}{2pt}
18538 \begin_layout Standard
18539 \begin_inset Flex Multiple Columns
18542 \begin_layout Plain Layout
18545 \begin_inset Quotes eld
18548 You're surprised to see me,
18550 \begin_inset Quotes erd
18558 \begin_layout Plain Layout
18561 I acknowledged that I was.
18564 \begin_layout Plain Layout
18567 \begin_inset Quotes eld
18573 and when I chanced to see you go into this house,
18574 as I came hobbling after you,
18575 I thought to myself,
18576 I'll just step in and see that kind gentleman,
18577 and tell him that if I was a bit gruff in my manner there was not any harm meant,
18578 and that I am much obliged to him for picking up my books.
18579 \begin_inset Quotes erd
18585 \begin_layout Plain Layout
18588 \begin_inset Quotes eld
18591 You make too much of a trifle,
18592 \begin_inset Quotes erd
18597 \begin_inset Quotes eld
18600 May I ask how you knew who I was?
18601 \begin_inset Quotes erd
18607 \begin_layout Plain Layout
18610 \begin_inset Quotes eld
18615 if it isn't too great a liberty,
18616 I am a neighbour of yours,
18617 for you'll find my little bookshop at the corner of Church Street,
18618 and very happy to see you,
18620 Maybe you collect yourself,
18625 \begin_inset space ~
18641 \begin_inset space ~
18646 With five volumes you could just fill that gap on that second shelf.
18650 \begin_inset Quotes erd
18661 \begin_layout Standard
18662 \begin_inset VSpace defskip
18668 \begin_layout Standard
18669 The rule can be colored by redefining the command
18670 \begin_inset Flex Code
18673 \begin_layout Plain Layout
18682 This is done by inserting the command
18685 \begin_layout LyX-Code
18690 columnseprulecolor}{
18695 \begin_layout Standard
18696 as \SpecialChar TeX
18697 Code before the multicolumn inset.
18699 \begin_inset Flex Code
18702 \begin_layout Plain Layout
18708 in this command by a color of your choice.
18709 You can use all pre- and self-defined colors.
18718 \begin_inset space ~
18723 for more information about pre- and self-defined colors.
18724 To go back to the default color insert the command
18727 \begin_layout LyX-Code
18732 columnseprulecolor}{
18737 \begin_layout Standard
18738 Here is the example with a cyan rule and 1
18739 \begin_inset space \thinspace{}
18742 cm column separation:
18745 \begin_layout Standard
18749 \begin_layout Plain Layout
18758 \begin_layout Plain Layout
18764 columnseprulecolor}{
18774 \begin_layout Standard
18775 \begin_inset Flex Multiple Columns
18778 \begin_layout Plain Layout
18781 \begin_inset Quotes eld
18784 You're surprised to see me,
18786 \begin_inset Quotes erd
18794 \begin_layout Plain Layout
18797 I acknowledged that I was.
18800 \begin_layout Plain Layout
18803 \begin_inset Quotes eld
18809 and when I chanced to see you go into this house,
18810 as I came hobbling after you,
18811 I thought to myself,
18812 I'll just step in and see that kind gentleman,
18813 and tell him that if I was a bit gruff in my manner there was not any harm meant,
18814 and that I am much obliged to him for picking up my books.
18815 \begin_inset Quotes erd
18821 \begin_layout Plain Layout
18824 \begin_inset Quotes eld
18827 You make too much of a trifle,
18828 \begin_inset Quotes erd
18833 \begin_inset Quotes eld
18836 May I ask how you knew who I was?
18837 \begin_inset Quotes erd
18843 \begin_layout Plain Layout
18846 \begin_inset Quotes eld
18851 if it isn't too great a liberty,
18852 I am a neighbour of yours,
18853 for you'll find my little bookshop at the corner of Church Street,
18854 and very happy to see you,
18856 Maybe you collect yourself,
18861 \begin_inset space ~
18877 \begin_inset space ~
18882 With five volumes you could just fill that gap on that second shelf.
18886 \begin_inset Quotes erd
18897 \begin_layout Standard
18901 \begin_layout Plain Layout
18907 columnseprule}{0pt}
18910 \begin_layout Plain Layout
18916 columnseprulecolor}{
18924 \begin_inset Note Note
18927 \begin_layout Plain Layout
18928 go back to the default
18936 \begin_layout Section
18940 \begin_layout Subsection
18941 Custom Paragraph Shapes
18944 \begin_layout Standard
18947 as well as any other text processor uses by default rectangular paragraphs.
18948 For special cases like for example posters,
18949 invitation cards or poems you can modify the paragraph shape to one of your choice.
18950 This module uses the
18954 package to provide over a dozen paragraph shapes as well as commands to define custom shapes.
18957 \begin_layout Subsubsection
18961 \begin_layout Standard
18966 package provides the following shapes:
18969 \begin_layout Standard
18970 \begin_inset Tabular
18971 <lyxtabular version="3" rows="13" columns="3">
18972 <features booktabs="true" islongtable="true" longtabularalignment="center">
18973 <column alignment="left" valignment="middle" width="16col%">
18974 <column alignment="left" valignment="middle" width="40col%">
18975 <column alignment="left" valignment="middle" width="35col%">
18976 <row endhead="true">
18977 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
18980 \begin_layout Plain Layout
18989 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
18992 \begin_layout Plain Layout
19001 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
19004 \begin_layout Plain Layout
19014 <row interlinespace="default">
19015 <cell alignment="left" valignment="top" usebox="none">
19018 \begin_layout Plain Layout
19026 <cell alignment="left" valignment="top" usebox="none">
19029 \begin_layout Plain Layout
19032 Circle with circular hole (in the size of a CD/DVD)
19037 <cell alignment="left" valignment="top" usebox="none">
19040 \begin_layout Plain Layout
19044 take care there is not too much text
19050 <row interlinespace="default">
19051 <cell alignment="left" valignment="top" usebox="none">
19054 \begin_layout Plain Layout
19062 <cell alignment="left" valignment="top" usebox="none">
19065 \begin_layout Plain Layout
19073 <cell alignment="left" valignment="top" usebox="none">
19076 \begin_layout Plain Layout
19080 calculation might fail
19086 <row interlinespace="default">
19087 <cell alignment="left" valignment="top" usebox="none">
19090 \begin_layout Plain Layout
19098 <cell alignment="left" valignment="top" usebox="none">
19101 \begin_layout Plain Layout
19104 Rhomboid (symbolizing a
19105 \begin_inset Quotes eld
19109 \begin_inset Quotes erd
19117 <cell alignment="left" valignment="top" usebox="none">
19120 \begin_layout Plain Layout
19129 <row interlinespace="default">
19130 <cell alignment="left" valignment="top" usebox="none">
19133 \begin_layout Plain Layout
19141 <cell alignment="left" valignment="top" usebox="none">
19144 \begin_layout Plain Layout
19152 <cell alignment="left" valignment="top" usebox="none">
19155 \begin_layout Plain Layout
19164 <row interlinespace="default">
19165 <cell alignment="left" valignment="top" usebox="none">
19168 \begin_layout Plain Layout
19176 <cell alignment="left" valignment="top" usebox="none">
19179 \begin_layout Plain Layout
19187 <cell alignment="left" valignment="top" usebox="none">
19190 \begin_layout Plain Layout
19199 <row interlinespace="default">
19200 <cell alignment="left" valignment="top" usebox="none">
19203 \begin_layout Plain Layout
19211 <cell alignment="left" valignment="top" usebox="none">
19214 \begin_layout Plain Layout
19217 Nut for bolt (hexagon with circular hole)
19222 <cell alignment="left" valignment="top" usebox="none">
19225 \begin_layout Plain Layout
19234 <row interlinespace="default">
19235 <cell alignment="left" valignment="top" usebox="none">
19238 \begin_layout Plain Layout
19246 <cell alignment="left" valignment="top" usebox="none">
19249 \begin_layout Plain Layout
19257 <cell alignment="left" valignment="top" usebox="none">
19260 \begin_layout Plain Layout
19269 <row interlinespace="default">
19270 <cell alignment="left" valignment="top" usebox="none">
19273 \begin_layout Plain Layout
19281 <cell alignment="left" valignment="top" usebox="none">
19284 \begin_layout Plain Layout
19292 <cell alignment="left" valignment="top" usebox="none">
19295 \begin_layout Plain Layout
19304 <row interlinespace="default">
19305 <cell alignment="left" valignment="top" usebox="none">
19308 \begin_layout Plain Layout
19316 <cell alignment="left" valignment="top" usebox="none">
19319 \begin_layout Plain Layout
19327 <cell alignment="left" valignment="top" usebox="none">
19330 \begin_layout Plain Layout
19339 <row interlinespace="default">
19340 <cell alignment="left" valignment="top" usebox="none">
19343 \begin_layout Plain Layout
19351 <cell alignment="left" valignment="top" usebox="none">
19354 \begin_layout Plain Layout
19357 Normal/reversed rain drop
19362 <cell alignment="left" valignment="top" usebox="none">
19365 \begin_layout Plain Layout
19369 calculation might fail
19375 <row interlinespace="default">
19376 <cell alignment="left" valignment="top" usebox="none">
19379 \begin_layout Plain Layout
19388 <cell alignment="left" valignment="top" usebox="none">
19391 \begin_layout Plain Layout
19394 The \SpecialChar TeX
19400 <cell alignment="left" valignment="top" usebox="none">
19403 \begin_layout Plain Layout
19412 <row interlinespace="default">
19413 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
19416 \begin_layout Plain Layout
19420 \begin_inset Newline newline
19428 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
19431 \begin_layout Plain Layout
19434 Triangles in different orientations
19439 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
19442 \begin_layout Plain Layout
19458 \begin_layout Standard
19459 To use a shape for your paragraph,
19460 simply select it in \SpecialChar LyX
19461 's pull-down box for environments in the toolbar.
19464 \begin_layout Standard
19465 \begin_inset Newpage newpage
19471 \begin_layout Standard
19472 Here is an example paragraph in the shape of a nut:
19475 \begin_layout Standard
19476 \begin_inset VSpace bigskip
19485 Lorem ipsum dolor sit amet,
19486 consetetur sadipscing elitr,
19487 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19489 At vero eos et accusam et justo duo dolores et ea rebum.
19490 Stet clita kasd gubergren,
19491 no sea takimata sanctus est Lorem ipsum dolor sit amet.
19492 Lorem ipsum dolor sit amet,
19493 consetetur sadipscing elitr,
19494 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19498 \begin_layout Standard
19499 \begin_inset VSpace bigskip
19505 \begin_layout Standard
19506 \begin_inset Note Greyedout
19509 \begin_layout Plain Layout
19519 paragraphs cannot run over a page break.
19527 \begin_layout Standard
19528 \begin_inset VSpace bigskip
19534 \begin_layout Standard
19536 \begin_inset Flex Code
19539 \begin_layout Plain Layout
19545 takes care that the shape will always be preserved,
19546 no matter how much text is in the paragraph.
19547 Therefore the paragraph size changes with the amount of contained text.
19548 This can lead to paragraph sizes exceeding the page margins.
19549 To demonstrate the size scaling,
19550 here is the same example paragraph but with twice as much text:
19553 \begin_layout Standard
19554 \begin_inset Newpage newpage
19563 Lorem ipsum dolor sit amet,
19564 consetetur sadipscing elitr,
19565 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19567 At vero eos et accusam et justo duo dolores et ea rebum.
19568 Stet clita kasd gubergren,
19569 no sea takimata sanctus est Lorem ipsum dolor sit amet.
19570 Lorem ipsum dolor sit amet,
19571 consetetur sadipscing elitr,
19572 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19574 Lorem ipsum dolor sit amet,
19575 consetetur sadipscing elitr,
19576 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19578 At vero eos et accusam et justo duo dolores et ea rebum.
19579 Stet clita kasd gubergren,
19580 no sea takimata sanctus est Lorem ipsum dolor sit amet.
19581 Lorem ipsum dolor sit amet,
19582 consetetur sadipscing elitr,
19583 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19587 \begin_layout Standard
19588 \begin_inset VSpace bigskip
19594 \begin_layout Standard
19595 An exception is the shape
19600 It cannot be scaled because it must fit the size of a CD/DVD.
19601 Therefore the amount of text that fits into the shape is limited.
19604 \begin_layout Standard
19614 meaning that the calculation of their size can fail,
19615 depending on the amount of text.
19616 You will then get the \SpecialChar LaTeX
19618 \begin_inset Quotes eld
19621 Arithmetic overflow
19622 \begin_inset Quotes erd
19626 In this case one can try to remove or add some text;
19627 if nothing works one has to use another shape.
19630 \begin_layout Standard
19631 For shapes with tips you will maybe see that \SpecialChar LaTeX
19632 's hyphenation routine fails for text in the tips.
19633 Therefore it is often necessary to add hyphenation points
19638 arg "specialchar-insert hyphenation"
19643 ) to the corresponding text parts.
19646 \begin_layout Standard
19647 Shapepar paragraphs are either always centered or placed on the page so that their left border touches the left page margin.
19648 You can therefore not use the paragraph dialog to align such paragraphs.
19649 A solution is to put the paragraph into a minipage or parbox and align the box.
19650 The problem is hereby to find the right width for the box.
19651 Because if it is too wide and you center the box,
19652 the paragraph is not centered too because it sticks at the left side of the box.
19653 So you might have to play a bit with the width until it fits.
19654 Here are two heart-shaped paragraphs,
19655 the first one is not aligned,
19656 the second one is right-aligned:
19659 \begin_layout Standard
19660 \begin_inset Newpage newpage
19666 \begin_layout Heart
19670 Lo\SpecialChar softhyphen
19671 rem ipsum dolor sit amet,
19672 consetetur sadipscing elitr,
19673 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19675 At vero eos et accusam et justo duo dolores et ea rebum.
19676 Stet clita kasd gubergren,
19677 no sea takimata sanctus est Lorem ipsum dolor sit amet.
19680 \begin_layout Standard
19681 \begin_inset VSpace bigskip
19687 \begin_layout Standard
19690 \begin_inset Box Frameless
19700 height_special "totalheight"
19705 backgroundcolor "none"
19708 \begin_layout Heart
19712 Lo\SpecialChar softhyphen
19713 rem ipsum dolor sit amet,
19714 consetetur sadipscing elitr,
19715 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19717 At vero eos et accusam et justo duo dolores et ea rebum.
19718 Stet clita kasd gubergren,
19719 no sea takimata sanctus est Lorem ipsum dolor sit amet.
19727 \begin_layout Subsubsection
19731 \begin_layout Standard
19732 You can define any shape you want.
19733 Doing this manually is a lot of work because every coordinate must be specified.
19734 But there is a way to let the computer calculate the coordinates:
19737 \begin_layout Enumerate
19738 Install the program
19739 \begin_inset CommandInset href
19742 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
19750 \begin_layout Enumerate
19757 TeX/LaTeX\SpecialChar menuseparator
19758 Settings\SpecialChar menuseparator
19761 and select the font size you are using in your document.
19762 For example this document uses the size 12
19763 \begin_inset space \thinspace{}
19769 \begin_layout Enumerate
19773 \begin_layout Enumerate
19776 TeX/LaTeX\SpecialChar menuseparator
19779 to export the shape to coordinates.
19780 In the appearing dialog use either the outline of your shape for the coordinates or the path itself.
19784 \begin_layout Plain Layout
19785 For more information see
19786 \begin_inset CommandInset href
19788 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
19801 \begin_layout Standard
19802 The coordinates are written into a \SpecialChar TeX
19804 To use it for your \SpecialChar LyX
19808 \begin_layout Enumerate
19809 Place the cursor before the first character of your paragraph (or into a new empty one).
19812 \begin_layout Enumerate
19813 Open in \SpecialChar LyX
19816 Insert\SpecialChar menuseparator
19817 File\SpecialChar menuseparator
19819 \begin_inset space ~
19825 select the file and use
19834 \begin_layout Standard
19835 \begin_inset VSpace defskip
19841 \begin_layout Standard
19842 \begin_inset Note Greyedout
19845 \begin_layout Plain Layout
19851 The changed shape only applies to the current paragraph;
19852 everything is reset to normal for the next paragraph.
19853 Therefore the shape definition file must be input into every paragraph with the desired shape.
19861 \begin_layout Standard
19862 \begin_inset VSpace bigskip
19868 \begin_layout Standard
19869 Here is an example:
19872 \begin_layout Standard
19873 \begin_inset VSpace bigskip
19879 \begin_layout Standard
19880 \begin_inset CommandInset include
19882 filename "SpecialParagraphShape.tex"
19889 Lorem ipsum dolor sit amet,
19890 consetetur sadipscing elitr,
19891 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19893 At vero eos et accusam et justo duo dolores et ea rebum.
19894 Stet clita kasd gubergren,
19895 no sea takimata sanctus est Lorem ipsum dolor sit amet.
19896 Lorem ipsum dolor sit amet,
19897 consetetur sadipscing elitr,
19898 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19902 \begin_layout Standard
19903 \begin_inset VSpace bigskip
19909 \begin_layout Standard
19915 to draw complexer shapes in
19919 you can draw the shape in a program of your choice and import the resulting image to
19924 Then you only need to draw a line or spline along the outline of the image.
19927 \begin_layout Standard
19930 Custom paragraph shapes
19932 also provides the two commands
19940 which can be used to define custom shapes coordinate by coordinate.
19944 \begin_layout Plain Layout
19945 These commands are internally used for all shapes described here.
19950 For information how these styles are used and about further customization possibilities,
19952 \begin_inset CommandInset href
19954 name "documentation"
19955 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
19961 \begin_inset Flex Code
19964 \begin_layout Plain Layout
19973 \begin_layout Subsection
19977 \begin_layout Hanging
19978 This module adds the
19984 one where all but the first line of the paragraph is indented.
19985 This may not appear in your \SpecialChar LyX
19986 document but will appear in the final output.
19989 \begin_layout Subsection
19990 \begin_inset CommandInset label
19992 name "subsec:Initials"
19996 Initials (Drop Caps)
19999 \begin_layout Initial
20000 \begin_inset Argument 2
20003 \begin_layout Plain Layout
20010 \begin_inset Argument 3
20013 \begin_layout Plain Layout
20019 module adds a drop capitals paragraph style
20023 for paragraph environments which you can use wherever you want to have drop capitals.
20024 You then have three more items in the
20031 \begin_layout Itemize
20036 which creates an inset for the drop capital
20039 \begin_layout Itemize
20044 which creates an inset for the rest of the word
20047 \begin_layout Itemize
20052 which allow you configure the formatting of the drop capital.
20055 \begin_layout Standard
20056 To customize the appearance of the style,
20059 Help\SpecialChar menuseparator
20060 Embedded Objects\SpecialChar menuseparator
20061 Objects Surrounded by Text\SpecialChar menuseparator
20067 \begin_layout Section
20071 \begin_layout Subsection
20072 Hyphenatable Text Markup (Soul)
20075 \begin_layout Standard
20076 This modul defines text styles to highlight,
20079 underline and capitalize/small-cap text by means of the
20086 \begin_layout Standard
20087 As opposed to the markup provided by the Text Properties dialog,
20088 words marked-up with
20094 \begin_inset CommandInset href
20096 name "soul documentation"
20097 target "http://mirrors.ctan.org/macros/generic/soul/soul.pdf"
20105 \begin_layout Subsection
20109 \begin_layout Standard
20110 This module defines some character styles for logical markup:
20114 \begin_inset Flex Noun
20117 \begin_layout Plain Layout
20131 \begin_inset Flex Emph
20134 \begin_layout Plain Layout
20146 \begin_inset Flex Strong
20149 \begin_layout Plain Layout
20157 \begin_inset Flex Code
20160 \begin_layout Plain Layout
20166 which are accessed via the
20171 dit\SpecialChar menuseparator
20173 \begin_inset space ~
20177 \begin_inset space ~
20189 \begin_layout Chapter
20193 \begin_layout Standard
20194 The most basic information about how to use Bib\SpecialChar TeX
20199 with \SpecialChar LyX
20200 is contained in the section
20202 Bibliography databases
20209 The following subsections explain special bibliography features supported by \SpecialChar LyX
20213 \begin_layout Section
20214 Alternative Citation Styles
20217 \begin_layout Standard
20218 Standard Bib\SpecialChar TeX
20220 \begin_inset space \thinspace{}
20224 \begin_inset space \space{}
20228 \begin_inset Quotes eld
20232 \begin_inset Quotes erd
20235 ) to refer to a cited work.
20237 in many scientific disciplines,
20238 other citation styles are in use.
20239 The most common one is the author-year style (e.
20240 \begin_inset space \thinspace{}
20244 \begin_inset space \space{}
20248 \begin_inset Quotes eld
20252 \begin_inset Quotes erd
20257 supports three packages that provide this style,
20259 \begin_inset Flex Code
20262 \begin_layout Plain Layout
20270 \begin_inset Flex Code
20273 \begin_layout Plain Layout
20281 \begin_inset Flex Code
20284 \begin_layout Plain Layout
20291 Each of these packages has their pros and cons,
20292 which cannot be listed in detail.
20293 If you only want to have simple author-year (or author-numerical) style,
20294 or if you want to use one of the countless style files for
20295 \begin_inset Flex Code
20298 \begin_layout Plain Layout
20305 then the established
20306 \begin_inset Flex Code
20309 \begin_layout Plain Layout
20315 package is probably your choice.
20316 If you look for specific citation styles common in law studies,
20317 you might consider the
20318 \begin_inset Flex Code
20321 \begin_layout Plain Layout
20328 If you want to have full control over the formatting or look for advanced features such as ibidem,
20329 footnote citations,
20330 full title citations,
20331 advanced date formats (such as 400 BC) or full localization to other languages than English,
20332 you should definitely consider
20333 \begin_inset Flex Code
20336 \begin_layout Plain Layout
20343 which exceeds all other packages in terms of features,
20344 but is also quite heavy and more resource-hungry.
20347 \begin_layout Standard
20348 The handling of these packages in \SpecialChar LyX
20349 is basically the same.
20352 Document\SpecialChar menuseparator
20375 Biblatex (Natbib mode)
20387 \begin_inset space ~
20390 6.5.3 in the User's Guide for more information on these choices).
20391 With all these packages,
20392 you will get some extra features in the citation dialog and you can select the style of the reference (
20393 \begin_inset Quotes eld
20397 \begin_inset Quotes erd
20402 \begin_inset Quotes eld
20406 \begin_inset Quotes erd
20411 \begin_inset Quotes eld
20416 \begin_inset Quotes erd
20421 \begin_inset Quotes eld
20425 \begin_inset Quotes erd
20429 Note that either package needs specifically designed style files.
20430 They all ship their own,
20431 but there are lots of additional style files,
20432 and there is even an interactive style file builder
20436 \begin_layout Plain Layout
20438 \begin_inset Flex URL
20441 \begin_layout Plain Layout
20443 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
20454 \begin_inset Flex Code
20457 \begin_layout Plain Layout
20466 \begin_layout Section
20467 Subdivided Bibliographies
20470 \begin_layout Standard
20471 Sometimes you might need to divide your bibliography into several sections.
20472 If you are for instance a historian,
20473 the possibility to separate sources and scientific works is most likely a
20474 \begin_inset Quotes eld
20478 \begin_inset Quotes erd
20483 Bib\SpecialChar TeX
20484 itself does not allow you to do this.
20485 But with the help of some \SpecialChar LaTeX
20487 Bib\SpecialChar TeX
20488 can be extended to fit your needs.
20491 \begin_layout Standard
20493 provides native support for one of these packages,
20502 \begin_layout Plain Layout
20504 \begin_inset Flex URL
20507 \begin_layout Plain Layout
20509 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
20519 The advantage of this package (compared to other packages such as
20523 ) is that you don't need to define new citation commands.
20525 you need to prepare different bibliographic databases which include the entries for the different sections of the bibliography.
20527 If you want to divide your bibliography into the sections
20528 \begin_inset Quotes eld
20532 \begin_inset Quotes erd
20536 \begin_inset Quotes eld
20540 \begin_inset Quotes erd
20544 you first need to create two bibliographic databases,
20546 \begin_inset space \thinspace{}
20550 \begin_inset space \space{}
20554 \begin_inset Flex Code
20557 \begin_layout Plain Layout
20564 \begin_inset Flex Code
20567 \begin_layout Plain Layout
20577 \begin_layout Standard
20580 Document\SpecialChar menuseparator
20589 Subdivided bibliography
20592 Now you can insert multiple Bib\SpecialChar TeX
20594 one for each section of your bibliography.
20595 Returning to our example:
20596 Insert the Bib\SpecialChar TeX
20598 \begin_inset Flex Code
20601 \begin_layout Plain Layout
20607 and a second one for the database
20608 \begin_inset Flex Code
20611 \begin_layout Plain Layout
20618 You are free to use the same or different styles for each section.
20620 you can choose if the bibliography section should contain
20621 \begin_inset Quotes eld
20624 all cited references
20625 \begin_inset Quotes erd
20628 of the specified database(s) (which is the default),
20630 \begin_inset Quotes eld
20633 all uncited references
20634 \begin_inset Quotes erd
20638 \begin_inset Quotes eld
20642 \begin_inset Quotes erd
20646 This might be useful if you would like to separate your bibliography into three sections:
20648 \begin_inset Quotes eld
20652 \begin_inset Quotes erd
20657 \begin_inset Quotes eld
20661 \begin_inset Quotes erd
20666 \begin_inset Quotes eld
20670 \begin_inset Quotes erd
20674 The titles for the sections can be added as ordinary sections or subsections.
20676 \begin_inset Flex Code
20679 \begin_layout Plain Layout
20685 removes the bibliography title,
20686 you have to manually re-add that,
20687 too (as a chapter* or section*,
20691 \begin_layout Standard
20697 the procedure is a bit different.
20708 \begin_inset Flex Noun
20711 \begin_layout Plain Layout
20712 Subdivided bibliography
20717 option is disabled if you use
20727 provides its own means to generate subdivided bibliographies.
20728 You can either add keywords to bibliography entries via the
20729 \begin_inset Flex Code
20732 \begin_layout Plain Layout
20738 entry option and then filter bibliography sections by keyword (by adding
20739 \begin_inset Flex Code
20742 \begin_layout Plain Layout
20749 \begin_inset Flex Noun
20752 \begin_layout Plain Layout
20758 field of the dialog that opens if you left-click on the
20759 \begin_inset Flex Noun
20762 \begin_layout Plain Layout
20763 Biblatex Generated Bibliography
20769 or you can filter by entry types (such as
20778 \begin_inset space \thinspace{}
20783 \begin_inset Flex Code
20786 \begin_layout Plain Layout
20793 \begin_inset Flex Code
20796 \begin_layout Plain Layout
20803 \begin_inset Flex Noun
20806 \begin_layout Plain Layout
20813 or you can create so-called
20814 \begin_inset Quotes eld
20817 Bibliography Categories
20818 \begin_inset Quotes erd
20821 to which you can assign individual entries.
20822 Please refer to the Biblatex manual,
20825 Subdivided Bibliographies
20831 \begin_layout Section
20832 Multiple Bibliographies
20833 \begin_inset CommandInset label
20835 name "subsec:Multiple-Bibliographies"
20842 \begin_layout Standard
20843 Multiple bibliographies,
20845 \begin_inset space \thinspace{}
20849 \begin_inset space \space{}
20852 a bibliography for each part,
20855 subsection or child (sub-document) of the document,
20856 are also supported by \SpecialChar LyX
20858 In order to enable it,
20861 Document\SpecialChar menuseparator
20862 Settings\SpecialChar menuseparator
20865 and select the relevant unit (e.
20866 \begin_inset space \thinspace{}
20871 \begin_inset Quotes eld
20875 \begin_inset Quotes erd
20879 \begin_inset Flex Noun
20882 \begin_layout Plain Layout
20883 Multiple Bibliographies
20889 Then add a Bib(la)\SpecialChar TeX
20890 bibliography to each unit (e.
20891 \begin_inset space \thinspace{}
20895 section) of your document.
20897 a separate bibliography,
20898 containing only the references done in the current unit is generated.
20901 \begin_layout Standard
20902 If you use Bib\SpecialChar TeX
20905 \begin_inset Flex Code
20908 \begin_layout Plain Layout
20915 \begin_inset Flex Code
20918 \begin_layout Plain Layout
20924 package is used to create multiple bibliographies.
20925 The former package is used if you select
20926 \begin_inset Quotes eld
20930 \begin_inset Quotes erd
20938 \begin_inset Flex Noun
20941 \begin_layout Plain Layout
20942 Sectioned Bibliography
20948 In all other cases,
20950 \begin_inset Flex Code
20953 \begin_layout Plain Layout
20963 \begin_layout Plain Layout
20964 An alternative approach,
20965 if you are willing to use some
20966 \begin_inset Flex Noun
20969 \begin_layout Plain Layout
20977 \begin_inset space ~
20981 \begin_inset CommandInset ref
20983 reference "sec:Inserting-TeX-Code"
20990 \begin_inset Flex Code
20993 \begin_layout Plain Layout
21005 \begin_inset Flex Code
21008 \begin_layout Plain Layout
21016 encloses the specified units in
21017 \begin_inset Flex Code
21020 \begin_layout Plain Layout
21027 \begin_inset Flex Code
21030 \begin_layout Plain Layout
21039 \begin_inset Flex Code
21042 \begin_layout Plain Layout
21050 in order to create the units.
21051 Note that this approach has some limitations.
21053 every citation reference has to be inside some
21054 \begin_inset Flex Code
21057 \begin_layout Plain Layout
21064 So citations outside a defined unit (e.
21065 \begin_inset space \thinspace{}
21069 before the first section if you use
21070 \begin_inset Quotes eld
21074 \begin_inset Quotes erd
21078 \begin_inset Quotes eld
21082 \begin_inset Quotes erd
21086 You can also create your own units by entering
21087 \begin_inset Flex Code
21090 \begin_layout Plain Layout
21099 \begin_inset Flex Code
21102 \begin_layout Plain Layout
21110 as \SpecialChar TeX
21111 code (for instance to work around the mentioned limitation).
21115 \begin_inset Flex Code
21118 \begin_layout Plain Layout
21124 s cannot be nested.
21125 A second limitation is that
21126 \begin_inset Flex Code
21129 \begin_layout Plain Layout
21135 always processes all references of a bibliography database,
21136 even if they are not cited.
21137 This can result in odd labels (e.
21138 \begin_inset space \thinspace{}
21143 \begin_inset Quotes eld
21147 \begin_inset Quotes erd
21150 if two works of this author from 2014 are in the database,
21151 even if only one is cited).
21154 \begin_layout Standard
21161 \begin_inset Flex Code
21164 \begin_layout Plain Layout
21170 option is used instead.
21171 If you need specific units,
21172 you can start them with the \SpecialChar TeX
21174 \begin_inset Flex Code
21177 \begin_layout Plain Layout
21186 \begin_inset Flex Code
21189 \begin_layout Plain Layout
21199 If you also want to control the end of the unit,
21200 use the environment
21201 \begin_inset Flex Code
21204 \begin_layout Plain Layout
21214 \begin_inset Flex Code
21217 \begin_layout Plain Layout
21229 \begin_inset Flex Code
21232 \begin_layout Plain Layout
21238 s cannot be nested.
21239 In addition to the individual bibliography of the current unit,
21244 also provides an easy way to output all bibliographies,
21247 \begin_inset space \thinspace{}
21251 at the end of the document).
21253 \begin_inset Quotes eld
21256 all reference units
21257 \begin_inset Quotes erd
21260 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve this.
21261 Please refer to the
21265 manual for more information on this topic.
21268 \begin_layout Chapter
21270 \begin_inset CommandInset label
21272 name "chap:bullets"
21279 \begin_layout Standard
21285 \begin_layout Section
21289 \begin_layout Standard
21291 provides 216 bullet shapes that can be accessed from a simple dialog.
21292 Using this dialog you can easily specify what bullet shape to use at each level of an itemized list.
21293 These settings are document-wide so you won't be able to specify different sets of bullets for different paragraphs.
21297 \begin_layout Plain Layout
21299 actually you can but you'll have to do it by hand.
21307 \begin_layout Section
21311 \begin_layout Standard
21312 Open the dialog by selecting the
21314 Document\SpecialChar menuseparator
21317 menu item and then select the
21318 \begin_inset Flex Noun
21321 \begin_layout Plain Layout
21330 \begin_layout Standard
21331 The dialog provides you with a table of bullet shapes.
21332 A column of buttons on the left of the table provides access to the six different panels of bullet shapes.
21333 The row of buttons across the top is used to select which bullet depth you are changing.
21336 \begin_layout Standard
21342 a text entry under the table will be activated in which you can enter a bullet shape's \SpecialChar LaTeX
21344 If you do modify the text you will also need to specify any needed packages in the \SpecialChar LaTeX
21348 \begin_layout Standard
21349 The six panels are divided up by the packages they require.
21350 The following table shows the mappings from button name to \SpecialChar LaTeX
21354 \begin_layout Standard
21356 \begin_inset Tabular
21357 <lyxtabular version="3" rows="7" columns="2">
21358 <features tabularvalignment="middle">
21359 <column alignment="center" valignment="top" width="0pt">
21360 <column alignment="center" valignment="top" width="0pt">
21362 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21365 \begin_layout Plain Layout
21380 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21383 \begin_layout Plain Layout
21400 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21403 \begin_layout Plain Layout
21418 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21421 \begin_layout Plain Layout
21430 base \SpecialChar LaTeX
21438 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21441 \begin_layout Plain Layout
21456 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21459 \begin_layout Plain Layout
21476 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21479 \begin_layout Plain Layout
21494 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21497 \begin_layout Plain Layout
21514 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21517 \begin_layout Plain Layout
21532 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21535 \begin_layout Plain Layout
21552 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21555 \begin_layout Plain Layout
21570 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21573 \begin_layout Plain Layout
21590 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21593 \begin_layout Plain Layout
21608 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21611 \begin_layout Plain Layout
21634 \begin_layout Standard
21636 doesn't stop you using bullets from packages you don't have.
21637 If you get errors from \SpecialChar LaTeX
21638 when you try to view or print the file,
21639 then it is likely you are missing a package.
21643 \begin_layout Plain Layout
21645 doesn't restrict your use since you may be editing locally and exporting elsewhere.
21653 \begin_layout Section
21654 \begin_inset CommandInset label
21656 name "sec:How-to-use"
21663 \begin_layout Standard
21664 Select which bullet depth you want to change then select the bullet shape and size.
21665 Any changes will not be visible in \SpecialChar LyX
21667 but are visible when viewing the document.
21670 \begin_layout Standard
21671 You can reset a bullet shape to the default simply by clicking your right mouse button on the appropriate bullet depth button.
21672 \begin_inset CommandInset label
21674 name "fn:If-you-really"
21681 \begin_layout Standard
21686 want to have multiple sets of paragraphs with different sets of bullets in each,
21687 then you're going to have to get your hands dirty with \SpecialChar TeX
21689 The bullet selection dialog can help though because it provides you with the \SpecialChar LaTeX
21690 code for a wide range of bullet shapes.
21691 To make your own custom paragraphs you have the following options:
21694 \begin_layout Standard
21698 \begin_layout Plain Layout
21714 \begin_layout Standard
21718 \begin_layout Plain Layout
21740 \begin_layout Itemize
21741 Use the \SpecialChar LaTeX
21743 \begin_inset Flex Code
21746 \begin_layout Plain Layout
21754 to specify a new bullet shape for a given depth.
21755 You'll also need to save the current bullet shape so you can restore it again afterwards.
21756 In this itemized list the following \SpecialChar LaTeX
21757 code was used to change the bullet used for the first depth.
21761 \begin_layout LyX-Code
21771 \begin_layout LyX-Code
21788 \begin_layout Itemize
21789 Note that the itemize depth is specified in Roman numerals as part of the
21798 \begin_layout Itemize
21799 \begin_inset Argument item:1
21802 \begin_layout Plain Layout
21806 \begin_layout Plain Layout
21824 Specify each individual entry by starting each item with the bullet shape enclosed in a
21825 \begin_inset Quotes eld
21829 \begin_inset Quotes erd
21832 inset (available at
21834 Insert\SpecialChar menuseparator
21838 \begin_inset Flex Noun
21841 \begin_layout Plain Layout
21850 this item was started with
21851 \begin_inset Flex Code
21854 \begin_layout Plain Layout
21869 \begin_layout Standard
21873 \begin_layout Plain Layout
21889 \begin_layout Standard
21890 You'll also need to revert the labelitem back to its previous setting for the global bullet shape settings to remain in effect.
21891 The way used here was:
21894 \begin_layout LyX-Code
21904 \begin_layout Chapter
21908 \begin_layout Section
21909 Multipart Documents
21912 \begin_layout Subsection
21916 \begin_layout Standard
21917 When you are working on a large file with many sections,
21918 it is often convenient to break up the document into several files,
21919 or perhaps you have something where a table may change from time to time,
21920 but the preceding text does not.
21922 you should seriously consider using multipart documents.
21924 scientific papers often have five major sections:
21930 Each of these could be its own separate \SpecialChar LyX
21933 \begin_inset Quotes eld
21937 \begin_inset Quotes erd
21940 file which contains the title,
21945 plus the five included files.
21946 It is important to note that each of these files is a full \SpecialChar LyX
21947 file which can be formatted and printed on its own,
21948 as well as included in a master file.
21949 Each of these files must have the same document class,
21951 don't attempt to mix book classes with article classes.
21952 You may also include \SpecialChar LaTeX
21955 these files must not have their own preamble (i.
21956 \begin_inset space \thinspace{}
21960 \begin_inset space \space{}
21963 everything up to and including the
21964 \begin_inset Flex Code
21967 \begin_layout Plain Layout
21975 line as well as the
21976 \begin_inset Flex Code
21979 \begin_layout Plain Layout
21987 line must be deleted) or else errors will be generated when you try to make a DVI file.
21990 \begin_layout Standard
21992 allows you to include files quite easily with
21994 Insert\SpecialChar menuseparator
21996 \begin_inset space ~
22002 When you click on this selection a small box is inserted into the file at the current cursor location.
22003 Clicking on the box raises a dialog which allows you to select the file to be included,
22004 and the method of its inclusion.
22008 \begin_layout Standard
22009 The file selection box should by now be obvious.
22010 The three inclusion methods are
22011 \begin_inset Quotes eld
22015 \begin_inset Quotes erd
22020 \begin_inset Quotes eld
22024 \begin_inset Quotes erd
22029 \begin_inset Quotes eld
22033 \begin_inset Quotes erd
22038 \begin_inset Quotes eld
22042 \begin_inset Quotes erd
22046 \begin_inset Quotes eld
22050 \begin_inset Quotes erd
22053 are similar in many ways,
22054 but there are also some notable differences:
22057 \begin_layout Enumerate
22059 \begin_inset Quotes eld
22063 \begin_inset Quotes erd
22066 are typeset beginning on a new page,
22067 while files that are
22068 \begin_inset Quotes eld
22072 \begin_inset Quotes erd
22075 are typeset starting on the current page.
22078 \begin_layout Enumerate
22079 \begin_inset Quotes eld
22083 \begin_inset Quotes erd
22086 files cannot themselves
22087 \begin_inset Quotes eld
22091 \begin_inset Quotes erd
22095 \begin_inset Quotes eld
22099 \begin_inset Quotes erd
22104 \begin_inset Quotes eld
22108 \begin_inset Quotes erd
22113 infinite sub-inputting is possible.
22116 \begin_layout Enumerate
22117 \begin_inset Quotes eld
22121 \begin_inset Quotes erd
22124 allow for the output of only selected
22125 \begin_inset Quotes eld
22129 \begin_inset Quotes erd
22133 while maintaining the actual counters (pagination etc.) and references (please refer to the section
22136 \begin_inset space ~
22144 \begin_inset space ~
22149 manual for details).
22152 \begin_layout Standard
22155 \begin_inset Quotes eld
22159 \begin_inset Quotes erd
22162 is the preferred method for chapters that are outsourced to child documents,
22164 \begin_inset Quotes eld
22168 \begin_inset Quotes erd
22171 is more suitable for arbitrary file inheritance.
22174 \begin_layout Standard
22176 \begin_inset Quotes eld
22180 \begin_inset Quotes erd
22183 included file allows you to include a file typeset exactly as it appears in the file,
22185 \begin_inset space \thinspace{}
22189 \begin_inset space \space{}
22193 \begin_inset Flex Code
22196 \begin_layout Plain Layout
22203 with the characters set in a fixed-width typewriter font.
22205 spaces in this file are invisible,
22206 though two consecutive spaces are conserved,
22207 unlike \SpecialChar LyX
22208 's normal treatment of spaces.
22211 \begin_inset Flex Noun
22214 \begin_layout Plain Layout
22216 \begin_inset space ~
22220 \begin_inset space ~
22224 \begin_inset space ~
22232 checkbox typesets a mark to unambiguously define the presence of a space.
22236 \begin_layout Standard
22238 the master file is converted into a full \SpecialChar LaTeX
22239 file before typesetting,
22240 while the included files are converted to \SpecialChar LaTeX
22241 files that do not have all the preamble information.
22244 \begin_layout Subsection
22245 Cross-References Between Files
22248 \begin_layout Standard
22249 \begin_inset Box Shadowbox
22259 height_special "totalheight"
22264 backgroundcolor "none"
22267 \begin_layout Plain Layout
22268 This section is somewhat out of date.
22269 Need to describe default master documents and how children are opened when the master is.
22278 \begin_layout Standard
22279 It is possible to set up cross-references between the different files.
22281 open all the files in question:
22282 let's call them A and B in a two file example,
22283 where B is included in A.
22284 Let's say you insert a label in A,
22285 then want to reference it in B.
22286 Open the cross-reference dialog whilst in document B,
22287 and you can select the
22288 \begin_inset Quotes eld
22292 \begin_inset Quotes erd
22298 \begin_layout Subsection
22299 Bibliography Lists in all Subdocuments
22302 \begin_layout Standard
22303 If you work with child documents,
22304 you might want to have only one main bibliography at the end,
22305 but still be able to have a selected bibliography for the child if you output it on its own.
22306 Here is how to achieve this.
22309 \begin_layout Standard
22310 For the main document,
22311 you just insert a bibliography inset at the place where the main bibliography has to appear (within the master file or within a child).
22312 If the bibliography inset is in the master file,
22313 the references will be inherited by all children,
22314 so they are available in the citation dialog within each child.
22317 \begin_layout Standard
22318 For child-specific bibliographies,
22319 insert bibliography insets within the child documents,
22320 at the place where the bibliography should appear when the child is compiled separately.
22322 the trick is to insert them into a branch (
22324 Insert\SpecialChar menuseparator
22325 Branch\SpecialChar menuseparator
22326 Insert New Branch...
22330 \begin_inset space \thinspace{}
22335 \begin_inset Quotes eld
22339 \begin_inset Quotes erd
22343 Within the children,
22344 activate the branch (
22346 Document\SpecialChar menuseparator
22347 Settings...\SpecialChar menuseparator
22352 deactivate the branch (
22354 Document\SpecialChar menuseparator
22355 Settings...\SpecialChar menuseparator
22359 Now the child's bibliography will be ignored by the master,
22360 but considered by the child.
22363 \begin_layout Standard
22364 If you need multiple bibliographies (e.
22365 \begin_inset space \thinspace{}
22369 one per child in the
22374 please refer to sec.
22375 \begin_inset space ~
22379 \begin_inset CommandInset ref
22381 reference "subsec:Multiple-Bibliographies"
22389 \begin_layout Section
22394 \begin_layout Standard
22395 Users sometimes need to be able to
22396 \begin_inset Quotes eld
22400 \begin_inset Quotes erd
22404 file together with all the images (and other files) on which it depends,
22405 either for sending to a publisher or for sharing with a co-author.
22407 includes a Python script (
22408 \begin_inset Flex Code
22411 \begin_layout Plain Layout
22417 ) that automates this process.
22419 you must have either the
22420 \begin_inset Flex Code
22423 \begin_layout Plain Layout
22430 \begin_inset Flex Code
22433 \begin_layout Plain Layout
22439 python modules installed on your system.
22441 the script prefers the
22442 \begin_inset Flex Code
22445 \begin_layout Plain Layout
22452 \begin_inset Flex Code
22455 \begin_layout Plain Layout
22461 format on Unix-like systems and the
22462 \begin_inset Flex Code
22465 \begin_layout Plain Layout
22474 \begin_layout Standard
22476 's configuration process will set the script up to export a `\SpecialChar LyX
22478 and this format will then be available under
22480 File\SpecialChar menuseparator
22486 \begin_layout Standard
22487 Independently of the platform,
22488 the generation of a particular archive format can be forced by adding either the
22489 \begin_inset Flex Code
22492 \begin_layout Plain Layout
22499 \begin_inset Flex Code
22502 \begin_layout Plain Layout
22509 \begin_inset Flex Code
22512 \begin_layout Plain Layout
22519 \begin_inset Flex Code
22522 \begin_layout Plain Layout
22528 format) switch to the
22529 \begin_inset Flex Code
22532 \begin_layout Plain Layout
22542 Tools\SpecialChar menuseparator
22543 Preferences\SpecialChar menuseparator
22544 File Handling\SpecialChar menuseparator
22548 (Make sure you add the switch after the script name,
22552 \begin_layout Chapter
22554 and the World Wide Web
22557 \begin_layout Standard
22559 has long supported the export of documents to various web-friendly formats,
22561 Before version 2.0,
22563 HTML export was always accomplished by the use of external converters.
22567 \begin_layout Plain Layout
22568 For details on the use of external converters with \SpecialChar LyX
22574 section of the Customization manual.
22579 These fall into two large groups:
22580 there are converters that use \SpecialChar LaTeX
22581 as an intermediate format,
22583 \begin_inset Flex Code
22586 \begin_layout Plain Layout
22594 \begin_inset Flex Code
22597 \begin_layout Plain Layout
22605 \begin_inset Flex Code
22608 \begin_layout Plain Layout
22615 relying upon \SpecialChar LyX
22616 to produce the \SpecialChar LaTeX
22618 and there is a converter that works directly on \SpecialChar LyX
22621 \begin_inset Flex Code
22624 \begin_layout Plain Layout
22632 All of these have different advantages and disadvantages.
22636 \begin_layout Standard
22637 The \SpecialChar LaTeX
22638 -based converters have the advantage that,
22640 they know everything about the exported document that \SpecialChar LaTeX
22642 Such converters do not care,
22644 if a certain block of code was produced by \SpecialChar LyX
22645 or was Evil Red Text.
22646 These converters know about
22647 \begin_inset Flex Code
22650 \begin_layout Plain Layout
22659 and can often make use of the
22660 \begin_inset Flex Code
22663 \begin_layout Plain Layout
22669 files generated by Bib\SpecialChar TeX
22673 is a very hard language to parse—
22674 it is sometimes said that only \SpecialChar TeX
22675 itself understands \SpecialChar TeX
22677 and \SpecialChar LaTeX
22678 -based converters will often choke on what seem to be quite simple constructs;
22679 complex ones can throw them completely,
22680 and as of this writing,
22686 manual will not export with
22687 \begin_inset Flex Code
22690 \begin_layout Plain Layout
22697 though the others will.
22698 The other issue concerns how math is handled.
22699 These converters typically convert the formulae into little pictures that are then linked from the HTML document.
22700 Since these are actually generated by \SpecialChar LaTeX
22703 But they do not scale well,
22704 and just getting them to look as if they are actually meant to be in your document—
22705 so that the font sizes seem to be roughly the same—
22706 can be a challenge.
22709 \begin_layout Standard
22711 \begin_inset Flex Code
22714 \begin_layout Plain Layout
22722 \begin_inset CommandInset href
22724 name "http://pinchito.es/elyxer/"
22725 target "http://pinchito.es/elyxer/"
22730 ) solves some of these problems.
22732 the formulae it produces scale perfectly,
22733 since it renders math using a combination of HTML and CSS rather than converting the formulae to images.
22734 But even moderately complex formula are rendered less well than with
22735 \begin_inset Flex Code
22738 \begin_layout Plain Layout
22745 this reflects the limitations of HTML.
22749 \begin_layout Plain Layout
22752 \begin_inset Flex Code
22755 \begin_layout Plain Layout
22762 can also use jsMath and MathJax for equations,
22763 but this setting is only available globally and requires one to have access to a server that runs the backend.
22768 More importantly (as of version 1.1.1,
22771 \begin_inset Flex Code
22774 \begin_layout Plain Layout
22781 has limited support for math macros and no support for user-defined paragraph or character styles.
22782 These limitations make
22783 \begin_inset Flex Code
22786 \begin_layout Plain Layout
22793 unsuitable for many of the documents \SpecialChar LyX
22797 these problems could be solved,
22798 but the \SpecialChar LyX
22799 developers have decided to follow a different path and have made \SpecialChar LyX
22800 itself capable of writing XHTML,
22801 just as it is capable of writing \SpecialChar LaTeX
22807 \begin_layout Standard
22808 As of this writing,
22809 XHTML output remains under development and should probably be regarded as
22810 \begin_inset Quotes eld
22814 \begin_inset Quotes erd
22821 \begin_layout Plain Layout
22823 \begin_inset Flex Code
22826 \begin_layout Plain Layout
22827 development/HTML/HTML.notes
22833 which can be found in the \SpecialChar LyX
22835 \begin_inset CommandInset href
22837 name "accessed online"
22838 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
22844 usually contains up-to-date information about the state of XHTML output.
22845 See also the list of XHTML bugs on
22846 \begin_inset CommandInset href
22848 name "the bug tracker"
22849 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"
22860 the developers have chosen this approach because it has several potential advantages over the other two.
22863 \begin_layout Standard
22864 These advantages are primarily due to the fact that the XHTML output routines,
22865 since they are part of \SpecialChar LyX
22867 know everything \SpecialChar LyX
22868 knows about the document being exported.
22872 \begin_layout Plain Layout
22873 Another advantage is that,
22874 since these routines are internal to \SpecialChar LyX
22876 they are immune to changes in \SpecialChar LyX
22878 or to changes in the semantics of existing insets.
22883 So they know about the table of contents (as displayed in the outline),
22884 about the counters associated with different paragraph styles,
22885 and about user-defined styles.
22886 The XHTML output routines know what \SpecialChar LyX
22887 knows about internationalization,
22889 so they will output
22890 \begin_inset Quotes eld
22894 \begin_inset Quotes erd
22898 \begin_inset Quotes eld
22906 \begin_inset Quotes erd
22910 depending upon the language in effect at the time.
22914 \begin_layout Standard
22916 the output routines know what \SpecialChar LyX
22917 knows about document layout,
22919 about how the document is to be rendered on screen.
22920 We use this information when we output the document as XHTML.
22927 generates CSS style information corresponding to the layout information it uses to render the document on screen:
22928 if section headings are supposed to be sans-serif and bold as seen in \SpecialChar LyX
22930 then (by default) they will be sans-serif and bold when viewed in a web browser,
22932 And this is true not just for pre-defined styles,
22935 including user-defined styles.
22937 the XHTML output routines make no distinction between user-defined paragraph and text styles and \SpecialChar LyX
22938 's own pre-defined styles:
22940 everything \SpecialChar LyX
22941 knows about the styles is contained in the layout files.
22942 And much the same is true as regards pre-defined textual insets,
22944 and various custom insets.
22947 \begin_layout Standard
22948 The result is that XHTML output can be customized and extended in exactly the same way \SpecialChar LaTeX
22949 output can be customized and extended:
22950 through layout files and modules.
22951 See chapter five of the
22955 manual for the details.
22958 \begin_layout Standard
22959 The remainder of this chapter contains more detailed information on XHTML output,
22961 and ways to work around those limitations.
22964 \begin_layout Section
22965 Math Output in XHTML
22968 \begin_layout Standard
22970 offers four choices for how math is rendered.
22971 These have various advantages and disadvantages:
22974 \begin_layout Itemize
22976 \begin_inset Newline newline
22979 MathML is a dialect of XML designed specifically for mathematics on the web,
22980 and it typically renders very well in browsers that support it.
22981 The disadvantage is that not all browsers support MathML,
22982 and support is not complete even in the Gecko-based browsers,
22984 \begin_inset Newline newline
22987 If \SpecialChar LyX
22988 is unable to render a formula as MathML—
22990 if the formula uses the
22991 \begin_inset Flex Code
22994 \begin_layout Plain Layout
23001 then it will instead output the formula as an image.
23005 \begin_layout Itemize
23007 \begin_inset Newline newline
23010 As mentioned above,
23012 \begin_inset Flex Code
23015 \begin_layout Plain Layout
23021 outputs math as HTML,
23026 \begin_layout Plain Layout
23028 has borrowed some of the CSS for its HTML output from
23029 \begin_inset Flex Code
23032 \begin_layout Plain Layout
23043 For simple formulae,
23044 this can work quite well,
23045 though with more complicated formulae it tends to break down.
23047 this method has the advantage that it is very widely supported and so it may be appropriate for documents that contain only a little,
23048 fairly simple math.
23049 \begin_inset Newline newline
23052 If Lyx is unable to render a formula as HTML—
23054 if the formula uses the
23055 \begin_inset Flex Code
23058 \begin_layout Plain Layout
23065 then it will instead output the formula as an image.
23069 \begin_layout Itemize
23071 \begin_inset Newline newline
23075 \begin_inset Flex Code
23078 \begin_layout Plain Layout
23086 will output formulae as images,
23087 the very same images,
23089 that are used for instant preview.
23093 \begin_layout Plain Layout
23094 Instant preview does
23098 have to be on for images to be output,
23104 The advantage to this method is that the images are simply generated by \SpecialChar LaTeX
23106 so they are very accurate.
23108 as mentioned earlier,
23109 is that these are bitmapped images,
23110 so they do not scale terribly well,
23111 and one cannot copy them,
23113 \begin_inset Newline newline
23116 The size of the images can be controlled by setting the
23117 \begin_inset Quotes eld
23120 Math Images Scaling
23121 \begin_inset Quotes erd
23126 Document\SpecialChar menuseparator
23127 Settings\SpecialChar menuseparator
23132 \SpecialChar menuseparator
23139 \begin_layout Plain Layout
23140 For those who want to know,
23141 this controls the resolution of the image in dots per inch and is based upon a default of 75 dpi.
23147 \begin_inset Newline newline
23150 If \SpecialChar LyX
23151 for some reason fails to create an image for a formula (e.g.,
23152 if a required \SpecialChar LaTeX
23153 package is not installed),
23154 then it will fall back to outputing the raw \SpecialChar LaTeX
23158 \begin_layout Itemize
23161 \begin_inset Newline newline
23166 will happily output math as \SpecialChar LaTeX
23168 As well as being the output of last resort,
23169 this method can be used with such tools as
23170 \begin_inset CommandInset href
23173 target "http://www.math.union.edu/~dpvc/jsMath/"
23179 which uses JavaScript to render \SpecialChar LaTeX
23180 embedded in HTML documents.
23182 wraps the \SpecialChar LaTeX
23184 \begin_inset Flex Code
23187 \begin_layout Plain Layout
23193 (for inline formulas) or
23194 \begin_inset Flex Code
23197 \begin_layout Plain Layout
23203 (for displayed formulas) with
23204 \begin_inset Flex Code
23207 \begin_layout Plain Layout
23214 as is required for jsMath.
23217 \begin_layout Standard
23218 One of these output methods must be selected under
23220 Document\SpecialChar menuseparator
23221 Settings\SpecialChar menuseparator
23228 This is a document-wide setting,
23232 \begin_layout Standard
23235 will offer the user the option to select an alternate output method for a particular inset,
23237 one that isn't being rendered very well by MathML.
23241 \begin_layout Plain Layout
23243 since \SpecialChar LyX
23244 falls back to images if the inset contains ERT,
23245 then one can force output as an image by putting some harmless ERT into the math,
23248 \begin_inset Formula $a=b\relax$
23259 \begin_layout Section
23260 Bibliography and Citations
23263 \begin_layout Standard
23264 XHTML output fully supports bibliographies and citations.
23268 \begin_layout Standard
23269 Citation labels are generated by the same machinery that generates \SpecialChar LyX
23270 's on-screen labels,
23271 so the labels will look in the output much as they do in \SpecialChar LyX
23274 If you are using numerical citations,
23275 then \SpecialChar LyX
23276 will output numerical labels,
23277 such as [1] or [17],
23278 rather than simply showing the citation key in square brackets,
23279 as it does on-screen.
23280 If you are using author-year citations,
23281 then \SpecialChar LyX
23282 will add lowercase letters to the years,
23283 just as Bib\SpecialChar TeX
23285 if it finds more than one citation for a given author-year combination.
23286 The labels will be printed with the bibliography entries.
23287 Note that there is,
23289 no way to customize the appearance of the labels,
23291 to choose between square brackets and parentheses.
23294 \begin_layout Standard
23295 Bibliography output is handled by the same machinery that handles the presentation of reference information in the citation dialog,
23296 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.
23297 The formatting can be customized in your layout file or,
23304 manual for the details.
23307 \begin_layout Standard
23308 The main defect at present is that cross-referenced information is printed with every entry with which it is associated.
23309 So you can see things like this:
23312 \begin_layout Quote
23315 \begin_inset Quotes eld
23318 Context and Logical Form
23319 \begin_inset Quotes erd
23325 Language in Context:
23329 Oxford University Press,
23335 \begin_layout Quote
23338 \begin_inset Quotes eld
23341 Semantics in Context
23342 \begin_inset Quotes erd
23348 Language in Context:
23352 Oxford University Press,
23358 \begin_layout Standard
23359 This should be fixed before long.
23362 \begin_layout Standard
23363 There is no support at present for sectioned bibliographies.
23364 If you have multiple bibliographies,
23365 then \SpecialChar LyX
23366 will print the same bibliography over and over.
23369 \begin_layout Section
23373 \begin_layout Standard
23375 will happily export indexes as XHTML,
23376 but with certain limitations at the moment.
23379 \begin_layout Standard
23380 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
23388 \begin_layout Plain Layout
23389 The main issue here is that \SpecialChar LyX
23390 itself does not really handle these.
23391 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
23397 We'll describe how they are handled using the subsection headings from that section.
23400 \begin_layout Itemize
23401 Grouping Index Entries (aka,
23404 makes an effort to support these,
23405 but the entries must be separated by
23406 \begin_inset Quotes eld
23411 \begin_inset Quotes erd
23416 there must be spaces around the exclamation point.
23417 This is because it is otherwise too difficult to check for escaped exclamation points,
23422 \begin_layout Itemize
23424 There is no support at all for page ranges,
23425 since these make no sense with XHMTL.
23427 you will just get two index entries,
23431 \begin_layout Itemize
23433 There is no support for cross-referencing.
23434 If \SpecialChar LyX
23435 finds an entry containing the
23436 \begin_inset Quotes eld
23439 |see\SpecialChar ldots
23441 \begin_inset Quotes erd
23445 it is just dropped,
23446 and the rest is treated as an ordinary index entry.
23449 \begin_layout Itemize
23452 does support attempts to fix the sorting order.
23453 It will take what is before the first `@' it finds and use that for sorting,
23454 taking what follows the first `@' to be the actual entry.
23457 does not check for escaped `@',
23458 so do not try to index email addresses.
23461 \begin_layout Itemize
23462 Index Entry Layout:
23463 You can format entries by using the text style dialog,
23464 or by using any other method available within \SpecialChar LyX
23466 There is no support for constructs like:
23468 \begin_inset Quotes eld
23472 \begin_inset Quotes erd
23477 if \SpecialChar LyX
23478 finds a pipe symbol,
23481 it will delete it and everything that follows it.
23484 \begin_layout Itemize
23486 There is no support for multiple indexes.
23488 all index entries will be printed as one large index.
23489 To avoid our printing several versions of the index,
23490 we print only the main index,
23491 so make sure you have one.
23494 \begin_layout Section
23495 Nomenclature and Glossary
23498 \begin_layout Standard
23499 There is at present no support for glossaries.
23500 Adding it would be fairly trivial,
23504 \begin_layout Chapter
23508 \begin_layout Standard
23511 can generate documents in the DocBook XML vocabulary.
23512 With versions 2.3 and before,
23513 only select templates could be used to generate DocBook documents (only version 4).
23514 Starting with \SpecialChar LyX
23516 most \SpecialChar LyX
23517 layouts can generate valid DocBook documents (only version 5).
23518 This feature is built into \SpecialChar LyX
23519 and does not require the use of external tools.
23522 \begin_layout Standard
23523 The result is that the DocBook output can be customized and extended in exactly the same way \SpecialChar LaTeX
23524 output can be customized and extended:
23525 through layout files and modules.
23526 See chapter five of the
23530 manual for the details.
23533 \begin_layout Standard
23534 Most \SpecialChar LyX
23535 features are supported with DocBook,
23539 \begin_layout Itemize
23540 Math output is performed mostly in MathML (the major exception being constructions not supported by \SpecialChar LyX
23544 All formulae are also available in raw \SpecialChar TeX
23545 in the DocBook output for further processing.
23548 \begin_layout Itemize
23549 Bibliographies and citations are implemented,
23550 including with an external BibTeX file.
23551 Bibliography entries are not prerendered when the detailed information are available,
23552 but rather output with the standard DocBook constructs.
23553 The external DocBook processor is expected to handle the rendering of entries.
23556 \begin_layout Itemize
23557 Indexes are supported,
23558 including multiple indices.
23565 and cross-references (
23570 with the exception of the same symbols escaped.
23579 ) are not supported.
23580 There is no support for escaping of index entries.
23583 \begin_layout Itemize
23584 Glossaries are implemented.
23587 \begin_layout Standard
23588 Two major parameters can be set at the document level.
23591 \begin_layout Itemize
23594 can generate tables either as HTML (default value) or CALS,
23595 depending on the user's requirements.
23596 Most DocBook processors accept both formats.
23599 \begin_layout Itemize
23602 MathML is included within its own name space,
23604 The implication is that there must be an indication of the tags belonging to the MathML standard.
23605 Three choices are offered:
23609 \begin_layout Itemize
23611 the MathML name space is defined for each formula (using the
23615 attribute on each formula)
23618 \begin_layout Itemize
23624 the MathML name space is defined at the document level (using the
23628 attribute on the root element).
23629 Each MathML is prefixed with
23640 \begin_layout Itemize
23656 \begin_layout Standard
23657 This option is especially useful if you want \SpecialChar LyX
23658 to match your personal style or to work with buggy software that only accepts one prefix for MathML.
23662 \begin_layout Chapter
23663 The \SpecialChar LyX
23667 \begin_layout Section
23671 \begin_layout Standard
23672 The `\SpecialChar LyX
23673 server' allows other programs to talk to \SpecialChar LyX
23675 invoke \SpecialChar LyX
23677 and retrieve information about the \SpecialChar LyX
23679 This is only intended for advanced users,
23680 but they should find it useful.
23681 It is by writing to the \SpecialChar LyX
23684 that bibliography managers,
23687 \begin_inset Quotes eld
23691 \begin_inset Quotes erd
23694 citations to \SpecialChar LyX
23698 \begin_layout Section
23699 Starting the \SpecialChar LyX
23701 \begin_inset CommandInset label
23703 name "sec:Starting-the-Server"
23710 \begin_layout Standard
23711 The \SpecialChar LyX
23712 server works through the use of a pair of named pipes.
23713 These are usually located in
23714 \begin_inset Flex Code
23717 \begin_layout Plain Layout
23724 (except on Windows,
23729 named pipes are special objects located in
23730 \begin_inset Flex Code
23733 \begin_layout Plain Layout
23745 ) and have the names
23746 \begin_inset Quotes eld
23750 \begin_inset Flex Code
23753 \begin_layout Plain Layout
23760 \begin_inset Quotes erd
23764 \begin_inset Quotes eld
23768 \begin_inset Flex Code
23771 \begin_layout Plain Layout
23778 \begin_inset Quotes erd
23782 External programs write into
23783 \begin_inset Flex Code
23786 \begin_layout Plain Layout
23792 and read back data from
23793 \begin_inset Flex Code
23796 \begin_layout Plain Layout
23803 The stem of the pipe names can be defined in the
23805 Tools\SpecialChar menuseparator
23806 Preferences\SpecialChar menuseparator
23811 \begin_inset Flex Code
23814 \begin_layout Plain Layout
23815 "/home/myhome/lyxpipe"
23822 \begin_inset Flex Code
23825 \begin_layout Plain Layout
23839 on Windows (where any working path instead of lyxpipe can be used,
23841 \begin_inset Flex Code
23844 \begin_layout Plain Layout
23867 configure this manually in order for the server to start.
23870 \begin_layout Standard
23873 \begin_inset Flex Code
23876 \begin_layout Plain Layout
23883 \begin_inset Flex Code
23886 \begin_layout Plain Layout
23892 ' to create the pipes.
23893 If one of the pipes already exists,
23895 will assume that another \SpecialChar LyX
23896 process is already running and will not start the server.
23897 On POSIX (Unix like) systems,
23898 if for some other reason,
23900 \begin_inset Quotes eld
23904 \begin_inset Quotes erd
23907 pipe is left in existence when \SpecialChar LyX
23909 then \SpecialChar LyX
23910 will try to delete it.
23911 If this fails for some reason,
23912 you will need to delete the pipes manually and then restart \SpecialChar LyX
23915 pipes are deleted by the OS on program termination or crash,
23917 \begin_inset Quotes eld
23921 \begin_inset Quotes erd
23924 pipes should not be possible.
23927 \begin_layout Standard
23928 To have several \SpecialChar LyX
23929 processes with servers at the same time,
23930 you have to use different configurations,
23931 perhaps by using separate user directories,
23933 \begin_inset Flex Code
23936 \begin_layout Plain Layout
23946 \begin_layout Standard
23947 If you are developing a client program,
23948 you might find it useful to enable debugging information from the \SpecialChar LyX
23950 Do this by starting \SpecialChar LyX
23952 \begin_inset Flex Code
23955 \begin_layout Plain Layout
23964 \begin_layout Standard
23965 You can find a complete example client written in C++ in the source distribution as
23966 \begin_inset Flex Code
23969 \begin_layout Plain Layout
23970 development/lyxserver/server_monitor.cpp
23978 \begin_layout Standard
23979 Another useful tool is the command-line based client found in
23980 \begin_inset Flex Code
23983 \begin_layout Plain Layout
23984 src/client/lyxclient
23992 \begin_layout Section
23993 Normal communication
23996 \begin_layout Standard
23997 To issue a \SpecialChar LyX
23999 the client writes a line of ASCII text into the input pipe.
24000 This line has the following format:
24003 \begin_layout Quote
24017 \begin_layout Description
24018 clientname is a name that the client can choose arbitrarily.
24019 Its only use is that \SpecialChar LyX
24020 will echo it if it sends an answer—
24021 so a client can dispatch results from different requesters.
24024 \begin_layout Description
24025 function is the function you want \SpecialChar LyX
24027 It is the same as the commands you'd use in the minibuffer.
24030 \begin_layout Description
24031 argument is an optional argument which is meaningful only to some functions (for instance,
24033 \begin_inset Quotes eld
24037 \begin_inset Quotes erd
24040 LFUN will insert the argument as text at the cursor position).
24043 \begin_layout Standard
24044 The answer from \SpecialChar LyX
24045 will arrive in the output pipe and be of the form
24048 \begin_layout Quote
24062 \begin_layout Standard
24071 are just echoed from the command request,
24076 is more or less useful information filled according to how the command execution worked out.
24079 \begin_inset Quotes eld
24083 \begin_inset Quotes erd
24087 will return information about the internal state of \SpecialChar LyX
24089 while other will return an empty data-response.
24090 This means that the command execution went fine.
24093 \begin_layout Standard
24095 the response from \SpecialChar LyX
24096 will have this form
24099 \begin_layout Quote
24113 \begin_layout Standard
24118 should contain an explanation of why the command failed.
24121 \begin_layout Standard
24125 \begin_layout LyX-Code
24126 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
24127 \begin_inset Newline newline
24130 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
24131 \begin_inset Newline newline
24134 read a <~/.lyxpipe.out
24135 \begin_inset Newline newline
24141 \begin_layout Subsection
24142 AppleScript (Mac OS X)
24145 \begin_layout Standard
24146 Since \SpecialChar LyX
24149 supports basic interactions with AppleScript for normal communication through the command run.
24150 This command takes a direct argument (the
24154 to perform) and an optional argument.
24155 It either returns the output of the function or triggers an error with the error message and code.
24158 \begin_layout Standard
24162 \begin_layout LyX-Code
24163 tell application "\SpecialChar LyX
24167 \begin_layout LyX-Code
24171 \begin_layout LyX-Code
24172 -- Stores the current file name into f
24175 \begin_layout LyX-Code
24176 set f to (run "server-get-filename" with argument "")
24179 \begin_layout LyX-Code
24180 on error the error_message number the error_number
24183 \begin_layout LyX-Code
24184 display dialog "Error:
24185 " & the error_number & ".
24189 \begin_layout LyX-Code
24190 & the error_message buttons {"OK"} default button 1
24193 \begin_layout LyX-Code
24197 \begin_layout LyX-Code
24201 \begin_layout Section
24205 \begin_layout Standard
24207 can notify clients of events going on asynchronously.
24208 Currently it will only do this if the user binds a key sequence with the function
24209 \begin_inset Quotes eld
24213 \begin_inset Quotes erd
24217 The format of the string \SpecialChar LyX
24218 sends is as follows:
24221 \begin_layout Quote
24222 \begin_inset Flex Code
24225 \begin_layout Plain Layout
24236 \begin_layout Standard
24241 is the printed representation of the key sequence that was actually typed by the user.
24244 \begin_layout Standard
24245 This mechanism can be used to extend \SpecialChar LyX
24246 's command set and implement macros.
24247 Bind some key sequence to
24248 \begin_inset Quotes eld
24252 \begin_inset Quotes erd
24256 Then start a client that listens on the output pipe,
24257 dispatches the command according to the sequence,
24258 and starts a function that may use \SpecialChar LyX
24259 calls and \SpecialChar LyX
24260 requests to issue a command or a series of commands to \SpecialChar LyX
24264 \begin_layout Section
24265 The simple \SpecialChar LyX
24269 \begin_layout Standard
24271 implements a simple protocol that can be used for session management.
24272 All messages are of the form
24275 \begin_layout Quote
24285 \begin_layout Standard
24291 \begin_inset Quotes eld
24295 \begin_inset Quotes erd
24299 \begin_inset Quotes eld
24303 \begin_inset Quotes erd
24308 \begin_inset Quotes eld
24312 \begin_inset Quotes erd
24315 is received from a client,
24317 will report back to inform the client that it's listening to it's messages,
24319 \begin_inset Quotes eld
24323 \begin_inset Quotes erd
24326 sent from \SpecialChar LyX
24327 will inform clients that \SpecialChar LyX
24331 \begin_layout Section
24332 Reverse DVI/PDF search
24335 \begin_layout Standard
24336 Some DVI/PDF viewers
24340 \begin_layout Plain Layout
24341 The following viewers offer the reverse PDF search feature:
24342 Okular on KDE/Linux,
24344 Skim on Mac OSX and SumatraPDF on Windows.
24353 facility (also called
24358 This means that you can tell \SpecialChar LyX
24359 to put the cursor to a specific line in the document by clicking at the respective position in the DVI/PDF output.
24361 the viewer must be able to communicate with \SpecialChar LyX
24363 This is done via the \SpecialChar LyX
24364 server either by using the named pipe (
24369 or the UNIX domain socket (
24373 ) that \SpecialChar LyX
24374 creates in its temporary directory (this is the way the
24375 \begin_inset Flex Code
24378 \begin_layout Plain Layout
24384 program communicates with \SpecialChar LyX
24387 you need a helper script that mediates between the viewer and \SpecialChar LyX
24390 the viewer can communicate with \SpecialChar LyX
24392 This depends on the selected viewer and on your operating system.
24393 The same applies to the way viewers need to be configured and the way the reverse search is actually performed.
24395 we will thus describe how to setup reverse search for specific viewers.
24396 Before we turn to this,
24398 we will explain what needs to be done generally to enable reverse search in the DVI/PDF output.
24401 \begin_layout Subsection
24403 \begin_inset CommandInset label
24405 name "subsec:rev-search"
24412 \begin_layout Standard
24413 In most cases \SpecialChar LyX
24414 will do the work for you by pressing the following button in the toolbar:
24418 arg "buffer-toggle-output-sync"
24423 you can also enable the feature by checking
24425 Synchronize with Output
24429 Document\SpecialChar menuseparator
24430 Settings\SpecialChar menuseparator
24431 Output\SpecialChar menuseparator
24435 In such a case \SpecialChar LyX
24436 will automatically insert the necessary Sync\SpecialChar TeX
24437 macro (for PDF) or load the srcltx package (for DVI) respectively.
24438 This option can be easily reached also on
24439 \begin_inset Flex Code
24442 \begin_layout Plain Layout
24451 \begin_layout Standard
24452 If you need a different setting,
24453 you can select or input a custom macro from the drop down box just below
24455 Document\SpecialChar menuseparator
24456 Settings\SpecialChar menuseparator
24457 Output\SpecialChar menuseparator
24458 Synchronize with Output
24463 \begin_layout Standard
24464 Note that the method
24465 \begin_inset Flex Code
24468 \begin_layout Plain Layout
24476 enables gzip compression.
24477 If your viewer does not support it,
24478 you should instead use
24479 \begin_inset Flex Code
24482 \begin_layout Plain Layout
24493 \begin_layout Standard
24494 Please also note that including the
24495 \begin_inset Flex Code
24498 \begin_layout Plain Layout
24505 \begin_inset Flex Code
24508 \begin_layout Plain Layout
24514 sometimes has an undesired impact on the typesetting.
24516 you should switch output synchronization off for the final typesetting if you use the
24517 \begin_inset Flex Code
24520 \begin_layout Plain Layout
24527 \begin_inset Flex Code
24530 \begin_layout Plain Layout
24540 \begin_layout Standard
24541 In case you need some more special settings that are not covered by the automatic settings,
24542 read the next section about how to set up output synchronization manually.
24543 If the automatic setup suits your needs,
24544 you can readily jump to section
24545 \begin_inset space ~
24549 \begin_inset CommandInset ref
24551 reference "subsec:configuring-viewers"
24557 where the necessary configuration steps in your viewer – needed both with the automatic and the manual setup – are described.
24560 \begin_layout Subsection
24564 \begin_layout Standard
24566 provides several different methods for reverse search.
24567 Some are built-in in the
24568 \begin_inset Flex Code
24571 \begin_layout Plain Layout
24578 some are provided by external packages.
24579 Your choice depends on whether your \SpecialChar LaTeX
24580 distribution already provides a given method (the built-in methods are rather new) and whether your viewer can cope with it.
24581 The available methods are described in the following.
24584 \begin_layout Subsubsection*
24585 Built-in DVI-search via src-specials (DVI only)
24588 \begin_layout Standard
24589 This method provides the DVI file with the necessary information for reverse search.
24590 It is available in \SpecialChar LaTeX
24591 since quite some time (any somewhat recent \SpecialChar LaTeX
24592 distribution should include it),
24593 and it works reliably.
24596 \begin_inset Flex Noun
24599 \begin_layout Plain Layout
24610 \begin_inset Flex Noun
24613 \begin_layout Plain Layout
24625 Preferences\SpecialChar menuseparator
24626 File Handling\SpecialChar menuseparator
24630 \begin_inset Flex Code
24633 \begin_layout Plain Layout
24634 latex -src-specials $$i
24640 If this doesn't work,
24641 check if your \SpecialChar TeX
24642 engine needs different options (the syntax might differ in some distributions).
24645 \begin_layout Subsubsection*
24646 External Packages (PDFSync and scrltx)
24649 \begin_layout Standard
24658 provide reverse search facility for PDF output (via pdflatex) and DVI output,
24660 In order to enable it,
24661 load the packages in the \SpecialChar LyX
24666 \begin_layout Itemize
24667 \begin_inset Flex Code
24670 \begin_layout Plain Layout
24673 usepackage{pdfsync}
24678 for reverse PDF search,
24681 \begin_layout Itemize
24682 \begin_inset Flex Code
24685 \begin_layout Plain Layout
24688 usepackage[active]{srcltx}
24693 for reverse DVI search.
24696 \begin_layout Standard
24697 If you want to be able to perform both DVI and PDF reverse searches,
24698 you can also insert in the preamble the following lines
24701 \begin_layout LyX-Code
24705 \begin_inset Newline newline
24711 \begin_inset Newline newline
24716 usepackage{pdfsync}
24717 \begin_inset Newline newline
24723 \begin_inset Newline newline
24728 usepackage[active]{srcltx}
24729 \begin_inset Newline newline
24737 \begin_layout Standard
24739 you can preview the file as either DVI or PDF (pdflatex) and the right package will be used.
24742 \begin_layout Standard
24743 Note that PDFSync might affect the output layout of your document.
24744 It is therefore advised to disable PDFsync for final documents.
24747 \begin_layout Subsubsection*
24748 Built-in reverse search via Sync\SpecialChar TeX
24752 \begin_layout Standard
24754 \begin_inset Flex Code
24757 \begin_layout Plain Layout
24763 have built-in support for both PDF and DVI reverse search.
24766 Sync\SpecialChar TeX
24769 facility is basically the result of the integration of the PDFSync package to the pdftex program and its merge with the
24774 You need at least \SpecialChar TeX
24775 Live 2008 or a recent Mik\SpecialChar TeX
24776 distribution in order to use it.
24780 \begin_layout Plain Layout
24782 Mik\SpecialChar TeX
24783 does not understand/obey the command \SpecialChar LyX
24784 inserts into the preamble when you check the "Enable Forward/Reverse Search" button in the toolbar and does not generate the necessary info.
24787 \begin_layout Plain Layout
24788 The generation of the required info can be forced by changing the converter "\SpecialChar LaTeX
24789 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e.,
24790 by adding the -synctex=1 switch).
24795 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
24797 SumatraPDF on Windows;
24798 see the next section for details) already provide Sync\SpecialChar TeX
24802 \begin_layout Standard
24803 To enable Sync\SpecialChar TeX
24806 \begin_inset Flex Noun
24809 \begin_layout Plain Layout
24820 \begin_inset Flex Noun
24823 \begin_layout Plain Layout
24828 (plain) -> DraftDVI
24835 Preferences\SpecialChar menuseparator
24836 File Handling\SpecialChar menuseparator
24840 \begin_inset Flex Code
24843 \begin_layout Plain Layout
24844 latex -synctex=1 $$i
24850 and for PDF output,
24852 \begin_inset Flex Noun
24855 \begin_layout Plain Layout
24860 (pdflatex) -> PDF (pdflatex)
24866 \begin_inset Flex Code
24869 \begin_layout Plain Layout
24870 pdflatex -synctex=1 $$i
24876 Should your viewer not be considered in the following description,
24877 or in case of missing success,
24878 please check the documentation of your viewer whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
24883 \begin_layout Plain Layout
24884 Note that the option
24885 \begin_inset Flex Code
24888 \begin_layout Plain Layout
24894 option enables gzip compression.
24895 If your viewer does not support it,
24896 you should instead use
24897 \begin_inset Flex Code
24900 \begin_layout Plain Layout
24914 \begin_layout Subsection
24915 Configuring and using specific viewers
24916 \begin_inset CommandInset label
24918 name "subsec:configuring-viewers"
24925 \begin_layout Subsubsection*
24926 Xdvi (all platforms)
24929 \begin_layout Standard
24931 \begin_inset Flex Code
24934 \begin_layout Plain Layout
24941 you don't need to do anything else for performing a reverse DVI search,
24942 as \SpecialChar LyX
24943 already provides the necessary hooks for automatically using the
24944 \begin_inset Flex Code
24947 \begin_layout Plain Layout
24954 Just setup your document as described above (reverse search is triggered by Ctrl-click or Alt-click on Mac OSX,
24958 \begin_layout Standard
24960 if for whatever reason you want to use the named pipe instead of the socket for communicating with \SpecialChar LyX
24962 simply change the DVI viewer in
24964 Preferences\SpecialChar menuseparator
24965 File Handling\SpecialChar menuseparator
24972 \begin_layout Plain Layout
24973 On Mac OSX you have to use
24974 \begin_inset Flex Code
24977 \begin_layout Plain Layout
24978 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
24989 \begin_inset Flex Code
24992 \begin_layout Plain Layout
24993 xdvi -editor "lyxeditor.sh %f %l"
25000 \begin_inset Flex Code
25003 \begin_layout Plain Layout
25009 is a suitable script.
25011 a minimal shell script is the following one:
25014 \begin_layout LyX-Code
25016 \begin_inset Newline newline
25019 LYXPIPE="/path/to/lyxpipe"
25020 \begin_inset Newline newline
25023 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
25024 \begin_inset Newline newline
25027 echo "$COMMAND" > "${LYXPIPE}".in || exit
25028 \begin_inset Newline newline
25031 read TMP < "${LYXPIPE}".out || exit
25034 \begin_layout Standard
25036 \begin_inset Flex Code
25039 \begin_layout Plain Layout
25045 is the LyXServer pipe path specified in
25047 Preferences\SpecialChar menuseparator
25054 \begin_layout Plain Layout
25056 \begin_inset Flex Code
25059 \begin_layout Plain Layout
25065 folder of a source distribution you can find a
25066 \begin_inset Flex Code
25069 \begin_layout Plain Layout
25075 script which is able to locate the
25079 based on your preferences.
25087 \begin_layout Subsubsection*
25091 \begin_layout Standard
25093 \begin_inset Flex Code
25096 \begin_layout Plain Layout
25097 /Applications/MacDviX_Folder/calleditor.script
25103 add the following lines:
25106 \begin_layout LyX-Code
25107 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
25108 \begin_inset Newline newline
25114 \begin_layout Standard
25115 Modify the lines accordingly if you install \SpecialChar LyX
25116 somewhere else than in the Applications folder.
25119 \begin_layout Standard
25120 Reverse search is triggered by Alt-click (OPTION-click).
25123 \begin_layout Subsubsection*
25127 \begin_layout Standard
25129 \begin_inset Flex Code
25132 \begin_layout Plain Layout
25133 open -a Skim.app $$i
25138 to the viewer setting in
25140 Preferences\SpecialChar menuseparator
25141 File Handling\SpecialChar menuseparator
25142 File formats\SpecialChar menuseparator
25148 Skim\SpecialChar menuseparator
25149 Preferences\SpecialChar menuseparator
25156 preset and enter command
25157 \begin_inset Flex Noun
25160 \begin_layout Plain Layout
25161 /Applications/\SpecialChar LyX
25162 .app/Contents/MacOS/lyxeditor
25170 \begin_layout Standard
25171 Reverse search is triggered by COMMAND-SHIFT-click
25174 \begin_layout Subsubsection*
25178 \begin_layout Standard
25179 Reverse search with evince does not work out of the box,
25180 but it can be achieved by means of some third party helper scripts.
25182 \begin_inset CommandInset href
25184 target "https://wiki.lyx.org/LyX/SyncTeX"
25192 \begin_layout Subsubsection*
25196 \begin_layout Standard
25199 Settings\SpecialChar menuseparator
25200 Configure Okular\SpecialChar menuseparator
25204 \begin_inset Quotes erd
25208 This inserts the appropriate command (
25209 \begin_inset Flex Code
25212 \begin_layout Plain Layout
25221 \begin_layout Standard
25222 Reverse search is triggered by SHIFT-click.
25223 Note that this only works if Okular is in
25224 \begin_inset Quotes eld
25228 \begin_inset Quotes erd
25232 \begin_inset space \thinspace{}
25236 the hand symbol is clicked).
25239 \begin_layout Subsubsection*
25243 \begin_layout Standard
25244 Qpdfview supports Sync\SpecialChar TeX
25245 since version 0.3.5.
25248 Edit\SpecialChar menuseparator
25249 Settings\SpecialChar menuseparator
25253 click on the input field of the
25254 \begin_inset Quotes eld
25258 \begin_inset Quotes erd
25261 item and add the command
25262 \begin_inset Flex Code
25265 \begin_layout Plain Layout
25274 \begin_layout Standard
25275 Reverse search is triggered by double-click or,
25276 in more recent versions,
25280 \begin_layout Subsubsection*
25284 \begin_layout Standard
25288 View\SpecialChar menuseparator
25291 menu and select the
25292 \begin_inset Quotes eld
25296 \begin_inset Quotes erd
25301 \begin_inset Quotes eld
25304 New\SpecialChar ldots
25306 \begin_inset Quotes erd
25310 in the window that opens,
25312 \begin_inset Quotes eld
25317 \begin_inset Quotes erd
25320 (or any other name you like) in the
25321 \begin_inset Quotes eld
25325 \begin_inset Quotes erd
25329 Now click on the button labeled
25330 \begin_inset Quotes eld
25335 \begin_inset Quotes erd
25338 to open a file dialog and navigate to the directory containing the batch file
25339 \begin_inset Flex Code
25342 \begin_layout Plain Layout
25350 \begin_inset Flex Code
25353 \begin_layout Plain Layout
25359 and then specify the program arguments as
25360 \begin_inset Flex Code
25363 \begin_layout Plain Layout
25371 \begin_inset Flex Code
25374 \begin_layout Plain Layout
25380 wrapper is used for communicating with \SpecialChar LyX
25388 \begin_layout LyX-Code
25390 \begin_inset Newline newline
25393 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
25402 \begin_inset Newline newline
25416 \begin_layout Standard
25417 Make sure that the \SpecialChar LyX
25418 Server pipe path you specified in \SpecialChar LyX
25420 \begin_inset Flex Code
25423 \begin_layout Plain Layout
25438 otherwise change the
25439 \begin_inset Flex Code
25442 \begin_layout Plain Layout
25448 wrapper accordingly.
25451 \begin_layout Standard
25453 reverse search is triggered by double-click.
25456 \begin_layout Subsubsection*
25457 SumatraPDF (Windows)
25460 \begin_layout Standard
25461 In order to use SumatraPDF for inverse search,
25463 \begin_inset Flex Code
25466 \begin_layout Plain Layout
25467 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
25472 in the viewer setting in
25474 Preferences\SpecialChar menuseparator
25475 File Handling\SpecialChar menuseparator
25476 File formats\SpecialChar menuseparator
25481 \begin_inset Flex Code
25484 \begin_layout Plain Layout
25490 is the previous wrapper.
25491 If SumatraPDF.exe is not in your command PATH,
25492 use its full file name.
25495 \begin_layout Standard
25496 Reverse search is triggered by double-click.
25499 \begin_layout Subsubsection*
25503 \begin_layout Standard
25505 make sure that yap is your default DVI viewer in the Windows environment,
25509 View\SpecialChar menuseparator
25512 menu and select the
25513 \begin_inset Quotes eld
25517 \begin_inset Quotes erd
25522 \begin_inset Quotes eld
25525 New\SpecialChar ldots
25527 \begin_inset Quotes erd
25531 in the window that opens,
25533 \begin_inset Quotes eld
25538 \begin_inset Quotes erd
25541 (or any other name you like) in the
25542 \begin_inset Quotes eld
25546 \begin_inset Quotes erd
25550 Now click on the button labeled
25551 \begin_inset Quotes eld
25556 \begin_inset Quotes erd
25559 to open a file dialog and navigate to the directory containing the
25560 \begin_inset Flex Code
25563 \begin_layout Plain Layout
25569 program (which is installed by default on Cygwin along with the \SpecialChar LyX
25572 \begin_inset Flex Code
25575 \begin_layout Plain Layout
25581 and then specify the program arguments as
25582 \begin_inset Flex Code
25585 \begin_layout Plain Layout
25593 you will be using the
25597 for communicating with \SpecialChar LyX
25600 for whatever reason,
25601 you want to use the
25607 \begin_inset Flex Code
25610 \begin_layout Plain Layout
25616 option and be sure to specify the \SpecialChar LyX
25617 Server pipe path in the \SpecialChar LyX
25621 \begin_layout Standard
25623 reverse search is triggered by double-click.
25626 \begin_layout Subsubsection*
25627 SumatraPDF (Cygwin)
25630 \begin_layout Standard
25631 In order to use SumatraPDF for inverse search,
25633 \begin_inset Flex Code
25636 \begin_layout Plain Layout
25637 SumatraPDF -inverse-search "lyxeditor -g %f %l"
25642 in the viewer setting in
25644 Preferences\SpecialChar menuseparator
25645 File Handling\SpecialChar menuseparator
25646 File formats\SpecialChar menuseparator
25650 If SumatraPDF.exe is not in your command PATH,
25651 use its full posix path.
25653 \begin_inset Flex Code
25656 \begin_layout Plain Layout
25662 enables communication via the
25669 \begin_inset Flex Code
25672 \begin_layout Plain Layout
25678 option if you want to use the
25683 and be sure to specify the \SpecialChar LyX
25684 Server pipe path in the \SpecialChar LyX
25688 \begin_layout Standard
25689 Reverse search is triggered by double-click.
25692 \begin_layout Section
25696 \begin_layout Standard
25698 as the name implies,
25700 \begin_inset Quotes eld
25704 \begin_inset Quotes erd
25708 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
25710 If forward search is set up (as described in what follows),
25711 you can put the cursor anywhere in your \SpecialChar LyX
25715 Navigate\SpecialChar menuseparator
25722 in the context menu via right mouse click),
25723 and then the viewer will jump to that position as well.
25726 that your viewer supports this function.
25729 \begin_layout Standard
25730 To make forward search possible,
25731 you first need to provide the generated output PDF/DVI file with additional information about the \SpecialChar TeX
25733 This can be done via the methods described in the section
25734 \begin_inset CommandInset ref
25736 reference "subsec:rev-search"
25744 \begin_layout Standard
25746 you need to configure \SpecialChar LyX
25747 for using your viewers in
25749 Tools\SpecialChar menuseparator
25750 Preferences\SpecialChar menuseparator
25751 Output\SpecialChar menuseparator
25755 We provide a range of tested configurations for some viewers,
25756 which you can select from the drop down list.
25757 If none of these configurations suits you,
25758 you have to find out and enter a suitable configuration yourself.
25759 The definition syntax uses the following placeholders:
25762 \begin_layout Itemize
25764 \begin_inset Flex Code
25767 \begin_layout Plain Layout
25777 \begin_layout Itemize
25779 \begin_inset Flex Code
25782 \begin_layout Plain Layout
25789 name of the (temporary) exported .tex file (without path)
25792 \begin_layout Itemize
25794 \begin_inset Flex Code
25797 \begin_layout Plain Layout
25804 name of the (temporary) exported .tex file (including path)
25807 \begin_layout Itemize
25809 \begin_inset Flex Code
25812 \begin_layout Plain Layout
25819 name of the exported output file (either dvi or pdf,
25820 depending on which one exists in the temporary directory)
25823 \begin_layout Standard
25824 Note that only some of the viewers provide full and usable forward search functionality out of the box,
25831 \begin_layout Plain Layout
25832 You might want to set
25833 \begin_inset Flex Code
25836 \begin_layout Plain Layout
25844 Tools\SpecialChar menuseparator
25845 Preferences\SpecialChar menuseparator
25846 File Handling\SpecialChar menuseparator
25848 \begin_inset space ~
25862 \begin_layout Plain Layout
25863 SumatraPDF can also use DDE commands through the external program CMCDDE —
25865 \begin_inset CommandInset href
25867 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
25883 \begin_layout Plain Layout
25884 Forward search with evince can be achieved by means of third party helper scripts.
25886 \begin_inset CommandInset href
25888 target "https://wiki.lyx.org/LyX/SyncTeX"
25899 require some extra tools in order to use forward search.
25900 While many of the widespread PDF viewers (most notably Adobe Reader) do not support forward search at all,
25901 some other viewers – e.
25902 \begin_inset space \thinspace{}
25906 xpdf – allow at least to reload the document and jump to a specific page of the file,
25907 so you can at least navigate
25908 \begin_inset Quotes eld
25912 \begin_inset Quotes erd
25916 This latter functionality is provided by an external call of synctex (see the predefined example configurations).
25920 \begin_layout Standard
25921 Forward search works both with DVI and PDF output.
25923 simply checks which preview format you have used before (i.
25924 \begin_inset space \thinspace{}
25928 which format is already there in the temporary directory) and chooses the appropriate configuration for the respective format.\SpecialChar LyX
25929 Features needing Extra Software
25932 \begin_layout Section
25933 Checking \SpecialChar TeX
25937 \begin_layout Standard
25943 \begin_layout Subsection
25947 \begin_layout Standard
25956 \begin_layout Plain Layout
25961 is not yet available when you are using the \SpecialChar LaTeX
25962 distribution MiK\SpecialChar TeX
25977 \begin_inset space ~
25988 \begin_inset Newline newline
25992 \begin_inset CommandInset href
25994 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
26002 \begin_layout Standard
26005 Chk\SpecialChar TeX
26008 package is a program that was written by
26009 \begin_inset Flex Noun
26012 \begin_layout Plain Layout
26014 \begin_inset space ~
26022 in frustration because some constructs in \SpecialChar LaTeX
26023 are sometimes non-intuitive,
26024 and easy to forget.
26025 The program runs over your \SpecialChar LaTeX
26027 checks the integrity of the file,
26028 and flags some common errors.
26029 In other technical words,
26034 for \SpecialChar LaTeX
26038 \begin_layout Standard
26040 what is a syntax checker doing in \SpecialChar LyX
26041 which is supposed to produce correct \SpecialChar LaTeX
26043 The answer is simple:
26048 not only checks the
26057 checks for type-errors,
26060 Chk\SpecialChar TeX
26063 catches some common
26068 in addition to the syntactical ones.
26072 Chk\SpecialChar TeX
26075 is capable of detecting several common errors,
26079 \begin_layout Itemize
26080 Ellipsis detection:
26081 \begin_inset Newline newline
26084 Use \SpecialChar ldots
26088 \begin_layout Itemize
26089 No space in front of/after parenthesis:
26090 \begin_inset Newline newline
26096 \begin_layout Itemize
26097 Enforcement of normal space after common abbreviations:
26098 \begin_inset Newline newline
26102 \begin_inset space \thinspace{}
26106 \begin_inset space \space{}
26109 is too wide spacing.
26112 \begin_layout Itemize
26113 Enforcement of end-of-sentence space when the last sentence ends with a capital letter:
26114 \begin_inset Newline newline
26118 And this is wrong spacing.
26121 \begin_layout Itemize
26122 Space in front of labels and similar commands:
26123 \begin_inset Newline newline
26126 The label should stick right up to the text to avoid falling to a wrong page.
26128 \begin_inset CommandInset label
26138 \begin_layout Plain Layout
26139 This footnote is in danger of falling off to a wrong page
26144 The label is separated too much.
26147 \begin_layout Itemize
26148 Space in front of references,
26149 instead of hard spaces:
26150 \begin_inset Newline newline
26153 If you have bad luck,
26154 the text will break right between the referenced text and reference number,
26157 \begin_inset CommandInset ref
26159 reference "sec:chktex"
26167 \begin_layout Itemize
26169 \begin_inset Quotes eld
26173 \begin_inset Quotes erd
26177 \begin_inset Formula $\times$
26181 \begin_inset Newline newline
26184 2x2 looks cheap compared to
26185 \begin_inset Formula $2\times2$
26191 \begin_layout Standard
26192 and more \SpecialChar ldots
26193 It is an invaluable tool when you are
26194 \begin_inset Quotes eld
26198 \begin_inset Quotes erd
26201 your document before printing,
26202 and you should run it right after the obligatory spelling check,
26203 and before you go fine tuning the typesetting.
26206 \begin_layout Subsection
26210 \begin_layout Standard
26211 If you have the program installed,
26212 usage is as simple as choosing
26214 Tools\SpecialChar menuseparator
26216 \begin_inset space ~
26222 This will make \SpecialChar LyX
26223 generate a \SpecialChar LaTeX
26224 file of your document,
26227 Chk\SpecialChar TeX
26231 and then make \SpecialChar LyX
26233 \begin_inset Quotes eld
26237 \begin_inset Quotes erd
26240 with the warnings from
26242 Chk\SpecialChar TeX
26247 The warnings will be placed close to the point of the mistake,
26248 and you can quickly find them by using the
26250 Navigate\SpecialChar menuseparator
26254 or the shortcut key
26263 Open the error boxes by clicking on them with the mouse,
26264 or use the shortcut key
26273 or the corresponding
26282 Read the warning and correct the mistake,
26283 if it is a mistake.
26284 If you have trouble understanding what the warning is about,
26285 you can safely ignore it.
26286 Remember that there is a hidden layer between the document on screen and the technical details in invoking
26288 Chk\SpecialChar TeX
26292 and this gap can make some warnings seem arcane or just plain silly.
26295 \begin_layout Standard
26296 This document is an excellent testing bed for the feature,
26297 and it should provide quite a few warnings for you to fiddle with.
26298 Since computers are only so smart,
26299 expect most of the warnings to be false alarms,
26303 \begin_layout Subsection
26304 How to fine tune it
26307 \begin_layout Standard
26311 Chk\SpecialChar TeX
26314 makes more noise than suits your mood.
26315 Then you can choose not to use it,
26316 wait until your mood changes,
26317 or try to customize
26319 Chk\SpecialChar TeX
26322 to get better along with you.
26325 \begin_layout Standard
26328 Chk\SpecialChar TeX
26335 very configurable and extensible,
26336 you should not expect to solve all problems with
26338 Chk\SpecialChar TeX
26341 in \SpecialChar LyX
26343 Since \SpecialChar LyX
26344 has to generate a somewhat special \SpecialChar LaTeX
26345 file to be able to match the line numbers from the
26347 Chk\SpecialChar TeX
26354 \begin_layout Plain Layout
26355 You can inspect the specific output from
26361 Document\SpecialChar menuseparator
26364 \begin_inset space ~
26378 to the internal document structure,
26379 some of the warnings will not appear correctly.
26380 There are two things you can do about this:
26383 \begin_layout Itemize
26386 Chk\SpecialChar TeX
26389 invocation command line in
26391 Tools\SpecialChar menuseparator
26392 Preferences\SpecialChar menuseparator
26393 Output\SpecialChar menuseparator
26394 LaTeX\SpecialChar menuseparator
26400 Chk\SpecialChar TeX
26403 installation configuration file (usually with the file
26408 See below to learn what warnings can be enabled and disabled on the command line.
26411 \begin_layout Itemize
26412 Export your document as a raw \SpecialChar LaTeX
26415 File\SpecialChar menuseparator
26416 Export\SpecialChar menuseparator
26425 Invoked in this way,
26426 it can be a hassle to find the corresponding place in the document inside \SpecialChar LyX
26428 but with a little patience,
26429 you should be able to do it.
26432 \begin_layout Standard
26433 Here follows the warning messages that can be enabled and disabled in
26442 to disable a warning,
26447 to enable a warning.
26448 The emphasized entries are disabled by default,
26449 because the default is "
26451 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
26456 \begin_layout Standard
26457 Notice that you should only use the options that enable and disable warnings,
26458 because \SpecialChar LyX
26459 relies on some of the other command line parameters to be set in a specific way to have a chance to communicate with
26466 \begin_layout Enumerate
26470 Command terminated with space.
26473 \begin_layout Enumerate
26476 Non-breaking space (
26477 \begin_inset Quotes eld
26485 \begin_inset Quotes erd
26488 ) should have been used.
26491 \begin_layout Enumerate
26495 You should enclose the previous parenthesis with
26496 \begin_inset Quotes eld
26504 \begin_inset Quotes erd
26510 \begin_layout Enumerate
26513 Italic correction (
26514 \begin_inset Quotes eld
26524 \begin_inset Quotes erd
26527 ) found in non-italic buffer.
26530 \begin_layout Enumerate
26533 Italic correction (
26534 \begin_inset Quotes eld
26544 \begin_inset Quotes erd
26547 ) found more than once.
26550 \begin_layout Enumerate
26554 No italic correction (
26555 \begin_inset Quotes eld
26565 \begin_inset Quotes erd
26571 \begin_layout Enumerate
26575 \begin_inset Quotes eld
26583 \begin_inset Quotes erd
26587 \begin_inset Quotes eld
26595 \begin_inset Quotes erd
26601 \begin_layout Enumerate
26604 Wrong length of dash may have been used.
26607 \begin_layout Enumerate
26611 \begin_inset Quotes eld
26619 \begin_inset Quotes erd
26624 \begin_inset Quotes eld
26632 \begin_inset Quotes erd
26638 \begin_layout Enumerate
26642 \begin_inset Quotes eld
26650 \begin_inset Quotes erd
26656 \begin_layout Enumerate
26660 \begin_inset Quotes eld
26668 \begin_inset Quotes erd
26671 to achieve an ellipsis.
26674 \begin_layout Enumerate
26677 Inter-word spacing (
26678 \begin_inset Quotes eld
26688 \begin_inset Quotes eld
26691 ) should perhaps be used.
26694 \begin_layout Enumerate
26697 Inter-sentence spacing (
26698 \begin_inset Quotes eld
26708 \begin_inset Quotes erd
26711 ) should perhaps be used.
26714 \begin_layout Enumerate
26717 Could not find argument for command.
26720 \begin_layout Enumerate
26724 \begin_inset Quotes eld
26732 \begin_inset Quotes erd
26738 \begin_layout Enumerate
26741 Math mode still on at end of \SpecialChar LaTeX
26745 \begin_layout Enumerate
26749 \begin_inset Quotes eld
26757 \begin_inset Quotes erd
26760 doesn't match the number of
26761 \begin_inset Quotes eld
26769 \begin_inset Quotes erd
26775 \begin_layout Enumerate
26778 You should use either
26781 \begin_inset Quotes eld
26789 \begin_inset Quotes erd
26794 as an alternative to
26795 \begin_inset Quotes eld
26803 \begin_inset Quotes erd
26809 \begin_layout Enumerate
26816 " (ASCII 39) instead of "
26823 \begin_layout Enumerate
26826 User-specified pattern found.
26829 \begin_layout Enumerate
26832 This command might not be intended.
26835 \begin_layout Enumerate
26842 \begin_layout Enumerate
26860 \begin_layout Enumerate
26863 Delete this space to maintain correct page references.
26866 \begin_layout Enumerate
26870 You might wish to put this between a pair of
26871 \begin_inset Quotes eld
26879 \begin_inset Quotes erd
26885 \begin_layout Enumerate
26888 You ought to remove spaces in front of punctuation.
26891 \begin_layout Enumerate
26894 Could not execute \SpecialChar LaTeX
26898 \begin_layout Enumerate
26907 in front of small punctuation.
26910 \begin_layout Enumerate
26918 may look prettier here.
26921 \begin_layout Enumerate
26925 Multiple spaces detected in output.
26928 \begin_layout Enumerate
26931 This text may be ignored.
26934 \begin_layout Enumerate
26940 \begin_inset Quotes eld
26945 to begin quotation,
26953 \begin_layout Enumerate
26964 \begin_inset Quotes eld
26972 \begin_layout Enumerate
26978 \begin_layout Enumerate
26981 You should perhaps use
26982 \begin_inset Quotes eld
26990 \begin_inset Quotes erd
26996 \begin_layout Enumerate
26999 You should put a space in front of/after parenthesis.
27002 \begin_layout Enumerate
27005 You should avoid spaces in front of/after parenthesis.
27008 \begin_layout Enumerate
27012 You should not use punctuation in front of/after quotes.
27015 \begin_layout Enumerate
27018 Double space found.
27021 \begin_layout Enumerate
27024 You should put punctuation outside inner/inside display math mode.
27027 \begin_layout Enumerate
27030 You ought to not use primitive \SpecialChar TeX
27031 in \SpecialChar LaTeX
27035 \begin_layout Enumerate
27038 You should remove spaces in front of
27039 \begin_inset Quotes eld
27047 \begin_inset Quotes erd
27053 \begin_layout Enumerate
27056 \begin_inset Quotes eld
27064 \begin_inset Quotes erd
27067 is normally not followed by
27068 \begin_inset Quotes eld
27076 \begin_inset Quotes erd
27082 \begin_layout Standard
27083 In later versions of \SpecialChar LyX
27085 we hope to provide a more complete interface to this tool (and it's smaller cousin
27089 ) to exploit the full power of it.
27090 But it's not exactly useless as it is now:
27091 go try it on one of your existing documents of a certain length and be surprised.
27094 \begin_layout Section
27095 Version Control in \SpecialChar LyX
27099 \begin_layout Standard
27102 Lars Gullik Bjønnes
27109 \begin_layout Subsection
27113 \begin_layout Standard
27115 supports some of the most basic RCS/CVS/SVN/GIT commands.
27116 If you need something a bit more sophisticated you will have to do that manually in a terminal or your favourite client.
27119 \begin_layout Standard
27120 Also note that CVS support is not as good as subversion support,
27121 so we advise using SVN instead.
27122 A good place to start learning Subversion is the SVN Book
27126 \begin_layout Plain Layout
27127 \begin_inset CommandInset href
27129 target "http://svnbook.red-bean.com/"
27140 In the case of RCS you should read
27141 \begin_inset Quotes eld
27145 \begin_inset Quotes erd
27154 This file describes all the basic features of RCS.
27155 You should especially notice the comment about a RCS directory,
27156 and the notion of a master RCS file (the file ending in
27163 \begin_layout Standard
27164 Before you begin to use the version control features in \SpecialChar LyX
27166 you should be familiar with RCS/CVS/SVN/GIT usage.
27167 The implementation in \SpecialChar LyX
27168 assumes a recent version of the GNU RCS or CVS/SVN package —
27169 no guarantees are made for older versions.
27170 Most of the log messages are not currently displayed after operations —
27171 you can check them in the Messages pane if you are unsure.
27172 Regular users of version control will appreciate the VC toolbar,
27173 which can be enabled via
27175 View\SpecialChar menuseparator
27176 Toolbars\SpecialChar menuseparator
27178 \begin_inset space ~
27186 \begin_layout Standard
27187 For introducing your own external commands consult
27188 \begin_inset Flex Code
27191 \begin_layout Plain Layout
27205 \begin_layout Standard
27206 It is strongly recommended to store documents in uncompressed format if using version control (uncheck
27208 Document\SpecialChar menuseparator
27212 Uncompressed LyX documents are text files and therefore for merging two different versions by version control systems.
27213 Compressed LyX documents are binary files,
27214 which cannot be merged by version control systems.
27215 Also to avoid unnecessary merge conflicts we advise to disable
27217 Document\SpecialChar menuseparator
27218 Settings\SpecialChar menuseparator
27219 Output\SpecialChar menuseparator
27220 Save transient properties
27222 when more users work on the same document.
27225 \begin_layout Subsection
27226 RCS commands in \SpecialChar LyX
27230 \begin_layout Standard
27231 The following sections describe the RCS commands supported by \SpecialChar LyX
27233 You can find them in the
27235 File\SpecialChar menuseparator
27237 \begin_inset space ~
27244 was tested against RCS 5.7/5.8/5.10.
27247 \begin_layout Subsubsection
27253 \begin_layout Standard
27254 If your document is not under revision control,
27255 this is the only item shown in the menu.
27256 And if it is under revision control,
27261 item is not visible.
27265 \begin_layout Standard
27266 This command registers your document with RCS (unless you are under the directory managed by CVS)\SpecialChar endofsentence
27267 You are asked interactively to supply an initial description of the document.
27268 The document is now set in Read-Only mode and you have to
27271 \begin_inset space ~
27275 \begin_inset space ~
27279 \begin_inset space ~
27285 before making any changes to it.
27286 A document under revision control has a
27287 \begin_inset Quotes eld
27290 [RCS:<version> <locker>]
27291 \begin_inset Quotes erd
27294 item tagged to the filename in the minibuffer.
27297 \begin_layout Standard
27298 RCS command that is run:
27301 \begin_layout LyX-Code
27304 ci -q -u -i -t-"<initial description>" <file-name>
27307 \begin_layout Standard
27312 to understand the switches.
27316 \begin_layout Subsubsection
27322 \begin_layout Standard
27323 When you are finished editing a file,
27324 you check in your changes.
27326 you are asked for a description of the changes.
27327 This is stored in the history log.
27328 The version number is bumped,
27329 your changes are applied to the master RCS file,
27330 the document is unlocked and set to Read-Only mode.
27333 \begin_layout Itemize
27337 ci -q -u -m"<description>" <file-name>
27340 \begin_layout Subsubsection
27346 \begin_layout Standard
27347 By doing this you lock the document so that only you can edit it.
27348 This will also make the document Read-Write only for you.
27349 You will usually continue editing for a while and when you are finished you check in your changes.
27350 The status line is changed to reflect that you have locked the file.
27353 \begin_layout Itemize
27357 co -q -l <file-name>
27360 \begin_layout Subsubsection
27363 Revert To Repository Version
27366 \begin_layout Standard
27367 This will discard all changes made to the document since the last check in.
27368 You get a warning before changes are discarded.
27371 \begin_layout Itemize
27375 co -f -u<version> <file-name>
27378 \begin_layout Subsubsection
27384 \begin_layout Standard
27385 This will create a copy of the current document.
27386 Since RCS does not support copy operations natively,
27387 the version history is not preserved,
27388 and the copy is added as a new file.
27389 It requires a clean document without any changes since the last checkin.
27390 You are asked for a file name and a description of the copy operation.
27391 After that the copy is created,
27392 both locally and in the repository.
27393 If the parent directories of the copied and original document differ,
27394 all relative paths of included files of the copy are adjusted (like in
27396 File\SpecialChar menuseparator
27402 the copy is loaded instead of the original document.
27405 \begin_layout Labeling
27406 \labelwidthstring 00.00.0000
27408 \begin_inset space ~
27413 \begin_inset space ~
27417 \begin_inset Newline newline
27421 \begin_inset Flex Code
27424 \begin_layout Plain Layout
27427 \begin_inset Quotes qld
27431 \begin_inset Quotes qld
27440 \begin_inset Flex Code
27443 \begin_layout Plain Layout
27446 \begin_inset Quotes qld
27450 \begin_inset Quotes qld
27459 \begin_inset Newline newline
27463 \begin_inset Flex Code
27466 \begin_layout Plain Layout
27470 \begin_inset Quotes qld
27474 \begin_inset Quotes qld
27485 \begin_layout Subsubsection
27491 \begin_layout Standard
27492 This makes as if the last check in never happened.
27493 No changes are made to the document loaded into \SpecialChar LyX
27495 but the last version is removed from the master RCS file.
27498 \begin_layout Itemize
27502 rcs -o<version> <file-name>
27505 \begin_layout Subsubsection
27511 \begin_layout Standard
27512 This shows the complete history of the RCS document.
27517 is shown in a browser.
27525 \begin_layout Subsubsection
27529 \begin_layout Standard
27531 supports RCS version number,
27533 date and time of last commit.
27534 All those are extracted from
27536 rlog -r <file-name>
27540 \begin_inset CommandInset ref
27542 reference "subsec:VCS-Revision-Information"
27550 \begin_layout Subsection
27551 CVS commands in \SpecialChar LyX
27555 \begin_layout Standard
27556 A subset of CVS operations is supported by \SpecialChar LyX
27558 You can find the commands in the
27560 File\SpecialChar menuseparator
27562 \begin_inset space ~
27568 The version control system SVN is more powerful,
27569 so please use it instead of CVS if possible.
27572 \begin_layout Subsubsection
27578 \begin_layout Standard
27579 If you start from scratch with CVS you have to create your repository and checkout the working copy with external tools.
27580 If you're using a client-server setup you may need to login before doing the first repository checkout.
27583 \begin_layout Standard
27584 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.
27585 Standard CVS repositories don't operate with a file locking mechanism.
27586 This may be surprising,
27587 but conflicts only occur if people disagree on the proper content of the same part of a document.
27589 if co-workers are used to communicate regularly,
27590 these conflicts occur rarely.
27591 If they don't communicate they have a fundamental problem anyway.
27592 Nevertheless some people like to work with so called
27593 \begin_inset Quotes eld
27597 \begin_inset Quotes erd
27601 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.
27602 When the changes are checked in the working copy returns to readonly state.
27603 With \SpecialChar LyX
27604 one has to edit the
27605 \begin_inset Flex Code
27608 \begin_layout Plain Layout
27614 file and add the line
27615 \begin_inset Flex Code
27618 \begin_layout Plain Layout
27624 to work with reserved checkouts.
27625 The benefit is the possibility to see who is using a writable copy of some document.
27626 It's not guaranteed only one user makes a copy writable.
27629 \begin_layout Standard
27631 tries to guess if you're using reserved or non-reserved checkouts.
27632 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.
27633 When a reserved checkout is detected you have to use
27634 \begin_inset Flex Noun
27637 \begin_layout Plain Layout
27643 to make your working copy writable if it's readonly.
27645 \begin_inset Flex Noun
27648 \begin_layout Plain Layout
27654 operation is possible and that makes your working copy readonly again after transferring your changes to the repository.
27657 \begin_layout Standard
27658 More information about CVS can be found here
27659 \begin_inset Flex URL
27662 \begin_layout Plain Layout
27664 http://www.nongnu.org/cvs
27670 \begin_inset Flex URL
27673 \begin_layout Plain Layout
27675 http://ximbiot.com/cvs
27683 \begin_layout Standard
27688 to understand the sub-commands and the switches mentioned below.
27691 \begin_layout Subsubsection
27697 \begin_layout Standard
27698 If your document is not under revision control,
27699 this is the only item shown in the menu.
27700 And if it is under revision control,
27705 item is not visible.
27709 \begin_layout Standard
27710 This command registers in CVS your document
27711 \begin_inset Flex Strong
27714 \begin_layout Plain Layout
27722 in the case you have already the documents directory under CVS control (in particular
27727 This means you have to create or checkout the archive by yourself using external tools.
27728 (In case you forget that step \SpecialChar LyX
27729 registers the document with RCS.)
27732 \begin_layout Standard
27733 Then you are asked interactively to supply an initial description of the document.
27734 Don't forget that registered file is not yet checked in.
27737 \begin_layout Standard
27738 CVS command that is run:
27741 cvs -q add -m"<entered message>" "<file-name>"
27744 \begin_layout Standard
27749 above and for all other CVS commands is an abbreviation for
27750 \begin_inset Quotes eld
27753 change the current working directory to file location and use the file name without path component as argument
27754 \begin_inset Quotes erd
27760 \begin_layout Subsubsection
27766 \begin_layout Standard
27767 When you are finished editing a file,
27768 you commit your changes.
27769 When you do this and you had changed the document,
27770 you are asked for a description of the changes.
27771 After that changes are written to the repository.
27772 In case you didn't change the document and a reserved checkout is detected the reservation made on
27773 \begin_inset Flex Noun
27776 \begin_layout Plain Layout
27785 \begin_layout Labeling
27786 \labelwidthstring 00.00.0000
27788 \begin_inset space ~
27793 \begin_inset space ~
27797 \begin_inset Newline newline
27801 \begin_inset Flex Code
27804 \begin_layout Plain Layout
27807 -q commit -m"<description>" "<file-name>"
27813 \begin_inset Newline newline
27817 \begin_inset Flex Code
27820 \begin_layout Plain Layout
27831 \begin_layout Subsubsection
27837 \begin_layout Standard
27838 When you are sharing a repository with others,
27839 you may have to incorporate their changes into your working copy.
27842 \begin_layout Standard
27846 cvs -q update "<file-name>"
27849 \begin_layout Standard
27850 If a readonly checkout is detected the working copy is made writable and reserved.
27853 \begin_layout Standard
27857 cvs -q edit "<file-name>"
27860 \begin_layout Subsubsection
27863 Revert To Repository Version
27866 \begin_layout Standard
27867 This will discard all changes made to the document since the last check in.
27868 You get a warning before changes are discarded.
27869 Firstly the file is deleted,
27870 secondly CVS update command is run.
27873 \begin_layout Standard
27877 cvs -q update "<file-name>"
27880 \begin_layout Standard
27881 If a reserved checkout is detected and the working copy has no changes only the reservation is undone.
27884 \begin_layout Standard
27888 cvs -q unedit "<file-name>"
27891 \begin_layout Subsubsection
27897 \begin_layout Standard
27898 This will create a copy of the current document.
27899 Since CVS does not support copy operations natively,
27900 the version history is not preserved,
27901 and the copy is added as a new file.
27902 It requires a clean document without any changes since the last checkin.
27903 You are asked for a file name and a description of the copy operation.
27904 After that the copy is created,
27905 both locally and in the repository.
27906 If the parent directories of the copied and original document differ,
27907 all relative paths of included files of the copy are adjusted (like in
27909 File\SpecialChar menuseparator
27915 the copy is loaded instead of the original document.
27918 \begin_layout Labeling
27919 \labelwidthstring 00.00.0000
27921 \begin_inset space ~
27926 \begin_inset space ~
27930 \begin_inset Newline newline
27934 \begin_inset Flex Code
27937 \begin_layout Plain Layout
27944 \begin_inset Flex Code
27947 \begin_layout Plain Layout
27954 \begin_inset Newline newline
27958 \begin_inset Flex Code
27961 \begin_layout Plain Layout
27962 cvs -q add "<new-file-name>"
27970 \begin_layout Subsubsection
27976 \begin_layout Standard
27977 This will rename the current document.
27978 Since CVS does not support rename operations natively,
27979 the version history is not preserved,
27980 the renamed document is added as a new file,
27981 and the original document is deleted.
27982 It requires a clean document without any changes since the last checkin.
27983 You are asked for a file name and a description of the rename operation.
27984 After that the document is renamed,
27985 both locally and in the repository.
27986 If the parent directories of the new and old file names differ,
27987 all relative paths of included files are adjusted (like in
27989 File\SpecialChar menuseparator
27995 the document is reloaded using the new name.
27998 \begin_layout Labeling
27999 \labelwidthstring 00.00.0000
28001 \begin_inset space ~
28006 \begin_inset space ~
28010 \begin_inset Newline newline
28014 \begin_inset Flex Code
28017 \begin_layout Plain Layout
28024 \begin_inset Flex Code
28027 \begin_layout Plain Layout
28034 \begin_inset Newline newline
28038 \begin_inset Flex Code
28041 \begin_layout Plain Layout
28042 cvs -q add "<new-file-name>"
28048 \begin_inset Newline newline
28052 \begin_inset Flex Code
28055 \begin_layout Plain Layout
28056 cvs -q remove "<file-name>"
28064 \begin_layout Subsubsection
28065 Update of the local directory checkout from repository
28068 \begin_layout Standard
28069 Once your documents gets more complex,
28070 containing sub-documents and pictures,
28072 \begin_inset Flex Code
28075 \begin_layout Plain Layout
28081 files and so on using version control becomes more complicated.
28083 supports updating the whole tree in which resides the document.
28084 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.
28085 You have to organize the files structure so that all external files are in the same directory or subdirectories of the document.
28086 It's good practice anyway to store multipart documents in an extra directory.
28089 \begin_layout Standard
28091 \begin_inset Flex Code
28094 \begin_layout Plain Layout
28095 Update local directory from repository
28100 command updates the whole directory.
28101 If local changes are detected user is warned before update starts.
28102 In case of merge conflicts both versions of the conflicting document parts are placed in the final document.
28103 You have to review and correct the result of the merge.
28104 You'll find the conflicts enclosed in pairs of
28105 \begin_inset Flex Code
28108 \begin_layout Plain Layout
28115 \begin_inset Flex Code
28118 \begin_layout Plain Layout
28125 \begin_inset Flex Code
28128 \begin_layout Plain Layout
28135 The first part is your version as before the update operation with the document name prepended.
28136 The second one is the repository version with the version number after the sequence of
28137 \begin_inset Flex Code
28140 \begin_layout Plain Layout
28149 \begin_layout Labeling
28150 \labelwidthstring 00.00.0000
28152 \begin_inset space ~
28157 \begin_inset space ~
28161 \begin_inset Newline newline
28165 \begin_inset Flex Code
28168 \begin_layout Plain Layout
28177 (Ask if changes are detected.)
28178 \begin_inset Newline newline
28182 \begin_inset Flex Code
28185 \begin_layout Plain Layout
28197 \begin_layout Standard
28199 \begin_inset Flex Code
28202 \begin_layout Plain Layout
28208 stands for the path to the document.
28211 \begin_layout Subsubsection
28217 \begin_layout Standard
28218 This shows the complete history of the CVS document.
28221 cvs log "<file-name>"
28223 is shown in a browser.
28226 \begin_layout Subsubsection
28230 \begin_layout Standard
28232 supports CVS version number,
28234 date and time of last commit.
28235 All those are extracted from
28237 cvs log -r <file-name>
28241 \begin_inset CommandInset ref
28243 reference "subsec:VCS-Revision-Information"
28251 \begin_layout Subsection
28252 SVN commands in \SpecialChar LyX
28256 \begin_layout Standard
28257 SVN is now partially supported by \SpecialChar LyX
28259 You can find the commands in the
28261 File\SpecialChar menuseparator
28263 \begin_inset space ~
28269 Please note that if you use password protected access to repository via ssh,
28270 you will be asked in terminal window.
28272 was tested against SVN 1.5,
28278 \begin_layout Plain Layout
28279 Most of the commands will work with 1.4 too,
28281 \begin_inset CommandInset ref
28283 reference "subsec:SVN-Repo-Update"
28289 There seems to be currently unresolved permissions problem under SVN 1.8 with reverting changes when file is locked.
28297 \begin_layout Subsubsection
28303 \begin_layout Standard
28304 If your document is not under revision control,
28305 this is the only item shown in the menu.
28306 And if it is under revision control,
28311 item is not visible.
28314 \begin_layout Standard
28315 This command registers in SVN your document ONLY in case you have already the documents directory under SVN control (in particular
28320 This means you have to checkout the archive by yourself.
28323 \begin_layout Standard
28324 Then you are asked interactively to supply an initial description of the document.
28325 Don't forget that registered file is not yet commited.
28328 \begin_layout Standard
28329 SVN command that is run:
28333 \begin_inset Quotes qld
28337 \begin_inset Quotes qld
28343 \begin_layout Standard
28348 to understand the switches.
28351 \begin_layout Subsubsection
28357 \begin_layout Standard
28358 When you are finished editing a file,
28359 you commit your changes.
28361 you are asked for a description of the changes.
28362 After that changes are commited.
28365 \begin_layout Standard
28370 \begin_layout Plain Layout
28371 In case locking is not enabled.
28373 \begin_inset CommandInset ref
28375 reference "subsec:SVN-File-Locking"
28387 svn commit -q -m"<description>" <file-name>
28390 \begin_layout Subsubsection
28396 \begin_layout Standard
28397 Updates the changes of this file from the repository.
28398 Be sure you understand SVN merging and conflicts resolving before using this function,
28399 because all conflicts has to be resolved manually by you!
28402 \begin_layout Standard
28407 \begin_layout Plain Layout
28415 svn update --non-interactive
28416 \begin_inset Quotes qld
28420 \begin_inset Quotes qld
28426 \begin_layout Subsubsection
28429 Revert To Repository Version
28432 \begin_layout Standard
28433 This will discard all changes made to the document since the last check in.
28434 You get a warning before changes are discarded.
28437 \begin_layout Standard
28442 \begin_inset Quotes qld
28446 \begin_inset Quotes qld
28452 \begin_layout Subsubsection
28458 \begin_layout Standard
28459 This will create a copy of the current document including the version history.
28460 It requires a clean document without any changes since the last checkin.
28461 You are asked for a file name and a description of the copy operation.
28462 After that the copy is created,
28463 both locally and in the repository.
28464 If the parent directories of the copied and original document differ,
28465 all relative paths of included files of the copy are adjusted (like in
28467 File\SpecialChar menuseparator
28473 the copy is loaded instead of the original document.
28476 \begin_layout Labeling
28477 \labelwidthstring 00.00.0000
28479 \begin_inset space ~
28484 \begin_inset space ~
28488 \begin_inset Newline newline
28492 \begin_inset Flex Code
28495 \begin_layout Plain Layout
28499 \begin_inset Quotes qld
28503 \begin_inset Quotes qld
28507 \begin_inset Quotes qld
28511 \begin_inset Quotes qld
28520 \begin_inset Newline newline
28524 \begin_inset Flex Code
28527 \begin_layout Plain Layout
28536 \begin_layout Subsubsection
28542 \begin_layout Standard
28543 This will rename the current document including the version history.
28544 It requires a clean document without any changes since the last checkin.
28545 You are asked for a file name and a description of the rename operation.
28546 After that the document is renamed,
28547 both locally and in the repository.
28548 If the parent directories of the new and old file names differ,
28549 all relative paths of included files are adjusted (like in
28551 File\SpecialChar menuseparator
28557 the document is reloaded using the new name.
28560 \begin_layout Labeling
28561 \labelwidthstring 00.00.0000
28563 \begin_inset space ~
28568 \begin_inset space ~
28572 \begin_inset Newline newline
28576 \begin_inset Flex Code
28579 \begin_layout Plain Layout
28583 \begin_inset Quotes qld
28587 \begin_inset Quotes qld
28591 \begin_inset Quotes qld
28595 \begin_inset Quotes qld
28604 \begin_inset Newline newline
28608 \begin_inset Flex Code
28611 \begin_layout Plain Layout
28620 \begin_layout Subsubsection
28621 \begin_inset CommandInset label
28623 name "subsec:SVN-Repo-Update"
28627 Update of the local directory checkout from repository
28631 \begin_layout Plain Layout
28632 Note that this command will work only with subversion
28633 \begin_inset Formula $\geqq1.5$
28644 \begin_layout Standard
28645 All the commands above have one shortcoming – they deal with the current document only.
28646 Once your document contains pictures,
28648 \begin_inset Flex Code
28651 \begin_layout Plain Layout
28657 files and so on administration becomes more complicated.
28659 now supports updating the whole tree in which resides the document
28663 \begin_layout Plain Layout
28664 One need to organize the files structure so that all external files are in the same directory or subdirectories of the document.
28671 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.
28675 \begin_layout Standard
28676 \begin_inset Flex Code
28679 \begin_layout Plain Layout
28680 Update local directory from repository
28685 command updates the whole directory and in case of merge conflicts local version of the files are left,
28686 so no unintended data loss occurs.
28687 If local changes are detected user is warned before update starts.
28690 \begin_layout Labeling
28691 \labelwidthstring 00.00.0000
28693 \begin_inset space ~
28698 \begin_inset space ~
28702 \begin_inset Newline newline
28706 \begin_inset Flex Code
28709 \begin_layout Plain Layout
28715 (Ask if changes are detected.)
28716 \begin_inset Newline newline
28720 \begin_inset Flex Code
28723 \begin_layout Plain Layout
28724 svn update --accept mine-full $path
28732 \begin_layout Standard
28734 \begin_inset Flex Code
28737 \begin_layout Plain Layout
28743 stands for the path to the document.
28746 \begin_layout Subsubsection
28752 \begin_layout Standard
28753 This shows the complete history of the SVN document.
28757 \begin_inset Quotes qld
28761 \begin_inset Quotes qld
28766 is shown in a browser.
28769 \begin_layout Subsubsection
28771 \begin_inset CommandInset label
28773 name "subsec:SVN-File-Locking"
28780 \begin_layout Standard
28781 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.
28782 When such a conflict happens it needs manual resolving and one reasonable alternative is to provide some kind of locking mechanism,
28783 which guarantees that only one user is allowed to edit file at the given time.
28786 \begin_layout Standard
28787 SVN has two such mechanisms to provide mutual exclusivity for file access – locks and automatic setting of write permissions (see sec.
28789 \begin_inset CommandInset ref
28791 reference "subsec:Automatical-Locking-Property"
28797 \begin_inset Flex Code
28800 \begin_layout Plain Layout
28810 \begin_layout Plain Layout
28811 \begin_inset Flex URL
28814 \begin_layout Plain Layout
28816 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
28827 If this property is detected for a given document \SpecialChar LyX
28828 starts to use SVN locks for document editing automatically and the whole check-in/out mechanism switches to the same regimen as for RCS.
28829 This in particular means there are two different modes of file use in \SpecialChar LyX
28833 \begin_layout Itemize
28835 The loaded file is in the read-only mode.
28836 For editing on needs to check-out.
28841 consists of updating from the repository and gaining write lock.
28842 If the lock is not possible to obtain,
28843 we remain in unlocked state.
28846 \begin_layout Itemize
28848 The loaded file is in the
28849 \begin_inset Quotes els
28853 \begin_inset Quotes ers
28857 No other user is allowed to edit the file.
28862 consists of commiting changes and releasing write-lock.
28863 If no changes have been made to the document,
28864 no commit will be produced
28868 \begin_layout Plain Layout
28869 Don't be puzzled by the fact that you will be asked for commit message anyway.
28874 and only the write-lock will be released.
28877 \begin_layout Standard
28881 \begin_layout Labeling
28882 \labelwidthstring 00.00.0000
28886 svn commit -q -m"<description>" "<file-name>"
28887 \begin_inset Newline newline
28890 svn unlock "<file-name>"
28893 \begin_layout Labeling
28894 \labelwidthstring 00.00.0000
28898 svn update "<file-name>"
28899 \begin_inset Newline newline
28902 svn lock "<file-name>"
28905 \begin_layout Subsubsection
28908 \begin_inset CommandInset label
28910 name "subsec:Automatical-Locking-Property"
28916 Automatic Locking Property
28919 \begin_layout Standard
28920 The above mentioned automatic setting of write permissions of the .lyx file can be set through
28922 File\SpecialChar menuseparator
28924 \begin_inset space ~
28927 Control\SpecialChar menuseparator
28928 Use Locking Property
28931 This command is active only when the file is not locked on the svn server (i.e.
28932 you need to check-out before proceeding).
28935 \begin_layout Labeling
28936 \labelwidthstring 00.00.0000
28938 \begin_inset space ~
28944 \begin_layout Labeling
28945 \labelwidthstring 00.00.0000
28949 svn propset svn:needs-lock ON "<file-name>"
28952 \begin_layout Labeling
28953 \labelwidthstring 00.00.0000
28957 svn propdel svn:needs-lock "<file-name>"
28960 \begin_layout Subsubsection
28961 \begin_inset CommandInset label
28963 name "subsec:VCS-Revision-Information"
28967 Revision Information in Documents
28970 \begin_layout Standard
28971 There are more possibilities how to activate revision information in our document.
28974 \begin_layout Itemize
28980 \begin_layout Itemize
28981 tree revision information (
28982 \begin_inset Flex Code
28985 \begin_layout Plain Layout
28992 The result is the output of the
28993 \begin_inset Flex Code
28996 \begin_layout Plain Layout
29003 the following table gives you an idea,
29004 how to read the results.
29007 \begin_layout Standard
29009 \begin_inset Tabular
29010 <lyxtabular version="3" rows="6" columns="2">
29011 <features tabularvalignment="middle">
29012 <column alignment="left" valignment="top">
29013 <column alignment="left" valignment="top">
29015 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
29018 \begin_layout Plain Layout
29026 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
29029 \begin_layout Plain Layout
29039 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
29042 \begin_layout Plain Layout
29048 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
29051 \begin_layout Plain Layout
29052 mixed revision working copy
29059 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
29062 \begin_layout Plain Layout
29068 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
29071 \begin_layout Plain Layout
29072 modified working copy
29079 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
29082 \begin_layout Plain Layout
29088 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
29091 \begin_layout Plain Layout
29092 switched working copy
29099 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
29102 \begin_layout Plain Layout
29108 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
29111 \begin_layout Plain Layout
29112 partial working copy,
29113 from a sparse checkout
29120 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
29123 \begin_layout Plain Layout
29129 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
29132 \begin_layout Plain Layout
29135 switched working copy
29148 \begin_layout Itemize
29149 file revision information.
29150 The result comes from parsing the output of
29151 \begin_inset Flex Code
29154 \begin_layout Plain Layout
29156 \begin_inset space ~
29160 \begin_inset space ~
29164 \begin_inset space ~
29173 Supported flags are:
29177 \begin_layout Itemize
29178 version number of the last commit (
29179 \begin_inset Flex Code
29182 \begin_layout Plain Layout
29191 \begin_layout Itemize
29192 author of the last commit (
29193 \begin_inset Flex Code
29196 \begin_layout Plain Layout
29205 \begin_layout Itemize
29206 date of the last commit (
29207 \begin_inset Flex Code
29210 \begin_layout Plain Layout
29219 \begin_layout Itemize
29220 time of the last commit (
29221 \begin_inset Flex Code
29224 \begin_layout Plain Layout
29234 \begin_layout Standard
29235 You can obtain this info via InsetInfo (
29237 Insert\SpecialChar menuseparator
29238 Field\SpecialChar menuseparator
29239 Version Control Revision
29242 The information will be available only when you have the file stored under svn managment (i.e.
29244 \begin_inset Flex Code
29247 \begin_layout Plain Layout
29253 directory is available with your document).
29257 \begin_layout Itemize
29260 possibility is to use svn keywords
29264 \begin_layout Plain Layout
29265 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
29271 In short – you set file keywords property (e.g.
29274 svn propset svn:keywords 'Rev' file.lyx
29276 ) and then paste keyword \SpecialChar TeX
29281 \begin_layout Plain Layout
29282 This is an easy way how to ensure that \SpecialChar LyX
29283 won't break the line in the middle of keyword tag.
29288 tag in your document (e.g.
29290 \begin_inset Flex Code
29293 \begin_layout Plain Layout
29300 This way svn client will automatically substitute revision number (e.g.
29302 \begin_inset Flex Code
29305 \begin_layout Plain Layout
29312 ) after each update and commit.
29313 There are more problems with this approach.
29315 the '$' character is used in \SpecialChar TeX
29316 world for math equations,
29317 so any occurence of math formula
29318 \begin_inset Formula $Rev$
29322 \begin_inset Formula $Rev:59$
29325 in your \SpecialChar LyX
29327 Similarly for other keywords like Id,
29331 Secondly svn output is dependent on your locales,
29332 so its very easy that svn would produce some problematic strings once Date is used.
29333 Thirdly you get the whole 'Rev:
29334 59' string in your document instead of the plain number.
29335 Until subversion implements user's custom keywords it will be hard to use this approach reliably or let \SpecialChar LyX
29336 to support it directly.
29339 \begin_layout Subsection
29340 SVN and Windows Environment
29343 \begin_layout Quote
29344 My inclination is to say that if the user cannot figure out the command line operations on their own fairly quickly,
29345 they would be well advised to use TortoiseSVN.
29352 \begin_layout Subsubsection
29356 \begin_layout Standard
29357 In addition to installing \SpecialChar LyX
29359 and having access to a Subversion repository,
29360 the user will need to install the Subversion client program.
29361 A Windows installer for the client program is available from
29362 \begin_inset CommandInset href
29365 target "http://www.collab.net/nonav/downloads/subversion/"
29371 The user may also want to install
29372 \begin_inset CommandInset href
29375 target "http://tortoisesvn.tigris.org/"
29381 which integrates Subversion operations into the context (rightclick) menu of Windows Explorer.
29382 Operations done outside \SpecialChar LyX
29383 will typically be more convenient using the Explorer context menu.
29384 Note that TortoiseSVN is not a replacement for the client program,
29385 which is what \SpecialChar LyX
29389 \begin_layout Subsubsection
29390 Bringing a document under Subversion control
29393 \begin_layout Standard
29394 Before a \SpecialChar LyX
29395 document can be brought under version control in Subversion,
29396 its parent directory needs to be under version control.
29397 If the document is being added to a project already in the repository,
29398 this is accomplished by checking the project out to the directory where the new document will be placed.
29399 If the project itself is not yet under version control (for instance,
29400 if this document starts a new project),
29401 the directory must be imported into the repository.
29402 This is done outside \SpecialChar LyX
29404 Both import and checkout are easily accomplished from the Explorer context menu using TortoiseSVN,
29405 or alternatively can be done using the command line client at a DOS prompt.
29406 The procedure for importing the project using TortoiseSVN is described below,
29407 assuming an existing repository and a new project being started in
29414 For information on using the Subversion client program,
29422 \begin_layout Enumerate
29429 in Windows Explorer,
29433 TortoiseSVN\SpecialChar menuseparator
29438 adjust the URL for the repository,
29442 \begin_layout Enumerate
29443 Right click the level of the repository under which you want to place the new project folder (typically the top level) and click
29447 Supply a name for the project folder and click OK.
29448 Add a message for the log file if desired,
29449 then click OK again.
29450 The new project folder should appear in the repository.
29452 click OK again to exit the repository browser.
29455 \begin_layout Enumerate
29456 Once again right click
29463 this time selecting SVN Checkout\SpecialChar ldots
29464 Select the URL of the project folder you just created in the repository,
29465 and set the checkout directory to
29473 You will be warned about a non-empty folder;
29474 click OK to proceed.
29475 You should now have a
29486 \begin_layout Enumerate
29487 Create or open your document in \SpecialChar LyX
29490 File\SpecialChar menuseparator
29492 \begin_inset space ~
29495 Control\SpecialChar menuseparator
29499 Add a log message and click OK to commit the document to version control.
29502 \begin_layout Standard
29503 From this point onward,
29504 you should have full functionality in the
29506 File\SpecialChar menuseparator
29508 \begin_inset space ~
29514 You also have the option of checking the document in and out,
29515 viewing its history,
29517 using the TortoiseSVN context menu in Windows Explorer or the Subversion client program from a command prompt.
29520 \begin_layout Subsubsection
29521 SSH tunnel used with SVN under Windows
29524 \begin_layout Standard
29525 Compared with Linux setting up an svn client to communicate over ssh under Windows is a rather troublesome task.
29526 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,
29527 also be prepared for a great deal of frustration\SpecialChar ldots
29531 \begin_layout Enumerate
29532 Get an svn client for windows,
29533 as described in the previous sections.
29534 When it is a fresh install run some svn command (e.g.
29536 \begin_inset Flex Code
29539 \begin_layout Plain Layout
29545 ) to create config files,
29546 which you will need to change later on.
29549 \begin_layout Enumerate
29550 Choose an ssh client for Windows.
29551 There are several possibilities,
29552 we will use the one from Putty tools
29556 \begin_layout Plain Layout
29557 \begin_inset Flex URL
29560 \begin_layout Plain Layout
29562 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
29573 You will need to set the connection up so that the client doesn't ask for any password from you.
29574 To keep things easy we will use only keys without any additional password protection etc.
29578 \begin_layout Enumerate
29580 \begin_inset Flex Code
29583 \begin_layout Plain Layout
29590 Save your private .ppk key file and put the public one on the server side.
29591 If the SVN server runs on Linux,
29592 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
29593 \begin_inset Quotes eld
29598 Public key for pasting into OpenSSH authorized_keys file
29601 \begin_inset Quotes erd
29604 edit field into the server's
29605 \begin_inset Flex Code
29608 \begin_layout Plain Layout
29609 ~/.ssh/authorized_keys
29615 \begin_inset Flex Code
29618 \begin_layout Plain Layout
29627 \begin_layout Enumerate
29629 \begin_inset Flex Code
29632 \begin_layout Plain Layout
29639 In the SVN config file
29643 \begin_layout Plain Layout
29644 Exact path depends on Windows version,
29645 usually somewhere around
29646 \begin_inset Flex Code
29649 \begin_layout Plain Layout
29652 Documents and Settings
29666 \begin_inset Flex Code
29669 \begin_layout Plain Layout
29689 \begin_inset Flex Code
29692 \begin_layout Plain Layout
29693 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
29702 \begin_layout Plain Layout
29703 It will usually take a lot of time to get exact command right and it depends on many things.
29704 For example do not have some remote server saved as a default session in Putty etc.
29706 try to connect via plink without SVN first.
29715 \begin_layout Enumerate
29716 Checkout the SVN archive,
29718 \begin_inset space \thinspace{}
29722 \begin_inset Newline newline
29726 \begin_inset Flex Code
29729 \begin_layout Plain Layout
29730 svn co svn+ssh://user@server/repository_path
29738 \begin_layout Subsubsection
29739 End-of-Line Conversions
29742 \begin_layout Standard
29743 When the collaborators are mixing Linux and Windows environments,
29745 will use different line endings inside the .lyx files.
29746 This is not a problem as far as \SpecialChar LyX
29747 functionality is concerned,
29748 but the commit diffs will be huge and merge-conflicts prone.
29749 Fortunately SVN itself knows
29753 \begin_layout Plain Layout
29754 \begin_inset Flex URL
29757 \begin_layout Plain Layout
29759 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
29769 how to deal with CR/LF problems when switching .lyx files to the
29770 \begin_inset Flex Code
29773 \begin_layout Plain Layout
29783 \begin_layout Plain Layout
29786 \begin_inset Flex Code
29789 \begin_layout Plain Layout
29790 svn propset svn:eol-style native FILE_NAME
29803 \begin_layout Subsection
29804 GIT commands in \SpecialChar LyX
29808 \begin_layout Standard
29809 A minimal subset of GIT commands is now supported by \SpecialChar LyX
29811 You can find the commands in the
29813 File\SpecialChar menuseparator
29815 \begin_inset space ~
29821 Please note that if you use password protected access to repository via ssh,
29822 you will be asked in terminal window.
29824 was tested against GIT 1.7/2.30.
29828 \begin_layout Plain Layout
29829 Windows users please note that you need to ensure that git is on the path.
29830 This can be set from within \SpecialChar LyX
29833 Tools\SpecialChar menuseparator
29834 Preferences\SpecialChar menuseparator
29835 Paths\SpecialChar menuseparator
29846 \begin_layout Standard
29847 One big difference of GIT and the other supported version control systems is the distributed nature of GIT:
29848 With traditional version control systems there is one central server which hosts the repository.
29849 Users commit their changes to the server,
29850 and get updates made by other users from it.
29852 users commit to a local repository.
29853 The local repository can be synchronized with one or more remote repositories using the
29854 \begin_inset Flex Code
29857 \begin_layout Plain Layout
29864 \begin_inset Flex Code
29867 \begin_layout Plain Layout
29875 does not interact in any way with remote GIT repositories.
29876 It works exclusively with the local repository in a very similar way as with a central CVS or SVN repository.
29877 If you use remote GIT repositories you need to do the
29878 \begin_inset Flex Code
29881 \begin_layout Plain Layout
29888 \begin_inset Flex Code
29891 \begin_layout Plain Layout
29897 operations with your favourite GIT client.
29900 \begin_layout Subsubsection
29906 \begin_layout Standard
29907 If your document is not under revision control,
29908 this is the only item shown in the menu.
29909 And if it is under revision control,
29914 item is not visible.
29917 \begin_layout Standard
29918 This command registers in GIT your document ONLY in case you have already the documents directory under GIT control (in particular
29926 \begin_layout Plain Layout
29931 *and* initial repository commit (or at least
29935 ) needs to be manually done.
29941 This means you have to checkout the archive by yourself.
29944 \begin_layout Standard
29945 Then you are asked interactively to supply an initial description of the document.
29946 Don't forget that registered file is not yet committed.
29949 \begin_layout Standard
29950 GIT command that is run:
29954 \begin_inset Quotes qld
29958 \begin_inset Quotes qld
29964 \begin_layout Standard
29969 to understand the switches.
29972 \begin_layout Subsubsection
29978 \begin_layout Standard
29979 When you are finished editing a file,
29980 you commit your changes.
29982 you are asked for a description of the changes.
29983 After that changes are committed.
29986 \begin_layout Standard
29990 git commit -q -m"<description>" <file-name>
29993 \begin_layout Subsubsection
29996 Revert To Repository Version
29999 \begin_layout Standard
30000 This will discard all changes made to the document since the last check in.
30001 You get a warning before changes are discarded.
30004 \begin_layout Standard
30009 \begin_inset Quotes qld
30013 \begin_inset Quotes qld
30019 \begin_layout Subsubsection
30025 \begin_layout Standard
30026 This will rename the current document including the version history.
30027 It requires a clean document without any changes since the last checkin.
30028 You are asked for a file name and a description of the rename operation.
30029 After that the document is renamed,
30030 both locally and in the repository.
30031 If the parent directories of the new and old file names differ,
30032 all relative paths of included files are adjusted (like in
30034 File\SpecialChar menuseparator
30040 the document is reloaded using the new name.
30043 \begin_layout Labeling
30044 \labelwidthstring 00.00.0000
30046 \begin_inset space ~
30051 \begin_inset space ~
30055 \begin_inset Newline newline
30059 \begin_inset Flex Code
30062 \begin_layout Plain Layout
30066 \begin_inset Quotes qld
30070 \begin_inset Quotes qld
30074 \begin_inset Quotes qld
30078 \begin_inset Quotes qld
30087 \begin_inset Newline newline
30091 \begin_inset Flex Code
30094 \begin_layout Plain Layout
30103 \begin_layout Subsubsection
30109 \begin_layout Standard
30110 This shows the complete history of the GIT document.
30114 \begin_inset Quotes qld
30118 \begin_inset Quotes qld
30123 is shown in a browser.
30126 \begin_layout Subsubsection
30130 \begin_layout Standard
30132 supports GIT hash number of the last commit to the file,
30133 its abbreviated form,
30135 date and time of last commit.
30136 All those are extracted from
30138 git log -n 1 --pretty=format:%H%n%h%n%an%n%ai
30141 Tree version information is obtained via
30143 git describe --abbrev --dirty --long
30147 \begin_inset CommandInset ref
30149 reference "subsec:VCS-Revision-Information"
30157 \begin_layout Subsection
30161 \begin_layout Standard
30162 With the recent addition of the
30163 \begin_inset Flex Code
30166 \begin_layout Plain Layout
30172 function \SpecialChar LyX
30173 power users are allowed to create their own commands for revision control.
30176 \begin_layout Standard
30177 As an example you can see how two TortoiseSVN commands could be integrated directly:
30180 \begin_layout Description
30183 \begin_inset Flex Code
30186 \begin_layout Plain Layout
30187 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
30195 \begin_layout Description
30198 \begin_inset Flex Code
30201 \begin_layout Plain Layout
30202 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
30210 \begin_layout Subsection
30211 Version control and Document comparison
30214 \begin_layout Standard
30215 One of the typical uses of version control is to inspect the changes between revisions,
30216 usually by creating
30217 \begin_inset Flex Code
30220 \begin_layout Plain Layout
30227 While this is useful for plain text files,
30228 it is much less useful in the case of \SpecialChar LyX
30230 which have more a complicated structure.
30231 Hence we provide binding to the Document comparison feature.
30232 There are two ways of calling this feature – either by direct call of
30233 \begin_inset Flex Code
30236 \begin_layout Plain Layout
30243 function (for details see \SpecialChar LyX
30244 functions manual) or by the toolbar icon
30258 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 '
30259 \begin_inset Flex Noun
30262 \begin_layout Plain Layout
30268 ' revisions back means comparison of the edited file with last commited revision).
30272 \begin_layout Standard
30273 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,
30274 numbers always point to the last number in RCS revision number,
30277 We don't currently support GIT addressing of revisions,
30278 one can just compare edited document with its revision X steps backs,
30279 where X is addressed as
30280 \begin_inset Flex Code
30283 \begin_layout Plain Layout
30292 \begin_layout Section
30293 \begin_inset CommandInset label
30295 name "sec:Literate-Programming"
30299 Literate Programming
30302 \begin_layout Standard
30307 (kayvan@sylvan.com)
30312 original documentation written by
30314 Edmar Wienskoski Jr.
30317 (edmar-w-jr@technologist.com)
30320 \begin_layout Subsection
30324 \begin_layout Standard
30325 The main purpose of this documentation is to show you how to use \SpecialChar LyX
30326 for literate programming,
30327 where it is assumed that you are familiar with this programming technique,
30329 \begin_inset Quotes eld
30333 \begin_inset Quotes erd
30337 \begin_inset Quotes eld
30341 \begin_inset Quotes erd
30345 If that is not the case,
30346 please follow the web links provided in the following sections.
30347 There is a lot of good documentation out there covering old development history to the latest tools tips.
30350 \begin_layout Standard
30351 It is also assumed that you are familiar with \SpecialChar LyX
30352 itself to a point that you are comfortable changing your \SpecialChar LyX
30354 and X resources file.
30355 If that is not the case please refer to other \SpecialChar LyX
30356 documentation to cover your specific needs.
30359 \begin_layout Subsection
30360 Literate Programming
30363 \begin_layout Standard
30364 From the Literate Programming FAQ:
30368 \begin_layout Quotation
30369 Literate programming is the combination of documentation and source together in a fashion suited for reading by human beings.
30371 literate programs should be enjoyable reading,
30374 I couldn't resist!) In general,
30375 literate programs combine source and documentation in a single file.
30376 Literate programming tools then parse the file to produce either readable documentation or compilable source.
30377 The WEB style of literate programming was created by D.
30378 \begin_inset space \thinspace{}
30382 Knuth during the development of his \SpecialChar TeX
30383 typesetting software.
30387 \begin_layout Standard
30388 Another excerpt says:
30391 \begin_layout Quotation
30394 How is literate programming different from verbose commenting?
30397 \begin_layout Quotation
30398 There are three distinguishing characteristics.
30399 In order of importance,
30405 \begin_layout Itemize
30406 flexible order of elaboration
30409 \begin_layout Itemize
30410 automatic support for browsing
30413 \begin_layout Itemize
30414 typeset documentation,
30415 especially diagrams and mathematics
30419 \begin_layout Standard
30420 Now that I sparked your curiosity,
30421 take a look in the references.
30424 \begin_layout Subsubsection
30428 \begin_layout Standard
30429 The complete Literate Programming FAQ can be found at:
30432 \begin_layout Quote
30433 Literate Programming FAQ
30434 \begin_inset Flex URL
30437 \begin_layout Plain Layout
30439 http://www.literateprogramming.com/lpfaq.pdf
30447 \begin_layout Standard
30448 The FAQ lists 23 (twenty three!) different literate programming tools.
30449 Where some are specialized or
30450 \begin_inset Quotes eld
30454 \begin_inset Quotes erd
30457 for particular programming languages,
30458 while other have general scope.
30463 for my own use for several reasons:
30466 \begin_layout Itemize
30467 It can generate the documentation either in \SpecialChar LaTeX
30471 \begin_layout Itemize
30472 It has a open architecture,
30474 \begin_inset space \thinspace{}
30478 \begin_inset space \space{}
30481 it is easy to plug in new filters
30485 \begin_layout Plain Layout
30490 are programs that read a given data stream and output a manipulated data stream.
30492 a WEB file (consisting of literate code) can be turned into a file consisting only of C program code or \SpecialChar LaTeX
30498 and to perform special processing that you may need.
30502 \begin_layout Itemize
30503 There is a good selection of filters available already (the HTML is one of them).
30506 \begin_layout Itemize
30510 \begin_layout Standard
30511 The Noweb web page can be found at:
30515 \begin_layout Quote
30517 \begin_inset Flex URL
30520 \begin_layout Plain Layout
30522 https://www.cs.tufts.edu/~nr/noweb/
30530 \begin_layout Standard
30531 Starting from there you can reach many other interesting links and even some literate program examples.
30534 \begin_layout Subsection
30536 and Literate Programming with Noweb
30539 \begin_layout Standard
30540 The \SpecialChar LyX
30541 support for Literate Programming is provided by using the generic \SpecialChar LyX
30542 converters mechanism.
30543 This support is provided in a
30544 \begin_inset Quotes eld
30548 \begin_inset Quotes erd
30553 \begin_inset space \thinspace{}
30557 \begin_inset space \space{}
30560 you will be able to use this new \SpecialChar LyX
30561 feature with some other literate programming tool of your choice by just changing your \SpecialChar LyX
30565 \begin_layout Subsubsection
30566 Generating documents and code (weaving and tangling)
30569 \begin_layout Paragraph
30570 Using the noweb module
30573 \begin_layout Standard
30574 If you have installed Noweb and \SpecialChar LyX
30576 whenever you open a new document,
30577 after you have chosen its document class,
30580 Document\SpecialChar menuseparator
30584 \begin_inset Quotes eld
30588 \begin_inset Quotes erd
30592 If Noweb is correctly installed,
30593 when you click on the
30594 \begin_inset Quotes eld
30598 \begin_inset Quotes erd
30603 \begin_inset Quotes eld
30607 \begin_inset Quotes erd
30610 module in the available list and you can add it to your document.
30613 \begin_layout Paragraph
30617 \begin_layout Standard
30619 enables you to write code with a custom inset named
30620 \begin_inset Flex Noun
30623 \begin_layout Plain Layout
30630 Noweb delimits chunks like this:
30633 \begin_layout LyX-Code
30637 \begin_layout LyX-Code
30641 \begin_layout LyX-Code
30645 \begin_layout LyX-Code
30649 \begin_layout LyX-Code
30653 \begin_layout Standard
30654 The problem is that whatever is written in between the << and the
30658 must be taken literally,
30660 \begin_inset space \thinspace{}
30664 \begin_inset space \space{}
30668 should be prevented from making any special interpretation of what has been written.
30669 This is also handled by
30670 \begin_inset Flex Noun
30673 \begin_layout Plain Layout
30680 that works like a normal text inset but has a free spacing capability.
30683 \begin_layout Standard
30685 you can also use the
30686 \begin_inset Quotes eld
30690 \begin_inset Quotes erd
30693 construct of Noweb in your chunks to add items to Noweb's identifier cross-reference:
30696 \begin_layout LyX-Code
30700 \begin_layout LyX-Code
30701 def some_function(args):
30704 \begin_layout LyX-Code
30705 "This is the doc string for this function."
30708 \begin_layout LyX-Code
30714 \begin_layout LyX-Code
30715 @ %def some_function
30718 \begin_layout Standard
30719 For an example of this usage and the resulting cross-reference output,
30720 look at the Literate python program in
30722 LIBDIR/examples/listerrors.lyx
30724 which should make this all clear.
30727 \begin_layout Paragraph
30728 Generating the documentation
30731 \begin_layout Standard
30732 At this point you already have a new document file with a proper document class,
30733 and with some code and text on it.
30735 The answer is simple,
30738 View\SpecialChar menuseparator
30743 Just like you would do for a plain document.
30744 No special procedure is required.
30747 \begin_layout Standard
30748 To help orientate you,
30749 I will now explain what happens inside \SpecialChar LyX
30753 \begin_layout Enumerate
30756 Update\SpecialChar menuseparator
30759 menu option is chosen,
30760 a \SpecialChar LaTeX
30766 \begin_layout Standard
30767 If the document is of any literate class the generated file will be named with an extension name defined by the
30768 \begin_inset Quotes eld
30772 \begin_inset Quotes erd
30775 format (defined in the Preferences panel),
30776 otherwise the file will have the usual
30784 \begin_layout Enumerate
30785 Note that the only difference so far is in the name of the file,
30786 no special processing is required by \SpecialChar LyX
30788 Given that you formatted the code using the
30789 \begin_inset Flex Noun
30792 \begin_layout Plain Layout
30800 takes care of the business.
30803 \begin_layout Enumerate
30804 If the document is of any literate class \SpecialChar LyX
30805 will then use the internal \SpecialChar LyX
30806 to Noweb converter,
30807 followed by the Noweb to \SpecialChar LaTeX
30812 \begin_layout Plain Layout
30813 The converters are defined in the
30815 Tools\SpecialChar menuseparator
30820 \begin_inset Quotes eld
30824 \begin_inset Quotes erd
30836 manual for general information about converters.
30841 to generate the \SpecialChar LaTeX
30846 \begin_layout Standard
30847 Otherwise it will just skip this step.
30851 \begin_layout Enumerate
30854 is invoked and the regular post processing continues as in a plain document.
30857 \begin_layout Standard
30858 Independence from a particular
30859 \begin_inset Quotes eld
30863 \begin_inset Quotes erd
30866 is easily achieved by changing the commands that are run by the various converters.
30869 \begin_layout Paragraph
30870 Generating the code
30873 \begin_layout Standard
30874 When the build menu option is chosen or the corresponding button in the toolbar is pressed,
30875 a \SpecialChar LaTeX
30876 file is generated just like step 1 above.
30884 This converter needs to be defined by the user and is not installed by default,
30885 though the Program format is.
30886 This converter (like any other converter) will have two parts:
30889 \begin_layout Enumerate
30890 The converter program itself.
30891 This program performs the conversion from the one format to the other (in this case,
30892 from the Noweb format to the Program pseudo-format).
30895 \begin_layout Enumerate
30896 The error log parser.
30897 This is a program whose sole purpose is to rewrite error messages in a format that \SpecialChar LyX
30899 This makes it possible for \SpecialChar LyX
30900 to place error boxes in the right places in the file buffer.
30903 \begin_layout Standard
30906 \begin_inset Quotes eld
30910 \begin_inset Quotes erd
30917 \begin_layout LyX-Code
30925 \begin_layout Standard
30926 This basically means that \SpecialChar LyX
30928 \begin_inset Quotes eld
30932 \begin_inset Quotes erd
30935 (a program or script) with the name of the Noweb file (normally a file in the \SpecialChar LyX
30936 temp directory) and the directory path of the original \SpecialChar LyX
30941 \begin_layout Standard
30942 This is an implementation of
30943 \begin_inset Quotes eld
30947 \begin_inset Quotes erd
30950 that you can place in a directory on your path:
30953 \begin_layout LyX-Code
30959 \begin_layout LyX-Code
30965 \begin_layout LyX-Code
30968 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
30971 \begin_layout Standard
30972 The next part of the converter setting is the
30973 \begin_inset Quotes eld
30977 \begin_inset Quotes erd
30980 which is to be set to
30983 \begin_layout LyX-Code
30986 parselog=$$s/scripts/listerrors
30989 \begin_layout Standard
30990 This will run any errors that are generated by the
30991 \begin_inset Quotes eld
30995 \begin_inset Quotes erd
30998 process through the
30999 \begin_inset Quotes eld
31003 \begin_inset Quotes erd
31009 \begin_layout Standard
31010 The build will normally take place in \SpecialChar LyX
31011 's temporary directory,
31012 so the files produced by the conversion will be in that directory.
31014 will copy out what it regards as the `main' file,
31019 conversion may produce several files,
31020 and so most of these would then be deleted when \SpecialChar LyX
31022 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.
31025 \begin_layout Paragraph
31026 Build instructions in the document
31029 \begin_layout Standard
31030 The last piece of the integration between \SpecialChar LyX
31032 \begin_inset Quotes eld
31036 \begin_inset Quotes erd
31041 the instructions for building your program should be embedded in a chunk of its own.
31043 \begin_inset Quotes eld
31047 \begin_inset Quotes erd
31050 above uses the notangle command to look for this chunk (called
31051 \begin_inset Quotes eld
31055 \begin_inset Quotes erd
31058 ) and runs its contents through
31059 \begin_inset Quotes eld
31063 \begin_inset Quotes erd
31069 \begin_layout Standard
31071 such a chunk would look something like this:
31074 \begin_layout LyX-Code
31078 \begin_layout LyX-Code
31080 \begin_inset Newline newline
31083 if [ -z "${NOWEB_SOURCE}" ]
31084 \begin_inset Newline newline
31090 \begin_layout LyX-Code
31091 NOWEB_SOURCE=myfile.nw
31092 \begin_inset Newline newline
31096 \begin_inset Newline newline
31100 code to extract files ...
31101 use NOWEB_OUTPUT_DIR here ...]
31102 \begin_inset Newline newline
31106 code to compile files ...]
31107 \begin_inset Newline newline
31113 \begin_layout Standard
31116 File\SpecialChar menuseparator
31117 Open Example\SpecialChar menuseparator
31118 Modules\SpecialChar menuseparator
31123 File\SpecialChar menuseparator
31124 Open Example\SpecialChar menuseparator
31125 Modules\SpecialChar menuseparator
31128 which implement versions of the
31129 \begin_inset Quotes eld
31133 \begin_inset Quotes erd
31136 program for some illustrations of how all of these pieces go together
31142 these files show off the language independency of the \SpecialChar LyX
31143 literate programming support since they are written in Python and Perl respectively.
31146 \begin_layout Subsubsection
31147 Configuring \SpecialChar LyX
31151 \begin_layout Standard
31152 All the Literate Programming support is configured by the
31154 Tools\SpecialChar menuseparator
31158 \begin_inset Quotes eld
31162 \begin_inset Quotes erd
31166 The important parts are:
31169 \begin_layout Description
31171 \begin_inset space ~
31175 \begin_inset Quotes eld
31179 \begin_inset Quotes erd
31183 \begin_inset space ~
31186 format Set up via the File Formats tab,
31187 this is where the Noweb-specific pieces are set up.
31197 the file extension is set to
31202 This tells \SpecialChar LyX
31203 to create a file with a
31207 extension in the first step of the conversion process.
31210 \begin_layout Description
31212 \begin_inset space ~
31220 \begin_inset space ~
31223 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).
31226 \begin_layout Description
31236 This converter performs the
31237 \begin_inset Quotes eld
31241 \begin_inset Quotes erd
31244 of the literate document.
31247 \begin_inset Quotes eld
31252 noweave -delay -index $$i > $$o
31255 \begin_inset Quotes erd
31261 \begin_layout Description
31271 \begin_inset Quotes eld
31275 \begin_inset Quotes erd
31280 the Converter is set to
31281 \begin_inset Quotes eld
31289 \begin_inset Quotes erd
31294 \begin_inset Newline newline
31298 \begin_inset Quotes eld
31303 parselog=$$s/scripts/listerrors
31306 \begin_inset Quotes erd
31312 \begin_layout Subsubsection
31316 \begin_layout Standard
31317 There is also a new function implemented in the \SpecialChar LyX
31320 \begin_inset Quotes eld
31323 server-goto-file-row" function,
31324 to be used with ddd/gdb or other debugger.
31328 \begin_layout Standard
31329 When debugging code with ddd/gdb,
31330 it is possible to invoke a text editor at the current execution position with a single key stroke.
31331 The default ddd configuration for that is shift-ctrl-V.
31332 It happens that you can define the editor command line invocation in ddd by accessing the
31334 Edit\SpecialChar menuseparator
31335 Preferences\SpecialChar menuseparator
31338 dialog and changing the "Edit Sources" entry.
31341 \begin_layout Standard
31342 I take advantage of the newly created \SpecialChar LyX
31343 server function and this ddd feature,
31345 \begin_inset Quotes eld
31349 \begin_inset Quotes erd
31355 \begin_layout LyX-Code
31356 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
31359 \begin_layout Standard
31361 whenever you are using ddd and find a point in the program that you want to edit,
31362 you just press shift-ctrl-V (in the ddd window),
31363 and ddd will forward this information to \SpecialChar LyX
31364 through the \SpecialChar LyX
31365 server and then the \SpecialChar LyX
31366 window will show the same file with the cursor at the same position ddd was pointing to.
31367 No more guessing or long scrolling to locate a point in the program back from debugging !
31370 \begin_layout Standard
31371 Note however that you must enable the \SpecialChar LyX
31372 server to get this feature working (it is disabled by default).
31374 \begin_inset space ~
31378 \begin_inset CommandInset ref
31380 reference "sec:Starting-the-Server"
31385 explains how to do that.
31388 \begin_layout Subsubsection
31392 \begin_layout Standard
31393 There are six new buttons that can be added to your \SpecialChar LyX
31395 Four of these buttons are short cuts to layout styles:
31418 one for the custom inset
31423 The last one is a short cut to the
31424 \begin_inset Quotes eld
31428 \begin_inset Quotes erd
31435 \begin_layout Standard
31437 has a range of buttons that are available for tool bar customization.
31438 In my toolbar I like to combine the six short cuts above with two more:
31443 \SpecialChar menuseparator
31448 \SpecialChar menuseparator
31455 Document\SpecialChar menuseparator
31456 View\SpecialChar menuseparator
31460 Here is how it looks like:
31463 \begin_layout LyX-Code
31467 \begin_layout LyX-Code
31471 \begin_layout LyX-Code
31472 Icon "layout Standard"
31475 \begin_layout LyX-Code
31476 Icon "layout Section"
31479 \begin_layout LyX-Code
31480 Icon "layout \SpecialChar LaTeX
31484 \begin_layout LyX-Code
31485 Icon "layout \SpecialChar LyX
31489 \begin_layout LyX-Code
31490 Icon "flex.insert Chunk"
31493 \begin_layout LyX-Code
31497 \begin_layout LyX-Code
31501 \begin_layout LyX-Code
31502 Icon "buffer-typeset"
31505 \begin_layout LyX-Code
31506 Icon "build-program"
31509 \begin_layout LyX-Code
31513 \begin_layout LyX-Code
31517 \begin_layout LyX-Code
31521 \begin_layout LyX-Code
31525 \begin_layout LyX-Code
31529 \begin_layout Subsubsection
31530 Colors customization
31533 \begin_layout Standard
31534 There are a number of colors in \SpecialChar LyX
31535 that can be customized in
31540 One of the things that bothers people is the \SpecialChar LaTeX
31542 The default color is red,
31543 since the chunks uses \SpecialChar LaTeX
31545 and there is a lot of chunks in literate documents,
31546 you may get tired of seeing everything in red.
31547 You can change it by going to the tabs
31557 \begin_layout Standard
31558 The next thing is the visible presence of the newline character in the screen.
31559 You can choose the color of this particular character and make it blend in the background.
31560 I recommend you choosing a color that is close to the background but not equal,
31561 that way you still can see it is there,
31562 but it is not bothering you anymore.
31565 \begin_layout Subsection
31570 \begin_layout Standard
31581 Help\SpecialChar menuseparator
31582 Specific Manuals\SpecialChar menuseparator
31587 File\SpecialChar menuseparator
31588 Open Example\SpecialChar menuseparator
31589 Modules\SpecialChar menuseparator
31594 Help\SpecialChar menuseparator
31595 Specific Manuals\SpecialChar menuseparator
31600 File\SpecialChar menuseparator
31601 Open Example\SpecialChar menuseparator
31602 Modules\SpecialChar menuseparator
31608 \begin_layout Standard
31609 \begin_inset CommandInset index_print
31610 LatexCommand printindex