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
3052 \begin_inset CommandInset label
3054 name "subsec:Hebrew"
3061 \begin_layout Standard
3062 The document classes
3080 document classes to facilitate the use of Hebrew in \SpecialChar LyX
3084 \begin_layout Subsection
3085 \begin_inset CommandInset label
3087 name "subsec:Japanese"
3091 Japanese (Standard Classes)
3094 \begin_layout Standard
3096 included a collection of several bundles that aim to facilitate typesetting Japanese documents.
3097 The bundles have been developed at different times,
3098 they thus support different typesetting engines and features.
3099 This collection is the oldest one.
3100 It adjusts the \SpecialChar LaTeX
3101 standard classes to requirements of Japanese typesetting,
3102 for horizontal and vertical writing.
3103 The collection includes
3106 \begin_inset space \thinspace{}
3115 \begin_inset space \thinspace{}
3125 \begin_inset space \thinspace{}
3134 \begin_inset space \thinspace{}
3144 \begin_inset space \thinspace{}
3147 (Japanese Standard Class)
3153 \begin_inset space \thinspace{}
3161 \begin_inset Quotes eld
3165 \begin_inset Quotes erd
3168 engines tailored for Japanese,
3170 and up\SpecialChar LaTeX
3174 \begin_layout Standard
3175 For the use with the more modern Lua\SpecialChar LaTeX
3177 the collection also includes dedicated classes
3180 \begin_inset space \thinspace{}
3183 (Standard Class for LuaTeX),
3185 \begin_inset space \thinspace{}
3188 (Standard Class for LuaTeX,
3191 \begin_inset space \thinspace{}
3194 (Standard Class for LuaTeX)
3200 \begin_inset space \thinspace{}
3203 (Standard Class for LuaTeX,
3210 \begin_inset space \thinspace{}
3213 (Japanese Standard Class for LuaTeX)
3219 \begin_inset space \thinspace{}
3222 (Japanese Standard Class for LuaTeX,
3234 \begin_layout Standard
3235 Templates for the Lua\SpecialChar LaTeX
3236 classes can be found in
3238 File\SpecialChar menuseparator
3241 in the respective category (
3258 \begin_layout Subsection
3259 \begin_inset CommandInset label
3261 name "subsec:Japanese-JS"
3265 Japanese (JS Bundle)
3268 \begin_layout Standard
3269 This collection includes improved versions of the classes included in
3271 Japanese (Standard Classes)
3274 \begin_inset space ~
3278 \begin_inset CommandInset ref
3280 reference "subsec:Japanese"
3288 \begin_inset space \thinspace{}
3296 \begin_inset space \thinspace{}
3302 A report class can be obtained by using
3305 \begin_inset space \thinspace{}
3316 Document\SpecialChar menuseparator
3317 Settings\SpecialChar menuseparator
3318 Document Class\SpecialChar menuseparator
3319 Class Options\SpecialChar menuseparator
3323 All these classes work with
3324 \begin_inset Quotes eld
3328 \begin_inset Quotes erd
3331 engines tailored for Japanese,
3333 and up\SpecialChar LaTeX
3337 \begin_layout Standard
3338 For the use with the more modern Lua\SpecialChar LaTeX
3340 the collection also includes dedicated classes
3342 Japanese Article (JS Bundle for LuaTeX),
3344 \begin_inset space \thinspace{}
3347 (JS Bundle for LuaTeX)
3353 \begin_inset space \thinspace{}
3367 \begin_layout Standard
3368 Templates for the Lua\SpecialChar LaTeX
3369 classes can be found in
3371 File\SpecialChar menuseparator
3374 in the respective category (
3391 \begin_layout Subsection
3392 \begin_inset CommandInset label
3394 name "subsec:Japanese-BX"
3398 Japanese (BX Bundle)
3401 \begin_layout Standard
3402 This bundle contains the document classes
3405 \begin_inset space \thinspace{}
3414 \begin_inset space \thinspace{}
3423 \begin_inset space \thinspace{}
3428 which provide alternative document classes for Japanese documents.
3432 Japanese Slides (BX Bundle)
3434 for presentation slides,
3436 As opposed to the classes of the
3446 \begin_inset CommandInset ref
3448 reference "subsec:Japanese"
3453 \begin_inset CommandInset ref
3455 reference "subsec:Japanese-JS"
3460 which support only p\SpecialChar LaTeX
3461 and up\SpecialChar LaTeX
3462 out of the box (and Lua\SpecialChar LaTeX
3463 only through the extra classes added by the
3469 the classes of this bundle also support pdf\SpecialChar LaTeX
3471 Xe\SpecialChar LaTeX
3472 and Lua\SpecialChar LaTeX
3474 with the aid of suitable packages that provide capability of Japanese typesetting.
3477 \begin_layout Subsection
3478 \begin_inset CommandInset label
3480 name "subsec:Japanese-JLReq"
3484 Japanese (JLReq Class)
3487 \begin_layout Standard
3488 This bundle draws on the
3492 class which faithfully traces the standard of
3494 Requirements for Japanese Text Layout
3496 set by the World Wide Web Consortium (W3C,
3498 \begin_inset Flex URL
3501 \begin_layout Plain Layout
3503 https://www.w3.org/TR/jlreq/?lang=en
3509 It can be used with Lua\SpecialChar LaTeX
3510 as well as p\SpecialChar LaTeX
3511 and up\SpecialChar LaTeX
3515 \begin_layout Standard
3516 LyX provides layouts for
3519 \begin_inset space \thinspace{}
3528 \begin_inset space \thinspace{}
3537 \begin_inset space \thinspace{}
3542 which are all derived from the
3547 class via specific class options.
3550 \begin_layout Standard
3551 An example article document is available at
3553 File\SpecialChar menuseparator
3554 Open Example\SpecialChar menuseparator
3555 Articles\SpecialChar menuseparator
3556 Japanese Article (JLReq Class)
3559 English documentation is available at
3560 \begin_inset Flex URL
3563 \begin_layout Plain Layout
3565 http://mirrors.ctan.org/macros/jptex/latex/jlreq/jlreq.pdf
3573 \begin_layout Subsection
3574 \begin_inset CommandInset label
3576 name "subsec:KOMA-Script"
3583 \begin_layout Standard
3593 and the \SpecialChar LyX
3597 \begin_layout Subsubsection
3601 \begin_layout Standard
3602 The KOMA-Script collection of document classes is a development of the Script classes created by Frank Neukam in the early 1990s;
3603 it was formally launched with the addition of a letter class in 1994.
3605 a second letter class has been added.
3606 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.
3609 \begin_layout Standard
3610 The \SpecialChar LyX
3630 correspond to the \SpecialChar LaTeX
3652 \begin_inset space ~
3655 of the Koma-Script family.
3656 They are replacements for the standard document classes
3676 and fit better to European typography conventions in a number of points.
3679 \begin_layout Itemize
3680 The base character sizes when you select a KOMA-Script class are 11pt in
3701 \begin_layout Itemize
3703 labels of the description environment,
3704 and a number of elements of the
3708 document class are set in a bold sans serif font.
3712 \begin_layout Plain Layout
3713 There is a big difference between the bold sans serif old cm fonts and new ec fonts,
3714 especially in the appearance of headings.
3716 the ec bold sans serif fonts look a bit thin.
3717 Here the \SpecialChar LaTeX
3726 helps to produce the
3727 \begin_inset Quotes eld
3731 \begin_inset Quotes erd
3734 appearance when using the ec fonts.
3739 The numbering of chapter headings is made in the same way as the numbering of section headings,
3740 that is without the extra line
3741 \begin_inset Quotes eld
3744 Chapter\SpecialChar ldots
3746 \begin_inset Quotes erd
3751 the appearance of the headings can be modified by using a number of options (in \SpecialChar LyX
3752 to be entered in the field
3755 \begin_inset space ~
3762 Layout\SpecialChar menuseparator
3769 \begin_layout Itemize
3770 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.
3771 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.
3772 You can change the sizes of the margins by changing the factor by which the page is divided into strips;
3773 the default for an A4 page is 9 and increasing this factor will produce increasingly narrower strips and therefore narrower margins.
3777 \begin_layout Standard
3778 Whatever the factor,
3779 two strips are allocated to the outer and bottom margins of a two-sided document and one strip to the inner and top margins,
3780 leaving a text area occupying around half the page.
3781 Since most two-sided documents have a binding,
3782 this can make the inner margins appear too narrow;
3783 so you can apply a binding correction to the page which is deducted before the size of the strips is calculated.
3786 \begin_layout Standard
3787 The main means in the Koma-Script document classes to design the type area are the options
3797 Document\SpecialChar menuseparator
3798 Settings\SpecialChar menuseparator
3799 Document Class\SpecialChar menuseparator
3800 Class Options\SpecialChar menuseparator
3806 \begin_layout Standard
3808 the binding correction is 7.5mm which is added in the form
3815 \begin_inset space ~
3818 options\SpecialChar menuseparator
3826 To change the factor to 11,
3832 to the comma separated list of entries in the
3843 \begin_inset space ~
3849 If you want the default value of this factor for a page size other than A4,
3857 \begin_layout Standard
3858 To use the circle method of calculating the page layout,
3867 \begin_layout Itemize
3868 The \SpecialChar LaTeX
3869 document classes of the Koma-Script family define a number of additional commands.
3870 Those part of it which makes sense in \SpecialChar LyX
3871 is implemented in corresponding paragraph types.
3874 \begin_layout Standard
3875 Detailed descriptions of the \SpecialChar LaTeX
3876 document classes of the Koma-Script family can be found in the Koma-Script documentation
3887 \begin_layout Subsubsection
3890 \begin_inset CommandInset label
3892 name "subsec:article-(KOMA-Script),-report"
3912 \begin_layout Standard
3913 The document classes
3927 are implemented in the layout files
3943 They contain all the paragraph types of the corresponding standard document classes
3960 with the exception of the \SpecialChar LyX
3966 which is replaced by the new
3970 -type having the same functionality.
3975 -Type there is a number of new paragraph types added.
3982 letter (koma-script)
3987 \begin_layout Itemize
4010 additionally inserting an entry in the table of contents.
4019 are not contained in
4021 article (koma-script)
4026 \begin_layout Itemize
4047 additionally clearing running heads.
4054 article (koma-script)
4060 \begin_layout Plain Layout
4073 report (koma-script)
4076 but since this is identical to
4081 is has not been implemented in \SpecialChar LyX
4090 \begin_layout Itemize
4096 generates a heading directly above the following paragraph in the standard character size without affecting the structure of the document.
4099 \begin_layout Itemize
4108 are special captions which respect the different space settings needed for captions placed above or below an element (if you follow strict typographic rules,
4109 you might want to place table captions always above the table).
4110 You can also use the class option
4128 You need at least Koma-Script version 2.8q to use this.
4131 \begin_layout Itemize
4137 can be used to set a bonmot,
4139 \begin_inset space \thinspace{}
4143 \begin_inset space \space{}
4146 at the beginning of a chapter.
4147 If you use the optional argument (
4149 Insert\SpecialChar menuseparator
4151 \begin_inset space ~
4157 you can insert the dictum's author there.
4158 Dictum and author are separated by a line.
4159 You need at least Koma-Script version 2.8q to use this.
4166 article (koma-script)
4171 \begin_layout Standard
4172 The following types,
4173 together with the standard types
4188 form the title area of the document.
4189 They must be entered ahead of the first
4190 \begin_inset Quotes eld
4194 \begin_inset Quotes erd
4201 \begin_layout Plain Layout
4202 The corresponding \SpecialChar LaTeX
4203 commands must appear before the
4214 When such a type is used more than once,
4215 the latter usage overwrites the former one,
4217 for every type only the latest usage is valid.
4218 The order of the different types however has,
4234 no effect on the appearance of the produced document.
4237 \begin_layout Itemize
4243 produces a centered paragraph above the ordinary title (
4257 ) for the subject of the document.
4260 \begin_layout Itemize
4266 produces a centered paragraph below the ordinary title (
4280 ) for the publishers' name.
4283 \begin_layout Itemize
4291 report (koma-script)
4297 produces a centered paragraph on its own page behind the title page,
4300 article (koma-script)
4302 produces a centered paragraph below the ordinary title (
4324 \begin_layout Itemize
4330 produces a left aligned paragraph above the ordinary title (
4349 ) for a document`s head.
4352 \begin_layout Itemize
4358 produces in a double-sided print in
4360 report (koma-script)
4366 a left-aligned paragraph at the top of the title page`s back or has no effect in a single-sided print or in
4368 article (koma-script)
4373 \begin_layout Itemize
4379 produces in a double-sided print in
4381 report (koma-script)
4387 a left-aligned paragraph at the bottom of the title page`s back or has no effect in a single-sided print or in
4389 article (koma-script)
4394 \begin_layout Itemize
4401 \begin_inset Quotes eld
4405 \begin_inset Quotes erd
4408 page ahead of the actual document containing a paragraph without special formatting.
4411 \begin_layout Standard
4412 KOMA-Script offers a wide range of
4419 \begin_inset space ~
4429 ocument\SpecialChar menuseparator
4434 ettings\SpecialChar menuseparator
4436 \begin_inset space ~
4441 dialog which you can apply to the whole document,
4445 \begin_layout Description
4452 which produces a PDF with a small black box at the end any line in which a formatting error occurs;
4453 the default setting is
4458 \begin_layout Description
4465 which may take the values
4479 the first and last adjust the sizes of the headings to take account of page sizes where the default values may not be suitable
4482 \begin_layout Description
4489 which may take the values
4503 the first leaves it up to KOMA-Script to add periods after chapter,
4506 the second forces the addition of periods and third suppresses them
4509 \begin_layout Standard
4510 and the math options:
4513 \begin_layout Description
4520 which causes equations to be numbered on the left rather than on the right,
4524 \begin_layout Description
4531 which causes equations to be left justified rather than centered.
4534 \begin_layout Standard
4535 It also provides commands to affect the output of the document independently of the standard \SpecialChar LaTeX
4536 commands and packages;
4538 if you want your captions in bold add
4541 \begin_layout Standard
4546 setkomafont{captionlabel}{
4551 \begin_layout Standard
4557 ocument\SpecialChar menuseparator
4564 \SpecialChar menuseparator
4569 \begin_inset space ~
4574 ) and the problem is solved.
4577 \begin_layout Standard
4578 If you are writing a book,
4579 it is normal to have the preliminary pages numbered in Roman numerals and the Chapters in this part unnumbered.
4580 If you use the Chapter* environment,
4581 your Foreword and Preface will not appear in the Table of Contents;
4582 to make them to appear in the Table of contents,
4583 you need to use Chapter environments and add the \SpecialChar TeX
4587 \begin_layout Standard
4595 \begin_layout Standard
4596 at the very start of the book (not in the \SpecialChar LaTeX
4600 \begin_layout Standard
4608 \begin_layout Standard
4609 before the first chapter of the body of the text.
4618 \begin_layout Standard
4619 You may also want to have some unnumbered Chapter environments at the end of the book after the Appendices,
4624 \begin_layout Plain Layout
4625 Appendices are normally “numbered” with letters.
4630 If you use the Chapter* environment,
4631 they will not appear in the Table of Contents;
4632 so add the \SpecialChar TeX
4636 \begin_layout Standard
4644 \begin_layout Standard
4645 before the first of these headings and use the Chapter environment.
4646 These commands will have no effect on the numbering in \SpecialChar LyX
4648 only on the PDF output where the headings will be unnumbered and appear in the Table of Contents.
4651 \begin_layout Standard
4652 The layout files for the document classes
4654 article (koma-script)
4659 report (koma-script)
4671 This is thought of as a place to define your own types.
4676 in your personal layout directory and edit the file!
4679 \begin_layout Subsubsection
4680 \begin_inset CommandInset label
4682 name "subsec:The-new-letter"
4686 The new letter class:
4687 KOMA-Script Letter (V.
4691 \begin_layout Standard
4697 \begin_layout Standard
4698 \begin_inset VSpace medskip
4704 \begin_layout Standard
4706 Koma-Script version 2.8 has introduced a new letter class
4710 which supersedes the now unsupported
4716 on the \SpecialChar LaTeX
4718 a completely new interface and is not compatible with the old class.
4722 though it is recommended you use the new class.
4725 \begin_layout Standard
4726 This class covers the same functionality as
4728 letter (koma-script),
4736 (receiver's address,
4756 will start a new letter (i.
4757 \begin_inset space \thinspace{}
4761 \begin_inset space \space{}
4764 you can write several letters per document).
4765 New elements are sender's
4784 and the possibility to use a
4790 Insert\SpecialChar menuseparator
4796 \begin_layout Standard
4797 The biggest improvement is,
4799 that the letter's layout is configurable to meet almost any needs.
4800 This can be done via the preamble or with a special style file (Letter Class Option,
4806 that will be read in as a class option.
4810 \begin_layout Plain Layout
4811 The KOMA package comes with some default
4822 file that follows german typesetting rules,
4827 that provides the default layout of the old
4832 The latter can be loaded with the class option
4839 Layout\SpecialChar menuseparator
4840 Document\SpecialChar menuseparator
4848 Have a look at the template in
4853 ile\SpecialChar menuseparator
4855 \begin_inset space ~
4863 \begin_inset space ~
4866 Template\SpecialChar menuseparator
4867 Letters\SpecialChar menuseparator
4868 KOMA-Script Letter (V.2)
4871 A detailed description is to be found in the Koma-Script documentation (
4878 \begin_layout Subsubsection
4882 \begin_layout Standard
4883 Visualizing the Koma-Script document classes in \SpecialChar LyX
4885 the \SpecialChar LyX
4886 internals cause some problems.
4889 \begin_layout Itemize
4890 The chapter number of a
4894 type appears on a line of its own above the chapter heading instead of appearing in the same line ahead of it.
4895 The cause for that is the \SpecialChar LyX
4896 internal behavior for the labeltype
4903 \begin_layout Itemize
4904 The headings of the types
4913 \begin_inset Quotes eld
4917 \begin_inset Quotes erd
4922 but not in the \SpecialChar LyX
4925 Document\SpecialChar menuseparator
4927 \begin_inset space ~
4931 \begin_inset space ~
4939 \begin_layout Itemize
4944 document class appear in a skip separation mode,
4946 This is the standard behavior,
4947 no special \SpecialChar LaTeX
4948 commands are needed for that.
4951 Document\SpecialChar menuseparator
4954 dialog the corresponding radio button indicates
4963 value always has the effect that extra \SpecialChar LaTeX
4964 commands are inserted in the document to produce the gap,
4965 which is not what is wanted in this case.
4968 \begin_layout Subsection
4969 \begin_inset CommandInset label
4971 name "subsec:Polish-M.W.collection"
4976 \begin_inset space \thinspace{}
4980 \begin_inset space \space{}
4986 \begin_layout Standard
4992 \begin_layout Standard
4993 The \SpecialChar LyX
4996 Polish Article (MW Bundle)
5001 Polish Report (MW Bundle)
5005 Polish Book (MW Bundle)
5007 correspond to the \SpecialChar LaTeX
5023 They are replacements for the standard document classes
5038 and fit better to Polish typography conventions in a number of points.
5042 \begin_layout Standard
5046 \begin_layout Itemize
5047 Unnumbered titles (with star,
5049 \begin_inset space \thinspace{}
5053 \begin_inset space \space{}
5060 ) are added into table of contents,
5063 \begin_layout Itemize
5064 Additional page styles:
5068 \begin_layout Description
5069 uheadings header with separated lines,
5072 \begin_layout Description
5073 myheadings custom header,
5074 contents headers via commands:
5090 \begin_layout Description
5091 myuheadings custom header with separated lines,
5094 \begin_layout Description
5095 outer page number is placed on outer side of page
5099 \begin_layout Itemize
5104 \begin_layout Description
5105 rmheadings serif titles —
5109 \begin_layout Description
5110 sfheadings sansserif titles,
5113 \begin_layout Description
5114 authortitle on title page first placed is author next title —
5118 \begin_layout Description
5119 titleauthor on title page first placed is title next author,
5122 \begin_layout Description
5123 withmarginpar reserve place on page for margins.
5127 \begin_layout Subsection
5131 \begin_layout Standard
5132 The document classes
5149 Detailed information about these document classes can be found in
5151 File\SpecialChar menuseparator
5152 Open Example\SpecialChar menuseparator
5153 Books\SpecialChar menuseparator
5158 File\SpecialChar menuseparator
5159 Open Example\SpecialChar menuseparator
5160 Handouts\SpecialChar menuseparator
5166 \begin_layout Section
5170 \begin_layout Standard
5171 See also the document classes in the Collections (section
5172 \begin_inset space ~
5176 \begin_inset CommandInset ref
5178 reference "sec:Collections"
5186 \begin_layout Subsection
5187 Astronomy & Astrophysics
5190 \begin_layout Standard
5196 updated by the \SpecialChar LyX
5200 \begin_layout Subsubsection
5204 \begin_layout Standard
5205 This section describes how \SpecialChar LyX
5206 can be used to write articles for submission to the scientific journal
5208 Astronomy & Astrophysics
5211 \begin_inset CommandInset href
5214 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
5219 ) using Version 9.1 of the document class
5224 information about it is available at
5225 \begin_inset Flex URL
5228 \begin_layout Plain Layout
5230 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
5238 \begin_layout Standard
5239 A manual comes together with the package and should be consulted before installing this document class as described in the
5241 Installing New Document Classe
5250 \begin_layout Standard
5251 \begin_inset Note Greyedout
5254 \begin_layout Plain Layout
5255 Please note that the publisher of the journal was changed from Springer to EDP Sciences starting January 1,
5257 That change also involved some slight changes to the style files,
5258 namely the removal of the thesaurus command.
5259 If you have an older version installed,
5261 For information about compatibility with the old (version 4) layout,
5262 please refer to the comments in
5265 Dir/layouts/aapaper.layout
5275 \begin_layout Subsubsection
5279 \begin_layout Standard
5280 It is recommended you start from the template in the menu
5285 ile\SpecialChar menuseparator
5287 \begin_inset space ~
5295 \begin_inset space ~
5298 Template\SpecialChar menuseparator
5299 Articles\SpecialChar menuseparator
5300 Astronomy & Astrophysics
5303 If you are not using the template,
5304 note the following settings:
5307 \begin_layout Itemize
5310 Astronomy & Astrophysics
5317 ocument\SpecialChar menuseparator
5322 ettings\SpecialChar menuseparator
5324 \begin_inset space ~
5330 that one was obvious).
5333 \begin_layout Itemize
5337 \begin_inset space ~
5349 \begin_inset space ~
5360 The whole layout is done by the macros,
5361 you shouldn't change anything.
5364 \begin_layout Subsubsection
5368 \begin_layout Standard
5369 First thing to enter is the header information.
5370 It consists of seven entries,
5371 of which one is optional.
5375 \begin_layout Itemize
5384 \begin_layout Itemize
5393 \begin_layout Itemize
5402 \begin_layout Itemize
5411 \begin_layout Itemize
5417 Determines to whom correspondence and reprints are to be sent.
5420 \begin_layout Itemize
5425 [optional] Snail mail address for contacts.
5428 \begin_layout Itemize
5442 \begin_layout Standard
5443 There is no need to issue the
5450 this is done automatically by \SpecialChar LyX
5451 when the header is finished.
5452 Although the order of the single header entries doesn't matter it is advised to keep the above sequence,
5453 just to get the best optics and meets the layout of the real document.
5456 \begin_layout Standard
5457 If you want to place footnotes in the header block,
5459 \begin_inset space \thinspace{}
5463 \begin_inset space \space{}
5466 to state your present address,
5467 just use the standard footnote via the menu
5472 nsert\SpecialChar menuseparator
5481 will automagically use the term
5490 \begin_layout Standard
5493 Edit\SpecialChar menuseparator
5497 you'll find two insets which are relevant for the titling:
5500 \begin_layout Itemize
5507 to mark corresponding author\SpecialChar breakableslash
5509 The institutes are numbered sequentially as they appear in the
5514 so you have to put a marker to each author.
5517 \begin_layout Itemize
5522 to supply an email address for fast contact.
5525 \begin_layout Standard
5526 In addition to these topics,
5527 the macros use one additional \SpecialChar LaTeX
5528 commands that has no counterpart in \SpecialChar LyX
5532 \begin_layout Itemize
5539 to separate different names for more than one author and institute,
5543 \begin_layout Standard
5544 The appropriate command has to be entered as \SpecialChar TeX
5545 code in \SpecialChar LyX
5547 See the examples in the template and in
5549 File\SpecialChar menuseparator
5550 Open Example\SpecialChar menuseparator
5551 Articles\SpecialChar menuseparator
5552 Astronomy & Astrophysics
5557 \begin_layout Subsubsection
5561 \begin_layout Standard
5562 The abstract should immediately follow the header block.
5563 With version 5 the abstract environment was changed to a command,
5564 and there is now a restriction to only one paragraph.
5566 it should contain an entry with the keywords.
5567 This is done via the paragraph style
5572 Refer to the example paper.
5575 \begin_layout Subsubsection
5576 Supported environments
5579 \begin_layout Standard
5580 The A&A paper layout supports the following environments for structuring your text:
5583 \begin_layout Standard
5586 \begin_inset Flex Multiple Columns
5589 \begin_layout Itemize
5595 \begin_layout Itemize
5601 \begin_layout Itemize
5607 \begin_layout Itemize
5613 \begin_layout Itemize
5619 \begin_layout Itemize
5625 \begin_layout Itemize
5631 \begin_layout Itemize
5637 \begin_layout Itemize
5643 \begin_layout Itemize
5649 \begin_layout Itemize
5655 \begin_layout Itemize
5664 \begin_layout Subsubsection
5665 Commands not supported by \SpecialChar LyX
5669 \begin_layout Standard
5670 Some commands are not yet supported by the
5672 Astronomy & Astrophysics
5674 layout for \SpecialChar LyX
5676 Some have already been mentioned.
5677 For the sake of completeness,
5678 they are listed all together here:
5681 \begin_layout Itemize
5689 \begin_layout Itemize
5697 \begin_layout Itemize
5705 \begin_layout Itemize
5713 \begin_layout Standard
5714 If you want to use any of these commands,
5715 you have to enter them yourself.
5716 Do not forget to use
5722 nsert\SpecialChar menuseparator
5725 \begin_inset space ~
5733 \begin_layout Subsubsection
5734 Figure and Table Floats
5737 \begin_layout Standard
5739 provides support for the necessary float environments
5750 therefore we won't tell much about it here.
5754 \begin_inset space ~
5760 Just remember that tables should be left-aligned.
5762 select the table and change the alignment in
5767 dit\SpecialChar menuseparator
5773 \begin_inset space ~
5781 arg "layout-paragraph"
5789 \begin_layout Standard
5790 There is only one special thing:
5791 the figures with a caption beside the figure.
5792 To create such a figure,
5793 you have to do the following:
5796 \begin_layout Enumerate
5797 Create a wide figure float:
5803 nsert\SpecialChar menuseparator
5808 t\SpecialChar menuseparator
5813 from within the float,
5819 dit\SpecialChar menuseparator
5825 \begin_inset space ~
5836 \begin_inset space ~
5848 \begin_layout Enumerate
5849 Enter your caption text.
5852 \begin_layout Enumerate
5857 to move the cursor above the caption.
5860 \begin_layout Enumerate
5864 \begin_layout Enumerate
5865 Position the cursor after the figure and insert a horizontal fill by using the menu:
5871 nsert\SpecialChar menuseparator
5876 rmatting\SpecialChar menuseparator
5882 \begin_inset space ~
5891 dialog and select the
5905 \begin_layout Enumerate
5906 Switch to \SpecialChar LaTeX
5911 \begin_inset space ~
5919 \begin_layout Enumerate
5928 Do not close the brace!
5931 \begin_layout Enumerate
5932 Position the cursor behind the caption text,
5933 switch to \SpecialChar LaTeX
5934 mode and insert the closing brace:
5938 \begin_inset space ~
5950 \begin_layout Standard
5952 refer to the figures in the file in
5954 File\SpecialChar menuseparator
5955 Open Example\SpecialChar menuseparator
5956 Articles\SpecialChar menuseparator
5957 Astronomy & Astrophysics
5962 \begin_layout Subsubsection
5966 \begin_layout Standard
5968 the paper has to be formatted in a special double-spacing layout.
5970 you have to add the option
5981 \begin_inset space ~
5991 ocument\SpecialChar menuseparator
5996 ettings\SpecialChar menuseparator
5998 \begin_inset space ~
6006 \begin_layout Subsubsection
6010 \begin_layout Standard
6013 File\SpecialChar menuseparator
6014 Open Example\SpecialChar menuseparator
6015 Articles\SpecialChar menuseparator
6016 Astronomy & Astrophysics
6018 was written with \SpecialChar LyX
6020 It is the example paper from the original macro package,
6026 \begin_inset CommandInset href
6029 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
6035 but translated to \SpecialChar LyX
6036 using the older unstructured abstract type.
6037 Use it for inspiration,
6038 and compare the \SpecialChar LaTeX
6043 with the \SpecialChar LyX
6047 \begin_layout Subsection
6052 \begin_layout Standard
6058 \begin_layout Subsubsection
6062 \begin_layout Standard
6064 is a set of macros produced by the American Astronomical Society to facilitate electronic manuscript submission to the three journals they publish:
6065 the Astrophysical Journal (including the Letters and Supplement),
6066 the Astronomical Journal,
6067 and the Publications of the Astronomical Society of the Pacific.
6069 has proven to be an excellent tool for generating these documents,
6070 especially given its equation,
6072 and figure handling capabilities.
6074 requires version 5.0 (or higher) of these macros;
6076 which is the version described here,
6078 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
6079 2.09 and are fundamentally incompatible with \SpecialChar LyX
6081 The AAS\SpecialChar TeX
6082 package may be downloaded from the AAS\SpecialChar TeX
6086 \begin_layout Standard
6087 \begin_inset VSpace medskip
6093 \begin_layout Standard
6095 \begin_inset Flex URL
6098 \begin_layout Plain Layout
6100 https://aas.org/aastex/aastex-downloads
6108 \begin_layout Standard
6109 \begin_inset VSpace medskip
6115 \begin_layout Standard
6116 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
6119 will not reduce the need to figure out all the AAS\SpecialChar TeX
6121 it will only reduce the drudgery of typing everything in.
6122 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
6123 document conforms completely to the requirements of the journal to which you are submitting your paper.
6126 \begin_layout Subsubsection
6127 Starting a New Paper
6130 \begin_layout Standard
6131 I strongly suggest that you start with the AAS\SpecialChar TeX
6135 File\SpecialChar menuseparator
6140 Template\SpecialChar menuseparator
6141 Articles\SpecialChar menuseparator
6142 American Astronomical Society
6145 This will show the most common fields found in a manuscript.
6146 Simply overwrite the existing text (including the brackets,
6151 ) with the correct information.
6152 Many of the AAS\SpecialChar TeX
6153 commands and environments can be implemented directly in \SpecialChar LyX
6156 For commands such as these,
6157 the \SpecialChar LaTeX
6158 code must be entered directly and marked as such.
6159 Such commands are referred to as \SpecialChar TeX
6162 I tried to minimize the amount of \SpecialChar TeX
6163 code needed in an AAS\SpecialChar TeX
6167 \begin_layout Subsubsection
6168 Finishing Your Paper
6171 \begin_layout Standard
6172 When the paper is finished to your satisfaction and previews/prints correctly,
6174 \begin_inset Quotes eld
6178 \begin_inset Quotes erd
6181 actions which need to be done before you submit it to the journals.
6185 \begin_layout Enumerate
6186 Export your paper as a \SpecialChar LaTeX
6189 File\SpecialChar menuseparator
6190 Export\SpecialChar menuseparator
6198 \begin_layout Enumerate
6203 file with your favorite text editor
6207 \begin_layout Enumerate
6208 remove the comment lines before the
6217 \begin_layout Enumerate
6222 usepackage...{fontenc}
6224 line if it appears (usually just after
6240 \begin_layout Enumerate
6241 remove everything between (and including) the
6254 except for any commands you specifically put into the \SpecialChar LaTeX
6255 preamble (which should appear immediately after the
6256 \begin_inset Quotes eld
6259 User specified \SpecialChar LaTeX
6261 \begin_inset Quotes erd
6272 \begin_layout Enumerate
6273 Run the resulting file through \SpecialChar LaTeX
6274 to make sure it still processes correctly.
6277 \begin_layout Enumerate
6278 Reread the journal requirements to make sure your filenames and formats are correct.
6281 \begin_layout Enumerate
6285 \begin_layout Subsubsection
6286 Comments On Specific Commands
6289 \begin_layout Standard
6290 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
6292 the AAS\SpecialChar TeX
6297 ) gives a good description of each.
6298 Thus it's probably easiest for me to go down the list as found in the guide and offer comments where necessary.
6299 So let's begin \SpecialChar ldots
6303 \begin_layout Paragraph
6304 Things that work as expected
6307 \begin_layout Standard
6308 Because they work as you might expect,
6309 I simply list them and the section they are found in:
6426 begin{thebibliography}
6436 all the cite commands and their variations (2.13.2),
6437 the generic graphicx figure commands (2.14.1),
6466 amongst other places),
6497 \begin_layout Standard
6498 The following style options also work correctly:
6524 Simply put them in the
6530 Layout\SpecialChar menuseparator
6536 \begin_layout Paragraph
6538 but require more comment
6541 \begin_layout Standard
6542 The following items work,
6543 but require a little more discussion:
6546 \begin_layout Itemize
6547 These items are reserved for use by the journal editors,
6548 but you can put them into the \SpecialChar LaTeX
6549 preamble if you feel compelled to do so:
6587 \begin_layout Itemize
6588 These items may be placed in the \SpecialChar LaTeX
6590 and are included as blanks in the template file:
6614 \begin_layout Itemize
6621 (2.3) – can only be used
6622 \begin_inset Quotes eld
6626 \begin_inset Quotes erd
6630 not in the middle of a paragraph.
6631 Use \SpecialChar TeX
6632 code if you need to embed it.
6635 \begin_layout Itemize
6642 (2.3) – will have extra {} after it.
6643 This should not cause an error.
6646 \begin_layout Itemize
6653 (2.6) – can only be used
6654 \begin_inset Quotes eld
6658 \begin_inset Quotes erd
6662 not in the middle of a paragraph.
6663 Use \SpecialChar TeX
6664 code if you need to embed it.
6667 \begin_layout Itemize
6674 (2.8) – can't insert a cross-reference tag,
6675 you must type the tag name by hand
6678 \begin_layout Itemize
6692 \begin_layout Itemize
6699 (2.9) – will have extra {} after it.
6700 This should not cause an error.
6703 \begin_layout Itemize
6710 (2.11) – will have extra {} after it.
6711 This should not cause an error.
6714 \begin_layout Itemize
6721 (2.14.2) – you can insert an optional filename argument by placing the cursor at the beginning of the text and selecting
6723 Insert\SpecialChar menuseparator
6728 \begin_inset Quotes eld
6732 \begin_inset Quotes erd
6735 inserts an optional argument of the type needed by
6742 Hopefully it will be renamed someday.
6745 \begin_layout Itemize
6758 for the catalog ID optional parameter
6761 \begin_layout Itemize
6774 for the catalog ID optional parameter
6777 \begin_layout Paragraph
6778 Things not implemented,
6779 use \SpecialChar TeX
6783 \begin_layout Standard
6795 setcounter{equation}
6798 Journal name abbreviations (2.13.4),
6841 insert it as the first element in the lefthand cell after where you want it.
6842 Don't use any of \SpecialChar LyX
6843 's rules in the table),
6918 \begin_layout Paragraph
6919 Things that cannot be implemented
6922 \begin_layout Standard
6924 at least in any meaningful sort of way,
6925 so I suggest ignoring them.
6926 They are the references environment (2.13.3),
6927 and the deluxetable environment (2.15).
6929 really need to use deluxetable,
6930 I suggest editing it in a separate file with a text editor,
6933 Insert\SpecialChar menuseparator
6935 \begin_inset space ~
6940 to include it in your \SpecialChar LyX
6944 File\SpecialChar menuseparator
6945 Open Example\SpecialChar menuseparator
6946 Articles\SpecialChar menuseparator
6947 American Astronomical Society
6949 for an example of this.
6952 \begin_layout Subsubsection
6956 and Other Ruminations
6959 \begin_layout Paragraph
6960 Getting \SpecialChar LyX
6961 and AAS\SpecialChar TeX
6965 \begin_layout Standard
6966 It can be a bit tricky to get \SpecialChar LyX
6967 to recognize a new layout and document class.
6968 When all else fails,
6972 \begin_layout Enumerate
6973 Make certain that \SpecialChar LaTeX
6974 can find AAS\SpecialChar TeX
6976 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
6977 distribution into a directory completely unrelated to \SpecialChar LaTeX
6978 or AAS\SpecialChar TeX
6979 and run \SpecialChar LaTeX
6987 \begin_layout Enumerate
6992 appears in \SpecialChar LyX
7000 \begin_layout Enumerate
7003 Tools\SpecialChar menuseparator
7008 then restart \SpecialChar LyX
7012 \begin_layout Enumerate
7013 Open a regular new file,
7014 not from a template.
7017 American Astronomical Society (AASTeX V.
7018 \begin_inset space \thinspace{}
7023 appear in the class list in
7025 Document\SpecialChar menuseparator
7031 \begin_layout Standard
7032 If you get a warning from an existing AAS\SpecialChar TeX
7033 document about not being able to find the AAS\SpecialChar TeX
7034 layout or a message about
7035 \begin_inset Quotes eld
7038 You should not mix title layouts with normal ones
7039 \begin_inset Quotes erd
7043 things haven't been installed correctly.
7046 \begin_layout Paragraph
7048 error processing a table
7051 \begin_layout Standard
7055 attempts to center the table caption/title.
7056 This seems to produce a bad interaction in AAS\SpecialChar TeX
7057 so you should click somewhere in the caption/title,
7060 Edit\SpecialChar menuseparator
7062 \begin_inset space ~
7077 This took care of it for me.
7080 \begin_layout Paragraph
7084 \begin_layout Standard
7089 \begin_layout Enumerate
7090 I have noticed some funny spacing in the reference entries in the text.
7091 When you enter the bibliography item data,
7096 space between the last author and the parenthesis setting off the year;
7100 \begin_inset space \thinspace{}
7104 \begin_inset space \space{}
7122 \begin_layout Enumerate
7123 Entering the references at all is not obvious.
7124 The easiest thing is to start typing your first reference at the end of the document,
7125 then mark it as type
7130 That will put a small gray box in front of what you just typed.
7131 Click on the box to fill in the rest of the information.
7133 go to the end of an existing reference and press return.
7134 That will create a new line with its own box,
7138 \begin_layout Paragraph
7142 \begin_layout Standard
7143 Even though AAS\SpecialChar TeX
7144 provides its own figure commands (
7152 I much prefer \SpecialChar LaTeX
7153 's standard figure commands (with the default graphicx).
7162 \begin_inset space ~
7165 commands as \SpecialChar TeX
7166 code into a Figure Float box if you desire,
7167 but I never have much luck getting the layout right.
7168 With the standard graphics,
7174 usepackage{graphicx}
7176 command into the \SpecialChar LaTeX
7177 preamble and handle the figures in the standard \SpecialChar LaTeX2e
7179 interspersing the figures in the text.
7180 I believe ApJ accepts figures exactly this way now;
7181 AJ might still use the
7182 \begin_inset Quotes eld
7185 stack everything at the end
7186 \begin_inset Quotes erd
7192 \begin_layout Paragraph
7193 Things I could have done,
7197 \begin_layout Standard
7199 \begin_inset Quotes eld
7203 \begin_inset Quotes erd
7206 things I could have implemented,
7209 I saw no point in double-spacing the text in the \SpecialChar LyX
7211 even though it is double-spaced in the paper manuscript.
7213 I chose not to make separate layouts for the preprint and preprint2 styles.
7214 Since I assume you will spend most of your time in the plain manuscript mode anyway,
7215 I decided not to chew up more disk space with this.
7219 \begin_layout Subsubsection
7223 \begin_layout Standard
7224 Your mileage may vary.
7225 I've now had papers published by both ApJ and AJ that have had 98% of the effort done in \SpecialChar LyX
7227 the last 2% was the \SpecialChar LaTeX
7228 post-processing and a few cleanups.
7229 I have had no trouble with the submission process,
7230 and I'm sure the journals were never aware that there might be a difference.
7232 go forth and publish!
7235 \begin_layout Subsection
7239 \begin_layout Standard
7244 uses the standard article document class together with the package
7248 to facilitate the description of chess games.
7251 File\SpecialChar menuseparator
7252 Open Example\SpecialChar menuseparator
7253 Articles\SpecialChar menuseparator
7267 \begin_layout Subsection
7271 \begin_layout Standard
7276 provides support for the
7281 class for journals in the Elsevier publishing house.
7282 This provides the following additional environments:
7286 \begin_inset space ~
7295 \begin_inset space ~
7304 \begin_inset space ~
7326 \begin_layout Standard
7327 A template is available in the menu
7332 ile\SpecialChar menuseparator
7334 \begin_inset space ~
7342 \begin_inset space ~
7345 Template\SpecialChar menuseparator
7346 Articles\SpecialChar menuseparator
7350 It has been customized with further environments and contains all the information you may need.
7352 the documentation is also available from
7353 \begin_inset CommandInset href
7356 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
7364 \begin_layout Subsection
7368 \begin_layout Standard
7371 Paper (Standard Class)
7373 provides an alternative to the
7375 Article (Standard Class)
7378 It provides similar functionality,
7379 but you might prefer this layout with sans serif sections,
7384 \begin_layout Subsection
7389 \begin_layout Standard
7395 \begin_layout Standard
7396 \begin_inset VSpace bigskip
7402 \begin_layout Standard
7407 \begin_inset space \thinspace{}
7412 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
7414 \begin_inset Formula $\beta$
7421 \begin_layout Standard
7428 which works with Rev\SpecialChar TeX
7431 v3.1 is basically obsolete,
7432 as it works with \SpecialChar LaTeX
7434 That means that it doesn't interact very well with \SpecialChar LyX
7436 which requires \SpecialChar LaTeX2e
7438 although it has been kludged to work.
7439 Since Rev\SpecialChar TeX
7440 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
7446 \begin_inset space ~
7450 \begin_inset space \thinspace{}
7455 textclass should also be pretty easy to use.
7458 \begin_layout Standard
7459 These documents are supposed to be used in
7463 to the Rev\SpecialChar TeX
7465 so we don't describe any of the special Rev\SpecialChar TeX
7467 and assume you'll know what to put in the preamble if necessary.
7470 \begin_layout Subsubsection
7474 \begin_layout Standard
7475 All you need to do is install Rev\SpecialChar TeX
7477 as described in the package's README file.
7478 The package can be found at The Rev\SpecialChar TeX
7480 \begin_inset Flex URL
7483 \begin_layout Plain Layout
7485 http://publish.aps.org/revtex4/
7491 Install it somewhere that \SpecialChar LaTeX
7493 Test it by trying to \SpecialChar LaTeX
7494 a short Rev\SpecialChar TeX
7495 4 document in some random directory (i.
7496 \begin_inset space \thinspace{}
7500 \begin_inset space \space{}
7503 not the directory where you installed the class file.) Then,
7504 if you reconfigure \SpecialChar LyX
7506 it will find the class file and let you use the Rev\SpecialChar TeX
7510 \begin_layout Standard
7511 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
7520 \begin_inset space ~
7528 File\SpecialChar menuseparator
7529 New From Templates\SpecialChar menuseparator
7535 \begin_layout Subsubsection
7539 \begin_layout Standard
7540 Optional arguments to
7548 \begin_inset Quotes eld
7552 \begin_inset Quotes erd
7556 \begin_inset Quotes eld
7560 \begin_inset Quotes erd
7567 \begin_inset space ~
7575 \begin_inset space ~
7582 Remember that in Rev\SpecialChar TeX
7584 at least one optional argument is required!
7588 \begin_layout Standard
7589 Other preamble matter,
7597 \begin_inset space ~
7604 \begin_inset space ~
7613 \begin_layout Subsubsection
7617 \begin_layout Standard
7618 The layouts basically correspond to the commands in Rev\SpecialChar TeX
7621 the Email layout corresponds to
7628 Note that (at least as of Rev\SpecialChar TeX
7638 layouts are exactly equivalent,
7639 so you shouldn't need to use both.
7643 \begin_layout Plain Layout
7644 In case you're curious,
7645 both were included so that
7649 would be able to translate both
7669 \begin_layout Subsubsection
7673 \begin_layout Standard
7674 There are a couple of important unique aspects of Rev\SpecialChar TeX
7675 4 which might cause bugs that will be even more confusing in \SpecialChar LyX
7679 \begin_layout Standard
7680 In Rev\SpecialChar TeX
7699 The \SpecialChar LyX
7700 equivalent is that there is a separate Thanks layout.
7705 write footnotes in the
7710 or weird things may happen.
7711 See the Rev\SpecialChar TeX
7712 4 documentation for more details.
7715 \begin_layout Standard
7720 \begin_inset space ~
7729 \begin_inset space ~
7739 layouts must be placed
7747 layout and the corresponding
7765 the \SpecialChar LaTeX
7769 \begin_layout Subsection
7773 \begin_layout Standard
7778 classes were replaced with a completely new class,
7784 Please find information at
7785 \begin_inset Flex URL
7788 \begin_layout Plain Layout
7790 https://www.springernature.com/gp/authors/campaigns/latex-author-support
7796 Native \SpecialChar LyX
7797 support is not available yet.
7800 \begin_layout Section
7804 \begin_layout Standard
7805 See also the document classes in the Collections (section
7806 \begin_inset space ~
7810 \begin_inset CommandInset ref
7812 reference "sec:Collections"
7820 \begin_layout Subsection
7824 \begin_layout Standard
7830 \begin_layout Subsubsection
7834 \begin_layout Standard
7835 Memoir is a very powerful and constantly evolving class.
7836 It has been designed with regard to fictional and non-fictional literature.
7837 Its aim is to let the user have maximum control over the typesetting of his document.
7838 Memoir is based on the standard book class,
7839 but it can also emulate the article class (see below).
7842 \begin_layout Standard
7844 the developer of Memoir,
7845 is known as the author of lots of useful packages in the \SpecialChar LaTeX
7847 Most of them have been merged with Memoir.
7849 it is much easier to layout the table of contents,
7851 chapter designs and such.
7855 does not support all of these goodies natively.
7856 Some of them might be added to forthcoming releases
7860 \begin_layout Plain Layout
7861 You are invited to send suggestions to
7862 \begin_inset Flex URL
7865 \begin_layout Plain Layout
7867 lyx-devel@lists.lyx.org
7878 lots will probably never be supported,
7879 due to the limitations of \SpecialChar LyX
7881 Of course you can still use all features with the help of some native \SpecialChar LaTeX
7882 commands (\SpecialChar TeX
7887 \begin_layout Plain Layout
7892 \begin_layout Plain Layout
7902 \begin_inset space ~
7906 \begin_inset CommandInset ref
7908 reference "sec:Inserting-TeX-Code"
7920 we can only list those features that are natively supported by \SpecialChar LyX
7922 For detailed descriptions (and for the rest of features) we recommend you have a look at the detailed manual of the Memoir class
7926 \begin_layout Plain Layout
7931 \begin_layout Plain Layout
7941 \begin_inset Flex URL
7944 \begin_layout Plain Layout
7946 CTAN:/macros/latex/memoir/memman.pdf
7957 which is not only a user guide for the class,
7958 but also both a comprehensive description on good typesetting and a superb example for good typesetting itself.
7961 \begin_layout Subsubsection
7962 Basic features and restrictions
7965 \begin_layout Standard
7966 Memoir supports basically all features of the standard book classes.
7973 \begin_layout Description
7975 \begin_inset space ~
7979 Memoir has a broader range of font sizes:
7988 \begin_layout Description
7990 \begin_inset space ~
7994 The fancy page style is not supported,
7995 due to a command clash between Memoir and the fancyhdr package (they both define a command with the same name,
7996 which confuses \SpecialChar LaTeX
7999 Memoir comes with a number of its own page styles (see
8001 Document\SpecialChar menuseparator
8002 Settings\SpecialChar menuseparator
8004 \begin_inset space ~
8010 If you want to use these for the chapter pages,
8011 you have to use the command
8017 in the main text or in preamble (e.
8018 \begin_inset space \thinspace{}
8022 \begin_inset space \space{}
8029 chapterstyle{companion}
8034 \begin_layout Description
8036 Sectionings (chapter,
8038 subsection etc.) come with an optional argument in the standard classes.
8040 you can specify an alternative version of the title for the table of contents and the headers (for instance,
8041 if the title is too long).
8046 Insert\SpecialChar menuseparator
8048 \begin_inset space ~
8053 at the beginning of a chapter/section.
8054 Memoir features a second optional argument and thus separates the table of contents from the header.
8055 You can define three variants of a title with this:
8056 one for the main text,
8057 one for the table of contents,
8058 and one for the headers.
8060 makes these available in form of specific
8071 \begin_layout Description
8073 In the standard classes (and in many other classes),
8074 the table of contents,
8075 the list of figures and the list of table start a new page automatically.
8076 Memoir does not follow this route.
8077 You have to insert a page break yourself,
8078 if you want to have one.
8081 \begin_layout Description
8083 For some unknown reason,
8084 Memoir uses pagination on the title page (in the standard classes,
8086 \begin_inset Quotes eld
8090 \begin_inset Quotes erd
8094 If you want an empty title page,
8099 aliaspagestyle{title}{empty}
8104 \begin_layout Description
8106 With the class option
8112 Document\SpecialChar menuseparator
8113 Settings\SpecialChar menuseparator
8114 Class Settings\SpecialChar menuseparator
8116 \begin_inset space ~
8122 you can emulate article style.
8124 counters (footnotes,
8126 tables etc.) will not be reset on new chapters,
8127 chapters don't start a new page (but are—
8129 \begin_inset Quotes eld
8133 \begin_inset Quotes erd
8144 \begin_layout Description
8147 Memoir does not allow the use of the deprecated font commands,
8148 which have been used in the old \SpecialChar LaTeX
8150 \begin_inset space \thinspace{}
8154 \begin_inset space \space{}
8171 It produces an error and stops \SpecialChar LaTeX
8172 whenever such a command appears.
8177 reallows the commands and spits out warnings instead (which does at least not stop \SpecialChar LaTeX
8179 Since a lot of packages and particularly Bib\SpecialChar TeX
8180 style files are still using those commands,
8181 we have decided to use this option by default.
8184 \begin_layout Subsubsection
8188 \begin_layout Standard
8189 We will only describe the features supported by \SpecialChar LyX
8190 (which is not much currently).
8191 Please consult the Memoir manual
8195 \begin_layout Plain Layout
8200 \begin_layout Plain Layout
8210 \begin_inset Flex URL
8213 \begin_layout Plain Layout
8215 CTAN:/macros/latex/memoir/memman.pdf
8228 \begin_layout Description
8230 You may wonder why an abstract is an extra feature.
8232 it is in book class.
8233 Usually books don't have abstracts.
8237 You can use it wherever and how often you like.
8240 \begin_layout Description
8242 You may know this older typesetting style:
8243 The contents of a chapter are summarized below the title and also in the table of contents (e.
8244 \begin_inset space \thinspace{}
8248 \begin_inset space \space{}
8253 Our hero arrives in Troia;
8254 he loses some friends;
8258 Chapterprecis does exactly this.
8259 It is therefore only sensible below a chapter.
8262 \begin_layout Description
8264 An epigraph is a smart slogan or motto at the beginning of a chapter.
8265 The epigraph environment provides an elegant way of typesetting such a motto.
8266 The motto itself (text) and its (optional) author (source) are divided by a short line.
8267 The author (source) can be inserted via
8269 Insert\SpecialChar menuseparator
8276 \begin_layout Description
8278 Memoir has lots of possibilities to typeset poetry (up to very complex figurative poems).
8280 can only support a few of them.
8282 which is a centered title for poems,
8283 which will also be added to the table of contents (verse is the standard environment for poems.
8284 Memoir has some enhanced versions of verse,
8285 but you need to use \SpecialChar TeX
8287 because they have to be nested inside regular verse environments,
8288 which is not possible with \SpecialChar LyX
8292 \begin_layout Description
8295 but it adds no entry to the table of contents.
8298 \begin_layout Subsection
8302 \begin_layout Standard
8311 document class but adds two environments:
8314 \begin_layout Description
8315 Recipe a numbered section environment at the
8319 level which generates a bold centered heading above a double horizontal rule
8322 \begin_layout Description
8333 are what are being described and the environment ends with a horizontal rule.
8336 \begin_layout Standard
8339 File\SpecialChar menuseparator
8340 Open Example\SpecialChar menuseparator
8341 Books\SpecialChar menuseparator
8344 illustrates its use.
8347 \begin_layout Standard
8348 The class is designed for typesetting one or two recipes per page.
8349 The hyperlinked table of contents (ToC) and page numbers make browsing recipes convenient.
8353 \begin_layout Section
8357 \begin_layout Subsection
8361 \begin_layout Standard
8371 an unofficial implementation of the ‘Europass CV’ recommended by the European Commission in 2013.
8374 File\SpecialChar menuseparator
8375 Open Example\SpecialChar menuseparator
8376 Curricula Vitae\SpecialChar menuseparator
8379 offers guidance on its use.
8380 Its documentation is available from
8381 \begin_inset CommandInset href
8384 target "http://mirrors.ctan.org/macros/latex/contrib/europasscv/europasscv.pdf"
8392 \begin_layout Subsection
8396 \begin_layout Standard
8406 an unofficial implementation of the “Europass CV” recommended by the European Commission in 2002.
8409 File\SpecialChar menuseparator
8410 Open Example\SpecialChar menuseparator
8411 Curricula Vitae\SpecialChar menuseparator
8414 offers guidance on its use.
8415 Its documentation is available from
8416 \begin_inset CommandInset href
8419 target "http://mirrors.ctan.org/macros/latex/contrib/europecv/europecv.pdf"
8427 \begin_layout Subsection
8431 \begin_layout Standard
8441 This allows the creation of customizable CVs.
8444 File\SpecialChar menuseparator
8445 Open Example\SpecialChar menuseparator
8446 Curricula Vitae\SpecialChar menuseparator
8449 offers guidance on its use.
8450 Its documentation is available from
8451 \begin_inset CommandInset href
8454 target "http://mirrors.ctan.org/macros/latex/contrib/moderncv/manual/moderncv_userguide.pdf"
8462 \begin_layout Subsection
8466 \begin_layout Standard
8476 originally developed for use with \SpecialChar LyX
8480 File\SpecialChar menuseparator
8481 Open Example\SpecialChar menuseparator
8482 Curricula Vitae\SpecialChar menuseparator
8485 offers guidance on its use.
8486 Its documentation is available from
8487 \begin_inset CommandInset href
8490 target "http://mirrors.ctan.org/macros/latex/contrib/simplecv/simplecv.pdf"
8498 \begin_layout Section
8502 \begin_layout Standard
8505 KOMA-Script Letter (V.
8509 \begin_inset space ~
8513 \begin_inset CommandInset ref
8515 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"
8542 \begin_inset space ~
8546 \begin_inset CommandInset ref
8548 reference "subsec:Hebrew"
8556 ) document classes .
8559 \begin_layout Subsection
8563 \begin_layout Standard
8568 provides support for the
8573 class for writing letters according to the standards of the German Standards Institute (
8575 Deutsches Institut für Normung,
8579 The file in the menu
8584 ile\SpecialChar menuseparator
8586 \begin_inset space ~
8594 \begin_inset space ~
8597 Template\SpecialChar menuseparator
8598 Letters\SpecialChar menuseparator
8601 offers guidance on its use.
8602 The documentation is available from
8603 \begin_inset CommandInset href
8606 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
8614 \begin_layout Subsection
8616 \begin_inset space \space{}
8622 \begin_layout Standard
8626 \begin_inset space \space{}
8631 provides support for the
8636 class for writing letters according to French conventions.
8637 The file in the menu
8642 ile\SpecialChar menuseparator
8644 \begin_inset space ~
8652 \begin_inset space ~
8655 Template\SpecialChar menuseparator
8656 Letters\SpecialChar menuseparator
8658 \begin_inset space \space{}
8663 offers guidance on its use.
8666 \begin_layout Subsection
8668 \begin_inset space \space{}
8674 \begin_layout Standard
8678 \begin_inset space \space{}
8683 provides support for
8688 another \SpecialChar LaTeX
8689 class for writing letters,
8690 but also faxes and envelopes,
8692 The file in the menu
8697 ile\SpecialChar menuseparator
8699 \begin_inset space ~
8707 \begin_inset space ~
8710 Template\SpecialChar menuseparator
8711 Letters\SpecialChar menuseparator
8713 \begin_inset space \space{}
8718 offers guidance on its use.
8719 The documentation is available from
8720 \begin_inset CommandInset href
8723 target "http://mirrors.ctan.org/macros/latex/contrib/lettre/lettre.pdf"
8731 \begin_layout Subsection
8733 \begin_inset space \thinspace{}
8739 \begin_layout Standard
8743 \begin_inset space \thinspace{}
8748 provides support for the
8753 class for writing letters in German.
8754 The file in the menu
8759 ile\SpecialChar menuseparator
8761 \begin_inset space ~
8769 \begin_inset space ~
8772 Template\SpecialChar menuseparator
8773 Letters\SpecialChar menuseparator
8775 \begin_inset space \thinspace{}
8780 offers guidance on its use.
8781 The documentation is available from
8782 \begin_inset CommandInset href
8785 target "http://mirrors.ctan.org/macros/latex/contrib/g-brief/g-brief.pdf"
8793 \begin_layout Section
8797 \begin_layout Subsection
8801 \begin_layout Standard
8811 class for creating presentations.
8812 The file in the menu
8817 ile\SpecialChar menuseparator
8819 \begin_inset space ~
8827 \begin_inset space ~
8830 Template\SpecialChar menuseparator
8831 Presentations\SpecialChar menuseparator
8836 Help\SpecialChar menuseparator
8837 Specific Manuals\SpecialChar menuseparator
8838 Beamer Presentations
8840 offers guidance on its use.
8841 The documentation is available from
8842 \begin_inset CommandInset href
8845 target "http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf"
8853 \begin_layout Subsection
8856 Foil\SpecialChar TeX
8860 \begin_inset CommandInset label
8869 \begin_layout Standard
8875 updated by the \SpecialChar LyX
8879 \begin_layout Subsubsection
8883 \begin_layout Standard
8886 Foil\SpecialChar TeX
8893 document class to make slides for overhead projectors.
8894 There are two document classes that can do this:
8899 document class (section
8900 \begin_inset space ~
8904 \begin_inset CommandInset ref
8906 reference "sec:slitex"
8916 Foil\SpecialChar TeX
8920 As of 2023 the former has continued to be maintained whereas
8922 Foil\SpecialChar TeX
8925 has not been maintained since 2008.
8926 This section documents the latter.
8927 If your machine doesn’t have the
8929 Foil\SpecialChar TeX
8932 document class installed,
8933 you’ll probably have to use the
8938 If you want to install the
8943 it is available from
8944 \begin_inset CommandInset href
8947 target "https://www.ctan.org/pkg/foiltex"
8953 You should also read the
8955 Installing New Document Classes
8964 \begin_layout Subsubsection
8968 \begin_layout Standard
8970 to use this document class,
8982 \begin_inset space ~
8988 There are some settings in the
8991 \begin_inset space ~
8996 dialog that you should know about that are specific to this class:
8999 \begin_layout Itemize
9000 Don't change the options
9011 \begin_inset space ~
9017 They're ignored by the
9024 \begin_layout Itemize
9025 The default font size is 20
9026 \begin_inset space \thinspace{}
9029 pt with the other options being 17
9030 \begin_inset space \thinspace{}
9035 \begin_inset space \thinspace{}
9039 \begin_inset space \thinspace{}
9045 \begin_layout Itemize
9054 but all math equations are still typeset in the usual roman font.
9057 \begin_layout Itemize
9060 Foil\SpecialChar TeX
9063 supports A4 and Letter paper sizes as well as a special size for working with 35
9064 \begin_inset space \thinspace{}
9068 It doesn't support A5,
9070 legal or executive paper sizes.
9073 \begin_layout Itemize
9074 Don't bother changing the
9078 settings because they are ignored anyway.
9079 All floats appear where they are defined in the text.
9082 \begin_layout Itemize
9087 setting behaves a bit differently for this class.
9090 Foil\SpecialChar TeX
9093 provides extensive footer and header capabilities including a user-defined logo.
9095 \begin_inset space ~
9099 \begin_inset CommandInset ref
9101 reference "sec:foilfoot"
9107 The title page is treated differently to all other pages in the document and is
9115 has the logo centered at the bottom of the page (if one is defined).
9116 The possible page style choices and what they do are as follows:
9120 \begin_layout Labeling
9121 \labelwidthstring MMMMMMM
9128 The final output contains no page numbers,
9129 or other headers or footers (except footnotes of course).
9133 \begin_layout Labeling
9134 \labelwidthstring MMMMMMM
9141 The final output contains page numbers centered at the bottom of the page.
9142 No other headings or footers (other than footnotes).
9145 \begin_layout Labeling
9146 \labelwidthstring MMMMMMM
9151 Page numbers in lower right corner.
9152 Additional headers and footers are also shown.
9153 This is also the default.
9156 \begin_layout Labeling
9157 \labelwidthstring MMMMMMM
9162 Gives you access to the
9166 package although its use with
9168 Foil\SpecialChar TeX
9171 is discouraged by the writer of the
9173 Foil\SpecialChar TeX
9176 package because of some potential page layout clashes.
9180 \begin_layout Paragraph
9184 \begin_layout Standard
9185 The following options may be used in the extra class options in the
9187 Document\SpecialChar menuseparator
9193 \begin_layout Labeling
9194 \labelwidthstring MMMMMMx
9199 This sets up the page layout for 7.33
9200 \begin_inset space \thinspace{}
9204 \begin_inset space \thinspace{}
9208 which is about the same aspect ratio as a 35
9209 \begin_inset space \thinspace{}
9213 making it a bit easier to work with this medium.
9216 \begin_layout Labeling
9217 \labelwidthstring MMMMMMx
9222 Places a rule across the page below the header on every page except the title page.
9225 \begin_layout Labeling
9226 \labelwidthstring MMMMMMx
9231 Places a rule across the page above the footer on every page except the title page.
9234 \begin_layout Labeling
9235 \labelwidthstring MMMMMMx
9240 This is automatically set each time you create a new
9247 Foil\SpecialChar TeX
9250 to use the dvips driver to rotate those pages that are set as landscape foils.
9253 \begin_layout Labeling
9254 \labelwidthstring MMMMMMx
9259 Simply changes the page dimensions to those of a landscape page but doesn't do any rotation.
9260 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.
9261 Note that this option effectively reverses the roles of the
9269 environments (don't worry these are described in the next section).
9272 \begin_layout Labeling
9273 \labelwidthstring MMMMMMx
9278 Equation numbers on the left.
9281 \begin_layout Labeling
9282 \labelwidthstring MMMMMMx
9287 Flush-left equations.
9290 \begin_layout Subsubsection
9291 Supported Environments
9294 \begin_layout Standard
9295 Most of the environments commonly supported in other classes are also supported by the
9297 Foil\SpecialChar TeX
9301 There are several additional environments provided by
9303 Foil\SpecialChar TeX
9306 as well as a couple added by \SpecialChar LyX
9308 The following environments are shared with other classes:
9311 \begin_layout Standard
9312 \begin_inset Flex Multiple Columns
9315 \begin_layout Itemize
9321 \begin_layout Itemize
9327 \begin_layout Itemize
9333 \begin_layout Itemize
9339 \begin_layout Itemize
9345 \begin_layout Itemize
9352 \begin_layout Itemize
9358 \begin_layout Itemize
9364 \begin_layout Itemize
9370 \begin_layout Itemize
9376 \begin_layout Itemize
9382 \begin_layout Itemize
9388 \begin_layout Itemize
9394 \begin_layout Itemize
9400 \begin_layout Itemize
9406 \begin_layout Itemize
9417 \begin_layout Standard
9419 all the major environments apart from the sectioning environments.
9420 Since foils are essentially self-contained sections,
9421 with a title and body,
9424 Foil\SpecialChar TeX
9427 provides specific commands for starting new foils and these are:
9430 \begin_layout Itemize
9436 \begin_layout Itemize
9442 \begin_layout Standard
9444 also provides slightly modified versions of these two environments called:
9447 \begin_layout Itemize
9453 \begin_layout Itemize
9459 \begin_layout Standard
9460 and the differences will be explained in the next section.
9463 \begin_layout Standard
9464 Since foils are often used in presenting ideas or new theorems and such
9466 Foil\SpecialChar TeX
9469 also provides a comprehensive box of goodies for presenting them:
9472 \begin_layout Standard
9473 \begin_inset Flex Multiple Columns
9476 \begin_layout Itemize
9482 \begin_layout Itemize
9488 \begin_layout Itemize
9494 \begin_layout Itemize
9500 \begin_layout Itemize
9506 \begin_layout Itemize
9512 \begin_layout Itemize
9518 \begin_layout Itemize
9524 \begin_layout Itemize
9530 \begin_layout Itemize
9536 \begin_layout Itemize
9547 \begin_layout Standard
9548 The starred versions are unnumbered while the unstarred versions are numbered.
9549 There are also two list environments added by \SpecialChar LyX
9553 \begin_layout Itemize
9559 \begin_layout Itemize
9565 \begin_layout Standard
9568 Foil\SpecialChar TeX
9571 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.
9572 If you want to change these settings in your document the best place to do so is at the very top of a foil,
9574 \begin_inset space \thinspace{}
9580 \begin_inset space \space{}
9585 straight after the foilhead.
9588 \begin_layout Standard
9590 the following command styles are provided [
9597 \begin_layout Standard
9598 \begin_inset Flex Multiple Columns
9601 \begin_layout Itemize
9605 \begin_inset space ~
9611 \begin_layout Itemize
9617 \begin_layout Itemize
9621 \begin_inset space ~
9627 \begin_layout Itemize
9631 \begin_inset space ~
9637 \begin_layout Itemize
9641 \begin_inset space ~
9648 \begin_layout Plain Layout
9649 \begin_inset space ~
9661 \begin_layout Standard
9662 There are also a few commands provided by
9664 Foil\SpecialChar TeX
9667 that aren't directly supported by \SpecialChar LyX
9668 but I'll tell you what they do and how to use them in section
9669 \begin_inset space ~
9673 \begin_inset CommandInset ref
9675 reference "sec:unsuppfoils"
9683 \begin_layout Subsubsection
9684 Building a Set of Foils
9687 \begin_layout Standard
9688 This section will give a simple introduction to using the different environments to build a set of foils.
9689 If you want to see an example set of foils,
9692 File\SpecialChar menuseparator
9693 Open Example\SpecialChar menuseparator
9694 Presentations\SpecialChar menuseparator
9700 \begin_layout Paragraph
9701 Give It a Title Page
9704 \begin_layout Standard
9705 Unlike other classes that provide
9730 creates the title on a page of its own.
9731 If you leave out the
9735 environment \SpecialChar LaTeX
9736 will substitute the current date (every time you regenerate the output).
9739 \begin_layout Paragraph
9743 \begin_layout Standard
9744 As I mentioned earlier,
9745 there are four ways of starting a new foil.
9746 For portrait foils you should use
9755 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.
9758 \begin_layout Standard
9759 Landscape foils are generated using the
9768 Again the only difference is the spacing between foilhead and body.
9769 Both of the short versions have 0.5
9770 \begin_inset space ~
9773 inches less separation between the foilhead and the body.
9777 \begin_layout Standard
9778 One problem with the support for landscape foils is the requirement that you have to use the
9782 driver to generate the PostScript output otherwise the foils won't be rotated.
9783 It is possible to get landscape foils even if you haven't got the
9787 driver provided you can feed your foils sideways through your printer ;-)
9790 \begin_layout Paragraph
9796 \begin_layout Standard
9797 You can't have two of the same type of these environments directly following each other.
9798 If you use a normal paragraph break,
9800 you will just be extending the previous environment as if you had merged the two environments together.
9802 you need to insert a so-called separator.
9803 Please refer to the section entitled
9814 \begin_layout Paragraph
9818 \begin_layout Standard
9819 You get all the commonly supported list styles found in other classes as well as two new ones.
9820 I'll only describe the new ones here.
9821 If you want to find out more about the other list environments check out the
9826 If you intend to use itemized lists you might also want to read about the
9829 \begin_inset space ~
9833 \begin_inset space ~
9838 dialog described above in section
9839 \begin_inset space ~
9843 \begin_inset CommandInset ref
9845 reference "chap:bullets"
9853 \begin_layout Standard
9854 The two new list styles,
9864 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.
9865 These lists are in fact dedicated variants of the
9870 They do however require that you have the
9877 \begin_layout Paragraph
9881 \begin_layout Standard
9884 Foil\SpecialChar TeX
9887 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.
9888 In fact if you change the float placement settings they are simply ignored.
9891 \begin_layout Paragraph
9892 Page Headers and Footers
9893 \begin_inset CommandInset label
9902 \begin_layout Standard
9906 \begin_inset space ~
9915 are two commands used to control the left-footer text string.
9916 The first is meant to allow you to include a graphic logo on your foils and defaults to
9917 \begin_inset Quotes eld
9922 Foil\SpecialChar TeX
9926 \begin_inset Quotes erd
9930 While the second is meant to provide a classification for the audience,
9934 \begin_inset space \thinspace{}
9940 \begin_inset space \space{}
9944 It is empty by default.
9947 \begin_layout Standard
9948 The remaining page corners can be filled by
9951 \begin_inset space ~
9956 (which defaults to page numbers),
9960 \begin_inset space ~
9968 \begin_inset space ~
9976 \begin_layout Subsubsection
9979 Foil\SpecialChar TeX
9983 \begin_inset CommandInset label
9985 name "sec:unsuppfoils"
9992 \begin_layout Standard
9993 All the commands mentioned below need to be set in a
10003 within another environment.
10006 \begin_layout Paragraph
10010 \begin_layout Standard
10011 All lengths are adjusted using the
10034 should be replaced by the name given to the length you want to change and
10038 is the length value.
10039 All lengths should be specified in units of length such as inches (
10052 ) or relative to some document or font-based length such as
10062 \begin_layout Standard
10063 It's possible to change the spacing between a foilhead and the body of the foil by adjusting the length specified by
10076 \begin_inset space \space{}
10079 in closer to their bodies put the following in the preamble:
10086 foilheadskip}{-0.5in}
10089 \begin_layout Standard
10090 The spacings around floats can be adjusted by setting these lengths:
10093 \begin_layout Labeling
10094 \labelwidthstring MMMMMMMMMMM
10101 Separation between the text and the top of the float
10104 \begin_layout Labeling
10105 \labelwidthstring MMMMMMMMMMM
10112 Separation between the float and the caption
10115 \begin_layout Labeling
10116 \labelwidthstring MMMMMMMMMMM
10123 Separation between the caption and the following text
10126 \begin_layout Labeling
10127 \labelwidthstring MMMMMMMMMMM
10134 You can make the captions narrower than the surrounding text by adjusting this length.
10135 Best done relative to
10144 \begin_layout Standard
10145 There are also several title page related lengths that you may find useful if you have a long title or several authors:
10148 \begin_layout Labeling
10149 \labelwidthstring MMMMMMMMMMM
10156 Separation from headers to
10161 \begin_layout Labeling
10162 \labelwidthstring MMMMMMMMMMM
10180 \begin_layout Labeling
10181 \labelwidthstring MMMMMMMMMMM
10195 \begin_layout Labeling
10196 \labelwidthstring MMMMMMMMMMM
10212 \begin_layout Labeling
10213 \labelwidthstring MMMMMMMMMMM
10229 \begin_layout Standard
10230 The last length related command affects all the list environments.
10241 a list environment then all the vertical spacing between the list items is removed.
10242 Note that this is a command not a length so it doesn't require
10248 like the stuff mentioned above.
10251 \begin_layout Paragraph
10252 Headers and Footers
10255 \begin_layout Standard
10268 commands control whether the logo in the
10272 definition appear on a given page.
10279 in the preamble then none of the foils will have the logo on them.
10280 If you don't want the logo on a particular page place the
10286 directly after the foilhead of that page and the
10292 directly after the next foilhead.
10295 \begin_layout Standard
10296 If you decide to use the
10300 page style setting in the
10303 \begin_inset space ~
10308 dialog you should probably add
10318 to your preamble so headers and footers on landscape pages are correctly placed when rotated.
10319 This is due to some clashes between the page layouts provided by the
10332 \begin_layout Subsection
10336 \begin_layout Standard
10346 class for creating presentations.
10349 File\SpecialChar menuseparator
10350 Open Example\SpecialChar menuseparator
10351 Presentations\SpecialChar menuseparator
10354 offers guidance on its use.
10355 The documentation is available from
10356 \begin_inset CommandInset href
10359 target "http://mirrors.ctan.org/macros/latex/contrib/powerdot/doc/powerdot.pdf"
10367 \begin_layout Subsection
10368 \begin_inset CommandInset label
10370 name "subsec:Seminar"
10379 \begin_layout Standard
10388 document class for creating presentations.
10391 File\SpecialChar menuseparator
10392 Open Example\SpecialChar menuseparator
10393 Presentations\SpecialChar menuseparator
10396 offers guidance on its use.
10397 The documentation is available from
10398 \begin_inset CommandInset href
10401 target "http://mirrors.ctan.org/macros/latex/contrib/seminar/doc/seminar-doc.pdf"
10409 \begin_layout Subsection
10412 Sli\SpecialChar TeX
10416 \begin_inset CommandInset label
10425 \begin_layout Standard
10431 updated by the \SpecialChar LyX
10435 \begin_layout Subsubsection
10439 \begin_layout Standard
10440 This section describes how to use \SpecialChar LyX
10441 to make slides for overhead projectors.
10442 There are two document classes that can do this:
10447 document class and the
10449 Foil\SpecialChar TeX
10453 This section documents the former.
10454 If you’re looking for the documentation for
10456 Foil\SpecialChar TeX
10461 \begin_inset space ~
10465 \begin_inset CommandInset ref
10467 reference "sec:foiltex"
10480 has continued to be maintained whereas
10482 Foil\SpecialChar TeX
10485 has not been maintained since 2008.
10489 \begin_layout Subsubsection
10491 \begin_inset CommandInset label
10493 name "sec:slidesetup"
10500 \begin_layout Standard
10502 to use this document class,
10504 \begin_inset Quotes eld
10512 \begin_inset Quotes erd
10515 from the class list in the
10517 Document\SpecialChar menuseparator
10521 There are some other special things you should know about this class:
10524 \begin_layout Itemize
10525 Don't bother changing the options
10530 They're not supported by the
10538 \begin_layout Itemize
10542 \begin_inset space ~
10547 behaves a bit differently for this class.
10548 The possible choices and what they do are as follows:
10552 \begin_layout Description
10557 The final output contains page numbers in the lower right corner.
10560 \begin_layout Description
10570 but also prints out any time markers you've put in.
10571 This is the default.
10574 \begin_layout Description
10579 The final output contains no page numbers,
10581 or alignment markers.
10585 \begin_layout Itemize
10590 class has an extra option:
10598 \begin_inset Quotes eld
10606 \begin_inset Quotes erd
10609 in the extra class options.
10613 \begin_layout Standard
10614 Using this options allows you to add time markers to
10620 \begin_inset space ~
10624 \begin_inset CommandInset ref
10626 reference "sec:slideNote"
10635 \begin_layout Standard
10636 You can also use the template file to automatically set up a document to use the
10642 File\SpecialChar menuseparator
10644 \begin_inset space ~
10648 \begin_inset space ~
10651 Template\SpecialChar menuseparator
10652 Presentations\SpecialChar menuseparator
10655 to open your new document.
10656 The template file also contains some examples of the special paragraph environments used by this class.
10657 I'll describe those next.
10660 \begin_layout Subsubsection
10661 Paragraph Environments
10664 \begin_layout Paragraph
10665 Supported Environments
10668 \begin_layout Standard
10669 The first thing you'll notice when you start up a new
10673 document is the font size and type:
10674 it's the equivalent of the size
10675 \begin_inset Quotes eld
10683 \begin_inset Quotes erd
10689 \begin_inset space ~
10695 This is also what's used in the output.
10697 \begin_inset Quotes eld
10701 \begin_inset Quotes erd
10704 to remind you that this is a slide.
10705 Your final slides will use a larger font;
10707 you'll have less space.
10709 the larger default screen font isn't WYSIWYG,
10713 \begin_layout Standard
10714 The next thing that becomes obvious is the changes to the paragraph environment pull-down box [at the far-left end of the toolbar].
10715 Most of the paragraph environments you're used to seeing are missing.
10716 There are also five new ones.
10721 class itself only supports certain paragraph environments:
10724 \begin_layout Standard
10727 \begin_inset Flex Multiple Columns
10730 \begin_layout Itemize
10736 \begin_layout Itemize
10742 \begin_layout Itemize
10748 \begin_layout Itemize
10754 \begin_layout Itemize
10760 \begin_layout Itemize
10766 \begin_layout Itemize
10772 \begin_layout Itemize
10778 \begin_layout Itemize
10784 \begin_layout Itemize
10796 \begin_layout Standard
10797 All of the other standard environments,
10798 including the section-heading environments,
10806 \begin_layout Standard
10808 you'll notice the following new environments:
10811 \begin_layout Standard
10814 \begin_inset Flex Multiple Columns
10817 \begin_layout Itemize
10823 \begin_layout Itemize
10829 \begin_layout Itemize
10835 \begin_layout Itemize
10841 \begin_layout Itemize
10848 \begin_layout Plain Layout
10849 \begin_inset space ~
10861 \begin_layout Standard
10862 These five are kind of quirky,
10864 \begin_inset Quotes eld
10868 \begin_inset Quotes erd
10871 in \SpecialChar LyX
10875 doesn't permit you to nest any other paragraph environment into an empty environment.
10877 that's fine and dandy,
10878 but it means that you wouldn't be able to start a slide with anything except plain text.
10880 I've performed a little
10881 \begin_inset Quotes eld
10886 \begin_inset Quotes erd
10892 \begin_layout Paragraph
10893 Quirks of the New Environments
10894 \begin_inset CommandInset label
10896 name "sec:slideQuirk"
10903 \begin_layout Standard
10904 All five of the new paragraph environments are somewhat quirky due to inherent limitations in the current version of \SpecialChar LyX
10906 As I just mentioned,
10908 forbids environments that begin with another environment.
10909 To get around this,
10914 environment isn't a paragraph environment as described in the
10922 \begin_layout Standard
10923 You should consider
10938 \begin_inset Quotes eld
10941 pseudo-environments.
10942 \begin_inset Quotes erd
10945 They look like a section heading or a
10946 \begin_inset Quotes eld
10954 \begin_inset Quotes erd
10957 but really begin a [and,
10959 end the previous] paragraph environment.
10970 \begin_inset Quotes eld
10974 \begin_inset Quotes erd
10977 These two perform some action.
10980 \begin_layout Standard
10981 A common feature of all five environments,
11006 is a rather long-ish label.
11007 The text following this label —
11008 ordinarily the contents of the paragraph environment —
11009 is utterly irrelevant for
11034 completely ignores it.
11036 you can leave these five environments completely empty.
11040 \begin_layout Standard
11045 to put any text after the rather long-ish label,
11047 This could be a short description of the contents of the
11054 enter your descriptive comment and hit
11058 as you normally would.
11061 \begin_layout Subsubsection
11062 Making a Presentation with
11076 \begin_layout Paragraph
11084 \begin_layout Standard
11085 If you're expecting this section to teach you how to actually make a presentation,
11086 you'll be sorely disappointed.
11088 I'll describe all of the ways the
11092 class can assist you in preparing the materials for a presentation.
11093 Filling in the contents,
11101 the \SpecialChar LyX
11105 \begin_layout Standard
11110 environment [in the manner described in section
11111 \begin_inset space ~
11115 \begin_inset CommandInset ref
11117 reference "sec:slideQuirk"
11122 ] tells \SpecialChar LyX
11123 to begin a new slide [duh].
11124 The label for this environment/
11125 \begin_inset Quotes eld
11129 \begin_inset Quotes erd
11133 \begin_inset Quotes eld
11137 \begin_inset Quotes erd
11141 followed by the label,
11143 \begin_inset Quotes eld
11147 \begin_inset Quotes erd
11151 Any text or paragraph environments that follow this one go on the new slide.
11155 \begin_layout Standard
11156 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
11157 (this can be specified in the
11164 once you finish entering the contents of one slide.
11165 If you've entered more text than can physically fit on a slide,
11166 the extra overflows onto a new slide.
11167 I don't recommend doing this,
11169 since the overflow slide won't have any page number on it.
11171 it may interfere with any
11175 you've made to accompany the oversized
11182 \begin_layout Standard
11191 environments work the same way as the
11196 They both create an
11197 \begin_inset Quotes eld
11201 \begin_inset Quotes erd
11204 followed by a label [
11205 \begin_inset Quotes eld
11209 \begin_inset Quotes erd
11213 \begin_inset Quotes eld
11217 \begin_inset Quotes erd
11222 The color is a stunning magenta instead of blue,
11224 \begin_inset Quotes eld
11228 \begin_inset Quotes erd
11231 will look different,
11232 in style and in length.
11233 The label fonts of all three also differ from one another.
11236 \begin_layout Standard
11242 if the contents of a
11250 exceed the physical size of a slide or sheet of paper,
11251 the extra will overflow onto a new sheet.
11253 you should avoid this.
11254 It defeats the whole purpose of
11265 \begin_layout Paragraph
11275 \begin_layout Standard
11280 is a slide that sits atop another slide.
11281 Perhaps you wish to discuss a figure on the main
11285 before displaying the text associated with it.
11286 One way to accomplish this is tape a flap of dark paper over the part of the
11290 you want to display later.
11293 if you wish to overlap one graph with another,
11295 You would then have to fumble while speaking to align the two separate,
11300 s to align the two graphs.
11305 environment in both cases makes life much easier.
11308 \begin_layout Standard
11313 receives the page number of its
11314 \begin_inset Quotes eld
11318 \begin_inset Quotes erd
11327 \begin_inset Quotes eld
11335 \begin_inset Quotes erd
11342 \begin_layout Plain Layout
11349 \begin_inset Quotes eld
11357 \begin_inset Quotes erd
11362 \begin_inset Quotes eld
11370 \begin_inset Quotes erd
11375 \begin_inset Quotes eld
11383 \begin_inset Quotes erd
11388 \begin_inset space ~
11391 appended to the page number of the parent
11402 you want the contents of both the
11410 to each fit on a single physical slide!
11411 You should probably consider an
11416 \begin_inset Quotes eld
11420 \begin_inset Quotes erd
11429 the \SpecialChar LyX
11434 class provides a visual cue for this:
11435 the label at the start of an
11439 is shorter than that at the start of a
11445 when you generate printable output,
11446 you'll find alignment markers in all four corners of both the
11450 page and its parent
11455 These will assist you in lining up the two physical slides.
11458 \begin_layout Standard
11459 The major problem in overlaying two slides is aligning the contents of the two transparencies.
11460 How much space should you leave for that graph on the second slide?
11462 what if you want a graph and a sentence on second slide,
11463 but there is text on the main transparency that goes in between them?
11464 You could try and insert vertical space of the right size.
11465 The better way is to use
11476 \begin_layout Standard
11477 As their names imply,
11486 are two command-like paragraph environments that make all subsequent text invisible and visible,
11489 \begin_inset space ~
11493 \begin_inset CommandInset ref
11495 reference "sec:slideQuirk"
11500 that you don't place anything
11504 these two environments,
11511 it inserts a centered,
11512 sky-blue label into the page reading
11513 \begin_inset Quotes eld
11516 <Invisible Text Follows>
11517 \begin_inset Quotes erd
11521 For paragraphs following this label,
11531 it doesn't matter which] where they would be contain instead blank space.
11535 \begin_layout Standard
11541 the corresponding centered label is
11542 \begin_inset Quotes eld
11545 <Visible Text Follows>
11546 \begin_inset Quotes erd
11550 Paragraphs following this label behave normally.
11551 Note that the beginning of a new
11565 automatically shuts off an
11570 It's therefore not necessary to use
11581 \begin_layout Standard
11583 it should be obvious how to create overlay transparencies using the proper combination of
11602 \begin_layout Enumerate
11608 including everything that will appear on it,
11609 whether on the main slide or on the
11616 \begin_layout Enumerate
11617 Before each figure or paragraph that will appear only on the
11632 environment after the
11639 \begin_layout Enumerate
11644 immediately following the
11651 \begin_layout Enumerate
11652 Copy the contents of this
11663 \begin_layout Enumerate
11680 \begin_layout Standard
11682 You've just made an
11689 \begin_layout Standard
11690 There's one problem with the way I've designed the \SpecialChar LyX
11696 you can't make text in the middle of a paragraph invisible,
11697 nor make text in the middle of an invisible paragraph visible again.
11698 To accomplish this feat,
11699 you'll need to use some inlined \SpecialChar LaTeX
11704 \begin_layout Plain Layout
11705 The commands of interest are:
11709 \begin_layout Itemize
11714 invisible \SpecialChar ldots
11718 \begin_layout Itemize
11723 visible \SpecialChar ldots
11727 \begin_layout Plain Layout
11729 and need to be marked as \SpecialChar TeX
11732 \begin_inset Quotes eld
11736 \begin_inset Quotes erd
11739 you wish to change goes in between the brackets [and after the
11752 If you don't know how to mark text as \SpecialChar TeX
11754 see the appropriate section of the
11766 \begin_layout Paragraph
11776 \begin_inset CommandInset label
11778 name "sec:slideNote"
11785 \begin_layout Standard
11795 is associated with a
11796 \begin_inset Quotes eld
11800 \begin_inset Quotes erd
11810 the \SpecialChar LyX
11815 class provides visual cues.
11820 is shorter than that of a
11824 [yet longer than that of an
11829 like the label of an
11833 is shockingly magenta.
11839 has the page number of its
11840 \begin_inset Quotes eld
11844 \begin_inset Quotes erd
11853 \begin_inset Quotes eld
11861 \begin_inset Quotes erd
11866 \begin_inset Quotes eld
11874 \begin_inset Quotes erd
11879 \begin_inset Quotes eld
11887 \begin_inset Quotes erd
11892 You can have multiple
11896 s associated with a single
11911 you'll probably want to break up long
11915 s so that they fit on a single sheet of paper.
11918 \begin_layout Standard
11924 it contains anything additional you might want to say about a
11929 It could also be used as a sheet of reminders for a particular
11934 In the case of the latter,
11935 you might want to make use of time markers.
11937 the \SpecialChar LyX
11943 \begin_inset Quotes eld
11947 \begin_inset Quotes erd
11950 support for time markers,
11953 Sli\SpecialChar TeX
11958 you'll have to resort to using the \SpecialChar LaTeX
11962 \begin_layout Standard
11963 To use time markers,
11964 you'll need to specify the extra class option
11965 \begin_inset Quotes eld
11973 \begin_inset Quotes erd
11977 \begin_inset space ~
11981 \begin_inset CommandInset ref
11983 reference "sec:slidesetup"
11989 This option turns on timing marks,
11990 which will appear in the lower-left-hand corner of every
11995 To set what appears in the time marker,
11996 you use the \SpecialChar LaTeX
11998 \begin_inset Quotes eld
12008 \begin_inset Quotes erd
12012 \begin_inset Quotes eld
12022 \begin_inset Quotes erd
12026 The arguments of both commands are time measured in seconds.
12028 \begin_inset Quotes eld
12038 \begin_inset Quotes erd
12041 sets the time marker to a given time.
12043 \begin_inset Quotes eld
12053 \begin_inset Quotes erd
12056 increments the time marker by the specified amount.
12057 Using time markers and
12062 you can remind yourself how much time to spend on a particular
12069 \begin_layout Standard
12070 There's one last feature to describe.
12072 you'd like to print out all of your
12080 s on transparencies while printing all of your
12098 with which it is associated.
12099 What's a person to do?
12102 \begin_layout Standard
12104 there are two \SpecialChar LaTeX
12105 commands that allow you to select what to print out.
12106 Both must be placed into the preamble of your document.
12108 \begin_inset Quotes eld
12120 \begin_inset Quotes erd
12123 will cause the output to contain only the
12134 \begin_inset Quotes eld
12146 \begin_inset Quotes erd
12149 prevents the output of anything but
12154 I'd advise placing both commands in the preamble and initially comment both out.
12155 You can then preview your entire presentation as you write.
12156 When you're done writing,
12157 you can then uncomment one of the two to select what you want to print.
12158 I like to uncomment
12159 \begin_inset Quotes eld
12171 \begin_inset Quotes erd
12175 print to a file with
12176 \begin_inset Quotes eld
12184 \begin_inset Quotes erd
12188 comment it back out,
12190 \begin_inset Quotes eld
12202 \begin_inset Quotes erd
12206 \begin_inset Quotes eld
12214 \begin_inset Quotes erd
12218 I can then send either file to a printer,
12219 loading transparencies or plain paper as appropriate.
12222 \begin_layout Standard
12223 You can also provide other arguments to the
12224 \begin_inset Quotes eld
12234 \begin_inset Quotes erd
12238 \begin_inset Quotes eld
12248 \begin_inset Quotes erd
12252 See a good \SpecialChar LaTeX
12256 \begin_layout Subsubsection
12261 Class Template File
12264 \begin_layout Standard
12265 I have also provided a template file with the
12271 begin your new presentation with
12273 File\SpecialChar menuseparator
12275 \begin_inset space ~
12279 \begin_inset space ~
12282 Template\SpecialChar menuseparator
12283 Presentations\SpecialChar menuseparator
12287 Your new \SpecialChar LyX
12288 presentation file will contain an example
12309 additionally contain an example of the use of
12319 the preamble will contain:
12322 \begin_layout LyX-Code
12323 % Uncomment to print out only slides and overlays
12326 \begin_layout LyX-Code
12330 \begin_layout LyX-Code
12336 \begin_inset Newline newline
12342 \begin_layout LyX-Code
12343 % Uncomment to print out only notes
12346 \begin_layout LyX-Code
12350 \begin_layout LyX-Code
12358 \begin_layout Standard
12360 I created this class to support the \SpecialChar LaTeX2e
12362 \begin_inset Quotes eld
12367 Sli\SpecialChar TeX
12371 \begin_inset Quotes erd
12375 one of the built-in \SpecialChar LaTeX2e
12377 Neither I nor the rest of the \SpecialChar LyX
12378 Team endorse or oppose the use of this built-in slide class.
12379 It's here if you want it or need it.
12380 There exist other \SpecialChar LaTeX2e
12381 classes for creating presentations,
12387 \begin_inset space ~
12391 \begin_inset CommandInset ref
12393 reference "sec:foiltex"
12403 \begin_inset space ~
12407 \begin_inset CommandInset ref
12409 reference "subsec:Seminar"
12418 Try them out to see what sort of alternative they provide.
12421 \begin_layout Section
12425 \begin_layout Subsection
12429 \begin_layout Standard
12430 Report classes are sort of a hybrid between book and article classes:
12432 they provide parts,
12433 chapters and sections but does not provide frontmatter,
12436 like article classes,
12437 they provide abstract paragraph styles and are one-sided by default.
12439 they do not start a new chapter on the right hand page (even in two-side mode).
12442 \begin_layout Standard
12443 All externally maintained
12447 document classes that are officially supported by \SpecialChar LyX
12448 are described in the Collections (section
12449 \begin_inset space ~
12453 \begin_inset CommandInset ref
12455 reference "sec:Collections"
12463 \begin_layout Itemize
12466 Japanese Report (Standard Class,
12471 Japanese Report (Standard Class)
12475 \begin_inset space ~
12479 \begin_inset CommandInset ref
12481 reference "subsec:Japanese"
12489 \begin_layout Itemize
12496 \begin_inset space ~
12500 \begin_inset CommandInset ref
12502 reference "subsec:KOMA-Script"
12510 \begin_layout Itemize
12513 Report (Standard Class with Extra Font Sizes)
12517 \begin_inset space ~
12521 \begin_inset CommandInset ref
12523 reference "subsec:Extra-font-sizes"
12531 \begin_layout Itemize
12534 Polish Report (MW Bundle)
12538 \begin_inset space ~
12542 \begin_inset CommandInset ref
12544 reference "subsec:Polish-M.W.collection"
12555 \begin_layout Section
12559 \begin_layout Standard
12565 we assemble document classes that help to write drama or movie scripts.
12566 The category is also open for other scripts,
12567 such as lecture scripts,
12568 for which no classes are officially supported yet by \SpecialChar LyX
12572 \begin_layout Subsection
12576 \begin_layout Standard
12582 \begin_layout Subsubsection
12586 \begin_layout Standard
12591 is for writing plays.
12592 The format is more decorative than
12597 \begin_inset space ~
12601 \begin_inset CommandInset ref
12603 reference "subsec:Hollywood"
12608 and much less standardized.
12609 This format should be suitable for workshops.
12612 \begin_layout Subsubsection
12616 \begin_layout Standard
12622 \begin_inset space ~
12626 \begin_inset CommandInset ref
12628 reference "subsec:Special-problems-Hollywood"
12635 \begin_layout Subsubsection
12639 \begin_layout Standard
12644 names as labels then cross-reference the label to insert the name.
12645 The cross-reference dialog will show the current cast of characters.
12648 \begin_layout Subsubsection
12649 Paper size and Margins
12652 \begin_layout Standard
12660 \begin_layout Subsubsection
12664 \begin_layout Standard
12665 The following environments are available.
12670 to get the bind keys shown at the right.
12673 \begin_layout Itemize
12677 \begin_inset Newline newline
12682 You should not have to use this,
12683 but it is here for anything that does not fit otherwise.
12686 \begin_layout Itemize
12690 \begin_inset space \hfill{}
12694 \begin_inset Newline newline
12699 Used to describe stage setting and the action.
12700 First use of speaker names in all CAPs.
12703 \begin_layout Itemize
12707 \begin_inset space \hfill{}
12711 \begin_inset Newline newline
12716 Automatically numbered.
12717 On screen it will be arabic,
12718 but will print as Roman.
12721 \begin_layout Itemize
12725 \begin_inset space \hfill{}
12729 \begin_inset Newline newline
12739 It is just centered text.
12742 \begin_layout Itemize
12746 \begin_inset space \hfill{}
12750 \begin_inset Newline newline
12755 Not automatically numbered.
12756 You supply the number.
12757 This is because I couldn't figure out how.
12760 \begin_layout Itemize
12764 \begin_inset space \hfill{}
12768 \begin_inset Newline newline
12773 A special case of Narrative to describe the setting and action as the curtain rises.
12776 \begin_layout Itemize
12780 \begin_inset space \hfill{}
12784 \begin_inset Newline newline
12789 The speaker's (actor's) title,
12790 centered in all CAPS.
12793 \begin_layout Itemize
12797 \begin_inset space \hfill{}
12801 \begin_inset Newline newline
12806 Instructions to the speaker.
12807 The parentheses are automatically inserted.
12808 The ( will appear on screen,
12809 but both will be in the printed play.
12810 This environment is only used within
12817 \begin_layout Itemize
12821 \begin_inset space \hfill{}
12825 \begin_inset Newline newline
12830 What the Speaker says.
12833 \begin_layout Itemize
12837 \begin_inset space \hfill{}
12841 \begin_inset Newline newline
12846 The curtain comes down.
12849 \begin_layout Itemize
12853 \begin_inset space \hfill{}
12859 \begin_layout Itemize
12863 \begin_inset space \hfill{}
12869 \begin_layout Itemize
12873 \begin_inset space \hfill{}
12879 \begin_layout Standard
12883 \begin_layout Subsection
12884 \begin_inset CommandInset label
12886 name "subsec:Hollywood"
12890 Hollywood (Hollywood spec scripts)
12893 \begin_layout Standard
12899 \begin_layout Subsubsection
12903 \begin_layout Standard
12904 Getting the format of a Hollywood script right is a
12905 \begin_inset Quotes eld
12909 \begin_inset Quotes erd
12912 It is designed to make the readers focus on content and to be easy and familiar for the actors to read.
12913 Each page of a script should be one minute of film.
12914 Nothing goes in a script that you cannot see or hear on screen.
12915 The courier 12 pt font should be used throughout.
12919 \begin_layout Subsubsection
12920 \begin_inset CommandInset label
12922 name "subsec:Special-problems-Hollywood"
12929 \begin_layout Standard
12930 Speakers' lines should
12934 break in mid-sentence.
12935 If a speaker's lines continue over a page break,
12940 title followed by (Cont'd).
12943 \begin_layout Subsubsection
12947 \begin_layout Standard
12952 names as labels then cross-reference the label to insert the name.
12953 The cross-reference dialog will show the current cast of characters.
12954 You can use this to insert the speaker name in narratives also.
12957 \begin_layout Subsubsection
12958 Paper size and Margins
12961 \begin_layout Standard
12969 \begin_layout Subsubsection
12973 \begin_layout Standard
12974 The following environments are available.
12979 to get the bind keys shown at the right.
12982 \begin_layout Itemize
12986 \begin_inset Newline newline
12991 Used where nothing else works.
12995 \begin_layout Itemize
13001 \begin_inset space \hfill{}
13009 \begin_inset Newline newline
13012 Usually followed by something like
13013 \begin_inset Quotes eld
13016 on Sally waking up.
13017 \begin_inset Quotes erd
13023 \begin_layout Itemize
13027 \begin_inset space \hfill{}
13031 \begin_inset Newline newline
13036 Introduces a new INTERIOR camera set-up.
13037 Always followed by DAY or NIGHT,
13038 or something similar to define the lighting required.
13039 Everthing on this line in CAPS.
13042 \begin_layout Itemize
13046 \begin_inset space \hfill{}
13050 \begin_inset Newline newline
13055 Introduces a new EXTERIOR camera set-up.
13056 Everthing on this line in CAPS.
13059 \begin_layout Itemize
13063 \begin_inset space \hfill{}
13067 \begin_inset Newline newline
13072 The character speaking.
13075 \begin_layout Itemize
13079 \begin_inset space \hfill{}
13083 \begin_inset Newline newline
13088 Instructions to the speaker.
13089 The () are automatically inserted.
13092 \begin_layout Itemize
13096 \begin_inset space \hfill{}
13100 \begin_inset Newline newline
13112 \begin_layout Itemize
13116 \begin_inset space \hfill{}
13120 \begin_inset Newline newline
13125 Camera movement instruction.
13127 \begin_inset space \thinspace{}
13131 \begin_inset space \space{}
13137 \begin_layout Itemize
13141 \begin_inset space \hfill{}
13147 \begin_layout Itemize
13151 \begin_inset space \hfill{}
13157 \begin_layout Itemize
13161 \begin_inset space \hfill{}
13167 \begin_layout Itemize
13171 \begin_inset space \hfill{}
13177 \begin_layout Subsubsection
13181 \begin_layout Itemize
13186 \begin_layout Itemize
13191 \begin_layout Itemize
13193 \begin_inset space \thinspace{}
13201 \begin_layout Itemize
13207 \begin_layout Itemize
13212 \begin_layout Itemize
13217 \begin_layout Chapter
13221 \begin_layout Section
13222 Academic Field Specifics
13225 \begin_layout Subsection
13227 Hazard and Precautionary Statements
13230 \begin_layout Standard
13231 This module provides two insets and a paragraph style to typeset numbers and phrases of chemical hazard and precautionary statements.
13232 For a description see
13234 File\SpecialChar menuseparator
13235 Open Example\SpecialChar menuseparator
13236 Modules\SpecialChar menuseparator
13237 Hazard and Precautionary Statements
13241 Help\SpecialChar menuseparator
13242 Specific Manuals\SpecialChar menuseparator
13243 Hazard and Precautionary Statements
13248 \begin_layout Subsection
13252 Risk and Safety Statements
13255 \begin_layout Standard
13256 This module provides two insets,
13266 accessible via the menu
13271 nsert\SpecialChar menuseparator
13273 \begin_inset space ~
13278 and an environment to typeset numbers and phrases of chemical risk and safety statements.
13281 \begin_layout Subsection
13285 \begin_layout Standard
13286 This module provides specific environments useful for linguistics (numbered examples,
13290 Discourse Representation Structures,
13292 You can obtain information about this module in
13297 elp\SpecialChar menuseparator
13303 \begin_inset space ~
13306 Manuals\SpecialChar menuseparator
13315 File\SpecialChar menuseparator
13316 Open Example\SpecialChar menuseparator
13317 Modules\SpecialChar menuseparator
13323 \begin_layout Section
13327 \begin_layout Subsection
13331 \begin_layout Standard
13332 This module supports the Braille script.
13333 It requires the \SpecialChar LaTeX
13339 This and its documentation can be obtained from
13340 \begin_inset CommandInset href
13343 target "https://www.ctan.org/pkg/braille"
13354 elp\SpecialChar menuseparator
13360 \begin_inset space ~
13363 Manuals\SpecialChar menuseparator
13372 File\SpecialChar menuseparator
13373 Open Example\SpecialChar menuseparator
13374 Modules\SpecialChar menuseparator
13380 \begin_layout Section
13381 Annotation & Revision
13384 \begin_layout Subsection
13388 \begin_layout Standard
13389 This module provides “FiXme” (marginal) annotations for document revision purposes.
13390 A list of annotations can be produced by using the “List of FIXMEs” in the outline panel.
13391 The annotations are customizable via the LaTeX preamble.
13396 documentation which can be obtained from
13397 \begin_inset CommandInset href
13400 target "http://mirrors.ctan.org/macros/latex/contrib/fixme/fixme.pdf"
13408 \begin_layout Standard
13415 the notes are only displayed in “draft” mode (if the option “draft” has been inserted in
13417 Document\SpecialChar menuseparator
13418 Settings\SpecialChar menuseparator
13419 Document Class\SpecialChar menuseparator
13421 \begin_inset space ~
13424 Options\SpecialChar menuseparator
13428 To display them always,
13437 Document\SpecialChar menuseparator
13438 Settings\SpecialChar menuseparator
13441 \begin_inset space ~
13449 \begin_layout Subsection
13453 \begin_layout Standard
13454 This module provides various kinds of annotations for PDF output.
13457 Help\SpecialChar menuseparator
13459 \begin_inset space ~
13462 Manuals\SpecialChar menuseparator
13464 \begin_inset space ~
13471 File\SpecialChar menuseparator
13473 \begin_inset space ~
13476 Example\SpecialChar menuseparator
13477 Modules\SpecialChar menuseparator
13479 \begin_inset space ~
13487 \begin_layout Subsection
13493 \begin_layout Standard
13494 This module provides fields and buttons for PDF forms.
13496 \begin_inset CommandInset href
13498 name "hyperref documentation"
13499 target "http://mirrors.ctan.org/macros/latex/contrib/hyperref/doc/hyperref-doc.pdf"
13507 Help\SpecialChar menuseparator
13509 \begin_inset space ~
13512 Manuals\SpecialChar menuseparator
13514 \begin_inset space ~
13521 File\SpecialChar menuseparator
13523 \begin_inset space ~
13526 Example\SpecialChar menuseparator
13527 Modules\SpecialChar menuseparator
13529 \begin_inset space ~
13537 \begin_layout Subsection
13543 \begin_layout Standard
13544 This module defines an inset to typeset reading aids (ruby,
13545 furigana) to Chinese characters.
13559 package (depending on the TeX engine) or a fallback definition.
13562 \begin_layout Subsection
13568 \begin_layout Standard
13569 This module provides custom insets to insert TODO items in your document.
13570 In order to generate a “List of TODOs,” the module provides a paragraph style.
13577 Document\SpecialChar menuseparator
13578 Settings\SpecialChar menuseparator
13579 Document Class\SpecialChar menuseparator
13581 \begin_inset space ~
13584 Options\SpecialChar menuseparator
13587 ) suppresses the output of TODO notes.
13589 \begin_inset CommandInset href
13591 name "todonotes documentation"
13592 target "http://mirrors.ctan.org/macros/latex/contrib/todonotes/todonotes.pdf"
13600 \begin_layout Section
13604 \begin_layout Subsection
13605 APA Style with Natbib
13608 \begin_layout Standard
13609 This module adds support for using natbib together with apacite (the bibliography style need not be
13624 or any bibliography that works with both the natbib and apacite packages.)
13627 \begin_layout Section
13631 \begin_layout Subsection
13632 Fancy Colored Boxes
13635 \begin_layout Standard
13636 This module adds ten custom insets that support colored boxes via the
13643 Help\SpecialChar menuseparator
13645 \begin_inset space ~
13648 Manuals\SpecialChar menuseparator
13654 File\SpecialChar menuseparator
13656 \begin_inset space ~
13659 Example\SpecialChar menuseparator
13660 Modules\SpecialChar menuseparator
13662 \begin_inset space ~
13666 \begin_inset space ~
13672 \begin_inset CommandInset href
13674 name "tcolorbox documentation"
13675 target "http://mirrors.ctan.org/macros/latex/contrib/tcolorbox/tcolorbox.pdf"
13683 \begin_layout Subsection
13687 \begin_layout Standard
13688 This provides the custom insets
13706 to scale and rotate its content.
13709 \begin_layout Standard
13714 is a simple way of reversing text without any other enhancement:
13717 \begin_layout Standard
13718 \begin_inset Flex Reflectbox
13721 \begin_layout Plain Layout
13722 Great Western Railway
13730 \begin_layout Standard
13731 (You will need to use Ctrl-R to see any of these examples.)
13734 \begin_layout Standard
13739 allows you to specify the dimensions of the text or image;
13740 permissible units are em,
13762 it scales by the width factor:
13765 \begin_layout Standard
13766 \begin_inset Flex Resizebox
13769 \begin_layout Plain Layout
13770 \begin_inset Argument 1
13773 \begin_layout Plain Layout
13780 \begin_inset Argument 2
13783 \begin_layout Plain Layout
13789 Great Western Railway
13797 \begin_layout Standard
13802 allows you to rotate its contents around the reference point of the box.
13803 If you wish to rotate the box around a different origin,
13804 place the cursor inside the box and select Insert\SpecialChar menuseparator
13834 or meaningful combinations of these and the counterclockwise rotation angle is expressed in degrees.
13838 \begin_layout Standard
13839 \begin_inset Flex Rotatebox
13842 \begin_layout Plain Layout
13843 \begin_inset Argument 1
13846 \begin_layout Plain Layout
13853 \begin_inset Argument 2
13856 \begin_layout Plain Layout
13862 Great Western Railway
13870 \begin_layout Standard
13871 You can combine boxes as in:
13874 \begin_layout Standard
13875 \begin_inset Flex Rotatebox
13878 \begin_layout Plain Layout
13879 \begin_inset Argument 1
13882 \begin_layout Plain Layout
13889 \begin_inset Argument 2
13892 \begin_layout Plain Layout
13899 \begin_inset Flex Resizebox
13902 \begin_layout Plain Layout
13903 \begin_inset Argument 1
13906 \begin_layout Plain Layout
13913 \begin_inset Argument 2
13916 \begin_layout Plain Layout
13923 \begin_inset Flex Reflectbox
13926 \begin_layout Plain Layout
13927 Great Western Railway
13945 \begin_layout Standard
13950 scales its contents;
13951 select Insert\SpecialChar menuseparator
13952 V-Factor to add a vertical factor.
13953 If the vertical factor is omitted,
13954 the horizontal is used.
13955 Adding different horizontal and vertical values creates distortion as in
13958 \begin_layout Standard
13961 \begin_inset Flex Scalebox
13964 \begin_layout Plain Layout
13965 \begin_inset Argument 1
13968 \begin_layout Plain Layout
13975 \begin_inset Argument 2
13978 \begin_layout Plain Layout
13986 Great Western Railway
13994 \begin_layout Standard
13995 A negative horizontal value reverses the text on the horizontal axis,
13996 a negative vertical value on the vertical axis,
14000 \begin_layout Standard
14001 \begin_inset Flex Scalebox
14004 \begin_layout Plain Layout
14005 \begin_inset Argument 1
14008 \begin_layout Plain Layout
14015 \begin_inset Argument 2
14018 \begin_layout Plain Layout
14024 Great Western Railway
14030 \begin_inset Flex Scalebox
14033 \begin_layout Plain Layout
14034 \begin_inset Argument 1
14037 \begin_layout Plain Layout
14044 \begin_inset Argument 2
14047 \begin_layout Plain Layout
14053 Great Western Railway
14061 \begin_layout Subsection
14065 \begin_layout Standard
14066 This module defines Boxes with section header.
14067 It is mainly intended for the SciPoster Document class.
14070 \begin_layout Subsection
14071 Variable-width Minipages
14074 \begin_layout Standard
14078 \begin_inset space \thinspace{}
14085 Insert\SpecialChar menuseparator
14087 \begin_inset space ~
14101 package provides a variable-width minipage,
14102 whose resulting width is the width of its contents (if this does not exceed the specified maximum width).
14103 The inset has two optional arguments which can be added by placing the cursor inside the minipage and entering
14105 Insert\SpecialChar menuseparator
14107 \begin_inset space \thinspace{}
14118 Insert\SpecialChar menuseparator
14120 \begin_inset space \thinspace{}
14134 File\SpecialChar menuseparator
14135 Open Example\SpecialChar menuseparator
14136 Variable-width Minipages
14141 \begin_layout Section
14145 \begin_layout Subsection
14146 Fix Computer Modern Fonts
14149 \begin_layout Standard
14150 This module uses the
14154 package to improve the appearance of Computer Modern fonts and make them available with arbitrary sizes.
14156 \begin_inset CommandInset href
14158 name "fix-cm documentation"
14159 target "http://mirrors.ctan.org/macros/latex/base/fix-cm.pdf"
14167 \begin_layout Subsection
14169 Kernel Fixes (Obsolete)
14172 \begin_layout Standard
14173 This module loads the \SpecialChar LaTeX
14178 which contains some bug fixes for \SpecialChar LaTeX
14180 If you use this module your typeset document may look different when you process it,
14181 depending on the respective version of
14188 \begin_layout Standard
14194 recent \SpecialChar LaTeX
14195 kernels (as of 2015/01/01) include the functionality of
14204 module is obsolete with newer \SpecialChar LaTeX
14208 \begin_layout Subsection
14209 Minimalistic Insets
14212 \begin_layout Standard
14213 This module redefines several insets (Index,
14215 URL) as being Minimalistic.
14218 \begin_layout Subsection
14219 Title and Preamble Hacks
14222 \begin_layout Standard
14223 This module provides two new paragraph styles:
14226 \begin_layout Enumerate
14231 which puts whatever is entered into it into the preamble.
14234 to include preamble code in the body of a LyX document.
14237 \begin_layout Enumerate
14242 which that will put its contents into the body of the LaTeX document,
14250 This is useful for making branches and notes in title-related material.
14252 if you put these in a
14257 this signals to LyX to output
14264 which may then come too early.)
14267 \begin_layout Section
14271 \begin_layout Subsection
14275 \begin_layout Standard
14276 This module uses the
14280 package for algorithm floats rather than LyX’s home-brewed algorithm floats.
14281 Use the Algorithm paragraph style to enter and indent the algorithm.
14283 \begin_inset CommandInset href
14285 name "algorithm2e documentation"
14286 target "http://mirrors.ctan.org/macros/latex/contrib/algorithm2e/doc/algorithm2e.pdf"
14294 \begin_layout Subsection
14295 Bilingual Captions AKA Multilingual Captions
14298 \begin_layout Standard
14299 This module provides the paragraph style
14302 \begin_inset space ~
14307 with which to typeset bilingual captions.
14308 Within this paragraph style
14310 Insert\SpecialChar menuseparator
14313 allows you to enter the desired second language using one of the babel names.
14316 File\SpecialChar menuseparator
14318 \begin_inset space ~
14321 Example\SpecialChar menuseparator
14322 Modules\SpecialChar menuseparator
14324 \begin_inset space ~
14331 Help\SpecialChar menuseparator
14333 \begin_inset space ~
14336 Manuals\SpecialChar menuseparator
14338 \begin_inset space ~
14343 further information on its use.
14346 \begin_layout Subsection
14347 Number Figures by Section
14350 \begin_layout Standard
14351 This module resets the figure number at section start and prepends the section number to the figure number,
14352 as in “Figure 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
14355 \begin_layout Subsection
14356 Number Tables by Section
14359 \begin_layout Standard
14360 This module resets the table number at section start and prepends the section number to the table number,
14361 as in “Table 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
14364 \begin_layout Section
14368 \begin_layout Subsection
14372 \begin_layout Standard
14373 This module adds an endnote inset,
14374 in addition to footnotes.
14380 which has some limitations but works with older \SpecialChar LaTeX
14381 distributions as well.
14384 Insert\SpecialChar menuseparator
14385 Custom Inset\SpecialChar menuseparator
14388 to insert an endnote and
14390 Insert\SpecialChar menuseparator
14391 List/Contents/References\SpecialChar menuseparator
14394 to insert the endnotes list where you want the endnotes to appear.
14397 Help\SpecialChar menuseparator
14408 \begin_layout Subsection
14409 Endnotes (Extended)
14412 \begin_layout Standard
14413 This module adds an endnote inset,
14414 in addition to footnotes.
14419 package which is more powerful and customizable than the
14424 but requires a fairly modern \SpecialChar LaTeX
14425 distribution (with \SpecialChar LaTeX
14429 Insert\SpecialChar menuseparator
14431 \begin_inset space ~
14434 Inset\SpecialChar menuseparator
14437 to insert an endnote and
14439 Insert\SpecialChar menuseparator
14440 List/Contents/References\SpecialChar menuseparator
14443 to insert the endnotes list where you want the endnotes to appear.
14446 Help\SpecialChar menuseparator
14448 \begin_inset space ~
14461 \begin_layout Subsection
14462 Footnotes as Endnotes (Basic)
14465 \begin_layout Standard
14466 This module sets all footnotes as endnotes.
14472 which has some limitations but works with older \SpecialChar LaTeX
14473 distributions as well.
14476 Insert\SpecialChar menuseparator
14477 List/Contents/References\SpecialChar menuseparator
14480 to insert the endnotes list where you want the endnotes to appear.
14483 Help\SpecialChar menuseparator
14485 \begin_inset space ~
14498 \begin_layout Subsection
14499 Footnotes as Endnotes (Extended)
14502 \begin_layout Standard
14503 This module sets all footnotes as endnotes.
14508 package which is more powerful and customizable than then
14513 but requires a fairly modern \SpecialChar LaTeX
14514 distribution (with \SpecialChar LaTeX
14518 Insert\SpecialChar menuseparator
14519 List/Contents/References\SpecialChar menuseparator
14522 to insert the endnotes list where you want the endnotes to appear.
14525 Help\SpecialChar menuseparator
14527 \begin_inset space ~
14540 \begin_layout Section
14545 \begin_layout Subsection
14549 \begin_layout Standard
14550 This module provides support for the
14554 package to print chess games.
14557 File\SpecialChar menuseparator
14558 Open Example\SpecialChar menuseparator
14559 Articles\SpecialChar menuseparator
14562 where you will find
14565 \begin_inset space ~
14573 \begin_inset space ~
14579 \begin_inset CommandInset href
14581 name "chessboard documentation"
14582 target "http://mirrors.ctan.org/macros/latex/contrib/chessboard/chessboard.pdf"
14590 \begin_layout Subsection
14591 Lilypond Music Notation
14594 \begin_layout Standard
14595 This module provides an inset via
14600 nsert\SpecialChar menuseparator
14601 Custom Inset\SpecialChar menuseparator
14604 in which to enter code for the LilyPond music editor.
14605 It will then be processed in the output.
14608 Help\SpecialChar menuseparator
14609 Specific Manuals\SpecialChar menuseparator
14614 File\SpecialChar menuseparator
14615 Open Example\SpecialChar menuseparator
14616 Modules\SpecialChar menuseparator
14618 \begin_inset space ~
14624 It cannot be used if the modules
14627 \begin_inset space \thinspace{}
14639 \begin_layout Section
14643 \begin_layout Subsection
14645 \begin_inset CommandInset label
14647 name "subsec:Customizable-Lists"
14654 \begin_layout Standard
14655 This module uses the
14659 package to enable the customization of various list environments.
14662 \begin_layout Subsubsection
14663 Custom Enumerate Lists
14666 \begin_layout Standard
14668 The default numbering of numbered lists can be changed by adding an optional argument (menu
14673 nsert\SpecialChar menuseparator
14675 \begin_inset space ~
14680 ) to the first item of each level in the list.
14681 There you add the command
14684 \begin_layout Standard
14692 \begin_layout Standard
14693 in \SpecialChar TeX
14703 \begin_layout Standard
14708 is the first level counter of the enumeration.
14709 To change the numbering for the list sublevels,
14714 ” in the command by the small Roman numeral of the level (
14736 \begin_layout Standard
14743 outputs the counter as a small Roman numeral.
14744 For capital Roman numerals replace
14756 in the command above.
14757 For Arabic numerals use
14765 \begin_inset Quotes eld
14769 \begin_inset Quotes erd
14772 items with capital or small Latin letters use
14788 \begin_layout Standard
14790 \begin_inset Note Greyedout
14793 \begin_layout Plain Layout
14799 You can only number 26
14800 \begin_inset space ~
14803 items with Latin letters,
14804 because this numbering is limited to single letters.
14812 \begin_layout Standard
14813 Here is a list with custom numbering:
14816 \begin_layout Enumerate
14817 \begin_inset Argument 1
14820 \begin_layout Plain Layout
14824 \begin_layout Plain Layout
14843 \begin_inset Separator latexpar
14850 \begin_layout Enumerate
14851 \begin_inset Argument 1
14854 \begin_layout Plain Layout
14858 \begin_layout Plain Layout
14877 \begin_layout Enumerate
14879 \begin_inset Separator latexpar
14886 \begin_layout Enumerate
14887 \begin_inset Argument 1
14890 \begin_layout Plain Layout
14894 \begin_layout Plain Layout
14911 \begin_inset Separator latexpar
14918 \begin_layout Enumerate
14919 \begin_inset Argument 1
14922 \begin_layout Plain Layout
14926 \begin_layout Plain Layout
14948 \begin_layout Standard
14949 For this list these commands were used:
14952 \begin_layout Standard
14963 \begin_inset Newline newline
14971 \begin_inset Newline newline
14979 \begin_inset Newline newline
14989 \begin_layout Standard
14996 makes the label emphasized and
15005 \begin_layout Standard
15006 \begin_inset Note Greyedout
15009 \begin_layout Plain Layout
15015 When you change the label of a list level,
15016 it will be used for all following lists until you change the definition.
15024 \begin_layout Standard
15028 \begin_layout Plain Layout
15046 \begin_layout Subsubsection
15047 Numbered Paragraphs in Reports
15050 \begin_layout Enumerate
15051 Official reports often include numbered paragraphs;
15052 you can achieve this with a variation on the approach outlined in section
15053 \begin_inset space ~
15057 \begin_inset CommandInset ref
15059 reference "sec:How-to-use"
15068 in each command with
15075 \begin_layout Enumerate
15076 These numbered paragraphs were generated by inserting the \SpecialChar TeX
15078 \begin_inset Separator latexpar
15085 \begin_layout Standard
15099 \begin_layout Standard
15100 before the start of the section;
15107 uses the \SpecialChar LaTeX
15108 section counter to generate the first part of the number.
15112 \begin_layout Enumerate
15113 I have ignored the subsection heading in this example because,
15114 with paragraphs numbered in this way,
15115 subsections are less likely to be used.
15118 \begin_layout Subsubsection
15119 Resumed Enumeration
15122 \begin_layout Standard
15126 \begin_layout Plain Layout
15142 \begin_layout Standard
15143 Enumerations can be resumed after intermediate paragraphs:
15146 \begin_layout Enumerate
15147 \begin_inset Argument 1
15150 \begin_layout Plain Layout
15154 \begin_layout Plain Layout
15169 \begin_inset Note Note
15172 \begin_layout Plain Layout
15173 goes back to default numbering
15181 \begin_layout Enumerate
15185 \begin_layout Standard
15189 \begin_layout Enumerate-Resume
15193 \begin_layout Standard
15194 To resume an enumeration,
15202 \begin_layout Standard
15203 \begin_inset Note Greyedout
15206 \begin_layout Plain Layout
15212 If there is no previous enumeration to resume,
15213 you will get a \SpecialChar LaTeX
15222 \begin_layout Standard
15223 Perhaps you might want to resume the list with a different number from the next one.
15224 Or you want to start a new enumeration with a defined number.
15225 This is possible by adding an optional argument to the first list item of a normal enumeration.
15230 \begin_layout Standard
15236 \begin_layout Standard
15241 is the number with which you want to resume the list.
15245 \begin_layout Enumerate
15249 \begin_layout Enumerate
15253 \begin_layout Standard
15254 Enumeration starting at a given value:
15257 \begin_layout Enumerate
15258 \begin_inset Argument 1
15261 \begin_layout Plain Layout
15265 \begin_layout Plain Layout
15277 This enumeration starts at 4
15280 \begin_layout Subsubsection
15282 \begin_inset Index idx
15287 \begin_layout Plain Layout
15297 \begin_layout Standard
15298 In some cases you might want less or more vertical space between the items of a list.
15299 For example if the default space is too much in your opinion in this case:
15302 \begin_layout Itemize
15306 \begin_layout Itemize
15307 with standard spacing
15310 \begin_layout Standard
15311 You can decrease the space by adding an optional argument to the first item of the list.
15312 Add there the command
15316 to get no additional list space like in this example:
15319 \begin_layout Itemize
15320 \begin_inset Argument 1
15323 \begin_layout Plain Layout
15327 \begin_layout Plain Layout
15342 \begin_layout Itemize
15346 \begin_layout Itemize
15350 \begin_layout Standard
15351 To add space you can use several other commands provided by the
15356 \begin_inset Index idx
15361 \begin_layout Plain Layout
15370 For more information see the
15371 \begin_inset CommandInset href
15373 name "enumitem documentation"
15374 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
15382 \begin_layout Standard
15383 There are also many commands available to change the horizontal spacing and indentation.
15384 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
15385 \begin_inset space \thinspace{}
15388 cm so that the number is in the page margin:
15391 \begin_layout Enumerate
15392 \begin_inset Argument 1
15395 \begin_layout Plain Layout
15399 \begin_layout Plain Layout
15417 \begin_layout Enumerate
15418 with negative indentation
15421 \begin_layout Subsubsection
15422 Further Customization
15423 \begin_inset Index idx
15428 \begin_layout Plain Layout
15438 \begin_layout Standard
15439 You can also change the style of description lists.
15443 \begin_layout Standard
15449 \begin_layout Standard
15450 changes the description label font,
15454 \begin_layout Standard
15462 \begin_layout Standard
15463 sets the list style.
15466 \begin_layout Standard
15467 An example where the command
15470 \begin_layout Standard
15479 \begin_layout Standard
15483 \begin_layout Description
15485 \begin_inset space ~
15490 \begin_inset Argument 1
15493 \begin_layout Plain Layout
15497 \begin_layout Plain Layout
15514 Ionizing radiation consists of particles or electromagnetic waves that are energetic enough to detach electrons from atoms or molecules,
15515 therefore ionizing them.
15518 \begin_layout Description
15520 \begin_inset space ~
15524 In computer science,
15525 reference counting is a technique of storing the number of references,
15527 or handles to a resource such as an object,
15529 disk space or other resource.
15532 \begin_layout Standard
15533 There are many more commands and features provided by the
15538 \begin_inset Index idx
15543 \begin_layout Plain Layout
15552 For more information see the
15553 \begin_inset CommandInset href
15555 name "enumitem documentation"
15556 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
15564 \begin_layout Subsection
15570 \begin_layout Standard
15571 This module uses the package
15575 to provide nine new list environments.
15576 Itemized and enumerated lists can be typeset within paragraphs,
15577 as paragraphs and in a compact version.
15578 Most environments have optional arguments to format the labels.
15580 the \SpecialChar LaTeX
15581 list environments itemize and enumerate are extended to use a similar optional argument.
15582 For further details see
15584 File\SpecialChar menuseparator
15585 Open Example\SpecialChar menuseparator
15586 Modules\SpecialChar menuseparator
15588 \begin_inset space ~
15592 \begin_inset space ~
15600 Help\SpecialChar menuseparator
15602 \begin_inset space ~
15605 Manuals\SpecialChar menuseparator
15609 \begin_inset CommandInset href
15611 name "paralist documentation"
15612 target "http://mirrors.ctan.org/macros/latex/contrib/paralist/paralist.pdf"
15620 \begin_layout Section
15621 Literate Programming
15624 \begin_layout Subsection
15628 \begin_layout Standard
15629 This module allows the use of Noweb as a literate programming tool.
15630 The files and the documentation for Noweb can be obtained from
15631 \begin_inset CommandInset href
15634 target "https://www.ctan.org/pkg/noweb"
15640 Literate programming is described in section
15641 \begin_inset space ~
15645 \begin_inset CommandInset ref
15647 reference "sec:Literate-Programming"
15652 and there are three example files:
15655 File\SpecialChar menuseparator
15657 \begin_inset space ~
15660 Example\SpecialChar menuseparator
15661 Modules\SpecialChar menuseparator
15667 File\SpecialChar menuseparator
15669 \begin_inset space ~
15672 Example\SpecialChar menuseparator
15673 Modules\SpecialChar menuseparator
15675 \begin_inset space ~
15682 File\SpecialChar menuseparator
15684 \begin_inset space ~
15687 Example\SpecialChar menuseparator
15688 Modules\SpecialChar menuseparator
15689 Noweb2\SpecialChar LyX
15695 \begin_layout Subsection
15699 \begin_layout Standard
15700 This module uses the
15710 \begin_inset Flex Code
15713 \begin_layout Plain Layout
15719 package in R for dynamic report generation has to be installed for this module to work:
15721 \begin_inset Flex Code
15724 \begin_layout Plain Layout
15725 install.packages(“knitr”)
15733 \begin_layout Standard
15739 \begin_layout Itemize
15740 it depends on R >= 2.14.1.
15742 \begin_inset Flex URL
15745 \begin_layout Plain Layout
15747 http://yihui.name/knitr
15755 \begin_layout Itemize
15760 also has to be installed.
15763 \begin_layout Itemize
15764 It cannot be used if the modules
15767 \begin_inset space ~
15779 \begin_layout Standard
15782 Help\SpecialChar menuseparator
15784 \begin_inset space ~
15787 Manuals\SpecialChar menuseparator
15793 File\SpecialChar menuseparator
15795 \begin_inset space ~
15798 Example\SpecialChar menuseparator
15799 Modules\SpecialChar menuseparator
15801 \begin_inset space ~
15807 \begin_inset space ~
15811 \begin_inset CommandInset ref
15813 reference "sec:Literate-Programming"
15818 for information about literate programming.
15821 \begin_layout Subsection
15825 \begin_layout Standard
15826 This module allows the use of the statistical language S/R as a literate programming tool.
15837 \begin_inset CommandInset href
15840 target "https://www.ctan.org/pkg/includernw"
15846 \begin_inset CommandInset href
15849 target "https://www.ctan.org/pkg/fancyvrb"
15854 are available from CTAN.
15855 It cannot be used if the module
15858 \begin_inset space ~
15866 Help\SpecialChar menuseparator
15867 Specific Manuals\SpecialChar menuseparator
15873 File\SpecialChar menuseparator
15875 \begin_inset space ~
15878 Example\SpecialChar menuseparator
15879 Modules\SpecialChar menuseparator
15883 \begin_inset space ~
15887 \begin_inset CommandInset ref
15889 reference "sec:Literate-Programming"
15894 for information about literate programming.
15897 \begin_layout Section
15901 \begin_layout Subsection
15905 \begin_layout Standard
15906 This modules defines theorem environments and the proof environment using the extended AMS machinery.
15907 Both numbered and unnumbered types are provided.
15909 the theorems are numbered consecutively throughout the document.
15910 This can be changed by loading one of the
15912 AMS Theorems (Numbered by \SpecialChar ldots
15916 It cannot be used if the modules
15922 Standard Theorems (Unnumbered)
15927 \begin_layout Subsection
15928 AMS Theorems (Extended)
15931 \begin_layout Standard
15932 This module defines some additional theorem environments for use with the
15936 package (which must be loaded).
15995 in both numbered and unnumbered forms.
15998 \begin_layout Subsection
15999 AMS Theorems (Extended,
16000 Numbered by Type within Chapters)
16003 \begin_layout Standard
16004 This module defines some additional theorem environments for use with the
16006 AMS Theorems (Numbered by Type within Chapters)
16008 module (which must be loaded).
16057 in both numbered and unnumbered forms.
16060 \begin_layout Standard
16063 AMS Theorems (Extended)
16066 the different theorem types provided here each have a separate counter,
16067 restarted with each new chapter (e.g.,
16129 \begin_layout Subsection
16130 AMS Theorems (Extended,
16134 \begin_layout Standard
16135 This module defines some additional theorem environments for use with the
16137 AMS Theorems (Numbered by Type)
16139 package (which must be loaded).
16188 in both numbered and unnumbered forms.
16191 \begin_layout Standard
16194 AMS Theorems (Extended)
16197 the different theorem types provided here each have a separate counter (e.g.,
16249 \begin_layout Subsection
16250 AMS Theorems (Numbered by Type within Chapters)
16253 \begin_layout Standard
16254 This module defines theorem environments and the proof environment using the extended AMS machinery.
16255 Both numbered and unnumbered types are provided.
16258 \begin_layout Standard
16264 the different theorem types provided here each have a separate counter (e.g.,
16319 The numbering restarts for each chapter:
16334 \begin_layout Standard
16335 It cannot be used if the modules
16347 Standard Theorems (Numbered by Type)
16351 Standard Theorems (Unnumbered)
16356 \begin_layout Subsection
16357 AMS Theorems (Numbered by Type)
16360 \begin_layout Standard
16361 This module defines theorem environments and the proof environment using the extended AMS machinery.
16362 Both numbered and unnumbered types are provided.
16368 the different theorem types provided here each have a separate counter (e.g.,
16423 The numbering’s scope is the whole document.
16424 For chapter- and section-wide numbering,
16425 use one of the ‘within Sections’/‘within Chapters’ modules,
16429 \begin_layout Standard
16430 It cannot be used if the modules
16442 Standard Theorems (Numbered by Type)
16446 Standard Theorems (Unnumbered)
16451 \begin_layout Subsection
16452 Number Equations by Section
16455 \begin_layout Standard
16456 This module resets the equation number at section start and prepends the section number to the equation number,
16464 \begin_layout Subsection
16468 \begin_layout Standard
16469 This module defines some theorem environments for use with non-AMS classes.
16471 the theorems are numbered consecutively throughout the document.
16472 This can be changed by loading one of the
16474 Standard Theorems (Numbered by \SpecialChar ldots
16480 \begin_layout Standard
16481 It cannot be used if the modules
16487 Standard Theorems (Unnumbered)
16492 \begin_layout Subsection
16493 Standard Theorems (Nameable)
16496 \begin_layout Standard
16497 This module facilitates the use of named theorems.
16498 The name of the theorem can be inserted via
16500 Insert\SpecialChar menuseparator
16501 Additional Theorem Text
16506 \begin_layout Subsection
16507 Standard Theorems (Numbered by Chapter)
16510 \begin_layout Standard
16511 This module numbers theorems and the like by chapter (i.e.,
16512 the counter is reset at each chapter start).
16513 Use this module only with document classes that provide a chapter environment.
16516 \begin_layout Standard
16528 \begin_layout Standard
16529 It cannot be used if the module
16531 Standard Theorems (Numbered by Section)
16536 \begin_layout Subsection
16537 Standard Theorems (Numbered by Section)
16540 \begin_layout Standard
16541 This module numbers theorems and the like by section (i.e.,
16542 the counter is reset at each section start).
16552 It cannot be used if the module
16554 Standard Theorems (Numbered by Chapter)
16559 \begin_layout Subsection
16560 Standard Theorems (Numbered by Type within Chapters)
16563 \begin_layout Standard
16564 This module defines some theorem environments for use with non-AMS classes.
16574 the different theorem types provided here each have a separate counter (e.g.,
16629 The numbering is reset at each chapter start.
16632 \begin_layout Standard
16635 AMS Theorems (Numbered by Type)
16639 Standard Theorems (Numbered by Type)
16644 \begin_layout Standard
16645 It cannot be used if any of the modules
16657 Standard Theorems (Unnumbered)
16662 Standard Theorems (Numbered by Sections)
16666 Standard Theorems (Numbered by Type within Sections)
16671 \begin_layout Subsection
16672 Standard Theorems (Numbered by Type within Sections)
16675 \begin_layout Standard
16676 This module defines some theorem environments for use with non-AMS classes.
16686 the different theorem types provided here each have a separate counter (e.g.,
16741 The numbering is reset at each section start.
16744 \begin_layout Standard
16747 AMS Theorems (Numbered by Type)
16751 Standard Theorems (Numbered by Type)
16756 \begin_layout Standard
16757 It cannot be used if any of the modules
16769 Standard Theorems (Unnumbered)
16774 Standard Theorems (Numbered by Chapters)
16778 Standard Theorems (Numbered by Type within Chapters)
16783 \begin_layout Subsection
16784 Standard Theorems (Numbered by Type)
16787 \begin_layout Standard
16788 This module defines some theorem environments for use with non-AMS classes.
16798 the different theorem types provided here each have a separate counter (e.g.,
16853 The numbering’s scope is the whole document.
16854 For chapter- and section-wide numbering,
16855 use one of the “within Chapters”/“within Sections” modules,
16859 \begin_layout Standard
16860 It cannot be used if any of the modules
16872 Standard Theorems (Unnumbered)
16876 AMS Theorems (Numbered by Type)
16881 \begin_layout Subsection
16882 Standard Theorems (Unnumbered)
16885 \begin_layout Standard
16886 This module defines only unnumbered theorem environments and the proof environment,
16887 using the extended AMS machinery.
16888 It cannot be used if either of the modules
16899 \begin_layout Subsection
16903 \begin_layout Standard
16904 This module provides a straightforward way to segregate subequations in LyX.
16907 Help\SpecialChar menuseparator
16908 Math\SpecialChar menuseparator
16914 \begin_layout Section
16918 \begin_layout Subsection
16919 Custom Header/Footer Text
16922 \begin_layout Standard
16923 This module requires the
16926 \begin_inset space ~
16940 ocument\SpecialChar menuseparator
16945 ettings\SpecialChar menuseparator
16947 \begin_inset space ~
16952 dialog to be set to
16957 It adds six environments to document classes which support the
16964 \begin_layout Itemize
16970 \begin_layout Itemize
16976 \begin_layout Itemize
16982 \begin_layout Itemize
16988 \begin_layout Itemize
16994 \begin_layout Itemize
17000 \begin_layout Subsubsection
17001 Fancy Headers and Footers
17004 \begin_layout Standard
17005 The default page layout is rather plain;
17008 Article (Standard Class)
17011 all you get is a centered page number at the bottom of the page.
17012 This document uses the
17017 so it appears to be a bit fancier.
17020 \begin_layout Standard
17024 \begin_inset space ~
17038 ocument\SpecialChar menuseparator
17043 ettings\SpecialChar menuseparator
17047 \begin_inset Quotes eld
17051 \begin_inset Quotes erd
17055 you will find that the page header is divided into three fields,
17056 not surprisingly labeled
17057 \begin_inset Quotes eld
17061 \begin_inset Quotes erd
17066 \begin_inset Quotes eld
17070 \begin_inset Quotes erd
17075 \begin_inset Quotes eld
17079 \begin_inset Quotes erd
17083 The footer is also divided into these three fields.
17084 The \SpecialChar LaTeX
17085 commands to set these fields in the simplest manner are
17114 Suppose you wish to put your name in the upper left hand corner of each page.
17115 Simply insert the following command in the preamble:
17118 \begin_layout LyX-Code
17125 \begin_layout Standard
17126 You will now see your name in the upper left.
17127 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,
17129 \begin_inset space \thinspace{}
17135 \begin_layout LyX-Code
17141 \begin_layout Standard
17144 an easier way to make simple changes.
17150 ocument\SpecialChar menuseparator
17155 ettings\SpecialChar menuseparator
17156 Modules\SpecialChar menuseparator
17157 Page Layout\SpecialChar menuseparator
17158 Custom Header/Footer Text
17161 you will find you have six new environments corresponding to the six fields described above.
17164 \begin_layout Standard
17165 Let's get really fancy:
17166 lets put the section number with the word
17167 \begin_inset Quotes eld
17171 \begin_inset Quotes erd
17175 \begin_inset space \thinspace{}
17179 \begin_inset space \space{}
17182 Section 3) in the upper left,
17183 the page number (e.
17184 \begin_inset space \thinspace{}
17188 \begin_inset space \space{}
17191 Page 4) in the upper right,
17192 your name in the lower left,
17193 and the date in the lower right.
17194 Use your newly enabled environments to add these entries:
17197 \begin_layout LyX-Code
17201 \begin_inset space ~
17220 \begin_layout LyX-Code
17226 \begin_layout LyX-Code
17243 \begin_layout LyX-Code
17255 \begin_layout LyX-Code
17261 \begin_layout LyX-Code
17275 \begin_layout Standard
17276 Make sure you enter the commands
17295 as \SpecialChar TeX
17313 access \SpecialChar LaTeX
17314 ’s section and page counters,
17315 and so print out the current section and page numbers.
17322 simply prints out today’s date.
17325 \begin_layout Standard
17326 The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
17327 If you don't want one of the rules,
17328 set its thickness to 0.
17329 The header rule has a default thickness of 0.4pt,
17330 the footer rule is 0pt.
17331 For this you will need to use \SpecialChar TeX
17335 \begin_layout Standard
17342 headrulewidth}{0.4pt}
17347 \begin_layout Standard
17354 footrulewidth}{0.4pt}
17356 to set the thicknesses.
17359 \begin_layout Standard
17360 You can switch the header/footer settings on and off for individual pages using \SpecialChar TeX
17365 thispagestyle{empty}
17372 thispagestyle{plain}
17379 thispagestyle{fancy}
17382 Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
17385 title pages are marked as plain by default,
17386 while following pages are marked fancy when using the global fancy setting.
17389 \begin_layout Standard
17390 If you want a header or footer to be on the outer side of a two sided document,
17391 you need to use something like:
17394 \begin_layout LyX-Code
17400 \begin_layout LyX-Code
17408 \begin_layout Standard
17409 The first command clears all existing footers avoiding any conflicts with your new command.
17412 \begin_layout Standard
17413 You can enter any of these commands,
17414 the simpler ones in any of your new environments,
17415 the more complex ones as \SpecialChar TeX
17417 at any point in your document and they will take effect on the next page.
17420 \begin_layout Standard
17421 As a final example,
17422 it is possible to include an image in the header or footer.
17423 Suppose you want to put a company logo in the upper left hand corner.
17424 You might try something like this in
17426 Document\SpecialChar menuseparator
17427 Settings\SpecialChar menuseparator
17433 \begin_layout LyX-Code
17440 includegraphics{logo.png}}}
17443 \begin_layout Standard
17445 You may need to preface this with
17449 usepackage{graphics}
17451 if you don't include graphics elsewhere in your document.
17454 \begin_layout Standard
17455 For more information on fancy headers,
17457 \begin_inset Flex Code
17460 \begin_layout Plain Layout
17467 \begin_inset CommandInset href
17470 target "http://www.ctan.org/pkg/fancyhdr"
17478 \begin_layout Subsection
17479 Landscape Document Parts
17482 \begin_layout Standard
17483 This module outputs parts of the document in landscape mode using
17485 Insert\SpecialChar menuseparator
17486 Custom Insets\SpecialChar menuseparator
17491 Insert\SpecialChar menuseparator
17492 Custom Insets\SpecialChar menuseparator
17493 Landscape (Floating)
17498 \begin_layout Subsection
17499 \begin_inset CommandInset label
17501 name "sec:Multiple-Columns"
17508 \begin_layout Standard
17509 This module uses the
17514 \begin_inset Index idx
17519 \begin_layout Plain Layout
17527 package and is independent of the option
17540 ocument\SpecialChar menuseparator
17545 ettings\SpecialChar menuseparator
17547 \begin_inset space ~
17553 If you want to have two columns for the whole document,
17554 you are recommended to use the
17563 For all other cases use this module.
17566 \begin_layout Standard
17567 Footnotes within multiple columns will be placed at the bottom of the page and not under each column.
17568 Within the different columns you can use everything,
17569 with the limitation that for floats you need to check the option
17575 \begin_inset space ~
17585 dit\SpecialChar menuseparator
17591 \begin_inset space ~
17599 \begin_layout Subsubsection
17603 \begin_layout Standard
17604 If you want to have two columns in your text,
17605 insert a multicolumn inset via the menu
17607 Insert\SpecialChar menuseparator
17609 \begin_inset space ~
17612 Insets\SpecialChar menuseparator
17614 \begin_inset space ~
17619 where the columns should start.
17620 Write all text that should be printed in 2
17621 \begin_inset space ~
17624 columns into this inset.
17627 \begin_layout Standard
17628 Here is an example:
17631 \begin_layout Standard
17633 \begin_inset Flex Multiple Columns
17636 \begin_layout Plain Layout
17641 The Adventure of the Empty House
17644 \begin_inset Newline newline
17649 Sir Arthur Conan Doyle
17652 \begin_layout Plain Layout
17655 It was in the spring of the year 1894 that all London was interested,
17656 and the fashionable world dismayed,
17657 by the murder of the Honourable Ronald Adair under most unusual and inexplicable circumstances.
17658 The public has already learned those particulars of the crime which came out in the police investigation,
17659 but a good deal was suppressed upon that occasion,
17660 since the case for the prosecution was so overwhelmingly strong that it was not necessary to bring forward all the facts.
17662 at the end of nearly ten years,
17663 am I allowed to supply those missing links which make up the whole of that remarkable chain.
17664 The crime was of interest in itself,
17665 but that interest was as nothing to me compared to the inconceivable sequel,
17666 which afforded me the greatest shock and surprise of any event in my adventurous life.
17668 after this long interval,
17669 I find myself thrilling as I think of it,
17670 and feeling once more that sudden flood of joy,
17672 and incredulity which utterly submerged my mind.
17673 Let me say to that public,
17674 which has shown some interest in those glimpses which I have occasionally given them of the thoughts and actions of a very remarkable man,
17675 that they are not to blame me if I have not shared my knowledge with them,
17676 for I should have considered it my first duty to do so,
17677 had I not been barred by a positive prohibition from his own lips,
17678 which was only withdrawn upon the third of last month.
17686 \begin_layout Standard
17687 To get 3 or more columns,
17688 set the cursor into the multicolumn inset and use the menu
17690 Insert\SpecialChar menuseparator
17692 \begin_inset space ~
17696 \begin_inset space ~
17702 The number of the desired columns is written into that inset (for 3
17703 \begin_inset space ~
17707 \begin_inset Quotes eld
17711 \begin_inset Quotes erd
17715 \begin_inset Newline newline
17718 Here is an example with 3
17719 \begin_inset space ~
17725 \begin_layout Standard
17726 \begin_inset Flex Multiple Columns
17729 \begin_layout Plain Layout
17732 \begin_inset Argument 1
17735 \begin_layout Plain Layout
17742 It can be imagined that my close intimacy with Sherlock Holmes had interested me deeply in crime,
17743 and that after his disappearance I never failed to read with care the various problems which came before the public.
17744 And I even attempted,
17746 for my own private satisfaction,
17747 to employ his methods in their solution,
17748 though with indifferent success.
17751 which appealed to me like this tragedy of Ronald Adair.
17752 As I read the evidence at the inquest,
17753 which led up to a verdict of willful murder against some person or persons unknown,
17754 I realized more clearly than I had ever done the loss which the community had sustained by the death of Sherlock Holmes.
17755 There were points about this strange business which would,
17757 have specially appealed to him,
17758 and the efforts of the police would have been supplemented,
17759 or more probably anticipated,
17760 by the trained observation and the alert mind of the first criminal agent in Europe.
17762 as I drove upon my round,
17763 I turned over the case in my mind and found no explanation which appeared to me to be adequate.
17764 At the risk of telling a twice-told tale,
17765 I will recapitulate the facts as they were known to the public at the conclusion of the inquest.
17773 \begin_layout Standard
17774 You can have up to 10
17775 \begin_inset space ~
17778 columns if you want to,
17779 but that might not be very pleasant for the readers of your document.
17782 \begin_layout Subsubsection
17783 Columns inside Columns
17786 \begin_layout Standard
17787 You can also have columns inside columns:
17790 \begin_layout Standard
17791 \begin_inset Flex Multiple Columns
17794 \begin_layout Plain Layout
17797 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
17798 at that time governor of one of the Australian colonies.
17799 Adair's mother had returned from Australia to undergo the operation for cataract,
17802 and her daughter Hilda were living together at 427 Park Lane.
17805 \begin_layout Plain Layout
17806 \begin_inset Flex Multiple Columns
17809 \begin_layout Plain Layout
17812 The youth moved in the best society
17813 \begin_inset space ~
17817 so far as was known,
17818 no enemies and no particular vices.
17819 He had been engaged to Miss Edith Woodley,
17821 but the engagement had been broken off by mutual consent some months before,
17822 and there was no sign that it had left any very profound feeling behind it.
17823 For the rest {sic} the man's life moved in a narrow and conventional circle,
17824 for his habits were quiet and his nature unemotional.
17825 Yet it was upon this easy-going young aristocrat that death came,
17826 in most strange and unexpected form,
17827 between the hours of ten and eleven-twenty on the night of March 30,
17836 \begin_layout Plain Layout
17839 Ronald Adair was fond of cards
17840 \begin_inset space ~
17843 – playing continually,
17844 but never for such stakes as would hurt him.
17845 He was a member of the Baldwin,
17847 and the Bagatelle card clubs.
17849 after dinner on the day of his death,
17850 he had played a rubber of whist at the latter club.
17851 He had also played there in the afternoon.
17856 The evidence of those who had played with him
17857 \begin_inset space ~
17864 \begin_inset space ~
17867 – showed that the game was whist,
17868 and that there was a fairly equal fall of the cards.
17869 Adair might have lost five pounds,
17871 His fortune was a considerable one,
17872 and such a loss could not in any way affect him.
17873 He had played nearly every day at one club or other,
17874 but he was a cautious player,
17875 and usually rose a winner.
17876 It came out in evidence that,
17877 in partnership with Colonel Moran,
17878 he had actually won as much as four hundred and twenty pounds in a sitting,
17880 from Godfrey Milner and Lord Balmoral.
17881 So much for his recent history as it came out at the inquest.
17889 \begin_layout Subsubsection
17893 \begin_layout Standard
17894 The examples in this section show some more special features of multiple columns.
17897 \begin_layout Standard
17898 For more features of multiple columns,
17900 \begin_inset CommandInset href
17902 name "documentation"
17903 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
17908 of the \SpecialChar LaTeX
17910 \begin_inset Flex Code
17913 \begin_layout Plain Layout
17922 \begin_layout Paragraph
17926 \begin_layout Standard
17927 To add a preface text for multiple columns,
17928 set the cursor into the multicolumn inset and use the menu
17930 Insert\SpecialChar menuseparator
17934 Write your preface text into that inset.
17935 \begin_inset Newline newline
17938 This is an example with some preface text:
17941 \begin_layout Standard
17942 \begin_inset VSpace bigskip
17948 \begin_layout Standard
17949 \begin_inset Flex Multiple Columns
17952 \begin_layout Plain Layout
17953 \begin_inset Argument 2
17956 \begin_layout Plain Layout
17957 And the story continues and continues and continues and continues\SpecialChar ldots
17965 On the evening of the crime,
17966 he returned from the club exactly at ten.
17967 His mother and sister were out spending the evening with a relation.
17968 The servant deposed that she heard him enter the front room on the second floor,
17969 generally used as his sitting-room.
17970 She had lit a fire there,
17971 and as it smoked she had opened the window.
17972 No sound was heard from the room until eleven-twenty,
17973 the hour of the return of Lady Maynooth and her daughter.
17974 Desiring to say good-night,
17975 she attempted to enter her son's room.
17976 The door was locked on the inside,
17977 and no answer could be got to their cries and knocking.
17979 and the door forced.
17980 The unfortunate young man was found lying near the table.
17981 His head had been horribly mutilated by an expanding revolver bullet,
17982 but no weapon of any sort was to be found in the room.
17990 \begin_layout Standard
17991 You can also use a section heading as the preface if you use a section command as \SpecialChar TeX
17993 For example the command
17996 \begin_layout LyX-Code
17999 subsection{subsection title}
18002 \begin_layout Standard
18003 creates a subsection.
18004 In this example the preface is a subsubsection:
18007 \begin_layout Standard
18008 \begin_inset Flex Multiple Columns
18011 \begin_layout Plain Layout
18012 \begin_inset Argument 2
18015 \begin_layout Plain Layout
18019 \begin_layout Plain Layout
18028 This is a subsubsection heading as a preface
18032 \begin_layout Plain Layout
18046 A minute examination of the circumstances served only to make the case more complex.
18047 In the first place,
18048 no reason could be given why the young man should have fastened the door upon the inside.
18049 There was the possibility that the murderer had done this,
18050 and had afterwards escaped by the window.
18051 The drop was at least twenty feet,
18053 and a bed of crocuses in full bloom lay beneath.
18054 Neither the flowers nor the earth showed any sign of having been disturbed,
18055 nor were there any marks upon the narrow strip of grass which separated the house from the road.
18058 it was the young man himself who had fastened the door.
18059 But how did he come by his death?
18060 No one could have climbed up to the window without leaving traces.
18061 Suppose a man had fired through the window,
18062 he would indeed be a remarkable shot who could with a revolver inflict so deadly a wound.
18064 Park Lane is a frequented thoroughfare;
18065 there is a cab stand within a hundred yards of the house.
18066 No one had heard a shot.
18074 \begin_layout Standard
18075 If there is less vertical space than six text lines is left on the page at the beginning of the multiple columns,
18076 a page break will be inserted before the multiple columns.
18077 Depending on the number of lines of the preface text,
18078 you might want to change this space.
18079 This is done by setting the cursor into the mulitcolumn inset behind the preface (if there is any) and using the menu
18081 Insert\SpecialChar menuseparator
18083 \begin_inset space ~
18087 \begin_inset space ~
18091 \begin_inset space ~
18097 Insert into that inset the amount of space like e.
18098 \begin_inset space \thinspace{}
18102 \begin_inset space \space{}
18106 \begin_inset Quotes eld
18110 \begin_inset Quotes erd
18114 \begin_inset Newline newline
18117 In this example the space is set to 7
18118 \begin_inset space ~
18121 text lines by using
18122 \begin_inset Flex Code
18125 \begin_layout Plain Layout
18134 \begin_inset Flex Code
18137 \begin_layout Plain Layout
18145 needs to be inserted as \SpecialChar TeX
18149 \begin_layout Standard
18150 \begin_inset Flex Multiple Columns
18153 \begin_layout Plain Layout
18154 \begin_inset Argument 3
18157 \begin_layout Plain Layout
18162 \begin_layout Plain Layout
18178 On the evening of the crime,
18179 he returned from the club exactly at ten.
18180 His mother and sister were out spending the evening with a relation.
18181 The servant deposed that she heard him enter the front room on the second floor,
18182 generally used as his sitting-room.
18183 She had lit a fire there,
18184 and as it smoked she had opened the window.
18185 No sound was heard from the room until eleven-twenty,
18186 the hour of the return of Lady Maynooth and her daughter.
18187 Desiring to say good-night,
18188 she attempted to enter her son's room.
18189 The door was locked on the inside,
18190 and no answer could be got to their cries and knocking.
18192 and the door forced.
18193 The unfortunate young man was found lying near the table.
18194 His head had been horribly mutilated by an expanding revolver bullet,
18195 but no weapon of any sort was to be found in the room.
18203 \begin_layout Paragraph
18207 \begin_layout Standard
18208 The amount of space before and after multiple columns can be changed by changing the length
18209 \begin_inset Flex Code
18212 \begin_layout Plain Layout
18221 For example the command
18224 \begin_layout LyX-Code
18232 \begin_layout Standard
18233 in \SpecialChar TeX
18234 Code changes its value to 3
18235 \begin_inset space \thinspace{}
18239 The change must be made before the multiple columns' start.
18240 The predefined value is 13
18241 \begin_inset space \thinspace{}
18247 \begin_layout Standard
18249 \begin_inset Flex Code
18252 \begin_layout Plain Layout
18261 \begin_inset space \thinspace{}
18267 \begin_layout Standard
18271 \begin_layout Plain Layout
18277 multicolsep}{2.5cm}
18285 \begin_layout Standard
18286 \begin_inset Flex Multiple Columns
18289 \begin_layout Plain Layout
18292 All day I turned these facts over in my mind,
18293 endeavouring to hit upon some theory which could reconcile them all,
18294 and to find that line of least resistance which my poor friend had declared to be the starting-point of every investigation.
18295 I confess that I made little progress.
18296 In the evening I strolled across the Park,
18297 and found myself about six o'clock at the Oxford Street end of Park Lane.
18298 A group of loafers upon the pavements,
18299 all staring up at a particular window,
18300 directed me to the house which I had come to see.
18302 thin man with coloured glasses,
18303 whom I strongly suspected of being a plain-clothes detective,
18304 was pointing out some theory of his own,
18305 while the others crowded round to listen to what he said.
18306 I got as near him as I could,
18307 but his observations seemed to me to be absurd,
18308 so I withdrew again in some disgust.
18309 As I did so I struck against an elderly,
18311 who had been behind me,
18312 and I knocked down several books which he was carrying.
18320 \begin_layout Standard
18321 \begin_inset Note Greyedout
18324 \begin_layout Plain Layout
18330 The values you set with
18331 \begin_inset Flex Code
18334 \begin_layout Plain Layout
18342 will be used for all following multiple columns until you change them again.
18350 \begin_layout Standard
18354 \begin_layout Plain Layout
18366 \begin_inset Note Note
18369 \begin_layout Plain Layout
18370 go back to the default
18378 \begin_layout Paragraph
18382 \begin_layout Standard
18383 A column break can be forced by inserting the command
18384 \begin_inset Flex Code
18387 \begin_layout Plain Layout
18395 as \SpecialChar TeX
18396 Code to that position in the text where the column should be broken.
18397 Note that this leads in most cases to whitespace in the text.
18398 \begin_inset Newline newline
18401 Here is an example:
18404 \begin_layout Standard
18405 \begin_inset Flex Multiple Columns
18408 \begin_layout Plain Layout
18411 \begin_inset Quotes eld
18414 You're surprised to see me,
18416 \begin_inset Quotes erd
18424 \begin_layout Plain Layout
18427 I acknowledged that I was.
18430 \begin_layout Plain Layout
18433 \begin_inset Quotes eld
18439 and when I chanced to see you go into this house,
18440 as I came hobbling after you,
18441 I thought to myself,
18442 I'll just step in and see that kind gentleman,
18443 and tell him that if I was a bit gruff in my manner there was not any harm meant,
18444 and that I am much obliged to him for picking up my books.
18445 \begin_inset Quotes erd
18451 \begin_layout Plain Layout
18454 \begin_inset Quotes eld
18457 You make too much of a trifle,
18458 \begin_inset Quotes erd
18463 \begin_inset Quotes eld
18466 May I ask how you knew who I was?
18467 \begin_inset Quotes erd
18470 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
18474 \begin_layout Plain Layout
18486 \begin_layout Plain Layout
18489 \begin_inset Quotes eld
18494 if it isn't too great a liberty,
18495 I am a neighbour of yours,
18496 for you'll find my little bookshop at the corner of Church Street,
18497 and very happy to see you,
18499 Maybe you collect yourself,
18504 \begin_inset space ~
18520 \begin_inset space ~
18525 With five volumes you could just fill that gap on that second shelf.
18529 \begin_inset Quotes erd
18540 \begin_layout Paragraph
18544 \begin_layout Standard
18545 The width of the columns is automatically calculated,
18546 but you can modify the space between the columns.
18547 This is done by changing the length
18548 \begin_inset Flex Code
18551 \begin_layout Plain Layout
18560 Its predefined value is 10
18561 \begin_inset space \thinspace{}
18565 Here is an example where
18566 \begin_inset Flex Code
18569 \begin_layout Plain Layout
18578 \begin_inset space \thinspace{}
18584 \begin_layout Standard
18588 \begin_layout Plain Layout
18602 \begin_layout Standard
18603 \begin_inset Flex Multiple Columns
18606 \begin_layout Plain Layout
18609 My observations of No.
18610 \begin_inset space \space{}
18613 427 Park Lane did little to clear up the problem in which I was interested.
18614 The house was separated from the street by a low wall and railing,
18615 the whole not more than five feet high.
18616 It was perfectly easy,
18618 for anyone to get into the garden,
18619 but the window was entirely inaccessible,
18620 since there was no water pipe or anything which could help the most active man to climb it.
18621 More puzzled than ever,
18622 I retraced my steps to Kensington.
18623 I had not been in my study five minutes when the maid entered to say that a person desired to see me.
18624 To my astonishment it was none other than my strange old book collector,
18626 wizened face peering out from a frame of white hair,
18627 and his precious volumes,
18628 a dozen of them at least,
18629 wedged under his right arm.
18637 \begin_layout Standard
18641 \begin_layout Plain Layout
18653 \begin_inset Note Note
18656 \begin_layout Plain Layout
18657 go back to the default
18665 \begin_layout Paragraph
18669 \begin_layout Standard
18670 Between the columns a rule with a width of the length
18671 \begin_inset Flex Code
18674 \begin_layout Plain Layout
18683 If this rule width is set to 0
18684 \begin_inset space \thinspace{}
18687 pt (this is the default),
18688 the rule is suppressed.
18689 In the following example the rule is 2
18690 \begin_inset space \thinspace{}
18696 \begin_layout Standard
18700 \begin_layout Plain Layout
18706 columnseprule}{2pt}
18714 \begin_layout Standard
18715 \begin_inset Flex Multiple Columns
18718 \begin_layout Plain Layout
18721 \begin_inset Quotes eld
18724 You're surprised to see me,
18726 \begin_inset Quotes erd
18734 \begin_layout Plain Layout
18737 I acknowledged that I was.
18740 \begin_layout Plain Layout
18743 \begin_inset Quotes eld
18749 and when I chanced to see you go into this house,
18750 as I came hobbling after you,
18751 I thought to myself,
18752 I'll just step in and see that kind gentleman,
18753 and tell him that if I was a bit gruff in my manner there was not any harm meant,
18754 and that I am much obliged to him for picking up my books.
18755 \begin_inset Quotes erd
18761 \begin_layout Plain Layout
18764 \begin_inset Quotes eld
18767 You make too much of a trifle,
18768 \begin_inset Quotes erd
18773 \begin_inset Quotes eld
18776 May I ask how you knew who I was?
18777 \begin_inset Quotes erd
18783 \begin_layout Plain Layout
18786 \begin_inset Quotes eld
18791 if it isn't too great a liberty,
18792 I am a neighbour of yours,
18793 for you'll find my little bookshop at the corner of Church Street,
18794 and very happy to see you,
18796 Maybe you collect yourself,
18801 \begin_inset space ~
18817 \begin_inset space ~
18822 With five volumes you could just fill that gap on that second shelf.
18826 \begin_inset Quotes erd
18837 \begin_layout Standard
18838 \begin_inset VSpace defskip
18844 \begin_layout Standard
18845 The rule can be colored by redefining the command
18846 \begin_inset Flex Code
18849 \begin_layout Plain Layout
18858 This is done by inserting the command
18861 \begin_layout LyX-Code
18866 columnseprulecolor}{
18871 \begin_layout Standard
18872 as \SpecialChar TeX
18873 Code before the multicolumn inset.
18875 \begin_inset Flex Code
18878 \begin_layout Plain Layout
18884 in this command by a color of your choice.
18885 You can use all pre- and self-defined colors.
18894 \begin_inset space ~
18899 for more information about pre- and self-defined colors.
18900 To go back to the default color insert the command
18903 \begin_layout LyX-Code
18908 columnseprulecolor}{
18913 \begin_layout Standard
18914 Here is the example with a cyan rule and 1
18915 \begin_inset space \thinspace{}
18918 cm column separation:
18921 \begin_layout Standard
18925 \begin_layout Plain Layout
18934 \begin_layout Plain Layout
18940 columnseprulecolor}{
18950 \begin_layout Standard
18951 \begin_inset Flex Multiple Columns
18954 \begin_layout Plain Layout
18957 \begin_inset Quotes eld
18960 You're surprised to see me,
18962 \begin_inset Quotes erd
18970 \begin_layout Plain Layout
18973 I acknowledged that I was.
18976 \begin_layout Plain Layout
18979 \begin_inset Quotes eld
18985 and when I chanced to see you go into this house,
18986 as I came hobbling after you,
18987 I thought to myself,
18988 I'll just step in and see that kind gentleman,
18989 and tell him that if I was a bit gruff in my manner there was not any harm meant,
18990 and that I am much obliged to him for picking up my books.
18991 \begin_inset Quotes erd
18997 \begin_layout Plain Layout
19000 \begin_inset Quotes eld
19003 You make too much of a trifle,
19004 \begin_inset Quotes erd
19009 \begin_inset Quotes eld
19012 May I ask how you knew who I was?
19013 \begin_inset Quotes erd
19019 \begin_layout Plain Layout
19022 \begin_inset Quotes eld
19027 if it isn't too great a liberty,
19028 I am a neighbour of yours,
19029 for you'll find my little bookshop at the corner of Church Street,
19030 and very happy to see you,
19032 Maybe you collect yourself,
19037 \begin_inset space ~
19053 \begin_inset space ~
19058 With five volumes you could just fill that gap on that second shelf.
19062 \begin_inset Quotes erd
19073 \begin_layout Standard
19077 \begin_layout Plain Layout
19083 columnseprule}{0pt}
19086 \begin_layout Plain Layout
19092 columnseprulecolor}{
19100 \begin_inset Note Note
19103 \begin_layout Plain Layout
19104 go back to the default
19112 \begin_layout Section
19116 \begin_layout Subsection
19117 Custom Paragraph Shapes
19120 \begin_layout Standard
19123 as well as any other text processor uses by default rectangular paragraphs.
19124 For special cases like for example posters,
19125 invitation cards or poems you can modify the paragraph shape to one of your choice.
19126 This module uses the
19130 package to provide over a dozen paragraph shapes as well as commands to define custom shapes.
19133 \begin_layout Subsubsection
19137 \begin_layout Standard
19142 package provides the following shapes:
19145 \begin_layout Standard
19146 \begin_inset Tabular
19147 <lyxtabular version="3" rows="13" columns="3">
19148 <features booktabs="true" islongtable="true" longtabularalignment="center">
19149 <column alignment="left" valignment="middle" width="16col%">
19150 <column alignment="left" valignment="middle" width="40col%">
19151 <column alignment="left" valignment="middle" width="35col%">
19152 <row endhead="true">
19153 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
19156 \begin_layout Plain Layout
19165 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
19168 \begin_layout Plain Layout
19177 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
19180 \begin_layout Plain Layout
19190 <row interlinespace="default">
19191 <cell alignment="left" valignment="top" usebox="none">
19194 \begin_layout Plain Layout
19202 <cell alignment="left" valignment="top" usebox="none">
19205 \begin_layout Plain Layout
19208 Circle with circular hole (in the size of a CD/DVD)
19213 <cell alignment="left" valignment="top" usebox="none">
19216 \begin_layout Plain Layout
19220 take care there is not too much text
19226 <row interlinespace="default">
19227 <cell alignment="left" valignment="top" usebox="none">
19230 \begin_layout Plain Layout
19238 <cell alignment="left" valignment="top" usebox="none">
19241 \begin_layout Plain Layout
19249 <cell alignment="left" valignment="top" usebox="none">
19252 \begin_layout Plain Layout
19256 calculation might fail
19262 <row interlinespace="default">
19263 <cell alignment="left" valignment="top" usebox="none">
19266 \begin_layout Plain Layout
19274 <cell alignment="left" valignment="top" usebox="none">
19277 \begin_layout Plain Layout
19280 Rhomboid (symbolizing a
19281 \begin_inset Quotes eld
19285 \begin_inset Quotes erd
19293 <cell alignment="left" valignment="top" usebox="none">
19296 \begin_layout Plain Layout
19305 <row interlinespace="default">
19306 <cell alignment="left" valignment="top" usebox="none">
19309 \begin_layout Plain Layout
19317 <cell alignment="left" valignment="top" usebox="none">
19320 \begin_layout Plain Layout
19328 <cell alignment="left" valignment="top" usebox="none">
19331 \begin_layout Plain Layout
19340 <row interlinespace="default">
19341 <cell alignment="left" valignment="top" usebox="none">
19344 \begin_layout Plain Layout
19352 <cell alignment="left" valignment="top" usebox="none">
19355 \begin_layout Plain Layout
19363 <cell alignment="left" valignment="top" usebox="none">
19366 \begin_layout Plain Layout
19375 <row interlinespace="default">
19376 <cell alignment="left" valignment="top" usebox="none">
19379 \begin_layout Plain Layout
19387 <cell alignment="left" valignment="top" usebox="none">
19390 \begin_layout Plain Layout
19393 Nut for bolt (hexagon with circular hole)
19398 <cell alignment="left" valignment="top" usebox="none">
19401 \begin_layout Plain Layout
19410 <row interlinespace="default">
19411 <cell alignment="left" valignment="top" usebox="none">
19414 \begin_layout Plain Layout
19422 <cell alignment="left" valignment="top" usebox="none">
19425 \begin_layout Plain Layout
19433 <cell alignment="left" valignment="top" usebox="none">
19436 \begin_layout Plain Layout
19445 <row interlinespace="default">
19446 <cell alignment="left" valignment="top" usebox="none">
19449 \begin_layout Plain Layout
19457 <cell alignment="left" valignment="top" usebox="none">
19460 \begin_layout Plain Layout
19468 <cell alignment="left" valignment="top" usebox="none">
19471 \begin_layout Plain Layout
19480 <row interlinespace="default">
19481 <cell alignment="left" valignment="top" usebox="none">
19484 \begin_layout Plain Layout
19492 <cell alignment="left" valignment="top" usebox="none">
19495 \begin_layout Plain Layout
19503 <cell alignment="left" valignment="top" usebox="none">
19506 \begin_layout Plain Layout
19515 <row interlinespace="default">
19516 <cell alignment="left" valignment="top" usebox="none">
19519 \begin_layout Plain Layout
19527 <cell alignment="left" valignment="top" usebox="none">
19530 \begin_layout Plain Layout
19533 Normal/reversed rain drop
19538 <cell alignment="left" valignment="top" usebox="none">
19541 \begin_layout Plain Layout
19545 calculation might fail
19551 <row interlinespace="default">
19552 <cell alignment="left" valignment="top" usebox="none">
19555 \begin_layout Plain Layout
19564 <cell alignment="left" valignment="top" usebox="none">
19567 \begin_layout Plain Layout
19570 The \SpecialChar TeX
19576 <cell alignment="left" valignment="top" usebox="none">
19579 \begin_layout Plain Layout
19588 <row interlinespace="default">
19589 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
19592 \begin_layout Plain Layout
19596 \begin_inset Newline newline
19604 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
19607 \begin_layout Plain Layout
19610 Triangles in different orientations
19615 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
19618 \begin_layout Plain Layout
19634 \begin_layout Standard
19635 To use a shape for your paragraph,
19636 simply select it in \SpecialChar LyX
19637 's pull-down box for environments in the toolbar.
19640 \begin_layout Standard
19641 \begin_inset Newpage newpage
19647 \begin_layout Standard
19648 Here is an example paragraph in the shape of a nut:
19651 \begin_layout Standard
19652 \begin_inset VSpace bigskip
19661 Lorem ipsum dolor sit amet,
19662 consetetur sadipscing elitr,
19663 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19665 At vero eos et accusam et justo duo dolores et ea rebum.
19666 Stet clita kasd gubergren,
19667 no sea takimata sanctus est Lorem ipsum dolor sit amet.
19668 Lorem ipsum dolor sit amet,
19669 consetetur sadipscing elitr,
19670 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19674 \begin_layout Standard
19675 \begin_inset VSpace bigskip
19681 \begin_layout Standard
19682 \begin_inset Note Greyedout
19685 \begin_layout Plain Layout
19695 paragraphs cannot run over a page break.
19703 \begin_layout Standard
19704 \begin_inset VSpace bigskip
19710 \begin_layout Standard
19712 \begin_inset Flex Code
19715 \begin_layout Plain Layout
19721 takes care that the shape will always be preserved,
19722 no matter how much text is in the paragraph.
19723 Therefore the paragraph size changes with the amount of contained text.
19724 This can lead to paragraph sizes exceeding the page margins.
19725 To demonstrate the size scaling,
19726 here is the same example paragraph but with twice as much text:
19729 \begin_layout Standard
19730 \begin_inset Newpage newpage
19739 Lorem ipsum dolor sit amet,
19740 consetetur sadipscing elitr,
19741 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19743 At vero eos et accusam et justo duo dolores et ea rebum.
19744 Stet clita kasd gubergren,
19745 no sea takimata sanctus est Lorem ipsum dolor sit amet.
19746 Lorem ipsum dolor sit amet,
19747 consetetur sadipscing elitr,
19748 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19750 Lorem ipsum dolor sit amet,
19751 consetetur sadipscing elitr,
19752 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19754 At vero eos et accusam et justo duo dolores et ea rebum.
19755 Stet clita kasd gubergren,
19756 no sea takimata sanctus est Lorem ipsum dolor sit amet.
19757 Lorem ipsum dolor sit amet,
19758 consetetur sadipscing elitr,
19759 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19763 \begin_layout Standard
19764 \begin_inset VSpace bigskip
19770 \begin_layout Standard
19771 An exception is the shape
19776 It cannot be scaled because it must fit the size of a CD/DVD.
19777 Therefore the amount of text that fits into the shape is limited.
19780 \begin_layout Standard
19790 meaning that the calculation of their size can fail,
19791 depending on the amount of text.
19792 You will then get the \SpecialChar LaTeX
19794 \begin_inset Quotes eld
19797 Arithmetic overflow
19798 \begin_inset Quotes erd
19802 In this case one can try to remove or add some text;
19803 if nothing works one has to use another shape.
19806 \begin_layout Standard
19807 For shapes with tips you will maybe see that \SpecialChar LaTeX
19808 's hyphenation routine fails for text in the tips.
19809 Therefore it is often necessary to add hyphenation points
19814 arg "specialchar-insert hyphenation"
19819 ) to the corresponding text parts.
19822 \begin_layout Standard
19823 Shapepar paragraphs are either always centered or placed on the page so that their left border touches the left page margin.
19824 You can therefore not use the paragraph dialog to align such paragraphs.
19825 A solution is to put the paragraph into a minipage or parbox and align the box.
19826 The problem is hereby to find the right width for the box.
19827 Because if it is too wide and you center the box,
19828 the paragraph is not centered too because it sticks at the left side of the box.
19829 So you might have to play a bit with the width until it fits.
19830 Here are two heart-shaped paragraphs,
19831 the first one is not aligned,
19832 the second one is right-aligned:
19835 \begin_layout Standard
19836 \begin_inset Newpage newpage
19842 \begin_layout Heart
19846 Lo\SpecialChar softhyphen
19847 rem ipsum dolor sit amet,
19848 consetetur sadipscing elitr,
19849 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
19851 At vero eos et accusam et justo duo dolores et ea rebum.
19852 Stet clita kasd gubergren,
19853 no sea takimata sanctus est Lorem ipsum dolor sit amet.
19856 \begin_layout Standard
19857 \begin_inset VSpace bigskip
19863 \begin_layout Standard
19866 \begin_inset Box Frameless
19876 height_special "totalheight"
19881 backgroundcolor "none"
19884 \begin_layout Heart
19888 Lo\SpecialChar softhyphen
19889 rem 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.
19903 \begin_layout Subsubsection
19907 \begin_layout Standard
19908 You can define any shape you want.
19909 Doing this manually is a lot of work because every coordinate must be specified.
19910 But there is a way to let the computer calculate the coordinates:
19913 \begin_layout Enumerate
19914 Install the program
19915 \begin_inset CommandInset href
19918 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
19926 \begin_layout Enumerate
19933 TeX/LaTeX\SpecialChar menuseparator
19934 Settings\SpecialChar menuseparator
19937 and select the font size you are using in your document.
19938 For example this document uses the size 12
19939 \begin_inset space \thinspace{}
19945 \begin_layout Enumerate
19949 \begin_layout Enumerate
19952 TeX/LaTeX\SpecialChar menuseparator
19955 to export the shape to coordinates.
19956 In the appearing dialog use either the outline of your shape for the coordinates or the path itself.
19960 \begin_layout Plain Layout
19961 For more information see
19962 \begin_inset CommandInset href
19964 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
19977 \begin_layout Standard
19978 The coordinates are written into a \SpecialChar TeX
19980 To use it for your \SpecialChar LyX
19984 \begin_layout Enumerate
19985 Place the cursor before the first character of your paragraph (or into a new empty one).
19988 \begin_layout Enumerate
19989 Open in \SpecialChar LyX
19992 Insert\SpecialChar menuseparator
19993 File\SpecialChar menuseparator
19995 \begin_inset space ~
20001 select the file and use
20010 \begin_layout Standard
20011 \begin_inset VSpace defskip
20017 \begin_layout Standard
20018 \begin_inset Note Greyedout
20021 \begin_layout Plain Layout
20027 The changed shape only applies to the current paragraph;
20028 everything is reset to normal for the next paragraph.
20029 Therefore the shape definition file must be input into every paragraph with the desired shape.
20037 \begin_layout Standard
20038 \begin_inset VSpace bigskip
20044 \begin_layout Standard
20045 Here is an example:
20048 \begin_layout Standard
20049 \begin_inset VSpace bigskip
20055 \begin_layout Standard
20056 \begin_inset CommandInset include
20058 filename "SpecialParagraphShape.tex"
20065 Lorem ipsum dolor sit amet,
20066 consetetur sadipscing elitr,
20067 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
20069 At vero eos et accusam et justo duo dolores et ea rebum.
20070 Stet clita kasd gubergren,
20071 no sea takimata sanctus est Lorem ipsum dolor sit amet.
20072 Lorem ipsum dolor sit amet,
20073 consetetur sadipscing elitr,
20074 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
20078 \begin_layout Standard
20079 \begin_inset VSpace bigskip
20085 \begin_layout Standard
20091 to draw complexer shapes in
20095 you can draw the shape in a program of your choice and import the resulting image to
20100 Then you only need to draw a line or spline along the outline of the image.
20103 \begin_layout Standard
20106 Custom paragraph shapes
20108 also provides the two commands
20116 which can be used to define custom shapes coordinate by coordinate.
20120 \begin_layout Plain Layout
20121 These commands are internally used for all shapes described here.
20126 For information how these styles are used and about further customization possibilities,
20128 \begin_inset CommandInset href
20130 name "documentation"
20131 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
20137 \begin_inset Flex Code
20140 \begin_layout Plain Layout
20149 \begin_layout Subsection
20153 \begin_layout Hanging
20154 This module adds the
20160 one where all but the first line of the paragraph is indented.
20161 This may not appear in your \SpecialChar LyX
20162 document but will appear in the final output.
20165 \begin_layout Subsection
20166 \begin_inset CommandInset label
20168 name "subsec:Initials"
20172 Initials (Drop Caps)
20175 \begin_layout Initial
20176 \begin_inset Argument 2
20179 \begin_layout Plain Layout
20186 \begin_inset Argument 3
20189 \begin_layout Plain Layout
20195 module adds a drop capitals paragraph style
20199 for paragraph environments which you can use wherever you want to have drop capitals.
20200 You then have three more items in the
20207 \begin_layout Itemize
20212 which creates an inset for the drop capital
20215 \begin_layout Itemize
20220 which creates an inset for the rest of the word
20223 \begin_layout Itemize
20228 which allow you configure the formatting of the drop capital.
20231 \begin_layout Standard
20232 To customize the appearance of the style,
20235 Help\SpecialChar menuseparator
20236 Embedded Objects\SpecialChar menuseparator
20237 Objects Surrounded by Text\SpecialChar menuseparator
20243 \begin_layout Section
20247 \begin_layout Subsection
20248 Hyphenatable Text Markup (Soul)
20251 \begin_layout Standard
20252 This module defines text styles to highlight,
20255 underline and capitalize/small-cap text by means of the
20262 \begin_layout Standard
20263 As opposed to the markup provided by the Text Properties dialog,
20264 words marked-up with
20270 \begin_inset CommandInset href
20272 name "soul documentation"
20273 target "http://mirrors.ctan.org/macros/generic/soul/soul.pdf"
20281 \begin_layout Subsection
20285 \begin_layout Standard
20286 This module defines some character styles for logical markup:
20290 \begin_inset Flex Noun
20293 \begin_layout Plain Layout
20307 \begin_inset Flex Emph
20310 \begin_layout Plain Layout
20322 \begin_inset Flex Strong
20325 \begin_layout Plain Layout
20333 \begin_inset Flex Code
20336 \begin_layout Plain Layout
20342 which are accessed via the
20347 dit\SpecialChar menuseparator
20349 \begin_inset space ~
20353 \begin_inset space ~
20365 \begin_layout Chapter
20369 \begin_layout Standard
20370 The most basic information about how to use Bib\SpecialChar TeX
20375 with \SpecialChar LyX
20376 is contained in the section
20378 Bibliography databases
20385 The following subsections explain special bibliography features supported by \SpecialChar LyX
20389 \begin_layout Section
20390 Alternative Citation Styles
20393 \begin_layout Standard
20394 Standard Bib\SpecialChar TeX
20396 \begin_inset space \thinspace{}
20400 \begin_inset space \space{}
20404 \begin_inset Quotes eld
20408 \begin_inset Quotes erd
20411 ) to refer to a cited work.
20413 in many scientific disciplines,
20414 other citation styles are in use.
20415 The most common one is the author-year style (e.
20416 \begin_inset space \thinspace{}
20420 \begin_inset space \space{}
20424 \begin_inset Quotes eld
20428 \begin_inset Quotes erd
20433 supports three packages that provide this style,
20435 \begin_inset Flex Code
20438 \begin_layout Plain Layout
20446 \begin_inset Flex Code
20449 \begin_layout Plain Layout
20457 \begin_inset Flex Code
20460 \begin_layout Plain Layout
20467 Each of these packages has their pros and cons,
20468 which cannot be listed in detail.
20469 If you only want to have simple author-year (or author-numerical) style,
20470 or if you want to use one of the countless style files for
20471 \begin_inset Flex Code
20474 \begin_layout Plain Layout
20481 then the established
20482 \begin_inset Flex Code
20485 \begin_layout Plain Layout
20491 package is probably your choice.
20492 If you look for specific citation styles common in law studies,
20493 you might consider the
20494 \begin_inset Flex Code
20497 \begin_layout Plain Layout
20504 If you want to have full control over the formatting or look for advanced features such as ibidem,
20505 footnote citations,
20506 full title citations,
20507 advanced date formats (such as 400 BC) or full localization to other languages than English,
20508 you should definitely consider
20509 \begin_inset Flex Code
20512 \begin_layout Plain Layout
20519 which exceeds all other packages in terms of features,
20520 but is also quite heavy and more resource-hungry.
20523 \begin_layout Standard
20524 The handling of these packages in \SpecialChar LyX
20525 is basically the same.
20528 Document\SpecialChar menuseparator
20551 Biblatex (Natbib mode)
20563 \begin_inset space ~
20566 6.5.3 in the User's Guide for more information on these choices).
20567 With all these packages,
20568 you will get some extra features in the citation dialog and you can select the style of the reference (
20569 \begin_inset Quotes eld
20573 \begin_inset Quotes erd
20578 \begin_inset Quotes eld
20582 \begin_inset Quotes erd
20587 \begin_inset Quotes eld
20592 \begin_inset Quotes erd
20597 \begin_inset Quotes eld
20601 \begin_inset Quotes erd
20605 Note that either package needs specifically designed style files.
20606 They all ship their own,
20607 but there are lots of additional style files,
20608 and there is even an interactive style file builder
20612 \begin_layout Plain Layout
20614 \begin_inset Flex URL
20617 \begin_layout Plain Layout
20619 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
20630 \begin_inset Flex Code
20633 \begin_layout Plain Layout
20642 \begin_layout Section
20643 Subdivided Bibliographies
20646 \begin_layout Standard
20647 Sometimes you might need to divide your bibliography into several sections.
20648 If you are for instance a historian,
20649 the possibility to separate sources and scientific works is most likely a
20650 \begin_inset Quotes eld
20654 \begin_inset Quotes erd
20659 Bib\SpecialChar TeX
20660 itself does not allow you to do this.
20661 But with the help of some \SpecialChar LaTeX
20663 Bib\SpecialChar TeX
20664 can be extended to fit your needs.
20667 \begin_layout Standard
20669 provides native support for one of these packages,
20678 \begin_layout Plain Layout
20680 \begin_inset Flex URL
20683 \begin_layout Plain Layout
20685 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
20695 The advantage of this package (compared to other packages such as
20699 ) is that you don't need to define new citation commands.
20701 you need to prepare different bibliographic databases which include the entries for the different sections of the bibliography.
20703 If you want to divide your bibliography into the sections
20704 \begin_inset Quotes eld
20708 \begin_inset Quotes erd
20712 \begin_inset Quotes eld
20716 \begin_inset Quotes erd
20720 you first need to create two bibliographic databases,
20722 \begin_inset space \thinspace{}
20726 \begin_inset space \space{}
20730 \begin_inset Flex Code
20733 \begin_layout Plain Layout
20740 \begin_inset Flex Code
20743 \begin_layout Plain Layout
20753 \begin_layout Standard
20756 Document\SpecialChar menuseparator
20765 Subdivided bibliography
20768 Now you can insert multiple Bib\SpecialChar TeX
20770 one for each section of your bibliography.
20771 Returning to our example:
20772 Insert the Bib\SpecialChar TeX
20774 \begin_inset Flex Code
20777 \begin_layout Plain Layout
20783 and a second one for the database
20784 \begin_inset Flex Code
20787 \begin_layout Plain Layout
20794 You are free to use the same or different styles for each section.
20796 you can choose if the bibliography section should contain
20797 \begin_inset Quotes eld
20800 all cited references
20801 \begin_inset Quotes erd
20804 of the specified database(s) (which is the default),
20806 \begin_inset Quotes eld
20809 all uncited references
20810 \begin_inset Quotes erd
20814 \begin_inset Quotes eld
20818 \begin_inset Quotes erd
20822 This might be useful if you would like to separate your bibliography into three sections:
20824 \begin_inset Quotes eld
20828 \begin_inset Quotes erd
20833 \begin_inset Quotes eld
20837 \begin_inset Quotes erd
20842 \begin_inset Quotes eld
20846 \begin_inset Quotes erd
20850 The titles for the sections can be added as ordinary sections or subsections.
20852 \begin_inset Flex Code
20855 \begin_layout Plain Layout
20861 removes the bibliography title,
20862 you have to manually re-add that,
20863 too (as a chapter* or section*,
20867 \begin_layout Standard
20873 the procedure is a bit different.
20884 \begin_inset Flex Noun
20887 \begin_layout Plain Layout
20888 Subdivided bibliography
20893 option is disabled if you use
20903 provides its own means to generate subdivided bibliographies.
20904 You can either add keywords to bibliography entries via the
20905 \begin_inset Flex Code
20908 \begin_layout Plain Layout
20914 entry option and then filter bibliography sections by keyword (by adding
20915 \begin_inset Flex Code
20918 \begin_layout Plain Layout
20925 \begin_inset Flex Noun
20928 \begin_layout Plain Layout
20934 field of the dialog that opens if you left-click on the
20935 \begin_inset Flex Noun
20938 \begin_layout Plain Layout
20939 Biblatex Generated Bibliography
20945 or you can filter by entry types (such as
20954 \begin_inset space \thinspace{}
20959 \begin_inset Flex Code
20962 \begin_layout Plain Layout
20969 \begin_inset Flex Code
20972 \begin_layout Plain Layout
20979 \begin_inset Flex Noun
20982 \begin_layout Plain Layout
20989 or you can create so-called
20990 \begin_inset Quotes eld
20993 Bibliography Categories
20994 \begin_inset Quotes erd
20997 to which you can assign individual entries.
20998 Please refer to the Biblatex manual,
21001 Subdivided Bibliographies
21007 \begin_layout Section
21008 Multiple Bibliographies
21009 \begin_inset CommandInset label
21011 name "subsec:Multiple-Bibliographies"
21018 \begin_layout Standard
21019 Multiple bibliographies,
21021 \begin_inset space \thinspace{}
21025 \begin_inset space \space{}
21028 a bibliography for each part,
21031 subsection or child (sub-document) of the document,
21032 are also supported by \SpecialChar LyX
21034 In order to enable it,
21037 Document\SpecialChar menuseparator
21038 Settings\SpecialChar menuseparator
21041 and select the relevant unit (e.
21042 \begin_inset space \thinspace{}
21047 \begin_inset Quotes eld
21051 \begin_inset Quotes erd
21055 \begin_inset Flex Noun
21058 \begin_layout Plain Layout
21059 Multiple Bibliographies
21065 Then add a Bib(la)\SpecialChar TeX
21066 bibliography to each unit (e.
21067 \begin_inset space \thinspace{}
21071 section) of your document.
21073 a separate bibliography,
21074 containing only the references done in the current unit is generated.
21077 \begin_layout Standard
21078 If you use Bib\SpecialChar TeX
21081 \begin_inset Flex Code
21084 \begin_layout Plain Layout
21091 \begin_inset Flex Code
21094 \begin_layout Plain Layout
21100 package is used to create multiple bibliographies.
21101 The former package is used if you select
21102 \begin_inset Quotes eld
21106 \begin_inset Quotes erd
21114 \begin_inset Flex Noun
21117 \begin_layout Plain Layout
21118 Sectioned Bibliography
21124 In all other cases,
21126 \begin_inset Flex Code
21129 \begin_layout Plain Layout
21139 \begin_layout Plain Layout
21140 An alternative approach,
21141 if you are willing to use some
21142 \begin_inset Flex Noun
21145 \begin_layout Plain Layout
21153 \begin_inset space ~
21157 \begin_inset CommandInset ref
21159 reference "sec:Inserting-TeX-Code"
21166 \begin_inset Flex Code
21169 \begin_layout Plain Layout
21181 \begin_inset Flex Code
21184 \begin_layout Plain Layout
21192 encloses the specified units in
21193 \begin_inset Flex Code
21196 \begin_layout Plain Layout
21203 \begin_inset Flex Code
21206 \begin_layout Plain Layout
21215 \begin_inset Flex Code
21218 \begin_layout Plain Layout
21226 in order to create the units.
21227 Note that this approach has some limitations.
21229 every citation reference has to be inside some
21230 \begin_inset Flex Code
21233 \begin_layout Plain Layout
21240 So citations outside a defined unit (e.
21241 \begin_inset space \thinspace{}
21245 before the first section if you use
21246 \begin_inset Quotes eld
21250 \begin_inset Quotes erd
21254 \begin_inset Quotes eld
21258 \begin_inset Quotes erd
21262 You can also create your own units by entering
21263 \begin_inset Flex Code
21266 \begin_layout Plain Layout
21275 \begin_inset Flex Code
21278 \begin_layout Plain Layout
21286 as \SpecialChar TeX
21287 code (for instance to work around the mentioned limitation).
21291 \begin_inset Flex Code
21294 \begin_layout Plain Layout
21300 s cannot be nested.
21301 A second limitation is that
21302 \begin_inset Flex Code
21305 \begin_layout Plain Layout
21311 always processes all references of a bibliography database,
21312 even if they are not cited.
21313 This can result in odd labels (e.
21314 \begin_inset space \thinspace{}
21319 \begin_inset Quotes eld
21323 \begin_inset Quotes erd
21326 if two works of this author from 2014 are in the database,
21327 even if only one is cited).
21330 \begin_layout Standard
21337 \begin_inset Flex Code
21340 \begin_layout Plain Layout
21346 option is used instead.
21347 If you need specific units,
21348 you can start them with the \SpecialChar TeX
21350 \begin_inset Flex Code
21353 \begin_layout Plain Layout
21362 \begin_inset Flex Code
21365 \begin_layout Plain Layout
21375 If you also want to control the end of the unit,
21376 use the environment
21377 \begin_inset Flex Code
21380 \begin_layout Plain Layout
21390 \begin_inset Flex Code
21393 \begin_layout Plain Layout
21405 \begin_inset Flex Code
21408 \begin_layout Plain Layout
21414 s cannot be nested.
21415 In addition to the individual bibliography of the current unit,
21420 also provides an easy way to output all bibliographies,
21423 \begin_inset space \thinspace{}
21427 at the end of the document).
21429 \begin_inset Quotes eld
21432 all reference units
21433 \begin_inset Quotes erd
21436 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve this.
21437 Please refer to the
21441 manual for more information on this topic.
21444 \begin_layout Chapter
21446 \begin_inset CommandInset label
21448 name "chap:bullets"
21455 \begin_layout Standard
21461 \begin_layout Section
21465 \begin_layout Standard
21467 provides 216 bullet shapes that can be accessed from a simple dialog.
21468 Using this dialog you can easily specify what bullet shape to use at each level of an itemized list.
21469 These settings are document-wide so you won't be able to specify different sets of bullets for different paragraphs.
21473 \begin_layout Plain Layout
21475 actually you can but you'll have to do it by hand.
21483 \begin_layout Section
21487 \begin_layout Standard
21488 Open the dialog by selecting the
21490 Document\SpecialChar menuseparator
21493 menu item and then select the
21494 \begin_inset Flex Noun
21497 \begin_layout Plain Layout
21506 \begin_layout Standard
21507 The dialog provides you with a table of bullet shapes.
21508 A column of buttons on the left of the table provides access to the six different panels of bullet shapes.
21509 The row of buttons across the top is used to select which bullet depth you are changing.
21512 \begin_layout Standard
21518 a text entry under the table will be activated in which you can enter a bullet shape's \SpecialChar LaTeX
21520 If you do modify the text you will also need to specify any needed packages in the \SpecialChar LaTeX
21524 \begin_layout Standard
21525 The six panels are divided up by the packages they require.
21526 The following table shows the mappings from button name to \SpecialChar LaTeX
21530 \begin_layout Standard
21532 \begin_inset Tabular
21533 <lyxtabular version="3" rows="7" columns="2">
21534 <features tabularvalignment="middle">
21535 <column alignment="center" valignment="top" width="0pt">
21536 <column alignment="center" valignment="top" width="0pt">
21538 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21541 \begin_layout Plain Layout
21556 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21559 \begin_layout Plain Layout
21576 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21579 \begin_layout Plain Layout
21594 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21597 \begin_layout Plain Layout
21606 base \SpecialChar LaTeX
21614 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21617 \begin_layout Plain Layout
21632 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21635 \begin_layout Plain Layout
21652 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21655 \begin_layout Plain Layout
21670 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21673 \begin_layout Plain Layout
21690 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21693 \begin_layout Plain Layout
21708 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21711 \begin_layout Plain Layout
21728 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21731 \begin_layout Plain Layout
21746 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21749 \begin_layout Plain Layout
21766 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21769 \begin_layout Plain Layout
21784 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21787 \begin_layout Plain Layout
21810 \begin_layout Standard
21812 doesn't stop you using bullets from packages you don't have.
21813 If you get errors from \SpecialChar LaTeX
21814 when you try to view or print the file,
21815 then it is likely you are missing a package.
21819 \begin_layout Plain Layout
21821 doesn't restrict your use since you may be editing locally and exporting elsewhere.
21829 \begin_layout Section
21830 \begin_inset CommandInset label
21832 name "sec:How-to-use"
21839 \begin_layout Standard
21840 Select which bullet depth you want to change then select the bullet shape and size.
21841 Any changes will not be visible in \SpecialChar LyX
21843 but are visible when viewing the document.
21846 \begin_layout Standard
21847 You can reset a bullet shape to the default simply by clicking your right mouse button on the appropriate bullet depth button.
21848 \begin_inset CommandInset label
21850 name "fn:If-you-really"
21857 \begin_layout Standard
21862 want to have multiple sets of paragraphs with different sets of bullets in each,
21863 then you're going to have to get your hands dirty with \SpecialChar TeX
21865 The bullet selection dialog can help though because it provides you with the \SpecialChar LaTeX
21866 code for a wide range of bullet shapes.
21867 To make your own custom paragraphs you have the following options:
21870 \begin_layout Standard
21874 \begin_layout Plain Layout
21890 \begin_layout Standard
21894 \begin_layout Plain Layout
21916 \begin_layout Itemize
21917 Use the \SpecialChar LaTeX
21919 \begin_inset Flex Code
21922 \begin_layout Plain Layout
21930 to specify a new bullet shape for a given depth.
21931 You'll also need to save the current bullet shape so you can restore it again afterwards.
21932 In this itemized list the following \SpecialChar LaTeX
21933 code was used to change the bullet used for the first depth.
21937 \begin_layout LyX-Code
21947 \begin_layout LyX-Code
21964 \begin_layout Itemize
21965 Note that the itemize depth is specified in Roman numerals as part of the
21974 \begin_layout Itemize
21975 \begin_inset Argument item:1
21978 \begin_layout Plain Layout
21982 \begin_layout Plain Layout
22000 Specify each individual entry by starting each item with the bullet shape enclosed in a
22001 \begin_inset Quotes eld
22005 \begin_inset Quotes erd
22008 inset (available at
22010 Insert\SpecialChar menuseparator
22014 \begin_inset Flex Noun
22017 \begin_layout Plain Layout
22026 this item was started with
22027 \begin_inset Flex Code
22030 \begin_layout Plain Layout
22045 \begin_layout Standard
22049 \begin_layout Plain Layout
22065 \begin_layout Standard
22066 You'll also need to revert the labelitem back to its previous setting for the global bullet shape settings to remain in effect.
22067 The way used here was:
22070 \begin_layout LyX-Code
22080 \begin_layout Chapter
22084 \begin_layout Section
22085 Multipart Documents
22088 \begin_layout Subsection
22092 \begin_layout Standard
22093 When you are working on a large file with many sections,
22094 it is often convenient to break up the document into several files,
22095 or perhaps you have something where a table may change from time to time,
22096 but the preceding text does not.
22098 you should seriously consider using multipart documents.
22100 scientific papers often have five major sections:
22106 Each of these could be its own separate \SpecialChar LyX
22109 \begin_inset Quotes eld
22113 \begin_inset Quotes erd
22116 file which contains the title,
22121 plus the five included files.
22122 It is important to note that each of these files is a full \SpecialChar LyX
22123 file which can be formatted and printed on its own,
22124 as well as included in a master file.
22125 Each of these files must have the same document class,
22127 don't attempt to mix book classes with article classes.
22128 You may also include \SpecialChar LaTeX
22131 these files must not have their own preamble (i.
22132 \begin_inset space \thinspace{}
22136 \begin_inset space \space{}
22139 everything up to and including the
22140 \begin_inset Flex Code
22143 \begin_layout Plain Layout
22151 line as well as the
22152 \begin_inset Flex Code
22155 \begin_layout Plain Layout
22163 line must be deleted) or else errors will be generated when you try to make a DVI file.
22166 \begin_layout Standard
22168 allows you to include files quite easily with
22170 Insert\SpecialChar menuseparator
22172 \begin_inset space ~
22178 When you click on this selection a small box is inserted into the file at the current cursor location.
22179 Clicking on the box raises a dialog which allows you to select the file to be included,
22180 and the method of its inclusion.
22184 \begin_layout Standard
22185 The file selection box should by now be obvious.
22186 The three inclusion methods are
22187 \begin_inset Quotes eld
22191 \begin_inset Quotes erd
22196 \begin_inset Quotes eld
22200 \begin_inset Quotes erd
22205 \begin_inset Quotes eld
22209 \begin_inset Quotes erd
22214 \begin_inset Quotes eld
22218 \begin_inset Quotes erd
22222 \begin_inset Quotes eld
22226 \begin_inset Quotes erd
22229 are similar in many ways,
22230 but there are also some notable differences:
22233 \begin_layout Enumerate
22235 \begin_inset Quotes eld
22239 \begin_inset Quotes erd
22242 are typeset beginning on a new page,
22243 while files that are
22244 \begin_inset Quotes eld
22248 \begin_inset Quotes erd
22251 are typeset starting on the current page.
22254 \begin_layout Enumerate
22255 \begin_inset Quotes eld
22259 \begin_inset Quotes erd
22262 files cannot themselves
22263 \begin_inset Quotes eld
22267 \begin_inset Quotes erd
22271 \begin_inset Quotes eld
22275 \begin_inset Quotes erd
22280 \begin_inset Quotes eld
22284 \begin_inset Quotes erd
22289 infinite sub-inputting is possible.
22292 \begin_layout Enumerate
22293 \begin_inset Quotes eld
22297 \begin_inset Quotes erd
22300 allow for the output of only selected
22301 \begin_inset Quotes eld
22305 \begin_inset Quotes erd
22309 while maintaining the actual counters (pagination etc.) and references (please refer to the section
22312 \begin_inset space ~
22320 \begin_inset space ~
22325 manual for details).
22328 \begin_layout Standard
22331 \begin_inset Quotes eld
22335 \begin_inset Quotes erd
22338 is the preferred method for chapters that are outsourced to child documents,
22340 \begin_inset Quotes eld
22344 \begin_inset Quotes erd
22347 is more suitable for arbitrary file inheritance.
22350 \begin_layout Standard
22352 \begin_inset Quotes eld
22356 \begin_inset Quotes erd
22359 included file allows you to include a file typeset exactly as it appears in the file,
22361 \begin_inset space \thinspace{}
22365 \begin_inset space \space{}
22369 \begin_inset Flex Code
22372 \begin_layout Plain Layout
22379 with the characters set in a fixed-width typewriter font.
22381 spaces in this file are invisible,
22382 though two consecutive spaces are conserved,
22383 unlike \SpecialChar LyX
22384 's normal treatment of spaces.
22387 \begin_inset Flex Noun
22390 \begin_layout Plain Layout
22392 \begin_inset space ~
22396 \begin_inset space ~
22400 \begin_inset space ~
22408 checkbox typesets a mark to unambiguously define the presence of a space.
22412 \begin_layout Standard
22414 the master file is converted into a full \SpecialChar LaTeX
22415 file before typesetting,
22416 while the included files are converted to \SpecialChar LaTeX
22417 files that do not have all the preamble information.
22420 \begin_layout Subsection
22421 Cross-References Between Files
22424 \begin_layout Standard
22425 \begin_inset Box Shadowbox
22435 height_special "totalheight"
22440 backgroundcolor "none"
22443 \begin_layout Plain Layout
22444 This section is somewhat out of date.
22445 Need to describe default master documents and how children are opened when the master is.
22454 \begin_layout Standard
22455 It is possible to set up cross-references between the different files.
22457 open all the files in question:
22458 let's call them A and B in a two file example,
22459 where B is included in A.
22460 Let's say you insert a label in A,
22461 then want to reference it in B.
22462 Open the cross-reference dialog whilst in document B,
22463 and you can select the
22464 \begin_inset Quotes eld
22468 \begin_inset Quotes erd
22474 \begin_layout Subsection
22475 Bibliography Lists in all Subdocuments
22478 \begin_layout Standard
22479 If you work with child documents,
22480 you might want to have only one main bibliography at the end,
22481 but still be able to have a selected bibliography for the child if you output it on its own.
22482 Here is how to achieve this.
22485 \begin_layout Standard
22486 For the main document,
22487 you just insert a bibliography inset at the place where the main bibliography has to appear (within the master file or within a child).
22488 If the bibliography inset is in the master file,
22489 the references will be inherited by all children,
22490 so they are available in the citation dialog within each child.
22493 \begin_layout Standard
22494 For child-specific bibliographies,
22495 insert bibliography insets within the child documents,
22496 at the place where the bibliography should appear when the child is compiled separately.
22498 the trick is to insert them into a branch (
22500 Insert\SpecialChar menuseparator
22501 Branch\SpecialChar menuseparator
22502 Insert New Branch...
22506 \begin_inset space \thinspace{}
22511 \begin_inset Quotes eld
22515 \begin_inset Quotes erd
22519 Within the children,
22520 activate the branch (
22522 Document\SpecialChar menuseparator
22523 Settings...\SpecialChar menuseparator
22528 deactivate the branch (
22530 Document\SpecialChar menuseparator
22531 Settings...\SpecialChar menuseparator
22535 Now the child's bibliography will be ignored by the master,
22536 but considered by the child.
22539 \begin_layout Standard
22540 If you need multiple bibliographies (e.
22541 \begin_inset space \thinspace{}
22545 one per child in the
22550 please refer to sec.
22551 \begin_inset space ~
22555 \begin_inset CommandInset ref
22557 reference "subsec:Multiple-Bibliographies"
22565 \begin_layout Section
22570 \begin_layout Standard
22571 Users sometimes need to be able to
22572 \begin_inset Quotes eld
22576 \begin_inset Quotes erd
22580 file together with all the images (and other files) on which it depends,
22581 either for sending to a publisher or for sharing with a co-author.
22583 includes a Python script (
22584 \begin_inset Flex Code
22587 \begin_layout Plain Layout
22593 ) that automates this process.
22595 you must have either the
22596 \begin_inset Flex Code
22599 \begin_layout Plain Layout
22606 \begin_inset Flex Code
22609 \begin_layout Plain Layout
22615 python modules installed on your system.
22617 the script prefers the
22618 \begin_inset Flex Code
22621 \begin_layout Plain Layout
22628 \begin_inset Flex Code
22631 \begin_layout Plain Layout
22637 format on Unix-like systems and the
22638 \begin_inset Flex Code
22641 \begin_layout Plain Layout
22650 \begin_layout Standard
22652 's configuration process will set the script up to export a `\SpecialChar LyX
22654 and this format will then be available under
22656 File\SpecialChar menuseparator
22662 \begin_layout Standard
22663 Independently of the platform,
22664 the generation of a particular archive format can be forced by adding either the
22665 \begin_inset Flex Code
22668 \begin_layout Plain Layout
22675 \begin_inset Flex Code
22678 \begin_layout Plain Layout
22685 \begin_inset Flex Code
22688 \begin_layout Plain Layout
22695 \begin_inset Flex Code
22698 \begin_layout Plain Layout
22704 format) switch to the
22705 \begin_inset Flex Code
22708 \begin_layout Plain Layout
22718 Tools\SpecialChar menuseparator
22719 Preferences\SpecialChar menuseparator
22720 File Handling\SpecialChar menuseparator
22724 (Make sure you add the switch after the script name,
22728 \begin_layout Chapter
22730 and the World Wide Web
22733 \begin_layout Standard
22735 has long supported the export of documents to various web-friendly formats,
22737 Before version 2.0,
22739 HTML export was always accomplished by the use of external converters.
22743 \begin_layout Plain Layout
22744 For details on the use of external converters with \SpecialChar LyX
22750 section of the Customization manual.
22755 These fall into two large groups:
22756 there are converters that use \SpecialChar LaTeX
22757 as an intermediate format,
22759 \begin_inset Flex Code
22762 \begin_layout Plain Layout
22770 \begin_inset Flex Code
22773 \begin_layout Plain Layout
22781 \begin_inset Flex Code
22784 \begin_layout Plain Layout
22791 relying upon \SpecialChar LyX
22792 to produce the \SpecialChar LaTeX
22794 and there is a converter that works directly on \SpecialChar LyX
22797 \begin_inset Flex Code
22800 \begin_layout Plain Layout
22808 All of these have different advantages and disadvantages.
22812 \begin_layout Standard
22813 The \SpecialChar LaTeX
22814 -based converters have the advantage that,
22816 they know everything about the exported document that \SpecialChar LaTeX
22818 Such converters do not care,
22820 if a certain block of code was produced by \SpecialChar LyX
22821 or was Evil Red Text.
22822 These converters know about
22823 \begin_inset Flex Code
22826 \begin_layout Plain Layout
22835 and can often make use of the
22836 \begin_inset Flex Code
22839 \begin_layout Plain Layout
22845 files generated by Bib\SpecialChar TeX
22849 is a very hard language to parse—
22850 it is sometimes said that only \SpecialChar TeX
22851 itself understands \SpecialChar TeX
22853 and \SpecialChar LaTeX
22854 -based converters will often choke on what seem to be quite simple constructs;
22855 complex ones can throw them completely,
22856 and as of this writing,
22862 manual will not export with
22863 \begin_inset Flex Code
22866 \begin_layout Plain Layout
22873 though the others will.
22874 The other issue concerns how math is handled.
22875 These converters typically convert the formulae into little pictures that are then linked from the HTML document.
22876 Since these are actually generated by \SpecialChar LaTeX
22879 But they do not scale well,
22880 and just getting them to look as if they are actually meant to be in your document—
22881 so that the font sizes seem to be roughly the same—
22882 can be a challenge.
22885 \begin_layout Standard
22887 \begin_inset Flex Code
22890 \begin_layout Plain Layout
22898 \begin_inset CommandInset href
22900 name "http://pinchito.es/elyxer/"
22901 target "http://pinchito.es/elyxer/"
22906 ) solves some of these problems.
22908 the formulae it produces scale perfectly,
22909 since it renders math using a combination of HTML and CSS rather than converting the formulae to images.
22910 But even moderately complex formula are rendered less well than with
22911 \begin_inset Flex Code
22914 \begin_layout Plain Layout
22921 this reflects the limitations of HTML.
22925 \begin_layout Plain Layout
22928 \begin_inset Flex Code
22931 \begin_layout Plain Layout
22938 can also use jsMath and MathJax for equations,
22939 but this setting is only available globally and requires one to have access to a server that runs the backend.
22944 More importantly (as of version 1.1.1,
22947 \begin_inset Flex Code
22950 \begin_layout Plain Layout
22957 has limited support for math macros and no support for user-defined paragraph or character styles.
22958 These limitations make
22959 \begin_inset Flex Code
22962 \begin_layout Plain Layout
22969 unsuitable for many of the documents \SpecialChar LyX
22973 these problems could be solved,
22974 but the \SpecialChar LyX
22975 developers have decided to follow a different path and have made \SpecialChar LyX
22976 itself capable of writing XHTML,
22977 just as it is capable of writing \SpecialChar LaTeX
22983 \begin_layout Standard
22984 As of this writing,
22985 XHTML output remains under development and should probably be regarded as
22986 \begin_inset Quotes eld
22990 \begin_inset Quotes erd
22997 \begin_layout Plain Layout
22999 \begin_inset Flex Code
23002 \begin_layout Plain Layout
23003 development/HTML/HTML.notes
23009 which can be found in the \SpecialChar LyX
23011 \begin_inset CommandInset href
23013 name "accessed online"
23014 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
23020 usually contains up-to-date information about the state of XHTML output.
23021 See also the list of XHTML bugs on
23022 \begin_inset CommandInset href
23024 name "the bug tracker"
23025 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"
23036 the developers have chosen this approach because it has several potential advantages over the other two.
23039 \begin_layout Standard
23040 These advantages are primarily due to the fact that the XHTML output routines,
23041 since they are part of \SpecialChar LyX
23043 know everything \SpecialChar LyX
23044 knows about the document being exported.
23048 \begin_layout Plain Layout
23049 Another advantage is that,
23050 since these routines are internal to \SpecialChar LyX
23052 they are immune to changes in \SpecialChar LyX
23054 or to changes in the semantics of existing insets.
23059 So they know about the table of contents (as displayed in the outline),
23060 about the counters associated with different paragraph styles,
23061 and about user-defined styles.
23062 The XHTML output routines know what \SpecialChar LyX
23063 knows about internationalization,
23065 so they will output
23066 \begin_inset Quotes eld
23070 \begin_inset Quotes erd
23074 \begin_inset Quotes eld
23082 \begin_inset Quotes erd
23086 depending upon the language in effect at the time.
23090 \begin_layout Standard
23092 the output routines know what \SpecialChar LyX
23093 knows about document layout,
23095 about how the document is to be rendered on screen.
23096 We use this information when we output the document as XHTML.
23103 generates CSS style information corresponding to the layout information it uses to render the document on screen:
23104 if section headings are supposed to be sans-serif and bold as seen in \SpecialChar LyX
23106 then (by default) they will be sans-serif and bold when viewed in a web browser,
23108 And this is true not just for pre-defined styles,
23111 including user-defined styles.
23113 the XHTML output routines make no distinction between user-defined paragraph and text styles and \SpecialChar LyX
23114 's own pre-defined styles:
23116 everything \SpecialChar LyX
23117 knows about the styles is contained in the layout files.
23118 And much the same is true as regards pre-defined textual insets,
23120 and various custom insets.
23123 \begin_layout Standard
23124 The result is that XHTML output can be customized and extended in exactly the same way \SpecialChar LaTeX
23125 output can be customized and extended:
23126 through layout files and modules.
23127 See chapter five of the
23131 manual for the details.
23134 \begin_layout Standard
23135 The remainder of this chapter contains more detailed information on XHTML output,
23137 and ways to work around those limitations.
23140 \begin_layout Section
23141 Math Output in XHTML
23144 \begin_layout Standard
23146 offers four choices for how math is rendered.
23147 These have various advantages and disadvantages:
23150 \begin_layout Itemize
23152 \begin_inset Newline newline
23155 MathML is a dialect of XML designed specifically for mathematics on the web,
23156 and it typically renders very well in browsers that support it.
23157 The disadvantage is that not all browsers support MathML,
23158 and support is not complete even in the Gecko-based browsers,
23160 \begin_inset Newline newline
23163 If \SpecialChar LyX
23164 is unable to render a formula as MathML—
23166 if the formula uses the
23167 \begin_inset Flex Code
23170 \begin_layout Plain Layout
23177 then it will instead output the formula as an image.
23181 \begin_layout Itemize
23183 \begin_inset Newline newline
23186 As mentioned above,
23188 \begin_inset Flex Code
23191 \begin_layout Plain Layout
23197 outputs math as HTML,
23202 \begin_layout Plain Layout
23204 has borrowed some of the CSS for its HTML output from
23205 \begin_inset Flex Code
23208 \begin_layout Plain Layout
23219 For simple formulae,
23220 this can work quite well,
23221 though with more complicated formulae it tends to break down.
23223 this method has the advantage that it is very widely supported and so it may be appropriate for documents that contain only a little,
23224 fairly simple math.
23225 \begin_inset Newline newline
23228 If Lyx is unable to render a formula as HTML—
23230 if the formula uses the
23231 \begin_inset Flex Code
23234 \begin_layout Plain Layout
23241 then it will instead output the formula as an image.
23245 \begin_layout Itemize
23247 \begin_inset Newline newline
23251 \begin_inset Flex Code
23254 \begin_layout Plain Layout
23262 will output formulae as images,
23263 the very same images,
23265 that are used for instant preview.
23269 \begin_layout Plain Layout
23270 Instant preview does
23274 have to be on for images to be output,
23280 The advantage to this method is that the images are simply generated by \SpecialChar LaTeX
23282 so they are very accurate.
23284 as mentioned earlier,
23285 is that these are bitmapped images,
23286 so they do not scale terribly well,
23287 and one cannot copy them,
23289 \begin_inset Newline newline
23292 The size of the images can be controlled by setting the
23293 \begin_inset Quotes eld
23296 Math Images Scaling
23297 \begin_inset Quotes erd
23302 Document\SpecialChar menuseparator
23303 Settings\SpecialChar menuseparator
23308 \SpecialChar menuseparator
23315 \begin_layout Plain Layout
23316 For those who want to know,
23317 this controls the resolution of the image in dots per inch and is based upon a default of 75 dpi.
23323 \begin_inset Newline newline
23326 If \SpecialChar LyX
23327 for some reason fails to create an image for a formula (e.g.,
23328 if a required \SpecialChar LaTeX
23329 package is not installed),
23330 then it will fall back to outputing the raw \SpecialChar LaTeX
23334 \begin_layout Itemize
23337 \begin_inset Newline newline
23342 will happily output math as \SpecialChar LaTeX
23344 As well as being the output of last resort,
23345 this method can be used with such tools as
23346 \begin_inset CommandInset href
23349 target "http://www.math.union.edu/~dpvc/jsMath/"
23355 which uses JavaScript to render \SpecialChar LaTeX
23356 embedded in HTML documents.
23358 wraps the \SpecialChar LaTeX
23360 \begin_inset Flex Code
23363 \begin_layout Plain Layout
23369 (for inline formulas) or
23370 \begin_inset Flex Code
23373 \begin_layout Plain Layout
23379 (for displayed formulas) with
23380 \begin_inset Flex Code
23383 \begin_layout Plain Layout
23390 as is required for jsMath.
23393 \begin_layout Standard
23394 One of these output methods must be selected under
23396 Document\SpecialChar menuseparator
23397 Settings\SpecialChar menuseparator
23404 This is a document-wide setting,
23408 \begin_layout Standard
23411 will offer the user the option to select an alternate output method for a particular inset,
23413 one that isn't being rendered very well by MathML.
23417 \begin_layout Plain Layout
23419 since \SpecialChar LyX
23420 falls back to images if the inset contains ERT,
23421 then one can force output as an image by putting some harmless ERT into the math,
23424 \begin_inset Formula $a=b\relax$
23435 \begin_layout Section
23436 Bibliography and Citations
23439 \begin_layout Standard
23440 XHTML output fully supports bibliographies and citations.
23444 \begin_layout Standard
23445 Citation labels are generated by the same machinery that generates \SpecialChar LyX
23446 's on-screen labels,
23447 so the labels will look in the output much as they do in \SpecialChar LyX
23450 If you are using numerical citations,
23451 then \SpecialChar LyX
23452 will output numerical labels,
23453 such as [1] or [17],
23454 rather than simply showing the citation key in square brackets,
23455 as it does on-screen.
23456 If you are using author-year citations,
23457 then \SpecialChar LyX
23458 will add lowercase letters to the years,
23459 just as Bib\SpecialChar TeX
23461 if it finds more than one citation for a given author-year combination.
23462 The labels will be printed with the bibliography entries.
23463 Note that there is,
23465 no way to customize the appearance of the labels,
23467 to choose between square brackets and parentheses.
23470 \begin_layout Standard
23471 Bibliography output is handled by the same machinery that handles the presentation of reference information in the citation dialog,
23472 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.
23473 The formatting can be customized in your layout file or,
23480 manual for the details.
23483 \begin_layout Standard
23484 The main defect at present is that cross-referenced information is printed with every entry with which it is associated.
23485 So you can see things like this:
23488 \begin_layout Quote
23491 \begin_inset Quotes eld
23494 Context and Logical Form
23495 \begin_inset Quotes erd
23501 Language in Context:
23505 Oxford University Press,
23511 \begin_layout Quote
23514 \begin_inset Quotes eld
23517 Semantics in Context
23518 \begin_inset Quotes erd
23524 Language in Context:
23528 Oxford University Press,
23534 \begin_layout Standard
23535 This should be fixed before long.
23538 \begin_layout Standard
23539 There is no support at present for sectioned bibliographies.
23540 If you have multiple bibliographies,
23541 then \SpecialChar LyX
23542 will print the same bibliography over and over.
23545 \begin_layout Section
23549 \begin_layout Standard
23551 will happily export indexes as XHTML,
23552 but with certain limitations at the moment.
23555 \begin_layout Standard
23556 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
23564 \begin_layout Plain Layout
23565 The main issue here is that \SpecialChar LyX
23566 itself does not really handle these.
23567 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
23573 We'll describe how they are handled using the subsection headings from that section.
23576 \begin_layout Itemize
23577 Grouping Index Entries (aka,
23580 makes an effort to support these,
23581 but the entries must be separated by
23582 \begin_inset Quotes eld
23587 \begin_inset Quotes erd
23592 there must be spaces around the exclamation point.
23593 This is because it is otherwise too difficult to check for escaped exclamation points,
23598 \begin_layout Itemize
23600 There is no support at all for page ranges,
23601 since these make no sense with XHMTL.
23603 you will just get two index entries,
23607 \begin_layout Itemize
23609 There is no support for cross-referencing.
23610 If \SpecialChar LyX
23611 finds an entry containing the
23612 \begin_inset Quotes eld
23615 |see\SpecialChar ldots
23617 \begin_inset Quotes erd
23621 it is just dropped,
23622 and the rest is treated as an ordinary index entry.
23625 \begin_layout Itemize
23628 does support attempts to fix the sorting order.
23629 It will take what is before the first `@' it finds and use that for sorting,
23630 taking what follows the first `@' to be the actual entry.
23633 does not check for escaped `@',
23634 so do not try to index email addresses.
23637 \begin_layout Itemize
23638 Index Entry Layout:
23639 You can format entries by using the text style dialog,
23640 or by using any other method available within \SpecialChar LyX
23642 There is no support for constructs like:
23644 \begin_inset Quotes eld
23648 \begin_inset Quotes erd
23653 if \SpecialChar LyX
23654 finds a pipe symbol,
23657 it will delete it and everything that follows it.
23660 \begin_layout Itemize
23662 There is no support for multiple indexes.
23664 all index entries will be printed as one large index.
23665 To avoid our printing several versions of the index,
23666 we print only the main index,
23667 so make sure you have one.
23670 \begin_layout Section
23671 Nomenclature and Glossary
23674 \begin_layout Standard
23675 There is at present no support for glossaries.
23676 Adding it would be fairly trivial,
23680 \begin_layout Chapter
23684 \begin_layout Standard
23687 can generate documents in the DocBook XML vocabulary.
23688 With versions 2.3 and before,
23689 only select templates could be used to generate DocBook documents (only version 4).
23690 Starting with \SpecialChar LyX
23692 most \SpecialChar LyX
23693 layouts can generate valid DocBook documents (only version 5).
23694 This feature is built into \SpecialChar LyX
23695 and does not require the use of external tools.
23698 \begin_layout Standard
23699 The result is that the DocBook output can be customized and extended in exactly the same way \SpecialChar LaTeX
23700 output can be customized and extended:
23701 through layout files and modules.
23702 See chapter five of the
23706 manual for the details.
23709 \begin_layout Standard
23710 Most \SpecialChar LyX
23711 features are supported with DocBook,
23715 \begin_layout Itemize
23716 Math output is performed mostly in MathML (the major exception being constructions not supported by \SpecialChar LyX
23720 All formulae are also available in raw \SpecialChar TeX
23721 in the DocBook output for further processing.
23724 \begin_layout Itemize
23725 Bibliographies and citations are implemented,
23726 including with an external BibTeX file.
23727 Bibliography entries are not prerendered when the detailed information are available,
23728 but rather output with the standard DocBook constructs.
23729 The external DocBook processor is expected to handle the rendering of entries.
23732 \begin_layout Itemize
23733 Indexes are supported,
23734 including multiple indices.
23741 and cross-references (
23746 with the exception of the same symbols escaped.
23755 ) are not supported.
23756 There is no support for escaping of index entries.
23759 \begin_layout Itemize
23760 Glossaries are implemented.
23763 \begin_layout Standard
23764 Two major parameters can be set at the document level.
23767 \begin_layout Itemize
23770 can generate tables either as HTML (default value) or CALS,
23771 depending on the user's requirements.
23772 Most DocBook processors accept both formats.
23775 \begin_layout Itemize
23778 MathML is included within its own name space,
23780 The implication is that there must be an indication of the tags belonging to the MathML standard.
23781 Three choices are offered:
23785 \begin_layout Itemize
23787 the MathML name space is defined for each formula (using the
23791 attribute on each formula)
23794 \begin_layout Itemize
23800 the MathML name space is defined at the document level (using the
23804 attribute on the root element).
23805 Each MathML is prefixed with
23816 \begin_layout Itemize
23832 \begin_layout Standard
23833 This option is especially useful if you want \SpecialChar LyX
23834 to match your personal style or to work with buggy software that only accepts one prefix for MathML.
23838 \begin_layout Chapter
23839 The \SpecialChar LyX
23843 \begin_layout Section
23847 \begin_layout Standard
23848 The `\SpecialChar LyX
23849 server' allows other programs to talk to \SpecialChar LyX
23851 invoke \SpecialChar LyX
23853 and retrieve information about the \SpecialChar LyX
23855 This is only intended for advanced users,
23856 but they should find it useful.
23857 It is by writing to the \SpecialChar LyX
23860 that bibliography managers,
23863 \begin_inset Quotes eld
23867 \begin_inset Quotes erd
23870 citations to \SpecialChar LyX
23874 \begin_layout Section
23875 Starting the \SpecialChar LyX
23877 \begin_inset CommandInset label
23879 name "sec:Starting-the-Server"
23886 \begin_layout Standard
23887 The \SpecialChar LyX
23888 server works through the use of a pair of named pipes.
23889 These are usually located in
23890 \begin_inset Flex Code
23893 \begin_layout Plain Layout
23900 (except on Windows,
23905 named pipes are special objects located in
23906 \begin_inset Flex Code
23909 \begin_layout Plain Layout
23921 ) and have the names
23922 \begin_inset Quotes eld
23926 \begin_inset Flex Code
23929 \begin_layout Plain Layout
23936 \begin_inset Quotes erd
23940 \begin_inset Quotes eld
23944 \begin_inset Flex Code
23947 \begin_layout Plain Layout
23954 \begin_inset Quotes erd
23958 External programs write into
23959 \begin_inset Flex Code
23962 \begin_layout Plain Layout
23968 and read back data from
23969 \begin_inset Flex Code
23972 \begin_layout Plain Layout
23979 The stem of the pipe names can be defined in the
23981 Tools\SpecialChar menuseparator
23982 Preferences\SpecialChar menuseparator
23987 \begin_inset Flex Code
23990 \begin_layout Plain Layout
23991 "/home/myhome/lyxpipe"
23998 \begin_inset Flex Code
24001 \begin_layout Plain Layout
24015 on Windows (where any working path instead of lyxpipe can be used,
24017 \begin_inset Flex Code
24020 \begin_layout Plain Layout
24043 configure this manually in order for the server to start.
24046 \begin_layout Standard
24049 \begin_inset Flex Code
24052 \begin_layout Plain Layout
24059 \begin_inset Flex Code
24062 \begin_layout Plain Layout
24068 ' to create the pipes.
24069 If one of the pipes already exists,
24071 will assume that another \SpecialChar LyX
24072 process is already running and will not start the server.
24073 On POSIX (Unix like) systems,
24074 if for some other reason,
24076 \begin_inset Quotes eld
24080 \begin_inset Quotes erd
24083 pipe is left in existence when \SpecialChar LyX
24085 then \SpecialChar LyX
24086 will try to delete it.
24087 If this fails for some reason,
24088 you will need to delete the pipes manually and then restart \SpecialChar LyX
24091 pipes are deleted by the OS on program termination or crash,
24093 \begin_inset Quotes eld
24097 \begin_inset Quotes erd
24100 pipes should not be possible.
24103 \begin_layout Standard
24104 To have several \SpecialChar LyX
24105 processes with servers at the same time,
24106 you have to use different configurations,
24107 perhaps by using separate user directories,
24109 \begin_inset Flex Code
24112 \begin_layout Plain Layout
24122 \begin_layout Standard
24123 If you are developing a client program,
24124 you might find it useful to enable debugging information from the \SpecialChar LyX
24126 Do this by starting \SpecialChar LyX
24128 \begin_inset Flex Code
24131 \begin_layout Plain Layout
24140 \begin_layout Standard
24141 You can find a complete example client written in C++ in the source distribution as
24142 \begin_inset Flex Code
24145 \begin_layout Plain Layout
24146 development/lyxserver/server_monitor.cpp
24154 \begin_layout Standard
24155 Another useful tool is the command-line based client found in
24156 \begin_inset Flex Code
24159 \begin_layout Plain Layout
24160 src/client/lyxclient
24168 \begin_layout Section
24169 Normal communication
24172 \begin_layout Standard
24173 To issue a \SpecialChar LyX
24175 the client writes a line of ASCII text into the input pipe.
24176 This line has the following format:
24179 \begin_layout Quote
24193 \begin_layout Description
24194 clientname is a name that the client can choose arbitrarily.
24195 Its only use is that \SpecialChar LyX
24196 will echo it if it sends an answer—
24197 so a client can dispatch results from different requesters.
24200 \begin_layout Description
24201 function is the function you want \SpecialChar LyX
24203 It is the same as the commands you'd use in the minibuffer.
24206 \begin_layout Description
24207 argument is an optional argument which is meaningful only to some functions (for instance,
24209 \begin_inset Quotes eld
24213 \begin_inset Quotes erd
24216 LFUN will insert the argument as text at the cursor position).
24219 \begin_layout Standard
24220 The answer from \SpecialChar LyX
24221 will arrive in the output pipe and be of the form
24224 \begin_layout Quote
24238 \begin_layout Standard
24247 are just echoed from the command request,
24252 is more or less useful information filled according to how the command execution worked out.
24255 \begin_inset Quotes eld
24259 \begin_inset Quotes erd
24263 will return information about the internal state of \SpecialChar LyX
24265 while other will return an empty data-response.
24266 This means that the command execution went fine.
24269 \begin_layout Standard
24271 the response from \SpecialChar LyX
24272 will have this form
24275 \begin_layout Quote
24289 \begin_layout Standard
24294 should contain an explanation of why the command failed.
24297 \begin_layout Standard
24301 \begin_layout LyX-Code
24302 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
24303 \begin_inset Newline newline
24306 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
24307 \begin_inset Newline newline
24310 read a <~/.lyxpipe.out
24311 \begin_inset Newline newline
24317 \begin_layout Subsection
24318 AppleScript (Mac OS X)
24321 \begin_layout Standard
24322 Since \SpecialChar LyX
24325 supports basic interactions with AppleScript for normal communication through the command run.
24326 This command takes a direct argument (the
24330 to perform) and an optional argument.
24331 It either returns the output of the function or triggers an error with the error message and code.
24334 \begin_layout Standard
24338 \begin_layout LyX-Code
24339 tell application "\SpecialChar LyX
24343 \begin_layout LyX-Code
24347 \begin_layout LyX-Code
24348 -- Stores the current file name into f
24351 \begin_layout LyX-Code
24352 set f to (run "server-get-filename" with argument "")
24355 \begin_layout LyX-Code
24356 on error the error_message number the error_number
24359 \begin_layout LyX-Code
24360 display dialog "Error:
24361 " & the error_number & ".
24365 \begin_layout LyX-Code
24366 & the error_message buttons {"OK"} default button 1
24369 \begin_layout LyX-Code
24373 \begin_layout LyX-Code
24377 \begin_layout Section
24381 \begin_layout Standard
24383 can notify clients of events going on asynchronously.
24384 Currently it will only do this if the user binds a key sequence with the function
24385 \begin_inset Quotes eld
24389 \begin_inset Quotes erd
24393 The format of the string \SpecialChar LyX
24394 sends is as follows:
24397 \begin_layout Quote
24398 \begin_inset Flex Code
24401 \begin_layout Plain Layout
24412 \begin_layout Standard
24417 is the printed representation of the key sequence that was actually typed by the user.
24420 \begin_layout Standard
24421 This mechanism can be used to extend \SpecialChar LyX
24422 's command set and implement macros.
24423 Bind some key sequence to
24424 \begin_inset Quotes eld
24428 \begin_inset Quotes erd
24432 Then start a client that listens on the output pipe,
24433 dispatches the command according to the sequence,
24434 and starts a function that may use \SpecialChar LyX
24435 calls and \SpecialChar LyX
24436 requests to issue a command or a series of commands to \SpecialChar LyX
24440 \begin_layout Section
24441 The simple \SpecialChar LyX
24445 \begin_layout Standard
24447 implements a simple protocol that can be used for session management.
24448 All messages are of the form
24451 \begin_layout Quote
24461 \begin_layout Standard
24467 \begin_inset Quotes eld
24471 \begin_inset Quotes erd
24475 \begin_inset Quotes eld
24479 \begin_inset Quotes erd
24484 \begin_inset Quotes eld
24488 \begin_inset Quotes erd
24491 is received from a client,
24493 will report back to inform the client that it's listening to it's messages,
24495 \begin_inset Quotes eld
24499 \begin_inset Quotes erd
24502 sent from \SpecialChar LyX
24503 will inform clients that \SpecialChar LyX
24507 \begin_layout Section
24508 Reverse DVI/PDF search
24511 \begin_layout Standard
24512 Some DVI/PDF viewers
24516 \begin_layout Plain Layout
24517 The following viewers offer the reverse PDF search feature:
24518 Okular on KDE/Linux,
24520 Skim on Mac OSX and SumatraPDF on Windows.
24529 facility (also called
24534 This means that you can tell \SpecialChar LyX
24535 to put the cursor to a specific line in the document by clicking at the respective position in the DVI/PDF output.
24537 the viewer must be able to communicate with \SpecialChar LyX
24539 This is done via the \SpecialChar LyX
24540 server either by using the named pipe (
24545 or the UNIX domain socket (
24549 ) that \SpecialChar LyX
24550 creates in its temporary directory (this is the way the
24551 \begin_inset Flex Code
24554 \begin_layout Plain Layout
24560 program communicates with \SpecialChar LyX
24563 you need a helper script that mediates between the viewer and \SpecialChar LyX
24566 the viewer can communicate with \SpecialChar LyX
24568 This depends on the selected viewer and on your operating system.
24569 The same applies to the way viewers need to be configured and the way the reverse search is actually performed.
24571 we will thus describe how to setup reverse search for specific viewers.
24572 Before we turn to this,
24574 we will explain what needs to be done generally to enable reverse search in the DVI/PDF output.
24577 \begin_layout Subsection
24579 \begin_inset CommandInset label
24581 name "subsec:rev-search"
24588 \begin_layout Standard
24589 In most cases \SpecialChar LyX
24590 will do the work for you by pressing the following button in the toolbar:
24594 arg "buffer-toggle-output-sync"
24599 you can also enable the feature by checking
24601 Synchronize with Output
24605 Document\SpecialChar menuseparator
24606 Settings\SpecialChar menuseparator
24607 Output\SpecialChar menuseparator
24611 In such a case \SpecialChar LyX
24612 will automatically insert the necessary Sync\SpecialChar TeX
24613 macro (for PDF) or load the srcltx package (for DVI) respectively.
24614 This option can be easily reached also on
24615 \begin_inset Flex Code
24618 \begin_layout Plain Layout
24627 \begin_layout Standard
24628 If you need a different setting,
24629 you can select or input a custom macro from the drop down box just below
24631 Document\SpecialChar menuseparator
24632 Settings\SpecialChar menuseparator
24633 Output\SpecialChar menuseparator
24634 Synchronize with Output
24639 \begin_layout Standard
24640 Note that the method
24641 \begin_inset Flex Code
24644 \begin_layout Plain Layout
24652 enables gzip compression.
24653 If your viewer does not support it,
24654 you should instead use
24655 \begin_inset Flex Code
24658 \begin_layout Plain Layout
24669 \begin_layout Standard
24670 Please also note that including the
24671 \begin_inset Flex Code
24674 \begin_layout Plain Layout
24681 \begin_inset Flex Code
24684 \begin_layout Plain Layout
24690 sometimes has an undesired impact on the typesetting.
24692 you should switch output synchronization off for the final typesetting if you use the
24693 \begin_inset Flex Code
24696 \begin_layout Plain Layout
24703 \begin_inset Flex Code
24706 \begin_layout Plain Layout
24716 \begin_layout Standard
24717 In case you need some more special settings that are not covered by the automatic settings,
24718 read the next section about how to set up output synchronization manually.
24719 If the automatic setup suits your needs,
24720 you can readily jump to section
24721 \begin_inset space ~
24725 \begin_inset CommandInset ref
24727 reference "subsec:configuring-viewers"
24733 where the necessary configuration steps in your viewer – needed both with the automatic and the manual setup – are described.
24736 \begin_layout Subsection
24740 \begin_layout Standard
24742 provides several different methods for reverse search.
24743 Some are built-in in the
24744 \begin_inset Flex Code
24747 \begin_layout Plain Layout
24754 some are provided by external packages.
24755 Your choice depends on whether your \SpecialChar LaTeX
24756 distribution already provides a given method (the built-in methods are rather new) and whether your viewer can cope with it.
24757 The available methods are described in the following.
24760 \begin_layout Subsubsection*
24761 Built-in DVI-search via src-specials (DVI only)
24764 \begin_layout Standard
24765 This method provides the DVI file with the necessary information for reverse search.
24766 It is available in \SpecialChar LaTeX
24767 since quite some time (any somewhat recent \SpecialChar LaTeX
24768 distribution should include it),
24769 and it works reliably.
24772 \begin_inset Flex Noun
24775 \begin_layout Plain Layout
24786 \begin_inset Flex Noun
24789 \begin_layout Plain Layout
24801 Preferences\SpecialChar menuseparator
24802 File Handling\SpecialChar menuseparator
24806 \begin_inset Flex Code
24809 \begin_layout Plain Layout
24810 latex -src-specials $$i
24816 If this doesn't work,
24817 check if your \SpecialChar TeX
24818 engine needs different options (the syntax might differ in some distributions).
24821 \begin_layout Subsubsection*
24822 External Packages (PDFSync and scrltx)
24825 \begin_layout Standard
24834 provide reverse search facility for PDF output (via pdflatex) and DVI output,
24836 In order to enable it,
24837 load the packages in the \SpecialChar LyX
24842 \begin_layout Itemize
24843 \begin_inset Flex Code
24846 \begin_layout Plain Layout
24849 usepackage{pdfsync}
24854 for reverse PDF search,
24857 \begin_layout Itemize
24858 \begin_inset Flex Code
24861 \begin_layout Plain Layout
24864 usepackage[active]{srcltx}
24869 for reverse DVI search.
24872 \begin_layout Standard
24873 If you want to be able to perform both DVI and PDF reverse searches,
24874 you can also insert in the preamble the following lines
24877 \begin_layout LyX-Code
24881 \begin_inset Newline newline
24887 \begin_inset Newline newline
24892 usepackage{pdfsync}
24893 \begin_inset Newline newline
24899 \begin_inset Newline newline
24904 usepackage[active]{srcltx}
24905 \begin_inset Newline newline
24913 \begin_layout Standard
24915 you can preview the file as either DVI or PDF (pdflatex) and the right package will be used.
24918 \begin_layout Standard
24919 Note that PDFSync might affect the output layout of your document.
24920 It is therefore advised to disable PDFsync for final documents.
24923 \begin_layout Subsubsection*
24924 Built-in reverse search via Sync\SpecialChar TeX
24928 \begin_layout Standard
24930 \begin_inset Flex Code
24933 \begin_layout Plain Layout
24939 have built-in support for both PDF and DVI reverse search.
24942 Sync\SpecialChar TeX
24945 facility is basically the result of the integration of the PDFSync package to the pdftex program and its merge with the
24950 You need at least \SpecialChar TeX
24951 Live 2008 or a recent Mik\SpecialChar TeX
24952 distribution in order to use it.
24956 \begin_layout Plain Layout
24958 Mik\SpecialChar TeX
24959 does not understand/obey the command \SpecialChar LyX
24960 inserts into the preamble when you check the "Enable Forward/Reverse Search" button in the toolbar and does not generate the necessary info.
24963 \begin_layout Plain Layout
24964 The generation of the required info can be forced by changing the converter "\SpecialChar LaTeX
24965 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e.,
24966 by adding the -synctex=1 switch).
24971 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
24973 SumatraPDF on Windows;
24974 see the next section for details) already provide Sync\SpecialChar TeX
24978 \begin_layout Standard
24979 To enable Sync\SpecialChar TeX
24982 \begin_inset Flex Noun
24985 \begin_layout Plain Layout
24996 \begin_inset Flex Noun
24999 \begin_layout Plain Layout
25004 (plain) -> DraftDVI
25011 Preferences\SpecialChar menuseparator
25012 File Handling\SpecialChar menuseparator
25016 \begin_inset Flex Code
25019 \begin_layout Plain Layout
25020 latex -synctex=1 $$i
25026 and for PDF output,
25028 \begin_inset Flex Noun
25031 \begin_layout Plain Layout
25036 (pdflatex) -> PDF (pdflatex)
25042 \begin_inset Flex Code
25045 \begin_layout Plain Layout
25046 pdflatex -synctex=1 $$i
25052 Should your viewer not be considered in the following description,
25053 or in case of missing success,
25054 please check the documentation of your viewer whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
25059 \begin_layout Plain Layout
25060 Note that the option
25061 \begin_inset Flex Code
25064 \begin_layout Plain Layout
25070 option enables gzip compression.
25071 If your viewer does not support it,
25072 you should instead use
25073 \begin_inset Flex Code
25076 \begin_layout Plain Layout
25090 \begin_layout Subsection
25091 Configuring and using specific viewers
25092 \begin_inset CommandInset label
25094 name "subsec:configuring-viewers"
25101 \begin_layout Subsubsection*
25102 Xdvi (all platforms)
25105 \begin_layout Standard
25107 \begin_inset Flex Code
25110 \begin_layout Plain Layout
25117 you don't need to do anything else for performing a reverse DVI search,
25118 as \SpecialChar LyX
25119 already provides the necessary hooks for automatically using the
25120 \begin_inset Flex Code
25123 \begin_layout Plain Layout
25130 Just setup your document as described above (reverse search is triggered by Ctrl-click or Alt-click on Mac OSX,
25134 \begin_layout Standard
25136 if for whatever reason you want to use the named pipe instead of the socket for communicating with \SpecialChar LyX
25138 simply change the DVI viewer in
25140 Preferences\SpecialChar menuseparator
25141 File Handling\SpecialChar menuseparator
25148 \begin_layout Plain Layout
25149 On Mac OSX you have to use
25150 \begin_inset Flex Code
25153 \begin_layout Plain Layout
25154 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
25165 \begin_inset Flex Code
25168 \begin_layout Plain Layout
25169 xdvi -editor "lyxeditor.sh %f %l"
25176 \begin_inset Flex Code
25179 \begin_layout Plain Layout
25185 is a suitable script.
25187 a minimal shell script is the following one:
25190 \begin_layout LyX-Code
25192 \begin_inset Newline newline
25195 LYXPIPE="/path/to/lyxpipe"
25196 \begin_inset Newline newline
25199 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
25200 \begin_inset Newline newline
25203 echo "$COMMAND" > "${LYXPIPE}".in || exit
25204 \begin_inset Newline newline
25207 read TMP < "${LYXPIPE}".out || exit
25210 \begin_layout Standard
25212 \begin_inset Flex Code
25215 \begin_layout Plain Layout
25221 is the LyXServer pipe path specified in
25223 Preferences\SpecialChar menuseparator
25230 \begin_layout Plain Layout
25232 \begin_inset Flex Code
25235 \begin_layout Plain Layout
25241 folder of a source distribution you can find a
25242 \begin_inset Flex Code
25245 \begin_layout Plain Layout
25251 script which is able to locate the
25255 based on your preferences.
25263 \begin_layout Subsubsection*
25267 \begin_layout Standard
25269 \begin_inset Flex Code
25272 \begin_layout Plain Layout
25273 /Applications/MacDviX_Folder/calleditor.script
25279 add the following lines:
25282 \begin_layout LyX-Code
25283 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
25284 \begin_inset Newline newline
25290 \begin_layout Standard
25291 Modify the lines accordingly if you install \SpecialChar LyX
25292 somewhere else than in the Applications folder.
25295 \begin_layout Standard
25296 Reverse search is triggered by Alt-click (OPTION-click).
25299 \begin_layout Subsubsection*
25303 \begin_layout Standard
25305 \begin_inset Flex Code
25308 \begin_layout Plain Layout
25309 open -a Skim.app $$i
25314 to the viewer setting in
25316 Preferences\SpecialChar menuseparator
25317 File Handling\SpecialChar menuseparator
25318 File formats\SpecialChar menuseparator
25324 Skim\SpecialChar menuseparator
25325 Preferences\SpecialChar menuseparator
25332 preset and enter command
25333 \begin_inset Flex Noun
25336 \begin_layout Plain Layout
25337 /Applications/\SpecialChar LyX
25338 .app/Contents/MacOS/lyxeditor
25346 \begin_layout Standard
25347 Reverse search is triggered by COMMAND-SHIFT-click
25350 \begin_layout Subsubsection*
25354 \begin_layout Standard
25355 Reverse search with evince does not work out of the box,
25356 but it can be achieved by means of some third party helper scripts.
25358 \begin_inset CommandInset href
25360 target "https://wiki.lyx.org/LyX/SyncTeX"
25368 \begin_layout Subsubsection*
25372 \begin_layout Standard
25375 Settings\SpecialChar menuseparator
25376 Configure Okular\SpecialChar menuseparator
25380 \begin_inset Quotes erd
25384 This inserts the appropriate command (
25385 \begin_inset Flex Code
25388 \begin_layout Plain Layout
25397 \begin_layout Standard
25398 Reverse search is triggered by SHIFT-click.
25399 Note that this only works if Okular is in
25400 \begin_inset Quotes eld
25404 \begin_inset Quotes erd
25408 \begin_inset space \thinspace{}
25412 the hand symbol is clicked).
25415 \begin_layout Subsubsection*
25419 \begin_layout Standard
25420 Qpdfview supports Sync\SpecialChar TeX
25421 since version 0.3.5.
25424 Edit\SpecialChar menuseparator
25425 Settings\SpecialChar menuseparator
25429 click on the input field of the
25430 \begin_inset Quotes eld
25434 \begin_inset Quotes erd
25437 item and add the command
25438 \begin_inset Flex Code
25441 \begin_layout Plain Layout
25450 \begin_layout Standard
25451 Reverse search is triggered by double-click or,
25452 in more recent versions,
25456 \begin_layout Subsubsection*
25460 \begin_layout Standard
25464 View\SpecialChar menuseparator
25467 menu and select the
25468 \begin_inset Quotes eld
25472 \begin_inset Quotes erd
25477 \begin_inset Quotes eld
25480 New\SpecialChar ldots
25482 \begin_inset Quotes erd
25486 in the window that opens,
25488 \begin_inset Quotes eld
25493 \begin_inset Quotes erd
25496 (or any other name you like) in the
25497 \begin_inset Quotes eld
25501 \begin_inset Quotes erd
25505 Now click on the button labeled
25506 \begin_inset Quotes eld
25511 \begin_inset Quotes erd
25514 to open a file dialog and navigate to the directory containing the batch file
25515 \begin_inset Flex Code
25518 \begin_layout Plain Layout
25526 \begin_inset Flex Code
25529 \begin_layout Plain Layout
25535 and then specify the program arguments as
25536 \begin_inset Flex Code
25539 \begin_layout Plain Layout
25547 \begin_inset Flex Code
25550 \begin_layout Plain Layout
25556 wrapper is used for communicating with \SpecialChar LyX
25564 \begin_layout LyX-Code
25566 \begin_inset Newline newline
25569 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
25578 \begin_inset Newline newline
25592 \begin_layout Standard
25593 Make sure that the \SpecialChar LyX
25594 Server pipe path you specified in \SpecialChar LyX
25596 \begin_inset Flex Code
25599 \begin_layout Plain Layout
25614 otherwise change the
25615 \begin_inset Flex Code
25618 \begin_layout Plain Layout
25624 wrapper accordingly.
25627 \begin_layout Standard
25629 reverse search is triggered by double-click.
25632 \begin_layout Subsubsection*
25633 SumatraPDF (Windows)
25636 \begin_layout Standard
25637 In order to use SumatraPDF for inverse search,
25639 \begin_inset Flex Code
25642 \begin_layout Plain Layout
25643 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
25648 in the viewer setting in
25650 Preferences\SpecialChar menuseparator
25651 File Handling\SpecialChar menuseparator
25652 File formats\SpecialChar menuseparator
25657 \begin_inset Flex Code
25660 \begin_layout Plain Layout
25666 is the previous wrapper.
25667 If SumatraPDF.exe is not in your command PATH,
25668 use its full file name.
25671 \begin_layout Standard
25672 Reverse search is triggered by double-click.
25675 \begin_layout Subsubsection*
25679 \begin_layout Standard
25681 make sure that yap is your default DVI viewer in the Windows environment,
25685 View\SpecialChar menuseparator
25688 menu and select the
25689 \begin_inset Quotes eld
25693 \begin_inset Quotes erd
25698 \begin_inset Quotes eld
25701 New\SpecialChar ldots
25703 \begin_inset Quotes erd
25707 in the window that opens,
25709 \begin_inset Quotes eld
25714 \begin_inset Quotes erd
25717 (or any other name you like) in the
25718 \begin_inset Quotes eld
25722 \begin_inset Quotes erd
25726 Now click on the button labeled
25727 \begin_inset Quotes eld
25732 \begin_inset Quotes erd
25735 to open a file dialog and navigate to the directory containing the
25736 \begin_inset Flex Code
25739 \begin_layout Plain Layout
25745 program (which is installed by default on Cygwin along with the \SpecialChar LyX
25748 \begin_inset Flex Code
25751 \begin_layout Plain Layout
25757 and then specify the program arguments as
25758 \begin_inset Flex Code
25761 \begin_layout Plain Layout
25769 you will be using the
25773 for communicating with \SpecialChar LyX
25776 for whatever reason,
25777 you want to use the
25783 \begin_inset Flex Code
25786 \begin_layout Plain Layout
25792 option and be sure to specify the \SpecialChar LyX
25793 Server pipe path in the \SpecialChar LyX
25797 \begin_layout Standard
25799 reverse search is triggered by double-click.
25802 \begin_layout Subsubsection*
25803 SumatraPDF (Cygwin)
25806 \begin_layout Standard
25807 In order to use SumatraPDF for inverse search,
25809 \begin_inset Flex Code
25812 \begin_layout Plain Layout
25813 SumatraPDF -inverse-search "lyxeditor -g %f %l"
25818 in the viewer setting in
25820 Preferences\SpecialChar menuseparator
25821 File Handling\SpecialChar menuseparator
25822 File formats\SpecialChar menuseparator
25826 If SumatraPDF.exe is not in your command PATH,
25827 use its full posix path.
25829 \begin_inset Flex Code
25832 \begin_layout Plain Layout
25838 enables communication via the
25845 \begin_inset Flex Code
25848 \begin_layout Plain Layout
25854 option if you want to use the
25859 and be sure to specify the \SpecialChar LyX
25860 Server pipe path in the \SpecialChar LyX
25864 \begin_layout Standard
25865 Reverse search is triggered by double-click.
25868 \begin_layout Section
25872 \begin_layout Standard
25874 as the name implies,
25876 \begin_inset Quotes eld
25880 \begin_inset Quotes erd
25884 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
25886 If forward search is set up (as described in what follows),
25887 you can put the cursor anywhere in your \SpecialChar LyX
25891 Navigate\SpecialChar menuseparator
25898 in the context menu via right mouse click),
25899 and then the viewer will jump to that position as well.
25902 that your viewer supports this function.
25905 \begin_layout Standard
25906 To make forward search possible,
25907 you first need to provide the generated output PDF/DVI file with additional information about the \SpecialChar TeX
25909 This can be done via the methods described in the section
25910 \begin_inset CommandInset ref
25912 reference "subsec:rev-search"
25920 \begin_layout Standard
25922 you need to configure \SpecialChar LyX
25923 for using your viewers in
25925 Tools\SpecialChar menuseparator
25926 Preferences\SpecialChar menuseparator
25927 Output\SpecialChar menuseparator
25931 We provide a range of tested configurations for some viewers,
25932 which you can select from the drop down list.
25933 If none of these configurations suits you,
25934 you have to find out and enter a suitable configuration yourself.
25935 The definition syntax uses the following placeholders:
25938 \begin_layout Itemize
25940 \begin_inset Flex Code
25943 \begin_layout Plain Layout
25953 \begin_layout Itemize
25955 \begin_inset Flex Code
25958 \begin_layout Plain Layout
25965 name of the (temporary) exported .tex file (without path)
25968 \begin_layout Itemize
25970 \begin_inset Flex Code
25973 \begin_layout Plain Layout
25980 name of the (temporary) exported .tex file (including path)
25983 \begin_layout Itemize
25985 \begin_inset Flex Code
25988 \begin_layout Plain Layout
25995 name of the exported output file (either dvi or pdf,
25996 depending on which one exists in the temporary directory)
25999 \begin_layout Standard
26000 Note that only some of the viewers provide full and usable forward search functionality out of the box,
26007 \begin_layout Plain Layout
26008 You might want to set
26009 \begin_inset Flex Code
26012 \begin_layout Plain Layout
26020 Tools\SpecialChar menuseparator
26021 Preferences\SpecialChar menuseparator
26022 File Handling\SpecialChar menuseparator
26024 \begin_inset space ~
26038 \begin_layout Plain Layout
26039 SumatraPDF can also use DDE commands through the external program CMCDDE —
26041 \begin_inset CommandInset href
26043 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
26059 \begin_layout Plain Layout
26060 Forward search with evince can be achieved by means of third party helper scripts.
26062 \begin_inset CommandInset href
26064 target "https://wiki.lyx.org/LyX/SyncTeX"
26075 require some extra tools in order to use forward search.
26076 While many of the widespread PDF viewers (most notably Adobe Reader) do not support forward search at all,
26077 some other viewers – e.
26078 \begin_inset space \thinspace{}
26082 xpdf – allow at least to reload the document and jump to a specific page of the file,
26083 so you can at least navigate
26084 \begin_inset Quotes eld
26088 \begin_inset Quotes erd
26092 This latter functionality is provided by an external call of synctex (see the predefined example configurations).
26096 \begin_layout Standard
26097 Forward search works both with DVI and PDF output.
26099 simply checks which preview format you have used before (i.
26100 \begin_inset space \thinspace{}
26104 which format is already there in the temporary directory) and chooses the appropriate configuration for the respective format.
26107 \begin_layout Chapter
26109 Features needing Extra Software
26112 \begin_layout Section
26113 Checking \SpecialChar TeX
26117 \begin_layout Standard
26123 \begin_layout Subsection
26127 \begin_layout Standard
26136 \begin_layout Plain Layout
26141 is not yet available when you are using the \SpecialChar LaTeX
26142 distribution MiK\SpecialChar TeX
26157 \begin_inset space ~
26168 \begin_inset Newline newline
26172 \begin_inset CommandInset href
26174 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
26182 \begin_layout Standard
26185 Chk\SpecialChar TeX
26188 package is a program that was written by
26189 \begin_inset Flex Noun
26192 \begin_layout Plain Layout
26194 \begin_inset space ~
26202 in frustration because some constructs in \SpecialChar LaTeX
26203 are sometimes non-intuitive,
26204 and easy to forget.
26205 The program runs over your \SpecialChar LaTeX
26207 checks the integrity of the file,
26208 and flags some common errors.
26209 In other technical words,
26214 for \SpecialChar LaTeX
26218 \begin_layout Standard
26220 what is a syntax checker doing in \SpecialChar LyX
26221 which is supposed to produce correct \SpecialChar LaTeX
26223 The answer is simple:
26228 not only checks the
26237 checks for type-errors,
26240 Chk\SpecialChar TeX
26243 catches some common
26248 in addition to the syntactical ones.
26252 Chk\SpecialChar TeX
26255 is capable of detecting several common errors,
26259 \begin_layout Itemize
26260 Ellipsis detection:
26261 \begin_inset Newline newline
26264 Use \SpecialChar ldots
26268 \begin_layout Itemize
26269 No space in front of/after parenthesis:
26270 \begin_inset Newline newline
26276 \begin_layout Itemize
26277 Enforcement of normal space after common abbreviations:
26278 \begin_inset Newline newline
26282 \begin_inset space \thinspace{}
26286 \begin_inset space \space{}
26289 is too wide spacing.
26292 \begin_layout Itemize
26293 Enforcement of end-of-sentence space when the last sentence ends with a capital letter:
26294 \begin_inset Newline newline
26298 And this is wrong spacing.
26301 \begin_layout Itemize
26302 Space in front of labels and similar commands:
26303 \begin_inset Newline newline
26306 The label should stick right up to the text to avoid falling to a wrong page.
26308 \begin_inset CommandInset label
26318 \begin_layout Plain Layout
26319 This footnote is in danger of falling off to a wrong page
26324 The label is separated too much.
26327 \begin_layout Itemize
26328 Space in front of references,
26329 instead of hard spaces:
26330 \begin_inset Newline newline
26333 If you have bad luck,
26334 the text will break right between the referenced text and reference number,
26337 \begin_inset CommandInset ref
26339 reference "sec:chktex"
26347 \begin_layout Itemize
26349 \begin_inset Quotes eld
26353 \begin_inset Quotes erd
26357 \begin_inset Formula $\times$
26361 \begin_inset Newline newline
26364 2x2 looks cheap compared to
26365 \begin_inset Formula $2\times2$
26371 \begin_layout Standard
26372 and more \SpecialChar ldots
26373 It is an invaluable tool when you are
26374 \begin_inset Quotes eld
26378 \begin_inset Quotes erd
26381 your document before printing,
26382 and you should run it right after the obligatory spelling check,
26383 and before you go fine tuning the typesetting.
26386 \begin_layout Subsection
26390 \begin_layout Standard
26391 If you have the program installed,
26392 usage is as simple as choosing
26394 Tools\SpecialChar menuseparator
26396 \begin_inset space ~
26402 This will make \SpecialChar LyX
26403 generate a \SpecialChar LaTeX
26404 file of your document,
26407 Chk\SpecialChar TeX
26411 and then make \SpecialChar LyX
26413 \begin_inset Quotes eld
26417 \begin_inset Quotes erd
26420 with the warnings from
26422 Chk\SpecialChar TeX
26427 The warnings will be placed close to the point of the mistake,
26428 and you can quickly find them by using the
26430 Navigate\SpecialChar menuseparator
26434 or the shortcut key
26443 Open the error boxes by clicking on them with the mouse,
26444 or use the shortcut key
26453 or the corresponding
26462 Read the warning and correct the mistake,
26463 if it is a mistake.
26464 If you have trouble understanding what the warning is about,
26465 you can safely ignore it.
26466 Remember that there is a hidden layer between the document on screen and the technical details in invoking
26468 Chk\SpecialChar TeX
26472 and this gap can make some warnings seem arcane or just plain silly.
26475 \begin_layout Standard
26476 This document is an excellent testing bed for the feature,
26477 and it should provide quite a few warnings for you to fiddle with.
26478 Since computers are only so smart,
26479 expect most of the warnings to be false alarms,
26483 \begin_layout Subsection
26484 How to fine tune it
26487 \begin_layout Standard
26491 Chk\SpecialChar TeX
26494 makes more noise than suits your mood.
26495 Then you can choose not to use it,
26496 wait until your mood changes,
26497 or try to customize
26499 Chk\SpecialChar TeX
26502 to get better along with you.
26505 \begin_layout Standard
26508 Chk\SpecialChar TeX
26515 very configurable and extensible,
26516 you should not expect to solve all problems with
26518 Chk\SpecialChar TeX
26521 in \SpecialChar LyX
26523 Since \SpecialChar LyX
26524 has to generate a somewhat special \SpecialChar LaTeX
26525 file to be able to match the line numbers from the
26527 Chk\SpecialChar TeX
26534 \begin_layout Plain Layout
26535 You can inspect the specific output from
26541 Document\SpecialChar menuseparator
26544 \begin_inset space ~
26558 to the internal document structure,
26559 some of the warnings will not appear correctly.
26560 There are two things you can do about this:
26563 \begin_layout Itemize
26566 Chk\SpecialChar TeX
26569 invocation command line in
26571 Tools\SpecialChar menuseparator
26572 Preferences\SpecialChar menuseparator
26573 Output\SpecialChar menuseparator
26574 LaTeX\SpecialChar menuseparator
26580 Chk\SpecialChar TeX
26583 installation configuration file (usually with the file
26588 See below to learn what warnings can be enabled and disabled on the command line.
26591 \begin_layout Itemize
26592 Export your document as a raw \SpecialChar LaTeX
26595 File\SpecialChar menuseparator
26596 Export\SpecialChar menuseparator
26605 Invoked in this way,
26606 it can be a hassle to find the corresponding place in the document inside \SpecialChar LyX
26608 but with a little patience,
26609 you should be able to do it.
26612 \begin_layout Standard
26613 Here follows the warning messages that can be enabled and disabled in
26622 to disable a warning,
26627 to enable a warning.
26628 The emphasized entries are disabled by default,
26629 because the default is "
26631 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
26636 \begin_layout Standard
26637 Notice that you should only use the options that enable and disable warnings,
26638 because \SpecialChar LyX
26639 relies on some of the other command line parameters to be set in a specific way to have a chance to communicate with
26646 \begin_layout Enumerate
26650 Command terminated with space.
26653 \begin_layout Enumerate
26656 Non-breaking space (
26657 \begin_inset Quotes eld
26665 \begin_inset Quotes erd
26668 ) should have been used.
26671 \begin_layout Enumerate
26675 You should enclose the previous parenthesis with
26676 \begin_inset Quotes eld
26684 \begin_inset Quotes erd
26690 \begin_layout Enumerate
26693 Italic correction (
26694 \begin_inset Quotes eld
26704 \begin_inset Quotes erd
26707 ) found in non-italic buffer.
26710 \begin_layout Enumerate
26713 Italic correction (
26714 \begin_inset Quotes eld
26724 \begin_inset Quotes erd
26727 ) found more than once.
26730 \begin_layout Enumerate
26734 No italic correction (
26735 \begin_inset Quotes eld
26745 \begin_inset Quotes erd
26751 \begin_layout Enumerate
26755 \begin_inset Quotes eld
26763 \begin_inset Quotes erd
26767 \begin_inset Quotes eld
26775 \begin_inset Quotes erd
26781 \begin_layout Enumerate
26784 Wrong length of dash may have been used.
26787 \begin_layout Enumerate
26791 \begin_inset Quotes eld
26799 \begin_inset Quotes erd
26804 \begin_inset Quotes eld
26812 \begin_inset Quotes erd
26818 \begin_layout Enumerate
26822 \begin_inset Quotes eld
26830 \begin_inset Quotes erd
26836 \begin_layout Enumerate
26840 \begin_inset Quotes eld
26848 \begin_inset Quotes erd
26851 to achieve an ellipsis.
26854 \begin_layout Enumerate
26857 Inter-word spacing (
26858 \begin_inset Quotes eld
26868 \begin_inset Quotes eld
26871 ) should perhaps be used.
26874 \begin_layout Enumerate
26877 Inter-sentence spacing (
26878 \begin_inset Quotes eld
26888 \begin_inset Quotes erd
26891 ) should perhaps be used.
26894 \begin_layout Enumerate
26897 Could not find argument for command.
26900 \begin_layout Enumerate
26904 \begin_inset Quotes eld
26912 \begin_inset Quotes erd
26918 \begin_layout Enumerate
26921 Math mode still on at end of \SpecialChar LaTeX
26925 \begin_layout Enumerate
26929 \begin_inset Quotes eld
26937 \begin_inset Quotes erd
26940 doesn't match the number of
26941 \begin_inset Quotes eld
26949 \begin_inset Quotes erd
26955 \begin_layout Enumerate
26958 You should use either
26961 \begin_inset Quotes eld
26969 \begin_inset Quotes erd
26974 as an alternative to
26975 \begin_inset Quotes eld
26983 \begin_inset Quotes erd
26989 \begin_layout Enumerate
26996 " (ASCII 39) instead of "
27003 \begin_layout Enumerate
27006 User-specified pattern found.
27009 \begin_layout Enumerate
27012 This command might not be intended.
27015 \begin_layout Enumerate
27022 \begin_layout Enumerate
27040 \begin_layout Enumerate
27043 Delete this space to maintain correct page references.
27046 \begin_layout Enumerate
27050 You might wish to put this between a pair of
27051 \begin_inset Quotes eld
27059 \begin_inset Quotes erd
27065 \begin_layout Enumerate
27068 You ought to remove spaces in front of punctuation.
27071 \begin_layout Enumerate
27074 Could not execute \SpecialChar LaTeX
27078 \begin_layout Enumerate
27087 in front of small punctuation.
27090 \begin_layout Enumerate
27098 may look prettier here.
27101 \begin_layout Enumerate
27105 Multiple spaces detected in output.
27108 \begin_layout Enumerate
27111 This text may be ignored.
27114 \begin_layout Enumerate
27120 \begin_inset Quotes eld
27125 to begin quotation,
27133 \begin_layout Enumerate
27144 \begin_inset Quotes eld
27152 \begin_layout Enumerate
27158 \begin_layout Enumerate
27161 You should perhaps use
27162 \begin_inset Quotes eld
27170 \begin_inset Quotes erd
27176 \begin_layout Enumerate
27179 You should put a space in front of/after parenthesis.
27182 \begin_layout Enumerate
27185 You should avoid spaces in front of/after parenthesis.
27188 \begin_layout Enumerate
27192 You should not use punctuation in front of/after quotes.
27195 \begin_layout Enumerate
27198 Double space found.
27201 \begin_layout Enumerate
27204 You should put punctuation outside inner/inside display math mode.
27207 \begin_layout Enumerate
27210 You ought to not use primitive \SpecialChar TeX
27211 in \SpecialChar LaTeX
27215 \begin_layout Enumerate
27218 You should remove spaces in front of
27219 \begin_inset Quotes eld
27227 \begin_inset Quotes erd
27233 \begin_layout Enumerate
27236 \begin_inset Quotes eld
27244 \begin_inset Quotes erd
27247 is normally not followed by
27248 \begin_inset Quotes eld
27256 \begin_inset Quotes erd
27262 \begin_layout Standard
27263 In later versions of \SpecialChar LyX
27265 we hope to provide a more complete interface to this tool (and it's smaller cousin
27269 ) to exploit the full power of it.
27270 But it's not exactly useless as it is now:
27271 go try it on one of your existing documents of a certain length and be surprised.
27274 \begin_layout Section
27275 Version Control in \SpecialChar LyX
27279 \begin_layout Standard
27282 Lars Gullik Bjønnes
27289 \begin_layout Subsection
27293 \begin_layout Standard
27295 supports some of the most basic RCS/CVS/SVN/GIT commands.
27296 If you need something a bit more sophisticated you will have to do that manually in a terminal or your favourite client.
27299 \begin_layout Standard
27300 Also note that CVS support is not as good as subversion support,
27301 so we advise using SVN instead.
27302 A good place to start learning Subversion is the SVN Book
27306 \begin_layout Plain Layout
27307 \begin_inset CommandInset href
27309 target "http://svnbook.red-bean.com/"
27320 In the case of RCS you should read
27321 \begin_inset Quotes eld
27325 \begin_inset Quotes erd
27334 This file describes all the basic features of RCS.
27335 You should especially notice the comment about a RCS directory,
27336 and the notion of a master RCS file (the file ending in
27343 \begin_layout Standard
27344 Before you begin to use the version control features in \SpecialChar LyX
27346 you should be familiar with RCS/CVS/SVN/GIT usage.
27347 The implementation in \SpecialChar LyX
27348 assumes a recent version of the GNU RCS or CVS/SVN package —
27349 no guarantees are made for older versions.
27350 Most of the log messages are not currently displayed after operations —
27351 you can check them in the Messages pane if you are unsure.
27352 Regular users of version control will appreciate the VC toolbar,
27353 which can be enabled via
27355 View\SpecialChar menuseparator
27356 Toolbars\SpecialChar menuseparator
27358 \begin_inset space ~
27366 \begin_layout Standard
27367 For introducing your own external commands consult
27368 \begin_inset Flex Code
27371 \begin_layout Plain Layout
27385 \begin_layout Standard
27386 It is strongly recommended to store documents in uncompressed format if using version control (uncheck
27388 Document\SpecialChar menuseparator
27392 Uncompressed LyX documents are text files and therefore for merging two different versions by version control systems.
27393 Compressed LyX documents are binary files,
27394 which cannot be merged by version control systems.
27395 Also to avoid unnecessary merge conflicts we advise to disable
27397 Document\SpecialChar menuseparator
27398 Settings\SpecialChar menuseparator
27399 Output\SpecialChar menuseparator
27400 Save transient properties
27402 when more users work on the same document.
27405 \begin_layout Subsection
27406 RCS commands in \SpecialChar LyX
27410 \begin_layout Standard
27411 The following sections describe the RCS commands supported by \SpecialChar LyX
27413 You can find them in the
27415 File\SpecialChar menuseparator
27417 \begin_inset space ~
27424 was tested against RCS 5.7/5.8/5.10.
27427 \begin_layout Subsubsection
27433 \begin_layout Standard
27434 If your document is not under revision control,
27435 this is the only item shown in the menu.
27436 And if it is under revision control,
27441 item is not visible.
27445 \begin_layout Standard
27446 This command registers your document with RCS (unless you are under the directory managed by CVS)\SpecialChar endofsentence
27447 You are asked interactively to supply an initial description of the document.
27448 The document is now set in Read-Only mode and you have to
27451 \begin_inset space ~
27455 \begin_inset space ~
27459 \begin_inset space ~
27465 before making any changes to it.
27466 A document under revision control has a
27467 \begin_inset Quotes eld
27470 [RCS:<version> <locker>]
27471 \begin_inset Quotes erd
27474 item tagged to the filename in the minibuffer.
27477 \begin_layout Standard
27478 RCS command that is run:
27481 \begin_layout LyX-Code
27484 ci -q -u -i -t-"<initial description>" <file-name>
27487 \begin_layout Standard
27492 to understand the switches.
27496 \begin_layout Subsubsection
27502 \begin_layout Standard
27503 When you are finished editing a file,
27504 you check in your changes.
27506 you are asked for a description of the changes.
27507 This is stored in the history log.
27508 The version number is bumped,
27509 your changes are applied to the master RCS file,
27510 the document is unlocked and set to Read-Only mode.
27513 \begin_layout Itemize
27517 ci -q -u -m"<description>" <file-name>
27520 \begin_layout Subsubsection
27526 \begin_layout Standard
27527 By doing this you lock the document so that only you can edit it.
27528 This will also make the document Read-Write only for you.
27529 You will usually continue editing for a while and when you are finished you check in your changes.
27530 The status line is changed to reflect that you have locked the file.
27533 \begin_layout Itemize
27537 co -q -l <file-name>
27540 \begin_layout Subsubsection
27543 Revert To Repository Version
27546 \begin_layout Standard
27547 This will discard all changes made to the document since the last check in.
27548 You get a warning before changes are discarded.
27551 \begin_layout Itemize
27555 co -f -u<version> <file-name>
27558 \begin_layout Subsubsection
27564 \begin_layout Standard
27565 This will create a copy of the current document.
27566 Since RCS does not support copy operations natively,
27567 the version history is not preserved,
27568 and the copy is added as a new file.
27569 It requires a clean document without any changes since the last checkin.
27570 You are asked for a file name and a description of the copy operation.
27571 After that the copy is created,
27572 both locally and in the repository.
27573 If the parent directories of the copied and original document differ,
27574 all relative paths of included files of the copy are adjusted (like in
27576 File\SpecialChar menuseparator
27582 the copy is loaded instead of the original document.
27585 \begin_layout Labeling
27586 \labelwidthstring 00.00.0000
27588 \begin_inset space ~
27593 \begin_inset space ~
27597 \begin_inset Newline newline
27601 \begin_inset Flex Code
27604 \begin_layout Plain Layout
27607 \begin_inset Quotes qld
27611 \begin_inset Quotes qld
27620 \begin_inset Flex Code
27623 \begin_layout Plain Layout
27626 \begin_inset Quotes qld
27630 \begin_inset Quotes qld
27639 \begin_inset Newline newline
27643 \begin_inset Flex Code
27646 \begin_layout Plain Layout
27650 \begin_inset Quotes qld
27654 \begin_inset Quotes qld
27665 \begin_layout Subsubsection
27671 \begin_layout Standard
27672 This makes as if the last check in never happened.
27673 No changes are made to the document loaded into \SpecialChar LyX
27675 but the last version is removed from the master RCS file.
27678 \begin_layout Itemize
27682 rcs -o<version> <file-name>
27685 \begin_layout Subsubsection
27691 \begin_layout Standard
27692 This shows the complete history of the RCS document.
27697 is shown in a browser.
27705 \begin_layout Subsubsection
27709 \begin_layout Standard
27711 supports RCS version number,
27713 date and time of last commit.
27714 All those are extracted from
27716 rlog -r <file-name>
27720 \begin_inset CommandInset ref
27722 reference "subsec:VCS-Revision-Information"
27730 \begin_layout Subsection
27731 CVS commands in \SpecialChar LyX
27735 \begin_layout Standard
27736 A subset of CVS operations is supported by \SpecialChar LyX
27738 You can find the commands in the
27740 File\SpecialChar menuseparator
27742 \begin_inset space ~
27748 The version control system SVN is more powerful,
27749 so please use it instead of CVS if possible.
27752 \begin_layout Subsubsection
27758 \begin_layout Standard
27759 If you start from scratch with CVS you have to create your repository and checkout the working copy with external tools.
27760 If you're using a client-server setup you may need to login before doing the first repository checkout.
27763 \begin_layout Standard
27764 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.
27765 Standard CVS repositories don't operate with a file locking mechanism.
27766 This may be surprising,
27767 but conflicts only occur if people disagree on the proper content of the same part of a document.
27769 if co-workers are used to communicate regularly,
27770 these conflicts occur rarely.
27771 If they don't communicate they have a fundamental problem anyway.
27772 Nevertheless some people like to work with so called
27773 \begin_inset Quotes eld
27777 \begin_inset Quotes erd
27781 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.
27782 When the changes are checked in the working copy returns to readonly state.
27783 With \SpecialChar LyX
27784 one has to edit the
27785 \begin_inset Flex Code
27788 \begin_layout Plain Layout
27794 file and add the line
27795 \begin_inset Flex Code
27798 \begin_layout Plain Layout
27804 to work with reserved checkouts.
27805 The benefit is the possibility to see who is using a writable copy of some document.
27806 It's not guaranteed only one user makes a copy writable.
27809 \begin_layout Standard
27811 tries to guess if you're using reserved or non-reserved checkouts.
27812 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.
27813 When a reserved checkout is detected you have to use
27814 \begin_inset Flex Noun
27817 \begin_layout Plain Layout
27823 to make your working copy writable if it's readonly.
27825 \begin_inset Flex Noun
27828 \begin_layout Plain Layout
27834 operation is possible and that makes your working copy readonly again after transferring your changes to the repository.
27837 \begin_layout Standard
27838 More information about CVS can be found here
27839 \begin_inset Flex URL
27842 \begin_layout Plain Layout
27844 http://www.nongnu.org/cvs
27850 \begin_inset Flex URL
27853 \begin_layout Plain Layout
27855 http://ximbiot.com/cvs
27863 \begin_layout Standard
27868 to understand the sub-commands and the switches mentioned below.
27871 \begin_layout Subsubsection
27877 \begin_layout Standard
27878 If your document is not under revision control,
27879 this is the only item shown in the menu.
27880 And if it is under revision control,
27885 item is not visible.
27889 \begin_layout Standard
27890 This command registers in CVS your document
27891 \begin_inset Flex Strong
27894 \begin_layout Plain Layout
27902 in the case you have already the documents directory under CVS control (in particular
27907 This means you have to create or checkout the archive by yourself using external tools.
27908 (In case you forget that step \SpecialChar LyX
27909 registers the document with RCS.)
27912 \begin_layout Standard
27913 Then you are asked interactively to supply an initial description of the document.
27914 Don't forget that registered file is not yet checked in.
27917 \begin_layout Standard
27918 CVS command that is run:
27921 cvs -q add -m"<entered message>" "<file-name>"
27924 \begin_layout Standard
27929 above and for all other CVS commands is an abbreviation for
27930 \begin_inset Quotes eld
27933 change the current working directory to file location and use the file name without path component as argument
27934 \begin_inset Quotes erd
27940 \begin_layout Subsubsection
27946 \begin_layout Standard
27947 When you are finished editing a file,
27948 you commit your changes.
27949 When you do this and you had changed the document,
27950 you are asked for a description of the changes.
27951 After that changes are written to the repository.
27952 In case you didn't change the document and a reserved checkout is detected the reservation made on
27953 \begin_inset Flex Noun
27956 \begin_layout Plain Layout
27965 \begin_layout Labeling
27966 \labelwidthstring 00.00.0000
27968 \begin_inset space ~
27973 \begin_inset space ~
27977 \begin_inset Newline newline
27981 \begin_inset Flex Code
27984 \begin_layout Plain Layout
27987 -q commit -m"<description>" "<file-name>"
27993 \begin_inset Newline newline
27997 \begin_inset Flex Code
28000 \begin_layout Plain Layout
28011 \begin_layout Subsubsection
28017 \begin_layout Standard
28018 When you are sharing a repository with others,
28019 you may have to incorporate their changes into your working copy.
28022 \begin_layout Standard
28026 cvs -q update "<file-name>"
28029 \begin_layout Standard
28030 If a readonly checkout is detected the working copy is made writable and reserved.
28033 \begin_layout Standard
28037 cvs -q edit "<file-name>"
28040 \begin_layout Subsubsection
28043 Revert To Repository Version
28046 \begin_layout Standard
28047 This will discard all changes made to the document since the last check in.
28048 You get a warning before changes are discarded.
28049 Firstly the file is deleted,
28050 secondly CVS update command is run.
28053 \begin_layout Standard
28057 cvs -q update "<file-name>"
28060 \begin_layout Standard
28061 If a reserved checkout is detected and the working copy has no changes only the reservation is undone.
28064 \begin_layout Standard
28068 cvs -q unedit "<file-name>"
28071 \begin_layout Subsubsection
28077 \begin_layout Standard
28078 This will create a copy of the current document.
28079 Since CVS does not support copy operations natively,
28080 the version history is not preserved,
28081 and the copy is added as a new file.
28082 It requires a clean document without any changes since the last checkin.
28083 You are asked for a file name and a description of the copy operation.
28084 After that the copy is created,
28085 both locally and in the repository.
28086 If the parent directories of the copied and original document differ,
28087 all relative paths of included files of the copy are adjusted (like in
28089 File\SpecialChar menuseparator
28095 the copy is loaded instead of the original document.
28098 \begin_layout Labeling
28099 \labelwidthstring 00.00.0000
28101 \begin_inset space ~
28106 \begin_inset space ~
28110 \begin_inset Newline newline
28114 \begin_inset Flex Code
28117 \begin_layout Plain Layout
28124 \begin_inset Flex Code
28127 \begin_layout Plain Layout
28134 \begin_inset Newline newline
28138 \begin_inset Flex Code
28141 \begin_layout Plain Layout
28142 cvs -q add "<new-file-name>"
28150 \begin_layout Subsubsection
28156 \begin_layout Standard
28157 This will rename the current document.
28158 Since CVS does not support rename operations natively,
28159 the version history is not preserved,
28160 the renamed document is added as a new file,
28161 and the original document is deleted.
28162 It requires a clean document without any changes since the last checkin.
28163 You are asked for a file name and a description of the rename operation.
28164 After that the document is renamed,
28165 both locally and in the repository.
28166 If the parent directories of the new and old file names differ,
28167 all relative paths of included files are adjusted (like in
28169 File\SpecialChar menuseparator
28175 the document is reloaded using the new name.
28178 \begin_layout Labeling
28179 \labelwidthstring 00.00.0000
28181 \begin_inset space ~
28186 \begin_inset space ~
28190 \begin_inset Newline newline
28194 \begin_inset Flex Code
28197 \begin_layout Plain Layout
28204 \begin_inset Flex Code
28207 \begin_layout Plain Layout
28214 \begin_inset Newline newline
28218 \begin_inset Flex Code
28221 \begin_layout Plain Layout
28222 cvs -q add "<new-file-name>"
28228 \begin_inset Newline newline
28232 \begin_inset Flex Code
28235 \begin_layout Plain Layout
28236 cvs -q remove "<file-name>"
28244 \begin_layout Subsubsection
28245 Update of the local directory checkout from repository
28248 \begin_layout Standard
28249 Once your documents gets more complex,
28250 containing sub-documents and pictures,
28252 \begin_inset Flex Code
28255 \begin_layout Plain Layout
28261 files and so on using version control becomes more complicated.
28263 supports updating the whole tree in which resides the document.
28264 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.
28265 You have to organize the files structure so that all external files are in the same directory or subdirectories of the document.
28266 It's good practice anyway to store multipart documents in an extra directory.
28269 \begin_layout Standard
28271 \begin_inset Flex Code
28274 \begin_layout Plain Layout
28275 Update local directory from repository
28280 command updates the whole directory.
28281 If local changes are detected user is warned before update starts.
28282 In case of merge conflicts both versions of the conflicting document parts are placed in the final document.
28283 You have to review and correct the result of the merge.
28284 You'll find the conflicts enclosed in pairs of
28285 \begin_inset Flex Code
28288 \begin_layout Plain Layout
28295 \begin_inset Flex Code
28298 \begin_layout Plain Layout
28305 \begin_inset Flex Code
28308 \begin_layout Plain Layout
28315 The first part is your version as before the update operation with the document name prepended.
28316 The second one is the repository version with the version number after the sequence of
28317 \begin_inset Flex Code
28320 \begin_layout Plain Layout
28329 \begin_layout Labeling
28330 \labelwidthstring 00.00.0000
28332 \begin_inset space ~
28337 \begin_inset space ~
28341 \begin_inset Newline newline
28345 \begin_inset Flex Code
28348 \begin_layout Plain Layout
28357 (Ask if changes are detected.)
28358 \begin_inset Newline newline
28362 \begin_inset Flex Code
28365 \begin_layout Plain Layout
28377 \begin_layout Standard
28379 \begin_inset Flex Code
28382 \begin_layout Plain Layout
28388 stands for the path to the document.
28391 \begin_layout Subsubsection
28397 \begin_layout Standard
28398 This shows the complete history of the CVS document.
28401 cvs log "<file-name>"
28403 is shown in a browser.
28406 \begin_layout Subsubsection
28410 \begin_layout Standard
28412 supports CVS version number,
28414 date and time of last commit.
28415 All those are extracted from
28417 cvs log -r <file-name>
28421 \begin_inset CommandInset ref
28423 reference "subsec:VCS-Revision-Information"
28431 \begin_layout Subsection
28432 SVN commands in \SpecialChar LyX
28436 \begin_layout Standard
28437 SVN is now partially supported by \SpecialChar LyX
28439 You can find the commands in the
28441 File\SpecialChar menuseparator
28443 \begin_inset space ~
28449 Please note that if you use password protected access to repository via ssh,
28450 you will be asked in terminal window.
28452 was tested against SVN 1.5,
28458 \begin_layout Plain Layout
28459 Most of the commands will work with 1.4 too,
28461 \begin_inset CommandInset ref
28463 reference "subsec:SVN-Repo-Update"
28469 There seems to be currently unresolved permissions problem under SVN 1.8 with reverting changes when file is locked.
28477 \begin_layout Subsubsection
28483 \begin_layout Standard
28484 If your document is not under revision control,
28485 this is the only item shown in the menu.
28486 And if it is under revision control,
28491 item is not visible.
28494 \begin_layout Standard
28495 This command registers in SVN your document ONLY in case you have already the documents directory under SVN control (in particular
28500 This means you have to checkout the archive by yourself.
28503 \begin_layout Standard
28504 Then you are asked interactively to supply an initial description of the document.
28505 Don't forget that registered file is not yet commited.
28508 \begin_layout Standard
28509 SVN command that is run:
28513 \begin_inset Quotes qld
28517 \begin_inset Quotes qld
28523 \begin_layout Standard
28528 to understand the switches.
28531 \begin_layout Subsubsection
28537 \begin_layout Standard
28538 When you are finished editing a file,
28539 you commit your changes.
28541 you are asked for a description of the changes.
28542 After that changes are commited.
28545 \begin_layout Standard
28550 \begin_layout Plain Layout
28551 In case locking is not enabled.
28553 \begin_inset CommandInset ref
28555 reference "subsec:SVN-File-Locking"
28567 svn commit -q -m"<description>" <file-name>
28570 \begin_layout Subsubsection
28576 \begin_layout Standard
28577 Updates the changes of this file from the repository.
28578 Be sure you understand SVN merging and conflicts resolving before using this function,
28579 because all conflicts has to be resolved manually by you!
28582 \begin_layout Standard
28587 \begin_layout Plain Layout
28595 svn update --non-interactive
28596 \begin_inset Quotes qld
28600 \begin_inset Quotes qld
28606 \begin_layout Subsubsection
28609 Revert To Repository Version
28612 \begin_layout Standard
28613 This will discard all changes made to the document since the last check in.
28614 You get a warning before changes are discarded.
28617 \begin_layout Standard
28622 \begin_inset Quotes qld
28626 \begin_inset Quotes qld
28632 \begin_layout Subsubsection
28638 \begin_layout Standard
28639 This will create a copy of the current document including the version history.
28640 It requires a clean document without any changes since the last checkin.
28641 You are asked for a file name and a description of the copy operation.
28642 After that the copy is created,
28643 both locally and in the repository.
28644 If the parent directories of the copied and original document differ,
28645 all relative paths of included files of the copy are adjusted (like in
28647 File\SpecialChar menuseparator
28653 the copy is loaded instead of the original document.
28656 \begin_layout Labeling
28657 \labelwidthstring 00.00.0000
28659 \begin_inset space ~
28664 \begin_inset space ~
28668 \begin_inset Newline newline
28672 \begin_inset Flex Code
28675 \begin_layout Plain Layout
28679 \begin_inset Quotes qld
28683 \begin_inset Quotes qld
28687 \begin_inset Quotes qld
28691 \begin_inset Quotes qld
28700 \begin_inset Newline newline
28704 \begin_inset Flex Code
28707 \begin_layout Plain Layout
28716 \begin_layout Subsubsection
28722 \begin_layout Standard
28723 This will rename the current document including the version history.
28724 It requires a clean document without any changes since the last checkin.
28725 You are asked for a file name and a description of the rename operation.
28726 After that the document is renamed,
28727 both locally and in the repository.
28728 If the parent directories of the new and old file names differ,
28729 all relative paths of included files are adjusted (like in
28731 File\SpecialChar menuseparator
28737 the document is reloaded using the new name.
28740 \begin_layout Labeling
28741 \labelwidthstring 00.00.0000
28743 \begin_inset space ~
28748 \begin_inset space ~
28752 \begin_inset Newline newline
28756 \begin_inset Flex Code
28759 \begin_layout Plain Layout
28763 \begin_inset Quotes qld
28767 \begin_inset Quotes qld
28771 \begin_inset Quotes qld
28775 \begin_inset Quotes qld
28784 \begin_inset Newline newline
28788 \begin_inset Flex Code
28791 \begin_layout Plain Layout
28800 \begin_layout Subsubsection
28801 \begin_inset CommandInset label
28803 name "subsec:SVN-Repo-Update"
28807 Update of the local directory checkout from repository
28811 \begin_layout Plain Layout
28812 Note that this command will work only with subversion
28813 \begin_inset Formula $\geqq1.5$
28824 \begin_layout Standard
28825 All the commands above have one shortcoming – they deal with the current document only.
28826 Once your document contains pictures,
28828 \begin_inset Flex Code
28831 \begin_layout Plain Layout
28837 files and so on administration becomes more complicated.
28839 now supports updating the whole tree in which resides the document
28843 \begin_layout Plain Layout
28844 One need to organize the files structure so that all external files are in the same directory or subdirectories of the document.
28851 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.
28855 \begin_layout Standard
28856 \begin_inset Flex Code
28859 \begin_layout Plain Layout
28860 Update local directory from repository
28865 command updates the whole directory and in case of merge conflicts local version of the files are left,
28866 so no unintended data loss occurs.
28867 If local changes are detected user is warned before update starts.
28870 \begin_layout Labeling
28871 \labelwidthstring 00.00.0000
28873 \begin_inset space ~
28878 \begin_inset space ~
28882 \begin_inset Newline newline
28886 \begin_inset Flex Code
28889 \begin_layout Plain Layout
28895 (Ask if changes are detected.)
28896 \begin_inset Newline newline
28900 \begin_inset Flex Code
28903 \begin_layout Plain Layout
28904 svn update --accept mine-full $path
28912 \begin_layout Standard
28914 \begin_inset Flex Code
28917 \begin_layout Plain Layout
28923 stands for the path to the document.
28926 \begin_layout Subsubsection
28932 \begin_layout Standard
28933 This shows the complete history of the SVN document.
28937 \begin_inset Quotes qld
28941 \begin_inset Quotes qld
28946 is shown in a browser.
28949 \begin_layout Subsubsection
28951 \begin_inset CommandInset label
28953 name "subsec:SVN-File-Locking"
28960 \begin_layout Standard
28961 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.
28962 When such a conflict happens it needs manual resolving and one reasonable alternative is to provide some kind of locking mechanism,
28963 which guarantees that only one user is allowed to edit file at the given time.
28966 \begin_layout Standard
28967 SVN has two such mechanisms to provide mutual exclusivity for file access – locks and automatic setting of write permissions (see sec.
28969 \begin_inset CommandInset ref
28971 reference "subsec:Automatical-Locking-Property"
28977 \begin_inset Flex Code
28980 \begin_layout Plain Layout
28990 \begin_layout Plain Layout
28991 \begin_inset Flex URL
28994 \begin_layout Plain Layout
28996 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
29007 If this property is detected for a given document \SpecialChar LyX
29008 starts to use SVN locks for document editing automatically and the whole check-in/out mechanism switches to the same regimen as for RCS.
29009 This in particular means there are two different modes of file use in \SpecialChar LyX
29013 \begin_layout Itemize
29015 The loaded file is in the read-only mode.
29016 For editing on needs to check-out.
29021 consists of updating from the repository and gaining write lock.
29022 If the lock is not possible to obtain,
29023 we remain in unlocked state.
29026 \begin_layout Itemize
29028 The loaded file is in the
29029 \begin_inset Quotes els
29033 \begin_inset Quotes ers
29037 No other user is allowed to edit the file.
29042 consists of commiting changes and releasing write-lock.
29043 If no changes have been made to the document,
29044 no commit will be produced
29048 \begin_layout Plain Layout
29049 Don't be puzzled by the fact that you will be asked for commit message anyway.
29054 and only the write-lock will be released.
29057 \begin_layout Standard
29061 \begin_layout Labeling
29062 \labelwidthstring 00.00.0000
29066 svn commit -q -m"<description>" "<file-name>"
29067 \begin_inset Newline newline
29070 svn unlock "<file-name>"
29073 \begin_layout Labeling
29074 \labelwidthstring 00.00.0000
29078 svn update "<file-name>"
29079 \begin_inset Newline newline
29082 svn lock "<file-name>"
29085 \begin_layout Subsubsection
29088 \begin_inset CommandInset label
29090 name "subsec:Automatical-Locking-Property"
29096 Automatic Locking Property
29099 \begin_layout Standard
29100 The above mentioned automatic setting of write permissions of the .lyx file can be set through
29102 File\SpecialChar menuseparator
29104 \begin_inset space ~
29107 Control\SpecialChar menuseparator
29108 Use Locking Property
29111 This command is active only when the file is not locked on the svn server (i.e.
29112 you need to check-out before proceeding).
29115 \begin_layout Labeling
29116 \labelwidthstring 00.00.0000
29118 \begin_inset space ~
29124 \begin_layout Labeling
29125 \labelwidthstring 00.00.0000
29129 svn propset svn:needs-lock ON "<file-name>"
29132 \begin_layout Labeling
29133 \labelwidthstring 00.00.0000
29137 svn propdel svn:needs-lock "<file-name>"
29140 \begin_layout Subsubsection
29141 \begin_inset CommandInset label
29143 name "subsec:VCS-Revision-Information"
29147 Revision Information in Documents
29150 \begin_layout Standard
29151 There are more possibilities how to activate revision information in our document.
29154 \begin_layout Itemize
29160 \begin_layout Itemize
29161 tree revision information (
29162 \begin_inset Flex Code
29165 \begin_layout Plain Layout
29172 The result is the output of the
29173 \begin_inset Flex Code
29176 \begin_layout Plain Layout
29183 the following table gives you an idea,
29184 how to read the results.
29187 \begin_layout Standard
29189 \begin_inset Tabular
29190 <lyxtabular version="3" rows="6" columns="2">
29191 <features tabularvalignment="middle">
29192 <column alignment="left" valignment="top">
29193 <column alignment="left" valignment="top">
29195 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
29198 \begin_layout Plain Layout
29206 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
29209 \begin_layout Plain Layout
29219 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
29222 \begin_layout Plain Layout
29228 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
29231 \begin_layout Plain Layout
29232 mixed revision working copy
29239 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
29242 \begin_layout Plain Layout
29248 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
29251 \begin_layout Plain Layout
29252 modified working copy
29259 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
29262 \begin_layout Plain Layout
29268 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
29271 \begin_layout Plain Layout
29272 switched working copy
29279 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
29282 \begin_layout Plain Layout
29288 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
29291 \begin_layout Plain Layout
29292 partial working copy,
29293 from a sparse checkout
29300 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
29303 \begin_layout Plain Layout
29309 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
29312 \begin_layout Plain Layout
29315 switched working copy
29328 \begin_layout Itemize
29329 file revision information.
29330 The result comes from parsing the output of
29331 \begin_inset Flex Code
29334 \begin_layout Plain Layout
29336 \begin_inset space ~
29340 \begin_inset space ~
29344 \begin_inset space ~
29353 Supported flags are:
29357 \begin_layout Itemize
29358 version number of the last commit (
29359 \begin_inset Flex Code
29362 \begin_layout Plain Layout
29371 \begin_layout Itemize
29372 author of the last commit (
29373 \begin_inset Flex Code
29376 \begin_layout Plain Layout
29385 \begin_layout Itemize
29386 date of the last commit (
29387 \begin_inset Flex Code
29390 \begin_layout Plain Layout
29399 \begin_layout Itemize
29400 time of the last commit (
29401 \begin_inset Flex Code
29404 \begin_layout Plain Layout
29414 \begin_layout Standard
29415 You can obtain this info via InsetInfo (
29417 Insert\SpecialChar menuseparator
29418 Field\SpecialChar menuseparator
29419 Version Control Revision
29422 The information will be available only when you have the file stored under svn managment (i.e.
29424 \begin_inset Flex Code
29427 \begin_layout Plain Layout
29433 directory is available with your document).
29437 \begin_layout Itemize
29440 possibility is to use svn keywords
29444 \begin_layout Plain Layout
29445 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
29451 In short – you set file keywords property (e.g.
29454 svn propset svn:keywords 'Rev' file.lyx
29456 ) and then paste keyword \SpecialChar TeX
29461 \begin_layout Plain Layout
29462 This is an easy way how to ensure that \SpecialChar LyX
29463 won't break the line in the middle of keyword tag.
29468 tag in your document (e.g.
29470 \begin_inset Flex Code
29473 \begin_layout Plain Layout
29480 This way svn client will automatically substitute revision number (e.g.
29482 \begin_inset Flex Code
29485 \begin_layout Plain Layout
29492 ) after each update and commit.
29493 There are more problems with this approach.
29495 the '$' character is used in \SpecialChar TeX
29496 world for math equations,
29497 so any occurence of math formula
29498 \begin_inset Formula $Rev$
29502 \begin_inset Formula $Rev:59$
29505 in your \SpecialChar LyX
29507 Similarly for other keywords like Id,
29511 Secondly svn output is dependent on your locales,
29512 so its very easy that svn would produce some problematic strings once Date is used.
29513 Thirdly you get the whole 'Rev:
29514 59' string in your document instead of the plain number.
29515 Until subversion implements user's custom keywords it will be hard to use this approach reliably or let \SpecialChar LyX
29516 to support it directly.
29519 \begin_layout Subsection
29520 SVN and Windows Environment
29523 \begin_layout Quote
29524 My inclination is to say that if the user cannot figure out the command line operations on their own fairly quickly,
29525 they would be well advised to use TortoiseSVN.
29532 \begin_layout Subsubsection
29536 \begin_layout Standard
29537 In addition to installing \SpecialChar LyX
29539 and having access to a Subversion repository,
29540 the user will need to install the Subversion client program.
29541 A Windows installer for the client program is available from
29542 \begin_inset CommandInset href
29545 target "http://www.collab.net/nonav/downloads/subversion/"
29551 The user may also want to install
29552 \begin_inset CommandInset href
29555 target "http://tortoisesvn.tigris.org/"
29561 which integrates Subversion operations into the context (rightclick) menu of Windows Explorer.
29562 Operations done outside \SpecialChar LyX
29563 will typically be more convenient using the Explorer context menu.
29564 Note that TortoiseSVN is not a replacement for the client program,
29565 which is what \SpecialChar LyX
29569 \begin_layout Subsubsection
29570 Bringing a document under Subversion control
29573 \begin_layout Standard
29574 Before a \SpecialChar LyX
29575 document can be brought under version control in Subversion,
29576 its parent directory needs to be under version control.
29577 If the document is being added to a project already in the repository,
29578 this is accomplished by checking the project out to the directory where the new document will be placed.
29579 If the project itself is not yet under version control (for instance,
29580 if this document starts a new project),
29581 the directory must be imported into the repository.
29582 This is done outside \SpecialChar LyX
29584 Both import and checkout are easily accomplished from the Explorer context menu using TortoiseSVN,
29585 or alternatively can be done using the command line client at a DOS prompt.
29586 The procedure for importing the project using TortoiseSVN is described below,
29587 assuming an existing repository and a new project being started in
29594 For information on using the Subversion client program,
29602 \begin_layout Enumerate
29609 in Windows Explorer,
29613 TortoiseSVN\SpecialChar menuseparator
29618 adjust the URL for the repository,
29622 \begin_layout Enumerate
29623 Right click the level of the repository under which you want to place the new project folder (typically the top level) and click
29627 Supply a name for the project folder and click OK.
29628 Add a message for the log file if desired,
29629 then click OK again.
29630 The new project folder should appear in the repository.
29632 click OK again to exit the repository browser.
29635 \begin_layout Enumerate
29636 Once again right click
29643 this time selecting SVN Checkout\SpecialChar ldots
29644 Select the URL of the project folder you just created in the repository,
29645 and set the checkout directory to
29653 You will be warned about a non-empty folder;
29654 click OK to proceed.
29655 You should now have a
29666 \begin_layout Enumerate
29667 Create or open your document in \SpecialChar LyX
29670 File\SpecialChar menuseparator
29672 \begin_inset space ~
29675 Control\SpecialChar menuseparator
29679 Add a log message and click OK to commit the document to version control.
29682 \begin_layout Standard
29683 From this point onward,
29684 you should have full functionality in the
29686 File\SpecialChar menuseparator
29688 \begin_inset space ~
29694 You also have the option of checking the document in and out,
29695 viewing its history,
29697 using the TortoiseSVN context menu in Windows Explorer or the Subversion client program from a command prompt.
29700 \begin_layout Subsubsection
29701 SSH tunnel used with SVN under Windows
29704 \begin_layout Standard
29705 Compared with Linux setting up an svn client to communicate over ssh under Windows is a rather troublesome task.
29706 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,
29707 also be prepared for a great deal of frustration\SpecialChar ldots
29711 \begin_layout Enumerate
29712 Get an svn client for windows,
29713 as described in the previous sections.
29714 When it is a fresh install run some svn command (e.g.
29716 \begin_inset Flex Code
29719 \begin_layout Plain Layout
29725 ) to create config files,
29726 which you will need to change later on.
29729 \begin_layout Enumerate
29730 Choose an ssh client for Windows.
29731 There are several possibilities,
29732 we will use the one from Putty tools
29736 \begin_layout Plain Layout
29737 \begin_inset Flex URL
29740 \begin_layout Plain Layout
29742 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
29753 You will need to set the connection up so that the client doesn't ask for any password from you.
29754 To keep things easy we will use only keys without any additional password protection etc.
29758 \begin_layout Enumerate
29760 \begin_inset Flex Code
29763 \begin_layout Plain Layout
29770 Save your private .ppk key file and put the public one on the server side.
29771 If the SVN server runs on Linux,
29772 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
29773 \begin_inset Quotes eld
29778 Public key for pasting into OpenSSH authorized_keys file
29781 \begin_inset Quotes erd
29784 edit field into the server's
29785 \begin_inset Flex Code
29788 \begin_layout Plain Layout
29789 ~/.ssh/authorized_keys
29795 \begin_inset Flex Code
29798 \begin_layout Plain Layout
29807 \begin_layout Enumerate
29809 \begin_inset Flex Code
29812 \begin_layout Plain Layout
29819 In the SVN config file
29823 \begin_layout Plain Layout
29824 Exact path depends on Windows version,
29825 usually somewhere around
29826 \begin_inset Flex Code
29829 \begin_layout Plain Layout
29832 Documents and Settings
29846 \begin_inset Flex Code
29849 \begin_layout Plain Layout
29869 \begin_inset Flex Code
29872 \begin_layout Plain Layout
29873 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
29882 \begin_layout Plain Layout
29883 It will usually take a lot of time to get exact command right and it depends on many things.
29884 For example do not have some remote server saved as a default session in Putty etc.
29886 try to connect via plink without SVN first.
29895 \begin_layout Enumerate
29896 Checkout the SVN archive,
29898 \begin_inset space \thinspace{}
29902 \begin_inset Newline newline
29906 \begin_inset Flex Code
29909 \begin_layout Plain Layout
29910 svn co svn+ssh://user@server/repository_path
29918 \begin_layout Subsubsection
29919 End-of-Line Conversions
29922 \begin_layout Standard
29923 When the collaborators are mixing Linux and Windows environments,
29925 will use different line endings inside the .lyx files.
29926 This is not a problem as far as \SpecialChar LyX
29927 functionality is concerned,
29928 but the commit diffs will be huge and merge-conflicts prone.
29929 Fortunately SVN itself knows
29933 \begin_layout Plain Layout
29934 \begin_inset Flex URL
29937 \begin_layout Plain Layout
29939 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
29949 how to deal with CR/LF problems when switching .lyx files to the
29950 \begin_inset Flex Code
29953 \begin_layout Plain Layout
29963 \begin_layout Plain Layout
29966 \begin_inset Flex Code
29969 \begin_layout Plain Layout
29970 svn propset svn:eol-style native FILE_NAME
29983 \begin_layout Subsection
29984 GIT commands in \SpecialChar LyX
29988 \begin_layout Standard
29989 A minimal subset of GIT commands is now supported by \SpecialChar LyX
29991 You can find the commands in the
29993 File\SpecialChar menuseparator
29995 \begin_inset space ~
30001 Please note that if you use password protected access to repository via ssh,
30002 you will be asked in terminal window.
30004 was tested against GIT 1.7/2.30.
30008 \begin_layout Plain Layout
30009 Windows users please note that you need to ensure that git is on the path.
30010 This can be set from within \SpecialChar LyX
30013 Tools\SpecialChar menuseparator
30014 Preferences\SpecialChar menuseparator
30015 Paths\SpecialChar menuseparator
30026 \begin_layout Standard
30027 One big difference of GIT and the other supported version control systems is the distributed nature of GIT:
30028 With traditional version control systems there is one central server which hosts the repository.
30029 Users commit their changes to the server,
30030 and get updates made by other users from it.
30032 users commit to a local repository.
30033 The local repository can be synchronized with one or more remote repositories using the
30034 \begin_inset Flex Code
30037 \begin_layout Plain Layout
30044 \begin_inset Flex Code
30047 \begin_layout Plain Layout
30055 does not interact in any way with remote GIT repositories.
30056 It works exclusively with the local repository in a very similar way as with a central CVS or SVN repository.
30057 If you use remote GIT repositories you need to do the
30058 \begin_inset Flex Code
30061 \begin_layout Plain Layout
30068 \begin_inset Flex Code
30071 \begin_layout Plain Layout
30077 operations with your favourite GIT client.
30080 \begin_layout Subsubsection
30086 \begin_layout Standard
30087 If your document is not under revision control,
30088 this is the only item shown in the menu.
30089 And if it is under revision control,
30094 item is not visible.
30097 \begin_layout Standard
30098 This command registers in GIT your document ONLY in case you have already the documents directory under GIT control (in particular
30106 \begin_layout Plain Layout
30111 *and* initial repository commit (or at least
30115 ) needs to be manually done.
30121 This means you have to checkout the archive by yourself.
30124 \begin_layout Standard
30125 Then you are asked interactively to supply an initial description of the document.
30126 Don't forget that registered file is not yet committed.
30129 \begin_layout Standard
30130 GIT command that is run:
30134 \begin_inset Quotes qld
30138 \begin_inset Quotes qld
30144 \begin_layout Standard
30149 to understand the switches.
30152 \begin_layout Subsubsection
30158 \begin_layout Standard
30159 When you are finished editing a file,
30160 you commit your changes.
30162 you are asked for a description of the changes.
30163 After that changes are committed.
30166 \begin_layout Standard
30170 git commit -q -m"<description>" <file-name>
30173 \begin_layout Subsubsection
30176 Revert To Repository Version
30179 \begin_layout Standard
30180 This will discard all changes made to the document since the last check in.
30181 You get a warning before changes are discarded.
30184 \begin_layout Standard
30189 \begin_inset Quotes qld
30193 \begin_inset Quotes qld
30199 \begin_layout Subsubsection
30205 \begin_layout Standard
30206 This will rename the current document including the version history.
30207 It requires a clean document without any changes since the last checkin.
30208 You are asked for a file name and a description of the rename operation.
30209 After that the document is renamed,
30210 both locally and in the repository.
30211 If the parent directories of the new and old file names differ,
30212 all relative paths of included files are adjusted (like in
30214 File\SpecialChar menuseparator
30220 the document is reloaded using the new name.
30223 \begin_layout Labeling
30224 \labelwidthstring 00.00.0000
30226 \begin_inset space ~
30231 \begin_inset space ~
30235 \begin_inset Newline newline
30239 \begin_inset Flex Code
30242 \begin_layout Plain Layout
30246 \begin_inset Quotes qld
30250 \begin_inset Quotes qld
30254 \begin_inset Quotes qld
30258 \begin_inset Quotes qld
30267 \begin_inset Newline newline
30271 \begin_inset Flex Code
30274 \begin_layout Plain Layout
30283 \begin_layout Subsubsection
30289 \begin_layout Standard
30290 This shows the complete history of the GIT document.
30294 \begin_inset Quotes qld
30298 \begin_inset Quotes qld
30303 is shown in a browser.
30306 \begin_layout Subsubsection
30310 \begin_layout Standard
30312 supports GIT hash number of the last commit to the file,
30313 its abbreviated form,
30315 date and time of last commit.
30316 All those are extracted from
30318 git log -n 1 --pretty=format:%H%n%h%n%an%n%ai
30321 Tree version information is obtained via
30323 git describe --abbrev --dirty --long
30327 \begin_inset CommandInset ref
30329 reference "subsec:VCS-Revision-Information"
30337 \begin_layout Subsection
30341 \begin_layout Standard
30342 With the recent addition of the
30343 \begin_inset Flex Code
30346 \begin_layout Plain Layout
30352 function \SpecialChar LyX
30353 power users are allowed to create their own commands for revision control.
30356 \begin_layout Standard
30357 As an example you can see how two TortoiseSVN commands could be integrated directly:
30360 \begin_layout Description
30363 \begin_inset Flex Code
30366 \begin_layout Plain Layout
30367 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
30375 \begin_layout Description
30378 \begin_inset Flex Code
30381 \begin_layout Plain Layout
30382 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
30390 \begin_layout Subsection
30391 Version control and Document comparison
30394 \begin_layout Standard
30395 One of the typical uses of version control is to inspect the changes between revisions,
30396 usually by creating
30397 \begin_inset Flex Code
30400 \begin_layout Plain Layout
30407 While this is useful for plain text files,
30408 it is much less useful in the case of \SpecialChar LyX
30410 which have more a complicated structure.
30411 Hence we provide binding to the Document comparison feature.
30412 There are two ways of calling this feature – either by direct call of
30413 \begin_inset Flex Code
30416 \begin_layout Plain Layout
30423 function (for details see \SpecialChar LyX
30424 functions manual) or by the toolbar icon
30438 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 '
30439 \begin_inset Flex Noun
30442 \begin_layout Plain Layout
30448 ' revisions back means comparison of the edited file with last commited revision).
30452 \begin_layout Standard
30453 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,
30454 numbers always point to the last number in RCS revision number,
30457 We don't currently support GIT addressing of revisions,
30458 one can just compare edited document with its revision X steps backs,
30459 where X is addressed as
30460 \begin_inset Flex Code
30463 \begin_layout Plain Layout
30472 \begin_layout Section
30473 \begin_inset CommandInset label
30475 name "sec:Literate-Programming"
30479 Literate Programming
30482 \begin_layout Standard
30487 (kayvan@sylvan.com)
30492 original documentation written by
30494 Edmar Wienskoski Jr.
30497 (edmar-w-jr@technologist.com)
30500 \begin_layout Subsection
30504 \begin_layout Standard
30505 The main purpose of this documentation is to show you how to use \SpecialChar LyX
30506 for literate programming,
30507 where it is assumed that you are familiar with this programming technique,
30509 \begin_inset Quotes eld
30513 \begin_inset Quotes erd
30517 \begin_inset Quotes eld
30521 \begin_inset Quotes erd
30525 If that is not the case,
30526 please follow the web links provided in the following sections.
30527 There is a lot of good documentation out there covering old development history to the latest tools tips.
30530 \begin_layout Standard
30531 It is also assumed that you are familiar with \SpecialChar LyX
30532 itself to a point that you are comfortable changing your \SpecialChar LyX
30534 and X resources file.
30535 If that is not the case please refer to other \SpecialChar LyX
30536 documentation to cover your specific needs.
30539 \begin_layout Subsection
30540 Literate Programming
30543 \begin_layout Standard
30544 From the Literate Programming FAQ:
30548 \begin_layout Quotation
30549 Literate programming is the combination of documentation and source together in a fashion suited for reading by human beings.
30551 literate programs should be enjoyable reading,
30554 I couldn't resist!) In general,
30555 literate programs combine source and documentation in a single file.
30556 Literate programming tools then parse the file to produce either readable documentation or compilable source.
30557 The WEB style of literate programming was created by D.
30558 \begin_inset space \thinspace{}
30562 Knuth during the development of his \SpecialChar TeX
30563 typesetting software.
30567 \begin_layout Standard
30568 Another excerpt says:
30571 \begin_layout Quotation
30574 How is literate programming different from verbose commenting?
30577 \begin_layout Quotation
30578 There are three distinguishing characteristics.
30579 In order of importance,
30585 \begin_layout Itemize
30586 flexible order of elaboration
30589 \begin_layout Itemize
30590 automatic support for browsing
30593 \begin_layout Itemize
30594 typeset documentation,
30595 especially diagrams and mathematics
30599 \begin_layout Standard
30600 Now that I sparked your curiosity,
30601 take a look in the references.
30604 \begin_layout Subsubsection
30608 \begin_layout Standard
30609 The complete Literate Programming FAQ can be found at:
30612 \begin_layout Quote
30613 Literate Programming FAQ
30614 \begin_inset Flex URL
30617 \begin_layout Plain Layout
30619 http://www.literateprogramming.com/lpfaq.pdf
30627 \begin_layout Standard
30628 The FAQ lists 23 (twenty three!) different literate programming tools.
30629 Where some are specialized or
30630 \begin_inset Quotes eld
30634 \begin_inset Quotes erd
30637 for particular programming languages,
30638 while other have general scope.
30643 for my own use for several reasons:
30646 \begin_layout Itemize
30647 It can generate the documentation either in \SpecialChar LaTeX
30651 \begin_layout Itemize
30652 It has a open architecture,
30654 \begin_inset space \thinspace{}
30658 \begin_inset space \space{}
30661 it is easy to plug in new filters
30665 \begin_layout Plain Layout
30670 are programs that read a given data stream and output a manipulated data stream.
30672 a WEB file (consisting of literate code) can be turned into a file consisting only of C program code or \SpecialChar LaTeX
30678 and to perform special processing that you may need.
30682 \begin_layout Itemize
30683 There is a good selection of filters available already (the HTML is one of them).
30686 \begin_layout Itemize
30690 \begin_layout Standard
30691 The Noweb web page can be found at:
30695 \begin_layout Quote
30697 \begin_inset Flex URL
30700 \begin_layout Plain Layout
30702 https://www.cs.tufts.edu/~nr/noweb/
30710 \begin_layout Standard
30711 Starting from there you can reach many other interesting links and even some literate program examples.
30714 \begin_layout Subsection
30716 and Literate Programming with Noweb
30719 \begin_layout Standard
30720 The \SpecialChar LyX
30721 support for Literate Programming is provided by using the generic \SpecialChar LyX
30722 converters mechanism.
30723 This support is provided in a
30724 \begin_inset Quotes eld
30728 \begin_inset Quotes erd
30733 \begin_inset space \thinspace{}
30737 \begin_inset space \space{}
30740 you will be able to use this new \SpecialChar LyX
30741 feature with some other literate programming tool of your choice by just changing your \SpecialChar LyX
30745 \begin_layout Subsubsection
30746 Generating documents and code (weaving and tangling)
30749 \begin_layout Paragraph
30750 Using the noweb module
30753 \begin_layout Standard
30754 If you have installed Noweb and \SpecialChar LyX
30756 whenever you open a new document,
30757 after you have chosen its document class,
30760 Document\SpecialChar menuseparator
30764 \begin_inset Quotes eld
30768 \begin_inset Quotes erd
30772 If Noweb is correctly installed,
30773 when you click on the
30774 \begin_inset Quotes eld
30778 \begin_inset Quotes erd
30783 \begin_inset Quotes eld
30787 \begin_inset Quotes erd
30790 module in the available list and you can add it to your document.
30793 \begin_layout Paragraph
30797 \begin_layout Standard
30799 enables you to write code with a custom inset named
30800 \begin_inset Flex Noun
30803 \begin_layout Plain Layout
30810 Noweb delimits chunks like this:
30813 \begin_layout LyX-Code
30817 \begin_layout LyX-Code
30821 \begin_layout LyX-Code
30825 \begin_layout LyX-Code
30829 \begin_layout LyX-Code
30833 \begin_layout Standard
30834 The problem is that whatever is written in between the << and the
30838 must be taken literally,
30840 \begin_inset space \thinspace{}
30844 \begin_inset space \space{}
30848 should be prevented from making any special interpretation of what has been written.
30849 This is also handled by
30850 \begin_inset Flex Noun
30853 \begin_layout Plain Layout
30860 that works like a normal text inset but has a free spacing capability.
30863 \begin_layout Standard
30865 you can also use the
30866 \begin_inset Quotes eld
30870 \begin_inset Quotes erd
30873 construct of Noweb in your chunks to add items to Noweb's identifier cross-reference:
30876 \begin_layout LyX-Code
30880 \begin_layout LyX-Code
30881 def some_function(args):
30884 \begin_layout LyX-Code
30885 "This is the doc string for this function."
30888 \begin_layout LyX-Code
30894 \begin_layout LyX-Code
30895 @ %def some_function
30898 \begin_layout Standard
30899 For an example of this usage and the resulting cross-reference output,
30900 look at the Literate python program in
30902 LIBDIR/examples/listerrors.lyx
30904 which should make this all clear.
30907 \begin_layout Paragraph
30908 Generating the documentation
30911 \begin_layout Standard
30912 At this point you already have a new document file with a proper document class,
30913 and with some code and text on it.
30915 The answer is simple,
30918 View\SpecialChar menuseparator
30923 Just like you would do for a plain document.
30924 No special procedure is required.
30927 \begin_layout Standard
30928 To help orientate you,
30929 I will now explain what happens inside \SpecialChar LyX
30933 \begin_layout Enumerate
30936 Update\SpecialChar menuseparator
30939 menu option is chosen,
30940 a \SpecialChar LaTeX
30946 \begin_layout Standard
30947 If the document is of any literate class the generated file will be named with an extension name defined by the
30948 \begin_inset Quotes eld
30952 \begin_inset Quotes erd
30955 format (defined in the Preferences panel),
30956 otherwise the file will have the usual
30964 \begin_layout Enumerate
30965 Note that the only difference so far is in the name of the file,
30966 no special processing is required by \SpecialChar LyX
30968 Given that you formatted the code using the
30969 \begin_inset Flex Noun
30972 \begin_layout Plain Layout
30980 takes care of the business.
30983 \begin_layout Enumerate
30984 If the document is of any literate class \SpecialChar LyX
30985 will then use the internal \SpecialChar LyX
30986 to Noweb converter,
30987 followed by the Noweb to \SpecialChar LaTeX
30992 \begin_layout Plain Layout
30993 The converters are defined in the
30995 Tools\SpecialChar menuseparator
31000 \begin_inset Quotes eld
31004 \begin_inset Quotes erd
31016 manual for general information about converters.
31021 to generate the \SpecialChar LaTeX
31026 \begin_layout Standard
31027 Otherwise it will just skip this step.
31031 \begin_layout Enumerate
31034 is invoked and the regular post processing continues as in a plain document.
31037 \begin_layout Standard
31038 Independence from a particular
31039 \begin_inset Quotes eld
31043 \begin_inset Quotes erd
31046 is easily achieved by changing the commands that are run by the various converters.
31049 \begin_layout Paragraph
31050 Generating the code
31053 \begin_layout Standard
31054 When the build menu option is chosen or the corresponding button in the toolbar is pressed,
31055 a \SpecialChar LaTeX
31056 file is generated just like step 1 above.
31064 This converter needs to be defined by the user and is not installed by default,
31065 though the Program format is.
31066 This converter (like any other converter) will have two parts:
31069 \begin_layout Enumerate
31070 The converter program itself.
31071 This program performs the conversion from the one format to the other (in this case,
31072 from the Noweb format to the Program pseudo-format).
31075 \begin_layout Enumerate
31076 The error log parser.
31077 This is a program whose sole purpose is to rewrite error messages in a format that \SpecialChar LyX
31079 This makes it possible for \SpecialChar LyX
31080 to place error boxes in the right places in the file buffer.
31083 \begin_layout Standard
31086 \begin_inset Quotes eld
31090 \begin_inset Quotes erd
31097 \begin_layout LyX-Code
31105 \begin_layout Standard
31106 This basically means that \SpecialChar LyX
31108 \begin_inset Quotes eld
31112 \begin_inset Quotes erd
31115 (a program or script) with the name of the Noweb file (normally a file in the \SpecialChar LyX
31116 temp directory) and the directory path of the original \SpecialChar LyX
31121 \begin_layout Standard
31122 This is an implementation of
31123 \begin_inset Quotes eld
31127 \begin_inset Quotes erd
31130 that you can place in a directory on your path:
31133 \begin_layout LyX-Code
31139 \begin_layout LyX-Code
31145 \begin_layout LyX-Code
31148 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
31151 \begin_layout Standard
31152 The next part of the converter setting is the
31153 \begin_inset Quotes eld
31157 \begin_inset Quotes erd
31160 which is to be set to
31163 \begin_layout LyX-Code
31166 parselog=$$s/scripts/listerrors
31169 \begin_layout Standard
31170 This will run any errors that are generated by the
31171 \begin_inset Quotes eld
31175 \begin_inset Quotes erd
31178 process through the
31179 \begin_inset Quotes eld
31183 \begin_inset Quotes erd
31189 \begin_layout Standard
31190 The build will normally take place in \SpecialChar LyX
31191 's temporary directory,
31192 so the files produced by the conversion will be in that directory.
31194 will copy out what it regards as the `main' file,
31199 conversion may produce several files,
31200 and so most of these would then be deleted when \SpecialChar LyX
31202 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.
31205 \begin_layout Paragraph
31206 Build instructions in the document
31209 \begin_layout Standard
31210 The last piece of the integration between \SpecialChar LyX
31212 \begin_inset Quotes eld
31216 \begin_inset Quotes erd
31221 the instructions for building your program should be embedded in a chunk of its own.
31223 \begin_inset Quotes eld
31227 \begin_inset Quotes erd
31230 above uses the notangle command to look for this chunk (called
31231 \begin_inset Quotes eld
31235 \begin_inset Quotes erd
31238 ) and runs its contents through
31239 \begin_inset Quotes eld
31243 \begin_inset Quotes erd
31249 \begin_layout Standard
31251 such a chunk would look something like this:
31254 \begin_layout LyX-Code
31258 \begin_layout LyX-Code
31260 \begin_inset Newline newline
31263 if [ -z "${NOWEB_SOURCE}" ]
31264 \begin_inset Newline newline
31270 \begin_layout LyX-Code
31271 NOWEB_SOURCE=myfile.nw
31272 \begin_inset Newline newline
31276 \begin_inset Newline newline
31280 code to extract files ...
31281 use NOWEB_OUTPUT_DIR here ...]
31282 \begin_inset Newline newline
31286 code to compile files ...]
31287 \begin_inset Newline newline
31293 \begin_layout Standard
31296 File\SpecialChar menuseparator
31297 Open Example\SpecialChar menuseparator
31298 Modules\SpecialChar menuseparator
31303 File\SpecialChar menuseparator
31304 Open Example\SpecialChar menuseparator
31305 Modules\SpecialChar menuseparator
31308 which implement versions of the
31309 \begin_inset Quotes eld
31313 \begin_inset Quotes erd
31316 program for some illustrations of how all of these pieces go together
31322 these files show off the language independency of the \SpecialChar LyX
31323 literate programming support since they are written in Python and Perl respectively.
31326 \begin_layout Subsubsection
31327 Configuring \SpecialChar LyX
31331 \begin_layout Standard
31332 All the Literate Programming support is configured by the
31334 Tools\SpecialChar menuseparator
31338 \begin_inset Quotes eld
31342 \begin_inset Quotes erd
31346 The important parts are:
31349 \begin_layout Description
31351 \begin_inset space ~
31355 \begin_inset Quotes eld
31359 \begin_inset Quotes erd
31363 \begin_inset space ~
31366 format Set up via the File Formats tab,
31367 this is where the Noweb-specific pieces are set up.
31377 the file extension is set to
31382 This tells \SpecialChar LyX
31383 to create a file with a
31387 extension in the first step of the conversion process.
31390 \begin_layout Description
31392 \begin_inset space ~
31400 \begin_inset space ~
31403 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).
31406 \begin_layout Description
31416 This converter performs the
31417 \begin_inset Quotes eld
31421 \begin_inset Quotes erd
31424 of the literate document.
31427 \begin_inset Quotes eld
31432 noweave -delay -index $$i > $$o
31435 \begin_inset Quotes erd
31441 \begin_layout Description
31451 \begin_inset Quotes eld
31455 \begin_inset Quotes erd
31460 the Converter is set to
31461 \begin_inset Quotes eld
31469 \begin_inset Quotes erd
31474 \begin_inset Newline newline
31478 \begin_inset Quotes eld
31483 parselog=$$s/scripts/listerrors
31486 \begin_inset Quotes erd
31492 \begin_layout Subsubsection
31496 \begin_layout Standard
31497 There is also a new function implemented in the \SpecialChar LyX
31500 \begin_inset Quotes eld
31503 server-goto-file-row" function,
31504 to be used with ddd/gdb or other debugger.
31508 \begin_layout Standard
31509 When debugging code with ddd/gdb,
31510 it is possible to invoke a text editor at the current execution position with a single key stroke.
31511 The default ddd configuration for that is shift-ctrl-V.
31512 It happens that you can define the editor command line invocation in ddd by accessing the
31514 Edit\SpecialChar menuseparator
31515 Preferences\SpecialChar menuseparator
31518 dialog and changing the "Edit Sources" entry.
31521 \begin_layout Standard
31522 I take advantage of the newly created \SpecialChar LyX
31523 server function and this ddd feature,
31525 \begin_inset Quotes eld
31529 \begin_inset Quotes erd
31535 \begin_layout LyX-Code
31536 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
31539 \begin_layout Standard
31541 whenever you are using ddd and find a point in the program that you want to edit,
31542 you just press shift-ctrl-V (in the ddd window),
31543 and ddd will forward this information to \SpecialChar LyX
31544 through the \SpecialChar LyX
31545 server and then the \SpecialChar LyX
31546 window will show the same file with the cursor at the same position ddd was pointing to.
31547 No more guessing or long scrolling to locate a point in the program back from debugging !
31550 \begin_layout Standard
31551 Note however that you must enable the \SpecialChar LyX
31552 server to get this feature working (it is disabled by default).
31554 \begin_inset space ~
31558 \begin_inset CommandInset ref
31560 reference "sec:Starting-the-Server"
31565 explains how to do that.
31568 \begin_layout Subsubsection
31572 \begin_layout Standard
31573 There are six new buttons that can be added to your \SpecialChar LyX
31575 Four of these buttons are short cuts to layout styles:
31598 one for the custom inset
31603 The last one is a short cut to the
31604 \begin_inset Quotes eld
31608 \begin_inset Quotes erd
31615 \begin_layout Standard
31617 has a range of buttons that are available for tool bar customization.
31618 In my toolbar I like to combine the six short cuts above with two more:
31623 \SpecialChar menuseparator
31628 \SpecialChar menuseparator
31635 Document\SpecialChar menuseparator
31636 View\SpecialChar menuseparator
31640 Here is how it looks like:
31643 \begin_layout LyX-Code
31647 \begin_layout LyX-Code
31651 \begin_layout LyX-Code
31652 Icon "layout Standard"
31655 \begin_layout LyX-Code
31656 Icon "layout Section"
31659 \begin_layout LyX-Code
31660 Icon "layout \SpecialChar LaTeX
31664 \begin_layout LyX-Code
31665 Icon "layout \SpecialChar LyX
31669 \begin_layout LyX-Code
31670 Icon "flex.insert Chunk"
31673 \begin_layout LyX-Code
31677 \begin_layout LyX-Code
31681 \begin_layout LyX-Code
31682 Icon "buffer-typeset"
31685 \begin_layout LyX-Code
31686 Icon "build-program"
31689 \begin_layout LyX-Code
31693 \begin_layout LyX-Code
31697 \begin_layout LyX-Code
31701 \begin_layout LyX-Code
31705 \begin_layout LyX-Code
31709 \begin_layout Subsubsection
31710 Colors customization
31713 \begin_layout Standard
31714 There are a number of colors in \SpecialChar LyX
31715 that can be customized in
31720 One of the things that bothers people is the \SpecialChar LaTeX
31722 The default color is red,
31723 since the chunks uses \SpecialChar LaTeX
31725 and there is a lot of chunks in literate documents,
31726 you may get tired of seeing everything in red.
31727 You can change it by going to the tabs
31737 \begin_layout Standard
31738 The next thing is the visible presence of the newline character in the screen.
31739 You can choose the color of this particular character and make it blend in the background.
31740 I recommend you choosing a color that is close to the background but not equal,
31741 that way you still can see it is there,
31742 but it is not bothering you anymore.
31745 \begin_layout Subsection
31750 \begin_layout Standard
31761 Help\SpecialChar menuseparator
31762 Specific Manuals\SpecialChar menuseparator
31767 File\SpecialChar menuseparator
31768 Open Example\SpecialChar menuseparator
31769 Modules\SpecialChar menuseparator
31774 Help\SpecialChar menuseparator
31775 Specific Manuals\SpecialChar menuseparator
31780 File\SpecialChar menuseparator
31781 Open Example\SpecialChar menuseparator
31782 Modules\SpecialChar menuseparator
31788 \begin_layout Standard
31789 \begin_inset CommandInset index_print
31790 LatexCommand printindex